@distilled.cloud/coinbase 0.27.0 → 0.28.1

package/src/operations/createTransfer.ts

@@ -0,0 +1,461 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export interface CreateTransferInput {
+  source:
+    | { accountId: string; asset: string }
+    | { paymentMethodId: string; asset: string };
+  target:
+    | { accountId: string; asset: string }
+    | { paymentMethodId: string; asset: string }
+    | {
+        address: string;
+        network:
+          | "base"
+          | "ethereum"
+          | "solana"
+          | "aptos"
+          | "arbitrum"
+          | "arbitrum-sepolia"
+          | "optimism"
+          | "polygon"
+          | "world"
+          | "world-sepolia";
+        destinationTag?: string;
+        asset: string;
+      }
+    | { email: string; asset: string };
+  amount: string;
+  asset: string;
+  amountType?: "target" | "source";
+  validateOnly?: boolean;
+  execute: boolean;
+  metadata?: Record<string, string>;
+  travelRule?: {
+    isSelf?: boolean;
+    isIntermediary?: boolean;
+    originator?: {
+      financialInstitution?: string;
+      name?: string;
+      address?: {
+        line1?: string;
+        line2?: string;
+        city?: string;
+        state?: string;
+        postCode?: string;
+        countryCode?: string;
+      };
+      virtualAssetServiceProvider?: {
+        name?: string;
+        address?: {
+          line1?: string;
+          line2?: string;
+          city?: string;
+          state?: string;
+          postCode?: string;
+          countryCode?: string;
+        };
+        identifier?: string;
+      };
+      personalId?: string;
+      dateOfBirth?: { day?: string; month?: string; year?: string };
+    };
+    beneficiary?: {
+      financialInstitution?: string;
+      name?: string;
+      address?: {
+        line1?: string;
+        line2?: string;
+        city?: string;
+        state?: string;
+        postCode?: string;
+        countryCode?: string;
+      };
+      walletType?: "custodial" | "self_custody";
+    };
+  };
+}
+export const CreateTransferInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  source: Schema.Union([
+    Schema.Struct({
+      accountId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      paymentMethodId: Schema.String,
+      asset: Schema.String,
+    }),
+  ]),
+  target: Schema.Union([
+    Schema.Struct({
+      accountId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      paymentMethodId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      address: Schema.String,
+      network: Schema.Literals([
+        "base",
+        "ethereum",
+        "solana",
+        "aptos",
+        "arbitrum",
+        "arbitrum-sepolia",
+        "optimism",
+        "polygon",
+        "world",
+        "world-sepolia",
+      ]),
+      destinationTag: Schema.optional(Schema.String),
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      email: Schema.String,
+      asset: Schema.String,
+    }),
+  ]),
+  amount: Schema.String,
+  asset: Schema.String,
+  amountType: Schema.optional(Schema.Literals(["target", "source"])),
+  validateOnly: Schema.optional(Schema.Boolean),
+  execute: Schema.Boolean,
+  metadata: Schema.optional(Schema.Record(Schema.String, Schema.String)),
+  travelRule: Schema.optional(
+    Schema.Struct({
+      isSelf: Schema.optional(Schema.Boolean),
+      isIntermediary: Schema.optional(Schema.Boolean),
+      originator: Schema.optional(
+        Schema.Struct({
+          financialInstitution: Schema.optional(Schema.String),
+          name: Schema.optional(Schema.String),
+          address: Schema.optional(
+            Schema.Struct({
+              line1: Schema.optional(Schema.String),
+              line2: Schema.optional(Schema.String),
+              city: Schema.optional(Schema.String),
+              state: Schema.optional(Schema.String),
+              postCode: Schema.optional(Schema.String),
+              countryCode: Schema.optional(Schema.String),
+            }),
+          ),
+          virtualAssetServiceProvider: Schema.optional(
+            Schema.Struct({
+              name: Schema.optional(Schema.String),
+              address: Schema.optional(
+                Schema.Struct({
+                  line1: Schema.optional(Schema.String),
+                  line2: Schema.optional(Schema.String),
+                  city: Schema.optional(Schema.String),
+                  state: Schema.optional(Schema.String),
+                  postCode: Schema.optional(Schema.String),
+                  countryCode: Schema.optional(Schema.String),
+                }),
+              ),
+              identifier: Schema.optional(Schema.String),
+            }),
+          ),
+          personalId: Schema.optional(Schema.String),
+          dateOfBirth: Schema.optional(
+            Schema.Struct({
+              day: Schema.optional(Schema.String),
+              month: Schema.optional(Schema.String),
+              year: Schema.optional(Schema.String),
+            }),
+          ),
+        }),
+      ),
+      beneficiary: Schema.optional(
+        Schema.Struct({
+          financialInstitution: Schema.optional(Schema.String),
+          name: Schema.optional(Schema.String),
+          address: Schema.optional(
+            Schema.Struct({
+              line1: Schema.optional(Schema.String),
+              line2: Schema.optional(Schema.String),
+              city: Schema.optional(Schema.String),
+              state: Schema.optional(Schema.String),
+              postCode: Schema.optional(Schema.String),
+              countryCode: Schema.optional(Schema.String),
+            }),
+          ),
+          walletType: Schema.optional(
+            Schema.Literals(["custodial", "self_custody"]),
+          ),
+        }),
+      ),
+    }),
+  ),
+}).pipe(
+  T.Http({ method: "POST", path: "/v2/transfers" }),
+) as unknown as Schema.Codec<CreateTransferInput>;
+
+// Output Schema
+export interface CreateTransferOutput {
+  transferId?: string;
+  status?: "quoted" | "processing" | "completed" | "failed";
+  source:
+    | { accountId: string; asset: string }
+    | { paymentMethodId: string; asset: string }
+    | {
+        address: string;
+        network:
+          | "base"
+          | "ethereum"
+          | "solana"
+          | "aptos"
+          | "arbitrum"
+          | "arbitrum-sepolia"
+          | "optimism"
+          | "polygon"
+          | "world"
+          | "world-sepolia";
+        destinationTag?: string;
+        asset: string;
+      }
+    | { bankName: string; accountLast4: string; currency: string };
+  target:
+    | { accountId: string; asset: string }
+    | { paymentMethodId: string; asset: string }
+    | {
+        address: string;
+        network:
+          | "base"
+          | "ethereum"
+          | "solana"
+          | "aptos"
+          | "arbitrum"
+          | "arbitrum-sepolia"
+          | "optimism"
+          | "polygon"
+          | "world"
+          | "world-sepolia";
+        destinationTag?: string;
+        asset: string;
+      }
+    | { email: string; asset: string };
+  sourceAmount?: string;
+  sourceAsset?: string;
+  targetAmount?: string;
+  targetAsset?: string;
+  exchangeRate?: { sourceAsset: string; targetAsset: string; rate: string };
+  fees?: {
+    type: "bank" | "conversion" | "network" | "other";
+    amount: string;
+    asset: string;
+  }[];
+  estimate?: {
+    exchangeRate?: { sourceAsset: string; targetAsset: string; rate: string };
+    targetAmount?: string;
+    targetAsset?: string;
+    fees?: {
+      type: "bank" | "conversion" | "network" | "other";
+      amount: string;
+      asset: string;
+    }[];
+    estimatedAt: string;
+  };
+  completedAt?: string;
+  failureReason?: string;
+  expiresAt?: string;
+  executedAt?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  metadata?: Record<string, string>;
+  details?: {
+    depositDestination?: { id: string };
+    onchainTransactions?: {
+      transactionHash: string;
+      network:
+        | "base"
+        | "ethereum"
+        | "solana"
+        | "aptos"
+        | "arbitrum"
+        | "arbitrum-sepolia"
+        | "optimism"
+        | "polygon"
+        | "world"
+        | "world-sepolia";
+    }[];
+    travelRule?: {
+      status?: "incomplete" | "completed";
+      statusMessage?: string;
+    };
+  };
+}
+export const CreateTransferOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  transferId: Schema.optional(Schema.String),
+  status: Schema.optional(
+    Schema.Literals(["quoted", "processing", "completed", "failed"]),
+  ),
+  source: Schema.Union([
+    Schema.Struct({
+      accountId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      paymentMethodId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      address: Schema.String,
+      network: Schema.Literals([
+        "base",
+        "ethereum",
+        "solana",
+        "aptos",
+        "arbitrum",
+        "arbitrum-sepolia",
+        "optimism",
+        "polygon",
+        "world",
+        "world-sepolia",
+      ]),
+      destinationTag: Schema.optional(Schema.String),
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      bankName: Schema.String,
+      accountLast4: Schema.String,
+      currency: Schema.String,
+    }),
+  ]),
+  target: Schema.Union([
+    Schema.Struct({
+      accountId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      paymentMethodId: Schema.String,
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      address: Schema.String,
+      network: Schema.Literals([
+        "base",
+        "ethereum",
+        "solana",
+        "aptos",
+        "arbitrum",
+        "arbitrum-sepolia",
+        "optimism",
+        "polygon",
+        "world",
+        "world-sepolia",
+      ]),
+      destinationTag: Schema.optional(Schema.String),
+      asset: Schema.String,
+    }),
+    Schema.Struct({
+      email: Schema.String,
+      asset: Schema.String,
+    }),
+  ]),
+  sourceAmount: Schema.optional(Schema.String),
+  sourceAsset: Schema.optional(Schema.String),
+  targetAmount: Schema.optional(Schema.String),
+  targetAsset: Schema.optional(Schema.String),
+  exchangeRate: Schema.optional(
+    Schema.Struct({
+      sourceAsset: Schema.String,
+      targetAsset: Schema.String,
+      rate: Schema.String,
+    }),
+  ),
+  fees: Schema.optional(
+    Schema.Array(
+      Schema.Struct({
+        type: Schema.Literals(["bank", "conversion", "network", "other"]),
+        amount: Schema.String,
+        asset: Schema.String,
+      }),
+    ),
+  ),
+  estimate: Schema.optional(
+    Schema.Struct({
+      exchangeRate: Schema.optional(
+        Schema.Struct({
+          sourceAsset: Schema.String,
+          targetAsset: Schema.String,
+          rate: Schema.String,
+        }),
+      ),
+      targetAmount: Schema.optional(Schema.String),
+      targetAsset: Schema.optional(Schema.String),
+      fees: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            type: Schema.Literals(["bank", "conversion", "network", "other"]),
+            amount: Schema.String,
+            asset: Schema.String,
+          }),
+        ),
+      ),
+      estimatedAt: Schema.String,
+    }),
+  ),
+  completedAt: Schema.optional(Schema.String),
+  failureReason: Schema.optional(Schema.String),
+  expiresAt: Schema.optional(Schema.String),
+  executedAt: Schema.optional(Schema.String),
+  createdAt: Schema.optional(Schema.String),
+  updatedAt: Schema.optional(Schema.String),
+  metadata: Schema.optional(Schema.Record(Schema.String, Schema.String)),
+  details: Schema.optional(
+    Schema.Struct({
+      depositDestination: Schema.optional(
+        Schema.Struct({
+          id: Schema.String,
+        }),
+      ),
+      onchainTransactions: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            transactionHash: Schema.String,
+            network: Schema.Literals([
+              "base",
+              "ethereum",
+              "solana",
+              "aptos",
+              "arbitrum",
+              "arbitrum-sepolia",
+              "optimism",
+              "polygon",
+              "world",
+              "world-sepolia",
+            ]),
+          }),
+        ),
+      ),
+      travelRule: Schema.optional(
+        Schema.Struct({
+          status: Schema.optional(Schema.Literals(["incomplete", "completed"])),
+          statusMessage: Schema.optional(Schema.String),
+        }),
+      ),
+    }),
+  ),
+}) as unknown as Schema.Codec<CreateTransferOutput>;
+
+// The operation
+/**
+ * Create transfer
+ *
+ * Create a new transfer to move funds from a source to a target.
+ * All transfers first transition to `quoted`. If `execute: false`, the transfer stays quoted until you call `/v2/transfers/{transferId}/execute`.
+ * If `execute: true`, quoted status emits momentarily before the transfer moves to `processing`, where execution proceeds. Subscribe to the transfers webhook to  follow progress in real time instead of polling.
+ *
+ * @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 createTransfer = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateTransferInput,
+  outputSchema: CreateTransferOutput,
+}));

package/src/operations/createWebhookSubscription.ts

@@ -1,13 +1,72 @@
 import * as Schema from "effect/Schema";
 import { API } from "../client.ts";
 import * as T from "../traits.ts";
-import { SensitiveString } from "../sensitive.ts";
+import { SensitiveOutputString } from "../sensitive.ts";
+import * as Redacted from "effect/Redacted";
 
 // Input Schema
+export interface CreateWebhookSubscriptionInput {
+  description?: string;
+  eventTypes: (
+    | "onchain.activity.detected"
+    | "wallet.activity.detected"
+    | "wallet.activity.multi"
+    | "wallet.transaction.created"
+    | "wallet.transaction.signed"
+    | "wallet.transaction.broadcast"
+    | "wallet.transaction.replaced"
+    | "wallet.transaction.pending"
+    | "wallet.transaction.confirmed"
+    | "wallet.transaction.failed"
+    | "wallet.delegation.created"
+    | "wallet.delegation.revoked"
+    | "wallet.typed_data.signed"
+    | "wallet.message.signed"
+    | "wallet.hash.signed"
+    | "onramp.transaction.created"
+    | "onramp.transaction.updated"
+    | "onramp.transaction.success"
+    | "onramp.transaction.failed"
+    | "offramp.transaction.created"
+    | "offramp.transaction.updated"
+    | "offramp.transaction.success"
+    | "offramp.transaction.failed"
+  )[];
+  isEnabled: boolean;
+  target: { url: string; headers?: Record<string, string> };
+  metadata?: Record<string, string>;
+  labels?: Record<string, string>;
+}
 export const CreateWebhookSubscriptionInput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     description: Schema.optional(Schema.String),
-    eventTypes: Schema.Array(Schema.String),
+    eventTypes: Schema.Array(
+      Schema.Literals([
+        "onchain.activity.detected",
+        "wallet.activity.detected",
+        "wallet.activity.multi",
+        "wallet.transaction.created",
+        "wallet.transaction.signed",
+        "wallet.transaction.broadcast",
+        "wallet.transaction.replaced",
+        "wallet.transaction.pending",
+        "wallet.transaction.confirmed",
+        "wallet.transaction.failed",
+        "wallet.delegation.created",
+        "wallet.delegation.revoked",
+        "wallet.typed_data.signed",
+        "wallet.message.signed",
+        "wallet.hash.signed",
+        "onramp.transaction.created",
+        "onramp.transaction.updated",
+        "onramp.transaction.success",
+        "onramp.transaction.failed",
+        "offramp.transaction.created",
+        "offramp.transaction.updated",
+        "offramp.transaction.success",
+        "offramp.transaction.failed",
+      ]),
+    ),
     isEnabled: Schema.Boolean,
     target: Schema.Struct({
       url: Schema.String,
@@ -15,78 +74,114 @@ export const CreateWebhookSubscriptionInput =
     }),
     metadata: Schema.optional(Schema.Record(Schema.String, Schema.String)),
     labels: Schema.optional(Schema.Record(Schema.String, Schema.String)),
-  }).pipe(T.Http({ method: "POST", path: "/v2/data/webhooks/subscriptions" }));
-export type CreateWebhookSubscriptionInput =
-  typeof CreateWebhookSubscriptionInput.Type;
+  }).pipe(
+    T.Http({ method: "POST", path: "/v2/data/webhooks/subscriptions" }),
+  ) as unknown as Schema.Codec<CreateWebhookSubscriptionInput>;
 
 // Output Schema
+export interface CreateWebhookSubscriptionOutput {
+  createdAt: string;
+  updatedAt?: string;
+  description?: string;
+  eventTypes: (
+    | "onchain.activity.detected"
+    | "wallet.activity.detected"
+    | "wallet.activity.multi"
+    | "wallet.transaction.created"
+    | "wallet.transaction.signed"
+    | "wallet.transaction.broadcast"
+    | "wallet.transaction.replaced"
+    | "wallet.transaction.pending"
+    | "wallet.transaction.confirmed"
+    | "wallet.transaction.failed"
+    | "wallet.delegation.created"
+    | "wallet.delegation.revoked"
+    | "wallet.typed_data.signed"
+    | "wallet.message.signed"
+    | "wallet.hash.signed"
+    | "onramp.transaction.created"
+    | "onramp.transaction.updated"
+    | "onramp.transaction.success"
+    | "onramp.transaction.failed"
+    | "offramp.transaction.created"
+    | "offramp.transaction.updated"
+    | "offramp.transaction.success"
+    | "offramp.transaction.failed"
+  )[];
+  isEnabled: boolean;
+  metadata?: { secret?: Redacted.Redacted<string> };
+  secret: Redacted.Redacted<string>;
+  subscriptionId: string;
+  target: { url: string; headers?: Record<string, string> };
+  labels?: Record<string, string>;
+}
 export const CreateWebhookSubscriptionOutput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     createdAt: Schema.String,
     updatedAt: Schema.optional(Schema.String),
     description: Schema.optional(Schema.String),
-    eventTypes: Schema.Array(Schema.String),
+    eventTypes: Schema.Array(
+      Schema.Literals([
+        "onchain.activity.detected",
+        "wallet.activity.detected",
+        "wallet.activity.multi",
+        "wallet.transaction.created",
+        "wallet.transaction.signed",
+        "wallet.transaction.broadcast",
+        "wallet.transaction.replaced",
+        "wallet.transaction.pending",
+        "wallet.transaction.confirmed",
+        "wallet.transaction.failed",
+        "wallet.delegation.created",
+        "wallet.delegation.revoked",
+        "wallet.typed_data.signed",
+        "wallet.message.signed",
+        "wallet.hash.signed",
+        "onramp.transaction.created",
+        "onramp.transaction.updated",
+        "onramp.transaction.success",
+        "onramp.transaction.failed",
+        "offramp.transaction.created",
+        "offramp.transaction.updated",
+        "offramp.transaction.success",
+        "offramp.transaction.failed",
+      ]),
+    ),
     isEnabled: Schema.Boolean,
     metadata: Schema.optional(
       Schema.Struct({
-        secret: Schema.optional(SensitiveString),
+        secret: Schema.optional(SensitiveOutputString),
       }),
     ),
-    secret: SensitiveString,
+    secret: SensitiveOutputString,
     subscriptionId: Schema.String,
     target: Schema.Struct({
       url: Schema.String,
       headers: Schema.optional(Schema.Record(Schema.String, Schema.String)),
     }),
     labels: Schema.optional(Schema.Record(Schema.String, Schema.String)),
-  });
-export type CreateWebhookSubscriptionOutput =
-  typeof CreateWebhookSubscriptionOutput.Type;
+  }) as unknown as Schema.Codec<CreateWebhookSubscriptionOutput>;
 
 // The operation
 /**
  * Create webhook subscription
  *
- * Subscribe to real-time events across CDP products using flexible filtering.
- * ### Event Types
- * **Onchain Events** - Monitor Base mainnet with microsecond precision:
- * - `onchain.activity.detected` - Smart contract events, transfers, swaps, NFT activity
- * - **Requires** `labels` for filtering (e.g., `contract_address`, `event_name`)
- * **Onramp/Offramp Events** - Transaction lifecycle notifications:
- * - `onramp.transaction.created`, `onramp.transaction.updated`
- * - `onramp.transaction.success`, `onramp.transaction.failed`
- * - `offramp.transaction.created`, `offramp.transaction.updated`
- * - `offramp.transaction.success`, `offramp.transaction.failed`
- * - **No labels required** - maximum simplicity for transaction monitoring
- * **Payments Transfers Events** - Transfer lifecycle notifications:
- * - `payments.transfers.quoted`
- * - `payments.transfers.processing`
- * - `payments.transfers.completed`
- * - `payments.transfers.failed`
- * - `payments.transfers.travel_rule_incomplete`
- * - `payments.transfers.travel_rule_completed`
- * - **No labels required** - enable the transfers webhook to monitor status transitions
- * **Wallet Events** - Wallet activity notifications:
- * - `wallet.activity.detected`
+ * Subscribe to real-time events across CDP products.
+ * ### Filtering
+ * Onchain events can utilize multi-label filtering to only receive events that match all the specified labels.
+ * Allows labels are:
+ * - `network` (required) — Blockchain network
+ * - `contract_address` — Smart contract address
+ * - `event_name` — Event name (e.g., "Transfer", "Burn")
+ * - `event_signature` — Event signature (e.g., "Transfer(address,address,uint256)")
+ * - `transaction_from` — Transaction sender address
+ * - `transaction_to` — Transaction recipient address
+ * - `params.*` — Any event parameter from the log event (e.g., `params.from`, `params.to`, `params.sender`, `params.tokenId`)
+ * For webhook types that aren't `onchain.*`, labels are ignored.
  * ### Webhook Signature Verification
- * All webhooks include cryptographic signatures for security.
- * The signature secret is returned in `secret` field when creating a subscription.
- * **Note:** Webhooks are in beta and this interface is subject to change.
+ * All webhooks include an HMAC-SHA256 signed header for security. The signature is signed with the secret that is returned in the `secret` field when creating a subscription.
+ * Do not lose the secret, as you will not be able to recreate it. If you lose the secret, you will need to create a new subscription.
  * See the [verification guide](https://docs.cdp.coinbase.com/onramp-&-offramp/webhooks#webhook-signature-verification) for implementation details.
- * ### Onchain Label Filtering
- * For `onchain.activity.detected` events, use `labels` for precise filtering with AND logic (max 20 labels per webhook).
- * **Allowed labels** (all in snake_case format):
- * - `network` (required) - Blockchain network
- * - `contract_address` - Smart contract address
- * - `event_name` - Event name (e.g., "Transfer", "Burn")
- * - `event_signature` - Event signature hash
- * - `transaction_from` - Transaction sender address
- * - `transaction_to` - Transaction recipient address
- * - `params.*` - Any event parameter (e.g., `params.from`, `params.to`, `params.sender`, `params.tokenId`)
- * **Examples**:
- * - **Liquidity Pool Monitor**: `{"network": "base-mainnet", "contract_address": "0xcd1f9777571493aeacb7eae45cd30a226d3e612d", "event_name": "Burn"}`
- * - **Price Oracle Tracker**: `{"network": "base-mainnet", "contract_address": "0xbac4a9428ea707c51f171ed9890c3c2fa810305d", "event_name": "PriceUpdated"}`
- * - **DeFi Protocol Activity**: `{"network": "base-mainnet", "contract_address": "0x45c6e6a47a711b14d8357d5243f46704904578e3", "event_name": "Deposit"}`
  */
 export const createWebhookSubscription = /*@__PURE__*/ /*#__PURE__*/ API.make(
   () => ({