@distilled.cloud/coinbase 0.27.0 → 0.28.0

package/src/operations/prepareUserOperation.ts

@@ -3,6 +3,29 @@ import { API } from "../client.ts";
 import * as T from "../traits.ts";
 
 // Input Schema
+export interface PrepareUserOperationInput {
+  address: string;
+  network:
+    | "base-sepolia"
+    | "base"
+    | "arbitrum"
+    | "optimism"
+    | "zora"
+    | "polygon"
+    | "bnb"
+    | "avalanche"
+    | "ethereum"
+    | "ethereum-sepolia";
+  calls: {
+    to: string;
+    value: string;
+    data: string;
+    overrideGasLimit?: string;
+  }[];
+  paymasterUrl?: string;
+  paymasterContext?: Record<string, unknown>;
+  dataSuffix?: string;
+}
 export const PrepareUserOperationInput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     address: Schema.String.pipe(T.PathParam()),
@@ -27,16 +50,54 @@ export const PrepareUserOperationInput =
       }),
     ),
     paymasterUrl: Schema.optional(Schema.String),
+    paymasterContext: Schema.optional(
+      Schema.Record(Schema.String, Schema.Unknown),
+    ),
     dataSuffix: Schema.optional(Schema.String),
   }).pipe(
     T.Http({
       method: "POST",
       path: "/v2/evm/smart-accounts/{address}/user-operations",
     }),
-  );
-export type PrepareUserOperationInput = typeof PrepareUserOperationInput.Type;
+  ) as unknown as Schema.Codec<PrepareUserOperationInput>;
 
 // Output Schema
+export interface PrepareUserOperationOutput {
+  network:
+    | "base-sepolia"
+    | "base"
+    | "arbitrum"
+    | "optimism"
+    | "zora"
+    | "polygon"
+    | "bnb"
+    | "avalanche"
+    | "ethereum"
+    | "ethereum-sepolia";
+  userOpHash: string;
+  calls: {
+    to: string;
+    value: string;
+    data: string;
+    overrideGasLimit?: string;
+  }[];
+  status:
+    | "pending"
+    | "signed"
+    | "broadcast"
+    | "complete"
+    | "dropped"
+    | "failed";
+  transactionHash?: string;
+  receipts?: {
+    revert?: { data: string; message: string };
+    transactionHash?: string;
+    blockHash?: string;
+    blockNumber?: number;
+    gasUsed?: string;
+  }[];
+  expiresAt?: string;
+}
 export const PrepareUserOperationOutput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     network: Schema.Literals([
@@ -85,12 +146,12 @@ export const PrepareUserOperationOutput =
         }),
       ),
     ),
-  });
-export type PrepareUserOperationOutput = typeof PrepareUserOperationOutput.Type;
+    expiresAt: Schema.optional(Schema.String),
+  }) as unknown as Schema.Codec<PrepareUserOperationOutput>;
 
 // The operation
 /**
- * Prepare a user operation
+ * Prepare user operation
  *
  * Prepares a new user operation on a Smart Account for a specific network.
  *

package/src/operations/requestEvmFaucet.ts

@@ -3,6 +3,11 @@ import { API } from "../client.ts";
 import * as T from "../traits.ts";
 
 // Input Schema
+export interface RequestEvmFaucetInput {
+  network: "base-sepolia" | "ethereum-sepolia" | "ethereum-hoodi";
+  address: string;
+  token: "eth" | "usdc" | "eurc" | "cbbtc";
+}
 export const RequestEvmFaucetInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
   network: Schema.Literals([
     "base-sepolia",
@@ -11,16 +16,19 @@ export const RequestEvmFaucetInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
   ]),
   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;
+}).pipe(
+  T.Http({ method: "POST", path: "/v2/evm/faucet" }),
+) as unknown as Schema.Codec<RequestEvmFaucetInput>;
 
 // Output Schema
+export interface RequestEvmFaucetOutput {
+  transactionHash: string;
+}
 export const RequestEvmFaucetOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
   {
     transactionHash: Schema.String,
   },
-);
-export type RequestEvmFaucetOutput = typeof RequestEvmFaucetOutput.Type;
+) as unknown as Schema.Codec<RequestEvmFaucetOutput>;
 
 // The operation
 /**

package/src/operations/requestLimitsUpgrade.ts

@@ -0,0 +1,56 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export interface RequestLimitsUpgradeInput {
+  userId: string;
+  userIdType: "phone_number";
+  fields?: {
+    ssnLast4?: string;
+    dateOfBirth?: { day?: string; month?: string; year?: string };
+  };
+}
+export const RequestLimitsUpgradeInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    userId: Schema.String,
+    userIdType: Schema.Literals(["phone_number"]),
+    fields: Schema.optional(
+      Schema.Struct({
+        ssnLast4: Schema.optional(Schema.String),
+        dateOfBirth: Schema.optional(
+          Schema.Struct({
+            day: Schema.optional(Schema.String),
+            month: Schema.optional(Schema.String),
+            year: Schema.optional(Schema.String),
+          }),
+        ),
+      }),
+    ),
+  }).pipe(
+    T.Http({ method: "POST", path: "/v2/onramp/limits/upgrade" }),
+  ) as unknown as Schema.Codec<RequestLimitsUpgradeInput>;
+
+// Output Schema
+export type RequestLimitsUpgradeOutput = void;
+export const RequestLimitsUpgradeOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void as unknown as Schema.Codec<RequestLimitsUpgradeOutput>;
+
+// The operation
+/**
+ * Request limit upgrade
+ *
+ * Requests a limit upgrade for an onramp user by submitting identity information. Only phone number is currently supported as a userId.
+ * The verification process is asynchronous. After calling this endpoint, use the [Get Onramp User Limits](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/onramp/get-onramp-user-limits) endpoint to check the status in the `limitUpgradeOptions` array.
+ * **Prerequisites:**
+ * - The phone number must have been previously verified by your app via OTP. - Upgrades may not be available until a certain number of successful transactions by the user.
+ * **Supported fields:**
+ * - `ssnLast4`: Last 4 digits of the Social Security Number (no dashes or spaces).
+ * - `dateOfBirth`: Date of birth (day, month, year as zero-padded strings).
+ */
+export const requestLimitsUpgrade = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RequestLimitsUpgradeInput,
+    outputSchema: RequestLimitsUpgradeOutput,
+  }),
+);

package/src/operations/requestSolanaFaucet.ts

@@ -3,19 +3,26 @@ import { API } from "../client.ts";
 import * as T from "../traits.ts";
 
 // Input Schema
+export interface RequestSolanaFaucetInput {
+  address: string;
+  token: "sol" | "usdc" | "cbtusd";
+}
 export const RequestSolanaFaucetInput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     address: Schema.String,
     token: Schema.Literals(["sol", "usdc", "cbtusd"]),
-  }).pipe(T.Http({ method: "POST", path: "/v2/solana/faucet" }));
-export type RequestSolanaFaucetInput = typeof RequestSolanaFaucetInput.Type;
+  }).pipe(
+    T.Http({ method: "POST", path: "/v2/solana/faucet" }),
+  ) as unknown as Schema.Codec<RequestSolanaFaucetInput>;
 
 // Output Schema
+export interface RequestSolanaFaucetOutput {
+  transactionSignature: string;
+}
 export const RequestSolanaFaucetOutput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     transactionSignature: Schema.String,
-  });
-export type RequestSolanaFaucetOutput = typeof RequestSolanaFaucetOutput.Type;
+  }) as unknown as Schema.Codec<RequestSolanaFaucetOutput>;
 
 // The operation
 /**

package/src/operations/revokeDelegationForEndUser.ts

@@ -3,24 +3,27 @@ import { API } from "../client.ts";
 import * as T from "../traits.ts";
 
 // Input Schema
+export interface RevokeDelegationForEndUserInput {
+  userId: string;
+  projectID?: string;
+  walletSecretId?: string;
+}
 export const RevokeDelegationForEndUserInput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     userId: Schema.String.pipe(T.PathParam()),
+    projectID: Schema.optional(Schema.String),
     walletSecretId: Schema.optional(Schema.String),
   }).pipe(
     T.Http({
       method: "DELETE",
       path: "/v2/embedded-wallet-api/end-users/{userId}/delegation",
     }),
-  );
-export type RevokeDelegationForEndUserInput =
-  typeof RevokeDelegationForEndUserInput.Type;
+  ) as unknown as Schema.Codec<RevokeDelegationForEndUserInput>;
 
 // Output Schema
+export type RevokeDelegationForEndUserOutput = void;
 export const RevokeDelegationForEndUserOutput =
-  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
-export type RevokeDelegationForEndUserOutput =
-  typeof RevokeDelegationForEndUserOutput.Type;
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void as unknown as Schema.Codec<RevokeDelegationForEndUserOutput>;
 
 // The operation
 /**
@@ -41,6 +44,7 @@ When included, duplicate requests with the same key will return identical respon
 Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
 
  * @param userId - The ID of the end user.
+ * @param projectID - The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
  */
 export const revokeDelegationForEndUser = /*@__PURE__*/ /*#__PURE__*/ API.make(
   () => ({

package/src/operations/revokeDelegationForEndUserAccount.ts

@@ -0,0 +1,57 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export interface RevokeDelegationForEndUserAccountInput {
+  userId: string;
+  address: string;
+  projectID?: string;
+  walletSecretId?: string;
+}
+export const RevokeDelegationForEndUserAccountInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    userId: Schema.String.pipe(T.PathParam()),
+    address: Schema.String.pipe(T.PathParam()),
+    projectID: Schema.optional(Schema.String),
+    walletSecretId: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/v2/embedded-wallet-api/end-users/{userId}/address/{address}/delegation",
+    }),
+  ) as unknown as Schema.Codec<RevokeDelegationForEndUserAccountInput>;
+
+// Output Schema
+export type RevokeDelegationForEndUserAccountOutput = void;
+export const RevokeDelegationForEndUserAccountOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void as unknown as Schema.Codec<RevokeDelegationForEndUserAccountOutput>;
+
+// The operation
+/**
+ * Revoke account-scoped delegation for end user
+ *
+ * Revokes the active account-scoped delegation for the specified end user account. Other account-scoped delegations for the same user are unaffected. This operation can be performed by the end user themselves or by a developer using their API key.
+ * When the address corresponds to an EVM Smart Account, this revokes the delegation for the Smart Account's owner EOA.
+ *
+ * @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-Developer-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 userId - The ID of the end user.
+ * @param address - The blockchain address of the end user account whose delegation should be revoked. For EVM addresses, matching is case-insensitive.
+ * @param projectID - The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
+ */
+export const revokeDelegationForEndUserAccount =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: RevokeDelegationForEndUserAccountInput,
+    outputSchema: RevokeDelegationForEndUserAccountOutput,
+  }));

package/src/operations/revokeSpendPermission.ts

@@ -3,6 +3,20 @@ import { API } from "../client.ts";
 import * as T from "../traits.ts";
 
 // Input Schema
+export interface RevokeSpendPermissionInput {
+  address: string;
+  network:
+    | "base"
+    | "base-sepolia"
+    | "ethereum"
+    | "ethereum-sepolia"
+    | "optimism"
+    | "arbitrum"
+    | "avalanche"
+    | "polygon";
+  permissionHash: string;
+  paymasterUrl?: string;
+}
 export const RevokeSpendPermissionInput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     address: Schema.String.pipe(T.PathParam()),
@@ -23,10 +37,45 @@ export const RevokeSpendPermissionInput =
       method: "POST",
       path: "/v2/evm/smart-accounts/{address}/spend-permissions/revoke",
     }),
-  );
-export type RevokeSpendPermissionInput = typeof RevokeSpendPermissionInput.Type;
+  ) as unknown as Schema.Codec<RevokeSpendPermissionInput>;
 
 // Output Schema
+export interface RevokeSpendPermissionOutput {
+  network:
+    | "base-sepolia"
+    | "base"
+    | "arbitrum"
+    | "optimism"
+    | "zora"
+    | "polygon"
+    | "bnb"
+    | "avalanche"
+    | "ethereum"
+    | "ethereum-sepolia";
+  userOpHash: string;
+  calls: {
+    to: string;
+    value: string;
+    data: string;
+    overrideGasLimit?: string;
+  }[];
+  status:
+    | "pending"
+    | "signed"
+    | "broadcast"
+    | "complete"
+    | "dropped"
+    | "failed";
+  transactionHash?: string;
+  receipts?: {
+    revert?: { data: string; message: string };
+    transactionHash?: string;
+    blockHash?: string;
+    blockNumber?: number;
+    gasUsed?: string;
+  }[];
+  expiresAt?: string;
+}
 export const RevokeSpendPermissionOutput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     network: Schema.Literals([
@@ -75,13 +124,12 @@ export const RevokeSpendPermissionOutput =
         }),
       ),
     ),
-  });
-export type RevokeSpendPermissionOutput =
-  typeof RevokeSpendPermissionOutput.Type;
+    expiresAt: Schema.optional(Schema.String),
+  }) as unknown as Schema.Codec<RevokeSpendPermissionOutput>;
 
 // The operation
 /**
- * Revoke a spend permission
+ * Revoke spend permission
  *
  * Revokes an existing spend permission.
  *

package/src/operations/runSQLQuery.ts

@@ -3,6 +3,10 @@ import { API } from "../client.ts";
 import * as T from "../traits.ts";
 
 // Input Schema
+export interface RunSQLQueryInput {
+  sql: string;
+  cache?: { maxAgeMs?: number };
+}
 export const RunSQLQueryInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
   sql: Schema.String,
   cache: Schema.optional(
@@ -10,10 +14,46 @@ export const RunSQLQueryInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
       maxAgeMs: Schema.optional(Schema.Number),
     }),
   ),
-}).pipe(T.Http({ method: "POST", path: "/v2/data/query/run" }));
-export type RunSQLQueryInput = typeof RunSQLQueryInput.Type;
+}).pipe(
+  T.Http({ method: "POST", path: "/v2/data/query/run" }),
+) as unknown as Schema.Codec<RunSQLQueryInput>;
 
 // Output Schema
+export interface RunSQLQueryOutput {
+  result?: Record<string, unknown>[];
+  schema?: {
+    columns?: {
+      name?: string;
+      type?:
+        | "String"
+        | "UInt8"
+        | "UInt16"
+        | "UInt32"
+        | "UInt64"
+        | "UInt128"
+        | "UInt256"
+        | "Int8"
+        | "Int16"
+        | "Int32"
+        | "Int64"
+        | "Int128"
+        | "Int256"
+        | "Float32"
+        | "Float64"
+        | "Bool"
+        | "Date"
+        | "DateTime"
+        | "DateTime64"
+        | "UUID";
+    }[];
+  };
+  metadata?: {
+    cached?: boolean;
+    executionTimestamp?: string;
+    executionTimeMs?: number;
+    rowCount?: number;
+  };
+}
 export const RunSQLQueryOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
   result: Schema.optional(
     Schema.Array(Schema.Record(Schema.String, Schema.Unknown)),
@@ -61,8 +101,7 @@ export const RunSQLQueryOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
       rowCount: Schema.optional(Schema.Number),
     }),
   ),
-});
-export type RunSQLQueryOutput = typeof RunSQLQueryOutput.Type;
+}) as unknown as Schema.Codec<RunSQLQueryOutput>;
 
 // The operation
 /**
@@ -76,17 +115,15 @@ export type RunSQLQueryOutput = typeof RunSQLQueryOutput.Type;
  * - Read-only queries (SELECT statements)
  * - No DDL or DML operations
  * - Query that follow limits (defined below)
- * ### Supported Tables
- * - `<network>.events` - Base mainnet decoded event logs with parameters, event signature, topics, and more.
- * - `<network>.transactions` - Base mainnet transaction data including hash, block number, gas usage.
- * - `<network>.blocks` - Base mainnet block information.
- * - `<network>.encoded_logs` - Encoded log data of event logs that aren't able to be decoded by our event decoder (ex: log0 opcode).
- * - `<network>.decoded_user_operations` - Decoded user operations data including hash, block number, gas usage, builder codes, entrypoint version, and more.
- * - `<network>.transaction_attributions` - Information about the attributions of a transaction to a builder and associated builder codes.
  * ### Supported Networks
  * - Base Mainnet: `base`
  * - Base Sepolia: `base_sepolia`
- * So for example, valid tables are: `base.events`, `base_sepolia.events`, `base.transactions`, etc.
+ * - Solana Mainnet: `solana`
+ * - Hyperevm Mainnet: `hyperevm`
+ * ### Supported Tables
+ * The below tables are supported for `base` and `base_sepolia` networks.
+ * Following the above, the valid tables on Base Mainnet are `base.events`, `base.transactions`, `base.blocks`, `base.encoded_logs`, `base.decoded_user_operations`, and `base.transaction_attributions`.
+ * Separately, there is a limited set of tables supported for `solana` and `hyperevm` networks:
  * ### Query Limits
  * - Maximum result set: 50,000 rows
  * - Maximum query length: 10,000 characters