uvd-x402-sdk 2.37.0 → 2.40.0

package/README.md

@@ -1,20 +1,22 @@
 # uvd-x402-sdk
 
-Gasless crypto payments across 21 blockchain networks using the x402 protocol.
+Gasless crypto payments across 23 blockchain networks using the x402 protocol.
 
 Users sign a message or transaction, and the Ultravioleta facilitator handles on-chain settlement. No gas fees for users.
 
 ## Features
 
-- **21 Networks**: EVM (13 including Scroll, SKALE Base), Solana, Fogo, Stellar, NEAR, Algorand, Sui
+- **23 Networks**: EVM (13 including Scroll, SKALE Base), Solana, Fogo, Stellar, NEAR, Algorand, Sui, XRP Ledger (mainnet + testnet)
 - **Multi-Stablecoin**: USDC, EURC, AUSD, PYUSD, USDT
 - **x402 v1 & v2**: Both protocol versions with auto-detection
 - **Gasless**: Facilitator pays all network fees
 - **Type-Safe**: Full TypeScript support
 - **React & Wagmi**: First-class integrations
 - **Signing Wallet Adapters**: EnvKeyAdapter (server/CLI), OWSWalletAdapter (Open Wallet Standard), or bring your own
-- **ERC-8004 Trustless Agents**: On-chain reputation and identity (EVM + Solana)
+- **ERC-8004 Trustless Agents**: On-chain reputation and identity across 20 networks (18 EVM + 2 Solana)
 - **Escrow & Refunds**: Hold payments with dispute resolution
+- **Advanced Escrow**: Full escrow lifecycle (authorize, release, refund, charge) with SigningWalletAdapter support
+- **Commerce Scheme**: `'commerce'` scheme alias for marketplace integrations (identical to `'escrow'` on-chain)
 - **`/accepts` Negotiation**: Discover facilitator capabilities before constructing payments
 - **Bazaar Discovery**: Register and discover paid resources across the x402 network
 - **Facilitator Info**: Query version, supported networks, blacklist, and health
@@ -45,6 +47,9 @@ npm install algosdk lute-connect
 
 # Sui
 npm install @mysten/sui
+
+# XRPL (XRP Ledger)
+npm install xrpl
 ```
 
 ## Quick Start
@@ -208,6 +213,35 @@ Sui uses sponsored transactions:
 - Facilitator sponsors gas (pays in SUI)
 - User pays zero gas fees
 
+### XRPL (XRP Ledger)
+
+```typescript
+import { XRPLProvider } from 'uvd-x402-sdk/xrpl';
+import { getChainByName } from 'uvd-x402-sdk';
+
+// Seed-based signer (Node.js / server-side)
+const xrpl = new XRPLProvider({ seed: process.env.XRPL_SEED });
+const address = await xrpl.connect(); // classic r-address
+const chainConfig = getChainByName('xrpl-mainnet')!;
+
+// Build + FULLY sign the Payment off-chain. Returns JSON: { signedTxBlob }
+const payload = await xrpl.signPayment({
+  recipient: 'rfADKkVXBNqK3z72tVSS3LVzAR3psYkonp', // classic r-address
+  amount: '10.00',
+}, chainConfig);
+
+const header = xrpl.encodePaymentHeader(payload);
+```
+
+XRPL uses the **t54 "pre-signed Payment blob"** scheme:
+- The client builds and FULLY signs a native XRP `Payment` off-chain (paying its own XRP fee)
+- Only one field is sent to the facilitator: `{ "signedTxBlob": "<hex tx blob>" }`
+- The facilitator decodes the blob to re-derive payer/amount/destination and submits it
+- The Payment sets `LastLedgerSequence`, must NOT set `tfPartialPayment`, and must NOT use `SendMax`
+- All payment-level fields (destination, amount, InvoiceID, SourceTag, Memo) come from the requirements
+
+> Requires the optional peer dependency `xrpl` (`npm install xrpl`).
+
 ### Stellar
 
 ```typescript
@@ -627,6 +661,15 @@ const header = svm.encodePaymentHeader(payload, chainConfig);
 |---------|--------|--------|
 | Sui | USDC, AUSD | Sui Wallet |
 
+### XRPL
+
+XRP Ledger settles in **native XRP** (6 decimals / drops) using the **t54 pre-signed Payment blob** scheme. The client builds and fully signs the Payment off-chain and sends `{ signedTxBlob }` to the facilitator. There is no stablecoin/token contract on XRPL. Use network ids `xrpl-mainnet` and `xrpl-testnet`. See [XRPL (XRP Ledger)](#xrpl-xrp-ledger) above for the `uvd-x402-sdk/xrpl` provider usage.
+
+| Network | Asset | Network ID | Provider |
+|---------|-------|------------|----------|
+| XRP Ledger | XRP (native) | xrpl-mainnet | `uvd-x402-sdk/xrpl` |
+| XRP Ledger Testnet | XRP (native) | xrpl-testnet | `uvd-x402-sdk/xrpl` |
+
 ### Other
 
 | Network | Wallet |
@@ -648,11 +691,13 @@ FACILITATOR_ADDRESSES.algorand; // KIMS5H6QLCUDL65L5UBTOXDPWLMTS7N3AAC3I6B2NCONE
 FACILITATOR_ADDRESSES.stellar;  // GCHPGXJT2WFFRFCA5TV4G4E3PMMXLNIDUH27PKDYA4QJ2XGYZWGFZNHB
 FACILITATOR_ADDRESSES.near;     // uvd-facilitator.near
 FACILITATOR_ADDRESSES.sui;      // 0xe7bbf2b13f7d72714760aa16e024fa1b35a978793f9893d0568a4fbf356a764a
+FACILITATOR_ADDRESSES['xrpl-mainnet']; // rfADKkVXBNqK3z72tVSS3LVzAR3psYkonp
 
 // Or get by chain name
 getFacilitatorAddress('algorand'); // KIMS5H6...
 getFacilitatorAddress('base', 'evm'); // 0x1030...
 getFacilitatorAddress('sui'); // 0xe7bbf...
+getFacilitatorAddress('xrpl-mainnet'); // rfADKk...
 ```
 
 ## Backend
@@ -756,10 +801,20 @@ try {
 
 ## ERC-8004 Trustless Agents
 
-Build verifiable on-chain reputation for AI agents and services. Supports **18 networks** (16 EVM + Solana + Solana devnet).
+Build verifiable on-chain reputation for AI agents and services. Supports **20 networks** (18 EVM + 2 Solana).
 
 On EVM networks, agent IDs are sequential numbers. On Solana, agent IDs are base58 pubkey strings. The `AgentId` type (`number | string`) handles both.
 
+### EVM Networks (18)
+
+ethereum, base-mainnet, polygon, arbitrum, optimism, celo, bsc, monad, avalanche, skale-base, ethereum-sepolia, base-sepolia, polygon-amoy, arbitrum-sepolia, optimism-sepolia, celo-sepolia, avalanche-fuji, skale-base-sepolia
+
+### Solana Networks (2)
+
+solana, solana-devnet
+
+### Usage
+
 ```typescript
 import { Erc8004Client, AgentId } from 'uvd-x402-sdk/backend';
 
@@ -773,6 +828,10 @@ console.log(identity.agentUri);
 const solIdentity = await erc8004.getIdentity('solana', '8oo4dC4JvBLwy5...');
 console.log(solIdentity.agentUri);
 
+// Look up agent by wallet owner address
+const byOwner = await erc8004.getIdentityByOwner('base-mainnet', '0xOwnerAddress...');
+console.log(byOwner.agentId, byOwner.identity.agentUri);
+
 // Get agent reputation
 const reputation = await erc8004.getReputation('ethereum', 42);
 console.log(`Score: ${reputation.summary.summaryValue}`);
@@ -851,6 +910,102 @@ const state = await escrow.getEscrowState({
 });
 ```
 
+## Advanced Escrow (AdvancedEscrowClient)
+
+Full escrow lifecycle management for EVM chains. Supports both `ethers.Signer` and `SigningWalletAdapter` (EnvKey, OWS) for signing.
+
+Supported on 10 EVM networks: Base, Base Sepolia, Ethereum, Ethereum Sepolia, Polygon, Arbitrum, Optimism, Celo, Monad, Avalanche.
+
+### With Private Key (ethers.Signer)
+
+```typescript
+import { AdvancedEscrowClient } from 'uvd-x402-sdk/backend';
+
+const client = new AdvancedEscrowClient(process.env.PRIVATE_KEY!, {
+  chainId: 8453, // Base
+});
+await client.init();
+
+// Build payment info
+const paymentInfo = client.buildPaymentInfo(
+  '0xWorkerAddress...', // receiver
+  '5000000',           // amount in atomic units ($5.00 USDC)
+  'standard',          // tier: 'standard' | 'express' | 'premium'
+);
+
+// Authorize: lock funds in escrow
+const auth = await client.authorize(paymentInfo);
+
+// Release: capture escrowed funds to receiver
+await client.release(paymentInfo);
+
+// Or refund: return escrowed funds to payer
+await client.refundInEscrow(paymentInfo);
+
+// Query escrow state on-chain
+const state = await client.queryEscrowState(paymentInfo);
+```
+
+### With SigningWalletAdapter (OWS)
+
+```typescript
+import { AdvancedEscrowClient } from 'uvd-x402-sdk/backend';
+import { OWSWalletAdapter } from 'uvd-x402-sdk';
+
+const wallet = new OWSWalletAdapter(owsWalletInstance);
+const client = new AdvancedEscrowClient(null, {
+  wallet,
+  rpcUrl: 'https://mainnet.base.org',
+  chainId: 8453,
+});
+await client.init();
+
+const paymentInfo = client.buildPaymentInfo('0xWorker...', '5000000', 'standard');
+const auth = await client.authorize(paymentInfo);
+```
+
+### Gasless Operations via Facilitator
+
+Release and refund can be executed through the facilitator (no gas required):
+
+```typescript
+// Gasless release
+await client.releaseViaFacilitator(paymentInfo);
+
+// Gasless refund
+await client.refundViaFacilitator(paymentInfo);
+```
+
+### Direct Charge (No Escrow)
+
+```typescript
+// Instant payment without escrow hold
+await client.charge(paymentInfo);
+```
+
+## Commerce Scheme
+
+The `'commerce'` scheme is a semantic alias for `'escrow'`, introduced for marketplace integrations (Execution Market, arbiter workflows). It uses the same contracts, ABI, and ERC-3009 flow as `'escrow'`.
+
+```typescript
+import type { X402Scheme } from 'uvd-x402-sdk';
+
+// All three schemes are valid
+const scheme: X402Scheme = 'commerce'; // or 'exact' or 'escrow'
+
+// PaymentRequirements and X402 headers accept all schemes
+const header = {
+  x402Version: 2,
+  scheme: 'commerce',
+  network: 'eip155:8453',
+  payload: { /* ... */ },
+};
+
+// Default behavior unchanged: buildPaymentRequirements() defaults to 'exact'
+```
+
+The facilitator's `/supported` endpoint advertises both `'escrow'` and `'commerce'` entries for all 11 escrow-capable networks (14 entries each).
+
 ## Bazaar Discovery
 
 Register and discover paid x402 resources across the network.

package/dist/adapters/index.d.mts

@@ -1,4 +1,4 @@
-import { O as X402Version, k as PaymentResult } from '../index-DsuzwOwF.mjs';
+import { O as X402Version, k as PaymentResult } from '../index-DNcDDyee.mjs';
 export { E as EnvKeyAdapter, O as OWSWallet, a as OWSWalletAdapter } from '../ows-CYIVd4xO.mjs';
 import '../wallet-0cX9Pw2F.mjs';
 

package/dist/adapters/index.d.ts

@@ -1,4 +1,4 @@
-import { O as X402Version, k as PaymentResult } from '../index-DsuzwOwF.js';
+import { O as X402Version, k as PaymentResult } from '../index-DNcDDyee.js';
 export { E as EnvKeyAdapter, O as OWSWallet, a as OWSWalletAdapter } from '../ows-DTDixPzO.js';
 import '../wallet-0cX9Pw2F.js';
 

package/dist/adapters/index.js

@@ -800,6 +800,65 @@ var SUPPORTED_CHAINS = {
       facilitatorUrl: DEFAULT_FACILITATOR_URL,
       enabled: true
     }
+  },
+  // ============================================================================
+  // XRPL (2 networks) - XRP Ledger, native XRP via pre-signed Payment blobs
+  // ============================================================================
+  "xrpl-mainnet": {
+    chainId: 0,
+    // Non-EVM (XRPL uses network id strings, no numeric chain ID)
+    chainIdHex: "0x0",
+    name: "xrpl-mainnet",
+    displayName: "XRP Ledger",
+    networkType: "xrpl",
+    rpcUrl: "https://xrplcluster.com",
+    explorerUrl: "https://livenet.xrpl.org",
+    nativeCurrency: {
+      name: "XRP",
+      symbol: "XRP",
+      decimals: 6
+      // XRPL uses 6 decimals (drops); 1 XRP = 1,000,000 drops
+    },
+    // XRPL settles in native XRP - there is no USDC/token contract.
+    // The `usdc` field describes the native asset for interface compatibility.
+    usdc: {
+      address: "XRP",
+      // Native asset - no token contract
+      decimals: 6,
+      name: "XRP",
+      version: "1"
+    },
+    x402: {
+      facilitatorUrl: DEFAULT_FACILITATOR_URL,
+      enabled: true
+    }
+  },
+  "xrpl-testnet": {
+    chainId: 0,
+    // Non-EVM
+    chainIdHex: "0x0",
+    name: "xrpl-testnet",
+    displayName: "XRP Ledger Testnet",
+    networkType: "xrpl",
+    rpcUrl: "https://s.altnet.rippletest.net:51234",
+    explorerUrl: "https://testnet.xrpl.org",
+    nativeCurrency: {
+      name: "XRP",
+      symbol: "XRP",
+      decimals: 6
+    },
+    // XRPL settles in native XRP - there is no USDC/token contract.
+    usdc: {
+      address: "XRP",
+      // Native asset - no token contract
+      decimals: 6,
+      name: "XRP",
+      version: "1"
+    },
+    x402: {
+      facilitatorUrl: DEFAULT_FACILITATOR_URL,
+      enabled: true
+    }
   }
 };
 function getChainByName(name) {
@@ -834,7 +893,10 @@ var CAIP2_IDENTIFIERS = {
   "algorand-testnet": "algorand:testnet",
   // Sui
   sui: "sui:mainnet",
-  "sui-testnet": "sui:testnet"
+  "sui-testnet": "sui:testnet",
+  // XRPL (XRP Ledger has no CAIP-2 form - the v1 string IS the network id)
+  "xrpl-mainnet": "xrpl-mainnet",
+  "xrpl-testnet": "xrpl-testnet"
 };
 Object.fromEntries(
   Object.entries(CAIP2_IDENTIFIERS).map(([k, v]) => [v, k])
@@ -894,6 +956,7 @@ var ETH_ADDRESS_REGEX = /^0x[a-fA-F0-9]{40}$/;
 var SOLANA_ADDRESS_REGEX = /^[1-9A-HJ-NP-Za-km-z]{32,44}$/;
 var STELLAR_ADDRESS_REGEX = /^G[A-Z2-7]{55}$/;
 var NEAR_ADDRESS_REGEX = /^[a-z0-9._-]+$/;
+var XRPL_ADDRESS_REGEX = /^r[1-9A-HJ-NP-Za-km-z]{24,34}$/;
 function validateRecipient(recipient, networkType) {
   if (!recipient) {
     throw new X402Error(
@@ -943,6 +1006,14 @@ function validateRecipient(recipient, networkType) {
           );
         }
         break;
+      case "xrpl":
+        if (!XRPL_ADDRESS_REGEX.test(trimmed)) {
+          throw new X402Error(
+            `Invalid XRPL recipient address: "${trimmed}". Expected a classic r-address (base58, Ripple alphabet).`,
+            "INVALID_RECIPIENT"
+          );
+        }
+        break;
     }
   }
 }