@coinbase/cdp-sdk 1.1.2 → 1.3.0

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

@@ -0,0 +1,271 @@
+/**
+ * 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,
+  SendEvmTransaction200,
+  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 getSendEvmTransactionResponseMock = (
+  overrideResponse: Partial<SendEvmTransaction200> = {},
+): SendEvmTransaction200 => ({ transactionHash: faker.string.alpha(20), ...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 getSendEvmTransactionMockHandler = (
+  overrideResponse?:
+    | SendEvmTransaction200
+    | ((
+        info: Parameters<Parameters<typeof http.post>[1]>[0],
+      ) => Promise<SendEvmTransaction200> | SendEvmTransaction200),
+) => {
+  return http.post("*/v2/evm/accounts/:address/send/transaction", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getSendEvmTransactionResponseMock(),
+      ),
+      { 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(),
+  getSendEvmTransactionMockHandler(),
+  getSignEvmTransactionMockHandler(),
+  getSignEvmHashMockHandler(),
+  getSignEvmMessageMockHandler(),
+];

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

@@ -0,0 +1,194 @@
+/**
+ * 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,
+  SendEvmTransaction200,
+  SendEvmTransactionBody,
+  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 and sends it to the indicated supported network. This API handles nonce management and gas estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. 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).
+
+
+**Transaction fields and API behavior**
+
+- `to` *(Required)*: The address of the contract or account to send the transaction to.
+- `chainId` *(Ignored)*: The value of the `chainId` field in the transaction is ignored.
+  The transaction will be sent to the network indicated by the `network` field in the request body.
+
+- `nonce` *(Optional)*: The nonce to use for the transaction. If not provided, the API will assign
+   a nonce to the transaction based on the current state of the account.
+
+- `maxPriorityFeePerGas` *(Optional)*: The maximum priority fee per gas to use for the transaction.
+   If not provided, the API will estimate a value based on current network conditions.
+
+- `maxFeePerGas` *(Optional)*: The maximum fee per gas to use for the transaction.
+   If not provided, the API will estimate a value based on current network conditions.
+
+- `gasLimit` *(Optional)*: The gas limit to use for the transaction. If not provided, the API will estimate a value
+  based on the `to` and `data` fields of the transaction.
+
+- `value` *(Optional)*: The amount of ETH, in wei, to send with the transaction.
+- `data` *(Optional)*: The data to send with the transaction; only used for contract calls.
+- `accessList` *(Optional)*: The access list to use for the transaction.
+ * @summary Send a transaction
+ */
+export const sendEvmTransaction = (
+  address: string,
+  sendEvmTransactionBody: SendEvmTransactionBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<SendEvmTransaction200>(
+    {
+      url: `/v2/evm/accounts/${address}/send/transaction`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: sendEvmTransactionBody,
+    },
+    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.
+ * @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 SendEvmTransactionResult = NonNullable<Awaited<ReturnType<typeof sendEvmTransaction>>>;
+export type SignEvmTransactionResult = NonNullable<Awaited<ReturnType<typeof signEvmTransaction>>>;
+export type SignEvmHashResult = NonNullable<Awaited<ReturnType<typeof signEvmHash>>>;
+export type SignEvmMessageResult = NonNullable<Awaited<ReturnType<typeof signEvmMessage>>>;