@coinbase/cdp-sdk 1.49.2 → 1.51.0

package/{client → src/client}/end-user/endUser.types.ts

@@ -59,7 +59,10 @@ export type ListEndUsersOptions = ListEndUsersParams;
 /**
  * The options for creating an end user.
  */
-export type CreateEndUserOptions = CreateEndUserBody;
+export type CreateEndUserOptions = CreateEndUserBody & {
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
+};
 
 /**
  * The options for adding an EVM account to an end user.
@@ -69,6 +72,8 @@ export interface AddEndUserEvmAccountOptions {
    * The unique identifier of the end user.
    */
   userId: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -88,6 +93,8 @@ export interface AddEndUserEvmSmartAccountOptions {
    * If true, enables spend permissions for the EVM smart account.
    */
   enableSpendPermissions: boolean;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -103,6 +110,8 @@ export interface AddEndUserSolanaAccountOptions {
    * The unique identifier of the end user.
    */
   userId: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -139,6 +148,8 @@ export interface ImportEndUserOptions {
    * Defaults to the known CDP public key.
    */
   encryptionPublicKey?: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -164,6 +175,8 @@ export interface RevokeDelegationForEndUserOptions {
    * The unique identifier of the end user.
    */
   userId: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 // ─── Account-Scoped Delegation Options/Results ───
@@ -225,6 +238,8 @@ export interface SignEvmTransactionOptions {
   address: string;
   /** The RLP-serialized EIP-1559 transaction to sign, hex-encoded. */
   transaction: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -242,6 +257,8 @@ export interface SignEvmMessageOptions {
   address: string;
   /** The EIP-191 message to sign. */
   message: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -259,6 +276,8 @@ export interface SignEvmTypedDataOptions {
   address: string;
   /** The EIP-712 typed data to sign. */
   typedData: EIP712Message;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -280,6 +299,8 @@ export interface SendEvmTransactionOptions {
   transaction: string;
   /** The network to send the transaction on. */
   network: SendEvmTransactionWithEndUserAccountBodyNetwork;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -307,6 +328,8 @@ export interface SendEvmAssetOptions {
   useCdpPaymaster?: boolean;
   /** A custom paymaster URL. */
   paymasterUrl?: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -332,6 +355,8 @@ export interface SendUserOperationOptions {
   paymasterUrl?: string;
   /** An optional data suffix. */
   dataSuffix?: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -353,6 +378,8 @@ export interface CreateEvmEip7702DelegationOptions {
   network: EvmEip7702DelegationNetwork;
   /** Whether to enable spend permissions for the delegation. */
   enableSpendPermissions?: boolean;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -373,6 +400,8 @@ export interface SignSolanaMessageOptions {
   address: string;
   /** The base64-encoded message to sign. */
   message: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -390,6 +419,8 @@ export interface SignSolanaTransactionOptions {
   address: string;
   /** The base64-encoded Solana transaction to sign. */
   transaction: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -411,6 +442,8 @@ export interface SendSolanaTransactionOptions {
   transaction: string;
   /** The Solana network to send on. */
   network: SendSolanaTransactionWithEndUserAccountBodyNetwork;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -436,6 +469,8 @@ export interface SendSolanaAssetOptions {
   network: SendSolanaAssetWithEndUserAccountBodyNetwork;
   /** Whether to create the recipient's associated token account if it doesn't exist. */
   createRecipientAta?: boolean;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -453,6 +488,8 @@ export interface AccountSignEvmTransactionOptions {
   address?: string;
   /** The RLP-serialized EIP-1559 transaction to sign, hex-encoded. */
   transaction: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -463,6 +500,8 @@ export interface AccountSignEvmMessageOptions {
   address?: string;
   /** The EIP-191 message to sign. */
   message: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -473,6 +512,8 @@ export interface AccountSignEvmTypedDataOptions {
   address?: string;
   /** The EIP-712 typed data to sign. */
   typedData: EIP712Message;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -485,6 +526,8 @@ export interface AccountSendEvmTransactionOptions {
   transaction: string;
   /** The network to send the transaction on. */
   network: SendEvmTransactionWithEndUserAccountBodyNetwork;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -505,6 +548,8 @@ export interface AccountSendEvmAssetOptions {
   useCdpPaymaster?: boolean;
   /** A custom paymaster URL. */
   paymasterUrl?: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -523,6 +568,8 @@ export interface AccountSendUserOperationOptions {
   paymasterUrl?: string;
   /** An optional data suffix. */
   dataSuffix?: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -535,6 +582,8 @@ export interface AccountCreateEvmEip7702DelegationOptions {
   network: EvmEip7702DelegationNetwork;
   /** Whether to enable spend permissions for the delegation. */
   enableSpendPermissions?: boolean;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -545,6 +594,8 @@ export interface AccountSignSolanaMessageOptions {
   address?: string;
   /** The base64-encoded message to sign. */
   message: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -555,6 +606,8 @@ export interface AccountSignSolanaTransactionOptions {
   address?: string;
   /** The base64-encoded Solana transaction to sign. */
   transaction: string;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -567,6 +620,8 @@ export interface AccountSendSolanaTransactionOptions {
   transaction: string;
   /** The Solana network to send on. */
   network: SendSolanaTransactionWithEndUserAccountBodyNetwork;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -585,6 +640,8 @@ export interface AccountSendSolanaAssetOptions {
   network: SendSolanaAssetWithEndUserAccountBodyNetwork;
   /** Whether to create the recipient's associated token account if it doesn't exist. */
   createRecipientAta?: boolean;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -595,6 +652,8 @@ export interface AddEvmSmartAccountOptions {
    * If true, enables spend permissions for the EVM smart account.
    */
   enableSpendPermissions: boolean;
+  /** Optional idempotency key for safe retries. */
+  idempotencyKey?: string;
 }
 
 /**
@@ -617,7 +676,7 @@ export type EndUserAccountActions = {
    * console.log(result.evmAccount.address);
    * ```
    */
-  addEvmAccount: () => Promise<AddEndUserEvmAccountResult>;
+  addEvmAccount: (idempotencyKey?: string) => Promise<AddEndUserEvmAccountResult>;
 
   /**
    * Adds an EVM smart account to this end user.
@@ -657,7 +716,7 @@ export type EndUserAccountActions = {
    * console.log(result.solanaAccount.address);
    * ```
    */
-  addSolanaAccount: () => Promise<AddEndUserSolanaAccountResult>;
+  addSolanaAccount: (idempotencyKey?: string) => Promise<AddEndUserSolanaAccountResult>;
 
   /**
    * Gets the active delegation for this end user, if one exists.
@@ -687,7 +746,7 @@ export type EndUserAccountActions = {
    * await endUser.revokeDelegation();
    * ```
    */
-  revokeDelegation: () => Promise<void>;
+  revokeDelegation: (idempotencyKey?: string) => Promise<void>;
 
   // ─── Account-Scoped Delegation Methods ───
 

package/{client → src/client}/end-user/toEndUserAccount.ts

@@ -128,23 +128,25 @@ export function toEndUserAccount(
 
     // ─── Account Management Methods ───
 
-    async addEvmAccount(): Promise<AddEndUserEvmAccountResult> {
+    async addEvmAccount(idempotencyKey?: string): Promise<AddEndUserEvmAccountResult> {
       Analytics.trackAction({ action: "end_user_add_evm_account" });
-      return apiClient.addEndUserEvmAccount(endUser.userId, {});
+      return apiClient.addEndUserEvmAccount(endUser.userId, {}, idempotencyKey);
     },
 
     async addEvmSmartAccount(
       smartAccountOptions: AddEvmSmartAccountOptions,
     ): Promise<AddEndUserEvmSmartAccountResult> {
       Analytics.trackAction({ action: "end_user_add_evm_smart_account" });
-      return apiClient.addEndUserEvmSmartAccount(endUser.userId, {
-        enableSpendPermissions: smartAccountOptions.enableSpendPermissions,
-      });
+      return apiClient.addEndUserEvmSmartAccount(
+        endUser.userId,
+        { enableSpendPermissions: smartAccountOptions.enableSpendPermissions },
+        smartAccountOptions.idempotencyKey,
+      );
     },
 
-    async addSolanaAccount(): Promise<AddEndUserSolanaAccountResult> {
+    async addSolanaAccount(idempotencyKey?: string): Promise<AddEndUserSolanaAccountResult> {
       Analytics.trackAction({ action: "end_user_add_solana_account" });
-      return apiClient.addEndUserSolanaAccount(endUser.userId, {});
+      return apiClient.addEndUserSolanaAccount(endUser.userId, {}, idempotencyKey);
     },
 
     async getDelegation(): Promise<GetDelegationForEndUserResult> {
@@ -152,9 +154,9 @@ export function toEndUserAccount(
       return apiClient.getDelegationForEndUser(endUser.userId);
     },
 
-    async revokeDelegation(): Promise<void> {
+    async revokeDelegation(idempotencyKey?: string): Promise<void> {
       Analytics.trackAction({ action: "end_user_revoke_delegation" });
-      await apiClient.revokeDelegationForEndUser(endUser.userId, {});
+      await apiClient.revokeDelegationForEndUser(endUser.userId, {}, undefined, idempotencyKey);
     },
 
     // ─── Account-Scoped Delegation Methods ───
@@ -188,28 +190,34 @@ export function toEndUserAccount(
     ): Promise<SignEvmTransactionResult> {
       Analytics.trackAction({ action: "end_user_sign_evm_transaction" });
       const address = resolveEvmAddress(endUser, opts.address);
-      return apiClient.signEvmTransactionWithEndUserAccount(endUser.userId, {
-        address,
-        transaction: opts.transaction,
-      });
+      return apiClient.signEvmTransactionWithEndUserAccount(
+        endUser.userId,
+        { address, transaction: opts.transaction },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     async signEvmMessage(opts: AccountSignEvmMessageOptions): Promise<SignEvmMessageResult> {
       Analytics.trackAction({ action: "end_user_sign_evm_message" });
       const address = resolveEvmAddress(endUser, opts.address);
-      return apiClient.signEvmMessageWithEndUserAccount(endUser.userId, {
-        address,
-        message: opts.message,
-      });
+      return apiClient.signEvmMessageWithEndUserAccount(
+        endUser.userId,
+        { address, message: opts.message },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     async signEvmTypedData(opts: AccountSignEvmTypedDataOptions): Promise<SignEvmTypedDataResult> {
       Analytics.trackAction({ action: "end_user_sign_evm_typed_data" });
       const address = resolveEvmAddress(endUser, opts.address);
-      return apiClient.signEvmTypedDataWithEndUserAccount(endUser.userId, {
-        address,
-        typedData: opts.typedData,
-      });
+      return apiClient.signEvmTypedDataWithEndUserAccount(
+        endUser.userId,
+        { address, typedData: opts.typedData },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     // ─── Delegated EVM Send Methods ───
@@ -219,24 +227,32 @@ export function toEndUserAccount(
     ): Promise<SendEvmTransactionResult> {
       Analytics.trackAction({ action: "end_user_send_evm_transaction" });
       const address = resolveEvmAddress(endUser, opts.address);
-      return apiClient.sendEvmTransactionWithEndUserAccount(endUser.userId, {
-        address,
-        transaction: opts.transaction,
-        network: opts.network,
-      });
+      return apiClient.sendEvmTransactionWithEndUserAccount(
+        endUser.userId,
+        { address, transaction: opts.transaction, network: opts.network },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     async sendEvmAsset(opts: AccountSendEvmAssetOptions): Promise<SendEvmAssetResult> {
       Analytics.trackAction({ action: "end_user_send_evm_asset" });
       const address = resolveEvmAddress(endUser, opts.address);
       const asset = opts.asset ?? "usdc";
-      return apiClient.sendEvmAssetWithEndUserAccount(endUser.userId, address, asset, {
-        to: opts.to,
-        amount: opts.amount,
-        network: opts.network,
-        useCdpPaymaster: opts.useCdpPaymaster,
-        paymasterUrl: opts.paymasterUrl,
-      });
+      return apiClient.sendEvmAssetWithEndUserAccount(
+        endUser.userId,
+        address,
+        asset,
+        {
+          to: opts.to,
+          amount: opts.amount,
+          network: opts.network,
+          useCdpPaymaster: opts.useCdpPaymaster,
+          paymasterUrl: opts.paymasterUrl,
+        },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     async sendUserOperation(
@@ -244,13 +260,19 @@ export function toEndUserAccount(
     ): Promise<SendUserOperationResult> {
       Analytics.trackAction({ action: "end_user_send_user_operation" });
       const address = resolveEvmSmartAccountAddress(endUser, opts.address);
-      return apiClient.sendUserOperationWithEndUserAccount(endUser.userId, address, {
-        network: opts.network,
-        calls: opts.calls,
-        useCdpPaymaster: opts.useCdpPaymaster,
-        paymasterUrl: opts.paymasterUrl,
-        dataSuffix: opts.dataSuffix,
-      });
+      return apiClient.sendUserOperationWithEndUserAccount(
+        endUser.userId,
+        address,
+        {
+          network: opts.network,
+          calls: opts.calls,
+          useCdpPaymaster: opts.useCdpPaymaster,
+          paymasterUrl: opts.paymasterUrl,
+          dataSuffix: opts.dataSuffix,
+        },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     // ─── Delegated EVM EIP-7702 Delegation Method ───
@@ -260,11 +282,16 @@ export function toEndUserAccount(
     ): Promise<CreateEvmEip7702DelegationForEndUserResult> {
       Analytics.trackAction({ action: "end_user_create_evm_eip7702_delegation" });
       const address = resolveEvmAddress(endUser, opts.address);
-      return apiClient.createEvmEip7702DelegationWithEndUserAccount(endUser.userId, {
-        address,
-        network: opts.network,
-        enableSpendPermissions: opts.enableSpendPermissions,
-      });
+      return apiClient.createEvmEip7702DelegationWithEndUserAccount(
+        endUser.userId,
+        {
+          address,
+          network: opts.network,
+          enableSpendPermissions: opts.enableSpendPermissions,
+        },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     // ─── Delegated Solana Sign Methods ───
@@ -274,10 +301,12 @@ export function toEndUserAccount(
     ): Promise<SignSolanaMessageResult> {
       Analytics.trackAction({ action: "end_user_sign_solana_message" });
       const address = resolveSolanaAddress(endUser, opts.address);
-      return apiClient.signSolanaMessageWithEndUserAccount(endUser.userId, {
-        address,
-        message: opts.message,
-      });
+      return apiClient.signSolanaMessageWithEndUserAccount(
+        endUser.userId,
+        { address, message: opts.message },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     async signSolanaTransaction(
@@ -285,10 +314,12 @@ export function toEndUserAccount(
     ): Promise<SignSolanaTransactionResult> {
       Analytics.trackAction({ action: "end_user_sign_solana_transaction" });
       const address = resolveSolanaAddress(endUser, opts.address);
-      return apiClient.signSolanaTransactionWithEndUserAccount(endUser.userId, {
-        address,
-        transaction: opts.transaction,
-      });
+      return apiClient.signSolanaTransactionWithEndUserAccount(
+        endUser.userId,
+        { address, transaction: opts.transaction },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     // ─── Delegated Solana Send Methods ───
@@ -298,23 +329,31 @@ export function toEndUserAccount(
     ): Promise<SendSolanaTransactionResult> {
       Analytics.trackAction({ action: "end_user_send_solana_transaction" });
       const address = resolveSolanaAddress(endUser, opts.address);
-      return apiClient.sendSolanaTransactionWithEndUserAccount(endUser.userId, {
-        address,
-        transaction: opts.transaction,
-        network: opts.network,
-      });
+      return apiClient.sendSolanaTransactionWithEndUserAccount(
+        endUser.userId,
+        { address, transaction: opts.transaction, network: opts.network },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
 
     async sendSolanaAsset(opts: AccountSendSolanaAssetOptions): Promise<SendSolanaAssetResult> {
       Analytics.trackAction({ action: "end_user_send_solana_asset" });
       const address = resolveSolanaAddress(endUser, opts.address);
       const asset = opts.asset ?? "usdc";
-      return apiClient.sendSolanaAssetWithEndUserAccount(endUser.userId, address, asset, {
-        to: opts.to,
-        amount: opts.amount,
-        network: opts.network,
-        createRecipientAta: opts.createRecipientAta,
-      });
+      return apiClient.sendSolanaAssetWithEndUserAccount(
+        endUser.userId,
+        address,
+        asset,
+        {
+          to: opts.to,
+          amount: opts.amount,
+          network: opts.network,
+          createRecipientAta: opts.createRecipientAta,
+        },
+        undefined,
+        opts.idempotencyKey,
+      );
     },
   };
 

package/src/openapi-client/generated/accounts/accounts.ts

@@ -0,0 +1,103 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Coinbase Developer Platform APIs
+ * The Coinbase Developer Platform APIs - leading the world's transition onchain.
+ * OpenAPI spec version: 2.0.0
+ */
+import type {
+  Account,
+  AccountId,
+  Asset,
+  Balance,
+  CreateAccountRequest,
+  ListBalances200,
+  ListBalancesParams,
+  ListFoundationAccounts200,
+  ListFoundationAccountsParams,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * List all accounts. The API will return all accounts that the API Key has Permissions to access. You can filter the results by using query parameters, which will be treated as a single conjunction (i.e. AND). Results are sorted by creation date in descending order (newest first).
+ * @summary List accounts
+ */
+export const listFoundationAccounts = (
+  params?: ListFoundationAccountsParams,
+  options?: SecondParameter<typeof cdpApiClient<ListFoundationAccounts200>>,
+) => {
+  return cdpApiClient<ListFoundationAccounts200>(
+    { url: `/v2/accounts`, method: "GET", params },
+    options,
+  );
+};
+/**
+ * Create an account for your Entity. Support for creating Customer-owned accounts is in development.
+ * @summary Create account
+ */
+export const createFoundationAccount = (
+  createAccountRequest: CreateAccountRequest,
+  options?: SecondParameter<typeof cdpApiClient<Account>>,
+) => {
+  return cdpApiClient<Account>(
+    {
+      url: `/v2/accounts`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createAccountRequest,
+    },
+    options,
+  );
+};
+/**
+ * Get an account by its ID.
+ * @summary Get account
+ */
+export const getFoundationAccountById = (
+  accountId: AccountId,
+  options?: SecondParameter<typeof cdpApiClient<Account>>,
+) => {
+  return cdpApiClient<Account>({ url: `/v2/accounts/${accountId}`, method: "GET" }, options);
+};
+/**
+ * List the balances for an account. Results are sorted by native-fiat equivalent balance in descending order.
+ * @summary List balances for account
+ */
+export const listBalances = (
+  accountId: AccountId,
+  params?: ListBalancesParams,
+  options?: SecondParameter<typeof cdpApiClient<ListBalances200>>,
+) => {
+  return cdpApiClient<ListBalances200>(
+    { url: `/v2/accounts/${accountId}/balances`, method: "GET", params },
+    options,
+  );
+};
+/**
+ * Get the balance for an account by asset.
+ * @summary Get balance for account
+ */
+export const getBalanceByAsset = (
+  accountId: AccountId,
+  asset: Asset,
+  options?: SecondParameter<typeof cdpApiClient<Balance>>,
+) => {
+  return cdpApiClient<Balance>(
+    { url: `/v2/accounts/${accountId}/balances/${asset}`, method: "GET" },
+    options,
+  );
+};
+export type ListFoundationAccountsResult = NonNullable<
+  Awaited<ReturnType<typeof listFoundationAccounts>>
+>;
+export type CreateFoundationAccountResult = NonNullable<
+  Awaited<ReturnType<typeof createFoundationAccount>>
+>;
+export type GetFoundationAccountByIdResult = NonNullable<
+  Awaited<ReturnType<typeof getFoundationAccountById>>
+>;
+export type ListBalancesResult = NonNullable<Awaited<ReturnType<typeof listBalances>>>;
+export type GetBalanceByAssetResult = NonNullable<Awaited<ReturnType<typeof getBalanceByAsset>>>;