@coinbase/cdp-sdk 1.38.4 → 1.38.6

package/client/evm/evm.types.ts

@@ -18,6 +18,7 @@ import type {
   SendTransactionOptions,
 } from "../../actions/evm/sendTransaction.js";
 import type {
+  PrepareAndSendUserOperationReturnType,
   SendUserOperationOptions,
   SendUserOperationReturnType,
 } from "../../actions/evm/sendUserOperation.js";
@@ -61,6 +62,7 @@ export type EvmClientInterface = Omit<
   | "listEvmSmartAccounts" // mapped to listSmartAccounts
   | "listEvmTokenBalances" // mapped to listTokenBalances
   | "prepareUserOperation"
+  | "prepareAndSendUserOperation"
   | "requestEvmFaucet" // mapped to requestFaucet
   | "sendUserOperation"
   | "signEvmHash" // mapped to signHash
@@ -102,6 +104,9 @@ export type EvmClientInterface = Omit<
   sendUserOperation: (
     options: SendUserOperationOptions<unknown[]>,
   ) => Promise<SendUserOperationReturnType>;
+  prepareAndSendUserOperation: (
+    options: PrepareAndSendUserOperationOptions,
+  ) => Promise<PrepareAndSendUserOperationReturnType>;
   signHash: (options: SignHashOptions) => Promise<SignatureResult>;
   signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
   signTypedData: (options: SignTypedDataOptions) => Promise<SignatureResult>;
@@ -293,6 +298,22 @@ export interface PrepareUserOperationOptions {
   paymasterUrl?: string;
 }
 
+/**
+ * Options for preparing and sending a user operation.
+ */
+export interface PrepareAndSendUserOperationOptions {
+  /** The smart account. */
+  smartAccount: SmartAccount;
+  /** The network. */
+  network: EvmUserOperationNetwork;
+  /** The calls. */
+  calls: Calls<EvmCall[]>;
+  /** The paymaster URL. */
+  paymasterUrl?: string;
+  /** An optional idempotency key. */
+  idempotencyKey?: string;
+}
+
 /**
  * A call to be executed in a user operation.
  */
@@ -307,6 +328,8 @@ export interface EvmCall {
    * The call data to send. This is the hex-encoded data of the function call consisting of the method selector and the function arguments.
    */
   data: Hex;
+  /** The override gas limit. */
+  overrideGasLimit?: string;
 }
 
 /**

package/index.ts

@@ -9,7 +9,8 @@ export {
 } from "./policies/types.js";
 export { NetworkError } from "./openapi-client/errors.js";
 export type { SpendPermission, SpendPermissionInput } from "./spend-permissions/types.js";
-export type { SpendPermissionNetwork } from "./openapi-client/index.js";
+export type { SpendPermissionNetwork, ListEndUsers200, EndUser } from "./openapi-client/index.js";
+export type { ListEndUsersOptions } from "./client/end-user/endUser.types.js";
 export {
   SPEND_PERMISSION_MANAGER_ABI as spendPermissionManagerAbi,
   SPEND_PERMISSION_MANAGER_ADDRESS as spendPermissionManagerAddress,

package/openapi-client/cdpApiClient.ts

@@ -5,6 +5,7 @@ import axiosRetry, { exponentialDelay } from "axios-retry";
 import { withAuth } from "../auth/hooks/axios/index.js";
 import { ERROR_DOCS_PAGE_URL } from "../constants.js";
 import { isOpenAPIError, APIError, UnknownError, NetworkError } from "./errors.js";
+import { UserInputValidationError } from "../errors.js";
 
 import type { Prettify } from "../types/utils.js";
 
@@ -132,6 +133,10 @@ export const cdpApiClient = async <T>(
     const response = await axiosInstance(configWithIdempotencyKey);
     return response.data as T;
   } catch (error) {
+    if (error instanceof UserInputValidationError) {
+      throw error;
+    }
+
     // eslint-disable-next-line import/no-named-as-default-member
     if (Axios.isAxiosError(error) && !error.response) {
       // Network-level errors (no response received)

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

@@ -104,6 +104,11 @@ export interface EndUser {
   solanaAccounts: string[];
 }
 
+export interface ListResponse {
+  /** The token for the next page of items, if any. */
+  nextPageToken?: string;
+}
+
 /**
  * The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
  */
@@ -177,11 +182,6 @@ Account names are guaranteed to be unique across all EVM accounts in the develop
   updatedAt?: string;
 }
 
-export interface ListResponse {
-  /** The token for the next page of items, if any. */
-  nextPageToken?: string;
-}
-
 /**
  * The domain of the EIP-712 typed data.
  */
@@ -286,6 +286,8 @@ export interface EvmCall {
    * @pattern ^0x[0-9a-fA-F]*$
    */
   data: string;
+  /** The override gas limit to use for the call instead of the bundler's estimated gas limit. */
+  overrideGasLimit?: string;
 }
 
 /**
@@ -2309,7 +2311,7 @@ export interface OnchainDataQuery {
   /**
    * SQL query to execute against the indexed blockchain data.
    * @minLength 1
-   * @maxLength 10000
+   * @maxLength 50000
    */
   sql: string;
 }
@@ -2715,236 +2717,6 @@ export interface X402SupportedPaymentKind {
   extra?: X402SupportedPaymentKindExtra;
 }
 
-/**
- * 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;
-}
-
 /**
  * The type of payment method to be used to complete an onramp order.
  */
@@ -3025,6 +2797,8 @@ export interface OnrampOrder {
   createdAt: string;
   /** The date and time the order was last updated. */
   updatedAt: string;
+  /** The partner user reference ID. */
+  partnerUserRef?: string;
 }
 
 /**
@@ -3095,6 +2869,11 @@ export interface OnrampQuote {
   exchangeRate: string;
 }
 
+/**
+ * Unauthorized.
+ */
+export type UnauthorizedErrorResponse = Error;
+
 /**
  * Internal server error.
  */
@@ -3130,11 +2909,6 @@ export type AlreadyExistsErrorResponse = Error;
  */
 export type InvalidSQLQueryErrorResponse = Error;
 
-/**
- * Unauthorized.
- */
-export type UnauthorizedErrorResponse = Error;
-
 /**
  * The request timed out.
  */
@@ -3205,6 +2979,36 @@ Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/i
  */
 export type IdempotencyKeyParameter = string;
 
+export type ListEndUsersParams = {
+  /**
+   * The number of end users to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the desired page of end users. Will be empty if there are no more end users to fetch.
+   */
+  pageToken?: string;
+  /**
+   * Sort end users. Defaults to ascending order (oldest first).
+   */
+  sort?: ListEndUsersSortItem[];
+};
+
+export type ListEndUsersSortItem = (typeof ListEndUsersSortItem)[keyof typeof ListEndUsersSortItem];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ListEndUsersSortItem = {
+  "createdAt=asc": "createdAt=asc",
+  "createdAt=desc": "createdAt=desc",
+} as const;
+
+export type ListEndUsers200AllOf = {
+  /** The list of end users. */
+  endUsers: EndUser[];
+};
+
+export type ListEndUsers200 = ListEndUsers200AllOf & ListResponse;
+
 /**
  * The request body for a developer to verify an end user's access token.
  */
@@ -3411,6 +3215,14 @@ export type PrepareUserOperationBody = {
   paymasterUrl?: string;
 };
 
+export type PrepareAndSendUserOperationBody = {
+  network: EvmUserOperationNetwork;
+  /** The list of calls to make from the Smart Account. */
+  calls: EvmCall[];
+  /** The URL of the paymaster to use for the user operation. */
+  paymasterUrl?: string;
+};
+
 export type SendUserOperationBody = {
   /** The hex-encoded signature of the user operation. This should be a 65-byte signature consisting of the `r`, `s`, and `v` values of the ECDSA signature. Note that the `v` value should conform to the `personal_sign` standard, which means it should be 27 or 28. */
   signature: string;
@@ -3812,54 +3624,6 @@ export type SettleX402PaymentBody = {
   paymentRequirements: X402PaymentRequirements;
 };
 
-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;
-};
-
 export type CreateOnrampOrderBody = {
   /** The timestamp of when the user acknowledged that by using Coinbase Onramp they are accepting the Coinbase Terms  (https://www.coinbase.com/legal/guest-checkout/us), User Agreement (https://www.coinbase.com/legal/user_agreement),  and Privacy Policy (https://www.coinbase.com/legal/privacy). */
   agreementAcceptedAt: string;

package/openapi-client/generated/end-user-accounts/end-user-accounts.ts

@@ -7,6 +7,8 @@
  */
 import type {
   EndUser,
+  ListEndUsers200,
+  ListEndUsersParams,
   ValidateEndUserAccessTokenBody,
 } from "../coinbaseDeveloperPlatformAPIs.schemas.js";
 
@@ -14,6 +16,17 @@ import { cdpApiClient } from "../../cdpApiClient.js";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
+/**
+ * Lists the end users belonging to the developer's CDP Project.
+By default, the response is sorted by creation date in ascending order and paginated to 20 users per page.
+ * @summary List end users
+ */
+export const listEndUsers = (
+  params?: ListEndUsersParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<ListEndUsers200>({ url: `/v2/end-users`, method: "GET", params }, options);
+};
 /**
  * Validates the end user's access token and returns the end user's information. Returns an error if the access token is invalid or expired.
 
@@ -34,6 +47,7 @@ export const validateEndUserAccessToken = (
     options,
   );
 };
+export type ListEndUsersResult = NonNullable<Awaited<ReturnType<typeof listEndUsers>>>;
 export type ValidateEndUserAccessTokenResult = NonNullable<
   Awaited<ReturnType<typeof validateEndUserAccessToken>>
 >;

package/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.ts

@@ -14,6 +14,7 @@ import type {
   ListEvmSmartAccountsParams,
   ListSpendPermissions200,
   ListSpendPermissionsParams,
+  PrepareAndSendUserOperationBody,
   PrepareUserOperationBody,
   RevokeSpendPermissionRequest,
   SendUserOperationBody,
@@ -120,6 +121,25 @@ export const prepareUserOperation = (
     options,
   );
 };
+/**
+ * Prepares, signs, and sends a user operation for an EVM Smart Account. This API can be used only if the owner on Smart Account is a CDP EVM Account.
+ * @summary Prepare and send a user operation for EVM Smart Account
+ */
+export const prepareAndSendUserOperation = (
+  address: string,
+  prepareAndSendUserOperationBody: PrepareAndSendUserOperationBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmUserOperation>(
+    {
+      url: `/v2/evm/smart-accounts/${address}/user-operations/prepare-and-send`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: prepareAndSendUserOperationBody,
+    },
+    options,
+  );
+};
 /**
  * Gets a user operation by its hash.
  * @summary Get a user operation
@@ -225,6 +245,9 @@ export type UpdateEvmSmartAccountResult = NonNullable<
 export type PrepareUserOperationResult = NonNullable<
   Awaited<ReturnType<typeof prepareUserOperation>>
 >;
+export type PrepareAndSendUserOperationResult = NonNullable<
+  Awaited<ReturnType<typeof prepareAndSendUserOperation>>
+>;
 export type GetUserOperationResult = NonNullable<Awaited<ReturnType<typeof getUserOperation>>>;
 export type SendUserOperationResult = NonNullable<Awaited<ReturnType<typeof sendUserOperation>>>;
 export type CreateSpendPermissionResult = NonNullable<

package/openapi-client/generated/sql-api-alpha/sql-api-alpha.ts

@@ -57,4 +57,17 @@ export const runSQLQuery = (
     options,
   );
 };
+/**
+ * Retrieve the SQL grammar for the SQL API.
+
+The SQL queries that are supported by the SQL API are defined via an ANTLR4 grammar which is evaluated by server before executing the query. This ensures the safety and soundness of the SQL API.
+
+This endpoint returns the ANTLR4 grammar that is used to evaluate the SQL queries so that developers can understand the SQL API and build SQL queries with high confidence and correctness. LLMs interact well with ANTLR4 grammar as well.
+
+ * @summary Get SQL grammar
+ */
+export const getSQLGrammar = (options?: SecondParameter<typeof cdpApiClient>) => {
+  return cdpApiClient<string>({ url: `/v2/data/query/grammar`, method: "GET" }, options);
+};
 export type RunSQLQueryResult = NonNullable<Awaited<ReturnType<typeof runSQLQuery>>>;
+export type GetSQLGrammarResult = NonNullable<Awaited<ReturnType<typeof getSQLGrammar>>>;

package/openapi-client/index.ts

@@ -7,7 +7,6 @@ export * from "./generated/solana-accounts/solana-accounts.js";
 export * from "./generated/solana-token-balances/solana-token-balances.js";
 export * from "./generated/faucets/faucets.js";
 export * from "./generated/policy-engine/policy-engine.js";
-export * from "./generated/payments-alpha/payments-alpha.js";
 export * from "./generated/onramp/onramp.js";
 export * from "./generated/onchain-data/onchain-data.js";
 export * from "./generated/end-user-accounts/end-user-accounts.js";
@@ -22,7 +21,6 @@ import * as evmSwaps from "./generated/evm-swaps/evm-swaps.js";
 import * as evmTokenBalances from "./generated/evm-token-balances/evm-token-balances.js";
 import * as faucets from "./generated/faucets/faucets.js";
 import * as onchainData from "./generated/onchain-data/onchain-data.js";
-import * as payments from "./generated/payments-alpha/payments-alpha.js";
 import * as policies from "./generated/policy-engine/policy-engine.js";
 import * as solana from "./generated/solana-accounts/solana-accounts.js";
 import * as solanaTokenBalances from "./generated/solana-token-balances/solana-token-balances.js";
@@ -37,7 +35,6 @@ export const CdpOpenApiClient = {
   ...faucets,
   ...onchainData,
   ...policies,
-  ...payments,
   ...endUserAccounts,
   configure,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-sdk",
-  "version": "1.38.4",
+  "version": "1.38.6",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/types/calls.ts

@@ -11,6 +11,7 @@ export type Call<call = unknown, extraProperties extends Record<string, unknown>
       data?: Hex | undefined;
       to: Address;
       value?: bigint | undefined;
+      overrideGasLimit?: string | undefined;
     })
   | (extraProperties &
       (Omit<GetMulticallContractParameters<call, AbiStateMutability>, "address"> & {

package/version.ts

@@ -1 +1 @@
-export const version = "1.38.4";
+export const version = "1.38.6";