Skip to main content

Safe Account V2

Safe Account V2 uses the original Safe Singleton and adds ERC-4337 functionality using a module/fallback handler.

The V2 contracts, known as the SafeAccountV0_2_0 class in AbstractionKit, support EntryPoint v0.6.

Import​

import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

How to Use​

Initialize a new Safe Account and calculate its address:

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31"; // Safe owner pub address
const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]);

const accountAddress = smartAccount.accountAddress;

Constructor​

Creates a SafeAccountV0_2_0 instance for an existing deployed Safe account. For new (undeployed) accounts, use the static initializeNewAccount method instead.

Usage​

import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

const accountAddress = "0x1a02592A3484c2077d2E5D24482497F85e1980C6";

const smartAccount = new SafeAccount(accountAddress);
keytypedescription
accountAddressstringThe on-chain address of the deployed Safe account.
overrides?objectOptional overrides for module and EntryPoint addresses.
overrides?.safe4337ModuleAddress?stringOverride the default Safe 4337 module address.
overrides?.entrypointAddress?stringOverride the default EntryPoint address.
overrides?.onChainIdentifierParams?OnChainIdentifierParamsTypeParameters for on-chain identifier tracking.
overrides?.onChainIdentifier?stringPre-computed on-chain identifier string.

Source code​

constructor

Methods​

The Essentials methods provide all necessary functionalities with support for overrides, offering a streamlined approach.

initializeNewAccount​

Initializes a new SafeAccount class given a list of owners' public addresses. Only needs to be called on the first transaction when the account has not been deployed yet.

Usage​

In this example, we initiate a single owner account.

example.ts
import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]);

console.log("Account address (sender): " + smartAccount.accountAddress);
Example Response
Account address(sender) : 0x1a02592A3484c2077d2E5D24482497F85e1980C6

Source code​

initializeNewAccount

isDeployed​

Static method that checks whether a Safe account is already deployed on-chain. Use it to decide between connecting to an existing account (new SafeAccountV0_2_0(address)) and initializing a counterfactual one (SafeAccountV0_2_0.initializeNewAccount(owners)). Once an account is deployed, the factory data carried by initializeNewAccount is no longer needed and including it would waste gas.

This only checks for non-empty bytecode at accountAddress. It does not verify that the deployed code is a Safe or that its on-chain configuration matches a given owner set.

Usage​

example.ts
import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

const accountAddress = "0x1a02592A3484c2077d2E5D24482497F85e1980C6";
const nodeRpcUrl = "https://rpc2.sepolia.org";

const account = (await SafeAccount.isDeployed(accountAddress, nodeRpcUrl))
    ? new SafeAccount(accountAddress)
    : SafeAccount.initializeNewAccount([ownerPublicAddress]);

Source code​

isDeployed

createUserOperation​

This method determines the nonce, fetches the gas prices, estimates gas limits, and returns a UserOperation to be signed. You can override any of these values using the overrides parameter.

Usage​

This example mints the same NFT twice in a single UserOperation.

example.ts
import { MetaTransaction } from "abstractionkit";

const jsonRpcNodeProvider = "https://rpc2.sepolia.org";
const bundlerUrl = "https://api.candide.dev/public/v3/11155111";

const transaction: MetaTransaction = {
    to: "0xD9de104e3386d9A45a61BcE269c43E48B534e4E7", // NFT contract address
    value: 0n,
    data: "0x1249c58b", // mint()
}

let userOperation = await smartAccount.createUserOperation(
  [transaction, transaction], // batch transactions to mint 2 NFTs
  jsonRpcNodeProvider,
  bundlerUrl,
)

console.log(userOperation);
Example Response
{
  sender: '0x44e3cb9acd92ab055d3251994352bb8fe0e20879',
  nonce: 1n,
  initCode: '0x',
  callData: '0x541d63c800000000000000000000000038869bf66a61cf6bdb996a6ae40d5853fd43b52600000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000001048d80ff0a000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000b200d9de104e3386d9a45a61bce269c43e48b534e4e7000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041249c58b00d9de104e3386d9a45a61bce269c43e48b534e4e7000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041249c58b000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
  callGasLimit: 95085n,
  verificationGasLimit: 62187n,
  preVerificationGas: 46156n,
  maxFeePerGas: 1625933544n,
  maxPriorityFeePerGas: 1200000000n,
  paymasterAndData: '0x',
  signature: '0x00000000000000000000000041c6297bd9573e8d979a272db4f6576a98f639a7e6874055a627769401dc46d01143551ccaa473364ace4340ec395c546dccb725e1eac2639ecef443d229f0071b'
}

Source code​

createUserOperation

signUserOperation​

This method takes a userOperation, the private keys of the owner of the account, and the chainId and returns the signature field.

example.ts
const chainId = BigInt("11155111"); // sepolia chain ID
const privateKey = "0x4cad764980d84fc6684ca839cae2c78be5432e292fa98416e11687ceb9096a03";
const userOperation = {..}

const signature = smartAccount.signUserOperation(
  userOperation,
  [privateKey],
  chainId,
);

console.log(signature);
Example Response
0x00000000000000000000000041c6297bd9573e8d979a272db4f6576a98f639a7e6874055a627769401dc46d01143551ccaa473364ace4340ec395c546dccb725e1eac2639ecef443d229f0071b

Source code​

signUserOperation

signUserOperationWithSigners​

Signs a UserOperation using one or more ExternalSigners instead of raw private keys. Integrates viem, ethers, hardware wallets, HSMs, MPC services, and WebAuthn through the same API.

example.ts
import { fromEthersWallet } from "abstractionkit";
import { Wallet } from "ethers";

const wallet = new Wallet("0x...");

userOperation.signature = await smartAccount.signUserOperationWithSigners(
  userOperation,
  [fromEthersWallet(wallet)],
  chainId,
);

See External Signers for the full list of adapters and custom-signer integrations.

Source code​

signUserOperationWithSigners

sendUserOperation​

This method sends the UserOperation to the bundler to be executed on-chain. It returns a promise SendUseroperationResponse object to confirm the on-chain inclusion of the UserOperation.

example.ts
const sendUserOperationResponse = await smartAccount.sendUserOperation(userOperation, bundlerUrl)

console.log("sendUserOperationResponse: ", sendUserOperationResponse);
console.log("UserOperation sent. Waiting to be included...");

const receipt = await sendUserOperationResponse.included()

console.log("receipt: ", receipt);
Example Response
sendUserOperationResponse: {
  userOperationHash: '0x61b3e2c57ad7ad1ae788f0ac84c79b28aab8aeaf872be173cadc72ab8b3d4418',
  bundler: { rpcUrl: 'https://api.candide.dev/public/v3/11155111' },
  entrypointAddress: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789'
}

UserOperation sent. Waiting to be included...

receipt: {
  userOpHash: '0x61b3e2c57ad7ad1ae788f0ac84c79b28aab8aeaf872be173cadc72ab8b3d4418',
  entryPoint: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789',
  sender: '0x44e3cb9acd92ab055d3251994352bb8fe0e20879',
  nonce: '0x2',
  paymaster: '0x0000000000000000000000000000000000000000',
  actualGasCost: 261844423573004,
  actualGasUsed: 185893,
  success: true,
  logs: '[{"address":"0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000ee2567da7e0c000000000000000000000000000000000000000000000000000000000002d625","logIndex":"0x140","removed":false,"topics":["0x49628fd1471006c1482da88028e9ce4dbb080b815c9b0344d39e5a8e6ec1419f","0x61b3e2c57ad7ad1ae788f0ac84c79b28aab8aeaf872be173cadc72ab8b3d4418","0x00000000000000000000000044e3cb9acd92ab055d3251994352bb8fe0e20879","0x0000000000000000000000000000000000000000000000000000000000000000"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"}]',
  receipt: {
    blockHash: '0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69',
    blockNumber: '0x4e4d65',
    from: '0x3cfdc212769c890907bce93d3d8c2c53de6a7a89',
    cumulativeGasUsed: '0x1c3ffde',
    gasUsed: '0x2dbfd',
    logs: '[{"address":"0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x00000000000000000000000000000000000000000000000000013cd7ed43f8b8","logIndex":"0x13a","removed":false,"topics":["0x2da466a7b24304f47e87fa2e1e5a81b9831ce54fec19055ce277ca2f39ba42c4","0x00000000000000000000000044e3cb9acd92ab055d3251994352bb8fe0e20879"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"},{"address":"0x44e3cb9acd92ab055d3251994352bb8fe0e20879","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x","logIndex":"0x13b","removed":false,"topics":["0x6895c13664aa4f67288b25d7a21d7aaa34916e355fb9b6fae0a139a9085becb8","0x000000000000000000000000d556564bacf6feac2e26ff70695f8250cea8c29e"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"},{"address":"0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x","logIndex":"0x13c","removed":false,"topics":["0xbb47ee3e183a558b1a2ff0874b079f3fc5478b7454eacf2bfc5af2ff5878f972"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"},{"address":"0xd9de104e3386d9a45a61bce269c43e48b534e4e7","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x","logIndex":"0x13d","removed":false,"topics":["0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef","0x0000000000000000000000000000000000000000000000000000000000000000","0x00000000000000000000000044e3cb9acd92ab055d3251994352bb8fe0e20879","0x0000000000000000000000000000000000000000000000000000000000000023"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"},{"address":"0xd9de104e3386d9a45a61bce269c43e48b534e4e7","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x","logIndex":"0x13e","removed":false,"topics":["0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef","0x0000000000000000000000000000000000000000000000000000000000000000","0x00000000000000000000000044e3cb9acd92ab055d3251994352bb8fe0e20879","0x0000000000000000000000000000000000000000000000000000000000000024"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"},{"address":"0x44e3cb9acd92ab055d3251994352bb8fe0e20879","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x","logIndex":"0x13f","removed":false,"topics":["0x6895c13664aa4f67288b25d7a21d7aaa34916e355fb9b6fae0a139a9085becb8","0x000000000000000000000000d556564bacf6feac2e26ff70695f8250cea8c29e"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"},{"address":"0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789","blockHash":"0xba4e1221571d457b4a01db81be6c3ca8e1dcf0117c2c383425e8379853345a69","blockNumber":"0x4e4d65","data":"0x000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000ee2567da7e0c000000000000000000000000000000000000000000000000000000000002d625","logIndex":"0x140","removed":false,"topics":["0x49628fd1471006c1482da88028e9ce4dbb080b815c9b0344d39e5a8e6ec1419f","0x61b3e2c57ad7ad1ae788f0ac84c79b28aab8aeaf872be173cadc72ab8b3d4418","0x00000000000000000000000044e3cb9acd92ab055d3251994352bb8fe0e20879","0x0000000000000000000000000000000000000000000000000000000000000000"],"transactionHash":"0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25","transactionIndex":"0xc5"}]',
    logsBloom: '0x000000000000100000000000000000000000000000000000000000000000000000080000000000000022080100000000001000000000008000000200000020000000000000020000000000080000000008100000000000000000000000002000020000000a0800000000000000000800000000000000000000000014000200000000000000000000000000000008000040000000000200000000000000000000000000000002000000400000400000000200000000000000000002200008000000000002000000000001000008000000000000000000080800000000000020000040000000000000000000000000000200000000000000000100000000000000',
    transactionHash: '0x00289aec83e4f8a109e2026e9e7f9a122bcf66116b1fc9c48099d668eec49f25',
    transactionIndex: '0xc5',
    effectiveGasPrice: '0xc6e9e20'
  }
}

Source code​

sendUserOperation

Advanced Methods​

The Advanced methods offer fine control and customization, catering to developers who require detailed configurations for their specific requirements.

createAccountAddress​

Calculates the Account address from the initial owners

Usage​

In this example, we initiate a single owner account.

example.ts
import { SafeAccount } from "abstractionkit";

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
const safeAddress = SafeAccount.createAccountAddress(
    [ownerPublicAddress],
);

console.log("Account address (sender): " + safeAddress);
Example Response
Account address(sender) : 0x1a02592A3484c2077d2E5D24482497F85e1980C6

Source code​

createAccountAddress

createInitCode​

Calculates the initCode needed to deploy the account on-chain.

Usage​

In this example, we initiate a single owner account.

example.ts
import { SafeAccount } from "abstractionkit";

const owner1PublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
const owner2PublicAddress = "0x4991A5360e5da9BAF62fF644d89F46268e5159eA";
const initCode = SafeAccount.createInitCode([ownerPublicAddress, owner2PublicAddress], 2);

console.log("initCode: ", initCode);
Example Response
initCode: 0x...

Source code​

createInitCode

createAccountAddressAndInitCode​

Calculates the Safe address and the initCode needed to deploy the account on-chain.

Usage​

In this example, we initiate a single owner account.

example.ts
import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
let [accountAddress, initCode] = SafeAccount.createAccountAddressAndInitCode(
    [ownerPublicAddress],
);

console.log("Account address (sender): " + accountAddress);
console.log("initCode: ", initCode);
Example Response
Account address(sender) : 0x1a02592A3484c2077d2E5D24482497F85e1980C6
initCode: 0x...

Source code​

createAccountAddressAndInitCode

createInitializerCallData​

Creates the initializer calldata

Usage​

import { SafeAccountV0_3_0 as SafeAccount } from "abstractionkit";

const initializeCallData = SafeAccount.createInitializerCallData(
  [ownerPublicAddress], // owners
  1, //threshold
);
console.log("initializeCallData: " + initializeCallData);
Example Response
initializeCallData: 0xb63e800d000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000010000000000000000000000002dd68b007b46fbe91b9a7c3eda5a7a1063cb5b47000000000000000000000000000000000000000000000000000000000000014000000000000000000000000075cf11467937ce3f2f357ce24ffc3dbf8fd5c2260000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000bdbc5fbc9ca8c3f514d073ec3de840ac84fc6d3100000000000000000000000000000000000000000000000000000000000000648d0dc49f0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000075cf11467937ce3f2f357ce24ffc3dbf8fd5c22600000000000000000000000000000000000000000000000000000000

Source code​

createInitializerCallData

createAccountCallDataSingleTransaction​

Encodes calldata for a single MetaTransaction to be executed by a Safe account.

Usage​

In this example, we make a transfer of 1 wei to a random address.

example.ts
import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]);

const callData = smartAccount.createAccountCallDataSingleTransaction({
  to: "0x1a02592A3484c2077d2E5D24482497F85e1980C6",
  value: 1,
  data: "0x",
});

console.log("callData: " + callData);
Example Response
callData : 0xf34308ef000000000000000000000000b4fbf271143f4fbf7b91a5ded31805e42b2208d6000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000

Source code​

createAccountCallDataSingleTransaction

createAccountCallDataBatchTransactions​

Encodes calldata for a list of MetaTransactions to be executed by a Safe account.

Usage​

In this example, we make a transfer to 2 different random addresses, 1 wei each.

example.ts
import {
  SafeAccountV0_2_0 as SafeAccount,
  MetaTransaction,
} from "abstractionkit";

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]);

const tx1: MetaTransaction = {
  to: "0x1a02592A3484c2077d2E5D24482497F85e1980C6",
  value: 1,
  data: "0x",
};
const tx2: MetaTransaction = {
  to: "0x3fe285dcd76bcce4ac92d38a6f2f8e964041e020",
  value: 1,
  data: "0x",
};

const callData = SafeAccount.createAccountCallDataBatchTransactions([tx1, tx2]);

console.log("callData: " + callData);
Example Response
callData : 0xf34308ef000000000000000000000000b4fbf271143f4fbf7b91a5ded31805e42b2208d6000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000

Source code​

createAccountCallDataBatchTransactions

estimateUserOperationGas​

Estimates gas limits for a UserOperation.

Usage​

import {
  SafeAccountV0_2_0 as SafeAccount,
  UserOperationV6
} from "abstractionkit";

const bundlerRPC = "https://api.candide.dev/public/v3/11155111";

const ownerPublicAddress = "0xBdbc5FBC9cA8C3F514D073eC3de840Ac84FC6D31";
const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress])

// Use createUserOperation() to help you construct the userOp below
let userOperation: UserOperationV6 = smartAccount.createUserOperation(..);

const [preVerificationGas, verificationGasLimit, callGasLimit] = await estimateUserOperationGas(userOperation, bundlerRPC);
Example Response
[ 46840n, 64545n, 102761n ]

Source code​

estimateUserOperationGas

getUserOperationEip712Hash​

Creates a UserOperation EIP-712 hash.

Usage​

example
import {
  SafeAccountV0_2_0 as SafeAccount,
  UserOperationV6
} from "abstractionkit";

const userOperation: UserOperationV6 = smartAccount.createUserOperation(..)

const safeUserOpHash = SafeAccount.getUserOperationEip712Hash(userOperation, chainId);

console.log(safeUserOpHash);

Source code​

getUserOperationEip712Hash

formatEip712SignaturesToUseroperationSignature​

A static method to format a list of EIP-712 signatures to a UserOperation signature.

Usage​

import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";
import { Wallet } from "ethers";

const ownerPrivateKey = process.env.PRIVATE_KEY as string;
const signer = new Wallet(ownerPrivateKey);
const ownerPublicAddress = signer.address;

const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]);

let userOperation = ... // smartAccount.createUserOperation(..)

const safeUserOpHash = SafeAccount.getUserOperationEip712Hash(userOperation, chainId);
const signature = signer.signingKey.sign(safeUserOpHash).serialized;

const formatedSig = SafeAccount.formatEip712SignaturesToUseroperationSignature([ownerPublicAddress], [signature]);
userOperation.signature = formatedSig;
Example Response
0x0000000000000000000000006da39f6f7b0d2c0035084d3c313350697b3167ff591a84bf0b4bb4741224b5d226682ec306544c091e2b6535042c900b459282edfe98e393d552963ca8db11731c

Source code​

formatEip712SignaturesToUseroperationSignature

isModuleEnabled​

Checks if a specified module is enabled for a given Safe account. This function returns a boolean indicating the module's status.

keytypedescription
nodeRpcUrlstringThe JSON-RPC API url for the target chain.
moduleAddressstringThe module address to check if enabled.

createAddOwnerWithThresholdMetaTransactions​

Creates a meta-transaction to add a new owner to the Safe account with a specified threshold. This function returns an object containing the meta-transaction details, including the target address, encoded data, and transaction value.

keytypedescription
newOwnerobjectThe public address of the new owner to be added
newOwner.SignerECDSAPublicAddress | WebauthnPublicKeySigner type which can be either an ECDSA public address or a Webauthn public key
thresholdnumberThe new threshold value for owner confirmations.
overridesobjectOptional Overrides for the default values used in the transaction.
overrides.nodeRpcUrlstring?The JSON-RPC API url for the target chain, to check if the new webauthn owner is deployed or not
overrides.eip7212WebAuthnPrecompileVerifierstring?Address for the EIP-7212 WebAuthn precompile verifier.
overrides.eip7212WebAuthnContractVerifierstring?Address for the EIP-7212 WebAuthn contract verifier.
overrides.webAuthnSignerFactorystring?Address for the WebAuthn signer factory.
overrides.webAuthnSignerSingletonstring?Address for the WebAuthn signer singleton.

createSwapOwnerMetaTransactions​

Creates a meta-transaction to swap an owner in the Safe account. If a new owner verifier is not already deployed, it will deploy one and fetch the previous owner automatically. This function returns a promise that resolves to a list of meta-transactions containing the necessary details for the swap and deployment.

keytypedescription
nodeRpcUrlstringThe JSON-RPC API URL for the target chain to fetch the previous owner.
newOwnerobjectThe public address of the new owner to be added.
newOwner.SignerECDSAPublicAddress | WebauthnPublicKeySigner type which can be either an ECDSA public address or a Webauthn public key
oldOwnerSignerThe public address of the owner to be replaced.
overridesobjectOverrides for the default values used in the transaction.
overrides.prevOwnerstringIf set, it will be used as the previous owner instead of fetching it.
overrides.eip7212WebAuthnPrecompileVerifierstringAddress for the EIP-7212 WebAuthn precompile verifier.
overrides.eip7212WebAuthnContractVerifierstringAddress for the EIP-7212 WebAuthn contract verifier.
overrides.webAuthnSignerFactorystringAddress for the WebAuthn signer factory.
overrides.webAuthnSignerSingletonstringAddress for the WebAuthn signer singleton.

createRemoveOwnerMetaTransaction​

Creates a meta-transaction to remove an owner from the Safe account, fetching the previous owner if not provided. This function returns a promise that resolves to a meta-transaction object containing the necessary details for the removal.

keytypedescription
nodeRpcUrlstringThe JSON-RPC API URL for the target chain to fetch the previous owner.
ownerToDeleteobjectThe public address of the owner to be deleted.
ownerToDelete.SignerECDSAPublicAddress | WebauthnPublicKeySigner type which can be either an ECDSA public address or a Webauthn public key
thresholdnumberThe new threshold value for owner confirmations after removal.
overridesobjectOptional Overrides for the default values used in the transaction.
overrides.prevOwnerstringIf set, it will be used as the previous owner instead of fetching it.
overrides.eip7212WebAuthnPrecompileVerifierstringAddress for the EIP-7212 WebAuthn precompile verifier.
overrides.eip7212WebAuthnContractVerifierstringAddress for the EIP-7212 WebAuthn contract verifier.
overrides.webAuthnSignerFactorystringAddress for the WebAuthn signer factory.
overrides.webAuthnSignerSingletonstringAddress for the WebAuthn signer singleton.

createDisableModuleMetaTransaction​

Creates a meta-transaction to disable a module from the Safe account. The function automatically fetches the previous module address in the linked list if not provided in the overrides. This function returns a promise that resolves to a meta-transaction object containing the necessary details for disabling the module.

keytypedescription
nodeRpcUrlstringThe JSON-RPC API URL for the target chain to fetch the previous module address.
moduleToDisableAddressstringThe address of the module to be disabled.
accountAddressstringThe Safe account address for which to disable the module.
overridesobjectOptional overrides for the default values used in the transaction.
overrides.prevModuleAddressstringIf set, it will be used as the previous module address instead of fetching it.
overrides.modulesStartstringStarting address for the module pagination query.
overrides.modulesPageSizebigintPage size for the module pagination query.

verifyWebAuthnSignatureForMessageHash​

A static method that verifies a webAuthn signed hash message for Passkeys, and can be also used even if the safe account hasn't been deployed yet.

keytypedescription
nodeRpcUrlstringThe JSON-RPC API url for the target chain.
webAuthnPublicKeyobjectThe x and y coordinates of the webAuthn public key
webAuthnPublicKey.xbigintThe x coordinate of the webAuthn public key
webAuthnPublicKey.ybigintThe y coordinate of the webAuthn public key
messagestringThe hashed message to verify
signaturestringThe signed message
overridesobjectOptional overrides for webAuthn verify signature message
overrides.webAuthnSignerSingletonstringSpecify the WebAuthn signer singleton
overrides.eip7212WebAuthnPrecompileVerifierstringSpecify the EIP-7212 WebAuthn precompile verifier
overrides.eip7212WebAuthnContractVerifierstringSpecify the EIP-7212 WebAuthn contract verifier

getUserOperationEip712Data​

A static method that returns the EIP-712 domain data for a UserOperation.

keytypedescription
userOperationobjectUserOp to hash
userOperation.senderstringThe account making the operation
userOperation.noncestringAnti-replay parameter (see “Semi-abstracted Nonce Support” )
userOperation.initCodestringThe initCode of the account (needed if and only if the account is not yet on-chain and needs to be created)
userOperation.callDatastringThe data to pass to the sender during the main execution call
userOperation.callGasLimitbigintThe amount of gas to allocate the main execution call
userOperation.verificationGasLimitbigintThe amount of gas to allocate for the verification step
userOperation.preVerificationGasbigintThe amount of gas to pay for to compensate the bundler for pre-verification execution and calldata
userOperation.maxFeePerGasbigintMaximum fee per gas (similar to EIP-1559 max_fee_per_gas)
userOperation.maxPriorityFeePerGasbigintMaximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas)
userOperation.paymasterAndDatastringAddress of paymaster sponsoring the transaction, followed by extra data to send to the paymaster (empty for self-sponsored transaction). Revolves to '0x' if not using a paymaster, and a paymasterDummyData when estimating gas
userOperation.signaturestringThe signature for the userOperation. It is the data passed into the account along with the nonce during the verification step. Resolves to '0x' when the user did not provide their signature yet
chainIdbiginttarget chain id
overrides?objectundefined
overrides?.validAfter?bigintTimestamp the signature will be valid after
overrides?.validUntil?bigintTimestamp the signature will be valid until
overrides?.entrypointAddress?stringAddress of the entrypoint contract
overrides?.safe4337ModuleAddress?stringAddress of the Safe 4337 module.

createMigrateToSafeAccountV0_3_0MetaTransactions​

Creates an array of meta-transactions to migrate a Safe account from EntryPoint v0.6 (module v0.2.0) to EntryPoint v0.7 (module v0.3.0). The migration disables the v0.6 module, enables the v0.7 module, and updates the fallback handler.

Usage​

import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit";

const nodeRpcUrl = "https://rpc2.sepolia.org";

const smartAccount = new SafeAccount(accountAddress);

const migrationMetaTransactions =
  await smartAccount.createMigrateToSafeAccountV0_3_0MetaTransactions(nodeRpcUrl);

// Include these meta-transactions in a UserOperation to execute the migration
const userOperation = await smartAccount.createUserOperation(
  migrationMetaTransactions,
  nodeRpcUrl,
  bundlerUrl,
);
keytypedescription
nodeRpcUrlstringThe JSON-RPC API URL for the target chain.
overrides?objectOptional overrides for contract addresses and pagination.
overrides?.safeV06ModuleAddress?stringOverride the Safe v0.6 module address to disable.
overrides?.safeV07ModuleAddress?stringOverride the Safe v0.7 module address to enable.
overrides?.pageSize?bigintPage size for the module pagination query.
overrides?.modulesStart?stringStarting address for the module pagination query.

Source code​

createMigrateToSafeAccountV0_3_0MetaTransactions

Audits​

Last updated on by marc