@coinbase/cdp-sdk 1.33.0 → 1.34.0

package/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.ts

@@ -45,6 +45,7 @@ export const ErrorType = {
   idempotency_error: "idempotency_error",
   internal_server_error: "internal_server_error",
   invalid_request: "invalid_request",
+  invalid_sql_query: "invalid_sql_query",
   invalid_signature: "invalid_signature",
   malformed_transaction: "malformed_transaction",
   not_found: "not_found",
@@ -202,6 +203,20 @@ export interface UserOperationReceiptRevert {
  */
 export interface UserOperationReceipt {
   revert?: UserOperationReceiptRevert;
+  /**
+   * The hash of this transaction as 0x-prefixed string.
+   * @pattern ^0x[a-fA-F0-9]{64}$
+   */
+  transactionHash?: string;
+  /**
+   * The block hash of the block including the transaction as 0x-prefixed string.
+   * @pattern ^0x[0-9a-fA-F]{64}$|^$
+   */
+  blockHash?: string;
+  /** The block height (number) of the block including the transaction. */
+  blockNumber?: number;
+  /** The gas used for landing this user operation. */
+  gasUsed?: string;
 }
 
 /**
@@ -240,21 +255,33 @@ export interface EvmUserOperation {
   receipts?: UserOperationReceipt[];
 }
 
+/**
+ * The network the spend permission is on.
+ */
+export type SpendPermissionNetwork =
+  (typeof SpendPermissionNetwork)[keyof typeof SpendPermissionNetwork];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const SpendPermissionNetwork = {
+  base: "base",
+  "base-sepolia": "base-sepolia",
+  ethereum: "ethereum",
+  "ethereum-sepolia": "ethereum-sepolia",
+  optimism: "optimism",
+  arbitrum: "arbitrum",
+  avalanche: "avalanche",
+  polygon: "polygon",
+} as const;
+
 export interface CreateSpendPermissionRequest {
-  /** The network of the spend permission. */
-  network: string;
+  network: SpendPermissionNetwork;
   /**
-   * Smart account this spend permission is valid for.
-   * @pattern ^0x[a-fA-F0-9]{40}$
-   */
-  account: string;
-  /**
-   * Entity that can spend account's tokens.
+   * Entity that can spend account's tokens. Can be either a Smart Account or an EOA.
    * @pattern ^0x[a-fA-F0-9]{40}$
    */
   spender: string;
   /**
-   * Token address (ERC-7528 native token address or ERC-20 contract).
+   * ERC-7528 native token address (e.g. "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE" for native ETH), or an  ERC-20 contract address.
    * @pattern ^0x[a-fA-F0-9]{40}$
    */
   token: string;
@@ -296,32 +323,31 @@ export interface SpendPermission {
   /** Maximum allowed value to spend, in atomic units for the specified token, within each period. */
   allowance: string;
   /** Time duration for resetting used allowance on a recurring basis (seconds). */
-  period?: string;
+  period: string;
   /** The start time for this spend permission, in Unix seconds. */
-  start?: string;
+  start: string;
   /** The expiration time for this spend permission, in Unix seconds. */
-  end?: string;
+  end: string;
   /** An arbitrary salt to differentiate unique spend permissions with otherwise identical data. */
-  salt?: string;
+  salt: string;
   /** Arbitrary data to include in the permission. */
-  extraData?: string;
+  extraData: string;
 }
 
 export interface SpendPermissionResponseObject {
-  permission?: SpendPermission;
+  permission: SpendPermission;
   /** Unique hash identifier for this permission. */
-  permissionHash?: string;
+  permissionHash: string;
   /** Whether this permission has been revoked. */
-  revoked?: boolean;
+  revoked: boolean;
   /** The UTC ISO 8601 timestamp when the permission was revoked (if applicable). */
   revokedAt?: string;
   /** The UTC ISO 8601 timestamp when the permission was created. */
-  createdAt?: string;
+  createdAt: string;
 }
 
 export interface RevokeSpendPermissionRequest {
-  /** The network of the spend permission. */
-  network: string;
+  network: SpendPermissionNetwork;
   /** The hash of the spend permission to revoke. */
   permissionHash: string;
   /** The paymaster URL of the spend permission. */
@@ -1032,6 +1058,14 @@ export type EvmNetworkCriterionNetworksItem =
 export const EvmNetworkCriterionNetworksItem = {
   "base-sepolia": "base-sepolia",
   base: "base",
+  ethereum: "ethereum",
+  "ethereum-sepolia": "ethereum-sepolia",
+  avalanche: "avalanche",
+  polygon: "polygon",
+  optimism: "optimism",
+  arbitrum: "arbitrum",
+  zora: "zora",
+  bnb: "bnb",
 } as const;
 
 /**
@@ -1847,6 +1881,109 @@ export interface SolanaTokenBalance {
   token: SolanaToken;
 }
 
+/**
+ * Request to execute a SQL query against indexed blockchain data.
+ */
+export interface OnchainDataQuery {
+  /**
+   * SQL query to execute against the indexed blockchain data.
+   * @minLength 1
+   * @maxLength 10000
+   */
+  sql: string;
+}
+
+/**
+ * Row data with column names as keys.
+ */
+export type OnchainDataResultResultItem = { [key: string]: unknown };
+
+/**
+ * Column data type (ClickHouse types).
+ */
+export type OnchainDataResultSchemaColumnsItemType =
+  (typeof OnchainDataResultSchemaColumnsItemType)[keyof typeof OnchainDataResultSchemaColumnsItemType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OnchainDataResultSchemaColumnsItemType = {
+  String: "String",
+  UInt8: "UInt8",
+  UInt16: "UInt16",
+  UInt32: "UInt32",
+  UInt64: "UInt64",
+  UInt128: "UInt128",
+  UInt256: "UInt256",
+  Int8: "Int8",
+  Int16: "Int16",
+  Int32: "Int32",
+  Int64: "Int64",
+  Int128: "Int128",
+  Int256: "Int256",
+  Float32: "Float32",
+  Float64: "Float64",
+  Bool: "Bool",
+  Date: "Date",
+  DateTime: "DateTime",
+  DateTime64: "DateTime64",
+  UUID: "UUID",
+} as const;
+
+export type OnchainDataResultSchemaColumnsItem = {
+  /** Column name. */
+  name?: string;
+  /** Column data type (ClickHouse types). */
+  type?: OnchainDataResultSchemaColumnsItemType;
+};
+
+/**
+ * Schema information for the query result. This is a derived schema from the query result, so types may not match the underlying table.
+
+ */
+export type OnchainDataResultSchema = {
+  /** Column definitions. */
+  columns?: OnchainDataResultSchemaColumnsItem[];
+};
+
+/**
+ * Metadata about query execution.
+ */
+export type OnchainDataResultMetadata = {
+  /** Whether the result was served from cache. */
+  cached?: boolean;
+  /** Query execution time in milliseconds. */
+  executionTimeMs?: number;
+  /** Number of rows returned. */
+  rowCount?: number;
+};
+
+/**
+ * Result of executing a SQL query.
+ */
+export interface OnchainDataResult {
+  /** Query result as an array of objects representing rows. */
+  result?: OnchainDataResultResultItem[];
+  /** Schema information for the query result. This is a derived schema from the query result, so types may not match the underlying table.
+   */
+  schema?: OnchainDataResultSchema;
+  /** Metadata about query execution. */
+  metadata?: OnchainDataResultMetadata;
+}
+
+/**
+ * Response containing token addresses that an account has received.
+ */
+export interface AccountTokenAddressesResponse {
+  /** The account address that was queried. */
+  accountAddress?: string;
+  /** List of token contract addresses that the account has received. */
+  tokenAddresses?: string[];
+  /**
+   * Total number of unique token addresses discovered.
+   * @minimum 0
+   */
+  totalCount?: number;
+}
+
 /**
  * The action of the payment method.
  */
@@ -2211,11 +2348,21 @@ export type IdempotencyErrorResponse = Error;
  */
 export type AlreadyExistsErrorResponse = Error;
 
+/**
+ * The underlying SQL string is invalid.
+ */
+export type InvalidSQLQueryErrorResponse = Error;
+
 /**
  * Unauthorized.
  */
 export type UnauthorizedErrorResponse = Error;
 
+/**
+ * The request timed out.
+ */
+export type TimedOutErrorResponse = Error;
+
 /**
  * Rate limit exceeded.
  */
@@ -2806,6 +2953,24 @@ export type ListSolanaTokenBalances200AllOf = {
 
 export type ListSolanaTokenBalances200 = ListSolanaTokenBalances200AllOf & ListResponse;
 
+export type ListDataTokenBalancesParams = {
+  /**
+   * The number of balances to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the next page of balances. Will be empty if there are no more balances to fetch.
+   */
+  pageToken?: string;
+};
+
+export type ListDataTokenBalances200AllOf = {
+  /** The list of EVM token balances. */
+  balances: TokenBalance[];
+};
+
+export type ListDataTokenBalances200 = ListDataTokenBalances200AllOf & ListResponse;
+
 export type GetCryptoRailsParams = {
   /**
    * Comma separated list of networks to filter the rails by.

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

@@ -199,6 +199,19 @@ export const getPrepareUserOperationResponseMock = (
         { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
         undefined,
       ]),
+      transactionHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+        undefined,
+      ]),
+      blockHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+        undefined,
+      ]),
+      blockNumber: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+      gasUsed: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
     })),
     undefined,
   ]),
@@ -233,6 +246,19 @@ export const getGetUserOperationResponseMock = (
         { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
         undefined,
       ]),
+      transactionHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+        undefined,
+      ]),
+      blockHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+        undefined,
+      ]),
+      blockNumber: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+      gasUsed: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
     })),
     undefined,
   ]),
@@ -267,6 +293,19 @@ export const getSendUserOperationResponseMock = (
         { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
         undefined,
       ]),
+      transactionHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+        undefined,
+      ]),
+      blockHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+        undefined,
+      ]),
+      blockNumber: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+      gasUsed: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
     })),
     undefined,
   ]),
@@ -301,6 +340,19 @@ export const getCreateSpendPermissionResponseMock = (
         { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
         undefined,
       ]),
+      transactionHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+        undefined,
+      ]),
+      blockHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+        undefined,
+      ]),
+      blockNumber: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+      gasUsed: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
     })),
     undefined,
   ]),
@@ -313,30 +365,24 @@ export const getListSpendPermissionsResponseMock = (): ListSpendPermissions200 =
       { length: faker.number.int({ min: 1, max: 10 }) },
       (_, i) => i + 1,
     ).map(() => ({
-      permission: faker.helpers.arrayElement([
-        {
-          account: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
-          spender: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
-          token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
-          allowance: faker.string.alpha(20),
-          period: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
-          start: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
-          end: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
-          salt: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
-          extraData: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
-        },
-        undefined,
-      ]),
-      permissionHash: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
-      revoked: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]),
+      permission: {
+        account: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+        spender: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+        token: faker.helpers.fromRegExp("^0x[a-fA-F0-9]{40}$"),
+        allowance: faker.string.alpha(20),
+        period: faker.string.alpha(20),
+        start: faker.string.alpha(20),
+        end: faker.string.alpha(20),
+        salt: faker.string.alpha(20),
+        extraData: faker.string.alpha(20),
+      },
+      permissionHash: faker.string.alpha(20),
+      revoked: faker.datatype.boolean(),
       revokedAt: faker.helpers.arrayElement([
         `${faker.date.past().toISOString().split(".")[0]}Z`,
         undefined,
       ]),
-      createdAt: faker.helpers.arrayElement([
-        `${faker.date.past().toISOString().split(".")[0]}Z`,
-        undefined,
-      ]),
+      createdAt: `${faker.date.past().toISOString().split(".")[0]}Z`,
     })),
   },
   ...{ nextPageToken: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) },
@@ -370,6 +416,19 @@ export const getRevokeSpendPermissionResponseMock = (
         { data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"), message: faker.string.alpha(20) },
         undefined,
       ]),
+      transactionHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[a-fA-F0-9]{64}$"),
+        undefined,
+      ]),
+      blockHash: faker.helpers.arrayElement([
+        faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+        undefined,
+      ]),
+      blockNumber: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+      gasUsed: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
     })),
     undefined,
   ]),

package/openapi-client/generated/evm-token-balances/evm-token-balances.ts

@@ -17,8 +17,7 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 /**
  * 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 is still under development and does not yet provide strong freshness guarantees. Specifically, balances of new tokens can, on occasion, take up to ~30 seconds to appear, while balances of tokens already belonging to an address will generally be close to chain tip. Freshness of new token balances will improve over the coming weeks.
+ **Note:** This endpoint is still under development and does not yet provide strong freshness guarantees. Specifically, balances of new tokens can, on occasion, take up to ~30 seconds to appear, while balances of tokens already belonging to an address will generally be close to chain tip. Freshness of new token balances will improve over the coming weeks.
  * @summary List EVM token balances
  */
 export const listEvmTokenBalances = (

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 "./onchain-data/onchain-data.msw.js";
 export * from "./onramp/onramp.msw.js";
 export * from "./payments-alpha/payments-alpha.msw.js";
 export * from "./policy-engine/policy-engine.msw.js";

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

@@ -0,0 +1,185 @@
+/**
+ * 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 { ListEvmTokenBalancesNetwork } from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+import type {
+  AccountTokenAddressesResponse,
+  ListDataTokenBalances200,
+  OnchainDataResult,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getRunSQLQueryResponseMock = (
+  overrideResponse: Partial<OnchainDataResult> = {},
+): OnchainDataResult => ({
+  result: faker.helpers.arrayElement([
+    Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({})),
+    undefined,
+  ]),
+  schema: faker.helpers.arrayElement([
+    {
+      columns: faker.helpers.arrayElement([
+        Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+          name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+          type: faker.helpers.arrayElement([
+            faker.helpers.arrayElement([
+              "String",
+              "UInt8",
+              "UInt16",
+              "UInt32",
+              "UInt64",
+              "UInt128",
+              "UInt256",
+              "Int8",
+              "Int16",
+              "Int32",
+              "Int64",
+              "Int128",
+              "Int256",
+              "Float32",
+              "Float64",
+              "Bool",
+              "Date",
+              "DateTime",
+              "DateTime64",
+              "UUID",
+            ] as const),
+            undefined,
+          ]),
+        })),
+        undefined,
+      ]),
+    },
+    undefined,
+  ]),
+  metadata: faker.helpers.arrayElement([
+    {
+      cached: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]),
+      executionTimeMs: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+      rowCount: faker.helpers.arrayElement([
+        faker.number.int({ min: undefined, max: undefined }),
+        undefined,
+      ]),
+    },
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getListTokensForAccountResponseMock = (
+  overrideResponse: Partial<AccountTokenAddressesResponse> = {},
+): AccountTokenAddressesResponse => ({
+  accountAddress: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  tokenAddresses: faker.helpers.arrayElement([
+    Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() =>
+      faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+    ),
+    undefined,
+  ]),
+  totalCount: faker.helpers.arrayElement([faker.number.int({ min: 0, max: undefined }), undefined]),
+  ...overrideResponse,
+});
+
+export const getListDataTokenBalancesResponseMock = (): ListDataTokenBalances200 => ({
+  ...{
+    balances: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(
+      () => ({
+        amount: {
+          amount: faker.helpers.fromRegExp("^[0-9]+$"),
+          decimals: faker.number.int({ min: undefined, max: undefined }),
+        },
+        token: {
+          network: faker.helpers.arrayElement(Object.values(ListEvmTokenBalancesNetwork)),
+          symbol: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+          name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+          contractAddress: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+        },
+      }),
+    ),
+  },
+  ...{ nextPageToken: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) },
+});
+
+export const getRunSQLQueryMockHandler = (
+  overrideResponse?:
+    | OnchainDataResult
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<OnchainDataResult> | OnchainDataResult),
+) => {
+  return http.post("*/v2/data/query/run", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getRunSQLQueryResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getListTokensForAccountMockHandler = (
+  overrideResponse?:
+    | AccountTokenAddressesResponse
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<AccountTokenAddressesResponse> | AccountTokenAddressesResponse),
+) => {
+  return http.get("*/v2/data/evm/token-ownership/:network/:address", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getListTokensForAccountResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getListDataTokenBalancesMockHandler = (
+  overrideResponse?:
+    | ListDataTokenBalances200
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<ListDataTokenBalances200> | ListDataTokenBalances200),
+) => {
+  return http.get("*/v2/data/evm/token-balances/:network/:address", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getListDataTokenBalancesResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getOnchainDataMock = () => [
+  getRunSQLQueryMockHandler(),
+  getListTokensForAccountMockHandler(),
+  getListDataTokenBalancesMockHandler(),
+];