@zkp2p/sdk 0.3.2 → 0.4.0-rc.1

package/README.md

@@ -6,7 +6,7 @@
 
 Stable TypeScript SDK for trustless fiat-to-crypto on Base. ZKP2P combines escrowed on-chain settlement, TLS attestations for payment verification, and API/indexer helpers so makers, takers, wallets, and embedded ramps can ship production-grade fiat liquidity flows without building their own contract or indexing stack.
 
-Current version: `0.3.1`
+Current version: `0.3.3`
 
 ## Why This SDK
 
@@ -96,6 +96,7 @@ Indexer defaults by environment:
 | Intents                        | `signalIntent`, `fulfillIntent`, `cancelIntent`, `releaseFundsToPayer`, `getFulfillIntentInputs`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | Prepared transactions          | `client.prepareCreateDeposit(...)`, `client.signalIntent.prepare(...)`, `client.fulfillIntent.prepare(...)`, `client.setVaultFee.prepare(...)`, and equivalent prepare flows across the rest of the prepareable write surface                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | Payee and quote APIs           | `registerPayeeDetails`, `resolvePayeeHash`, `getQuote`, `getQuotesBestByPlatform`, `getTakerTier`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| Seller automated release       | `uploadSellerCredential`, `getSellerCredentialStatus`, `verifySellerPayment`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | Delegation and hooks           | `setDelegate`, `removeDelegate`, `setRateManager`, `clearRateManager`, `setDepositRateManager`, `clearDepositRateManager`, `setDepositPreIntentHook`, `setDepositWhitelistHook`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | Vault / DRM                    | `createRateManager`, `setVaultMinRate`, `setVaultMinRatesBatch`, `setVaultFee`, `setVaultConfig`, `getDepositRateManager`, `getManagerFee`, `getEffectiveRate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | Oracle config                  | `setOracleRateConfig`, `setOracleRateConfigBatch`, `removeOracleRateConfig`, `updateCurrencyConfigBatch`, `deactivateCurrenciesBatch`, `supportsInlineOracleRateConfig`, `validateOracleFeedsOnChain`                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
@@ -104,6 +105,51 @@ Indexer defaults by environment:
 | React hooks                    | `@zkp2p/sdk/react` exports hooks for deposits, intents, delegation, vaults, payment methods, and taker tier                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | Attribution                    | ERC-8021 helpers like `sendTransactionWithAttribution`, `encodeWithAttribution`, and `txOverrides.referrer` support                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 
+## Extension Onramp Deeplinks
+
+Use `createPeerExtensionSdk()` when a third-party page has signaled an intent and should hand payment authentication and proof generation into the Peer extension.
+
+```ts
+import { createPeerExtensionSdk } from '@zkp2p/sdk';
+
+const peer = createPeerExtensionSdk();
+const intentHash = await client.signalIntent({
+  // quote-selected intent params
+});
+
+const submitPreparedTransaction = async ({ transaction }) => {
+  await walletClient.sendTransaction({
+    to: transaction.to,
+    data: transaction.data,
+    value: BigInt(transaction.value),
+  });
+};
+
+const existing = await peer.getOnrampTransaction(intentHash);
+if (existing) {
+  await submitPreparedTransaction(existing);
+} else {
+  peer.onramp(
+    {
+      intentHash,
+      referrer: 'Liquidity Page',
+      inputCurrency: 'USD',
+      inputAmount: '500',
+      paymentPlatform: 'venmo',
+      depositId: '12345678901234567890',
+      amountUsdc: '488280000',
+      toToken: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+      recipientAddress: '0xRecipient',
+    },
+    submitPreparedTransaction,
+  );
+}
+```
+
+For exact-deposit handoffs, pass `depositId` as a string or bigint unless it is known to be a JavaScript-safe integer. The extension derives payment method hashes from `paymentPlatform`; do not pass escrow addresses, payment method hashes, or hashed on-chain ids through the onramp URL. `getOnrampTransaction(intentHash)` is the pull recovery path for prepared calldata when the callback message was missed.
+
+See [Extension Onramp Deeplinks](../../docs/extension-onramp-deeplinks.md) for the full parameter contract, exact-deposit semantics, and prepared calldata recovery behavior.
+
 ## Create a Deposit
 
 ```ts
@@ -158,6 +204,17 @@ const payeeHash = await client.resolvePayeeHash(
 
 `getQuote()` returns available liquidity plus payee details when authenticated. Use `getQuotesBestByPlatform()` to fetch the best quote per supported payment platform in a single call (handy for cross-platform comparison UIs). `getTakerTier()` returns limits and cooldown data for taker UX.
 
+## Seller Credential Status
+
+```ts
+const status = await client.getSellerCredentialStatus({
+  processorName: 'venmo',
+  payeeDetails: '0xPAYEE_DETAILS_HASH',
+});
+```
+
+`payeeDetails` is the hashed payee details bytes32 used by maker registration, quotes, and on-chain intents. The public status endpoint returns `{ platform, payeeIdHash, status, credentialType }`; maker row ids are intentionally not returned by status or upload responses.
+
 ## Signal, Fulfill, and Release Intents
 
 ```ts