Type Alias SmartAccountActions

Type declaration

• transfer: (options: SmartAccountTransferOptions) => Promise<SendUserOperationReturnType>

  Transfer an amount of a token from an account to another account.

  Example

  const { userOpHash } = await sender.transfer({
    to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
    amount: 10000n, // equivalent to 0.01 USDC
    token: "usdc",
    network: "base-sepolia",
  });
  Copy

  Example

  Using parseUnits to specify USDC amount

  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",
  });
  Copy

  Example

  Transfer ETH

  import { parseEther } from "viem";
  
  const { userOpHash } = await sender.transfer({
    to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
    amount: parseEther("0.000001"),
    token: "eth",
    network: "base-sepolia",
  });
  Copy

  Example

  Using a contract address

  import { parseEther } from "viem";
  
  const { userOpHash } = await sender.transfer({
    to: "0x9F663335Cd6Ad02a37B633602E98866CF944124d",
    amount: parseEther("0.000001"),
    token: "0x4200000000000000000000000000000000000006", // WETH on Base Sepolia
    network: "base-sepolia",
  });
  Copy

  Example

  Transfer to another account

  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",
  });
  Copy

• sendUserOperation: (
      options: Omit<SendUserOperationOptions<unknown[]>, "smartAccount">,
  ) => Promise<SendUserOperationReturnType>

  Sends a user operation.

  Example

  const userOp = await smartAccount.sendUserOperation({
    network: "base-sepolia",
    calls: [
      {
        to: "0x1234567890123456789012345678901234567890",
        value: parseEther("0.000001"),
        data: "0x",
      },
    ],
  });
  Copy

• waitForUserOperation: (
      options: Omit<WaitForUserOperationOptions, "smartAccountAddress">,
  ) => Promise<WaitForUserOperationReturnType>

  Waits for a user operation to complete or fail.

  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,
  });
  Copy

• getUserOperation: (
      options: Omit<GetUserOperationOptions, "smartAccount">,
  ) => Promise<UserOperation>

  Gets a user operation by its hash.

  Example

  const userOp = await smartAccount.getUserOperation({
    userOpHash: "0x1234567890123456789012345678901234567890",
  });
  Copy

• quoteSwap: (options: SmartAccountQuoteSwapOptions) => Promise<SmartAccountQuoteSwapResult>

  Creates a swap quote without executing the transaction. This is useful when you need to get swap details before executing the swap. The taker is automatically set to the smart account's address.

  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`);
  }
  Copy

• swap: (options: SmartAccountSwapOptions) => Promise<SmartAccountSwapResult>

  Executes a token swap on the specified network via a user operation. This method handles all the steps required for a swap, including Permit2 signatures if needed. The taker is automatically set to the smart account's address.

  Throws

  If liquidity is not available when using inline options.

  Example: **Using a pre-created swap quote**

  // 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}`);
  Copy

  Example: **Using inline options (all-in-one)**

  // 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}`);
  Copy

• signTypedData: (
      options: Omit<SignTypedDataOptions, "address"> & {
          network: KnownEvmNetworks;
      },
  ) => Promise<Hex>

  Signs a typed data message.

  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",
      },
    },
  });
  Copy

• __experimental_useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>

  Deprecated

  Experimental! This method name will change, and is subject to other breaking changes.

  Uses a spend permission to execute a transaction via user operation. This allows the smart account to spend tokens that have been approved via a spend permission.

  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.__experimental_useSpendPermission({
    spendPermission,
    value: parseEther("0.001"), // Spend 0.001 ETH
    network: "base-sepolia",
  });
  Copy