@zkp2p/sdk 0.0.15 → 0.1.0-rc.2

package/README.md

@@ -2,129 +2,44 @@
 
 [![npm version](https://img.shields.io/npm/v/@zkp2p/sdk.svg)](https://www.npmjs.com/package/@zkp2p/sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue)](https://www.typescriptlang.org/)
 
-**ZKP2P Client SDK** - TypeScript SDK for **liquidity providers** who want to offer fiat off-ramp services on Base.
+TypeScript SDK for ZKP2P liquidity providers and integrators.
 
-## Who Is This For?
+The staging protocol-upgrade surfaces are included in this package line (`0.0.x`): V1/V2 contract routing, vault/delegated rate-management (DRM) operations, oracle/spread configuration, and expanded indexer helpers.
 
-This SDK is designed for **liquidity providers (peers)** who want to:
+## Who This Is For
 
-- Create and manage USDC deposits that accept fiat payments
-- Configure payment methods, currencies, and conversion rates
-- Monitor deposit utilization and manage liquidity
-- Earn fees by providing off-ramp services
+- maker/liquidity-provider applications
+- internal client apps (web, extension)
+- tools that need contract-safe deposit/intent operations
+- dashboard/reporting services that query `client.indexer.*`
 
-## RPC-First Architecture
+## Core Capabilities
 
-This SDK uses **RPC-first queries** via ProtocolViewer for instant, real-time on-chain data:
-
-- **No indexer lag**: Queries go directly to the blockchain
-- **Always fresh**: See deposit/intent state immediately after transactions
-- **Instant feedback**: Perfect for interactive UIs
-
-Advanced historical queries (pagination, filtering, fulfillment records) are available via `client.indexer.*`.
-
-## Core Features (Deposit Management)
-
-| Feature             | Description                                                      |
-| ------------------- | ---------------------------------------------------------------- |
-| **Create Deposits** | Lock USDC and define accepted payment methods                    |
-| **Configure Rates** | Set conversion rates per currency and payment platform           |
-| **Manage Funds**    | Add/remove funds, withdraw deposits                              |
-| **Payment Methods** | Wise, Venmo, Revolut, CashApp, PayPal, Zelle, Monzo, MercadoPago |
-| **Multi-Currency**  | Support USD, EUR, GBP, and 25+ fiat currencies                   |
-| **Query Deposits**  | Real-time on-chain queries via ProtocolViewer                    |
-| **React Hooks**     | Full suite of React hooks for frontend integration               |
-
-## Supporting Features
-
-The SDK also includes supporting functionality for the broader ZKP2P ecosystem:
-
-- **Intent Operations**: `signalIntent()`, `fulfillIntent()`, `cancelIntent()` (typically used by takers/buyers)
-- **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();
-```
+| Area              | Highlights                                                                                                                         |
+| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| Deposit lifecycle | `createDeposit`, `addFunds`, `removeFunds`, `withdrawDeposit`                                                                      |
+| Intent lifecycle  | `signalIntent`, `fulfillIntent`, `cancelIntent`, `releaseFundsToPayer`                                                             |
+| Vault/DRM         | `createRateManager`, `setRateManager`, `clearRateManager`, `setVaultFee`, `setVaultMinRate`, `setDepositorFloor`, `setVaultConfig` |
+| Oracle config     | `setOracleRateConfig`, `setOracleRateConfigBatch`                                                                                  |
+| RPC-first reads   | `getDeposits`, `getDeposit`, `getIntents`, `getIntent`                                                                             |
+| Indexer services  | `client.indexer.*`, `IndexerRateManagerService`, `getIntentFulfillmentAmounts`                                                     |
+| React hooks       | `@zkp2p/sdk/react` hooks for deposit/intent/vault operations                                                                       |
 
 ## Installation
 
 ```bash
 npm install @zkp2p/sdk viem
 # or
-yarn add @zkp2p/sdk viem
-# or
 pnpm add @zkp2p/sdk viem
+# or
+yarn add @zkp2p/sdk viem
 ```
 
 ## Quick Start
 
-### Initialize the Client
-
-```typescript
-import { OfframpClient } from '@zkp2p/sdk';
+```ts
+import { Zkp2pClient } from '@zkp2p/sdk';
 import { createWalletClient, custom } from 'viem';
 import { base } from 'viem/chains';
 
@@ -133,536 +48,169 @@ const walletClient = createWalletClient({
   transport: custom(window.ethereum),
 });
 
-const client = new OfframpClient({
+const client = new Zkp2pClient({
   walletClient,
   chainId: base.id,
-  apiKey: 'YOUR_CURATOR_API_KEY', // For curator API (createDeposit, signalIntent, etc.)
-  indexerApiKey: 'YOUR_INDEXER_KEY', // For indexer proxy (x-api-key header)
+  runtimeEnv: 'staging', // 'production' | 'staging'
+  apiKey: 'YOUR_CURATOR_API_KEY',
+  indexerApiKey: 'YOUR_INDEXER_API_KEY',
 });
+```
 
-// Optional: keep indexer auth fresh in long-lived clients
-const getFreshAuthToken = async () => {
-  return await yourAuthProvider.getAccessToken();
-};
+## Routing Defaults
 
-const clientWithTokenProvider = new OfframpClient({
-  walletClient,
-  chainId: base.id,
-  getAuthorizationToken: getFreshAuthToken, // Bearer token per indexer request
-});
-```
+- SDK methods are capability-based and do not enforce product rollout flags.
+- SDK defaults to V2 routing when V2 contracts are deployed, with legacy fallback when not.
+- Apply phase/rollout gating in app layers above the SDK (web/extension/backend).
 
-### Authentication Behavior
+## Authentication
 
-- Indexer authentication is optional. `client.indexer.*` works without auth unless your backend policy requires it.
-- The indexer accepts two auth methods:
-  - **Bearer token** — set via `authorizationToken` (static) or `getAuthorizationToken` (per-request). Sent as `Authorization: Bearer <token>`.
-  - **Indexer API key** — set via `indexerApiKey`. Sent as `x-api-key: <key>`. Separate from the curator `apiKey`.
-- `authorizationToken` is also used by API adapter methods like `getQuote()`, `getTakerTier()`, and API-backed deposit flows.
-- `getAuthorizationToken` is used by indexer requests (`client.indexer.*`) and is called per request.
-- If both bearer and indexer API key are provided, both headers are sent.
-- If `getAuthorizationToken` throws, indexer requests continue without an `Authorization` header.
-- Authenticated requests may receive different limits or entitlements depending on backend policy.
+- `apiKey` is used for curator API endpoints (for example quote/deposit helper endpoints).
+- `authorizationToken` and `getAuthorizationToken` support bearer auth.
+- `indexerApiKey` adds `x-api-key` for indexer proxy auth.
 
-### Indexer Defaults and Retry Behavior
+If you provide both bearer and indexer API key, both headers are sent.
 
-- Default indexer endpoints:
-  - Production/Preproduction: `https://indexer.zkp2p.xyz/v1/graphql`
-  - Staging: `https://indexer-staging.zkp2p.xyz/v1/graphql`
-- Indexer HTTP `429` handling:
-  - Honors `Retry-After` in seconds or HTTP-date format.
-  - Total attempts are capped at `max(retries, rateLimitRetries) + 1`.
+## Indexer Defaults
 
-## Core Operations
+- Production: `https://indexer.zkp2p.xyz/v1/graphql`
+- Preproduction: `https://indexer-preprod.zkp2p.xyz/v1/graphql`
+- Staging: `https://indexer-staging.zkp2p.xyz/v1/graphql`
 
-### Creating a Deposit
+## Common Operations
 
-Provide liquidity by creating a deposit with your preferred payment methods and currencies:
+### Create a Deposit
 
-```typescript
+```ts
 import { Currency } from '@zkp2p/sdk';
 
 await client.createDeposit({
   token: '0xUSDC_ADDRESS',
-  amount: 10000000000n, // 10,000 USDC (6 decimals)
-  intentAmountRange: { min: 100000n, max: 1000000000n },
-  processorNames: ['wise', 'revolut'],
-  depositData: [
-    { email: 'maker@example.com' }, // Wise payment details
-    { tag: '@maker' }, // Revolut payment details
-  ],
-  conversionRates: [
-    [{ currency: Currency.USD, conversionRate: '1020000000000000000' }], // 1.02 (18 decimals)
-    [{ currency: Currency.EUR, conversionRate: '950000000000000000' }], // 0.95 (18 decimals)
-  ],
-  onSuccess: ({ hash }) => console.log('Deposit created:', hash),
+  amount: 10_000_000n,
+  intentAmountRange: { min: 100_000n, max: 5_000_000n },
+  processorNames: ['wise'],
+  depositData: [{ email: 'maker@example.com' }],
+  conversionRates: [[{ currency: Currency.USD, conversionRate: '1020000000000000000' }]],
 });
 ```
 
-### Managing Deposit Settings
-
-```typescript
-// Toggle accepting intents
-await client.setAcceptingIntents({ depositId: 1n, accepting: true });
+### Configure Oracle Spread (EscrowV2)
 
-// Update intent amount range
-await client.setIntentRange({ depositId: 1n, min: 50000n, max: 5000000n });
-
-// Set minimum conversion rate for a currency
-await client.setCurrencyMinRate({
-  depositId: 1n,
-  paymentMethod: '0x...',
-  fiatCurrency: '0x...',
-  minConversionRate: 1020000n, // 1.02 rate
+```ts
+await client.setOracleRateConfig({
+  depositId: 42n,
+  paymentMethodHash: '0x...',
+  currencyHash: '0x...',
+  config: {
+    adapter: '0x...',
+    adapterConfig: '0x',
+    spreadBps: 50,
+    maxStaleness: 180,
+  },
 });
 ```
 
-### Fund Management
-
-```typescript
-// Add more funds to your deposit
-await client.addFunds({ depositId: 1n, amount: 5000000n });
-
-// Remove funds from deposit
-await client.removeFunds({ depositId: 1n, amount: 1000000n });
-
-// Withdraw entire deposit
-await client.withdrawDeposit({ depositId: 1n });
-```
-
-### Querying Deposits (RPC-first)
-
-```typescript
-// Get all your deposits (instant on-chain query)
-const deposits = await client.getDeposits();
-
-// Get deposits for any address
-const ownerDeposits = await client.getAccountDeposits('0xOwnerAddress');
-
-// Get a specific deposit by ID
-const deposit = await client.getDeposit(42n);
-console.log(`Available liquidity: ${deposit.availableLiquidity}`);
-console.log(`Payment methods: ${deposit.paymentMethods.length}`);
-
-// Get multiple deposits by ID
-const batch = await client.getDepositsById([1n, 2n, 3n]);
-```
-
-### Querying Intents (RPC-first)
-
-```typescript
-// Get all your intents
-const intents = await client.getIntents();
-
-// Get intents for any address
-const ownerIntents = await client.getAccountIntents('0xOwnerAddress');
-
-// Get a specific intent by hash
-const intent = await client.getIntent('0xIntentHash...');
-```
-
-### Advanced Indexer Queries
+### Vault / DRM Operations
 
-For historical data, pagination, and advanced filtering:
-
-```typescript
-// Query with filters and pagination
-const deposits = await client.indexer.getDeposits(
-  { status: 'ACTIVE', minLiquidity: '1000000', depositor: '0xYourAddress' }, // Note: use 'depositor', not 'owner'
-  { limit: 50, orderBy: 'remainingDeposits', orderDirection: 'desc' },
-);
-
-// Get deposits with related data
-const depositsWithRelations = await client.indexer.getDepositsWithRelations(
-  { status: 'ACTIVE' },
-  { limit: 50 },
-  { includeIntents: true, intentStatuses: ['SIGNALED'] },
-);
-
-// Historical fulfillment records
-const fulfillments = await client.indexer.getFulfilledIntentEvents(['0x...']);
-
-// Find deposits by payee
-const payeeDeposits = await client.indexer.getDepositsByPayeeHash('0x...');
-```
-
-### Supporting: Intent Operations
-
-> **Note**: These methods are typically used by takers/buyers, not liquidity providers.
-
-```typescript
-// Signal an intent to use a deposit
-await client.signalIntent({
-  depositId: 1n,
-  amount: 1000000n,
-  toAddress: '0xRecipient',
-  processorName: 'wise',
-  fiatCurrencyCode: 'USD',
-  conversionRate: 1020000n,
-  payeeDetails: '0xPayeeHash',
+```ts
+// Create a vault (rate manager)
+await client.createRateManager({
+  config: {
+    manager: '0xManager',
+    feeRecipient: '0xFeeRecipient',
+    maxFee: 50_000_000_000_000_000n,
+    fee: 10_000_000_000_000_000n,
+    name: 'My Vault',
+    uri: 'ipfs://...',
+  },
 });
 
-// Fulfill an intent with a payment proof
-await client.fulfillIntent({
-  intentHash: '0xIntentHash',
-  proof: attestationProof,
+// Delegate a deposit to a vault
+await client.setRateManager({
+  depositId: 42n,
+  rateManagerAddress: '0xVaultAddress',
+  rateManagerId: '0xVaultId',
 });
 
-// Release funds back to deposit owner (liquidity providers may use this)
-await client.releaseFundsToPayer({ intentHash: '0x...' });
-
-// Cancel an intent
-await client.cancelIntent({ intentHash: '0x...' });
+// Update vault fee and config
+await client.setVaultFee({ rateManagerId: '0xVaultId', newFee: 20_000_000_000_000_000n });
+await client.setVaultConfig({
+  rateManagerId: '0xVaultId',
+  newManager: '0xNewManager',
+  newFeeRecipient: '0xNewFeeRecipient',
+  newName: 'Updated Vault',
+  newUri: 'ipfs://updated',
+});
 ```
 
-### Supporting: Getting Quotes
+### Query Indexer Data
 
-> **Note**: Primarily used by frontend applications to display available liquidity.
+```ts
+const deposits = await client.indexer.getDeposits(
+  { status: 'ACTIVE', depositor: '0xYourAddress' },
+  { limit: 25 },
+);
 
-```typescript
-const quote = await client.getQuote({
-  paymentPlatforms: ['wise', 'revolut'],
-  fiatCurrency: 'USD',
-  user: '0xUserAddress',
-  recipient: '0xRecipientAddress',
-  destinationChainId: 8453,
-  destinationToken: '0xUSDC',
-  amount: '100',
-});
+const amounts = await client.indexer.getIntentFulfillmentAmounts('0xIntentHash');
+// amounts?.releasedAmount, amounts?.takerAmountNetFees
 ```
 
 ## React Hooks
 
-The SDK provides React hooks for all deposit and intent operations via a dedicated subpath:
-
 ```tsx
 import {
   useCreateDeposit,
-  useAddFunds,
-  useRemoveFunds,
-  useWithdrawDeposit,
-  useSetAcceptingIntents,
-  useSetIntentRange,
-  useSetCurrencyMinRate,
-  useAddPaymentMethods,
-  useRemovePaymentMethod,
-  useAddCurrencies,
   useSignalIntent,
-  useFulfillIntent,
-  useReleaseFundsToPayer,
-  usePruneExpiredIntents,
-  useSetDelegate,
-  useRemoveDelegate,
+  useCreateVault,
+  useVaultDelegation,
+  useSetVaultFee,
+  useSetDepositorFloor,
 } from '@zkp2p/sdk/react';
-
-function DepositManager({ client }) {
-  const { createDeposit, isLoading, error } = useCreateDeposit({ client });
-  const { addFunds } = useAddFunds({ client });
-  const { setAcceptingIntents } = useSetAcceptingIntents({ client });
-
-  const handleCreate = async () => {
-    const result = await createDeposit({
-      token: '0xUSDC_ADDRESS',
-      amount: 10000000000n,
-      intentAmountRange: { min: 100000n, max: 1000000000n },
-      processorNames: ['wise'],
-      depositData: [{ email: 'maker@example.com' }],
-      conversionRates: [[{ currency: 'USD', conversionRate: '1020000000000000000' }]], // 1.02 (18 decimals)
-    });
-    console.log('Created deposit:', result.hash);
-  };
-
-  return (
-    <div>
-      <button disabled={isLoading} onClick={handleCreate}>
-        {isLoading ? 'Creating...' : 'Create Deposit'}
-      </button>
-      {error && <p>Error: {error.message}</p>}
-    </div>
-  );
-}
 ```
 
-## Payment Methods
-
-Supported payment platforms:
-
-| Platform    | Key           | Currencies          |
-| ----------- | ------------- | ------------------- |
-| Wise        | `wise`        | USD, EUR, GBP, etc. |
-| Venmo       | `venmo`       | USD                 |
-| Revolut     | `revolut`     | USD, EUR, GBP, etc. |
-| CashApp     | `cashapp`     | USD                 |
-| PayPal      | `paypal`      | USD, EUR, etc.      |
-| Zelle       | `zelle`       | USD                 |
-| Monzo       | `monzo`       | GBP                 |
-| Chime       | `chime`       | USD                 |
-| Luxon       | `luxon`       | USD, EUR, GBP       |
-| N26         | `n26`         | EUR                 |
-| MercadoPago | `mercadopago` | BRL, ARS, MXN       |
-
-```typescript
-import { getPaymentMethodsCatalog, PLATFORM_METADATA, PAYMENT_PLATFORMS } from '@zkp2p/sdk';
-
-// Available payment platforms
-console.log(PAYMENT_PLATFORMS); // ['wise', 'venmo', 'revolut', 'cashapp', 'mercadopago', 'zelle', 'paypal', 'monzo', 'chime', 'luxon', 'n26']
-
-// Get payment method hashes
-const methods = getPaymentMethodsCatalog(8453, 'production');
-const wiseHash = methods['wise'].paymentMethodHash;
-
-// Get platform metadata
-const wiseInfo = PLATFORM_METADATA['wise'];
-console.log(wiseInfo.displayName); // "Wise"
-```
+## Contracts and Catalog Helpers
 
-## Currency Utilities
-
-```typescript
+```ts
 import {
-  Currency,
-  currencyInfo,
-  getCurrencyInfoFromHash,
+  getContracts,
+  getRateManagerContracts,
+  getPaymentMethodsCatalog,
   resolveFiatCurrencyBytes32,
+  resolvePaymentMethodHash,
 } from '@zkp2p/sdk';
 
-// Use currency constants
-const usd = Currency.USD;
-const eur = Currency.EUR;
-
-// Get currency info
-const info = currencyInfo[Currency.USD];
-console.log(info.currencySymbol); // "$"
-
-// Convert to bytes32 for on-chain use
-const usdBytes = resolveFiatCurrencyBytes32('USD');
-```
-
-## Contract Helpers
-
-```typescript
-import { getContracts, getPaymentMethodsCatalog } from '@zkp2p/sdk';
-
-// Get contract addresses and ABIs
-const { addresses, abis } = getContracts(8453, 'production');
-console.log(addresses.escrow); // Contract addresses use camelCase
-console.log(addresses.orchestrator);
-
-// Get payment methods catalog
-const catalog = getPaymentMethodsCatalog(8453, 'production');
-```
-
-## Supported Networks
-
-| Network      | Chain ID | Environment  |
-| ------------ | -------- | ------------ |
-| Base Mainnet | 8453     | `production` |
-| Base Sepolia | 84532    | `staging`    |
-
-## API Reference
-
-### Query Methods (RPC-first)
-
-**Deposits (instant on-chain reads):**
-
-- `getDeposits()` - Get connected wallet's deposits
-- `getAccountDeposits(owner)` - Get deposits for any address
-- `getDeposit(depositId)` - Get single deposit by ID
-- `getDepositsById(ids)` - Batch fetch deposits
-
-**Intents (instant on-chain reads):**
-
-- `getIntents()` - Get connected wallet's intents
-- `getAccountIntents(owner)` - Get intents for any address
-- `getIntent(intentHash)` - Get single intent by hash
-
-**Utilities:**
-
-- `resolvePayeeHash(depositId, paymentMethodHash)` - Get payee details hash
-
-**Token Allowance:**
-
-- `ensureAllowance(params)` - Check/set ERC20 allowance for deposits
-
-### Core Methods (Deposit Management)
-
-**Creating & Managing Deposits:**
-
-- `createDeposit(params)` - Create a new liquidity deposit
-- `addFunds(params)` - Add funds to deposit
-- `removeFunds(params)` - Remove funds from deposit
-- `withdrawDeposit(params)` - Withdraw entire deposit
-
-**Configuring Deposits:**
-
-- `setAcceptingIntents(params)` - Toggle intent acceptance
-- `setIntentRange(params)` - Set min/max intent amounts
-- `setCurrencyMinRate(params)` - Set minimum conversion rate
-- `setDelegate(params)` / `removeDelegate(params)` - Manage delegates
-- `addPaymentMethods(params)` - Add payment platforms (requires `currencies` array per method)
-- `setPaymentMethodActive(params)` - Enable/disable payment methods
-- `addCurrencies(params)` / `deactivateCurrency(params)` - Manage currencies
-
-### Indexer Methods (`client.indexer.*`)
-
-For historical data, pagination, and advanced filtering:
-
-- `indexer.getDeposits(filter?, pagination?)` - Query deposits with filters
-- `indexer.getDepositsWithRelations(filter?, pagination?, options?)` - Include payment methods/intents
-- `indexer.getDepositById(compositeId, options?)` - Get by composite ID
-- `indexer.getDepositsByPayeeHash(hash, options?)` - Find by payee
-- `indexer.getOwnerIntents(owner, statuses?)` - Get owner's intents
-- `indexer.getExpiredIntents(params)` - Find expired intents
-- `indexer.getFulfilledIntentEvents(intentHashes)` - Historical fulfillments
-- `indexer.getFulfillmentAndPayment(intentHash)` - Verification records
-- `indexer.client.query(request, { retries?, rateLimitRetries? })` - Raw GraphQL query with retry controls
-
-### Supporting Methods
-
-**Intent Operations** (typically used by takers, not liquidity providers):
-
-- `signalIntent(params)` - Signal an intent to use a deposit
-- `fulfillIntent(params)` - Fulfill with attestation proof
-- `cancelIntent(params)` - Cancel an intent
-- `releaseFundsToPayer(params)` - Release funds back to deposit
-- `pruneExpiredIntents(params)` - Clean up expired intents
-
-**Quote API** (used by frontends):
-
-- `getQuote(params)` - Get available exchange quotes
-
-## Token Allowance Management
-
-Before creating deposits or adding funds, you may need to approve the escrow contract to spend your tokens:
-
-```typescript
-// Check and set allowance if needed
-const result = await client.ensureAllowance({
-  token: '0xUSDC_ADDRESS',
-  amount: 10000000000n, // Amount to approve
-  spender: addresses.escrow, // Optional: defaults to escrow contract
-  maxApprove: false, // Optional: set to true for unlimited approval
-});
-
-if (result.hadAllowance) {
-  console.log('Already had sufficient allowance');
-} else {
-  console.log('Approval transaction:', result.hash);
-}
+const { addresses } = getContracts(8453, 'staging');
+const rateManager = getRateManagerContracts(8453, 'staging');
+const catalog = getPaymentMethodsCatalog(8453, 'staging');
 ```
 
-## Low-Level Method Parameters
-
-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 }]],
-});
+## Supported Payment Platforms
 
-// addCurrencies - Add currencies to a payment method
-await client.addCurrencies({
-  depositId: 1n,
-  paymentMethod: '0x...', // bytes32 payment method hash
-  currencies: [
-    { code: '0x...', minConversionRate: 1020000000000000000n }, // bytes32 currency code, 18 decimals
-  ],
-});
+`wise`, `venmo`, `revolut`, `cashapp`, `mercadopago`, `zelle`, `paypal`, `monzo`, `chime`, `luxon`, `n26`
 
-// deactivateCurrency - Remove a currency from a payment method
-await client.deactivateCurrency({
-  depositId: 1n,
-  paymentMethod: '0x...', // bytes32 payment method hash
-  currencyCode: '0x...', // bytes32 currency code
-});
+## Extension SDK Helpers
 
-// setPaymentMethodActive - Enable/disable a payment method
-await client.setPaymentMethodActive({
-  depositId: 1n,
-  paymentMethod: '0x...', // bytes32 payment method hash (not paymentMethodHash)
-  isActive: true,
-});
+If you integrate with the Peer extension:
 
-// setCurrencyMinRate - Update minimum conversion rate
-await client.setCurrencyMinRate({
-  depositId: 1n,
-  paymentMethod: '0x...', // bytes32 payment method hash
-  fiatCurrency: '0x...', // bytes32 currency code (not currencyCode)
-  minConversionRate: 1020000000000000000n, // 18 decimals
-});
-```
-
-## Error Handling
-
-```typescript
-import { ValidationError, NetworkError, ContractError } from '@zkp2p/sdk';
-
-try {
-  await client.createDeposit({
-    /* ... */
-  });
-} catch (error) {
-  if (error instanceof ValidationError) {
-    console.error('Invalid parameters:', error.message);
-  } else if (error instanceof NetworkError) {
-    console.error('Network issue:', error.message);
-  } else if (error instanceof ContractError) {
-    console.error('Contract error:', error.message);
-  }
-}
-```
-
-## Logging
-
-```typescript
-import { setLogLevel } from '@zkp2p/sdk';
-
-// Set log level: 'debug' | 'info' | 'warn' | 'error' | 'none'
-setLogLevel('debug');
-```
-
-## TypeScript Support
-
-Full TypeScript support with exported types:
+```ts
+import { peerExtensionSdk } from '@zkp2p/sdk';
 
-```typescript
-import type {
-  CreateDepositParams,
-  SignalIntentParams,
-  FulfillIntentParams,
-  IndexerDeposit,
-  IndexerIntent,
-  CurrencyType,
-  PaymentPlatformType,
-} from '@zkp2p/sdk';
+const state = await peerExtensionSdk.getState();
+if (state === 'needs_install') peerExtensionSdk.openInstallPage();
 ```
 
-## Contributing
+## Development
 
 ```bash
 cd packages/sdk
-npm install
-npm run build
-npm run test
-npm run lint
+pnpm build
+pnpm test
+pnpm typecheck
+pnpm lint
 ```
 
-## License
-
-MIT License - see [LICENSE](LICENSE) for details.
-
 ## Links
 
-- [NPM Package](https://www.npmjs.com/package/@zkp2p/sdk)
-- [GitHub Repository](https://github.com/zkp2p/zkp2p-clients/tree/main/packages/sdk)
-- [Documentation](https://docs.zkp2p.xyz)
-
-## Support
-
-- GitHub Issues: [Create an issue](https://github.com/zkp2p/zkp2p-clients/issues)
-- Email: support@zkp2p.xyz
+- NPM: https://www.npmjs.com/package/@zkp2p/sdk
+- Monorepo: https://github.com/zkp2p/zkp2p-clients
+- Docs: https://docs.zkp2p.xyz