@coinbase/cdp-sdk 1.33.0 → 1.34.1

package/openapi-client/generated/x402-facilitator/x402-facilitator.msw.ts

@@ -0,0 +1,136 @@
+/**
+ * Generated by orval v7.6.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 { faker } from "@faker-js/faker";
+
+import { HttpResponse, delay, http } from "msw";
+
+import {
+  X402SettleErrorReason,
+  X402VerifyInvalidReason,
+  X402Version,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+import type {
+  X402SettleResponseResponse,
+  X402SupportedPaymentKindsResponseResponse,
+  X402VerifyResponseResponse,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getVerifyX402PaymentResponseMock = (
+  overrideResponse: Partial<X402VerifyResponseResponse> = {},
+): X402VerifyResponseResponse => ({
+  isValid: faker.datatype.boolean(),
+  invalidReason: faker.helpers.arrayElement([
+    faker.helpers.arrayElement(Object.values(X402VerifyInvalidReason)),
+    undefined,
+  ]),
+  payer: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$"),
+  ...overrideResponse,
+});
+
+export const getSettleX402PaymentResponseMock = (
+  overrideResponse: Partial<X402SettleResponseResponse> = {},
+): X402SettleResponseResponse => ({
+  success: faker.datatype.boolean(),
+  errorReason: faker.helpers.arrayElement([
+    faker.helpers.arrayElement(Object.values(X402SettleErrorReason)),
+    undefined,
+  ]),
+  payer: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$"),
+  transaction: faker.helpers.fromRegExp(
+    "^0x[a-fA-F0-9]{40}|[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$",
+  ),
+  network: faker.string.alpha(20),
+  ...overrideResponse,
+});
+
+export const getSupportedX402PaymentKindsResponseMock = (
+  overrideResponse: Partial<X402SupportedPaymentKindsResponseResponse> = {},
+): X402SupportedPaymentKindsResponseResponse => ({
+  kinds: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+    x402Version: faker.helpers.arrayElement(Object.values(X402Version)),
+    scheme: faker.helpers.arrayElement(["exact"] as const),
+    network: faker.helpers.arrayElement(["base-sepolia", "base"] as const),
+  })),
+  ...overrideResponse,
+});
+
+export const getVerifyX402PaymentMockHandler = (
+  overrideResponse?:
+    | X402VerifyResponseResponse
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<X402VerifyResponseResponse> | X402VerifyResponseResponse),
+) => {
+  return http.post("*/v2/x402/verify", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getVerifyX402PaymentResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getSettleX402PaymentMockHandler = (
+  overrideResponse?:
+    | X402SettleResponseResponse
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<X402SettleResponseResponse> | X402SettleResponseResponse),
+) => {
+  return http.post("*/v2/x402/settle", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getSettleX402PaymentResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getSupportedX402PaymentKindsMockHandler = (
+  overrideResponse?:
+    | X402SupportedPaymentKindsResponseResponse
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) =>
+        | Promise<X402SupportedPaymentKindsResponseResponse>
+        | X402SupportedPaymentKindsResponseResponse),
+) => {
+  return http.get("*/v2/x402/supported", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getSupportedX402PaymentKindsResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getX402FacilitatorMock = () => [
+  getVerifyX402PaymentMockHandler(),
+  getSettleX402PaymentMockHandler(),
+  getSupportedX402PaymentKindsMockHandler(),
+];

package/openapi-client/generated/x402-facilitator/x402-facilitator.ts

@@ -0,0 +1,70 @@
+/**
+ * Generated by orval v7.6.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 {
+  SettleX402PaymentBody,
+  VerifyX402PaymentBody,
+  X402SettleResponseResponse,
+  X402SupportedPaymentKindsResponseResponse,
+  X402VerifyResponseResponse,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Verify an x402 protocol payment with a specific scheme and network.
+ * @summary Verify a payment
+ */
+export const verifyX402Payment = (
+  verifyX402PaymentBody: VerifyX402PaymentBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<X402VerifyResponseResponse>(
+    {
+      url: `/v2/x402/verify`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: verifyX402PaymentBody,
+    },
+    options,
+  );
+};
+/**
+ * Settle an x402 protocol payment with a specific scheme and network.
+ * @summary Settle a payment
+ */
+export const settleX402Payment = (
+  settleX402PaymentBody: SettleX402PaymentBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<X402SettleResponseResponse>(
+    {
+      url: `/v2/x402/settle`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: settleX402PaymentBody,
+    },
+    options,
+  );
+};
+/**
+ * Get the supported x402 protocol payment schemes and networks that the facilitator is able to verify and settle payments for.
+ * @summary Get supported payment schemes and networks
+ */
+export const supportedX402PaymentKinds = (options?: SecondParameter<typeof cdpApiClient>) => {
+  return cdpApiClient<X402SupportedPaymentKindsResponseResponse>(
+    { url: `/v2/x402/supported`, method: "GET" },
+    options,
+  );
+};
+export type VerifyX402PaymentResult = NonNullable<Awaited<ReturnType<typeof verifyX402Payment>>>;
+export type SettleX402PaymentResult = NonNullable<Awaited<ReturnType<typeof settleX402Payment>>>;
+export type SupportedX402PaymentKindsResult = NonNullable<
+  Awaited<ReturnType<typeof supportedX402PaymentKinds>>
+>;

package/openapi-client/index.ts

@@ -9,8 +9,12 @@ 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";
+export * from "./generated/x402-facilitator/x402-facilitator.js";
 
 import { configure } from "./cdpApiClient.js";
+import * as endUserAccounts from "./generated/end-user-accounts/end-user-accounts.js";
 import * as evm from "./generated/evm-accounts/evm-accounts.js";
 import * as evmSmartAccounts from "./generated/evm-smart-accounts/evm-smart-accounts.js";
 import * as evmSwaps from "./generated/evm-swaps/evm-swaps.js";
@@ -31,6 +35,7 @@ export const CdpOpenApiClient = {
   ...faucets,
   ...policies,
   ...payments,
+  ...endUserAccounts,
   configure,
 };
 

package/package.json

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

package/spend-permissions/types.ts

@@ -1,3 +1,4 @@
+import type { SpendPermissionNetwork } from "../openapi-client/index.js";
 import type { Address, Hex } from "../types/misc.js";
 
 /**
@@ -24,19 +25,48 @@ export type SpendPermission = {
   extraData: Hex;
 };
 
-/**
- * Networks that the SpendPermissionManager contract supports.
- * From https://github.com/coinbase/spend-permissions/blob/main/README.md#deployments
- */
-export type SpendPermissionNetworks =
-  | "base"
-  | "base-sepolia"
-  | "ethereum"
-  | "ethereum-sepolia"
-  | "optimism"
-  | "optimism-sepolia"
-  | "arbitrum"
-  | "avalanche"
-  | "binance"
-  | "polygon"
-  | "zora";
+export type SpendPermissionInput = Omit<
+  SpendPermission,
+  "token" | "salt" | "extraData" | "period" | "start" | "end"
+> & {
+  token: "eth" | "usdc" | Address;
+  salt?: bigint;
+  extraData?: Hex;
+  period?: number;
+  periodInDays?: number;
+  start?: Date;
+  end?: Date;
+};
+
+export interface CreateSpendPermissionOptions {
+  /** The spend permission. */
+  spendPermission: SpendPermissionInput;
+  /** The network. */
+  network: SpendPermissionNetwork;
+  /** The paymaster URL. */
+  paymasterUrl?: string;
+  /** The idempotency key. */
+  idempotencyKey?: string;
+}
+
+export interface ListSpendPermissionsOptions {
+  /** The address of the smart account. */
+  address: Address;
+  /** The page size to paginate through the spend permissions. */
+  pageSize?: number;
+  /** The page token to paginate through the spend permissions. */
+  pageToken?: string;
+}
+
+export interface RevokeSpendPermissionOptions {
+  /** The address of the smart account. */
+  address: Address;
+  /** The hash of the spend permission to revoke. */
+  permissionHash: Hex;
+  /** The network. */
+  network: SpendPermissionNetwork;
+  /** The paymaster URL. */
+  paymasterUrl?: string;
+  /** The idempotency key. */
+  idempotencyKey?: string;
+}

package/spend-permissions/utils.ts

@@ -0,0 +1,35 @@
+import { getErc20Address } from "../actions/evm/transfer/utils.js";
+import { UserInputValidationError } from "../errors.js";
+
+import type { Network } from "../actions/evm/transfer/types.js";
+import type { SpendPermissionNetwork } from "../openapi-client/index.js";
+import type { Address } from "../types/misc.js";
+
+/**
+ * Resolve the address of a token for a given network.
+ *
+ * @param token - The token symbol or contract address.
+ * @param network - The network to get the address for.
+ *
+ * @returns The address of the token.
+ */
+export function resolveTokenAddress(
+  token: "eth" | "usdc" | Address,
+  network: SpendPermissionNetwork,
+): Address {
+  if (token === "eth") {
+    return "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+  }
+
+  if (token === "usdc" && (network === "base" || network === "base-sepolia")) {
+    return getErc20Address(token, network as Network);
+  }
+
+  if (token === "usdc") {
+    throw new UserInputValidationError(
+      `Automatic token address lookup for ${token} is not supported on ${network}. Please provide the token address manually.`,
+    );
+  }
+
+  return token;
+}

package/version.ts

@@ -1 +1 @@
-export const version = "1.33.0";
+export const version = "1.34.1";