@usdctofiat/offramp 2.0.3 → 3.0.0

package/CHANGELOG.md

@@ -7,6 +7,98 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [3.0.0] - 2026-05-07
+
+### ⚠ BREAKING CHANGES
+
+The Peer browser extension upstream cut over to a prepared-calldata contract.
+The host app now owns the fulfill broadcast instead of the extension. Anyone
+driving `peerExtensionSdk` directly through the re-export must migrate.
+
+- **`peerExtensionSdk.onramp(params)` is no longer fire-and-forget.** It now
+  takes a callback and yields prepared calldata for the host to broadcast:
+  `peerExtensionSdk.onramp(params, (prepared) => { /* sign & send */ })`. The
+  callback receives `{ status: "calldata_ready", intentHash, transaction: { to,
+data, value, chainId } }` — broadcast it through your wallet client.
+- **`peerExtensionSdk.onIntentFulfilled(callback)` was removed.** Subscriptions
+  no longer exist; the prepared-calldata callback above replaces them. Track
+  fulfillment off the `sendTransaction` resolution in your callback.
+- **`intentHash` is required** in the `onramp` params (was optional). Pass the
+  hash returned by `signalIntent` upstream.
+- **`PeerIntentFulfilledResult` / `PeerIntentFulfilledCallback` /
+  `PeerIntentFulfilledBridgeStatus` are gone** from `@zkp2p/sdk`. Anyone
+  importing them directly will hit a missing-name error. Switch to
+  `PeerOnrampPreparedTransactionResult` / `PeerOnrampPreparedTransactionCallback`
+  (now re-exported from this package).
+
+### Added
+
+- **`peerExtensionSdk.getOnrampTransaction(intentHash)`** pull-recovery path
+  for prepared calldata when the callback was missed (page reload, tab close,
+  extension restart). Returns the same `calldata_ready` shape or `null` if
+  nothing is pending. Wire it into your active-intent resume flow.
+- **New type re-exports** from `@zkp2p/sdk`: `PeerOnrampPreparedTransactionCallback`,
+  `PeerOnrampPreparedTransactionResult`, `PeerExtensionOnrampParams`. Available
+  from both the core entry and via `extension.ts`.
+
+### Migration
+
+```ts
+// Before (2.x)
+peerExtensionSdk.onramp({
+  intentHash,
+  paymentPlatform: "wise",
+  inputAmount: "100",
+  amountUsdc: "100000000",
+  recipientAddress,
+  referrer: "myapp",
+});
+const unsubscribe = peerExtensionSdk.onIntentFulfilled((result) => {
+  if (result.status === "fulfilled") {
+    handleFulfilled(result.fulfillTxHash);
+  }
+});
+
+// After (3.x)
+peerExtensionSdk.onramp(
+  {
+    intentHash, // now REQUIRED
+    paymentPlatform: "wise",
+    inputAmount: "100",
+    amountUsdc: "100000000",
+    recipientAddress,
+    referrer: "myapp",
+  },
+  async (prepared) => {
+    const fulfillTxHash = await walletClient.sendTransaction({
+      to: prepared.transaction.to,
+      data: prepared.transaction.data,
+      value: BigInt(prepared.transaction.value || "0"),
+      chainId: prepared.transaction.chainId,
+    });
+    handleFulfilled(fulfillTxHash);
+  },
+);
+
+// Optional: pull-recovery on page mount when an active intent exists
+const prepared = await peerExtensionSdk.getOnrampTransaction(intentHash);
+if (prepared?.status === "calldata_ready") {
+  // broadcast as above
+}
+```
+
+### Changed
+
+- Bump `@zkp2p/sdk` to `0.4.0-rc.4`.
+
+## [2.0.4] - 2026-04-25
+
+### Docs
+
+- Lead the agent bundle with the developer portal (`https://usdctofiat.xyz/developers`) so human integrators landing on npm have a one-click path to the polished docs surface, then drop into skills and `llms-full.txt`.
+- Call out the symmetric Peerlytics relationship: one Peerlytics API key authenticates outbound webhooks here and the paid Peerlytics v1 API.
+- Bump `SDK_VERSION` to track package version (enforced by `scripts/check-version.mjs`).
+
 ## [2.0.3] - 2026-04-25
 
 ### Docs
@@ -271,6 +363,9 @@ If you were on `@usdctofiat/offramp@1.x`:
 - Dual CJS/ESM build via tsup with type definitions for both entry points.
 
 [Unreleased]: https://github.com/ADWilkinson/galleonlabs-zkp2p/compare/main...HEAD
+[3.0.0]: https://github.com/ADWilkinson/galleonlabs-zkp2p/releases/tag/offramp-sdk-v3.0.0
+[2.0.4]: https://github.com/ADWilkinson/galleonlabs-zkp2p/releases/tag/offramp-sdk-v2.0.4
+[2.0.3]: https://github.com/ADWilkinson/galleonlabs-zkp2p/releases/tag/offramp-sdk-v2.0.3
 [2.0.2]: https://github.com/ADWilkinson/galleonlabs-zkp2p/releases/tag/offramp-sdk-v2.0.2
 [2.0.1]: https://github.com/ADWilkinson/galleonlabs-zkp2p/releases/tag/offramp-sdk-v2.0.1
 [2.0.0]: https://github.com/ADWilkinson/galleonlabs-zkp2p/releases/tag/offramp-sdk-v2.0.0

package/README.md

@@ -9,12 +9,13 @@ USDC-to-fiat offramp SDK for Base. 6 functions + 2 const objects.
 
 If you are integrating through an agent (Claude Code, Cursor, etc.), start here:
 
+- Developer portal: <https://usdctofiat.xyz/developers>
 - Drop-in skill: <https://usdctofiat.xyz/skills/usdctofiat.md>
 - Short machine reference: <https://usdctofiat.xyz/llms.txt>
 - Full machine reference: <https://usdctofiat.xyz/llms-full.txt>
 - Scaffold CLI: `npx create-offramp-app@latest my-app --template=next|vite|telegram-bot`
-- Starters (Next.js / Vite / Telegram bot): <https://github.com/ADWilkinson/usdctofiat-peerlytics-starters>
-- Companion SDK for analytics + explorer: [`@peerlytics/sdk`](https://www.npmjs.com/package/@peerlytics/sdk)
+- Starters (Next.js / Vite / Telegram bot, plus runnable example scripts and HMAC verifiers): <https://github.com/ADWilkinson/usdctofiat-peerlytics-starters>
+- Companion SDK for analytics + explorer: [`@peerlytics/sdk`](https://www.npmjs.com/package/@peerlytics/sdk) (one Peerlytics API key authenticates both products)
 
 ## Install
 
@@ -216,7 +217,7 @@ Every deposit is automatically delegated to the Delegate vault for oracle-based
 
 ## Webhooks
 
-Subscribe to `deposit.created`, `deposit.filled`, `deposit.partially_filled`, `deposit.closed`, `otc.enabled`, `otc.disabled`, and `otc.taken` events for your attributed deposits. Register endpoints at [usdctofiat.xyz/developers](https://usdctofiat.xyz/developers) with your Peerlytics API key. HMAC-SHA256 signed deliveries use the `X-Usdctofiat-Signature: t=<unix>,v1=<hex>` header. Reference HMAC receiver in the [starters repo](https://github.com/ADWilkinson/usdctofiat-peerlytics-starters).
+Subscribe to live `deposit.created`, `deposit.filled`, `deposit.partially_filled`, `deposit.closed`, and `otc.taken` events for your attributed deposits. `otc.enabled` and `otc.disabled` are reserved event names. Register endpoints at [usdctofiat.xyz/developers](https://usdctofiat.xyz/developers) with your Peerlytics API key. HMAC-SHA256 signed deliveries use the `X-Usdctofiat-Signature: t=<unix>,v1=<hex>` header. Reference HMAC receiver in the [starters repo](https://github.com/ADWilkinson/usdctofiat-peerlytics-starters).
 
 ## Links
 

package/dist/{chunk-ZWQVMPSH.js → chunk-J2CCUQZ4.js}

@@ -1,6 +1,6 @@
 // src/config.ts
 import { getContracts, getGatingServiceAddress } from "@zkp2p/sdk";
-var SDK_VERSION = "2.0.3";
+var SDK_VERSION = "3.0.0";
 var BASE_CHAIN_ID = 8453;
 var RUNTIME_ENV = "production";
 var API_BASE_URL = "https://api.zkp2p.xyz";
@@ -1774,4 +1774,4 @@ export {
   openPeerExtensionInstallPage,
   getPeerExtensionState
 };
-//# sourceMappingURL=chunk-ZWQVMPSH.js.map
+//# sourceMappingURL=chunk-J2CCUQZ4.js.map