@coinbase/cdp-sdk 1.29.0 → 1.30.0

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

@@ -62,7 +62,7 @@ export const ErrorType = {
   guest_region_forbidden: "guest_region_forbidden",
   guest_transaction_limit: "guest_transaction_limit",
   guest_transaction_count: "guest_transaction_count",
-  guest_phone_number_verification_expired: "guest_phone_number_verification_expired",
+  phone_number_verification_expired: "phone_number_verification_expired",
 } as const;
 
 /**
@@ -184,6 +184,26 @@ export interface EvmCall {
   data: string;
 }
 
+/**
+ * The revert data if the user operation has reverted.
+ */
+export interface UserOperationReceiptRevert {
+  /**
+   * The 0x-prefixed raw hex string.
+   * @pattern ^0x[0-9a-fA-F]*$
+   */
+  data: string;
+  /** Human-readable revert reason if able to decode. */
+  message: string;
+}
+
+/**
+ * The receipt that contains information about the execution of user operation.
+ */
+export interface UserOperationReceipt {
+  revert?: UserOperationReceiptRevert;
+}
+
 /**
  * The status of the user operation.
  */
@@ -216,6 +236,42 @@ export interface EvmUserOperation {
    * @pattern ^0x[0-9a-fA-F]{64}$|^$
    */
   transactionHash?: string;
+  /** The list of receipts associated with the user operation. */
+  receipts?: UserOperationReceipt[];
+}
+
+export interface CreateSpendPermissionRequest {
+  /** The network of the spend permission. */
+  network: string;
+  /**
+   * Smart account this spend permission is valid for.
+   * @pattern ^0x[a-fA-F0-9]{40}$
+   */
+  account: string;
+  /**
+   * Entity that can spend account's tokens.
+   * @pattern ^0x[a-fA-F0-9]{40}$
+   */
+  spender: string;
+  /**
+   * Token address (ERC-7528 native token address or ERC-20 contract).
+   * @pattern ^0x[a-fA-F0-9]{40}$
+   */
+  token: string;
+  /** Maximum allowed value to spend, in atomic units for the specified token, within each period. */
+  allowance: string;
+  /** Time duration for resetting used allowance on a recurring basis (seconds). */
+  period: string;
+  /** The start time for this spend permission, in Unix seconds. */
+  start: string;
+  /** The expiration time for this spend permission, in Unix seconds. */
+  end: string;
+  /** An arbitrary salt to differentiate unique spend permissions with otherwise identical data. */
+  salt?: string;
+  /** Arbitrary data to include in the permission. */
+  extraData?: string;
+  /** The paymaster URL of the spend permission. */
+  paymasterUrl?: string;
 }
 
 /**
@@ -1498,6 +1554,147 @@ export interface SolanaTokenBalance {
   token: SolanaToken;
 }
 
+/**
+ * The version of the x402 protocol.
+ */
+export type X402Version = (typeof X402Version)[keyof typeof X402Version];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const X402Version = {
+  NUMBER_1: 1,
+} as const;
+
+/**
+ * The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`.
+ */
+export type X402PaymentRequirementsScheme =
+  (typeof X402PaymentRequirementsScheme)[keyof typeof X402PaymentRequirementsScheme];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const X402PaymentRequirementsScheme = {
+  exact: "exact",
+} as const;
+
+/**
+ * The network of the blockchain to send payment on.
+ */
+export type X402PaymentRequirementsNetwork =
+  (typeof X402PaymentRequirementsNetwork)[keyof typeof X402PaymentRequirementsNetwork];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const X402PaymentRequirementsNetwork = {
+  "base-sepolia": "base-sepolia",
+  base: "base",
+} as const;
+
+/**
+ * The optional JSON schema describing the resource output.
+ */
+export type X402PaymentRequirementsOutputSchema = { [key: string]: unknown };
+
+/**
+ * The optional additional scheme-specific payment info.
+ */
+export type X402PaymentRequirementsExtra = { [key: string]: unknown };
+
+/**
+ * The x402 protocol payment requirements that the resource server expects the client's payment payload to meet.
+ */
+export interface X402PaymentRequirements {
+  /** The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`. */
+  scheme: X402PaymentRequirementsScheme;
+  /** The network of the blockchain to send payment on. */
+  network: X402PaymentRequirementsNetwork;
+  /** The maximum amount required to pay for the resource in atomic units of the payment asset. */
+  maxAmountRequired: string;
+  /** The URL of the resource to pay for. */
+  resource: string;
+  /** The description of the resource. */
+  description: string;
+  /** The MIME type of the resource response. */
+  mimeType: string;
+  /** The optional JSON schema describing the resource output. */
+  outputSchema?: X402PaymentRequirementsOutputSchema;
+  /**
+   * The destination to pay value to.
+
+For EVM networks, payTo will be a 0x-prefixed, checksum EVM address.
+
+For Solana-based networks, payTo will be a base58-encoded Solana address.
+   * @pattern ^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  payTo: string;
+  /** The maximum time in seconds for the resource server to respond. */
+  maxTimeoutSeconds: number;
+  /**
+   * The asset to pay with.
+
+For EVM networks, the asset will be a 0x-prefixed, checksum EVM address.
+
+For Solana-based networks, the asset will be a base58-encoded Solana address.
+   * @pattern ^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  asset: string;
+  /** The optional additional scheme-specific payment info. */
+  extra?: X402PaymentRequirementsExtra;
+}
+
+/**
+ * Communication protocol (e.g., "http", "mcp").
+ */
+export type X402DiscoveryResourceType =
+  (typeof X402DiscoveryResourceType)[keyof typeof X402DiscoveryResourceType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const X402DiscoveryResourceType = {
+  http: "http",
+} as const;
+
+/**
+ * Additional metadata as a JSON object.
+ */
+export type X402DiscoveryResourceMetadata = { [key: string]: unknown };
+
+/**
+ * A single discovered x402 resource.
+ */
+export interface X402DiscoveryResource {
+  /** The normalized resource identifier. */
+  resource: string;
+  /** Communication protocol (e.g., "http", "mcp"). */
+  type: X402DiscoveryResourceType;
+  x402Version: X402Version;
+  /** Payment requirements as an array of JSON objects. */
+  accepts?: X402PaymentRequirements[];
+  /** Timestamp of the last update. */
+  lastUpdated: string;
+  /** Additional metadata as a JSON object. */
+  metadata?: X402DiscoveryResourceMetadata;
+}
+
+/**
+ * Pagination information for the response.
+ */
+export type X402DiscoveryResourcesResponsePagination = {
+  /** The number of discovered x402 resources to return per page. */
+  limit?: number;
+  /** The offset of the first discovered x402 resource to return. */
+  offset?: number;
+  /** The total number of discovered x402 resources. */
+  total?: number;
+};
+
+/**
+ * Response containing discovered x402 resources.
+ */
+export interface X402DiscoveryResourcesResponse {
+  x402Version: X402Version;
+  /** List of discovered x402 resources. */
+  items: X402DiscoveryResource[];
+  /** Pagination information for the response. */
+  pagination: X402DiscoveryResourcesResponsePagination;
+}
+
 /**
  * The action of the payment method.
  */
@@ -1728,6 +1925,110 @@ export interface Transfer {
   transactionHash?: string;
 }
 
+/**
+ * The type of payment method to be used to complete the order.
+ */
+export type OnrampPaymentMethodTypeId =
+  (typeof OnrampPaymentMethodTypeId)[keyof typeof OnrampPaymentMethodTypeId];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OnrampPaymentMethodTypeId = {
+  GUEST_CHECKOUT_APPLE_PAY: "GUEST_CHECKOUT_APPLE_PAY",
+} as const;
+
+/**
+ * The type of fee.
+ */
+export type OnrampOrderFeeType = (typeof OnrampOrderFeeType)[keyof typeof OnrampOrderFeeType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OnrampOrderFeeType = {
+  FEE_TYPE_NETWORK: "FEE_TYPE_NETWORK",
+  FEE_TYPE_EXCHANGE: "FEE_TYPE_EXCHANGE",
+} as const;
+
+/**
+ * A fee associated with an order.
+ */
+export interface OnrampOrderFee {
+  /** The type of fee. */
+  type: OnrampOrderFeeType;
+  /** The amount of the fee. */
+  amount: string;
+  /** The currency of the fee. */
+  currency: string;
+}
+
+/**
+ * The status of an onramp order.
+ */
+export type OnrampOrderStatus = (typeof OnrampOrderStatus)[keyof typeof OnrampOrderStatus];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OnrampOrderStatus = {
+  ONRAMP_ORDER_STATUS_PENDING_AUTH: "ONRAMP_ORDER_STATUS_PENDING_AUTH",
+  ONRAMP_ORDER_STATUS_PENDING_PAYMENT: "ONRAMP_ORDER_STATUS_PENDING_PAYMENT",
+  ONRAMP_ORDER_STATUS_PROCESSING: "ONRAMP_ORDER_STATUS_PROCESSING",
+  ONRAMP_ORDER_STATUS_COMPLETED: "ONRAMP_ORDER_STATUS_COMPLETED",
+  ONRAMP_ORDER_STATUS_FAILED: "ONRAMP_ORDER_STATUS_FAILED",
+} as const;
+
+/**
+ * An Onramp order.
+ */
+export interface OnrampOrder {
+  /** The ID of the onramp order. */
+  orderId: string;
+  /** The total amount of fiat to be paid. */
+  paymentTotal: string;
+  /** The amount of fiat to be converted to crypto. */
+  paymentSubtotal: unknown;
+  /** The fiat currency to be converted to crypto. */
+  paymentCurrency: string;
+  paymentMethod: OnrampPaymentMethodTypeId;
+  /** The amount of crypto to be purchased. */
+  purchaseAmount: string;
+  /** The crypto currency to be purchased. */
+  purchaseCurrency: string;
+  /** The fees associated with the order. */
+  fees: OnrampOrderFee[];
+  /** The exchange rate used to convert fiat to crypto. */
+  exchangeRate: string;
+  /** The destination address to send the crypto to. */
+  destinationAddress: string;
+  /** The network to send the crypto on. */
+  destinationNetwork: string;
+  status: OnrampOrderStatus;
+  /** The transaction hash of the order (only available once crypto has been sent). */
+  txHash?: string;
+  /** The date and time the order was created. */
+  createdAt: string;
+  /** The date and time the order was last updated. */
+  updatedAt: string;
+}
+
+/**
+ * The type of payment link.
+ */
+export type OnrampPaymentLinkType =
+  (typeof OnrampPaymentLinkType)[keyof typeof OnrampPaymentLinkType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OnrampPaymentLinkType = {
+  PAYMENT_LINK_TYPE_APPLE_PAY_BUTTON: "PAYMENT_LINK_TYPE_APPLE_PAY_BUTTON",
+} as const;
+
+/**
+ * A payment link to pay for an order.
+
+Please refer to the [Onramp docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/onramp-overview) for details on how to integrate with the different payment link types.
+ */
+export interface OnrampPaymentLink {
+  /** The URL to the hosted widget the user should be redirected to, append your own redirect_url query parameter to  this URL to ensure the user is redirected back to your app after the widget completes. */
+  url: string;
+  paymentLinkType: OnrampPaymentLinkType;
+}
+
 /**
  * Internal server error.
  */
@@ -1758,6 +2059,16 @@ export type IdempotencyErrorResponse = Error;
  */
 export type AlreadyExistsErrorResponse = Error;
 
+/**
+ * Unauthorized.
+ */
+export type UnauthorizedErrorResponse = Error;
+
+/**
+ * Rate limit exceeded.
+ */
+export type RateLimitExceededResponse = Error;
+
 /**
  * A JWT signed using your Wallet Secret, encoded in base64. Refer to the
 [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
@@ -2321,6 +2632,22 @@ export type ListSolanaTokenBalances200AllOf = {
 
 export type ListSolanaTokenBalances200 = ListSolanaTokenBalances200AllOf & ListResponse;
 
+export type ListX402DiscoveryResourcesParams = {
+  /**
+ * Filter by protocol type (e.g., "http", "mcp").
+Currently, the only supported protocol type is "http".
+ */
+  type?: string;
+  /**
+   * The number of discovered x402 resources to return per page.
+   */
+  limit?: number;
+  /**
+   * The offset of the first discovered x402 resource to return.
+   */
+  offset?: number;
+};
+
 export type GetCryptoRailsParams = {
   /**
    * Comma separated list of networks to filter the rails by.
@@ -2368,3 +2695,50 @@ export type CreatePaymentTransferQuoteBody = {
 export type CreatePaymentTransferQuote201 = {
   transfer: Transfer;
 };
+
+export type CreateOnrampOrderBody = {
+  /** The timestamp of the time the user acknowledged they are accepting the Coinbase service agreement  (https://www.coinbase.com/legal/guest-checkout/us) by using Coinbase Onramp. */
+  agreementAcceptedAt: string;
+  /** The address the purchased crypto will be sent to. */
+  destinationAddress: string;
+  /** The name of the crypto network the purchased currency will be sent on.
+
+Use the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported networks for your user's location. */
+  destinationNetwork: string;
+  /** The email address of the user requesting the onramp transaction. */
+  email: string;
+  /** If true, this API will return a quote without creating any transaction. */
+  isQuote?: boolean;
+  /** Optional partner order reference ID. */
+  partnerOrderRef?: string;
+  /** A unique string that represents the user in your app. This can be used to link individual transactions  together so you can retrieve the transaction history for your users. Prefix this string with “sandbox-”  to perform a sandbox transaction which will allow you to test your integration without any real transfer  of funds.
+
+This value can be used with with [Onramp User Transactions API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-onramp-transactions-by-id) to retrieve all transactions created by the user. */
+  partnerUserRef: string;
+  /** A string representing the amount of fiat the user wishes to pay in exchange for crypto. When using  this parameter, the returned quote will be inclusive of fees i.e. the user will pay this exact amount  of the payment currency. */
+  paymentAmount?: string;
+  /** The fiat currency to be converted to crypto. */
+  paymentCurrency: string;
+  paymentMethod: OnrampPaymentMethodTypeId;
+  /** The phone number of the user requesting the onramp transaction in E.164 format. This phone number must  be verified by your app (via OTP) before being used with the Onramp API.
+
+Please refer to the [Onramp docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/onramp-overview) for more details on phone number verification requirements and best practices. */
+  phoneNumber: string;
+  /** Timestamp of when the user's phone number was verified via OTP. User phone number must be verified  every 60 days. If this timestamp is older than 60 days, an error will be returned. */
+  phoneNumberVerifiedAt: string;
+  /** A string representing the amount of fiat the user wishes to pay in exchange for crypto. When using  this parameter the returned quote will be exclusive of fees i.e. the user will receive this exact  amount of the purchase currency. */
+  purchaseAmount?: string;
+  /** The ticker (e.g. `BTC`, `USDC`) or the UUID (e.g. `d85dce9b-5b73-5c3c-8978-522ce1d1c1b4`) of crypto  asset to be purchased.
+
+Use the [Onramp Buy Options API](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options) to discover the supported purchase currencies for your user's location. */
+  purchaseCurrency: string;
+};
+
+export type CreateOnrampOrder201 = {
+  order: OnrampOrder;
+  paymentLink?: OnrampPaymentLink;
+};
+
+export type GetOnrampOrderById200 = {
+  order: OnrampOrder;
+};

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

@@ -192,6 +192,15 @@ export const getPrepareUserOperationResponseMock = (
     faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
     undefined,
   ]),
+  receipts: faker.helpers.arrayElement([
+    Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+      revert: faker.helpers.arrayElement([
+        { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
+        undefined,
+      ]),
+    })),
+    undefined,
+  ]),
   ...overrideResponse,
 });
 
@@ -217,6 +226,15 @@ export const getGetUserOperationResponseMock = (
     faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
     undefined,
   ]),
+  receipts: faker.helpers.arrayElement([
+    Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+      revert: faker.helpers.arrayElement([
+        { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
+        undefined,
+      ]),
+    })),
+    undefined,
+  ]),
   ...overrideResponse,
 });
 
@@ -242,6 +260,49 @@ export const getSendUserOperationResponseMock = (
     faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
     undefined,
   ]),
+  receipts: faker.helpers.arrayElement([
+    Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+      revert: faker.helpers.arrayElement([
+        { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
+        undefined,
+      ]),
+    })),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getCreateSpendPermissionResponseMock = (
+  overrideResponse: Partial<EvmUserOperation> = {},
+): EvmUserOperation => ({
+  network: faker.helpers.arrayElement(Object.values(EvmUserOperationNetwork)),
+  userOpHash: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$"),
+  calls: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+    to: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+    value: faker.string.alpha(20),
+    data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"),
+  })),
+  status: faker.helpers.arrayElement([
+    "pending",
+    "signed",
+    "broadcast",
+    "complete",
+    "dropped",
+    "failed",
+  ] as const),
+  transactionHash: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+    undefined,
+  ]),
+  receipts: faker.helpers.arrayElement([
+    Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+      revert: faker.helpers.arrayElement([
+        { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
+        undefined,
+      ]),
+    })),
+    undefined,
+  ]),
   ...overrideResponse,
 });
 
@@ -431,6 +492,29 @@ export const getSendUserOperationMockHandler = (
     },
   );
 };
+
+export const getCreateSpendPermissionMockHandler = (
+  overrideResponse?:
+    | EvmUserOperation
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<EvmUserOperation> | EvmUserOperation),
+) => {
+  return http.post("*/v2/evm/smart-accounts/:address/spend-permissions", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getCreateSpendPermissionResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
 export const getEvmSmartAccountsMock = () => [
   getListEvmSmartAccountsMockHandler(),
   getCreateEvmSmartAccountMockHandler(),
@@ -440,4 +524,5 @@ export const getEvmSmartAccountsMock = () => [
   getPrepareUserOperationMockHandler(),
   getGetUserOperationMockHandler(),
   getSendUserOperationMockHandler(),
+  getCreateSpendPermissionMockHandler(),
 ];

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

@@ -7,6 +7,7 @@
  */
 import type {
   CreateEvmSmartAccountBody,
+  CreateSpendPermissionRequest,
   EvmSmartAccount,
   EvmUserOperation,
   ListEvmSmartAccounts200,
@@ -153,6 +154,25 @@ export const sendUserOperation = (
     options,
   );
 };
+/**
+ * Creates a spend permission for the given smart account address.
+ * @summary Create a spend permission
+ */
+export const createSpendPermission = (
+  address: string,
+  createSpendPermissionRequest: CreateSpendPermissionRequest,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmUserOperation>(
+    {
+      url: `/v2/evm/smart-accounts/${address}/spend-permissions`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createSpendPermissionRequest,
+    },
+    options,
+  );
+};
 export type ListEvmSmartAccountsResult = NonNullable<
   Awaited<ReturnType<typeof listEvmSmartAccounts>>
 >;
@@ -171,3 +191,6 @@ export type PrepareUserOperationResult = NonNullable<
 >;
 export type GetUserOperationResult = NonNullable<Awaited<ReturnType<typeof getUserOperation>>>;
 export type SendUserOperationResult = NonNullable<Awaited<ReturnType<typeof sendUserOperation>>>;
+export type CreateSpendPermissionResult = NonNullable<
+  Awaited<ReturnType<typeof createSpendPermission>>
+>;

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

@@ -3,7 +3,9 @@ export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";
 export * from "./evm-swaps/evm-swaps.msw.js";
 export * from "./evm-token-balances/evm-token-balances.msw.js";
 export * from "./faucets/faucets.msw.js";
+export * from "./onramp/onramp.msw.js";
 export * from "./payments-alpha/payments-alpha.msw.js";
 export * from "./policy-engine/policy-engine.msw.js";
 export * from "./solana-accounts/solana-accounts.msw.js";
 export * from "./solana-token-balances/solana-token-balances.msw.js";
+export * from "./x402-facilitator/x402-facilitator.msw.js";