@coinbase/cdp-sdk 1.1.1 → 1.2.0

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

@@ -0,0 +1,411 @@
+/**
+ * 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
+ */
+export interface EvmAccount {
+  /**
+   * The 0x-prefixed, checksum EVM address.
+   * @pattern ^0x[0-9a-fA-F]{40}$
+   */
+  address: string;
+  /**
+   * An optional name for the account.
+Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long.
+Account names are guaranteed to be unique across all EVM accounts in the developer's CDP Project.
+   * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  name?: string;
+}
+
+export interface ListResponse {
+  /** The token for the next page of items, if any. */
+  nextPageToken?: string;
+}
+
+/**
+ * The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
+ */
+export type ErrorType = (typeof ErrorType)[keyof typeof ErrorType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ErrorType = {
+  already_exists: "already_exists",
+  faucet_limit_exceeded: "faucet_limit_exceeded",
+  forbidden: "forbidden",
+  idempotency_error: "idempotency_error",
+  internal_server_error: "internal_server_error",
+  invalid_request: "invalid_request",
+  invalid_signature: "invalid_signature",
+  malformed_transaction: "malformed_transaction",
+  not_found: "not_found",
+  rate_limit_exceeded: "rate_limit_exceeded",
+  request_canceled: "request_canceled",
+  timed_out: "timed_out",
+  unauthorized: "unauthorized",
+} as const;
+
+/**
+ * An error response including the code for the type of error and a human-readable message describing the error.
+ */
+export interface Error {
+  errorType: ErrorType;
+  /** The error message. */
+  errorMessage: string;
+  /** A unique identifier for the request that generated the error. This can be used to help debug issues with the API. */
+  correlationId?: string;
+  /** A link to the corresponding error documentation. */
+  errorLink?: string;
+}
+
+export interface EvmSmartAccount {
+  /**
+   * The 0x-prefixed, checksum address of the Smart Account.
+   * @pattern ^0x[0-9a-fA-F]{40}$
+   */
+  address: string;
+  /** Today, only a single owner can be set for a Smart Account, but this is an array to allow having multiple owners in the future. The address is a 0x-prefixed, checksum address. */
+  owners: string[];
+  /**
+   * An optional name for the account.
+Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long.
+Account names are guaranteed to be unique across all Smart Accounts in the developer's CDP Project.
+   * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  name?: string;
+}
+
+export interface EvmCall {
+  /**
+   * The address the call is directed to.
+   * @pattern ^0x[0-9a-fA-F]{40}$
+   */
+  to: string;
+  /** The amount of ETH to send with the call, in wei. */
+  value: string;
+  /**
+   * The call data to send. This is the hex-encoded data of the function call consisting of the method selector and the function arguments.
+   * @pattern ^0x[0-9a-fA-F]*$
+   */
+  data: string;
+}
+
+/**
+ * The network the user operation is for.
+ */
+export type EvmUserOperationNetwork =
+  (typeof EvmUserOperationNetwork)[keyof typeof EvmUserOperationNetwork];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EvmUserOperationNetwork = {
+  "base-sepolia": "base-sepolia",
+  base: "base",
+} as const;
+
+/**
+ * The status of the user operation.
+ */
+export type EvmUserOperationStatus =
+  (typeof EvmUserOperationStatus)[keyof typeof EvmUserOperationStatus];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EvmUserOperationStatus = {
+  pending: "pending",
+  signed: "signed",
+  broadcast: "broadcast",
+  complete: "complete",
+  failed: "failed",
+} as const;
+
+export interface EvmUserOperation {
+  /** The network the user operation is for. */
+  network: EvmUserOperationNetwork;
+  /**
+   * The hash of the user operation. This is not the transaction hash, as a transaction consists of multiple user operations. The user operation hash is the hash of this particular user operation which gets signed by the owner of the Smart Account.
+   * @pattern ^0x[0-9a-fA-F]{64}$
+   */
+  userOpHash: string;
+  /** The list of calls in the user operation. */
+  calls: EvmCall[];
+  /** The status of the user operation. */
+  status: EvmUserOperationStatus;
+  /**
+   * The hash of the transaction that included this particular user operation. This gets set after the user operation is broadcasted and the transaction is included in a block.
+   * @pattern ^0x[0-9a-fA-F]{64}$|^$
+   */
+  transactionHash?: string;
+}
+
+export interface SolanaAccount {
+  /**
+   * The base58 encoded Solana address.
+   * @pattern ^[1-9A-HJ-NP-Za-km-z]{32,44}$
+   */
+  address: string;
+  /**
+   * An optional name for the account.
+Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long.
+Account names are guaranteed to be unique across all Solana accounts in the developer's CDP Project.
+   * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  name?: string;
+}
+
+/**
+ * Internal server error.
+ */
+export type InternalServerErrorResponse = Error;
+
+/**
+ * Idempotency key conflict.
+ */
+export type IdempotencyErrorResponse = Error;
+
+/**
+ * The resource already exists.
+ */
+export type AlreadyExistsErrorResponse = Error;
+
+/**
+ * A JWT signed using your Wallet Secret, encoded in base64. Refer to the
+[Generate a Wallet Token](https://docs.cdp.coinbase.com/api-v2/docs/authentication#3-generate-a-wallet-token)
+section of our Authentication docs for more details on how to generate your Wallet Token.
+
+ */
+export type XWalletAuthParameter = string;
+
+/**
+ * An optional [UUID v4](https://www.uuidgenerator.net/version4) request header for making requests safely retryable.
+When included, duplicate requests with the same key will return identical responses. 
+Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-v2/docs/idempotency) for more information on using idempotency keys.
+
+ */
+export type IdempotencyKeyParameter = string;
+
+export type ListEvmAccountsParams = {
+  /**
+   * The number of accounts to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the next page of accounts, if any.
+   */
+  pageToken?: string;
+};
+
+export type ListEvmAccounts200AllOf = {
+  /** The list of EVM accounts. */
+  accounts: EvmAccount[];
+};
+
+export type ListEvmAccounts200 = ListEvmAccounts200AllOf & ListResponse;
+
+export type CreateEvmAccountBody = {
+  /**
+   * An optional name for the account.
+Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long.
+Account names must be unique across all EVM accounts in the developer's CDP Project.
+   * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  name?: string;
+};
+
+export type SignEvmTransactionBody = {
+  /** The RLP-encoded transaction to sign, as a 0x-prefixed hex string. */
+  transaction: string;
+};
+
+export type SignEvmTransaction200 = {
+  /** The RLP-encoded signed transaction, as a 0x-prefixed hex string. */
+  signedTransaction: string;
+};
+
+export type SignEvmHashBody = {
+  /** The arbitrary 32 byte hash to sign. */
+  hash: string;
+};
+
+export type SignEvmHash200 = {
+  /** The signature of the hash, as a 0x-prefixed hex string. */
+  signature: string;
+};
+
+export type SignEvmMessageBody = {
+  /** The message to sign. */
+  message: string;
+};
+
+export type SignEvmMessage200 = {
+  /** The signature of the message, as a 0x-prefixed hex string. */
+  signature: string;
+};
+
+export type ListEvmSmartAccountsParams = {
+  /**
+   * The number of accounts to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the next page of accounts, if any.
+   */
+  pageToken?: string;
+};
+
+export type ListEvmSmartAccounts200AllOf = {
+  /** The list of Smart Accounts. */
+  accounts: EvmSmartAccount[];
+};
+
+export type ListEvmSmartAccounts200 = ListEvmSmartAccounts200AllOf & ListResponse;
+
+export type CreateEvmSmartAccountBody = {
+  /** Today, only a single owner can be set for a Smart Account, but this is an array to allow setting multiple owners in the future. */
+  owners: string[];
+};
+
+/**
+ * The network to prepare the user operation for.
+ */
+export type PrepareUserOperationBodyNetwork =
+  (typeof PrepareUserOperationBodyNetwork)[keyof typeof PrepareUserOperationBodyNetwork];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PrepareUserOperationBodyNetwork = {
+  "base-sepolia": "base-sepolia",
+  base: "base",
+} as const;
+
+export type PrepareUserOperationBody = {
+  /** The network to prepare the user operation for. */
+  network: PrepareUserOperationBodyNetwork;
+  /** The list of calls to make from the Smart Account. */
+  calls: EvmCall[];
+  /** The URL of the paymaster to use for the user operation. */
+  paymasterUrl?: string;
+};
+
+export type SendUserOperationBody = {
+  /** The hex-encoded signature of the user operation. */
+  signature: string;
+};
+
+/**
+ * The network to request funds from.
+ */
+export type RequestEvmFaucetBodyNetwork =
+  (typeof RequestEvmFaucetBodyNetwork)[keyof typeof RequestEvmFaucetBodyNetwork];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RequestEvmFaucetBodyNetwork = {
+  "base-sepolia": "base-sepolia",
+  "ethereum-sepolia": "ethereum-sepolia",
+} as const;
+
+/**
+ * The token to request funds for.
+ */
+export type RequestEvmFaucetBodyToken =
+  (typeof RequestEvmFaucetBodyToken)[keyof typeof RequestEvmFaucetBodyToken];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RequestEvmFaucetBodyToken = {
+  eth: "eth",
+  usdc: "usdc",
+  eurc: "eurc",
+  cbbtc: "cbbtc",
+} as const;
+
+export type RequestEvmFaucetBody = {
+  /** The network to request funds from. */
+  network: RequestEvmFaucetBodyNetwork;
+  /**
+   * The address to request funds to, which is a 0x-prefixed hexadecimal string.
+   * @pattern ^0x[0-9a-fA-F]{40}$
+   */
+  address: string;
+  /** The token to request funds for. */
+  token: RequestEvmFaucetBodyToken;
+};
+
+export type RequestEvmFaucet200 = {
+  /** The hash of the transaction that requested the funds.
+   **Note:** In rare cases, when gas conditions are unusually high, the transaction may not confirm, and the system may issue a replacement transaction to complete the faucet request. In these rare cases, the `transactionHash` will be out of sync with the actual faucet transaction that was confirmed onchain. */
+  transactionHash: string;
+};
+
+export type ListSolanaAccountsParams = {
+  /**
+   * The number of accounts to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the next page of accounts, if any.
+   */
+  pageToken?: string;
+};
+
+export type ListSolanaAccounts200AllOf = {
+  /** The list of Solana accounts. */
+  accounts: SolanaAccount[];
+};
+
+export type ListSolanaAccounts200 = ListSolanaAccounts200AllOf & ListResponse;
+
+export type CreateSolanaAccountBody = {
+  /**
+   * An optional name for the account.
+Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long.
+Account names must be unique across all Solana accounts in the developer's CDP Project.
+   * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$
+   */
+  name?: string;
+};
+
+export type SignSolanaTransactionBody = {
+  /** The base64 encoded transaction to sign. */
+  transaction: string;
+};
+
+export type SignSolanaTransaction200 = {
+  /** The base64 encoded signed transaction. */
+  signedTransaction: string;
+};
+
+export type SignSolanaMessageBody = {
+  /** The arbitrary message to sign. */
+  message: string;
+};
+
+export type SignSolanaMessage200 = {
+  /** The signature of the message, as a base58 encoded string. */
+  signature: string;
+};
+
+/**
+ * The token to request funds for.
+ */
+export type RequestSolanaFaucetBodyToken =
+  (typeof RequestSolanaFaucetBodyToken)[keyof typeof RequestSolanaFaucetBodyToken];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RequestSolanaFaucetBodyToken = {
+  sol: "sol",
+  usdc: "usdc",
+} as const;
+
+export type RequestSolanaFaucetBody = {
+  /**
+   * The address to request funds to, which is a base58-encoded string.
+   * @pattern ^[1-9A-HJ-NP-Za-km-z]{32,44}$
+   */
+  address: string;
+  /** The token to request funds for. */
+  token: RequestSolanaFaucetBodyToken;
+};
+
+export type RequestSolanaFaucet200 = {
+  /** The signature identifying the transaction that requested the funds. */
+  transactionSignature: string;
+};

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

@@ -0,0 +1,242 @@
+/**
+ * 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 {
+  EvmAccount,
+  ListEvmAccounts200,
+  SignEvmHash200,
+  SignEvmMessage200,
+  SignEvmTransaction200,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getListEvmAccountsResponseMock = (): ListEvmAccounts200 => ({
+  ...{
+    accounts: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(
+      () => ({
+        address: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+        name: faker.helpers.arrayElement([
+          faker.helpers.fromRegExp("^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$"),
+          undefined,
+        ]),
+      }),
+    ),
+  },
+  ...{ nextPageToken: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) },
+});
+
+export const getCreateEvmAccountResponseMock = (
+  overrideResponse: Partial<EvmAccount> = {},
+): EvmAccount => ({
+  address: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+  name: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$"),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getGetEvmAccountResponseMock = (
+  overrideResponse: Partial<EvmAccount> = {},
+): EvmAccount => ({
+  address: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+  name: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$"),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getGetEvmAccountByNameResponseMock = (
+  overrideResponse: Partial<EvmAccount> = {},
+): EvmAccount => ({
+  address: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+  name: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^[A-Za-z0-9][A-Za-z0-9-]{0,34}[A-Za-z0-9]$"),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getSignEvmTransactionResponseMock = (
+  overrideResponse: Partial<SignEvmTransaction200> = {},
+): SignEvmTransaction200 => ({ signedTransaction: faker.string.alpha(20), ...overrideResponse });
+
+export const getSignEvmHashResponseMock = (
+  overrideResponse: Partial<SignEvmHash200> = {},
+): SignEvmHash200 => ({ signature: faker.string.alpha(20), ...overrideResponse });
+
+export const getSignEvmMessageResponseMock = (
+  overrideResponse: Partial<SignEvmMessage200> = {},
+): SignEvmMessage200 => ({ signature: faker.string.alpha(20), ...overrideResponse });
+
+export const getListEvmAccountsMockHandler = (
+  overrideResponse?:
+    | ListEvmAccounts200
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<ListEvmAccounts200> | ListEvmAccounts200),
+) => {
+  return http.get("*/v2/evm/accounts", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getListEvmAccountsResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getCreateEvmAccountMockHandler = (
+  overrideResponse?:
+    | EvmAccount
+    | ((info: Parameters<Parameters<typeof http.post>[1]>[0]) => Promise<EvmAccount> | EvmAccount),
+) => {
+  return http.post("*/v2/evm/accounts", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getCreateEvmAccountResponseMock(),
+      ),
+      { status: 201, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getGetEvmAccountMockHandler = (
+  overrideResponse?:
+    | EvmAccount
+    | ((info: Parameters<Parameters<typeof http.get>[1]>[0]) => Promise<EvmAccount> | EvmAccount),
+) => {
+  return http.get("*/v2/evm/accounts/:address", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getGetEvmAccountResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getGetEvmAccountByNameMockHandler = (
+  overrideResponse?:
+    | EvmAccount
+    | ((info: Parameters<Parameters<typeof http.get>[1]>[0]) => Promise<EvmAccount> | EvmAccount),
+) => {
+  return http.get("*/v2/evm/accounts/by-name/:name", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getGetEvmAccountByNameResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getSignEvmTransactionMockHandler = (
+  overrideResponse?:
+    | SignEvmTransaction200
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<SignEvmTransaction200> | SignEvmTransaction200),
+) => {
+  return http.post("*/v2/evm/accounts/:address/sign/transaction", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getSignEvmTransactionResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getSignEvmHashMockHandler = (
+  overrideResponse?:
+    | SignEvmHash200
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<SignEvmHash200> | SignEvmHash200),
+) => {
+  return http.post("*/v2/evm/accounts/:address/sign", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getSignEvmHashResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getSignEvmMessageMockHandler = (
+  overrideResponse?:
+    | SignEvmMessage200
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<SignEvmMessage200> | SignEvmMessage200),
+) => {
+  return http.post("*/v2/evm/accounts/:address/sign/message", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getSignEvmMessageResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getEvmAccountsMock = () => [
+  getListEvmAccountsMockHandler(),
+  getCreateEvmAccountMockHandler(),
+  getGetEvmAccountMockHandler(),
+  getGetEvmAccountByNameMockHandler(),
+  getSignEvmTransactionMockHandler(),
+  getSignEvmHashMockHandler(),
+  getSignEvmMessageMockHandler(),
+];