Documentation Index
Fetch the complete documentation index at: https://docs.cloud.coinbase.com/llms.txt
Use this file to discover all available pages before exploring further.
Interfaces
CreateServerAccountOptions
Defined in: src/client/evm/evm.types.ts:339
Options for creating an EVM server account.
Properties
accountPolicy?
optional accountPolicy: string;
idempotencyKey?
optional idempotencyKey: string;
name?
Defined in: src/client/evm/evm.types.ts:341
The name of the account.
CreateSmartAccountOptions
Defined in: src/client/evm/evm.types.ts:502
Options for creating an EVM smart account.
Properties
enableSpendPermissions?
optional enableSpendPermissions: boolean;
idempotencyKey?
optional idempotencyKey: string;
name?
Defined in: src/client/evm/evm.types.ts:508
The name of the account.
owner
Defined in: src/client/evm/evm.types.ts:504
The owner of the account.
CreateSwapQuoteOptions
Defined in: src/client/evm/evm.types.ts:116
Options for creating a swap quote between two tokens on an EVM network.
Properties
fromAmount
Defined in: src/client/evm/evm.types.ts:124
The amount to send in atomic units of the token.
fromToken
fromToken: `0x${string}`;
gasPrice?
optional gasPrice: bigint;
idempotencyKey?
optional idempotencyKey: string;
network
network: EvmSwapsNetwork;
signerAddress?
optional signerAddress: `0x${string}`;
slippageBps?
optional slippageBps: number;
smartAccount?
optional smartAccount: {
address: `0x${string}`;
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
name?: string;
owners: EvmAccount[];
policies: undefined | string[];
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
type: "evm-smart";
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: ...; sendUserOperation: ...; waitForUserOperation: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
waitForFundOperationReceipt: Promise<WaitForFundOperationResult>;
};
address
The smart account’s address.
fund()
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
Parameters
options
Omit<EvmFundOptions, "address">
The options for the fund operation.
Returns
Promise<FundOperationResult>
A promise that resolves to the fund operation result containing the transfer details.
Example
const fundOperation = await account.fund({
network: "base",
token: "usdc",
amount: 1000000n,
});
getUserOperation()
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
Parameters
options
Omit<GetUserOperationOptions, "smartAccount">
Parameters for getting the user operation.
Returns
Promise<UserOperation>
A promise that resolves to the user operation.
Example
const userOp = await smartAccount.getUserOperation({
userOpHash: "0x1234567890123456789012345678901234567890",
});
listTokenBalances()
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
Parameters
options
Omit<ListTokenBalancesOptions, "address">
The options for the list token balances.
Returns
Promise<ListTokenBalancesResult>
The result of the list token balances.
Example
const balances = await account.listTokenBalances({
network: "base-sepolia",
});
name?
The name of the smart account.
owners
Array of accounts that own and can sign for the smart account (currently only supports one owner but will be extended to support multiple owners in the future).
policies
policies: undefined | string[];
quoteFund()
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
Parameters
options
Omit<EvmQuoteFundOptions, "address">
The options for the quote fund.
Returns
Promise<EvmQuote>
A promise that resolves to a Quote object containing details about the funding operation.
Example
const quote = await account.quoteFund({
network: "base",
token: "usdc",
amount: 1000000n,
});
quoteSwap()
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
Parameters
options
SmartAccountQuoteSwapOptions
Configuration options for creating the swap quote.
Returns
Promise<SmartAccountQuoteSwapResult>
A promise that resolves to the swap quote or a response indicating that liquidity is unavailable.
Example
const swapQuote = await smartAccount.quoteSwap({
network: "base",
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
if (swapQuote.liquidityAvailable) {
console.log(`Can swap for ${swapQuote.toAmount} USDC`);
}
requestFaucet()
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
Parameters
options
Omit<RequestFaucetOptions, "address">
Parameters for requesting funds from the EVM faucet.
Returns
Promise<RequestFaucetResult>
A promise that resolves to the transaction hash.
Example
const result = await account.requestFaucet({
network: "base-sepolia",
token: "eth",
});
sendUserOperation()
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
Parameters
options
Omit<SendUserOperationOptions<unknown[]>, "smartAccount">
Parameters for sending the user operation.
Returns
Promise<SendUserOperationReturnType>
A promise that resolves to an object containing the smart account address,
the user operation hash, and the status of the user operation.
Example
const userOp = await smartAccount.sendUserOperation({
network: "base-sepolia",
calls: [
{
to: "0x1234567890123456789012345678901234567890",
value: parseEther("0.000001"),
data: "0x",
},
],
});
signTypedData()
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
Parameters
options
Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}
Configuration options for signing the typed data.
Returns
Promise<`0x${string}`>
A promise that resolves to the signature.
Example
const signature = await smartAccount.signTypedData({
network: "base-sepolia",
typedData: {
domain: {
name: "Test",
chainId: 84532,
verifyingContract: "0x0000000000000000000000000000000000000000",
},
types: {
Test: [{ name: "name", type: "string" }],
},
primaryType: "Test",
message: {
name: "John Doe",
},
},
});
swap()
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
Parameters
options
SmartAccountSwapOptions
Configuration options for the swap.
Returns
Promise<SmartAccountSwapResult>
A promise that resolves to the user operation result.
Throws
If liquidity is not available when using inline options.
Examples
// First create a swap quote
const swapQuote = await cdp.evm.createSwapQuote({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
taker: smartAccount.address,
signerAddress: smartAccount.owners[0].address
});
// Check if liquidity is available
if (!swapQuote.liquidityAvailable) {
console.error("Insufficient liquidity for swap");
return;
}
// Execute the swap
const { userOpHash } = await smartAccount.swap({
swapQuote: swapQuote
});
console.log(`Swap executed with user op hash: ${userOpHash}`);
// Create and execute swap in one call
const { userOpHash } = await smartAccount.swap({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
console.log(`Swap executed with user op hash: ${userOpHash}`);
transfer()
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
Parameters
options
SmartAccountTransferOptions
The options for the transfer.
Returns
Promise<SendUserOperationReturnType>
The user operation result.
Examples
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
import { parseUnits } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseUnits("0.01", 6), // USDC uses 6 decimal places
token: "usdc",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "eth",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "0x4200000000000000000000000000000000000006", // WETH on Base Sepolia
network: "base-sepolia",
});
const sender = await cdp.evm.createAccount({ name: "Sender" });
const receiver = await cdp.evm.createAccount({ name: "Receiver" });
const { userOpHash } = await sender.transfer({
to: receiver,
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
type
Identifier for the smart account type.
useNetwork()
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: ...; sendUserOperation: ...; waitForUserOperation: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
Type Parameters
Network
Network extends KnownEvmNetworks
Parameters
network
Network
The network name or RPC URL
Returns
Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, “useNetwork”> & { [K in string | number | symbol]: ({ getUserOperation: …; sendUserOperation: …; waitForUserOperation: … } & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)))[K] } & { network: Network })[K] }>
Example
// For known networks, type is inferred automatically:
const baseAccount = await smartAccount.useNetwork("base");
// For custom RPC URLs with type hints (requires casting):
const typedAccount = await smartAccount.useNetwork<"base">("https://mainnet.base.org" as "base");
// For custom RPC URLs without type hints (only sendTransaction, transfer and waitForTransactionReceipt methods available):
const customAccount = await smartAccount.useNetwork("https://mainnet.base.org");
useSpendPermission()
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
Parameters
options
UseSpendPermissionOptions
Configuration options for using the spend permission.
Returns
Promise<SendUserOperationReturnType>
A promise that resolves to the user operation result.
Throws
If the network doesn’t support spend permissions via CDP API.
Example
const spendPermission = {
account: "0x1234...", // Smart account that owns the tokens
spender: smartAccount.address, // This smart account that can spend
token: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", // ETH
allowance: parseEther("0.01"),
period: 86400, // 1 day
start: 0,
end: 281474976710655,
salt: 0n,
extraData: "0x",
};
const result = await smartAccount.useSpendPermission({
spendPermission,
value: parseEther("0.001"), // Spend 0.001 ETH
network: "base-sepolia",
});
waitForUserOperation()
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
Parameters
options
Omit<WaitForUserOperationOptions, "smartAccountAddress">
Parameters for waiting for the user operation.
Returns
Promise<WaitForUserOperationReturnType>
A promise that resolves to the transaction receipt.
Example
// Send a user operation and get the user operation hash
const { userOpHash } = await smartAccount.sendUserOperation({
network: "base-sepolia",
calls: [
{
to: "0x0000000000000000000000000000000000000000",
value: parseEther("0.000001"),
data: "0x",
},
],
});
// Wait for the user operation to complete or fail
const result = await smartAccount.waitForUserOperation({
userOpHash: userOp.userOpHash,
});
waitForFundOperationReceipt()
waitForFundOperationReceipt(options: WaitForFundOperationOptions): Promise<WaitForFundOperationResult>;
Parameters
options
WaitForFundOperationOptions
The options for the wait for fund operation.
Returns
Promise<WaitForFundOperationResult>
A promise that resolves to the completed transfer receipt containing details about the funding operation.
Example
const completedTransfer = await account.waitForFundOperationReceipt({
transferId: "transfer_123",
});
taker
Defined in: src/client/evm/evm.types.ts:126
The address receiving the output of the swap.
toToken
Defined in: src/client/evm/evm.types.ts:120
The token to receive (destination token).
CreateSwapQuoteResult
Defined in: src/client/evm/evm.types.ts:224
Result of creating a swap quote.
Properties
blockNumber
Defined in: src/client/evm/evm.types.ts:240
The block number at which the liquidity conditions were examined.
execute()
execute: (options?: ExecuteSwapQuoteOptions) => Promise<ExecuteSwapQuoteResult>;
Parameters
options?
ExecuteSwapQuoteOptions
Options for executing the swap.
Returns
Promise<ExecuteSwapQuoteResult>
A promise that resolves to the swap execution result.
fees
Defined in: src/client/evm/evm.types.ts:242
The estimated fees for the swap.
fromAmount
Defined in: src/client/evm/evm.types.ts:234
The amount to send in atomic units of the token.
fromToken
fromToken: `0x${string}`;
issues
Defined in: src/client/evm/evm.types.ts:244
Potential issues discovered during validation.
liquidityAvailable
liquidityAvailable: true;
minToAmount
Defined in: src/client/evm/evm.types.ts:238
The minimum amount to receive after slippage in atomic units of the token.
network
network: EvmSwapsNetwork;
permit2?
optional permit2: {
eip712: EIP712Message;
};
eip712
EIP-712 typed data for signing.
toAmount
Defined in: src/client/evm/evm.types.ts:236
The amount to receive in atomic units of the token.
toToken
Defined in: src/client/evm/evm.types.ts:230
The token to receive (destination token).
transaction?
optional transaction: {
data: `0x${string}`;
gas: bigint;
gasPrice: bigint;
to: `0x${string}`;
value: bigint;
};
data
The transaction data.
gas
The gas limit for the transaction.
gasPrice
The gas price for the transaction in Wei.
to
The contract address to send the transaction to.
value
The value to send with the transaction in Wei.
EvmCall
Defined in: src/client/evm/evm.types.ts:299
A call to be executed in a user operation.
Properties
data
Defined in: src/client/evm/evm.types.ts:309
The call data to send. This is the hex-encoded data of the function call consisting of the method selector and the function arguments.
to
Defined in: src/client/evm/evm.types.ts:303
The address the call is directed to.
value
Defined in: src/client/evm/evm.types.ts:305
The amount of ETH to send with the call, in wei.
ExecuteSwapQuoteOptions
Defined in: src/client/evm/evm.types.ts:202
Options for executing a swap quote.
Properties
idempotencyKey?
optional idempotencyKey: string;
ExecuteSwapQuoteResult
Defined in: src/client/evm/evm.types.ts:210
Result of executing a swap quote.
Properties
smartAccountAddress?
optional smartAccountAddress: `0x${string}`;
status?
optional status: "broadcast";
transactionHash?
optional transactionHash: `0x${string}`;
userOpHash?
optional userOpHash: `0x${string}`;
ExportServerAccountOptions
Defined in: src/client/evm/evm.types.ts:365
Options for exporting an EVM server account.
Properties
address?
optional address: `0x${string}`;
idempotencyKey?
optional idempotencyKey: string;
name?
Defined in: src/client/evm/evm.types.ts:369
The name of the account.
GetOrCreateServerAccountOptions
Defined in: src/client/evm/evm.types.ts:399
Options for getting an EVM account, or creating one if it doesn’t exist.
Properties
name
Defined in: src/client/evm/evm.types.ts:401
The name of the account.
GetOrCreateSmartAccountOptions
Defined in: src/client/evm/evm.types.ts:407
Options for getting an EVM account, or creating one if it doesn’t exist.
Properties
enableSpendPermissions?
optional enableSpendPermissions: boolean;
name
Defined in: src/client/evm/evm.types.ts:409
The name of the account.
owner
Defined in: src/client/evm/evm.types.ts:411
The owner of the account.
GetServerAccountOptions
Defined in: src/client/evm/evm.types.ts:377
Options for getting an EVM account.
Properties
address?
optional address: `0x${string}`;
name?
Defined in: src/client/evm/evm.types.ts:381
The name of the account.
GetSmartAccountOptions
Defined in: src/client/evm/evm.types.ts:387
Options for getting an EVM smart account.
Properties
address?
optional address: `0x${string}`;
name?
Defined in: src/client/evm/evm.types.ts:393
The name of the account.
owner
Defined in: src/client/evm/evm.types.ts:391
The owner of the account.
GetSwapPriceOptions
Defined in: src/client/evm/evm.types.ts:142
Options for getting a swap price.
Properties
fromAmount
Defined in: src/client/evm/evm.types.ts:150
The amount to send in atomic units of the token.
fromToken
fromToken: `0x${string}`;
gasPrice?
optional gasPrice: bigint;
idempotencyKey?
optional idempotencyKey: string;
network
network: EvmSwapsNetwork;
signerAddress?
optional signerAddress: `0x${string}`;
slippageBps?
optional slippageBps: number;
taker
Defined in: src/client/evm/evm.types.ts:152
The address that will perform the swap.
toToken
Defined in: src/client/evm/evm.types.ts:146
The token to receive (destination token).
GetSwapPriceResult
Defined in: src/client/evm/evm.types.ts:166
Result of getting a swap price.
Properties
blockNumber
Defined in: src/client/evm/evm.types.ts:180
The block number at which the liquidity conditions were examined.
fees
Defined in: src/client/evm/evm.types.ts:182
The estimated fees for the swap.
fromAmount
Defined in: src/client/evm/evm.types.ts:174
The amount to send in atomic units of the token.
fromToken
fromToken: `0x${string}`;
gas?
Defined in: src/client/evm/evm.types.ts:186
The gas estimate for the swap.
gasPrice?
optional gasPrice: bigint;
issues
Defined in: src/client/evm/evm.types.ts:184
Potential issues discovered during validation.
liquidityAvailable
liquidityAvailable: true;
minToAmount
Defined in: src/client/evm/evm.types.ts:178
The minimum amount to receive after slippage in atomic units of the token.
toAmount
Defined in: src/client/evm/evm.types.ts:176
The amount to receive in atomic units of the token.
toToken
Defined in: src/client/evm/evm.types.ts:170
The token to receive (destination token).
GetUserOperationOptions
Defined in: src/client/evm/evm.types.ts:275
Options for getting a user operation.
Properties
smartAccount
smartAccount:
| `0x${string}`
| {
address: `0x${string}`;
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
name?: string;
owners: EvmAccount[];
policies: undefined | string[];
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
type: "evm-smart";
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: ...; sendUserOperation: ...; waitForUserOperation: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
waitForFundOperationReceipt: Promise<WaitForFundOperationResult>;
}
| ReadonlySmartAccount;
Type declaration
`0x${string}`
{
address: `0x${string}`;
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
name?: string;
owners: EvmAccount[];
policies: undefined | string[];
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
type: "evm-smart";
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: ...; sendUserOperation: ...; waitForUserOperation: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
waitForFundOperationReceipt: Promise<WaitForFundOperationResult>;
}
address
The smart account’s address.
fund()
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
Parameters
options
Omit<EvmFundOptions, "address">
The options for the fund operation.
Returns
Promise<FundOperationResult>
A promise that resolves to the fund operation result containing the transfer details.
Example
const fundOperation = await account.fund({
network: "base",
token: "usdc",
amount: 1000000n,
});
getUserOperation()
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
Parameters
options
Omit<GetUserOperationOptions, "smartAccount">
Parameters for getting the user operation.
Returns
Promise<UserOperation>
A promise that resolves to the user operation.
Example
const userOp = await smartAccount.getUserOperation({
userOpHash: "0x1234567890123456789012345678901234567890",
});
listTokenBalances()
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
Parameters
options
Omit<ListTokenBalancesOptions, "address">
The options for the list token balances.
Returns
Promise<ListTokenBalancesResult>
The result of the list token balances.
Example
const balances = await account.listTokenBalances({
network: "base-sepolia",
});
name?
The name of the smart account.
owners
Array of accounts that own and can sign for the smart account (currently only supports one owner but will be extended to support multiple owners in the future).
policies
policies: undefined | string[];
quoteFund()
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
Parameters
options
Omit<EvmQuoteFundOptions, "address">
The options for the quote fund.
Returns
Promise<EvmQuote>
A promise that resolves to a Quote object containing details about the funding operation.
Example
const quote = await account.quoteFund({
network: "base",
token: "usdc",
amount: 1000000n,
});
quoteSwap()
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
Parameters
options
SmartAccountQuoteSwapOptions
Configuration options for creating the swap quote.
Returns
Promise<SmartAccountQuoteSwapResult>
A promise that resolves to the swap quote or a response indicating that liquidity is unavailable.
Example
const swapQuote = await smartAccount.quoteSwap({
network: "base",
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
if (swapQuote.liquidityAvailable) {
console.log(`Can swap for ${swapQuote.toAmount} USDC`);
}
requestFaucet()
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
Parameters
options
Omit<RequestFaucetOptions, "address">
Parameters for requesting funds from the EVM faucet.
Returns
Promise<RequestFaucetResult>
A promise that resolves to the transaction hash.
Example
const result = await account.requestFaucet({
network: "base-sepolia",
token: "eth",
});
sendUserOperation()
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
Parameters
options
Omit<SendUserOperationOptions<unknown[]>, "smartAccount">
Parameters for sending the user operation.
Returns
Promise<SendUserOperationReturnType>
A promise that resolves to an object containing the smart account address,
the user operation hash, and the status of the user operation.
Example
const userOp = await smartAccount.sendUserOperation({
network: "base-sepolia",
calls: [
{
to: "0x1234567890123456789012345678901234567890",
value: parseEther("0.000001"),
data: "0x",
},
],
});
signTypedData()
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
Parameters
options
Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}
Configuration options for signing the typed data.
Returns
Promise<`0x${string}`>
A promise that resolves to the signature.
Example
const signature = await smartAccount.signTypedData({
network: "base-sepolia",
typedData: {
domain: {
name: "Test",
chainId: 84532,
verifyingContract: "0x0000000000000000000000000000000000000000",
},
types: {
Test: [{ name: "name", type: "string" }],
},
primaryType: "Test",
message: {
name: "John Doe",
},
},
});
swap()
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
Parameters
options
SmartAccountSwapOptions
Configuration options for the swap.
Returns
Promise<SmartAccountSwapResult>
A promise that resolves to the user operation result.
Throws
If liquidity is not available when using inline options.
Examples
// First create a swap quote
const swapQuote = await cdp.evm.createSwapQuote({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
taker: smartAccount.address,
signerAddress: smartAccount.owners[0].address
});
// Check if liquidity is available
if (!swapQuote.liquidityAvailable) {
console.error("Insufficient liquidity for swap");
return;
}
// Execute the swap
const { userOpHash } = await smartAccount.swap({
swapQuote: swapQuote
});
console.log(`Swap executed with user op hash: ${userOpHash}`);
// Create and execute swap in one call
const { userOpHash } = await smartAccount.swap({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
console.log(`Swap executed with user op hash: ${userOpHash}`);
transfer()
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
Parameters
options
SmartAccountTransferOptions
The options for the transfer.
Returns
Promise<SendUserOperationReturnType>
The user operation result.
Examples
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
import { parseUnits } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseUnits("0.01", 6), // USDC uses 6 decimal places
token: "usdc",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "eth",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "0x4200000000000000000000000000000000000006", // WETH on Base Sepolia
network: "base-sepolia",
});
const sender = await cdp.evm.createAccount({ name: "Sender" });
const receiver = await cdp.evm.createAccount({ name: "Receiver" });
const { userOpHash } = await sender.transfer({
to: receiver,
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
type
Identifier for the smart account type.
useNetwork()
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: ...; sendUserOperation: ...; waitForUserOperation: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
Type Parameters
Network
Network extends KnownEvmNetworks
Parameters
network
Network
The network name or RPC URL
Returns
Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, “useNetwork”> & { [K in string | number | symbol]: ({ getUserOperation: …; sendUserOperation: …; waitForUserOperation: … } & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)))[K] } & { network: Network })[K] }>
Example
// For known networks, type is inferred automatically:
const baseAccount = await smartAccount.useNetwork("base");
// For custom RPC URLs with type hints (requires casting):
const typedAccount = await smartAccount.useNetwork<"base">("https://mainnet.base.org" as "base");
// For custom RPC URLs without type hints (only sendTransaction, transfer and waitForTransactionReceipt methods available):
const customAccount = await smartAccount.useNetwork("https://mainnet.base.org");
useSpendPermission()
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
Parameters
options
UseSpendPermissionOptions
Configuration options for using the spend permission.
Returns
Promise<SendUserOperationReturnType>
A promise that resolves to the user operation result.
Throws
If the network doesn’t support spend permissions via CDP API.
Example
const spendPermission = {
account: "0x1234...", // Smart account that owns the tokens
spender: smartAccount.address, // This smart account that can spend
token: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", // ETH
allowance: parseEther("0.01"),
period: 86400, // 1 day
start: 0,
end: 281474976710655,
salt: 0n,
extraData: "0x",
};
const result = await smartAccount.useSpendPermission({
spendPermission,
value: parseEther("0.001"), // Spend 0.001 ETH
network: "base-sepolia",
});
waitForUserOperation()
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
Parameters
options
Omit<WaitForUserOperationOptions, "smartAccountAddress">
Parameters for waiting for the user operation.
Returns
Promise<WaitForUserOperationReturnType>
A promise that resolves to the transaction receipt.
Example
// Send a user operation and get the user operation hash
const { userOpHash } = await smartAccount.sendUserOperation({
network: "base-sepolia",
calls: [
{
to: "0x0000000000000000000000000000000000000000",
value: parseEther("0.000001"),
data: "0x",
},
],
});
// Wait for the user operation to complete or fail
const result = await smartAccount.waitForUserOperation({
userOpHash: userOp.userOpHash,
});
waitForFundOperationReceipt()
waitForFundOperationReceipt(options: WaitForFundOperationOptions): Promise<WaitForFundOperationResult>;
Parameters
options
WaitForFundOperationOptions
The options for the wait for fund operation.
Returns
Promise<WaitForFundOperationResult>
A promise that resolves to the completed transfer receipt containing details about the funding operation.
Example
const completedTransfer = await account.waitForFundOperationReceipt({
transferId: "transfer_123",
});
ReadonlySmartAccount
userOpHash
userOpHash: `0x${string}`;
ImportServerAccountOptions
Defined in: src/client/evm/evm.types.ts:351
Options for importing an EVM server account.
Properties
encryptionPublicKey?
optional encryptionPublicKey: string;
idempotencyKey?
optional idempotencyKey: string;
name?
Defined in: src/client/evm/evm.types.ts:355
The name of the account.
privateKey
privateKey: `0x${string}`;
ListServerAccountResult
Defined in: src/client/evm/evm.types.ts:477
The result of listing EVM server accounts.
Properties
accounts
accounts: {
address: `0x${string}`;
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
name?: string;
policies?: string[];
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
quoteSwap: (options: AccountQuoteSwapOptions) => Promise<AccountQuoteSwapResult>;
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<TransactionResult>;
sign: (parameters: {
hash: `0x${string}`;
}) => Promise<`0x${string}`>;
signMessage: (parameters: {
message: SignableMessage;
}) => Promise<`0x${string}`>;
signTransaction: (transaction: TransactionSerializable) => Promise<`0x${string}`>;
signTypedData: <typedData, primaryType>(parameters: TypedDataDefinition<typedData, primaryType>) => Promise<`0x${string}`>;
swap: (options: AccountSwapOptions) => Promise<SendSwapTransactionResult>;
transfer: (options: TransferOptions) => Promise<{
transactionHash: `0x${string}`;
}>;
type: "evm-server";
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<{ address: `0x${string}`; fund: (options: Omit<(...), (...)>) => Promise<(...)>; listTokenBalances: (options: Omit<(...), (...)>) => Promise<(...)>; name?: string; policies?: (...)[]; quoteFund: (options: Omit<(...), (...)>) => Promise<(...)>; quoteSwap: (options: AccountQuoteSwapOptions) => Promise<(...)>; requestFaucet: (options: Omit<(...), (...)>) => Promise<(...)>; sendTransaction: (options: Omit<(...), (...)>) => Promise<(...)>; sign: (parameters: { hash: ... }) => Promise<(...)>; signMessage: (parameters: { message: ... }) => Promise<(...)>; signTransaction: (transaction: TransactionSerializable) => Promise<(...)>; signTypedData: (parameters: TypedDataDefinition<(...), (...)>) => Promise<(...)>; swap: (options: AccountSwapOptions) => Promise<(...)>; transfer: (options: TransferOptions) => Promise<(...)>; type: "evm-server"; useNetwork: <Network extends NetworkOrRpcUrl>(network: Network) => Promise<{ [K in keyof (Omit<{ address: `0x${string}`; sign: (parameters: { hash: `0x${string}`; }) => Promise<`0x${string}`>; signMessage: (parameters: { message: SignableMessage; }) => Promise<...>; ... 15 more ...; useNetwork: ...; }, "transfer" | ... 5 more ....; useSpendPermission: (options: UseSpendPermissionOptions) => Promise<(...)>; waitForFundOperationReceipt: any }, "transfer" | "sendTransaction" | "quoteSwap" | "swap" | "useSpendPermission" | "useNetwork" | (keyof Actions)> & { [K in string | number | symbol]: ({ sendTransaction: ...; transfer: ...; waitForTransactionReceipt: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<TransactionResult>;
waitForFundOperationReceipt: Promise<WaitForFundOperationResult>;
}[];
address
The address of the signer.
fund()
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
Parameters
options
Omit<EvmFundOptions, "address">
The options for the fund operation.
Returns
Promise<FundOperationResult>
A promise that resolves to the fund operation result containing the transfer details.
Example
const fundOperation = await account.fund({
network: "base",
token: "usdc",
amount: 1000000n,
});
listTokenBalances()
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
Parameters
options
Omit<ListTokenBalancesOptions, "address">
The options for the list token balances.
Returns
Promise<ListTokenBalancesResult>
The result of the list token balances.
Example
const balances = await account.listTokenBalances({
network: "base-sepolia",
});
name?
Optional name for the server account.
policies?
optional policies: string[];
quoteFund()
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
Parameters
options
Omit<EvmQuoteFundOptions, "address">
The options for the quote fund.
Returns
Promise<EvmQuote>
A promise that resolves to a Quote object containing details about the funding operation.
Example
const quote = await account.quoteFund({
network: "base",
token: "usdc",
amount: 1000000n,
});
quoteSwap()
quoteSwap: (options: AccountQuoteSwapOptions) => Promise<AccountQuoteSwapResult>;
Parameters
options
AccountQuoteSwapOptions
Configuration options for creating the swap quote.
Returns
Promise<AccountQuoteSwapResult>
A promise that resolves to the swap quote or a response indicating that liquidity is unavailable.
Example
const swapQuote = await account.quoteSwap({
network: "base",
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
if (swapQuote.liquidityAvailable) {
console.log(`Can swap for ${swapQuote.toAmount} USDC`);
}
requestFaucet()
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
Parameters
options
Omit<RequestFaucetOptions, "address">
Parameters for requesting funds from the EVM faucet.
Returns
Promise<RequestFaucetResult>
A promise that resolves to the transaction hash.
Example
const result = await account.requestFaucet({
network: "base-sepolia",
token: "eth",
});
sendTransaction()
sendTransaction: (options: Omit<SendTransactionOptions, "address">) => Promise<TransactionResult>;
Parameters
options
Omit<SendTransactionOptions, "address">
Configuration options for sending the transaction.
Returns
Promise<TransactionResult>
A promise that resolves to the transaction hash.
Examples
Sending an RLP-encoded transaction
import { parseEther, serializeTransaction } from "viem";
import { baseSepolia } from "viem/chains";
const { transactionHash } = await account.sendTransaction({
transaction: serializeTransaction({
to: "0x4252e0c9A3da5A2700e7d91cb50aEf522D0C6Fe8",
value: parseEther("0.000001"),
chainId: baseSepolia.id,
// Fields below are optional, CDP API will populate them if omitted.
// nonce
// maxPriorityFeePerGas
// maxFeePerGas
// gas
}),
network: "base-sepolia",
});
const { transactionHash } = await account.sendTransaction({
transaction: {
to: "0x4252e0c9A3da5A2700e7d91cb50aEf522D0C6Fe8",
value: parseEther("0.000001"),
// Fields below are optional, CDP API will populate them if omitted.
// nonce
// maxPriorityFeePerGas
// maxFeePerGas
// gas
},
network: "base-sepolia",
});
sign()
sign: (parameters: {
hash: `0x${string}`;
}) => Promise<`0x${string}`>;
Parameters
parameters
hash
`0x${string}`
Returns
Promise<`0x${string}`>
signMessage()
signMessage: (parameters: {
message: SignableMessage;
}) => Promise<`0x${string}`>;
Parameters
parameters
message
SignableMessage
Returns
Promise<`0x${string}`>
signTransaction()
signTransaction: (transaction: TransactionSerializable) => Promise<`0x${string}`>;
Parameters
transaction
TransactionSerializable
Returns
Promise<`0x${string}`>
signTypedData()
signTypedData: <typedData, primaryType>(parameters: TypedDataDefinition<typedData, primaryType>) => Promise<`0x${string}`>;
Type Parameters
typedData
typedData extends
| Record<string, unknown>
| {
[key: string]: readonly TypedDataParameter[];
[key: `string[${string}]`]: undefined;
[key: `function[${string}]`]: undefined;
[key: `address[${string}]`]: undefined;
[key: `bool[${string}]`]: undefined;
[key: `bytes[${string}]`]: undefined;
[key: `bytes1[${string}]`]: undefined;
[key: `bytes2[${string}]`]: undefined;
[key: `bytes3[${string}]`]: undefined;
[key: `bytes32[${string}]`]: undefined;
[key: `bytes16[${string}]`]: undefined;
[key: `bytes4[${string}]`]: undefined;
[key: `bytes6[${string}]`]: undefined;
[key: `bytes18[${string}]`]: undefined;
[key: `bytes5[${string}]`]: undefined;
[key: `bytes7[${string}]`]: undefined;
[key: `bytes8[${string}]`]: undefined;
[key: `bytes9[${string}]`]: undefined;
[key: `bytes10[${string}]`]: undefined;
[key: `bytes11[${string}]`]: undefined;
[key: `bytes12[${string}]`]: undefined;
[key: `bytes13[${string}]`]: undefined;
[key: `bytes14[${string}]`]: undefined;
[key: `bytes15[${string}]`]: undefined;
[key: `bytes17[${string}]`]: undefined;
[key: `bytes19[${string}]`]: undefined;
[key: `bytes20[${string}]`]: undefined;
[key: `bytes21[${string}]`]: undefined;
[key: `bytes22[${string}]`]: undefined;
[key: `bytes23[${string}]`]: undefined;
[key: `bytes24[${string}]`]: undefined;
[key: `bytes25[${string}]`]: undefined;
[key: `bytes26[${string}]`]: undefined;
[key: `bytes27[${string}]`]: undefined;
[key: `bytes28[${string}]`]: undefined;
[key: `bytes29[${string}]`]: undefined;
[key: `bytes30[${string}]`]: undefined;
[key: `bytes31[${string}]`]: undefined;
[key: `int[${string}]`]: undefined;
[key: `int120[${string}]`]: undefined;
[key: `int64[${string}]`]: undefined;
[key: `int32[${string}]`]: undefined;
[key: `int16[${string}]`]: undefined;
[key: `int8[${string}]`]: undefined;
[key: `int24[${string}]`]: undefined;
[key: `int40[${string}]`]: undefined;
[key: `int48[${string}]`]: undefined;
[key: `int56[${string}]`]: undefined;
[key: `int72[${string}]`]: undefined;
[key: `int80[${string}]`]: undefined;
[key: `int88[${string}]`]: undefined;
[key: `int96[${string}]`]: undefined;
[key: `int104[${string}]`]: undefined;
[key: `int112[${string}]`]: undefined;
[key: `int128[${string}]`]: undefined;
[key: `int136[${string}]`]: undefined;
[key: `int144[${string}]`]: undefined;
[key: `int152[${string}]`]: undefined;
[key: `int160[${string}]`]: undefined;
[key: `int168[${string}]`]: undefined;
[key: `int176[${string}]`]: undefined;
[key: `int184[${string}]`]: undefined;
[key: `int192[${string}]`]: undefined;
[key: `int200[${string}]`]: undefined;
[key: `int208[${string}]`]: undefined;
[key: `int216[${string}]`]: undefined;
[key: `int224[${string}]`]: undefined;
[key: `int232[${string}]`]: undefined;
[key: `int240[${string}]`]: undefined;
[key: `int248[${string}]`]: undefined;
[key: `int256[${string}]`]: undefined;
[key: `uint[${string}]`]: undefined;
[key: `uint120[${string}]`]: undefined;
[key: `uint64[${string}]`]: undefined;
[key: `uint32[${string}]`]: undefined;
[key: `uint16[${string}]`]: undefined;
[key: `uint8[${string}]`]: undefined;
[key: `uint24[${string}]`]: undefined;
[key: `uint40[${string}]`]: undefined;
[key: `uint48[${string}]`]: undefined;
[key: `uint56[${string}]`]: undefined;
[key: `uint72[${string}]`]: undefined;
[key: `uint80[${string}]`]: undefined;
[key: `uint88[${string}]`]: undefined;
[key: `uint96[${string}]`]: undefined;
[key: `uint104[${string}]`]: undefined;
[key: `uint112[${string}]`]: undefined;
[key: `uint128[${string}]`]: undefined;
[key: `uint136[${string}]`]: undefined;
[key: `uint144[${string}]`]: undefined;
[key: `uint152[${string}]`]: undefined;
[key: `uint160[${string}]`]: undefined;
[key: `uint168[${string}]`]: undefined;
[key: `uint176[${string}]`]: undefined;
[key: `uint184[${string}]`]: undefined;
[key: `uint192[${string}]`]: undefined;
[key: `uint200[${string}]`]: undefined;
[key: `uint208[${string}]`]: undefined;
[key: `uint216[${string}]`]: undefined;
[key: `uint224[${string}]`]: undefined;
[key: `uint232[${string}]`]: undefined;
[key: `uint240[${string}]`]: undefined;
[key: `uint248[${string}]`]: undefined;
[key: `uint256[${string}]`]: undefined;
address?: undefined;
bool?: undefined;
bytes?: undefined;
bytes1?: undefined;
bytes10?: undefined;
bytes11?: undefined;
bytes12?: undefined;
bytes13?: undefined;
bytes14?: undefined;
bytes15?: undefined;
bytes16?: undefined;
bytes17?: undefined;
bytes18?: undefined;
bytes19?: undefined;
bytes2?: undefined;
bytes20?: undefined;
bytes21?: undefined;
bytes22?: undefined;
bytes23?: undefined;
bytes24?: undefined;
bytes25?: undefined;
bytes26?: undefined;
bytes27?: undefined;
bytes28?: undefined;
bytes29?: undefined;
bytes3?: undefined;
bytes30?: undefined;
bytes31?: undefined;
bytes32?: undefined;
bytes4?: undefined;
bytes5?: undefined;
bytes6?: undefined;
bytes7?: undefined;
bytes8?: undefined;
bytes9?: undefined;
int104?: undefined;
int112?: undefined;
int120?: undefined;
int128?: undefined;
int136?: undefined;
int144?: undefined;
int152?: undefined;
int16?: undefined;
int160?: undefined;
int168?: undefined;
int176?: undefined;
int184?: undefined;
int192?: undefined;
int200?: undefined;
int208?: undefined;
int216?: undefined;
int224?: undefined;
int232?: undefined;
int24?: undefined;
int240?: undefined;
int248?: undefined;
int256?: undefined;
int32?: undefined;
int40?: undefined;
int48?: undefined;
int56?: undefined;
int64?: undefined;
int72?: undefined;
int8?: undefined;
int80?: undefined;
int88?: undefined;
int96?: undefined;
string?: undefined;
uint104?: undefined;
uint112?: undefined;
uint120?: undefined;
uint128?: undefined;
uint136?: undefined;
uint144?: undefined;
uint152?: undefined;
uint16?: undefined;
uint160?: undefined;
uint168?: undefined;
uint176?: undefined;
uint184?: undefined;
uint192?: undefined;
uint200?: undefined;
uint208?: undefined;
uint216?: undefined;
uint224?: undefined;
uint232?: undefined;
uint24?: undefined;
uint240?: undefined;
uint248?: undefined;
uint256?: undefined;
uint32?: undefined;
uint40?: undefined;
uint48?: undefined;
uint56?: undefined;
uint64?: undefined;
uint72?: undefined;
uint8?: undefined;
uint80?: undefined;
uint88?: undefined;
uint96?: undefined;
}
primaryType
primaryType extends string | number | symbol = keyof typedData
Parameters
parameters
TypedDataDefinition<typedData, primaryType>
Returns
Promise<`0x${string}`>
swap()
swap: (options: AccountSwapOptions) => Promise<SendSwapTransactionResult>;
Parameters
options
AccountSwapOptions
Configuration options for the swap.
Returns
Promise<SendSwapTransactionResult>
A promise that resolves to the transaction hash.
Throws
If liquidity is not available when using inline options.
Examples
// First create a swap quote
const swapQuote = await cdp.evm.createSwapQuote({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
taker: account.address
});
// Check if liquidity is available
if (!swapQuote.liquidityAvailable) {
console.error("Insufficient liquidity for swap");
return;
}
// Execute the swap
const { transactionHash } = await account.swap({
swapQuote: swapQuote
});
console.log(`Swap executed with transaction hash: ${transactionHash}`);
// Create and execute swap in one call
const { transactionHash } = await account.swap({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
console.log(`Swap executed with transaction hash: ${transactionHash}`);
transfer()
transfer: (options: TransferOptions) => Promise<{
transactionHash: `0x${string}`;
}>;
Parameters
options
TransferOptions
The options for the transfer.
Returns
Promise<{
transactionHash: `0x${string}`;
}>
An object containing the transaction hash.
Examples
const { transactionHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
import { parseUnits } from "viem";
const { transactionHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseUnits("0.01", 6), // USDC uses 6 decimal places
token: "usdc",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { transactionHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "eth",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { transactionHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "0x4200000000000000000000000000000000000006", // WETH on Base Sepolia
network: "base-sepolia",
});
const sender = await cdp.evm.createAccount({ name: "Sender" });
const receiver = await cdp.evm.createAccount({ name: "Receiver" });
const { transactionHash } = await sender.transfer({
to: receiver,
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
type
Indicates this is a server-managed account.
useNetwork()
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<{ address: `0x${string}`; fund: (options: Omit<(...), (...)>) => Promise<(...)>; listTokenBalances: (options: Omit<(...), (...)>) => Promise<(...)>; name?: string; policies?: (...)[]; quoteFund: (options: Omit<(...), (...)>) => Promise<(...)>; quoteSwap: (options: AccountQuoteSwapOptions) => Promise<(...)>; requestFaucet: (options: Omit<(...), (...)>) => Promise<(...)>; sendTransaction: (options: Omit<(...), (...)>) => Promise<(...)>; sign: (parameters: { hash: ... }) => Promise<(...)>; signMessage: (parameters: { message: ... }) => Promise<(...)>; signTransaction: (transaction: TransactionSerializable) => Promise<(...)>; signTypedData: (parameters: TypedDataDefinition<(...), (...)>) => Promise<(...)>; swap: (options: AccountSwapOptions) => Promise<(...)>; transfer: (options: TransferOptions) => Promise<(...)>; type: "evm-server"; useNetwork: <Network extends NetworkOrRpcUrl>(network: Network) => Promise<{ [K in keyof (Omit<{ address: `0x${string}`; sign: (parameters: { hash: `0x${string}`; }) => Promise<`0x${string}`>; signMessage: (parameters: { message: SignableMessage; }) => Promise<...>; ... 15 more ...; useNetwork: ...; }, "transfer" | ... 5 more ....; useSpendPermission: (options: UseSpendPermissionOptions) => Promise<(...)>; waitForFundOperationReceipt: any }, "transfer" | "sendTransaction" | "quoteSwap" | "swap" | "useSpendPermission" | "useNetwork" | (keyof Actions)> & { [K in string | number | symbol]: ({ sendTransaction: ...; transfer: ...; waitForTransactionReceipt: ... } & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)))[K] } & { network: Network })[K] }>;
Type Parameters
Network
Network extends NetworkOrRpcUrl
Parameters
network
Network
The network name or RPC URL
Returns
Promise<{ [K in string | number | symbol]: (Omit<{ address: `0x\{string\}\`; fund: (options: Omit\<(...), (...)\>) =\> Promise\<(...)\>; listTokenBalances: (options: Omit\<(...), (...)\>) =\> Promise\<(...)\>; name?: string; policies?: (...)\[\]; quoteFund: (options: Omit\<(...), (...)\>) =\> Promise\<(...)\>; quoteSwap: (options: AccountQuoteSwapOptions) =\> Promise\<(...)\>; requestFaucet: (options: Omit\<(...), (...)\>) =\> Promise\<(...)\>; sendTransaction: (options: Omit\<(...), (...)\>) =\> Promise\<(...)\>; sign: (parameters: \{ hash: ... \}) =\> Promise\<(...)\>; signMessage: (parameters: \{ message: ... \}) =\> Promise\<(...)\>; signTransaction: (transaction: TransactionSerializable) =\> Promise\<(...)\>; signTypedData: (parameters: TypedDataDefinition\<(...), (...)\>) =\> Promise\<(...)\>; swap: (options: AccountSwapOptions) =\> Promise\<(...)\>; transfer: (options: TransferOptions) =\> Promise\<(...)\>; type: "evm-server"; useNetwork: \<Network extends NetworkOrRpcUrl\>(network: Network) =\> Promise\<\{ \[K in keyof (Omit\<\{ address: \`0x{string}`; sign: (parameters: { hash: `0x{string};ˋ})=Promise\<0ˋx{string}`>; signMessage: (parameters: { message: SignableMessage; }) => Promise<…>; … 15 more …; useNetwork: …; }, “transfer” | … 5 more …; useSpendPermission: (options: UseSpendPermissionOptions) => Promise<(…)>; waitForFundOperationReceipt: any }, “transfer” | “sendTransaction” | “quoteSwap” | “swap” | “useSpendPermission” | “useNetwork” | (keyof Actions)> & { [K in string | number | symbol]: ({ sendTransaction: …; transfer: …; waitForTransactionReceipt: … } & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)))[K] } & { network: Network })[K] }>
Example
// For known networks, type is inferred automatically:
const baseAccount = await account.useNetwork("base");
// For custom RPC URLs with type hints (requires casting):
const typedAccount = await account.useNetwork<"base">("https://mainnet.base.org" as "base");
// For custom RPC URLs without type hints (only sendTransaction and waitForTransactionReceipt methods available):
const customAccount = await account.useNetwork("https://mainnet.base.org");
useSpendPermission()
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<TransactionResult>;
Parameters
options
UseSpendPermissionOptions
Configuration options for using the spend permission.
Returns
Promise<TransactionResult>
A promise that resolves to the transaction result.
Throws
If the network doesn’t support spend permissions via CDP API.
Example
const spendPermission = {
account: "0x1234...", // Smart account that owns the tokens
spender: account.address, // This account that can spend
token: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", // ETH
allowance: parseEther("0.01"),
period: 86400, // 1 day
start: 0,
end: 281474976710655,
salt: 0n,
extraData: "0x",
};
const result = await account.useSpendPermission({
spendPermission,
value: parseEther("0.001"), // Spend 0.001 ETH
network: "base-sepolia",
});
waitForFundOperationReceipt()
waitForFundOperationReceipt(options: WaitForFundOperationOptions): Promise<WaitForFundOperationResult>;
Parameters
options
WaitForFundOperationOptions
The options for the wait for fund operation.
Returns
Promise<WaitForFundOperationResult>
A promise that resolves to the completed transfer receipt containing details about the funding operation.
Example
const completedTransfer = await account.waitForFundOperationReceipt({
transferId: "transfer_123",
});
nextPageToken?
optional nextPageToken: string;
ListServerAccountsOptions
Defined in: src/client/evm/evm.types.ts:419
Options for listing EVM accounts.
Properties
pageSize?
optional pageSize: number;
pageToken?
optional pageToken: string;
ListSmartAccountResult
Defined in: src/client/evm/evm.types.ts:464
The result of listing EVM smart accounts.
Properties
accounts
accounts: ReadonlySmartAccount[];
nextPageToken?
optional nextPageToken: string;
ListSmartAccountsOptions
Defined in: src/client/evm/evm.types.ts:490
Options for listing EVM smart accounts.
Properties
name?
Defined in: src/client/evm/evm.types.ts:492
The name of the account.
pageSize?
optional pageSize: number;
pageToken?
optional pageToken: string;
PrepareUserOperationOptions
Defined in: src/client/evm/evm.types.ts:285
Options for preparing a user operation.
Properties
calls
calls: readonly {
data: `0x${string}`;
to: `0x${string}`;
value: bigint;
}[];
network
network: EvmUserOperationNetwork;
paymasterUrl?
optional paymasterUrl: string;
smartAccount
smartAccount: {
address: `0x${string}`;
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
name?: string;
owners: EvmAccount[];
policies: undefined | string[];
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
type: "evm-smart";
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: (options: ...) => ...; sendUserOperation: (options: ...) => ...; waitForUserOperation: (options: ...) => ... } & (Network extends TransferNetworks ? { transfer: ... } : EmptyObject) & (Network extends ListTokenBalancesNetworks ? { listTokenBalances: ... } : EmptyObject) & (Network extends RequestFaucetNetworks ? { requestFaucet: ... } : EmptyObject) & (Network extends "base" ? { quoteFund: ... } : EmptyObject) & (Network extends "base" ? { fund: ...; waitForFundOperationReceipt: ... } : EmptyObject) & (Network extends QuoteSwapNetworks ? { quoteSwap: ... } : EmptyObject) & (Network extends SwapNetworks ? { swap: ... } : EmptyObject) & (Network extends SpendPermissionNetwork ? { useSpendPermission: ... } : EmptyObject))[K] } & { network: Network })[K] }>;
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
waitForFundOperationReceipt: Promise<WaitForFundOperationResult>;
};
address
The smart account’s address.
fund()
fund: (options: Omit<EvmFundOptions, "address">) => Promise<FundOperationResult>;
Parameters
options
Omit<EvmFundOptions, "address">
The options for the fund operation.
Returns
Promise<FundOperationResult>
A promise that resolves to the fund operation result containing the transfer details.
Example
const fundOperation = await account.fund({
network: "base",
token: "usdc",
amount: 1000000n,
});
getUserOperation()
getUserOperation: (options: Omit<GetUserOperationOptions, "smartAccount">) => Promise<UserOperation>;
Parameters
options
Omit<GetUserOperationOptions, "smartAccount">
Parameters for getting the user operation.
Returns
Promise<UserOperation>
A promise that resolves to the user operation.
Example
const userOp = await smartAccount.getUserOperation({
userOpHash: "0x1234567890123456789012345678901234567890",
});
listTokenBalances()
listTokenBalances: (options: Omit<ListTokenBalancesOptions, "address">) => Promise<ListTokenBalancesResult>;
Parameters
options
Omit<ListTokenBalancesOptions, "address">
The options for the list token balances.
Returns
Promise<ListTokenBalancesResult>
The result of the list token balances.
Example
const balances = await account.listTokenBalances({
network: "base-sepolia",
});
name?
The name of the smart account.
owners
Array of accounts that own and can sign for the smart account (currently only supports one owner but will be extended to support multiple owners in the future).
policies
policies: undefined | string[];
quoteFund()
quoteFund: (options: Omit<EvmQuoteFundOptions, "address">) => Promise<EvmQuote>;
Parameters
options
Omit<EvmQuoteFundOptions, "address">
The options for the quote fund.
Returns
Promise<EvmQuote>
A promise that resolves to a Quote object containing details about the funding operation.
Example
const quote = await account.quoteFund({
network: "base",
token: "usdc",
amount: 1000000n,
});
quoteSwap()
quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>;
Parameters
options
SmartAccountQuoteSwapOptions
Configuration options for creating the swap quote.
Returns
Promise<SmartAccountQuoteSwapResult>
A promise that resolves to the swap quote or a response indicating that liquidity is unavailable.
Example
const swapQuote = await smartAccount.quoteSwap({
network: "base",
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
if (swapQuote.liquidityAvailable) {
console.log(`Can swap for ${swapQuote.toAmount} USDC`);
}
requestFaucet()
requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
Parameters
options
Omit<RequestFaucetOptions, "address">
Parameters for requesting funds from the EVM faucet.
Returns
Promise<RequestFaucetResult>
A promise that resolves to the transaction hash.
Example
const result = await account.requestFaucet({
network: "base-sepolia",
token: "eth",
});
sendUserOperation()
sendUserOperation: (options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">) => Promise<SendUserOperationReturnType>;
Parameters
options
Omit<SendUserOperationOptions<unknown[]>, "smartAccount">
Parameters for sending the user operation.
Returns
Promise<SendUserOperationReturnType>
A promise that resolves to an object containing the smart account address,
the user operation hash, and the status of the user operation.
Example
const userOp = await smartAccount.sendUserOperation({
network: "base-sepolia",
calls: [
{
to: "0x1234567890123456789012345678901234567890",
value: parseEther("0.000001"),
data: "0x",
},
],
});
signTypedData()
signTypedData: (options: Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}) => Promise<`0x${string}`>;
Parameters
options
Omit<SignTypedDataOptions, "address"> & {
network: KnownEvmNetworks;
}
Configuration options for signing the typed data.
Returns
Promise<`0x${string}`>
A promise that resolves to the signature.
Example
const signature = await smartAccount.signTypedData({
network: "base-sepolia",
typedData: {
domain: {
name: "Test",
chainId: 84532,
verifyingContract: "0x0000000000000000000000000000000000000000",
},
types: {
Test: [{ name: "name", type: "string" }],
},
primaryType: "Test",
message: {
name: "John Doe",
},
},
});
swap()
swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>;
Parameters
options
SmartAccountSwapOptions
Configuration options for the swap.
Returns
Promise<SmartAccountSwapResult>
A promise that resolves to the user operation result.
Throws
If liquidity is not available when using inline options.
Examples
// First create a swap quote
const swapQuote = await cdp.evm.createSwapQuote({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
taker: smartAccount.address,
signerAddress: smartAccount.owners[0].address
});
// Check if liquidity is available
if (!swapQuote.liquidityAvailable) {
console.error("Insufficient liquidity for swap");
return;
}
// Execute the swap
const { userOpHash } = await smartAccount.swap({
swapQuote: swapQuote
});
console.log(`Swap executed with user op hash: ${userOpHash}`);
// Create and execute swap in one call
const { userOpHash } = await smartAccount.swap({
network: "base",
toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
fromToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
fromAmount: BigInt("1000000000000000000"), // 1 WETH in wei
});
console.log(`Swap executed with user op hash: ${userOpHash}`);
transfer()
transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>;
Parameters
options
SmartAccountTransferOptions
The options for the transfer.
Returns
Promise<SendUserOperationReturnType>
The user operation result.
Examples
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
import { parseUnits } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseUnits("0.01", 6), // USDC uses 6 decimal places
token: "usdc",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "eth",
network: "base-sepolia",
});
import { parseEther } from "viem";
const { userOpHash } = await sender.transfer({
to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
amount: parseEther("0.000001"),
token: "0x4200000000000000000000000000000000000006", // WETH on Base Sepolia
network: "base-sepolia",
});
const sender = await cdp.evm.createAccount({ name: "Sender" });
const receiver = await cdp.evm.createAccount({ name: "Receiver" });
const { userOpHash } = await sender.transfer({
to: receiver,
amount: 10000n, // equivalent to 0.01 USDC
token: "usdc",
network: "base-sepolia",
});
type
Identifier for the smart account type.
useNetwork()
useNetwork: <Network>(network: Network) => Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, "useNetwork"> & { [K in string | number | symbol]: ({ getUserOperation: (options: ...) => ...; sendUserOperation: (options: ...) => ...; waitForUserOperation: (options: ...) => ... } & (Network extends TransferNetworks ? { transfer: ... } : EmptyObject) & (Network extends ListTokenBalancesNetworks ? { listTokenBalances: ... } : EmptyObject) & (Network extends RequestFaucetNetworks ? { requestFaucet: ... } : EmptyObject) & (Network extends "base" ? { quoteFund: ... } : EmptyObject) & (Network extends "base" ? { fund: ...; waitForFundOperationReceipt: ... } : EmptyObject) & (Network extends QuoteSwapNetworks ? { quoteSwap: ... } : EmptyObject) & (Network extends SwapNetworks ? { swap: ... } : EmptyObject) & (Network extends SpendPermissionNetwork ? { useSpendPermission: ... } : EmptyObject))[K] } & { network: Network })[K] }>;
Type Parameters
Network
Network extends KnownEvmNetworks
Parameters
network
Network
The network name or RPC URL
Returns
Promise<{ [K in string | number | symbol]: (Omit<EvmSmartAccountProperties, “useNetwork”> & { [K in string | number | symbol]: ({ getUserOperation: (options: …) => …; sendUserOperation: (options: …) => …; waitForUserOperation: (options: …) => … } & (Network extends TransferNetworks ? { transfer: … } : EmptyObject) & (Network extends ListTokenBalancesNetworks ? { listTokenBalances: … } : EmptyObject) & (Network extends RequestFaucetNetworks ? { requestFaucet: … } : EmptyObject) & (Network extends “base” ? { quoteFund: … } : EmptyObject) & (Network extends “base” ? { fund: …; waitForFundOperationReceipt: … } : EmptyObject) & (Network extends QuoteSwapNetworks ? { quoteSwap: … } : EmptyObject) & (Network extends SwapNetworks ? { swap: … } : EmptyObject) & (Network extends SpendPermissionNetwork ? { useSpendPermission: … } : EmptyObject))[K] } & { network: Network })[K] }>
Example
// For known networks, type is inferred automatically:
const baseAccount = await smartAccount.useNetwork("base");
// For custom RPC URLs with type hints (requires casting):
const typedAccount = await smartAccount.useNetwork<"base">("https://mainnet.base.org" as "base");
// For custom RPC URLs without type hints (only sendTransaction, transfer and waitForTransactionReceipt methods available):
const customAccount = await smartAccount.useNetwork("https://mainnet.base.org");
useSpendPermission()
useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
Parameters
options
UseSpendPermissionOptions
Configuration options for using the spend permission.
Returns
Promise<SendUserOperationReturnType>
A promise that resolves to the user operation result.
Throws
If the network doesn’t support spend permissions via CDP API.
Example
const spendPermission = {
account: "0x1234...", // Smart account that owns the tokens
spender: smartAccount.address, // This smart account that can spend
token: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", // ETH
allowance: parseEther("0.01"),
period: 86400, // 1 day
start: 0,
end: 281474976710655,
salt: 0n,
extraData: "0x",
};
const result = await smartAccount.useSpendPermission({
spendPermission,
value: parseEther("0.001"), // Spend 0.001 ETH
network: "base-sepolia",
});
waitForUserOperation()
waitForUserOperation: (options: Omit<WaitForUserOperationOptions, "smartAccountAddress">) => Promise<WaitForUserOperationReturnType>;
Parameters
options
Omit<WaitForUserOperationOptions, "smartAccountAddress">
Parameters for waiting for the user operation.
Returns
Promise<WaitForUserOperationReturnType>
A promise that resolves to the transaction receipt.
Example
// Send a user operation and get the user operation hash
const { userOpHash } = await smartAccount.sendUserOperation({
network: "base-sepolia",
calls: [
{
to: "0x0000000000000000000000000000000000000000",
value: parseEther("0.000001"),
data: "0x",
},
],
});
// Wait for the user operation to complete or fail
const result = await smartAccount.waitForUserOperation({
userOpHash: userOp.userOpHash,
});
waitForFundOperationReceipt()
waitForFundOperationReceipt(options: WaitForFundOperationOptions): Promise<WaitForFundOperationResult>;
Parameters
options
WaitForFundOperationOptions
The options for the wait for fund operation.
Returns
Promise<WaitForFundOperationResult>
A promise that resolves to the completed transfer receipt containing details about the funding operation.
Example
const completedTransfer = await account.waitForFundOperationReceipt({
transferId: "transfer_123",
});
ReadonlySmartAccount
Defined in: src/client/evm/evm.types.ts:429
A smart account that only contains the owner address.
Extends
Properties
address
Defined in: src/accounts/evm/types.ts:150
The smart account’s address.
Inherited from
name?
Defined in: src/accounts/evm/types.ts:152
The name of the smart account.
Inherited from
owners
Defined in: src/client/evm/evm.types.ts:432
The owners of the smart account.
policies
policies: undefined | string[];
Inherited from
type
Defined in: src/accounts/evm/types.ts:156
Identifier for the smart account type.
Inherited from
SignatureResult
Defined in: src/client/evm/evm.types.ts:570
A signature result.
Properties
signature
signature: `0x${string}`;
SignHashOptions
Defined in: src/client/evm/evm.types.ts:516
Options for signing an EVM hash.
Properties
address
Defined in: src/client/evm/evm.types.ts:518
The address of the account.
hash
Defined in: src/client/evm/evm.types.ts:520
The hash to sign.
idempotencyKey?
optional idempotencyKey: string;
SignMessageOptions
Defined in: src/client/evm/evm.types.ts:528
Options for signing an EVM message.
Properties
address
Defined in: src/client/evm/evm.types.ts:530
The address of the account.
idempotencyKey?
optional idempotencyKey: string;
message
Defined in: src/client/evm/evm.types.ts:532
The message to sign.
SignTransactionOptions
Defined in: src/client/evm/evm.types.ts:558
Options for signing an EVM transaction.
Properties
address
Defined in: src/client/evm/evm.types.ts:560
The address of the account.
idempotencyKey?
optional idempotencyKey: string;
transaction
transaction: `0x${string}`;
SignTypedDataOptions
Defined in: src/client/evm/evm.types.ts:540
Options for signing an EVM typed data message.
Properties
address
Defined in: src/client/evm/evm.types.ts:542
The address of the account.
domain
Defined in: src/client/evm/evm.types.ts:544
The domain of the message.
idempotencyKey?
optional idempotencyKey: string;
message
message: EIP712MessageMessage;
primaryType struct in the types object.
primaryType
Defined in: src/client/evm/evm.types.ts:548
The primary type of the message. This is the name of the struct in the types object that is the root of the message.
types
Defined in: src/client/evm/evm.types.ts:546
The types of the message.
SmartAccountSignAndWrapTypedDataOptions
Defined in: src/client/evm/evm.types.ts:657
Options for signing and wrapping EIP-712 typed data with a smart account.
This method handles the full smart account signature flow including replay-safe hashing.
Properties
chainId
Defined in: src/client/evm/evm.types.ts:659
The chain ID for the signature (used for replay protection).
idempotencyKey?
optional idempotencyKey: string;
ownerIndex?
optional ownerIndex: bigint;
typedData
typedData: EIP712Message;
SwapAllowanceIssue
Defined in: src/client/evm/evm.types.ts:598
Details of allowance issues for a swap.
Properties
currentAllowance
currentAllowance: bigint;
spender
Defined in: src/client/evm/evm.types.ts:602
The address to set the allowance on.
SwapBalanceIssue
Defined in: src/client/evm/evm.types.ts:608
Details of balance issues for a swap.
Properties
currentBalance
Defined in: src/client/evm/evm.types.ts:612
The current balance of the fromToken by the taker.
requiredBalance
Defined in: src/client/evm/evm.types.ts:614
The amount of the token that the taker must hold.
token
Defined in: src/client/evm/evm.types.ts:610
The contract address of the token.
SwapFees
Defined in: src/client/evm/evm.types.ts:588
The estimated fees for a swap.
Properties
gasFee?
optional gasFee: TokenFee;
protocolFee?
optional protocolFee: TokenFee;
SwapIssues
Defined in: src/client/evm/evm.types.ts:620
Potential issues discovered during swap validation.
Properties
allowance?
optional allowance: SwapAllowanceIssue;
balance?
optional balance: SwapBalanceIssue;
simulationIncomplete
simulationIncomplete: boolean;
SwapUnavailableResult
Defined in: src/client/evm/evm.types.ts:194
Result when liquidity is unavailable for a swap.
Properties
liquidityAvailable
liquidityAvailable: false;
TokenFee
Defined in: src/client/evm/evm.types.ts:578
A fee in a specific token.
Properties
amount
Defined in: src/client/evm/evm.types.ts:580
The amount of the fee in atomic units of the token.
token
Defined in: src/client/evm/evm.types.ts:582
The contract address of the token that the fee is paid in.
UpdateEvmAccountOptions
Defined in: src/client/evm/evm.types.ts:438
Options for creating an EVM server account.
Properties
address
Defined in: src/client/evm/evm.types.ts:440
The address of the account.
idempotencyKey?
optional idempotencyKey: string;
update
update: UpdateEvmAccountBody;
UpdateEvmSmartAccountOptions
Defined in: src/client/evm/evm.types.ts:450
Options for updating an EVM smart account.
Properties
address
Defined in: src/client/evm/evm.types.ts:452
The address of the account.
idempotencyKey?
optional idempotencyKey: string;
owner
Defined in: src/client/evm/evm.types.ts:458
The owner of the account.
update
update: UpdateEvmSmartAccountBody;
UserOperation
Defined in: src/client/evm/evm.types.ts:315
A user operation.
Properties
calls
calls: readonly {
data: `0x${string}`;
to: `0x${string}`;
value: bigint;
}[];
network
network: EvmUserOperationNetwork;
receipts?
optional receipts: UserOperationReceipt[];
status
status: EvmUserOperationStatus;
transactionHash?
optional transactionHash: `0x${string}`;
userOpHash
userOpHash: `0x${string}`;
WaitForUserOperationOptions
Defined in: src/client/evm/evm.types.ts:632
Options for waiting for a user operation.
Properties
smartAccountAddress
smartAccountAddress: `0x${string}`;
userOpHash
userOpHash: `0x${string}`;
waitOptions?
optional waitOptions: WaitOptions;
Type Aliases
CreateSwapOptions
type CreateSwapOptions = CreateSwapQuoteOptions;
Deprecated
Use the new type names instead.
CreateSwapResult
type CreateSwapResult = CreateSwapQuoteResult;
EvmClientInterface
type EvmClientInterface = Omit<typeof OpenApiEvmMethods,
| "createEvmAccount"
| "createEvmSmartAccount"
| "createSpendPermission"
| "listSpendPermissions"
| "revokeSpendPermission"
| "importEvmAccount"
| "exportEvmAccount"
| "exportEvmAccountByName"
| "getEvmAccount"
| "getEvmAccountByName"
| "getEvmSmartAccount"
| "getEvmSmartAccountByName"
| "getEvmSwapPrice"
| "createEvmSwapQuote"
| "getUserOperation"
| "updateEvmAccount"
| "listEvmAccounts"
| "listEvmSmartAccounts"
| "listEvmTokenBalances"
| "prepareUserOperation"
| "requestEvmFaucet"
| "sendUserOperation"
| "signEvmHash"
| "signEvmMessage"
| "signEvmTransaction"
| "signEvmTypedData"
| "sendEvmTransaction"
| "signEvmTypedData"
| "updateEvmAccount"
| "exportEvmAccount"
| "exportEvmAccountByName"
| "updateEvmSmartAccount"> & {
createAccount: (options: CreateServerAccountOptions) => Promise<EvmServerAccount>;
createSmartAccount: (options: CreateSmartAccountOptions) => Promise<EvmSmartAccount>;
createSwapQuote: (options: CreateSwapQuoteOptions) => Promise<
| CreateSwapQuoteResult
| SwapUnavailableResult>;
exportAccount: (options: ExportServerAccountOptions) => Promise<string>;
getAccount: (options: GetServerAccountOptions) => Promise<EvmServerAccount>;
getOrCreateAccount: (options: GetOrCreateServerAccountOptions) => Promise<EvmServerAccount>;
getSmartAccount: (options: GetSmartAccountOptions) => Promise<EvmSmartAccount>;
getSwapPrice: (options: GetSwapPriceOptions) => Promise<
| GetSwapPriceResult
| SwapUnavailableResult>;
getUserOperation: (options: GetUserOperationOptions) => Promise<UserOperation>;
importAccount: (options: ImportServerAccountOptions) => Promise<EvmServerAccount>;
listAccounts: (options: ListServerAccountsOptions) => Promise<ListServerAccountResult>;
listSmartAccounts: (options: ListSmartAccountsOptions) => Promise<ListSmartAccountResult>;
listSpendPermissions: (options: ListSpendPermissionsOptions) => Promise<ListSpendPermissionsResult>;
listTokenBalances: (options: ListTokenBalancesOptions) => Promise<ListTokenBalancesResult>;
prepareUserOperation: (options: PrepareUserOperationOptions) => Promise<UserOperation>;
requestFaucet: (options: RequestFaucetOptions) => Promise<RequestFaucetResult>;
sendTransaction: (options: SendTransactionOptions) => Promise<TransactionResult>;
sendUserOperation: (options: SendUserOperationOptions<unknown[]>) => Promise<SendUserOperationReturnType>;
signHash: (options: SignHashOptions) => Promise<SignatureResult>;
signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
signTypedData: (options: SignTypedDataOptions) => Promise<SignatureResult>;
updateAccount: (options: UpdateEvmAccountOptions) => Promise<EvmServerAccount>;
updateSmartAccount: (options: UpdateEvmSmartAccountOptions) => Promise<EvmSmartAccount>;
};
Type declaration
createAccount()
createAccount: (options: CreateServerAccountOptions) => Promise<EvmServerAccount>;
Parameters
options
CreateServerAccountOptions
Returns
Promise<EvmServerAccount>
createSmartAccount()
createSmartAccount: (options: CreateSmartAccountOptions) => Promise<EvmSmartAccount>;
Parameters
options
CreateSmartAccountOptions
Returns
Promise<EvmSmartAccount>
createSwapQuote()
createSwapQuote: (options: CreateSwapQuoteOptions) => Promise<
| CreateSwapQuoteResult
| SwapUnavailableResult>;
Parameters
options
CreateSwapQuoteOptions
Returns
Promise<
| CreateSwapQuoteResult
| SwapUnavailableResult>
exportAccount()
exportAccount: (options: ExportServerAccountOptions) => Promise<string>;
Parameters
options
ExportServerAccountOptions
Returns
Promise<string>
getAccount()
getAccount: (options: GetServerAccountOptions) => Promise<EvmServerAccount>;
Parameters
options
GetServerAccountOptions
Returns
Promise<EvmServerAccount>
getOrCreateAccount()
getOrCreateAccount: (options: GetOrCreateServerAccountOptions) => Promise<EvmServerAccount>;
Parameters
options
GetOrCreateServerAccountOptions
Returns
Promise<EvmServerAccount>
getSmartAccount()
getSmartAccount: (options: GetSmartAccountOptions) => Promise<EvmSmartAccount>;
Parameters
options
GetSmartAccountOptions
Returns
Promise<EvmSmartAccount>
getSwapPrice()
getSwapPrice: (options: GetSwapPriceOptions) => Promise<
| GetSwapPriceResult
| SwapUnavailableResult>;
Parameters
options
GetSwapPriceOptions
Returns
Promise<
| GetSwapPriceResult
| SwapUnavailableResult>
getUserOperation()
getUserOperation: (options: GetUserOperationOptions) => Promise<UserOperation>;
Parameters
options
GetUserOperationOptions
Returns
Promise<UserOperation>
importAccount()
importAccount: (options: ImportServerAccountOptions) => Promise<EvmServerAccount>;
Parameters
options
ImportServerAccountOptions
Returns
Promise<EvmServerAccount>
listAccounts()
listAccounts: (options: ListServerAccountsOptions) => Promise<ListServerAccountResult>;
Parameters
options
ListServerAccountsOptions
Returns
Promise<ListServerAccountResult>
listSmartAccounts()
listSmartAccounts: (options: ListSmartAccountsOptions) => Promise<ListSmartAccountResult>;
Parameters
options
ListSmartAccountsOptions
Returns
Promise<ListSmartAccountResult>
listSpendPermissions()
listSpendPermissions: (options: ListSpendPermissionsOptions) => Promise<ListSpendPermissionsResult>;
Parameters
options
ListSpendPermissionsOptions
Returns
Promise<ListSpendPermissionsResult>
listTokenBalances()
listTokenBalances: (options: ListTokenBalancesOptions) => Promise<ListTokenBalancesResult>;
Parameters
options
ListTokenBalancesOptions
Returns
Promise<ListTokenBalancesResult>
prepareUserOperation()
prepareUserOperation: (options: PrepareUserOperationOptions) => Promise<UserOperation>;
Parameters
options
PrepareUserOperationOptions
Returns
Promise<UserOperation>
requestFaucet()
requestFaucet: (options: RequestFaucetOptions) => Promise<RequestFaucetResult>;
Parameters
options
RequestFaucetOptions
Returns
Promise<RequestFaucetResult>
sendTransaction()
sendTransaction: (options: SendTransactionOptions) => Promise<TransactionResult>;
Parameters
options
SendTransactionOptions
Returns
Promise<TransactionResult>
sendUserOperation()
sendUserOperation: (options: SendUserOperationOptions<unknown[]>) => Promise<SendUserOperationReturnType>;
Parameters
options
SendUserOperationOptions<unknown[]>
Returns
Promise<SendUserOperationReturnType>
signHash()
signHash: (options: SignHashOptions) => Promise<SignatureResult>;
Parameters
options
SignHashOptions
Returns
Promise<SignatureResult>
signMessage()
signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
Parameters
options
SignMessageOptions
Returns
Promise<SignatureResult>
signTransaction()
signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
Parameters
options
SignTransactionOptions
Returns
Promise<SignatureResult>
signTypedData()
signTypedData: (options: SignTypedDataOptions) => Promise<SignatureResult>;
Parameters
options
SignTypedDataOptions
Returns
Promise<SignatureResult>
updateAccount()
updateAccount: (options: UpdateEvmAccountOptions) => Promise<EvmServerAccount>;
Parameters
options
UpdateEvmAccountOptions
Returns
Promise<EvmServerAccount>
updateSmartAccount()
updateSmartAccount: (options: UpdateEvmSmartAccountOptions) => Promise<EvmSmartAccount>;
Parameters
options
UpdateEvmSmartAccountOptions
Returns
Promise<EvmSmartAccount>
GetSwapQuoteOptions
type GetSwapQuoteOptions = GetSwapPriceOptions;
GetSwapQuoteResult
type GetSwapQuoteResult = GetSwapPriceResult;
SwapPriceUnavailableResult
type SwapPriceUnavailableResult = SwapUnavailableResult;
SwapQuoteUnavailableResult
type SwapQuoteUnavailableResult = SwapUnavailableResult;
References
ServerAccount
Renames and re-exports EvmServerAccount
SmartAccount
Renames and re-exports EvmSmartAccount
