@coinbase/cdp-sdk 1.32.0 → 1.34.0

package/openapi-client/generated/onchain-data/onchain-data.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 {
+  AccountTokenAddressesResponse,
+  ListDataTokenBalances200,
+  ListDataTokenBalancesParams,
+  ListEvmTokenBalancesNetwork,
+  OnchainDataQuery,
+  OnchainDataResult,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Run a read-only SQL query against indexed blockchain data including transactions, events, and decoded logs.
+
+This endpoint provides direct SQL access to comprehensive blockchain data across supported networks.
+Queries are executed against optimized data structures for high-performance analytics.
+
+### Allowed Queries
+
+  - Standard SQL syntax (ClickHouse dialect)
+  - Read-only queries (SELECT statements)
+  - No DDL or DML operations
+  - No cartesian products
+
+### Supported Tables
+
+  - `base.events` - Base mainnet decoded event logs with parameters, event signature, topics, and more.
+  - `base.transactions` - Base mainnet transaction data including hash, block number, gas usage.
+  - `base.blocks` - Base mainnet block information.
+  - `base.encoded_logs` - Encoded log data of event logs that aren't able to be decoded by our event decoder (ex: log0 opcode).
+  - `base.transfers` - All event logs with event signature `Transfer(address,address,uint256)`. ERC-20, ERC-721, and ERC-1155 transfers are all included.
+
+### Query Limits
+
+  - Maximum result set: 10,000 rows
+  - Query timeout: 30 seconds
+  - Maximum JOINs: 5
+
+ * @summary Run SQL Query
+ */
+export const runSQLQuery = (
+  onchainDataQuery: OnchainDataQuery,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<OnchainDataResult>(
+    {
+      url: `/v2/data/query/run`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: onchainDataQuery,
+    },
+    options,
+  );
+};
+/**
+ * Retrieve all ERC-20 token contract addresses that an account has ever received tokens from. 
+Analyzes transaction history to discover token interactions.
+
+ * @summary List token addresses for account
+ */
+export const listTokensForAccount = (
+  network: "base" | "base-sepolia",
+  address: string,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<AccountTokenAddressesResponse>(
+    { url: `/v2/data/evm/token-ownership/${network}/${address}`, method: "GET" },
+    options,
+  );
+};
+/**
+ * Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page.
+
+**Note:** This endpoint provides <1 second freshness from chain tip, <500ms response latency for wallets with reasonable token history, and 99.9% uptime for production use.
+ * @summary List EVM token balances
+ */
+export const listDataTokenBalances = (
+  network: ListEvmTokenBalancesNetwork,
+  address: string,
+  params?: ListDataTokenBalancesParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<ListDataTokenBalances200>(
+    { url: `/v2/data/evm/token-balances/${network}/${address}`, method: "GET", params },
+    options,
+  );
+};
+export type RunSQLQueryResult = NonNullable<Awaited<ReturnType<typeof runSQLQuery>>>;
+export type ListTokensForAccountResult = NonNullable<
+  Awaited<ReturnType<typeof listTokensForAccount>>
+>;
+export type ListDataTokenBalancesResult = NonNullable<
+  Awaited<ReturnType<typeof listDataTokenBalances>>
+>;

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

@@ -25,6 +25,7 @@ import type {
   EvmTypedStringCondition,
   ListPolicies200,
   MintAddressCriterion,
+  NetUSDChangeCriterion,
   Policy,
   SignEvmTypedDataFieldCriterion,
   SignEvmTypedDataVerifyingContractCriterion,
@@ -163,12 +164,34 @@ export const getListPoliciesResponseEvmDataCriterionMock = (
   ...overrideResponse,
 });
 
+export const getListPoliciesResponseNetUSDChangeCriterionMock = (
+  overrideResponse: Partial<NetUSDChangeCriterion> = {},
+): NetUSDChangeCriterion => ({
+  ...{
+    type: faker.helpers.arrayElement(["netUSDChange"] as const),
+    changeCents: faker.number.int({ min: undefined, max: undefined }),
+    operator: faker.helpers.arrayElement([">", ">=", "<", "<=", "=="] as const),
+  },
+  ...overrideResponse,
+});
+
 export const getListPoliciesResponseEvmNetworkCriterionMock = (
   overrideResponse: Partial<EvmNetworkCriterion> = {},
 ): EvmNetworkCriterion => ({
   ...{
     type: faker.helpers.arrayElement(["evmNetwork"] as const),
-    networks: faker.helpers.arrayElements(["base-sepolia", "base"] as const),
+    networks: faker.helpers.arrayElements([
+      "base-sepolia",
+      "base",
+      "ethereum",
+      "ethereum-sepolia",
+      "avalanche",
+      "polygon",
+      "optimism",
+      "arbitrum",
+      "zora",
+      "bnb",
+    ] as const),
     operator: faker.helpers.arrayElement(["in", "not in"] as const),
   },
   ...overrideResponse,
@@ -341,6 +364,7 @@ export const getListPoliciesResponseMock = (): ListPolicies200 => ({
                     { ...getListPoliciesResponseEthValueCriterionMock() },
                     { ...getListPoliciesResponseEvmAddressCriterionMock() },
                     { ...getListPoliciesResponseEvmDataCriterionMock() },
+                    { ...getListPoliciesResponseNetUSDChangeCriterionMock() },
                   ]),
                 ),
               },
@@ -356,6 +380,7 @@ export const getListPoliciesResponseMock = (): ListPolicies200 => ({
                     { ...getListPoliciesResponseEvmAddressCriterionMock() },
                     { ...getListPoliciesResponseEvmNetworkCriterionMock() },
                     { ...getListPoliciesResponseEvmDataCriterionMock() },
+                    { ...getListPoliciesResponseNetUSDChangeCriterionMock() },
                   ]),
                 ),
               },
@@ -588,12 +613,34 @@ export const getCreatePolicyResponseEvmDataCriterionMock = (
   ...overrideResponse,
 });
 
+export const getCreatePolicyResponseNetUSDChangeCriterionMock = (
+  overrideResponse: Partial<NetUSDChangeCriterion> = {},
+): NetUSDChangeCriterion => ({
+  ...{
+    type: faker.helpers.arrayElement(["netUSDChange"] as const),
+    changeCents: faker.number.int({ min: undefined, max: undefined }),
+    operator: faker.helpers.arrayElement([">", ">=", "<", "<=", "=="] as const),
+  },
+  ...overrideResponse,
+});
+
 export const getCreatePolicyResponseEvmNetworkCriterionMock = (
   overrideResponse: Partial<EvmNetworkCriterion> = {},
 ): EvmNetworkCriterion => ({
   ...{
     type: faker.helpers.arrayElement(["evmNetwork"] as const),
-    networks: faker.helpers.arrayElements(["base-sepolia", "base"] as const),
+    networks: faker.helpers.arrayElements([
+      "base-sepolia",
+      "base",
+      "ethereum",
+      "ethereum-sepolia",
+      "avalanche",
+      "polygon",
+      "optimism",
+      "arbitrum",
+      "zora",
+      "bnb",
+    ] as const),
     operator: faker.helpers.arrayElement(["in", "not in"] as const),
   },
   ...overrideResponse,
@@ -762,6 +809,7 @@ export const getCreatePolicyResponseMock = (overrideResponse: Partial<Policy> =
             { ...getCreatePolicyResponseEthValueCriterionMock() },
             { ...getCreatePolicyResponseEvmAddressCriterionMock() },
             { ...getCreatePolicyResponseEvmDataCriterionMock() },
+            { ...getCreatePolicyResponseNetUSDChangeCriterionMock() },
           ]),
         ),
       },
@@ -777,6 +825,7 @@ export const getCreatePolicyResponseMock = (overrideResponse: Partial<Policy> =
             { ...getCreatePolicyResponseEvmAddressCriterionMock() },
             { ...getCreatePolicyResponseEvmNetworkCriterionMock() },
             { ...getCreatePolicyResponseEvmDataCriterionMock() },
+            { ...getCreatePolicyResponseNetUSDChangeCriterionMock() },
           ]),
         ),
       },
@@ -1004,12 +1053,34 @@ export const getGetPolicyByIdResponseEvmDataCriterionMock = (
   ...overrideResponse,
 });
 
+export const getGetPolicyByIdResponseNetUSDChangeCriterionMock = (
+  overrideResponse: Partial<NetUSDChangeCriterion> = {},
+): NetUSDChangeCriterion => ({
+  ...{
+    type: faker.helpers.arrayElement(["netUSDChange"] as const),
+    changeCents: faker.number.int({ min: undefined, max: undefined }),
+    operator: faker.helpers.arrayElement([">", ">=", "<", "<=", "=="] as const),
+  },
+  ...overrideResponse,
+});
+
 export const getGetPolicyByIdResponseEvmNetworkCriterionMock = (
   overrideResponse: Partial<EvmNetworkCriterion> = {},
 ): EvmNetworkCriterion => ({
   ...{
     type: faker.helpers.arrayElement(["evmNetwork"] as const),
-    networks: faker.helpers.arrayElements(["base-sepolia", "base"] as const),
+    networks: faker.helpers.arrayElements([
+      "base-sepolia",
+      "base",
+      "ethereum",
+      "ethereum-sepolia",
+      "avalanche",
+      "polygon",
+      "optimism",
+      "arbitrum",
+      "zora",
+      "bnb",
+    ] as const),
     operator: faker.helpers.arrayElement(["in", "not in"] as const),
   },
   ...overrideResponse,
@@ -1178,6 +1249,7 @@ export const getGetPolicyByIdResponseMock = (overrideResponse: Partial<Policy> =
             { ...getGetPolicyByIdResponseEthValueCriterionMock() },
             { ...getGetPolicyByIdResponseEvmAddressCriterionMock() },
             { ...getGetPolicyByIdResponseEvmDataCriterionMock() },
+            { ...getGetPolicyByIdResponseNetUSDChangeCriterionMock() },
           ]),
         ),
       },
@@ -1193,6 +1265,7 @@ export const getGetPolicyByIdResponseMock = (overrideResponse: Partial<Policy> =
             { ...getGetPolicyByIdResponseEvmAddressCriterionMock() },
             { ...getGetPolicyByIdResponseEvmNetworkCriterionMock() },
             { ...getGetPolicyByIdResponseEvmDataCriterionMock() },
+            { ...getGetPolicyByIdResponseNetUSDChangeCriterionMock() },
           ]),
         ),
       },
@@ -1420,12 +1493,34 @@ export const getUpdatePolicyResponseEvmDataCriterionMock = (
   ...overrideResponse,
 });
 
+export const getUpdatePolicyResponseNetUSDChangeCriterionMock = (
+  overrideResponse: Partial<NetUSDChangeCriterion> = {},
+): NetUSDChangeCriterion => ({
+  ...{
+    type: faker.helpers.arrayElement(["netUSDChange"] as const),
+    changeCents: faker.number.int({ min: undefined, max: undefined }),
+    operator: faker.helpers.arrayElement([">", ">=", "<", "<=", "=="] as const),
+  },
+  ...overrideResponse,
+});
+
 export const getUpdatePolicyResponseEvmNetworkCriterionMock = (
   overrideResponse: Partial<EvmNetworkCriterion> = {},
 ): EvmNetworkCriterion => ({
   ...{
     type: faker.helpers.arrayElement(["evmNetwork"] as const),
-    networks: faker.helpers.arrayElements(["base-sepolia", "base"] as const),
+    networks: faker.helpers.arrayElements([
+      "base-sepolia",
+      "base",
+      "ethereum",
+      "ethereum-sepolia",
+      "avalanche",
+      "polygon",
+      "optimism",
+      "arbitrum",
+      "zora",
+      "bnb",
+    ] as const),
     operator: faker.helpers.arrayElement(["in", "not in"] as const),
   },
   ...overrideResponse,
@@ -1594,6 +1689,7 @@ export const getUpdatePolicyResponseMock = (overrideResponse: Partial<Policy> =
             { ...getUpdatePolicyResponseEthValueCriterionMock() },
             { ...getUpdatePolicyResponseEvmAddressCriterionMock() },
             { ...getUpdatePolicyResponseEvmDataCriterionMock() },
+            { ...getUpdatePolicyResponseNetUSDChangeCriterionMock() },
           ]),
         ),
       },
@@ -1609,6 +1705,7 @@ export const getUpdatePolicyResponseMock = (overrideResponse: Partial<Policy> =
             { ...getUpdatePolicyResponseEvmAddressCriterionMock() },
             { ...getUpdatePolicyResponseEvmNetworkCriterionMock() },
             { ...getUpdatePolicyResponseEvmDataCriterionMock() },
+            { ...getUpdatePolicyResponseNetUSDChangeCriterionMock() },
           ]),
         ),
       },

package/openapi-client/index.ts

@@ -9,6 +9,7 @@ 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";
 
 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.32.0",
+  "version": "1.34.0",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/policies/evmSchema.ts

@@ -111,6 +111,23 @@ export const EvmMessageCriterionSchema = z.object({
 });
 export type EvmMessageCriterion = z.infer<typeof EvmMessageCriterionSchema>;
 
+/**
+ * Schema for Net USD change criterion
+ */
+export const NetUSDChangeCriterionSchema = z.object({
+  /** The type of criterion, must be "netUSDChange" for USD denominated asset transfer rules. */
+  type: z.literal("netUSDChange"),
+  /**
+   * The amount of USD, in cents, that the total USD value of a transaction's asset transfer and exposure should be compared to.
+   */
+  changeCents: z.number().int().nonnegative(),
+  /**
+   * The operator to use for the comparison. The total value of a transaction's asset transfer and exposure in USD will be on the left-hand side of the operator, and the `changeCents` field will be on the right-hand side.
+   */
+  operator: EthValueOperatorEnum,
+});
+export type NetUSDChangeCriterion = z.infer<typeof NetUSDChangeCriterionSchema>;
+
 /**
  * Schema for EVM typed address conditions
  */
@@ -350,6 +367,7 @@ export const SignEvmTransactionCriteriaSchema = z
       EthValueCriterionSchema,
       EvmAddressCriterionSchema,
       EvmDataCriterionSchema,
+      NetUSDChangeCriterionSchema,
     ]),
   )
   .max(10)
@@ -383,6 +401,7 @@ export const SendEvmTransactionCriteriaSchema = z
       EvmAddressCriterionSchema,
       EvmNetworkCriterionSchema,
       EvmDataCriterionSchema,
+      NetUSDChangeCriterionSchema,
     ]),
   )
   .max(10)

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.32.0";
+export const version = "1.34.0";