@usdctofiat/offramp 1.0.0 → 1.1.0

package/README.md

@@ -3,61 +3,55 @@
 [![npm version](https://img.shields.io/npm/v/@usdctofiat/offramp?color=8fb47d)](https://www.npmjs.com/package/@usdctofiat/offramp)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ADWilkinson/galleonlabs-zkp2p/blob/main/packages/offramp-sdk/LICENSE)
 
-USDC-to-fiat offramp SDK for Base. Create and manage delegated deposits in one function call.
+USDC-to-fiat offramp SDK for Base. 6 functions + 2 const objects.
 
 ## Install
 
 ```bash
-npm install @usdctofiat/offramp
+bun add @usdctofiat/offramp
 ```
 
 ## Quick Start
 
 ```typescript
-import { Offramp, PAYMENT_PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
+import { offramp, PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
 
-const offramp = new Offramp();
-
-const result = await offramp.createDeposit(walletClient, {
+const result = await offramp(walletClient, {
   amount: "100",
-  platform: PAYMENT_PLATFORMS.REVOLUT,
+  platform: PLATFORMS.REVOLUT,
   currency: CURRENCIES.EUR,
   identifier: "alice",
 });
-
-console.log(result.depositId, result.txHash);
+// { depositId: "362", txHash: "0x...", resumed: false }
 ```
 
 ## Deposit Management
 
 ```typescript
-// List deposits
-const deposits = await offramp.getDeposits("0xYourAddress");
-// [{ depositId, status, remainingUsdc, fulfilledIntents, delegated, ... }]
+import { deposits, close } from "@usdctofiat/offramp";
 
-// Close and withdraw
-const txHash = await offramp.withdrawDeposit(walletClient, "123");
+const list = await deposits("0xYourAddress");
+await close(walletClient, "361");
 ```
 
 ## React
 
 ```typescript
 import { useOfframp } from "@usdctofiat/offramp/react";
+import { PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
 
-function SellButton({ walletClient }) {
-  const { createDeposit, step, isLoading, error, getDeposits } = useOfframp();
+function SellButton({ walletClient }: { walletClient: WalletClient }) {
+  const { offramp, step, isLoading } = useOfframp();
 
   return (
     <button
       disabled={isLoading}
-      onClick={() =>
-        createDeposit(walletClient, {
-          amount: "100",
-          platform: "revolut",
-          currency: "EUR",
-          identifier: "alice",
-        })
-      }
+      onClick={() => offramp(walletClient, {
+        amount: "100",
+        platform: PLATFORMS.REVOLUT,
+        currency: CURRENCIES.EUR,
+        identifier: "alice",
+      })}
     >
       {step ?? "Sell USDC"}
     </button>
@@ -65,55 +59,54 @@ function SellButton({ walletClient }) {
 }
 ```
 
-## Progress Callbacks
+## Platform & Currency Data
 
 ```typescript
-await offramp.createDeposit(walletClient, params, (progress) => {
-  // progress.step: "approving" | "registering" | "depositing" | "confirming" | "delegating" | "done"
-  // progress.txHash: available after "depositing"
-  // progress.depositId: available after "confirming"
-});
+import { PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
+
+PLATFORMS.REVOLUT.name; // "Revolut"
+PLATFORMS.REVOLUT.currencies; // ["USD", "EUR", "GBP", ...]
+PLATFORMS.REVOLUT.identifier.label; // "Revtag"
+PLATFORMS.REVOLUT.identifier.placeholder; // "revtag (no @)"
+PLATFORMS.REVOLUT.identifier.help; // "Revtag without @ (must be public)"
+PLATFORMS.REVOLUT.validate("@alice"); // { valid: true, normalized: "alice" }
+
+CURRENCIES.EUR.symbol; // "€"
+CURRENCIES.EUR.name; // "Euro"
+CURRENCIES.EUR.countryCode; // "eu"
 ```
 
-## Discovery & Validation
+## OTC Private Orders
 
-```typescript
-import { PAYMENT_PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
+Restrict a deposit to a single taker wallet. Pass `otcTaker` and the deposit is created, delegated, and restricted in one call:
 
-// Platforms with currencies, labels, and format requirements
-offramp.getPlatforms();
-// [{ id: "revolut", name: "Revolut", currencies: ["USD","EUR",...], identifierLabel: "Revtag", helperText: "Revtag without @", ... }]
+```typescript
+import { offramp, PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
 
-// Currencies for a platform
-offramp.getCurrencies(PAYMENT_PLATFORMS.WISE);
-// ["USD", "EUR", "GBP", "AUD", ...]
+const { depositId, otcLink } = await offramp(walletClient, {
+  amount: "100",
+  platform: PLATFORMS.REVOLUT,
+  currency: CURRENCIES.EUR,
+  identifier: "alice",
+  otcTaker: "0xBuyerAddress",
+});
+// otcLink = "https://usdctofiat.xyz/deposit/0x.../362"
+// Share otcLink with the buyer — they open it, connect their wallet, and fill the order.
+```
 
-// Currency metadata for UI rendering
-offramp.getCurrencyInfo(CURRENCIES.EUR);
-// { code: "EUR", name: "Euro", symbol: "€", countryCode: "eu" }
+Toggle OTC on existing deposits:
 
-offramp.getAllCurrencies();
-// [{ code: "AED", name: "UAE Dirham", symbol: "د.إ", countryCode: "ae" }, ...]
+```typescript
+import { enableOtc, disableOtc, getOtcLink } from "@usdctofiat/offramp";
 
-// Validate and normalize identifiers (strips @, $, validates format)
-offramp.validateIdentifier(PAYMENT_PLATFORMS.REVOLUT, "@alice");
-// { valid: true, normalized: "alice" }
+await enableOtc(walletClient, "362", "0xBuyerAddress");
+await disableOtc(walletClient, "362"); // make public again
+getOtcLink("362"); // just the URL, no tx
 ```
 
-## Supported Platforms
-
-| Platform | Currencies | Identifier |
-|----------|-----------|-----------|
-| Revolut | 23 currencies | Revtag |
-| Wise | 30+ currencies | Wisetag |
-| PayPal | 7 currencies | Email |
-| Venmo | USD | Username |
-| Cash App | USD | Cashtag |
-| Zelle | USD | Email |
-| Monzo | GBP | Username |
-| N26 | EUR | IBAN |
-| Chime | USD | ChimeSign |
-| Mercado Pago | ARS | CVU |
+## Resumable
+
+`offramp()` is idempotent. If an undelegated deposit exists for the wallet, it skips straight to delegation. Handles browser crashes, failed delegation, and retries automatically. Just call `offramp()` again.
 
 ## Error Handling
 
@@ -121,31 +114,18 @@ offramp.validateIdentifier(PAYMENT_PLATFORMS.REVOLUT, "@alice");
 import { OfframpError } from "@usdctofiat/offramp";
 
 try {
-  await offramp.createDeposit(walletClient, params);
+  await offramp(walletClient, params);
 } catch (err) {
   if (err instanceof OfframpError) {
-    console.log(err.code);      // "VALIDATION" | "USER_CANCELLED" | "DEPOSIT_FAILED" | ...
-    console.log(err.step);      // Which step failed
-    console.log(err.txHash);    // Available if deposit was created on-chain
-    console.log(err.depositId); // Available if deposit was confirmed but delegation failed
+    if (err.code === "USER_CANCELLED") return;
+    // For any failure: call offramp() again to resume
   }
 }
 ```
 
 ## How It Works
 
-Every deposit created through this SDK is automatically:
-
-1. **Delegated** to the USDCtoFiat Delegate vault for rate management
-2. **Market-tracking** via oracle-based pricing
-3. **Auto-closing** when fully filled
-4. **Attributed** to Galleon Labs via ERC-8021
-
-## Requirements
-
-- Base network (chain ID 8453)
-- viem `WalletClient` with an account
-- USDC balance on Base
+Every deposit is automatically delegated to the Delegate vault for oracle-based rate management, auto-closes when filled, and is attributed to Galleon Labs via ERC-8021.
 
 ## Links