@coinbase/cdp-sdk 1.1.2 → 1.2.0

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

@@ -0,0 +1,150 @@
+/**
+ * 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 {
+  CreateEvmAccountBody,
+  EvmAccount,
+  ListEvmAccounts200,
+  ListEvmAccountsParams,
+  SignEvmHash200,
+  SignEvmHashBody,
+  SignEvmMessage200,
+  SignEvmMessageBody,
+  SignEvmTransaction200,
+  SignEvmTransactionBody,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Lists the EVM accounts belonging to the developer's CDP Project.
+The response is paginated, and by default, returns 20 accounts per page.
+ * @summary List EVM accounts
+ */
+export const listEvmAccounts = (
+  params?: ListEvmAccountsParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<ListEvmAccounts200>(
+    { url: `/v2/evm/accounts`, method: "GET", params },
+    options,
+  );
+};
+/**
+ * Creates a new EVM account.
+ * @summary Create an EVM account
+ */
+export const createEvmAccount = (
+  createEvmAccountBody?: CreateEvmAccountBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmAccount>(
+    {
+      url: `/v2/evm/accounts`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createEvmAccountBody,
+    },
+    options,
+  );
+};
+/**
+ * Gets an EVM account by its address.
+ * @summary Get an EVM account by address
+ */
+export const getEvmAccount = (address: string, options?: SecondParameter<typeof cdpApiClient>) => {
+  return cdpApiClient<EvmAccount>({ url: `/v2/evm/accounts/${address}`, method: "GET" }, options);
+};
+/**
+ * Gets an EVM account by its name.
+ * @summary Get an EVM account by name
+ */
+export const getEvmAccountByName = (
+  name: string,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmAccount>(
+    { url: `/v2/evm/accounts/by-name/${name}`, method: "GET" },
+    options,
+  );
+};
+/**
+ * Signs a transaction with the given EVM account.
+The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/).
+
+The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
+ * @summary Sign a transaction
+ */
+export const signEvmTransaction = (
+  address: string,
+  signEvmTransactionBody: SignEvmTransactionBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<SignEvmTransaction200>(
+    {
+      url: `/v2/evm/accounts/${address}/sign/transaction`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: signEvmTransactionBody,
+    },
+    options,
+  );
+};
+/**
+ * Signs an arbitrary 32 byte hash with the given EVM account.
+
+
+**WARNING: This API will likely be deprecated in the future.** It is recommended not to depend on it. Never sign a hash that you didn't generate, as it can be an arbitrary transaction. For example, it might send all of your funds to an attacker.
+ * @summary Sign a hash
+ */
+export const signEvmHash = (
+  address: string,
+  signEvmHashBody: SignEvmHashBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<SignEvmHash200>(
+    {
+      url: `/v2/evm/accounts/${address}/sign`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: signEvmHashBody,
+    },
+    options,
+  );
+};
+/**
+ * Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given EVM account.
+
+Per the specification, the message in the request body is prepended with `0x19 <0x45 (E)> <thereum Signed Message:\n" + len(message)>` before being signed.
+ * @summary Sign an EIP-191 message
+ */
+export const signEvmMessage = (
+  address: string,
+  signEvmMessageBody: SignEvmMessageBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<SignEvmMessage200>(
+    {
+      url: `/v2/evm/accounts/${address}/sign/message`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: signEvmMessageBody,
+    },
+    options,
+  );
+};
+export type ListEvmAccountsResult = NonNullable<Awaited<ReturnType<typeof listEvmAccounts>>>;
+export type CreateEvmAccountResult = NonNullable<Awaited<ReturnType<typeof createEvmAccount>>>;
+export type GetEvmAccountResult = NonNullable<Awaited<ReturnType<typeof getEvmAccount>>>;
+export type GetEvmAccountByNameResult = NonNullable<
+  Awaited<ReturnType<typeof getEvmAccountByName>>
+>;
+export type SignEvmTransactionResult = NonNullable<Awaited<ReturnType<typeof signEvmTransaction>>>;
+export type SignEvmHashResult = NonNullable<Awaited<ReturnType<typeof signEvmHash>>>;
+export type SignEvmMessageResult = NonNullable<Awaited<ReturnType<typeof signEvmMessage>>>;

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

@@ -0,0 +1,283 @@
+/**
+ * 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 {
+  EvmSmartAccount,
+  EvmUserOperation,
+  ListEvmSmartAccounts200,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getListEvmSmartAccountsResponseMock = (): ListEvmSmartAccounts200 => ({
+  ...{
+    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}$"),
+        owners: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(
+          () => 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 getCreateEvmSmartAccountResponseMock = (
+  overrideResponse: Partial<EvmSmartAccount> = {},
+): EvmSmartAccount => ({
+  address: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+  owners: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() =>
+    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 getGetEvmSmartAccountResponseMock = (
+  overrideResponse: Partial<EvmSmartAccount> = {},
+): EvmSmartAccount => ({
+  address: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+  owners: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() =>
+    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 getPrepareUserOperationResponseMock = (
+  overrideResponse: Partial<EvmUserOperation> = {},
+): EvmUserOperation => ({
+  network: faker.helpers.arrayElement(["base-sepolia", "base"] as const),
+  userOpHash: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$"),
+  calls: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+    to: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+    value: faker.string.alpha(20),
+    data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"),
+  })),
+  status: faker.helpers.arrayElement([
+    "pending",
+    "signed",
+    "broadcast",
+    "complete",
+    "failed",
+  ] as const),
+  transactionHash: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getGetUserOperationResponseMock = (
+  overrideResponse: Partial<EvmUserOperation> = {},
+): EvmUserOperation => ({
+  network: faker.helpers.arrayElement(["base-sepolia", "base"] as const),
+  userOpHash: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$"),
+  calls: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+    to: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+    value: faker.string.alpha(20),
+    data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"),
+  })),
+  status: faker.helpers.arrayElement([
+    "pending",
+    "signed",
+    "broadcast",
+    "complete",
+    "failed",
+  ] as const),
+  transactionHash: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getSendUserOperationResponseMock = (
+  overrideResponse: Partial<EvmUserOperation> = {},
+): EvmUserOperation => ({
+  network: faker.helpers.arrayElement(["base-sepolia", "base"] as const),
+  userOpHash: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$"),
+  calls: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
+    to: faker.helpers.fromRegExp("^0x[0-9a-fA-F]{40}$"),
+    value: faker.string.alpha(20),
+    data: faker.helpers.fromRegExp("^0x[0-9a-fA-F]*$"),
+  })),
+  status: faker.helpers.arrayElement([
+    "pending",
+    "signed",
+    "broadcast",
+    "complete",
+    "failed",
+  ] as const),
+  transactionHash: faker.helpers.arrayElement([
+    faker.helpers.fromRegExp("^0x[0-9a-fA-F]{64}$|^$"),
+    undefined,
+  ]),
+  ...overrideResponse,
+});
+
+export const getListEvmSmartAccountsMockHandler = (
+  overrideResponse?:
+    | ListEvmSmartAccounts200
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<ListEvmSmartAccounts200> | ListEvmSmartAccounts200),
+) => {
+  return http.get("*/v2/evm/smart-accounts", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getListEvmSmartAccountsResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getCreateEvmSmartAccountMockHandler = (
+  overrideResponse?:
+    | EvmSmartAccount
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<EvmSmartAccount> | EvmSmartAccount),
+) => {
+  return http.post("*/v2/evm/smart-accounts", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getCreateEvmSmartAccountResponseMock(),
+      ),
+      { status: 201, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getGetEvmSmartAccountMockHandler = (
+  overrideResponse?:
+    | EvmSmartAccount
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<EvmSmartAccount> | EvmSmartAccount),
+) => {
+  return http.get("*/v2/evm/smart-accounts/:address", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getGetEvmSmartAccountResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getPrepareUserOperationMockHandler = (
+  overrideResponse?:
+    | EvmUserOperation
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<EvmUserOperation> | EvmUserOperation),
+) => {
+  return http.post("*/v2/evm/smart-accounts/:address/user-operations", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getPrepareUserOperationResponseMock(),
+      ),
+      { status: 201, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getGetUserOperationMockHandler = (
+  overrideResponse?:
+    | EvmUserOperation
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<EvmUserOperation> | EvmUserOperation),
+) => {
+  return http.get("*/v2/evm/smart-accounts/:address/user-operations/:userOpHash", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getGetUserOperationResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getSendUserOperationMockHandler = (
+  overrideResponse?:
+    | EvmUserOperation
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<EvmUserOperation> | EvmUserOperation),
+) => {
+  return http.post(
+    "*/v2/evm/smart-accounts/:address/user-operations/:userOpHash/send",
+    async info => {
+      await delay(0);
+
+      return new HttpResponse(
+        JSON.stringify(
+          overrideResponse !== undefined
+            ? typeof overrideResponse === "function"
+              ? await overrideResponse(info)
+              : overrideResponse
+            : getSendUserOperationResponseMock(),
+        ),
+        { status: 200, headers: { "Content-Type": "application/json" } },
+      );
+    },
+  );
+};
+export const getEvmSmartAccountsMock = () => [
+  getListEvmSmartAccountsMockHandler(),
+  getCreateEvmSmartAccountMockHandler(),
+  getGetEvmSmartAccountMockHandler(),
+  getPrepareUserOperationMockHandler(),
+  getGetUserOperationMockHandler(),
+  getSendUserOperationMockHandler(),
+];

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

@@ -0,0 +1,131 @@
+/**
+ * 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 {
+  CreateEvmSmartAccountBody,
+  EvmSmartAccount,
+  EvmUserOperation,
+  ListEvmSmartAccounts200,
+  ListEvmSmartAccountsParams,
+  PrepareUserOperationBody,
+  SendUserOperationBody,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Lists the Smart Accounts belonging to the developer's CDP Project.
+The response is paginated, and by default, returns 20 accounts per page.
+ * @summary List Smart Accounts
+ */
+export const listEvmSmartAccounts = (
+  params?: ListEvmSmartAccountsParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<ListEvmSmartAccounts200>(
+    { url: `/v2/evm/smart-accounts`, method: "GET", params },
+    options,
+  );
+};
+/**
+ * Creates a new Smart Account.
+ * @summary Create a Smart Account
+ */
+export const createEvmSmartAccount = (
+  createEvmSmartAccountBody: CreateEvmSmartAccountBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmSmartAccount>(
+    {
+      url: `/v2/evm/smart-accounts`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createEvmSmartAccountBody,
+    },
+    options,
+  );
+};
+/**
+ * Gets a Smart Account by its address.
+ * @summary Get a Smart Account by address
+ */
+export const getEvmSmartAccount = (
+  address: string,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmSmartAccount>(
+    { url: `/v2/evm/smart-accounts/${address}`, method: "GET" },
+    options,
+  );
+};
+/**
+ * Prepares a new user operation on a Smart Account for a specific network.
+ * @summary Prepare a user operation
+ */
+export const prepareUserOperation = (
+  address: string,
+  prepareUserOperationBody: PrepareUserOperationBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmUserOperation>(
+    {
+      url: `/v2/evm/smart-accounts/${address}/user-operations`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: prepareUserOperationBody,
+    },
+    options,
+  );
+};
+/**
+ * Gets a user operation by its hash.
+ * @summary Get a user operation
+ */
+export const getUserOperation = (
+  address: string,
+  userOpHash: string,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmUserOperation>(
+    { url: `/v2/evm/smart-accounts/${address}/user-operations/${userOpHash}`, method: "GET" },
+    options,
+  );
+};
+/**
+ * Sends a user operation with a signature.
+ * @summary Send a user operation
+ */
+export const sendUserOperation = (
+  address: string,
+  userOpHash: string,
+  sendUserOperationBody: SendUserOperationBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<EvmUserOperation>(
+    {
+      url: `/v2/evm/smart-accounts/${address}/user-operations/${userOpHash}/send`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: sendUserOperationBody,
+    },
+    options,
+  );
+};
+export type ListEvmSmartAccountsResult = NonNullable<
+  Awaited<ReturnType<typeof listEvmSmartAccounts>>
+>;
+export type CreateEvmSmartAccountResult = NonNullable<
+  Awaited<ReturnType<typeof createEvmSmartAccount>>
+>;
+export type GetEvmSmartAccountResult = NonNullable<Awaited<ReturnType<typeof getEvmSmartAccount>>>;
+export type PrepareUserOperationResult = NonNullable<
+  Awaited<ReturnType<typeof prepareUserOperation>>
+>;
+export type GetUserOperationResult = NonNullable<Awaited<ReturnType<typeof getUserOperation>>>;
+export type SendUserOperationResult = NonNullable<Awaited<ReturnType<typeof sendUserOperation>>>;

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

@@ -0,0 +1,76 @@
+/**
+ * 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 {
+  RequestEvmFaucet200,
+  RequestSolanaFaucet200,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getRequestEvmFaucetResponseMock = (
+  overrideResponse: Partial<RequestEvmFaucet200> = {},
+): RequestEvmFaucet200 => ({ transactionHash: faker.string.alpha(20), ...overrideResponse });
+
+export const getRequestSolanaFaucetResponseMock = (
+  overrideResponse: Partial<RequestSolanaFaucet200> = {},
+): RequestSolanaFaucet200 => ({
+  transactionSignature: faker.string.alpha(20),
+  ...overrideResponse,
+});
+
+export const getRequestEvmFaucetMockHandler = (
+  overrideResponse?:
+    | RequestEvmFaucet200
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<RequestEvmFaucet200> | RequestEvmFaucet200),
+) => {
+  return http.post("*/v2/evm/faucet", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getRequestEvmFaucetResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+
+export const getRequestSolanaFaucetMockHandler = (
+  overrideResponse?:
+    | RequestSolanaFaucet200
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<RequestSolanaFaucet200> | RequestSolanaFaucet200),
+) => {
+  return http.post("*/v2/solana/faucet", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getRequestSolanaFaucetResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getFaucetsMock = () => [
+  getRequestEvmFaucetMockHandler(),
+  getRequestSolanaFaucetMockHandler(),
+];