@perkos/scheme-deferred 1.0.0

package/dist/index.js

@@ -0,0 +1,376 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  DEFERRED_ESCROW_ABI: () => DEFERRED_ESCROW_ABI,
+  DEFERRED_ESCROW_CLAIM_VOUCHER_ABI: () => DEFERRED_ESCROW_CLAIM_VOUCHER_ABI,
+  DEFERRED_ESCROW_GET_BALANCE_ABI: () => DEFERRED_ESCROW_GET_BALANCE_ABI,
+  DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI: () => DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+  DeferredSchemeVerifier: () => DeferredSchemeVerifier,
+  ERC20_BALANCE_ABI: () => ERC20_BALANCE_ABI,
+  VOUCHER_TYPES: () => VOUCHER_TYPES,
+  VOUCHER_TYPE_DEF: () => VOUCHER_TYPE_DEF,
+  createEIP712Domain: () => createEIP712Domain,
+  createVoucherMessage: () => createVoucherMessage,
+  createVoucherTuple: () => createVoucherTuple,
+  generateVoucherId: () => generateVoucherId,
+  parseSignature: () => parseSignature
+});
+module.exports = __toCommonJS(index_exports);
+var import_viem = require("viem");
+var import_util_chains = require("@perkos/util-chains");
+var VOUCHER_TYPE_DEF = [
+  { name: "id", type: "bytes32" },
+  { name: "buyer", type: "address" },
+  { name: "seller", type: "address" },
+  { name: "valueAggregate", type: "uint256" },
+  { name: "asset", type: "address" },
+  { name: "timestamp", type: "uint64" },
+  { name: "nonce", type: "uint256" },
+  { name: "escrow", type: "address" },
+  { name: "chainId", type: "uint256" }
+];
+var VOUCHER_TYPES = {
+  Voucher: VOUCHER_TYPE_DEF
+};
+var ERC20_BALANCE_ABI = [
+  {
+    name: "balanceOf",
+    type: "function",
+    stateMutability: "view",
+    inputs: [{ name: "account", type: "address" }],
+    outputs: [{ name: "", type: "uint256" }]
+  }
+];
+var DEFERRED_ESCROW_GET_BALANCE_ABI = [
+  {
+    name: "getAvailableBalance",
+    type: "function",
+    stateMutability: "view",
+    inputs: [
+      { name: "buyer", type: "address" },
+      { name: "seller", type: "address" },
+      { name: "asset", type: "address" }
+    ],
+    outputs: [{ name: "", type: "uint256" }]
+  }
+];
+var DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI = [
+  {
+    name: "voucherClaimed",
+    type: "function",
+    stateMutability: "view",
+    inputs: [
+      { name: "voucherId", type: "bytes32" },
+      { name: "nonce", type: "uint256" }
+    ],
+    outputs: [{ name: "", type: "bool" }]
+  }
+];
+var DEFERRED_ESCROW_CLAIM_VOUCHER_ABI = [
+  {
+    name: "claimVoucher",
+    type: "function",
+    stateMutability: "nonpayable",
+    inputs: [
+      {
+        name: "voucher",
+        type: "tuple",
+        components: [
+          { name: "id", type: "bytes32" },
+          { name: "buyer", type: "address" },
+          { name: "seller", type: "address" },
+          { name: "valueAggregate", type: "uint256" },
+          { name: "asset", type: "address" },
+          { name: "timestamp", type: "uint64" },
+          { name: "nonce", type: "uint256" },
+          { name: "escrow", type: "address" },
+          { name: "chainId", type: "uint256" }
+        ]
+      },
+      { name: "signature", type: "bytes" }
+    ],
+    outputs: []
+  }
+];
+var DEFERRED_ESCROW_ABI = [
+  ...DEFERRED_ESCROW_GET_BALANCE_ABI,
+  ...DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+  ...DEFERRED_ESCROW_CLAIM_VOUCHER_ABI
+];
+var DeferredSchemeVerifier = class {
+  constructor(config) {
+    this.network = config.network;
+    this.chainId = (0, import_util_chains.getChainIdFromNetwork)(config.network) || 1;
+    this.escrowAddress = config.escrowAddress;
+    this.domainName = config.domainName || "X402DeferredEscrow";
+    this.domainVersion = config.domainVersion || "1";
+    const chain = (0, import_util_chains.getChainById)(this.chainId);
+    const rpcUrl = config.rpcUrl || (0, import_util_chains.getRpcUrl)(this.chainId);
+    if (!chain || !rpcUrl) {
+      throw new Error(`Unsupported network: ${config.network}`);
+    }
+    this.publicClient = (0, import_viem.createPublicClient)({
+      chain,
+      transport: (0, import_viem.http)(rpcUrl)
+    });
+  }
+  /**
+   * Verify a deferred scheme payment voucher
+   */
+  async verify(payload, requirements) {
+    try {
+      const { voucher, signature } = payload;
+      if (!this.validateVoucher(voucher, requirements)) {
+        return {
+          isValid: false,
+          invalidReason: "Voucher fields invalid",
+          payer: null
+        };
+      }
+      const signer = await this.recoverSigner(voucher, signature);
+      if (!signer) {
+        return {
+          isValid: false,
+          invalidReason: "Invalid signature",
+          payer: null
+        };
+      }
+      if (signer.toLowerCase() !== voucher.buyer.toLowerCase()) {
+        return {
+          isValid: false,
+          invalidReason: `Signer does not match buyer. Recovered: ${signer}, Expected: ${voucher.buyer}`,
+          payer: null
+        };
+      }
+      const claimed = await this.isVoucherClaimed(
+        voucher.id,
+        BigInt(voucher.nonce)
+      );
+      if (claimed) {
+        return {
+          isValid: false,
+          invalidReason: "Voucher already claimed",
+          payer: null
+        };
+      }
+      const balance = await this.getEscrowBalance(
+        voucher.buyer,
+        voucher.seller,
+        voucher.asset
+      );
+      const valueAggregate = BigInt(voucher.valueAggregate);
+      if (balance < valueAggregate) {
+        return {
+          isValid: false,
+          invalidReason: "Insufficient escrow balance",
+          payer: null
+        };
+      }
+      return {
+        isValid: true,
+        invalidReason: null,
+        payer: voucher.buyer
+      };
+    } catch (error) {
+      return {
+        isValid: false,
+        invalidReason: error instanceof Error ? error.message : "Verification failed",
+        payer: null
+      };
+    }
+  }
+  /**
+   * Validate voucher fields against requirements
+   */
+  validateVoucher(voucher, requirements) {
+    if (voucher.escrow.toLowerCase() !== this.escrowAddress.toLowerCase()) {
+      return false;
+    }
+    if (BigInt(voucher.chainId) !== BigInt(this.chainId)) {
+      return false;
+    }
+    if (voucher.seller.toLowerCase() !== requirements.payTo.toLowerCase()) {
+      return false;
+    }
+    const valueAggregate = BigInt(voucher.valueAggregate);
+    const maxAmount = BigInt(requirements.maxAmountRequired);
+    if (valueAggregate > maxAmount) {
+      return false;
+    }
+    if (voucher.asset.toLowerCase() !== requirements.asset.toLowerCase()) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Recover signer from EIP-712 typed data signature
+   */
+  async recoverSigner(voucher, signature) {
+    try {
+      const domain = this.getEIP712Domain();
+      const message = {
+        id: voucher.id,
+        buyer: voucher.buyer,
+        seller: voucher.seller,
+        valueAggregate: BigInt(voucher.valueAggregate),
+        asset: voucher.asset,
+        timestamp: BigInt(voucher.timestamp),
+        nonce: BigInt(voucher.nonce),
+        escrow: voucher.escrow,
+        chainId: BigInt(voucher.chainId)
+      };
+      const recoveredAddress = await (0, import_viem.recoverTypedDataAddress)({
+        domain,
+        types: VOUCHER_TYPES,
+        primaryType: "Voucher",
+        message,
+        signature
+      });
+      return recoveredAddress;
+    } catch {
+      return null;
+    }
+  }
+  /**
+   * Get EIP-712 domain for escrow contract
+   */
+  getEIP712Domain() {
+    return {
+      name: this.domainName,
+      version: this.domainVersion,
+      chainId: this.chainId,
+      verifyingContract: this.escrowAddress
+    };
+  }
+  /**
+   * Check if voucher has been claimed
+   */
+  async isVoucherClaimed(voucherId, nonce) {
+    try {
+      const claimed = await this.publicClient.readContract({
+        address: this.escrowAddress,
+        abi: DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+        functionName: "voucherClaimed",
+        args: [voucherId, nonce]
+      });
+      return claimed;
+    } catch {
+      return false;
+    }
+  }
+  /**
+   * Get available escrow balance
+   */
+  async getEscrowBalance(buyer, seller, asset) {
+    try {
+      const balance = await this.publicClient.readContract({
+        address: this.escrowAddress,
+        abi: DEFERRED_ESCROW_GET_BALANCE_ABI,
+        functionName: "getAvailableBalance",
+        args: [buyer, seller, asset]
+      });
+      return balance;
+    } catch {
+      return 0n;
+    }
+  }
+  /**
+   * Get network name
+   */
+  getNetwork() {
+    return this.network;
+  }
+  /**
+   * Get chain ID
+   */
+  getChainId() {
+    return this.chainId;
+  }
+  /**
+   * Get escrow address
+   */
+  getEscrowAddress() {
+    return this.escrowAddress;
+  }
+};
+function parseSignature(signature) {
+  const sig = signature.slice(2);
+  const r = `0x${sig.slice(0, 64)}`;
+  const s = `0x${sig.slice(64, 128)}`;
+  const v = parseInt(sig.slice(128, 130), 16);
+  return { v, r, s };
+}
+function createEIP712Domain(chainId, escrowAddress, domainName, domainVersion) {
+  return {
+    name: domainName || "X402DeferredEscrow",
+    version: domainVersion || "1",
+    chainId,
+    verifyingContract: escrowAddress
+  };
+}
+function generateVoucherId() {
+  const bytes = new Uint8Array(32);
+  crypto.getRandomValues(bytes);
+  return `0x${Array.from(bytes).map((b) => b.toString(16).padStart(2, "0")).join("")}`;
+}
+function createVoucherMessage(id, buyer, seller, valueAggregate, asset, timestamp, nonce, escrow, chainId) {
+  return {
+    id,
+    buyer,
+    seller,
+    valueAggregate: BigInt(valueAggregate),
+    asset,
+    timestamp: BigInt(timestamp),
+    nonce: BigInt(nonce),
+    escrow,
+    chainId: BigInt(chainId)
+  };
+}
+function createVoucherTuple(voucher) {
+  return {
+    id: voucher.id,
+    buyer: voucher.buyer,
+    seller: voucher.seller,
+    valueAggregate: BigInt(voucher.valueAggregate),
+    asset: voucher.asset,
+    timestamp: BigInt(voucher.timestamp),
+    nonce: BigInt(voucher.nonce),
+    escrow: voucher.escrow,
+    chainId: BigInt(voucher.chainId)
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFERRED_ESCROW_ABI,
+  DEFERRED_ESCROW_CLAIM_VOUCHER_ABI,
+  DEFERRED_ESCROW_GET_BALANCE_ABI,
+  DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+  DeferredSchemeVerifier,
+  ERC20_BALANCE_ABI,
+  VOUCHER_TYPES,
+  VOUCHER_TYPE_DEF,
+  createEIP712Domain,
+  createVoucherMessage,
+  createVoucherTuple,
+  generateVoucherId,
+  parseSignature
+});

package/dist/index.mjs

@@ -0,0 +1,347 @@
+// src/index.ts
+import {
+  createPublicClient,
+  http,
+  recoverTypedDataAddress
+} from "viem";
+import {
+  getChainById,
+  getChainIdFromNetwork,
+  getRpcUrl
+} from "@perkos/util-chains";
+var VOUCHER_TYPE_DEF = [
+  { name: "id", type: "bytes32" },
+  { name: "buyer", type: "address" },
+  { name: "seller", type: "address" },
+  { name: "valueAggregate", type: "uint256" },
+  { name: "asset", type: "address" },
+  { name: "timestamp", type: "uint64" },
+  { name: "nonce", type: "uint256" },
+  { name: "escrow", type: "address" },
+  { name: "chainId", type: "uint256" }
+];
+var VOUCHER_TYPES = {
+  Voucher: VOUCHER_TYPE_DEF
+};
+var ERC20_BALANCE_ABI = [
+  {
+    name: "balanceOf",
+    type: "function",
+    stateMutability: "view",
+    inputs: [{ name: "account", type: "address" }],
+    outputs: [{ name: "", type: "uint256" }]
+  }
+];
+var DEFERRED_ESCROW_GET_BALANCE_ABI = [
+  {
+    name: "getAvailableBalance",
+    type: "function",
+    stateMutability: "view",
+    inputs: [
+      { name: "buyer", type: "address" },
+      { name: "seller", type: "address" },
+      { name: "asset", type: "address" }
+    ],
+    outputs: [{ name: "", type: "uint256" }]
+  }
+];
+var DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI = [
+  {
+    name: "voucherClaimed",
+    type: "function",
+    stateMutability: "view",
+    inputs: [
+      { name: "voucherId", type: "bytes32" },
+      { name: "nonce", type: "uint256" }
+    ],
+    outputs: [{ name: "", type: "bool" }]
+  }
+];
+var DEFERRED_ESCROW_CLAIM_VOUCHER_ABI = [
+  {
+    name: "claimVoucher",
+    type: "function",
+    stateMutability: "nonpayable",
+    inputs: [
+      {
+        name: "voucher",
+        type: "tuple",
+        components: [
+          { name: "id", type: "bytes32" },
+          { name: "buyer", type: "address" },
+          { name: "seller", type: "address" },
+          { name: "valueAggregate", type: "uint256" },
+          { name: "asset", type: "address" },
+          { name: "timestamp", type: "uint64" },
+          { name: "nonce", type: "uint256" },
+          { name: "escrow", type: "address" },
+          { name: "chainId", type: "uint256" }
+        ]
+      },
+      { name: "signature", type: "bytes" }
+    ],
+    outputs: []
+  }
+];
+var DEFERRED_ESCROW_ABI = [
+  ...DEFERRED_ESCROW_GET_BALANCE_ABI,
+  ...DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+  ...DEFERRED_ESCROW_CLAIM_VOUCHER_ABI
+];
+var DeferredSchemeVerifier = class {
+  constructor(config) {
+    this.network = config.network;
+    this.chainId = getChainIdFromNetwork(config.network) || 1;
+    this.escrowAddress = config.escrowAddress;
+    this.domainName = config.domainName || "X402DeferredEscrow";
+    this.domainVersion = config.domainVersion || "1";
+    const chain = getChainById(this.chainId);
+    const rpcUrl = config.rpcUrl || getRpcUrl(this.chainId);
+    if (!chain || !rpcUrl) {
+      throw new Error(`Unsupported network: ${config.network}`);
+    }
+    this.publicClient = createPublicClient({
+      chain,
+      transport: http(rpcUrl)
+    });
+  }
+  /**
+   * Verify a deferred scheme payment voucher
+   */
+  async verify(payload, requirements) {
+    try {
+      const { voucher, signature } = payload;
+      if (!this.validateVoucher(voucher, requirements)) {
+        return {
+          isValid: false,
+          invalidReason: "Voucher fields invalid",
+          payer: null
+        };
+      }
+      const signer = await this.recoverSigner(voucher, signature);
+      if (!signer) {
+        return {
+          isValid: false,
+          invalidReason: "Invalid signature",
+          payer: null
+        };
+      }
+      if (signer.toLowerCase() !== voucher.buyer.toLowerCase()) {
+        return {
+          isValid: false,
+          invalidReason: `Signer does not match buyer. Recovered: ${signer}, Expected: ${voucher.buyer}`,
+          payer: null
+        };
+      }
+      const claimed = await this.isVoucherClaimed(
+        voucher.id,
+        BigInt(voucher.nonce)
+      );
+      if (claimed) {
+        return {
+          isValid: false,
+          invalidReason: "Voucher already claimed",
+          payer: null
+        };
+      }
+      const balance = await this.getEscrowBalance(
+        voucher.buyer,
+        voucher.seller,
+        voucher.asset
+      );
+      const valueAggregate = BigInt(voucher.valueAggregate);
+      if (balance < valueAggregate) {
+        return {
+          isValid: false,
+          invalidReason: "Insufficient escrow balance",
+          payer: null
+        };
+      }
+      return {
+        isValid: true,
+        invalidReason: null,
+        payer: voucher.buyer
+      };
+    } catch (error) {
+      return {
+        isValid: false,
+        invalidReason: error instanceof Error ? error.message : "Verification failed",
+        payer: null
+      };
+    }
+  }
+  /**
+   * Validate voucher fields against requirements
+   */
+  validateVoucher(voucher, requirements) {
+    if (voucher.escrow.toLowerCase() !== this.escrowAddress.toLowerCase()) {
+      return false;
+    }
+    if (BigInt(voucher.chainId) !== BigInt(this.chainId)) {
+      return false;
+    }
+    if (voucher.seller.toLowerCase() !== requirements.payTo.toLowerCase()) {
+      return false;
+    }
+    const valueAggregate = BigInt(voucher.valueAggregate);
+    const maxAmount = BigInt(requirements.maxAmountRequired);
+    if (valueAggregate > maxAmount) {
+      return false;
+    }
+    if (voucher.asset.toLowerCase() !== requirements.asset.toLowerCase()) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Recover signer from EIP-712 typed data signature
+   */
+  async recoverSigner(voucher, signature) {
+    try {
+      const domain = this.getEIP712Domain();
+      const message = {
+        id: voucher.id,
+        buyer: voucher.buyer,
+        seller: voucher.seller,
+        valueAggregate: BigInt(voucher.valueAggregate),
+        asset: voucher.asset,
+        timestamp: BigInt(voucher.timestamp),
+        nonce: BigInt(voucher.nonce),
+        escrow: voucher.escrow,
+        chainId: BigInt(voucher.chainId)
+      };
+      const recoveredAddress = await recoverTypedDataAddress({
+        domain,
+        types: VOUCHER_TYPES,
+        primaryType: "Voucher",
+        message,
+        signature
+      });
+      return recoveredAddress;
+    } catch {
+      return null;
+    }
+  }
+  /**
+   * Get EIP-712 domain for escrow contract
+   */
+  getEIP712Domain() {
+    return {
+      name: this.domainName,
+      version: this.domainVersion,
+      chainId: this.chainId,
+      verifyingContract: this.escrowAddress
+    };
+  }
+  /**
+   * Check if voucher has been claimed
+   */
+  async isVoucherClaimed(voucherId, nonce) {
+    try {
+      const claimed = await this.publicClient.readContract({
+        address: this.escrowAddress,
+        abi: DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+        functionName: "voucherClaimed",
+        args: [voucherId, nonce]
+      });
+      return claimed;
+    } catch {
+      return false;
+    }
+  }
+  /**
+   * Get available escrow balance
+   */
+  async getEscrowBalance(buyer, seller, asset) {
+    try {
+      const balance = await this.publicClient.readContract({
+        address: this.escrowAddress,
+        abi: DEFERRED_ESCROW_GET_BALANCE_ABI,
+        functionName: "getAvailableBalance",
+        args: [buyer, seller, asset]
+      });
+      return balance;
+    } catch {
+      return 0n;
+    }
+  }
+  /**
+   * Get network name
+   */
+  getNetwork() {
+    return this.network;
+  }
+  /**
+   * Get chain ID
+   */
+  getChainId() {
+    return this.chainId;
+  }
+  /**
+   * Get escrow address
+   */
+  getEscrowAddress() {
+    return this.escrowAddress;
+  }
+};
+function parseSignature(signature) {
+  const sig = signature.slice(2);
+  const r = `0x${sig.slice(0, 64)}`;
+  const s = `0x${sig.slice(64, 128)}`;
+  const v = parseInt(sig.slice(128, 130), 16);
+  return { v, r, s };
+}
+function createEIP712Domain(chainId, escrowAddress, domainName, domainVersion) {
+  return {
+    name: domainName || "X402DeferredEscrow",
+    version: domainVersion || "1",
+    chainId,
+    verifyingContract: escrowAddress
+  };
+}
+function generateVoucherId() {
+  const bytes = new Uint8Array(32);
+  crypto.getRandomValues(bytes);
+  return `0x${Array.from(bytes).map((b) => b.toString(16).padStart(2, "0")).join("")}`;
+}
+function createVoucherMessage(id, buyer, seller, valueAggregate, asset, timestamp, nonce, escrow, chainId) {
+  return {
+    id,
+    buyer,
+    seller,
+    valueAggregate: BigInt(valueAggregate),
+    asset,
+    timestamp: BigInt(timestamp),
+    nonce: BigInt(nonce),
+    escrow,
+    chainId: BigInt(chainId)
+  };
+}
+function createVoucherTuple(voucher) {
+  return {
+    id: voucher.id,
+    buyer: voucher.buyer,
+    seller: voucher.seller,
+    valueAggregate: BigInt(voucher.valueAggregate),
+    asset: voucher.asset,
+    timestamp: BigInt(voucher.timestamp),
+    nonce: BigInt(voucher.nonce),
+    escrow: voucher.escrow,
+    chainId: BigInt(voucher.chainId)
+  };
+}
+export {
+  DEFERRED_ESCROW_ABI,
+  DEFERRED_ESCROW_CLAIM_VOUCHER_ABI,
+  DEFERRED_ESCROW_GET_BALANCE_ABI,
+  DEFERRED_ESCROW_VOUCHER_CLAIMED_ABI,
+  DeferredSchemeVerifier,
+  ERC20_BALANCE_ABI,
+  VOUCHER_TYPES,
+  VOUCHER_TYPE_DEF,
+  createEIP712Domain,
+  createVoucherMessage,
+  createVoucherTuple,
+  generateVoucherId,
+  parseSignature
+};