@coinbase/cdp-sdk/actions/evm/transfer/transfer.ts

SDK for interacting with the Coinbase Developer Platform Wallet API

import { isValidNetworkForAccount } from "./types.js";

import type {
  TransferExecutionStrategy,
  SmartAccountTransferOptions,
  TransferOptions,
} from "./types.js";
import type { EvmAccount, EvmSmartAccount } from "../../../accounts/evm/types.js";
import type { CdpOpenApiClientType } from "../../../openapi-client/index.js";
import type { Address } from "../../../types/misc.js";
import type { TransactionResult } from "../sendTransaction.js";
import type { SendUserOperationReturnType } from "../sendUserOperation.js";

/**
 * Transfer an amount of a token from an account to another account.
 *
 * @param apiClient - The client to use to send the transaction.
 * @param from - The account to send the transaction from.
 * @param transferArgs - The options for the transfer.
 * @param transferStrategy - The strategy to use to execute the transfer.
 * @returns The result of the transfer.
 */
export async function transfer<T extends EvmAccount | EvmSmartAccount>(
  apiClient: CdpOpenApiClientType,
  from: T,
  transferArgs: T extends EvmSmartAccount ? SmartAccountTransferOptions : TransferOptions,
  transferStrategy: TransferExecutionStrategy<T>,
): Promise<T extends EvmSmartAccount ? SendUserOperationReturnType : TransactionResult> {
  if (!isValidNetworkForAccount(transferArgs.network, from)) {
    throw new Error(
      `Network "${transferArgs.network}" is not supported for the given account type.`,
    );
  }

  const to =
    typeof transferArgs.to === "string" ? transferArgs.to : (transferArgs.to.address as Address);

  const transfer = {
    apiClient,
    from,
    to,
    value: transferArgs.amount,
    token: transferArgs.token,
    network: transferArgs.network,
    paymasterUrl: "paymasterUrl" in transferArgs ? transferArgs.paymasterUrl : undefined,
  };

  return transferStrategy.executeTransfer(transfer);
}