@distilled.cloud/coinbase 0.0.0 → 0.2.5-alpha2

package/src/operations/prepareAndSendUserOperation.ts

@@ -0,0 +1,113 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const PrepareAndSendUserOperationInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    address: Schema.String.pipe(T.PathParam()),
+    network: Schema.Literals([
+      "base-sepolia",
+      "base",
+      "arbitrum",
+      "optimism",
+      "zora",
+      "polygon",
+      "bnb",
+      "avalanche",
+      "ethereum",
+      "ethereum-sepolia",
+    ]),
+    calls: Schema.Array(
+      Schema.Struct({
+        to: Schema.String,
+        value: Schema.String,
+        data: Schema.String,
+        overrideGasLimit: Schema.optional(Schema.String),
+      }),
+    ),
+    paymasterUrl: Schema.optional(Schema.Struct({})),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/v2/evm/smart-accounts/{address}/user-operations/prepare-and-send",
+    }),
+  );
+export type PrepareAndSendUserOperationInput =
+  typeof PrepareAndSendUserOperationInput.Type;
+
+// Output Schema
+export const PrepareAndSendUserOperationOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    network: Schema.Literals([
+      "base-sepolia",
+      "base",
+      "arbitrum",
+      "optimism",
+      "zora",
+      "polygon",
+      "bnb",
+      "avalanche",
+      "ethereum",
+      "ethereum-sepolia",
+    ]),
+    userOpHash: Schema.String,
+    calls: Schema.Array(
+      Schema.Struct({
+        to: Schema.String,
+        value: Schema.String,
+        data: Schema.String,
+        overrideGasLimit: Schema.optional(Schema.String),
+      }),
+    ),
+    status: Schema.Literals([
+      "pending",
+      "signed",
+      "broadcast",
+      "complete",
+      "dropped",
+      "failed",
+    ]),
+    transactionHash: Schema.optional(Schema.String),
+    receipts: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          revert: Schema.optional(
+            Schema.Struct({
+              data: Schema.String,
+              message: Schema.String,
+            }),
+          ),
+          transactionHash: Schema.optional(Schema.String),
+          blockHash: Schema.optional(Schema.String),
+          blockNumber: Schema.optional(Schema.Number),
+          gasUsed: Schema.optional(Schema.String),
+        }),
+      ),
+    ),
+  });
+export type PrepareAndSendUserOperationOutput =
+  typeof PrepareAndSendUserOperationOutput.Type;
+
+// The operation
+/**
+ * Prepare and send a user operation for EVM Smart Account
+ *
+ * Prepares, signs, and sends a user operation for an EVM Smart Account. This API can be used only if the owner on Smart Account is a CDP EVM Account.
+ *
+ * @param X-Idempotency-Key - An optional string 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-reference/v2/idempotency) for more information on using idempotency keys.
+
+ * @param X-Wallet-Auth - A JWT signed using your Wallet Secret, encoded in base64. Refer to the
+[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
+section of our Authentication docs for more details on how to generate your Wallet Token.
+
+ * @param address - The address of the EVM Smart Account to execute the user operation from.
+ */
+export const prepareAndSendUserOperation = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: PrepareAndSendUserOperationInput,
+    outputSchema: PrepareAndSendUserOperationOutput,
+  }),
+);

package/src/operations/prepareUserOperation.ts

@@ -0,0 +1,104 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const PrepareUserOperationInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    address: Schema.String.pipe(T.PathParam()),
+    network: Schema.Literals([
+      "base-sepolia",
+      "base",
+      "arbitrum",
+      "optimism",
+      "zora",
+      "polygon",
+      "bnb",
+      "avalanche",
+      "ethereum",
+      "ethereum-sepolia",
+    ]),
+    calls: Schema.Array(
+      Schema.Struct({
+        to: Schema.String,
+        value: Schema.String,
+        data: Schema.String,
+        overrideGasLimit: Schema.optional(Schema.String),
+      }),
+    ),
+    paymasterUrl: Schema.optional(Schema.Struct({})),
+    dataSuffix: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/v2/evm/smart-accounts/{address}/user-operations",
+    }),
+  );
+export type PrepareUserOperationInput = typeof PrepareUserOperationInput.Type;
+
+// Output Schema
+export const PrepareUserOperationOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    network: Schema.Literals([
+      "base-sepolia",
+      "base",
+      "arbitrum",
+      "optimism",
+      "zora",
+      "polygon",
+      "bnb",
+      "avalanche",
+      "ethereum",
+      "ethereum-sepolia",
+    ]),
+    userOpHash: Schema.String,
+    calls: Schema.Array(
+      Schema.Struct({
+        to: Schema.String,
+        value: Schema.String,
+        data: Schema.String,
+        overrideGasLimit: Schema.optional(Schema.String),
+      }),
+    ),
+    status: Schema.Literals([
+      "pending",
+      "signed",
+      "broadcast",
+      "complete",
+      "dropped",
+      "failed",
+    ]),
+    transactionHash: Schema.optional(Schema.String),
+    receipts: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          revert: Schema.optional(
+            Schema.Struct({
+              data: Schema.String,
+              message: Schema.String,
+            }),
+          ),
+          transactionHash: Schema.optional(Schema.String),
+          blockHash: Schema.optional(Schema.String),
+          blockNumber: Schema.optional(Schema.Number),
+          gasUsed: Schema.optional(Schema.String),
+        }),
+      ),
+    ),
+  });
+export type PrepareUserOperationOutput = typeof PrepareUserOperationOutput.Type;
+
+// The operation
+/**
+ * Prepare a user operation
+ *
+ * Prepares a new user operation on a Smart Account for a specific network.
+ *
+ * @param address - The address of the Smart Account to create the user operation on.
+ */
+export const prepareUserOperation = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: PrepareUserOperationInput,
+    outputSchema: PrepareUserOperationOutput,
+  }),
+);

package/src/operations/requestEvmFaucet.ts

@@ -0,0 +1,38 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RequestEvmFaucetInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  network: Schema.Literals([
+    "base-sepolia",
+    "ethereum-sepolia",
+    "ethereum-hoodi",
+  ]),
+  address: Schema.String,
+  token: Schema.Literals(["eth", "usdc", "eurc", "cbbtc"]),
+}).pipe(T.Http({ method: "POST", path: "/v2/evm/faucet" }));
+export type RequestEvmFaucetInput = typeof RequestEvmFaucetInput.Type;
+
+// Output Schema
+export const RequestEvmFaucetOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    transactionHash: Schema.String,
+  },
+);
+export type RequestEvmFaucetOutput = typeof RequestEvmFaucetOutput.Type;
+
+// The operation
+/**
+ * Request funds on EVM test networks
+ *
+ * Request funds from the CDP Faucet on supported EVM test networks.
+ * Faucets are available for ETH, USDC, EURC, and cbBTC on Base Sepolia and Ethereum Sepolia, and for ETH only on Ethereum Hoodi.
+ * To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested.
+ * These limits are applied at both the CDP User level and the blockchain address level.
+ * A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address.
+ */
+export const requestEvmFaucet = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RequestEvmFaucetInput,
+  outputSchema: RequestEvmFaucetOutput,
+}));

package/src/operations/requestSolanaFaucet.ts

@@ -0,0 +1,33 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RequestSolanaFaucetInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    address: Schema.String,
+    token: Schema.Literals(["sol", "usdc"]),
+  }).pipe(T.Http({ method: "POST", path: "/v2/solana/faucet" }));
+export type RequestSolanaFaucetInput = typeof RequestSolanaFaucetInput.Type;
+
+// Output Schema
+export const RequestSolanaFaucetOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    transactionSignature: Schema.String,
+  });
+export type RequestSolanaFaucetOutput = typeof RequestSolanaFaucetOutput.Type;
+
+// The operation
+/**
+ * Request funds on Solana devnet
+ *
+ * Request funds from the CDP Faucet on Solana devnet.
+ * Faucets are available for SOL.
+ * To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested.
+ * These limits are applied at both the CDP Project level and the blockchain address level.
+ * A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address.
+ */
+export const requestSolanaFaucet = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RequestSolanaFaucetInput,
+  outputSchema: RequestSolanaFaucetOutput,
+}));

package/src/operations/revokeSpendPermission.ts

@@ -0,0 +1,103 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RevokeSpendPermissionInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    address: Schema.String.pipe(T.PathParam()),
+    network: Schema.Literals([
+      "base",
+      "base-sepolia",
+      "ethereum",
+      "ethereum-sepolia",
+      "optimism",
+      "arbitrum",
+      "avalanche",
+      "polygon",
+    ]),
+    permissionHash: Schema.String,
+    paymasterUrl: Schema.optional(Schema.Struct({})),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/v2/evm/smart-accounts/{address}/spend-permissions/revoke",
+    }),
+  );
+export type RevokeSpendPermissionInput = typeof RevokeSpendPermissionInput.Type;
+
+// Output Schema
+export const RevokeSpendPermissionOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    network: Schema.Literals([
+      "base-sepolia",
+      "base",
+      "arbitrum",
+      "optimism",
+      "zora",
+      "polygon",
+      "bnb",
+      "avalanche",
+      "ethereum",
+      "ethereum-sepolia",
+    ]),
+    userOpHash: Schema.String,
+    calls: Schema.Array(
+      Schema.Struct({
+        to: Schema.String,
+        value: Schema.String,
+        data: Schema.String,
+        overrideGasLimit: Schema.optional(Schema.String),
+      }),
+    ),
+    status: Schema.Literals([
+      "pending",
+      "signed",
+      "broadcast",
+      "complete",
+      "dropped",
+      "failed",
+    ]),
+    transactionHash: Schema.optional(Schema.String),
+    receipts: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          revert: Schema.optional(
+            Schema.Struct({
+              data: Schema.String,
+              message: Schema.String,
+            }),
+          ),
+          transactionHash: Schema.optional(Schema.String),
+          blockHash: Schema.optional(Schema.String),
+          blockNumber: Schema.optional(Schema.Number),
+          gasUsed: Schema.optional(Schema.String),
+        }),
+      ),
+    ),
+  });
+export type RevokeSpendPermissionOutput =
+  typeof RevokeSpendPermissionOutput.Type;
+
+// The operation
+/**
+ * Revoke a spend permission
+ *
+ * Revokes an existing spend permission.
+ *
+ * @param X-Wallet-Auth - A JWT signed using your Wallet Secret, encoded in base64. Refer to the
+[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
+section of our Authentication docs for more details on how to generate your Wallet Token.
+
+ * @param X-Idempotency-Key - An optional string 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-reference/v2/idempotency) for more information on using idempotency keys.
+
+ * @param address - The address of the Smart account this spend permission is valid for.
+ */
+export const revokeSpendPermission = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RevokeSpendPermissionInput,
+    outputSchema: RevokeSpendPermissionOutput,
+  }),
+);

package/src/operations/runSQLQuery.ts

@@ -0,0 +1,92 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RunSQLQueryInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  sql: Schema.String,
+  cache: Schema.optional(
+    Schema.Struct({
+      maxAgeMs: Schema.optional(Schema.Number),
+    }),
+  ),
+}).pipe(T.Http({ method: "POST", path: "/v2/data/query/run" }));
+export type RunSQLQueryInput = typeof RunSQLQueryInput.Type;
+
+// Output Schema
+export const RunSQLQueryOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  result: Schema.optional(
+    Schema.Array(Schema.Record(Schema.String, Schema.Unknown)),
+  ),
+  schema: Schema.optional(
+    Schema.Struct({
+      columns: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            name: Schema.optional(Schema.String),
+            type: Schema.optional(
+              Schema.Literals([
+                "String",
+                "UInt8",
+                "UInt16",
+                "UInt32",
+                "UInt64",
+                "UInt128",
+                "UInt256",
+                "Int8",
+                "Int16",
+                "Int32",
+                "Int64",
+                "Int128",
+                "Int256",
+                "Float32",
+                "Float64",
+                "Bool",
+                "Date",
+                "DateTime",
+                "DateTime64",
+                "UUID",
+              ]),
+            ),
+          }),
+        ),
+      ),
+    }),
+  ),
+  metadata: Schema.optional(
+    Schema.Struct({
+      cached: Schema.optional(Schema.Boolean),
+      executionTimestamp: Schema.optional(Schema.String),
+      executionTimeMs: Schema.optional(Schema.Number),
+      rowCount: Schema.optional(Schema.Number),
+    }),
+  ),
+});
+export type RunSQLQueryOutput = typeof RunSQLQueryOutput.Type;
+
+// The operation
+/**
+ * Run SQL Query
+ *
+ * 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: 100,000 rows
+ * - Query timeout: 30 seconds
+ */
+export const runSQLQuery = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RunSQLQueryInput,
+  outputSchema: RunSQLQueryOutput,
+}));

package/src/operations/sendEvmTransaction.ts

@@ -0,0 +1,70 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const SendEvmTransactionInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    address: Schema.String.pipe(T.PathParam()),
+    network: Schema.Literals([
+      "base",
+      "base-sepolia",
+      "ethereum",
+      "ethereum-sepolia",
+      "avalanche",
+      "polygon",
+      "optimism",
+      "arbitrum",
+    ]),
+    transaction: Schema.String,
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/v2/evm/accounts/{address}/send/transaction",
+    }),
+  );
+export type SendEvmTransactionInput = typeof SendEvmTransactionInput.Type;
+
+// Output Schema
+export const SendEvmTransactionOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    transactionHash: Schema.String,
+  });
+export type SendEvmTransactionOutput = typeof SendEvmTransactionOutput.Type;
+
+// The operation
+/**
+ * Send a transaction
+ *
+ * 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.
+ *
+ * @param X-Wallet-Auth - A JWT signed using your Wallet Secret, encoded in base64. Refer to the
+[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
+section of our Authentication docs for more details on how to generate your Wallet Token.
+
+ * @param X-Idempotency-Key - An optional string 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-reference/v2/idempotency) for more information on using idempotency keys.
+
+ * @param address - The 0x-prefixed address of the Ethereum account.
+ */
+export const sendEvmTransaction = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: SendEvmTransactionInput,
+  outputSchema: SendEvmTransactionOutput,
+}));

package/src/operations/sendSolanaTransaction.ts

@@ -0,0 +1,55 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const SendSolanaTransactionInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    network: Schema.Literals(["solana", "solana-devnet"]),
+    transaction: Schema.String,
+  }).pipe(
+    T.Http({ method: "POST", path: "/v2/solana/accounts/send/transaction" }),
+  );
+export type SendSolanaTransactionInput = typeof SendSolanaTransactionInput.Type;
+
+// Output Schema
+export const SendSolanaTransactionOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    transactionSignature: Schema.String,
+  });
+export type SendSolanaTransactionOutput =
+  typeof SendSolanaTransactionOutput.Type;
+
+// The operation
+/**
+ * Send a Solana transaction
+ *
+ * Signs and sends a single Solana transaction using multiple Solana accounts. The transaction may contain contain several instructions, each of which may require signatures from different account keys.
+ * The transaction should be serialized into a byte array and base64 encoded. The API handles recent blockhash management and fee estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction.
+ * **Transaction types**
+ * The following transaction types are supported:
+ * * [Legacy transactions](https://solana.com/developers/guides/advanced/versions#current-transaction-versions)
+ * * [Versioned transactions](https://solana.com/developers/guides/advanced/versions)
+ * **Instruction Batching**
+ * To batch multiple operations, include multiple instructions within a single transaction. All instructions within a transaction are executed atomically - if any instruction fails, the entire transaction fails and is rolled back.
+ * **Network Support**
+ * The following Solana networks are supported:
+ * * `solana` - Solana Mainnet
+ * * `solana-devnet` - Solana Devnet
+ * The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
+ *
+ * @param X-Wallet-Auth - A JWT signed using your Wallet Secret, encoded in base64. Refer to the
+[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
+section of our Authentication docs for more details on how to generate your Wallet Token.
+
+ * @param X-Idempotency-Key - An optional string 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-reference/v2/idempotency) for more information on using idempotency keys.
+
+ */
+export const sendSolanaTransaction = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: SendSolanaTransactionInput,
+    outputSchema: SendSolanaTransactionOutput,
+  }),
+);