Peer

https://github.com/zkp2p/docs
Admin
Peer is a permissionless peer-to-peer protocol that enables users to exchange fiat currencies for...
Tokens:76,401
Snippets:798
Trust Score:7.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install and Initialize ZKP2P SDK

Source: https://github.com/zkp2p/docs/blob/main/static/create-a-vault-llm.md

Setup instructions and client initialization for the @zkp2p/sdk.

```bash
npm install @zkp2p/sdk
```

```typescript
import { Zkp2pClient } from '@zkp2p/sdk';
import { createWalletClient, http } from 'viem';
import { base } from 'viem/chains';
import { privateKeyToAccount } from 'viem/accounts';

const client = new Zkp2pClient({
  walletClient: createWalletClient({
    account: privateKeyToAccount(PRIVATE_KEY),
    chain: base,
    transport: http(RPC_URL),
  }),
  chainId: 8453,
  runtimeEnv: 'production',
});
```

--------------------------------

### Quick Start with Zkp2pClient

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/overview.md

Initialize the Zkp2pClient with a viem wallet client and chain ID to interact with the SDK. This example fetches deposits.

```typescript
import { Zkp2pClient } from '@zkp2p/sdk';
import { createWalletClient, custom } from 'viem';
import { base } from 'viem/chains';

const walletClient = createWalletClient({
  chain: base,
  transport: custom(window.ethereum),
});

const client = new Zkp2pClient({
  walletClient,
  chainId: base.id,
});

const deposits = await client.getDeposits();
console.log(deposits.length);
```

--------------------------------

### SDK Installation

Source: https://context7.com/zkp2p/docs/llms.txt

Instructions on how to install the Peer TypeScript SDK and its dependencies.

```APIDOC
## SDK Installation

Install the TypeScript SDK for building integrations with Peer protocol.

```bash
npm install @zkp2p/sdk viem
# or
yarn add @zkp2p/sdk viem
# or
pnpm add @zkp2p/sdk viem
```
```

--------------------------------

### Install ZKP2P SDK

Source: https://github.com/zkp2p/docs/blob/main/developer/offramp-integration.md

Install the required packages using npm, yarn, or pnpm.

```bash
npm install @zkp2p/sdk viem
# or
yarn add @zkp2p/sdk viem
# or
pnpm add @zkp2p/sdk viem
```

--------------------------------

### Install Core SDK and Viem

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/overview.md

Install the core SDK and viem for managing deposits and intents. Add react if using the hooks package.

```bash
npm install @zkp2p/sdk viem
# or
yarn add @zkp2p/sdk viem
# or
pnpm add @zkp2p/sdk viem
# or
bun add @zkp2p/sdk viem
```

```bash
npm install react
# or
yarn add react
# or
pnpm add react
# or
bun add react
```

--------------------------------

### Install dependencies

Source: https://github.com/zkp2p/docs/blob/main/README.md

Run this command to install all project dependencies defined in the package manager.

```bash
yarn
```

--------------------------------

### Install Peerlytics SDK

Source: https://github.com/zkp2p/docs/blob/main/static/create-a-vault-llm.md

Install the Peerlytics SDK via npm.

```bash
npm install @peerlytics/sdk
```

--------------------------------

### Install and Import zkTLS Providers Package

Source: https://context7.com/zkp2p/docs/llms.txt

Install the zkTLS providers package using npm and import provider templates for use in your project. Ensure you have Node.js and npm installed.

```bash
# Install providers package
npm install @zkp2p/providers
```

```javascript
# Import provider templates
const venmo = require('@zkp2p/providers/venmo/transfer_venmo.json');
const manifest = require('@zkp2p/providers/providers.json');
```

--------------------------------

### Start local development server

Source: https://github.com/zkp2p/docs/blob/main/README.md

Launches a local development server with live reloading for rapid iteration.

```bash
yarn start
```

--------------------------------

### Install Zkp2p SDK, viem, and React

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/react-hooks.md

Install the necessary packages for using the Zkp2p SDK with React. React version 16.8.0 or higher is a peer dependency.

```bash
npm install @zkp2p/sdk viem react
# or
yarn add @zkp2p/sdk viem react
# or
pnpm add @zkp2p/sdk viem react
# or
bun add @zkp2p/sdk viem react
```

--------------------------------

### Post-Intent Hook Example: 95/5 Split

Source: https://github.com/zkp2p/docs/blob/main/developer/post-intent-hooks.md

An example demonstrating how to implement a post-intent hook to split funds with a 95/5 ratio.

```APIDOC
## Post-Intent Hook Example: 95/5 Split

### Description
This example shows a post-intent hook that splits the `executableAmount` into 95% for the recipient (`ctx.intent.to`) and 5% for a builder address.

### Code Example
```solidity
function execute(HookExecutionContext calldata ctx, bytes calldata) external override {
    require(msg.sender == orchestrator, "only orchestrator");
    uint256 fee = ctx.executableAmount * 5 / 100;
    uint256 toAmt = ctx.executableAmount - fee;
    IERC20(ctx.token).transferFrom(msg.sender, ctx.intent.to, toAmt);
    IERC20(ctx.token).transferFrom(msg.sender, builder, fee); // Assuming 'builder' is a state variable or passed in
}
```
```

--------------------------------

### Install Claude Code zkill Skill

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Install the Claude Code zkill for creating ZKP2P providers. This involves cloning the repository and running an installation script.

```bash
git clone https://github.com/zkp2p/zkills.git
cd zkills
./scripts/install-claude.sh
```

--------------------------------

### Basic Configuration Field Examples

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Examples of basic configuration fields for ZKP2P, including action type, authentication link, API URL, HTTP method, skipped headers, and request body.

```json
"transfer_venmo"
```

```json
"https://venmo.com/login"
```

```json
"https://api.venmo.com/v1/payments"
```

```json
"POST"
```

```json
["User-Agent", "Accept-Language"]
```

```json
"{\"amount\": \"{{AMOUNT}}\", \"recipient\": \"{{RECIPIENT}}\"}"
```

--------------------------------

### Example Calculation: Days per Cycle

Source: https://github.com/zkp2p/docs/blob/main/guides/for-sellers/calculating-apr.md

Demonstrates the calculation of days per cycle using specific example values for platform liquidity and average daily volume.

```plaintext
1,000,000 / 100,000 = 10 days
```

--------------------------------

### Post-Intent Hook Example: 95/5 Split

Source: https://github.com/zkp2p/docs/blob/main/developer/post-intent-hooks.md

An example `execute` function for a post-intent hook that splits the executable amount into a 95% portion for the recipient and a 5% portion for a builder address.

```solidity
function execute(HookExecutionContext calldata ctx, bytes calldata) external override {\n    require(msg.sender == orchestrator, \"only orchestrator\");\n    uint256 fee = ctx.executableAmount * 5 / 100;\n    uint256 toAmt = ctx.executableAmount - fee;\n    IERC20(ctx.token).transferFrom(msg.sender, ctx.intent.to, toAmt);\n    IERC20(ctx.token).transferFrom(msg.sender, builder, fee);\n}
```

--------------------------------

### Install @zkp2p/providers Package

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Install the ZKP2P providers package using npm or yarn. This package is data-only, containing JSON templates and documentation.

```bash
npm install @zkp2p/providers
# or
yarn add @zkp2p/providers
```

--------------------------------

### Configure Parameter Selectors

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Example configuration for extracting parameters using regex, JSONPath, and XPath from different sources.

```json
{
  "paramNames": ["userId", "transactionId", "amount"],
  "paramSelectors": [
    {
      "type": "regex",
      "value": "userId=([^&]+)",
      "source": "url"
    },
    {
      "type": "jsonPath",
      "value": "$.data.transactions[{{INDEX}}].id",
      "source": "responseBody"
    },
    {
      "type": "xPath",
      "value": "normalize-space(//div[@class='tx-amount'][{{INDEX}} + 1])",
      "source": "responseBody"
    },
    {
      "type": "regex",
      "value": "X-Transaction-Amount: ([0-9.]+)",
      "source": "responseHeaders"
    }
  ]
}
```

--------------------------------

### Example Calculation: Spread

Source: https://github.com/zkp2p/docs/blob/main/guides/for-sellers/calculating-apr.md

Shows the calculation of the spread using example values for conversion rate and currency price. The result is presented as both a decimal and a percentage.

```plaintext
(1.55 - 1.50) / 1.50 ≈ 0.0333 (3.33%)
```

--------------------------------

### Install Codex zkill Skill

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Install the Codex zkill for creating ZKP2P providers. This skill assists in mapping network requests to template selectors.

```bash
codex
$skill-installer https://github.com/zkp2p/zkills/tree/main/src/codex/create-zkp2p-provider
```

--------------------------------

### Example Calculation: Fees per Cycle

Source: https://github.com/zkp2p/docs/blob/main/guides/for-sellers/calculating-apr.md

Demonstrates the calculation of fees generated per cycle using example deposit amount and the calculated spread. The result is shown in USDC.

```plaintext
10,000 * 0.0333 ≈ 333.33 USDC
```

--------------------------------

### Post-Intent Hook Example: Pull-then-Act Pattern

Source: https://github.com/zkp2p/docs/blob/main/developer/post-intent-hooks.md

An example illustrating the pull-then-act pattern for post-intent hooks, where the hook first pulls tokens and then performs further actions.

```APIDOC
## Post-Intent Hook Example: Pull-then-Act Pattern

### Description
This example demonstrates the pull-then-act pattern. The hook first pulls the `executableAmount` into its own contract and then proceeds with further actions like routing through a bridge, router, or other DeFi protocols. Finally, it forwards the remaining amount to the original recipient.

### Code Example
```solidity
function execute(HookExecutionContext calldata ctx, bytes calldata) external override {
    require(msg.sender == orchestrator, "only orchestrator");
    IERC20(ctx.token).transferFrom(msg.sender, address(this), ctx.executableAmount);
    // Now you hold the tokens — approve a router, bridge, stake, swap, etc.
    // Forward remainder to ctx.intent.to
    IERC20(ctx.token).transferFrom(address(this), ctx.intent.to, ctx.executableAmount); // Example of forwarding
}
```
```

--------------------------------

### Directory Structure Overview

Source: https://github.com/zkp2p/docs/blob/main/AGENTS.md

Illustrates the organization of the ZKP2P documentation project, including sections for user guides, protocol details, developer integration, brand assets, and blog content.

```bash
docs/
├── guides/                    # User guides (buyers/sellers)
│   ├── for-buyers/
│   ├── for-sellers/
│   ├── introduction/
│   └── privacy-safety/
g├── protocol/                  # Protocol technical docs
│   ├── v2/                    # Legacy V2 contracts
│   ├── v3/                    # Current V3 architecture
│   └── peerauth-extension/    # Browser extension docs
g├── developer/                 # Integration documentation
│   └── integrate-zkp2p/
g├── brand-kit/                 # Brand asset downloads
g├── blog/                      # Blog markdown (SEO/fallback)
g├── src/
│   ├── brand/                 # Design system package (@zkp2p/brand)
│   ├── css/                   # Global styles
│   └── pages/                 # Custom React pages
g├── static/                    # Static assets
g├── docusaurus.config.js       # Main config
g└── *-sidebars.js              # Sidebar configs
```

--------------------------------

### Import and Apply Design Tokens

Source: https://github.com/zkp2p/docs/blob/main/src/brand/DESIGN_SYSTEM_RULES.md

Example usage of the @zkp2p/brand package to apply typography, colors, and gradients in TypeScript.

```typescript
import {
  colors,
  gradients,
  typography,
  mobileTypography,
  radii,
} from "@zkp2p/brand";

// Desktop headline
const heroStyle = {
  ...typography.hero,
  color: colors.white,
};

// Mobile headline
const mobileHeroStyle = {
  ...mobileTypography.h1,
  color: colors.white,
};

// Button with gradient
const buttonStyle = {
  ...typography.button,
  background: gradients.ignite,
  color: colors.black,
  borderRadius: radii.md,
};
```

--------------------------------

### Docusaurus Development Commands

Source: https://github.com/zkp2p/docs/blob/main/CLAUDE.md

Common commands for running and building the Docusaurus documentation site. Use `yarn start` for local development.

```bash
yarn start     # Dev server at localhost:3000
yarn build     # Production build to /build
yarn serve     # Serve production build
yarn clear     # Clear Docusaurus cache
```

--------------------------------

### GET /verify/supported

Source: https://github.com/zkp2p/docs/blob/main/protocol/v3/attestation-service.md

Lists the supported verifiers along with their corresponding typed data specifications.

```APIDOC
## GET /verify/supported

### Description
Retrieves a list of supported verifiers and their associated EIP-712 typed data specifications.

### Method
GET

### Endpoint
/verify/supported

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **supportedVerifiers** (object) - An object where keys are verifier names and values are their typed data specifications.

#### Response Example
```json
{
  "success": true,
  "message": "Supported verifiers list",
  "responseObject": {
    "verifier_name_1": {
      "primaryType": "PaymentAttestation",
      "types": {
        "PaymentAttestation": [
          { "name": "intentHash", "type": "bytes32" },
          { "name": "releaseAmount", "type": "uint256" },
          { "name": "dataHash", "type": "bytes32" }
        ]
      }
    },
    "verifier_name_2": { ... }
  }
}
```
```

--------------------------------

### WhitelistPreIntentHook Setup and Management

Source: https://github.com/zkp2p/docs/blob/main/protocol/v3/smart-contracts/pre-intent-hooks.md

Sets up and manages the WhitelistPreIntentHook for address-based access control per deposit and payment method. Only whitelisted taker addresses can signal intents.

```solidity
// Setup:
// 1. Set the hook: orchestrator.setDepositWhitelistHook(escrow, depositId, whitelistHookAddress)
// 2. Add addresses: whitelistHook.addToWhitelist(escrow, depositId, paymentMethod, addresses[])
//
// Management:
// - removeFromWhitelist(escrow, depositId, paymentMethod, addresses[]) — Remove addresses.
// - isWhitelisted(escrow, depositId, paymentMethod, taker) — Check if an address is whitelisted.
```

--------------------------------

### Implement Custom Pre-Intent Hook

Source: https://github.com/zkp2p/docs/blob/main/developer/post-intent-hooks.md

Example implementation of a custom hook that validates intent parameters before execution.

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.18;

import { IPreIntentHook } from "zkp2p-v2-contracts/contracts/interfaces/IPreIntentHook.sol";

contract MyGatingHook is IPreIntentHook {
    function validateSignalIntent(PreIntentContext calldata ctx) external override {
        // Example: only allow intents above 100 USDC (6 decimals)
        require(ctx.amount >= 100e6, "amount too low");

        // Example: only allow specific payment methods
        require(ctx.paymentMethod == keccak256("venmo"), "method not allowed");

        // Returning without reverting = intent approved
    }
}
```

--------------------------------

### Create a Deposit (Liquidity Provider)

Source: https://context7.com/zkp2p/docs/llms.txt

Guides liquidity providers on creating a new deposit, specifying token amount, accepted payment methods, and conversion rates.

```APIDOC
## Create a Deposit (Liquidity Provider)

Liquidity providers create deposits specifying token amount, payment methods, and conversion rates.

```typescript
import { Currency } from '@zkp2p/sdk';

const txHash = await client.createDeposit({
  token: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', // USDC on Base
  amount: 10000_000000n,  // 10,000 USDC (6 decimals)
  intentAmountRange: { min: 10_000000n, max: 1000_000000n }, // 10-1000 USDC per intent
  processorNames: ['wise', 'revolut'],
  depositData: [
    { wisetag: 'maker' },           // Wise payee details
    { revolutUsername: 'maker' },   // Revolut payee details
  ],
  conversionRates: [
    [{ currency: Currency.USD, conversionRate: '1020000000000000000' }], // 1.02 rate (18 decimals)
    [{ currency: Currency.EUR, conversionRate: '950000000000000000' }],  // 0.95 rate
  ],
  onSuccess: ({ hash }) => console.log('Deposit created:', hash),
});
```
```

--------------------------------

### Example Calculation: APR

Source: https://github.com/zkp2p/docs/blob/main/guides/for-sellers/calculating-apr.md

Shows the final calculation of the APR using the total annual fees and the deposit amount. The result is presented as a percentage.

```plaintext
(12,166 / 10,000) * 100% ≈ 121.66%
```

--------------------------------

### Example Calculation: Number of Cycles per Year

Source: https://github.com/zkp2p/docs/blob/main/guides/for-sellers/calculating-apr.md

Illustrates the calculation for the number of cycles per year using the previously calculated days per cycle value.

```plaintext
365 / 10 = 36.5
```

--------------------------------

### Initialize SDK Client

Source: https://context7.com/zkp2p/docs/llms.txt

Demonstrates how to initialize the Zkp2pClient with a viem wallet client for interacting with the Peer protocol.

```APIDOC
## Initialize SDK Client

Create a Zkp2pClient instance with a viem wallet client for read and write operations.

```typescript
import { Zkp2pClient } from '@zkp2p/sdk';
import { createWalletClient, custom } from 'viem';
import { base } from 'viem/chains';

const walletClient = createWalletClient({
  chain: base,
  transport: custom(window.ethereum),
});

const client = new Zkp2pClient({
  walletClient,
  chainId: base.id,           // 8453 for Base mainnet
  runtimeEnv: 'production',   // 'production' | 'preproduction' | 'staging'
});

// Fetch all deposits
const deposits = await client.getDeposits();
console.log('Total deposits:', deposits.length);
```
```

--------------------------------

### Install Chrome DevTools MCP for Skills

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Install the Chrome DevTools MCP (Message Channel Protocol) which is required for using ZKP2P skills like Codex and Claude Code for network capture. Restart your client after installation.

```bash
codex mcp add chrome-devtools -- npx chrome-devtools-mcp@latest
```

```bash
claude mcp add chrome-devtools -- npx chrome-devtools-mcp@latest
```

--------------------------------

### Initialize the SDK

Source: https://github.com/zkp2p/docs/blob/main/static/onramp-llm.md

Create a scoped instance of the SDK using the window object.

```ts
import { createPeerExtensionSdk } from '@zkp2p/sdk';

const peerSdk = createPeerExtensionSdk({ window });
```

--------------------------------

### Parameter Extraction Field Example

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Example of the `paramNames` field, which specifies an array of strings representing the names of parameters to be extracted.

```json
["transactionId", "amount", "recipient"]
```

--------------------------------

### Initialize Zkp2pClient

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/client-reference.md

Instantiate the Zkp2pClient with a viem WalletClient and chain ID. Ensure the WalletClient has an attached account for signing.

```typescript
import { Zkp2pClient } from '@zkp2p/sdk';

const client = new Zkp2pClient({
  walletClient,
  chainId: 8453,
});
```

--------------------------------

### Initialize SDK Client

Source: https://context7.com/zkp2p/docs/llms.txt

Initialize the Zkp2pClient with a viem wallet client for read and write operations. Ensure the correct chain ID and runtime environment are specified.

```typescript
import { Zkp2pClient } from '@zkp2p/sdk';
import { createWalletClient, custom } from 'viem';
import { base } from 'viem/chains';

const walletClient = createWalletClient({
  chain: base,
  transport: custom(window.ethereum),
});

const client = new Zkp2pClient({
  walletClient,
  chainId: base.id,           // 8453 for Base mainnet
  runtimeEnv: 'production',   // 'production' | 'preproduction' | 'staging'
});

// Fetch all deposits
const deposits = await client.getDeposits();
console.log('Total deposits:', deposits.length);
```

--------------------------------

### TypeScript SDK Initialization and Usage Pattern

Source: https://github.com/zkp2p/docs/blob/main/developer/CLAUDE.md

Illustrates the standard pattern for using the ZKP2P TypeScript SDK, including importing, initializing a client, and performing an action. Ensure the wallet client and chain ID are correctly provided during initialization.

```typescript
// 1. Import
import { SomeClient } from '@zkp2p/sdk';

// 2. Initialize
const client = new SomeClient({ walletClient, chainId });

// 3. Use
await client.someAction({ ...params });
```

--------------------------------

### Initialize OfframpClient

Source: https://github.com/zkp2p/docs/blob/main/developer/offramp-integration.md

Configure the client using a viem wallet client and the Base chain ID.

```ts
import { OfframpClient } from '@zkp2p/sdk';
import { createWalletClient, custom } from 'viem';
import { base } from 'viem/chains';

const walletClient = createWalletClient({
  chain: base,
  transport: custom(window.ethereum),
});

const client = new OfframpClient({
  walletClient,
  chainId: base.id,
});
```

--------------------------------

### Define Secret Headers

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

Example of specifying headers that contain sensitive information.

```json
["Authorization", "Cookie"]
```

--------------------------------

### Zkp2pClient Constructor

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/client-reference.md

Instantiate the Zkp2pClient with necessary options. The `walletClient` and `chainId` are required. Optional parameters allow for RPC overrides, environment settings, and API/indexer URL customization. API keys and authorization tokens are optional and enhance response richness.

```APIDOC
## Constructor

Create a client with `new Zkp2pClient(opts)`.

### Parameters
#### Request Body
- **walletClient** (Viem WalletClient) - Required - viem `WalletClient` with an attached account for signing
- **chainId** (number) - Required - Chain ID used for contract and API routing
- **rpcUrl** (string) - Optional - Optional RPC override; otherwise the SDK uses the wallet client's chain transport
- **runtimeEnv** (string) - Optional - Runtime environment: `production`, `preproduction`, or `staging`. Defaults to `production`
- **indexerUrl** (string) - Optional - Override for the indexer GraphQL endpoint
- **baseApiUrl** (string) - Optional - Override for ZKP2P service APIs
- **apiKey** (string) - Optional - Optional curator API key — not required for any method. When provided, some responses are enriched (e.g. `getQuote` returns maker `depositData`)
- **authorizationToken** (string) - Optional - Optional bearer token for hybrid authentication
- **getAuthorizationToken** (function) - Optional - Async token provider for long-lived clients
- **indexerApiKey** (string) - Optional - Optional `x-api-key` header for indexer proxy authentication
- **timeouts.api** (number) - Optional - API timeout in milliseconds

### Request Example
```ts
import { Zkp2pClient } from '@zkp2p/sdk';

const client = new Zkp2pClient({
  walletClient,
  chainId: 8453,
});
```

:::info No API key required
All SDK methods work without `apiKey` or `authorizationToken`. Auth credentials are optional and only affect response richness. `signalIntent()` can auto-fetch its gating signature when you provide `apiKey` or `authorizationToken`; if you do not want the SDK to make that request, pass `gatingServiceSignature` and `signatureExpiration` yourself.
:::
```

--------------------------------

### GET /on-chain-data

Source: https://context7.com/zkp2p/docs/llms.txt

Retrieves real-time deposits and intents directly from the on-chain state.

```APIDOC
## GET /on-chain-data

### Description
Read deposits and intents directly from on-chain state for real-time accuracy.

### Methods
- **getDeposits()**: Fetch all deposits
- **getAccountDeposits(owner)**: Fetch deposits for a specific owner
- **getDeposit(id)**: Fetch single deposit by ID
- **getIntents()**: Fetch all intents
- **getIntent(hash)**: Fetch single intent by hash
```

--------------------------------

### Initiate Onramp Flow with Peer Extension SDK

Source: https://github.com/zkp2p/docs/blob/main/developer/integrate-zkp2p/integrate-redirect-onramp.md

Use this code to check the Peer extension state, request connection if needed, register for fulfillment events, and then open the onramp flow with specified parameters. Ensure the Peer extension is installed and connected before proceeding. The `onIntentFulfilled` listener should be unsubscribed when no longer needed.

```typescript
import { peerExtensionSdk } from '@zkp2p/sdk';

const state = await peerExtensionSdk.getState();
if (state === 'needs_install') {
  peerExtensionSdk.openInstallPage();
  throw new Error('Peer extension not installed');
}

if (state === 'needs_connection') {
  const approved = await peerExtensionSdk.requestConnection();
  if (!approved) {
    throw new Error('Peer connection not approved');
  }
}

const unsubscribe = peerExtensionSdk.onIntentFulfilled((result) => {
  console.log('Peer order fulfilled:', result.intentHash, result.bridge.status);
});

peerExtensionSdk.onramp({
  referrer: 'Rampy Pay',
  referrerLogo: 'https://demo.peer.xyz/Rampy_logo.svg',
  inputCurrency: 'USD',
  inputAmount: '10',
  paymentPlatform: 'venmo',
  toToken: '8453:0x0000000000000000000000000000000000000000',
  recipientAddress: '0x84e113087C97Cd80eA9D78983D4B8Ff61ECa1929',
});

// Call unsubscribe() when your page no longer needs the listener.
```

--------------------------------

### GET /takerTiers

Source: https://context7.com/zkp2p/docs/llms.txt

Fetches tiering, cooldown, and platform-limit data for a specific taker address.

```APIDOC
## GET /takerTiers

### Description
Fetch tiering, cooldown, and platform-limit data for a taker address.

### Query Parameters
- **owner** (string) - Required - Taker address
- **chainId** (number) - Required - Chain ID

### Response
- **tier** (string) - Taker tier level
- **perIntentCapDisplay** (string) - Cap per intent
- **cooldownActive** (boolean) - Status of cooldown
- **nextIntentAvailableAt** (number) - Timestamp for next available intent
```

--------------------------------

### Create a Deposit

Source: https://context7.com/zkp2p/docs/llms.txt

Liquidity providers create deposits specifying token, amount, payment methods, and conversion rates. The `onSuccess` callback is triggered upon successful deposit creation.

```typescript
import { Currency } from '@zkp2p/sdk';

const txHash = await client.createDeposit({
  token: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', // USDC on Base
  amount: 10000_000000n,  // 10,000 USDC (6 decimals)
  intentAmountRange: { min: 10_000000n, max: 1000_000000n }, // 10-1000 USDC per intent
  processorNames: ['wise', 'revolut'],
  depositData: [
    { wisetag: 'maker' },           // Wise payee details
    { revolutUsername: 'maker' },   // Revolut payee details
  ],
  conversionRates: [
    [{ currency: Currency.USD, conversionRate: '1020000000000000000' }], // 1.02 rate (18 decimals)
    [{ currency: Currency.EUR, conversionRate: '950000000000000000' }],  // 0.95 rate
  ],
  onSuccess: ({ hash }) => console.log('Deposit created:', hash),
});
```

--------------------------------

### Validate Vault Registry

Source: https://github.com/zkp2p/docs/blob/main/guides/for-vault-managers/run-a-vault.md

Commands to install dependencies and run the validation script for the vault-list registry.

```bash
npm install && npm run validate
```

--------------------------------

### Build static site

Source: https://github.com/zkp2p/docs/blob/main/README.md

Compiles the project into static files located in the build directory.

```bash
yarn build
```

--------------------------------

### GET /indexer

Source: https://context7.com/zkp2p/docs/llms.txt

Queries historical data and advanced filtered records using the GraphQL indexer.

```APIDOC
## GET /indexer

### Description
Use the GraphQL indexer for advanced filtering, pagination, and historical records.

### Query Parameters
- **status** (string) - Optional - Filter by status (e.g., ACTIVE)
- **limit** (number) - Optional - Pagination limit
- **orderBy** (string) - Optional - Field to order results by
```

--------------------------------

### Get Next Tier Cap Utility

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/react-hooks.md

Returns the next cap threshold for a given tier.

```javascript
getNextTierCap(currentTier)
```

--------------------------------

### Check extension state

Source: https://github.com/zkp2p/docs/blob/main/static/onramp-llm.md

Retrieve the current state of the Peer extension to determine if installation or connection is required.

```ts
const state = await peerSdk.getState();
// Returns: 'needs_install' | 'needs_connection' | 'ready'
```

--------------------------------

### Metadata Configuration Example

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

This JSON object configures metadata for request matching, transaction extraction, and preprocessing. It includes settings for URL matching, fallback URLs, and user input prompts.

```json
"metadata": {
  "shouldReplayRequestInPage": false,
  "shouldSkipCloseTab": false,
  "platform": "venmo",
  "urlRegex": "https://api\\.venmo\\.com/v1/payments/\\d+",
  "method": "GET",
  "fallbackUrlRegex": "https://api\\.venmo\\.com/v1/transactions",
  "fallbackMethod": "GET",
  "preprocessRegex": "window.__data\s*=\s*({.*?});",
  "userInput": {
    "promptText": "Select a transfer below to proceed with authentication",
    "transactionXpath": "//section[@id='feed-pending-module']//div[contains(@class,'q1hbnk3w') and contains(@class,'q1hbnk5w')]"
  },
  "transactionsExtraction": {
    "transactionJsonPathListSelector": "$.data.transactions",
    "transactionJsonPathSelectors": {
      "recipient": "$.target.username",
      "amount": "$.amount",
      "date": "$.created_time",
      "paymentId": "$.id",
      "currency": "$.currency"
    },
    "transactionXPathListSelector": "",
    "transactionXPathSelectors": {}
  },
  "proofMetadataSelectors": [
    {
      "type": "jsonPath",
      "value": "$.data.user.id"
    }
  ]
}
```

--------------------------------

### Contract Interactions Reference

Source: https://github.com/zkp2p/docs/blob/main/guides/for-vault-managers/run-a-vault.md

A quick reference guide for common actions involving RateManagerV1 and EscrowV2 contracts.

```APIDOC
## Quick Reference

| Action | Contract | Function |
|---|---|---|
| Create vault | RateManagerV1 | `createRateManager(config)` where config is a `RateManagerConfig` struct |
| Set rate (single) | RateManagerV1 | `setRate(rateManagerId, paymentMethod, currencyCode, rate)` |
| Set rates (batch) | RateManagerV1 | `setRateBatch(rateManagerId, paymentMethods[], currencyCodes[][], rates[][])` |
| Change fee | RateManagerV1 | `setFee(rateManagerId, newFee)` |
| Change fee recipient | RateManagerV1 | `setFeeRecipient(rateManagerId, newRecipient)` |
| Depositor delegates | EscrowV2 | `setRateManager(depositId, rateManager, rateManagerId)` |
| Depositor exits | EscrowV2 | `clearRateManager(depositId)` |
| Depositor sets floor | EscrowV2 | `setCurrencyMinRate(depositId, paymentMethod, currencyCode, rate)` |
| Depositor sets oracle | EscrowV2 | `setOracleRateConfig(depositId, paymentMethod, currencyCode, config)` |
```

--------------------------------

### User Input Configuration Example

Source: https://github.com/zkp2p/docs/blob/main/developer/build-new-provider.md

This JSON object configures user input prompts for selecting transactions, useful for SPAs or feeds where a detail request follows a click. It specifies the prompt text and an XPath for selecting clickable transaction nodes.

```json
"userInput": {
  "promptText": "Select a transfer below to proceed with authentication",
  "transactionXpath": "//section[@id='feed-pending-module']//div[contains(@class,'q1hbnk3w') and contains(@class,'q1hbnk5w')]"
}
```

--------------------------------

### Deploy to GitHub Pages

Source: https://github.com/zkp2p/docs/blob/main/README.md

Commands for deploying the site to GitHub Pages, supporting both SSH and HTTPS authentication methods.

```bash
USE_SSH=true yarn deploy
```

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

--------------------------------

### Import Static Assets

Source: https://github.com/zkp2p/docs/blob/main/src/brand/CLAUDE.md

Import logos, icons, and videos directly from the @zkp2p/brand package. Ensure the asset path is correct for your build process.

```typescript
// Logos
import peerLogo from "@zkp2p/brand/logos/peer-logo-colour.svg";

// Icons
import starIcon from "@zkp2p/brand/icons/peer-icon-1.svg";

// Videos
import heroVideo from "@zkp2p/brand/videos/hero-desktop.mp4";
```

--------------------------------

### Get Taker Tier Action

Source: https://github.com/zkp2p/docs/blob/main/developer/sdk/react-hooks.md

Action returned by `useGetTakerTier` hook to manually fetch taker tier information.

```javascript
getTakerTier(params?)
```
Tokens:
Raw