@coinbase/cdp-sdk 1.11.0 → 1.12.0

package/openapi-client/generated/evm-swaps/evm-swaps.msw.ts

@@ -0,0 +1,217 @@
+/**
+ * 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 type {
+  CreateSwapQuoteResponse,
+  CreateSwapQuoteResponseWrapper,
+  GetSwapPriceResponse,
+  GetSwapPriceResponseWrapper,
+  SwapUnavailableResponse,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getGetEvmSwapPriceResponseGetSwapPriceResponseMock = (
+  overrideResponse: Partial<GetSwapPriceResponse> = {},
+): GetSwapPriceResponse => ({
+  ...{
+    ...{
+      blockNumber: faker.helpers.fromRegExp("^[1-9]\d*$"),
+      toAmount: faker.helpers.fromRegExp("^(0|[1-9]\d*)$"),
+      toToken: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+      fees: {
+        gasFee: {
+          ...{
+            amount: faker.helpers.fromRegExp("^\d+$"),
+            token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+          },
+        },
+        protocolFee: {
+          ...{
+            amount: faker.helpers.fromRegExp("^\d+$"),
+            token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+          },
+        },
+      },
+      issues: {
+        allowance: {
+          currentAllowance: faker.helpers.fromRegExp("^\d+$"),
+          spender: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+        },
+        balance: {
+          token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+          currentBalance: faker.helpers.fromRegExp("^\d+$"),
+          requiredBalance: faker.helpers.fromRegExp("^\d+$"),
+        },
+        simulationIncomplete: faker.datatype.boolean(),
+      },
+      liquidityAvailable: faker.datatype.boolean(),
+      minToAmount: faker.helpers.fromRegExp("^(0|[1-9]\d*)$"),
+      fromAmount: faker.helpers.fromRegExp("^(0|[1-9]\d*)$"),
+      fromToken: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+    },
+    ...{
+      gas: faker.helpers.arrayElement([faker.helpers.fromRegExp("^\d+$"), null]),
+      gasPrice: faker.helpers.fromRegExp("^\d+$"),
+    },
+  },
+  ...overrideResponse,
+});
+
+export const getGetEvmSwapPriceResponseSwapUnavailableResponseMock = (
+  overrideResponse: Partial<SwapUnavailableResponse> = {},
+): SwapUnavailableResponse => ({
+  ...{ liquidityAvailable: faker.datatype.boolean() },
+  ...overrideResponse,
+});
+
+export const getGetEvmSwapPriceResponseMock = (): GetSwapPriceResponseWrapper =>
+  faker.helpers.arrayElement([
+    { ...getGetEvmSwapPriceResponseGetSwapPriceResponseMock() },
+    { ...getGetEvmSwapPriceResponseSwapUnavailableResponseMock() },
+  ]);
+
+export const getCreateEvmSwapQuoteResponseCreateSwapQuoteResponseMock = (
+  overrideResponse: Partial<CreateSwapQuoteResponse> = {},
+): CreateSwapQuoteResponse => ({
+  ...{
+    ...{
+      permit2: {
+        hash: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+        eip712: {
+          domain: {
+            name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+            version: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+            chainId: faker.helpers.arrayElement([
+              faker.number.int({ min: undefined, max: undefined }),
+              undefined,
+            ]),
+            verifyingContract: faker.helpers.arrayElement([
+              faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+              undefined,
+            ]),
+            salt: faker.helpers.arrayElement([
+              faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+              undefined,
+            ]),
+          },
+          types: {},
+          primaryType: faker.string.alpha(20),
+          message: {},
+        },
+      },
+      transaction: {
+        to: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+        data: faker.string.alpha(20),
+        gas: faker.helpers.fromRegExp("^\d+$"),
+        gasPrice: faker.helpers.fromRegExp("^\d+$"),
+        value: faker.helpers.fromRegExp("^\d+$"),
+      },
+    },
+    ...{
+      blockNumber: faker.helpers.fromRegExp("^[1-9]\d*$"),
+      toAmount: faker.helpers.fromRegExp("^(0|[1-9]\d*)$"),
+      toToken: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+      fees: {
+        gasFee: {
+          ...{
+            amount: faker.helpers.fromRegExp("^\d+$"),
+            token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+          },
+        },
+        protocolFee: {
+          ...{
+            amount: faker.helpers.fromRegExp("^\d+$"),
+            token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+          },
+        },
+      },
+      issues: {
+        allowance: {
+          currentAllowance: faker.helpers.fromRegExp("^\d+$"),
+          spender: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+        },
+        balance: {
+          token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+          currentBalance: faker.helpers.fromRegExp("^\d+$"),
+          requiredBalance: faker.helpers.fromRegExp("^\d+$"),
+        },
+        simulationIncomplete: faker.datatype.boolean(),
+      },
+      liquidityAvailable: faker.datatype.boolean(),
+      minToAmount: faker.helpers.fromRegExp("^(0|[1-9]\d*)$"),
+      fromAmount: faker.helpers.fromRegExp("^(0|[1-9]\d*)$"),
+      fromToken: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+    },
+  },
+  ...overrideResponse,
+});
+
+export const getCreateEvmSwapQuoteResponseSwapUnavailableResponseMock = (
+  overrideResponse: Partial<SwapUnavailableResponse> = {},
+): SwapUnavailableResponse => ({
+  ...{ liquidityAvailable: faker.datatype.boolean() },
+  ...overrideResponse,
+});
+
+export const getCreateEvmSwapQuoteResponseMock = (): CreateSwapQuoteResponseWrapper =>
+  faker.helpers.arrayElement([
+    { ...getCreateEvmSwapQuoteResponseCreateSwapQuoteResponseMock() },
+    { ...getCreateEvmSwapQuoteResponseSwapUnavailableResponseMock() },
+  ]);
+
+export const getGetEvmSwapPriceMockHandler = (
+  overrideResponse?:
+    | GetSwapPriceResponseWrapper
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<GetSwapPriceResponseWrapper> | GetSwapPriceResponseWrapper),
+) => {
+  return http.get("*/v2/evm/swaps/quote", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getGetEvmSwapPriceResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getCreateEvmSwapQuoteMockHandler = (
+  overrideResponse?:
+    | CreateSwapQuoteResponseWrapper
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<CreateSwapQuoteResponseWrapper> | CreateSwapQuoteResponseWrapper),
+) => {
+  return http.post("*/v2/evm/swaps", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getCreateEvmSwapQuoteResponseMock(),
+      ),
+      { status: 201, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getEvmSwapsMock = () => [
+  getGetEvmSwapPriceMockHandler(),
+  getCreateEvmSwapQuoteMockHandler(),
+];

package/openapi-client/generated/evm-swaps/evm-swaps.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 {
+  CreateEvmSwapQuoteBody,
+  CreateSwapQuoteResponseWrapper,
+  GetEvmSwapPriceParams,
+  GetSwapPriceResponseWrapper,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Get a price estimate for a swap between two tokens on an EVM network.
+ * @summary Get a price estimate for a swap
+ */
+export const getEvmSwapPrice = (
+  params: GetEvmSwapPriceParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<GetSwapPriceResponseWrapper>(
+    { url: `/v2/evm/swaps/quote`, method: "GET", params },
+    options,
+  );
+};
+/**
+ * Create a swap quote, which includes the payload to sign as well as the transaction data needed to execute the swap. The developer is responsible for signing the payload and submitting the transaction to the network in order to execute the swap.
+ * @summary Create a swap quote
+ */
+export const createEvmSwapQuote = (
+  createEvmSwapQuoteBody: CreateEvmSwapQuoteBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<CreateSwapQuoteResponseWrapper>(
+    {
+      url: `/v2/evm/swaps`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createEvmSwapQuoteBody,
+    },
+    options,
+  );
+};
+export type GetEvmSwapPriceResult = NonNullable<Awaited<ReturnType<typeof getEvmSwapPrice>>>;
+export type CreateEvmSwapQuoteResult = NonNullable<Awaited<ReturnType<typeof createEvmSwapQuote>>>;

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

@@ -1,7 +1,8 @@
-export * from "./evm-token-balances/evm-token-balances.msw.js";
-export * from "./evm-accounts/evm-accounts.msw.js";
-export * from "./faucets/faucets.msw.js";
-export * from "./solana-accounts/solana-accounts.msw.js";
 export * from "./payments-alpha/payments-alpha.msw.js";
+export * from "./solana-accounts/solana-accounts.msw.js";
+export * from "./evm-token-balances/evm-token-balances.msw.js";
 export * from "./policy-engine/policy-engine.msw.js";
+export * from "./evm-accounts/evm-accounts.msw.js";
 export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";
+export * from "./evm-swaps/evm-swaps.msw.js";
+export * from "./faucets/faucets.msw.js";

package/openapi-client/index.ts

@@ -1,6 +1,7 @@
 export * from "./generated/coinbaseDeveloperPlatformAPIs.schemas.js";
 export * from "./generated/evm-accounts/evm-accounts.js";
 export * from "./generated/evm-smart-accounts/evm-smart-accounts.js";
+export * from "./generated/evm-swaps/evm-swaps.js";
 export * from "./generated/evm-token-balances/evm-token-balances.js";
 export * from "./generated/solana-accounts/solana-accounts.js";
 export * from "./generated/faucets/faucets.js";
@@ -10,6 +11,7 @@ export * from "./generated/payments-alpha/payments-alpha.js";
 import { configure } from "./cdpApiClient.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";
 import * as evmTokenBalances from "./generated/evm-token-balances/evm-token-balances.js";
 import * as faucets from "./generated/faucets/faucets.js";
 import * as payments from "./generated/payments-alpha/payments-alpha.js";
@@ -19,6 +21,7 @@ import * as solana from "./generated/solana-accounts/solana-accounts.js";
 export const CdpOpenApiClient = {
   ...evm,
   ...evmSmartAccounts,
+  ...evmSwaps,
   ...evmTokenBalances,
   ...solana,
   ...faucets,
@@ -30,6 +33,7 @@ export const CdpOpenApiClient = {
 export const OpenApiEvmMethods = {
   ...evm,
   ...evmSmartAccounts,
+  ...evmSwaps,
   ...evmTokenBalances,
   requestEvmFaucet: faucets.requestEvmFaucet,
 };

package/package.json

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

package/version.ts

@@ -1 +1 @@
-export const version = "1.11.0";
+export const version = "1.12.0";