@usdctofiat/offramp 1.0.1 → 1.1.0

package/README.md

@@ -3,7 +3,7 @@
 [![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. 3 functions + 2 const objects.
+USDC-to-fiat offramp SDK for Base. 6 functions + 2 const objects.
 
 ## Install
 
@@ -64,16 +64,44 @@ function SellButton({ walletClient }: { walletClient: WalletClient }) {
 ```typescript
 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" }
+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"
+CURRENCIES.EUR.symbol; // "€"
+CURRENCIES.EUR.name; // "Euro"
+CURRENCIES.EUR.countryCode; // "eu"
+```
+
+## OTC Private Orders
+
+Restrict a deposit to a single taker wallet. Pass `otcTaker` and the deposit is created, delegated, and restricted in one call:
+
+```typescript
+import { offramp, PLATFORMS, CURRENCIES } from "@usdctofiat/offramp";
+
+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.
+```
+
+Toggle OTC on existing deposits:
+
+```typescript
+import { enableOtc, disableOtc, getOtcLink } from "@usdctofiat/offramp";
+
+await enableOtc(walletClient, "362", "0xBuyerAddress");
+await disableOtc(walletClient, "362"); // make public again
+getOtcLink("362"); // just the URL, no tx
 ```
 
 ## Resumable