@zkp2p/sdk 0.0.5 → 0.0.7

package/README.md

@@ -44,6 +44,70 @@ The SDK also includes supporting functionality for the broader ZKP2P ecosystem:
 - **Quote API**: `getQuote()` (used by frontends to display available liquidity)
 - **Indexer Queries**: Historical data, pagination, and advanced filtering via `client.indexer.*`
 
+## Peer Extension SDK
+
+If your app integrates with the Peer browser extension, you can use the SDK wrappers around `window.peer`:
+
+```typescript
+import { peerExtensionSdk } from '@zkp2p/sdk';
+
+const state = await peerExtensionSdk.getState();
+if (state === 'needs_install') {
+  peerExtensionSdk.openInstallPage();
+} else if (state === 'needs_connection') {
+  await peerExtensionSdk.requestConnection();
+} else {
+  const version = await peerExtensionSdk.getVersion();
+  peerExtensionSdk.openSidebar('/buy');
+  peerExtensionSdk.onramp({
+    referrer: 'Polymarket',
+    inputCurrency: 'USD',
+    inputAmount: 25,
+    paymentPlatform: 'venmo',
+    amountUsdc: '100000000',
+    recipientAddress: '0x1111111111111111111111111111111111111111',
+  });
+}
+```
+
+### Intent Hash Deeplink
+
+Open the extension directly to a specific intent (skips quote flow):
+
+```typescript
+peerExtensionSdk.onramp({
+  intentHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+});
+```
+
+### Proof Completion Callbacks
+
+Subscribe to proof completion events to know when a proof succeeds, fails, or is cancelled:
+
+```typescript
+const unsubscribe = peerExtensionSdk.onProofComplete((result) => {
+  switch (result.status) {
+    case 'success':
+      console.log('Proof completed!', result.proof);
+      // result.proof: { attestation, signature, timestamp, platform }
+      break;
+    case 'failure':
+      console.error('Proof failed:', result.error);
+      // result.error: { code, message }
+      break;
+    case 'cancelled':
+      console.log('User cancelled');
+      break;
+    case 'timeout':
+      console.log('Proof timed out');
+      break;
+  }
+});
+
+// Clean up when done
+unsubscribe();
+```
+
 ## Installation
 
 ```bash
@@ -392,7 +456,7 @@ const catalog = getPaymentMethodsCatalog(8453, 'production');
 - `setIntentRange(params)` - Set min/max intent amounts
 - `setCurrencyMinRate(params)` - Set minimum conversion rate
 - `setDelegate(params)` / `removeDelegate(params)` - Manage delegates
-- `addPaymentMethods(params)` - Add payment platforms
+- `addPaymentMethods(params)` - Add payment platforms (requires `currencies` array per method)
 - `setPaymentMethodActive(params)` - Enable/disable payment methods
 - `addCurrencies(params)` / `deactivateCurrency(params)` - Manage currencies
 
@@ -446,6 +510,21 @@ if (result.hadAllowance) {
 For methods that interact directly with on-chain data, parameters use bytes32 hex strings:
 
 ```typescript
+// addPaymentMethods - Add payment methods with required currency lists
+await client.addPaymentMethods({
+  depositId: 1n,
+  paymentMethods: ['0x...'], // bytes32 payment method hashes
+  paymentMethodData: [
+    { intentGatingService: '0x...', payeeDetails: '0x...', data: '0x' },
+  ],
+  // currencies is required and must align with paymentMethods by index
+  currencies: [
+    [
+      { code: '0x...', minConversionRate: 1020000000000000000n },
+    ],
+  ],
+});
+
 // addCurrencies - Add currencies to a payment method
 await client.addCurrencies({
   depositId: 1n,