@coinbase/cdp-sdk 1.29.0 → 1.31.0

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

@@ -7,11 +7,15 @@
  */
 import type {
   CreateEvmSmartAccountBody,
+  CreateSpendPermissionRequest,
   EvmSmartAccount,
   EvmUserOperation,
   ListEvmSmartAccounts200,
   ListEvmSmartAccountsParams,
+  ListSpendPermissions200,
+  ListSpendPermissionsParams,
   PrepareUserOperationBody,
+  RevokeSpendPermissionRequest,
   SendUserOperationBody,
   UpdateEvmSmartAccountBody,
 } from "../coinbaseDeveloperPlatformAPIs.schemas.js";
@@ -153,6 +157,58 @@ 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,
+  );
+};
+/**
+ * Lists spend permission for the given smart account address.
+ * @summary List spend permissions
+ */
+export const listSpendPermissions = (
+  address: string,
+  params?: ListSpendPermissionsParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<ListSpendPermissions200>(
+    { url: `/v2/evm/smart-accounts/${address}/spend-permissions/list`, method: "GET", params },
+    options,
+  );
+};
+/**
+ * Revokes an existing spend permission.
+ * @summary Revoke a spend permission
+ */
+export const revokeSpendPermission = (
+  address: string,
+  revokeSpendPermissionRequest: RevokeSpendPermissionRequest,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmUserOperation>(
+    {
+      url: `/v2/evm/smart-accounts/${address}/spend-permissions/revoke`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: revokeSpendPermissionRequest,
+    },
+    options,
+  );
+};
 export type ListEvmSmartAccountsResult = NonNullable<
   Awaited<ReturnType<typeof listEvmSmartAccounts>>
 >;
@@ -171,3 +227,12 @@ 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>>
+>;
+export type ListSpendPermissionsResult = NonNullable<
+  Awaited<ReturnType<typeof listSpendPermissions>>
+>;
+export type RevokeSpendPermissionResult = NonNullable<
+  Awaited<ReturnType<typeof revokeSpendPermission>>
+>;

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

@@ -3,6 +3,7 @@ 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";

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

@@ -0,0 +1,135 @@
+/**
+ * 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 {
+  OnrampOrderStatus,
+  OnrampPaymentLinkType,
+  OnrampPaymentMethodTypeId,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+import type {
+  CreateOnrampOrder201,
+  GetOnrampOrderById200,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getCreateOnrampOrderResponseMock = (
+  overrideResponse: Partial<CreateOnrampOrder201> = {},
+): CreateOnrampOrder201 => ({
+  order: {
+    orderId: faker.string.alpha(20),
+    paymentTotal: faker.string.alpha(20),
+    paymentSubtotal: faker.string.alpha(20),
+    paymentCurrency: faker.string.alpha(20),
+    paymentMethod: faker.helpers.arrayElement(Object.values(OnrampPaymentMethodTypeId)),
+    purchaseAmount: faker.string.alpha(20),
+    purchaseCurrency: faker.string.alpha(20),
+    fees: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(
+      () => ({
+        type: faker.helpers.arrayElement(["FEE_TYPE_NETWORK", "FEE_TYPE_EXCHANGE"] as const),
+        amount: faker.string.alpha(20),
+        currency: faker.string.alpha(20),
+      }),
+    ),
+    exchangeRate: faker.string.alpha(20),
+    destinationAddress: faker.string.alpha(20),
+    destinationNetwork: faker.string.alpha(20),
+    status: faker.helpers.arrayElement(Object.values(OnrampOrderStatus)),
+    txHash: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+    createdAt: faker.string.alpha(20),
+    updatedAt: faker.string.alpha(20),
+  },
+  paymentLink: faker.helpers.arrayElement([
+    {
+      url: faker.string.alpha(20),
+      paymentLinkType: faker.helpers.arrayElement(Object.values(OnrampPaymentLinkType)),
+    },
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getGetOnrampOrderByIdResponseMock = (
+  overrideResponse: Partial<GetOnrampOrderById200> = {},
+): GetOnrampOrderById200 => ({
+  order: {
+    orderId: faker.string.alpha(20),
+    paymentTotal: faker.string.alpha(20),
+    paymentSubtotal: faker.string.alpha(20),
+    paymentCurrency: faker.string.alpha(20),
+    paymentMethod: faker.helpers.arrayElement(Object.values(OnrampPaymentMethodTypeId)),
+    purchaseAmount: faker.string.alpha(20),
+    purchaseCurrency: faker.string.alpha(20),
+    fees: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(
+      () => ({
+        type: faker.helpers.arrayElement(["FEE_TYPE_NETWORK", "FEE_TYPE_EXCHANGE"] as const),
+        amount: faker.string.alpha(20),
+        currency: faker.string.alpha(20),
+      }),
+    ),
+    exchangeRate: faker.string.alpha(20),
+    destinationAddress: faker.string.alpha(20),
+    destinationNetwork: faker.string.alpha(20),
+    status: faker.helpers.arrayElement(Object.values(OnrampOrderStatus)),
+    txHash: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+    createdAt: faker.string.alpha(20),
+    updatedAt: faker.string.alpha(20),
+  },
+  ...overrideResponse,
+});
+
+export const getCreateOnrampOrderMockHandler = (
+  overrideResponse?:
+    | CreateOnrampOrder201
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<CreateOnrampOrder201> | CreateOnrampOrder201),
+) => {
+  return http.post("*/v2/onramp/orders", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getCreateOnrampOrderResponseMock(),
+      ),
+      { status: 201, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getGetOnrampOrderByIdMockHandler = (
+  overrideResponse?:
+    | GetOnrampOrderById200
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<GetOnrampOrderById200> | GetOnrampOrderById200),
+) => {
+  return http.get("*/v2/onramp/orders/:orderId", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getGetOnrampOrderByIdResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getOnrampMock = () => [
+  getCreateOnrampOrderMockHandler(),
+  getGetOnrampOrderByIdMockHandler(),
+];

package/openapi-client/generated/onramp/onramp.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 {
+  CreateOnrampOrder201,
+  CreateOnrampOrderBody,
+  GetOnrampOrderById200,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Create a new Onramp order or get a quote for an Onramp order. Either `paymentAmount` or `purchaseAmount` must be provided.
+
+This API currently only supports the payment method `GUEST_CHECKOUT_APPLE_PAY`, and the `paymentLink` returned will only work in iOS apps. We do not support web integration via iframes at this time.
+
+For detailed integration instructions and to get access to this API, refer to the  [Apple Pay Onramp API docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/apple-pay-onramp-api).
+ * @summary Create an onramp order
+ */
+export const createOnrampOrder = (
+  createOnrampOrderBody: CreateOnrampOrderBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<CreateOnrampOrder201>(
+    {
+      url: `/v2/onramp/orders`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createOnrampOrderBody,
+    },
+    options,
+  );
+};
+/**
+ * Get an onramp order by ID.
+ * @summary Get an onramp order by ID
+ */
+export const getOnrampOrderById = (
+  orderId: string,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<GetOnrampOrderById200>(
+    { url: `/v2/onramp/orders/${orderId}`, method: "GET" },
+    options,
+  );
+};
+export type CreateOnrampOrderResult = NonNullable<Awaited<ReturnType<typeof createOnrampOrder>>>;
+export type GetOnrampOrderByIdResult = NonNullable<Awaited<ReturnType<typeof getOnrampOrderById>>>;

package/openapi-client/index.ts

@@ -8,6 +8,7 @@ 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";
 
 import { configure } from "./cdpApiClient.js";
 import * as evm from "./generated/evm-accounts/evm-accounts.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-sdk",
-  "version": "1.29.0",
+  "version": "1.31.0",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
@@ -22,6 +22,7 @@
     "@solana/web3.js": "^1.98.1",
     "abitype": "1.0.6",
     "axios": "^1.8.2",
+    "axios-retry": "^4.5.0",
     "jose": "^6.0.8",
     "md5": "^2.3.0",
     "uncrypto": "^0.1.3",