@coinbase/cdp-sdk 1.11.0 → 1.13.0

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 "./evm-accounts/evm-accounts.msw.js";
+export * from "./evm-token-balances/evm-token-balances.msw.js";
 export * from "./policy-engine/policy-engine.msw.js";
 export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";
+export * from "./evm-swaps/evm-swaps.msw.js";
+export * from "./solana-accounts/solana-accounts.msw.js";
+export * from "./payments-alpha/payments-alpha.msw.js";

package/openapi-client/generated/policy-engine/policy-engine.msw.ts

@@ -12,6 +12,7 @@ import { HttpResponse, delay, http } from "msw";
 import type {
   EthValueCriterion,
   EvmAddressCriterion,
+  EvmMessageCriterion,
   EvmNetworkCriterion,
   ListPolicies200,
   Policy,
@@ -53,6 +54,13 @@ export const getListPoliciesResponseEvmNetworkCriterionMock = (
   ...overrideResponse,
 });
 
+export const getListPoliciesResponseEvmMessageCriterionMock = (
+  overrideResponse: Partial<EvmMessageCriterion> = {},
+): EvmMessageCriterion => ({
+  ...{ type: faker.helpers.arrayElement(["evmMessage"] as const), match: faker.string.alpha(20) },
+  ...overrideResponse,
+});
+
 export const getListPoliciesResponseSolAddressCriterionMock = (
   overrideResponse: Partial<SolAddressCriterion> = {},
 ): SolAddressCriterion => ({
@@ -108,6 +116,18 @@ export const getListPoliciesResponseMock = (): ListPolicies200 => ({
                   ]),
                 ),
               },
+              {
+                action: faker.helpers.arrayElement(["reject", "accept"] as const),
+                operation: faker.helpers.arrayElement(["signEvmMessage"] as const),
+                criteria: Array.from(
+                  { length: faker.number.int({ min: 1, max: 10 }) },
+                  (_, i) => i + 1,
+                ).map(() =>
+                  faker.helpers.arrayElement([
+                    { ...getListPoliciesResponseEvmMessageCriterionMock() },
+                  ]),
+                ),
+              },
               {
                 action: faker.helpers.arrayElement(["reject", "accept"] as const),
                 operation: faker.helpers.arrayElement(["signSolTransaction"] as const),
@@ -120,6 +140,10 @@ export const getListPoliciesResponseMock = (): ListPolicies200 => ({
                   ]),
                 ),
               },
+              {
+                action: faker.helpers.arrayElement(["reject", "accept"] as const),
+                operation: faker.helpers.arrayElement(["signEvmHash"] as const),
+              },
             ]),
         ),
         createdAt: faker.string.alpha(20),
@@ -165,6 +189,13 @@ export const getCreatePolicyResponseEvmNetworkCriterionMock = (
   ...overrideResponse,
 });
 
+export const getCreatePolicyResponseEvmMessageCriterionMock = (
+  overrideResponse: Partial<EvmMessageCriterion> = {},
+): EvmMessageCriterion => ({
+  ...{ type: faker.helpers.arrayElement(["evmMessage"] as const), match: faker.string.alpha(20) },
+  ...overrideResponse,
+});
+
 export const getCreatePolicyResponseSolAddressCriterionMock = (
   overrideResponse: Partial<SolAddressCriterion> = {},
 ): SolAddressCriterion => ({
@@ -216,6 +247,16 @@ export const getCreatePolicyResponseMock = (overrideResponse: Partial<Policy> =
           ]),
         ),
       },
+      {
+        action: faker.helpers.arrayElement(["reject", "accept"] as const),
+        operation: faker.helpers.arrayElement(["signEvmMessage"] as const),
+        criteria: Array.from(
+          { length: faker.number.int({ min: 1, max: 10 }) },
+          (_, i) => i + 1,
+        ).map(() =>
+          faker.helpers.arrayElement([{ ...getCreatePolicyResponseEvmMessageCriterionMock() }]),
+        ),
+      },
       {
         action: faker.helpers.arrayElement(["reject", "accept"] as const),
         operation: faker.helpers.arrayElement(["signSolTransaction"] as const),
@@ -226,6 +267,10 @@ export const getCreatePolicyResponseMock = (overrideResponse: Partial<Policy> =
           faker.helpers.arrayElement([{ ...getCreatePolicyResponseSolAddressCriterionMock() }]),
         ),
       },
+      {
+        action: faker.helpers.arrayElement(["reject", "accept"] as const),
+        operation: faker.helpers.arrayElement(["signEvmHash"] as const),
+      },
     ]),
   ),
   createdAt: faker.string.alpha(20),
@@ -268,6 +313,13 @@ export const getGetPolicyByIdResponseEvmNetworkCriterionMock = (
   ...overrideResponse,
 });
 
+export const getGetPolicyByIdResponseEvmMessageCriterionMock = (
+  overrideResponse: Partial<EvmMessageCriterion> = {},
+): EvmMessageCriterion => ({
+  ...{ type: faker.helpers.arrayElement(["evmMessage"] as const), match: faker.string.alpha(20) },
+  ...overrideResponse,
+});
+
 export const getGetPolicyByIdResponseSolAddressCriterionMock = (
   overrideResponse: Partial<SolAddressCriterion> = {},
 ): SolAddressCriterion => ({
@@ -319,6 +371,16 @@ export const getGetPolicyByIdResponseMock = (overrideResponse: Partial<Policy> =
           ]),
         ),
       },
+      {
+        action: faker.helpers.arrayElement(["reject", "accept"] as const),
+        operation: faker.helpers.arrayElement(["signEvmMessage"] as const),
+        criteria: Array.from(
+          { length: faker.number.int({ min: 1, max: 10 }) },
+          (_, i) => i + 1,
+        ).map(() =>
+          faker.helpers.arrayElement([{ ...getGetPolicyByIdResponseEvmMessageCriterionMock() }]),
+        ),
+      },
       {
         action: faker.helpers.arrayElement(["reject", "accept"] as const),
         operation: faker.helpers.arrayElement(["signSolTransaction"] as const),
@@ -329,6 +391,10 @@ export const getGetPolicyByIdResponseMock = (overrideResponse: Partial<Policy> =
           faker.helpers.arrayElement([{ ...getGetPolicyByIdResponseSolAddressCriterionMock() }]),
         ),
       },
+      {
+        action: faker.helpers.arrayElement(["reject", "accept"] as const),
+        operation: faker.helpers.arrayElement(["signEvmHash"] as const),
+      },
     ]),
   ),
   createdAt: faker.string.alpha(20),
@@ -371,6 +437,13 @@ export const getUpdatePolicyResponseEvmNetworkCriterionMock = (
   ...overrideResponse,
 });
 
+export const getUpdatePolicyResponseEvmMessageCriterionMock = (
+  overrideResponse: Partial<EvmMessageCriterion> = {},
+): EvmMessageCriterion => ({
+  ...{ type: faker.helpers.arrayElement(["evmMessage"] as const), match: faker.string.alpha(20) },
+  ...overrideResponse,
+});
+
 export const getUpdatePolicyResponseSolAddressCriterionMock = (
   overrideResponse: Partial<SolAddressCriterion> = {},
 ): SolAddressCriterion => ({
@@ -422,6 +495,16 @@ export const getUpdatePolicyResponseMock = (overrideResponse: Partial<Policy> =
           ]),
         ),
       },
+      {
+        action: faker.helpers.arrayElement(["reject", "accept"] as const),
+        operation: faker.helpers.arrayElement(["signEvmMessage"] as const),
+        criteria: Array.from(
+          { length: faker.number.int({ min: 1, max: 10 }) },
+          (_, i) => i + 1,
+        ).map(() =>
+          faker.helpers.arrayElement([{ ...getUpdatePolicyResponseEvmMessageCriterionMock() }]),
+        ),
+      },
       {
         action: faker.helpers.arrayElement(["reject", "accept"] as const),
         operation: faker.helpers.arrayElement(["signSolTransaction"] as const),
@@ -432,6 +515,10 @@ export const getUpdatePolicyResponseMock = (overrideResponse: Partial<Policy> =
           faker.helpers.arrayElement([{ ...getUpdatePolicyResponseSolAddressCriterionMock() }]),
         ),
       },
+      {
+        action: faker.helpers.arrayElement(["reject", "accept"] as const),
+        operation: faker.helpers.arrayElement(["signEvmHash"] as const),
+      },
     ]),
   ),
   createdAt: faker.string.alpha(20),

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.13.0",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/policies/schema.ts

@@ -107,6 +107,20 @@ export const EvmNetworkCriterionSchema = z.object({
 });
 export type EvmNetworkCriterion = z.infer<typeof EvmNetworkCriterionSchema>;
 
+/**
+ * Schema for EVM message criterions
+ */
+export const EvmMessageCriterionSchema = z.object({
+  /** The type of criterion, must be "evmMessage" for EVM message-based rules. */
+  type: z.literal("evmMessage"),
+  /**
+   * A regular expression the message is matched against.
+   * Accepts valid regular expression syntax described by [RE2](https://github.com/google/re2/wiki/Syntax).
+   */
+  match: z.string().min(1),
+});
+export type EvmMessageCriterion = z.infer<typeof EvmMessageCriterionSchema>;
+
 /**
  * Schema for Solana address criterions
  */
@@ -140,6 +154,19 @@ export const SignEvmTransactionCriteriaSchema = z
  */
 export type SignEvmTransactionCriteria = z.infer<typeof SignEvmTransactionCriteriaSchema>;
 
+/**
+ * Schema for criteria used in SignEvmMessage operations
+ */
+export const SignEvmMessageCriteriaSchema = z
+  .array(z.discriminatedUnion("type", [EvmMessageCriterionSchema]))
+  .max(10)
+  .min(1);
+/**
+ * Type representing a set of criteria for the signEvmMessage operation.
+ * Can contain up to 10 individual EVM message criterion objects.
+ */
+export type SignEvmMessageCriteria = z.infer<typeof SignEvmMessageCriteriaSchema>;
+
 /**
  * Schema for criteria used in SendEvmTransaction operations
  */
@@ -226,6 +253,47 @@ export const SignEvmTransactionRuleSchema = z.object({
 });
 export type SignEvmTransactionRule = z.infer<typeof SignEvmTransactionRuleSchema>;
 
+/**
+ * Type representing a 'signEvmHash' policy rule that can accept or reject specific operations
+ * based on a set of criteria.
+ */
+export const SignEvmHashRuleSchema = z.object({
+  /**
+   * Determines whether matching the rule will cause a request to be rejected or accepted.
+   * "accept" will allow the signing, "reject" will block it.
+   */
+  action: ActionEnum,
+  /**
+   * The operation to which this rule applies.
+   * Must be "signEvmHash".
+   */
+  operation: z.literal("signEvmHash"),
+});
+export type SignEvmHashRule = z.infer<typeof SignEvmHashRuleSchema>;
+
+/**
+ * Type representing a 'signEvmMessage' policy rule that can accept or reject specific operations
+ * based on a set of criteria.
+ */
+export const SignEvmMessageRuleSchema = z.object({
+  /**
+   * Determines whether matching the rule will cause a request to be rejected or accepted.
+   * "accept" will allow the signing, "reject" will block it.
+   */
+  action: ActionEnum,
+  /**
+   * The operation to which this rule applies.
+   * Must be "signEvmMessage".
+   */
+  operation: z.literal("signEvmMessage"),
+  /**
+   * The set of criteria that must be matched for this rule to apply.
+   * Must be compatible with the specified operation type.
+   */
+  criteria: SignEvmMessageCriteriaSchema,
+});
+export type SignEvmMessageRule = z.infer<typeof SignEvmMessageRuleSchema>;
+
 /**
  * Type representing a 'sendEvmTransaction' policy rule that can accept or reject specific operations
  * based on a set of criteria.
@@ -277,6 +345,8 @@ export type SignSolTransactionRule = z.infer<typeof SignSolTransactionRuleSchema
  */
 export const RuleSchema = z.discriminatedUnion("operation", [
   SignEvmTransactionRuleSchema,
+  SignEvmHashRuleSchema,
+  SignEvmMessageRuleSchema,
   SendEvmTransactionRuleSchema,
   SignSolTransactionRuleSchema,
 ]);

package/version.ts

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