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

SDK for interacting with the Coinbase Developer Platform Wallet API

import { formatUnits } from "viem";

import { UserInputValidationError } from "../../../errors.js";
import {
  CreatePaymentTransferQuoteBodySourceType,
  CreatePaymentTransferQuoteBodyTargetType,
  type CdpOpenApiClientType,
} from "../../../openapi-client/index.js";
import { BaseFundOptions, FundOperationResult } from "../../types.js";

/**
 * Options for funding an EVM account.
 */
export interface EvmFundOptions extends BaseFundOptions {
  /** The network to request funds from. */
  network: "base" | "ethereum";
  /** The token to request funds for. */
  token: "eth" | "usdc";
}

/**
 * Funds an EVM account.
 *
 * @param apiClient - The API client.
 * @param options - The options for funding an EVM account.
 *
 * @returns A promise that resolves to the fund operation result.
 */
export async function fund(
  apiClient: CdpOpenApiClientType,
  options: EvmFundOptions,
): Promise<FundOperationResult> {
  if (options.token !== "eth" && options.token !== "usdc") {
    throw new UserInputValidationError("Invalid token, must be eth or usdc");
  }

  const decimals = options.token === "eth" ? 18 : 6;
  const amount = formatUnits(options.amount, decimals);

  const paymentMethods = await apiClient.getPaymentMethods();
  const cardPaymentMethod = paymentMethods.find(
    method => method.type === "card" && method.actions.includes("source"),
  );

  if (!cardPaymentMethod) {
    throw new Error("No card found to fund account");
  }

  const response = await apiClient.createPaymentTransferQuote({
    sourceType: CreatePaymentTransferQuoteBodySourceType.payment_method,
    source: {
      id: cardPaymentMethod.id,
    },
    targetType: CreatePaymentTransferQuoteBodyTargetType.crypto_rail,
    target: {
      currency: options.token,
      network: options.network,
      address: options.address,
    },
    amount,
    currency: options.token,
    execute: true,
  });

  return {
    id: response.transfer.id,
    network: response.transfer.target.network,
    status: response.transfer.status,
    targetAmount: response.transfer.targetAmount,
    targetCurrency: response.transfer.targetCurrency,
    transactionHash: response.transfer.transactionHash,
  };
}