@coinbase/cdp-sdk 1.10.0 → 1.11.0

package/actions/evm/fund/waitForFundOperationReceipt.ts

@@ -0,0 +1,118 @@
+import { CdpOpenApiClientType, Transfer, TransferStatus } from "../../../openapi-client/index.js";
+import { wait, WaitOptions } from "../../../utils/wait.js";
+
+/**
+ * Options for waiting for a fund operation.
+ */
+export type WaitForFundOperationOptions = {
+  /** The ID of the transfer to wait for. */
+  transferId: string;
+  /** Optional options for the wait operation. */
+  waitOptions?: WaitOptions;
+};
+
+/**
+ * Represents a failed fund operation.
+ */
+export type FailedFundOperation = {
+  /** The ID of the transfer. */
+  id: string;
+  /** The network that the transfer was created on. */
+  network: string;
+  /** The target amount that will be received. */
+  targetAmount: string;
+  /** The currency that will be received. */
+  targetCurrency: string;
+  /** The status of the transfer. */
+  status: typeof TransferStatus.failed;
+};
+
+/**
+ * Represents a completed fund operation.
+ */
+export type CompletedFundOperation = {
+  /** The ID of the transfer. */
+  id: string;
+  /** The network that the transfer was created on. */
+  network: string;
+  /** The target amount that will be received. */
+  targetAmount: string;
+  /** The currency that will be received. */
+  targetCurrency: string;
+  /** The status of the transfer. */
+  status: typeof TransferStatus.completed;
+  /** The transaction hash of the transfer. */
+  transactionHash: string;
+};
+
+/**
+ * Represents the return type of the waitForFundOperation function.
+ */
+export type WaitForFundOperationResult = FailedFundOperation | CompletedFundOperation;
+
+/**
+ * Waits for a fund operation to complete or fail.
+ *
+ * @example
+ * ```ts
+ * import { waitForFundOperation } from "@coinbase/cdp-sdk";
+ *
+ * const result = await waitForFundOperation(client, {
+ *   transferId: "0x1234567890123456789012345678901234567890",
+ *   waitOptions: {
+ *     timeoutSeconds: 30,
+ *   },
+ * });
+ * ```
+ *
+ * @param {CdpOpenApiClientType} client - The client to use to wait for the fund operation.
+ * @param {WaitForFundOperationOptions} options - The options for the wait operation.
+ * @returns {Promise<WaitForFundOperationResult>} The result of the fund operation.
+ */
+export async function waitForFundOperationReceipt(
+  client: CdpOpenApiClientType,
+  options: WaitForFundOperationOptions,
+): Promise<WaitForFundOperationResult> {
+  const { transferId } = options;
+
+  const reload = async () => {
+    const response = await client.getPaymentTransfer(transferId);
+    return response;
+  };
+
+  const transform = (operation: Transfer): WaitForFundOperationResult => {
+    if (operation.status === TransferStatus.failed) {
+      return {
+        id: operation.id,
+        network: operation.target.network,
+        targetAmount: operation.targetAmount,
+        targetCurrency: operation.targetCurrency,
+        status: operation.status,
+      } satisfies FailedFundOperation;
+    } else if (operation.status === TransferStatus.completed) {
+      return {
+        id: operation.id,
+        network: operation.target.network,
+        targetAmount: operation.targetAmount,
+        targetCurrency: operation.targetCurrency,
+        status: operation.status,
+        transactionHash: operation.transactionHash!,
+      } satisfies CompletedFundOperation;
+    } else {
+      throw new Error("Transfer is not terminal");
+    }
+  };
+
+  const waitOptions = options.waitOptions || {
+    timeoutSeconds: 900,
+    intervalSeconds: 1,
+  };
+
+  return await wait(reload, isTerminal, transform, waitOptions);
+}
+
+const isTerminal = (operation: Transfer): boolean => {
+  return (
+    operation.status === TransferStatus.completed || operation.status === TransferStatus.failed
+  );
+};

package/actions/evm/types.ts

@@ -1,3 +1,11 @@
+import { FundOptions } from "./fund/fund.js";
+import { Quote } from "./fund/Quote.js";
+import { QuoteFundOptions } from "./fund/quoteFund.js";
+import { FundOperationResult } from "./fund/types.js";
+import {
+  WaitForFundOperationOptions,
+  WaitForFundOperationResult,
+} from "./fund/waitForFundOperationReceipt.js";
 import { SendUserOperationOptions, SendUserOperationReturnType } from "./sendUserOperation.js";
 import { GetUserOperationOptions, UserOperation } from "../../client/evm/evm.types.js";
 import { Hex } from "../../types/misc.js";
@@ -50,6 +58,71 @@ type Actions = {
    * ```
    */
   requestFaucet: (options: Omit<RequestFaucetOptions, "address">) => Promise<RequestFaucetResult>;
+
+  /**
+   * Gets a quote to fund an EVM account.
+   *
+   * @param options - The options for the quote fund.
+   * @param options.network - The network to fund the account on.
+   * @param options.token - The token to fund the account with.
+   * @param options.amount - The amount of the token to fund represented as an atomic unit.
+   * It's common to use `parseUnits` utils from viem to convert to atomic units.
+   * Otherwise, you can pass atomic units directly.
+   *
+   * @returns A promise that resolves to a Quote object containing details about the funding operation.
+   *
+   * @example
+   * ```ts
+   * const quote = await account.quoteFund({
+   *   network: "base",
+   *   token: "usdc",
+   *   amount: 1000000n,
+   * });
+   * ```
+   */
+  quoteFund: (options: Omit<QuoteFundOptions, "address">) => Promise<Quote>;
+
+  /**
+   * Funds an EVM account with the specified token amount.
+   *
+   * @param options - The options for the fund operation.
+   * @param options.network - The network to fund the account on.
+   * @param options.token - The token to fund the account with (e.g., 'usdc').
+   * @param options.amount - The amount of the token to fund represented as an atomic unit.
+   * It's common to use `parseUnits` utils from viem to convert to atomic units.
+   * Otherwise, you can pass atomic units directly.
+   *
+   * @returns A promise that resolves to the fund operation result containing the transfer details.
+   *
+   * @example
+   * ```ts
+   * const fundOperation = await account.fund({
+   *   network: "base",
+   *   token: "usdc",
+   *   amount: 1000000n,
+   * });
+   * ```
+   */
+  fund: (options: Omit<FundOptions, "address">) => Promise<FundOperationResult>;
+
+  /**
+   * Waits for a fund operation to complete and returns the transfer receipt.
+   *
+   * @param options - The options for the wait for fund operation.
+   * @param options.transferId - The ID of the transfer to wait for.
+   *
+   * @returns A promise that resolves to the completed transfer receipt containing details about the funding operation.
+   *
+   * @example
+   * ```ts
+   * const completedTransfer = await account.waitForFundOperationReceipt({
+   *   transferId: "transfer_123",
+   * });
+   * ```
+   */
+  waitForFundOperationReceipt(
+    options: WaitForFundOperationOptions,
+  ): Promise<WaitForFundOperationResult>;
 };
 
 export type AccountActions = Actions & {

package/client/evm/evm.ts

@@ -103,6 +103,7 @@ export class EvmClient implements EvmClientInterface {
     const openApiAccount = await CdpOpenApiClient.createEvmAccount(
       {
         name: options.name,
+        accountPolicy: options.accountPolicy,
       },
       options.idempotencyKey,
     );

package/client/evm/evm.types.ts

@@ -145,6 +145,8 @@ export interface UserOperation {
 export interface CreateServerAccountOptions {
   /** The name of the account. */
   name?: string;
+  /** The policy ID to apply to the account. */
+  accountPolicy?: string;
   /** The idempotency key. */
   idempotencyKey?: string;
 }

package/client/solana/solana.ts

@@ -56,7 +56,10 @@ export class SolanaClient implements SolanaClientInterface {
    */
   async createAccount(options: CreateAccountOptions = {}): Promise<SolanaAccount> {
     const openApiAccount = await CdpOpenApiClient.createSolanaAccount(
-      options,
+      {
+        name: options.name,
+        accountPolicy: options.accountPolicy,
+      },
       options.idempotencyKey,
     );
 

package/client/solana/solana.types.ts

@@ -40,6 +40,8 @@ export interface SignatureResult {
 export interface CreateAccountOptions {
   /** The name of the account. */
   name?: string;
+  /** The policy ID to apply to the account. */
+  accountPolicy?: string;
   /** The idempotency key. */
   idempotencyKey?: string;
 }

package/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.ts

@@ -578,6 +578,236 @@ Account names are guaranteed to be unique across all Solana accounts in the deve
   policies?: string[];
 }
 
+/**
+ * The action of the payment method.
+ */
+export type PaymentRailAction = (typeof PaymentRailAction)[keyof typeof PaymentRailAction];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PaymentRailAction = {
+  source: "source",
+  target: "target",
+} as const;
+
+/**
+ * The type of payment method.
+ */
+export type PaymentMethodType = (typeof PaymentMethodType)[keyof typeof PaymentMethodType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PaymentMethodType = {
+  card: "card",
+  fiat_account: "fiat_account",
+} as const;
+
+/**
+ * The limit for this payment method being used as a source for transfers.
+ */
+export type PaymentMethodLimitsSourceLimit = {
+  /** The amount of the limit. */
+  amount?: string;
+  /** The currency of the limit. */
+  currency?: string;
+};
+
+/**
+ * The limit for this payment method being used as a target for transfers.
+ */
+export type PaymentMethodLimitsTargetLimit = {
+  /** The amount of the limit. */
+  amount?: string;
+  /** The currency of the limit. */
+  currency?: string;
+};
+
+/**
+ * The limits of the payment method.
+ */
+export type PaymentMethodLimits = {
+  /** The limit for this payment method being used as a source for transfers. */
+  sourceLimit?: PaymentMethodLimitsSourceLimit;
+  /** The limit for this payment method being used as a target for transfers. */
+  targetLimit?: PaymentMethodLimitsTargetLimit;
+};
+
+/**
+ * The fiat payment method object.
+ */
+export interface PaymentMethod {
+  /**
+   * The ID of the payment method which previously was added.
+   * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+   */
+  id: string;
+  /** The type of payment method. */
+  type: PaymentMethodType;
+  /** The currency of the payment method. */
+  currency: string;
+  /** The actions for the payment method. */
+  actions: PaymentRailAction[];
+  /** The limits of the payment method. */
+  limits?: PaymentMethodLimits;
+}
+
+/**
+ * The networks of the asset.
+ */
+export type CryptoRailNetworksItem = {
+  /** The name of the network. */
+  name?: string;
+  /** The chain ID of the network. */
+  chainId?: number;
+  /** The contract address of the asset on the network. */
+  contractAddress?: string;
+};
+
+/**
+ * The crypto rails available.
+ */
+export interface CryptoRail {
+  /** The currency symbol of the asset. */
+  currency: string;
+  /** The name of the asset. */
+  name: string;
+  /** All available networks of the asset. */
+  networks: CryptoRailNetworksItem[];
+  /** The actions for the crypto rail. */
+  actions: PaymentRailAction[];
+}
+
+/**
+ * The fiat payment method request object.
+ */
+export interface PaymentMethodRequest {
+  /**
+   * The ID of the payment method.
+   * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+   */
+  id: string;
+}
+
+/**
+ * The source of the transfer.
+ */
+export type TransferSource = PaymentMethodRequest;
+
+/**
+ * The crypto rail input object which specifies the symbol, network, and address which is the source or destination wallet address.
+ */
+export interface CryptoRailAddress {
+  /** The symbol of the currency of the payment rail. */
+  currency: string;
+  /** The network of the payment rail. */
+  network: string;
+  /** The address of the payment rail. This is the source or destination wallet address. It is not a contract address. */
+  address: string;
+}
+
+/**
+ * The target of the transfer.
+ */
+export type TransferTarget = CryptoRailAddress;
+
+/**
+ * The type of fee.
+ */
+export type FeeType = (typeof FeeType)[keyof typeof FeeType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FeeType = {
+  exchange_fee: "exchange_fee",
+  network_fee: "network_fee",
+} as const;
+
+/**
+ * The fee for the transfer.
+ */
+export interface Fee {
+  /** The type of fee. */
+  type: FeeType;
+  /** The amount of the fee. */
+  amount: string;
+  /** The currency of the fee. */
+  currency: string;
+  /** The description of the fee. */
+  description?: string;
+}
+
+/**
+ * The type of the source of the transfer.
+ */
+export type TransferSourceType = (typeof TransferSourceType)[keyof typeof TransferSourceType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const TransferSourceType = {
+  payment_method: "payment_method",
+} as const;
+
+/**
+ * The type of the target of the transfer.
+ */
+export type TransferTargetType = (typeof TransferTargetType)[keyof typeof TransferTargetType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const TransferTargetType = {
+  crypto_rail: "crypto_rail",
+} as const;
+
+/**
+ * The status of the transfer.
+ */
+export type TransferStatus = (typeof TransferStatus)[keyof typeof TransferStatus];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const TransferStatus = {
+  created: "created",
+  pending: "pending",
+  started: "started",
+  completed: "completed",
+  failed: "failed",
+} as const;
+
+/**
+ * The transfer object.
+ */
+export interface Transfer {
+  /**
+   * The ID of the transfer.
+   * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+   */
+  id: string;
+  /** The type of the source of the transfer. */
+  sourceType: TransferSourceType;
+  /** The source of the transfer. */
+  source: PaymentMethodRequest;
+  /** The type of the target of the transfer. */
+  targetType: TransferTargetType;
+  /** The target of the transfer. */
+  target: CryptoRailAddress;
+  /** The amount the source will transfer. */
+  sourceAmount: string;
+  /** The currency the source will transfer. */
+  sourceCurrency: string;
+  /** The amount the target will receive. */
+  targetAmount: string;
+  /** The currency the target will receive. */
+  targetCurrency: string;
+  /** The amount the customer put in to transfer. */
+  userAmount: string;
+  /** The currency the customer put in to transfer. */
+  userCurrency: string;
+  /** The fees for the transfer. */
+  fees: Fee[];
+  /** The status of the transfer. */
+  status: TransferStatus;
+  /** The UTC date and time in ISO 8601 format the transfer was created. */
+  createdAt: string;
+  /** The UTC date and time in ISO 8601 format the transfer was updated. */
+  updatedAt: string;
+  /** The transaction hash or transaction signature of the transfer. */
+  transactionHash?: string;
+}
+
 /**
  * Internal server error.
  */
@@ -645,6 +875,11 @@ Account names must be unique across all EVM accounts in the developer's CDP Proj
    * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
    */
   name?: string;
+  /**
+   * The ID of the account-level policy to apply to the account.
+   * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+   */
+  accountPolicy?: string;
 };
 
 export type UpdateEvmAccountBody = {
@@ -936,6 +1171,11 @@ Account names must be unique across all Solana accounts in the developer's CDP P
    * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
    */
   name?: string;
+  /**
+   * The ID of the account-level policy to apply to the account.
+   * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+   */
+  accountPolicy?: string;
 };
 
 export type UpdateSolanaAccountBody = {
@@ -998,3 +1238,51 @@ export type RequestSolanaFaucet200 = {
   /** The signature identifying the transaction that requested the funds. */
   transactionSignature: string;
 };
+
+export type GetCryptoRailsParams = {
+  /**
+   * Comma separated list of networks to filter the rails by.
+   */
+  networks?: string;
+};
+
+/**
+ * The type of the source of the transfer.
+ */
+export type CreatePaymentTransferQuoteBodySourceType =
+  (typeof CreatePaymentTransferQuoteBodySourceType)[keyof typeof CreatePaymentTransferQuoteBodySourceType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const CreatePaymentTransferQuoteBodySourceType = {
+  payment_method: "payment_method",
+} as const;
+
+/**
+ * The type of the target of the transfer.
+ */
+export type CreatePaymentTransferQuoteBodyTargetType =
+  (typeof CreatePaymentTransferQuoteBodyTargetType)[keyof typeof CreatePaymentTransferQuoteBodyTargetType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const CreatePaymentTransferQuoteBodyTargetType = {
+  crypto_rail: "crypto_rail",
+} as const;
+
+export type CreatePaymentTransferQuoteBody = {
+  /** The type of the source of the transfer. */
+  sourceType: CreatePaymentTransferQuoteBodySourceType;
+  source: TransferSource;
+  /** The type of the target of the transfer. */
+  targetType: CreatePaymentTransferQuoteBodyTargetType;
+  target: TransferTarget;
+  /** The amount of the transfer, which is either for the source currency to buy, or the target currency to receive. */
+  amount: string;
+  /** The currency of the transfer. This can be specified as the source currency, which would be used to buy, or else the target currency, which is how much will be received. */
+  currency: string;
+  /** Whether to execute the transfer. If true, the transfer will be committed and executed. If false, the quote will be generated and returned. */
+  execute?: boolean;
+};
+
+export type CreatePaymentTransferQuote201 = {
+  transfer: Transfer;
+};

package/openapi-client/generated/index.msw.ts

@@ -1,6 +1,7 @@
-export * from "./evm-accounts/evm-accounts.msw.js";
 export * from "./evm-token-balances/evm-token-balances.msw.js";
-export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";
+export * from "./evm-accounts/evm-accounts.msw.js";
 export * from "./faucets/faucets.msw.js";
-export * from "./policy-engine/policy-engine.msw.js";
 export * from "./solana-accounts/solana-accounts.msw.js";
+export * from "./payments-alpha/payments-alpha.msw.js";
+export * from "./policy-engine/policy-engine.msw.js";
+export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";