Frequently Asked Questions

keccak256(toUtf8Bytes("method-name"))

import { Escrow } from "@typechain/Escrow";

// Approve USDC first
await usdcToken.approve(escrowAddress, amount);

// Create deposit with payment method configuration
const depositId = await escrow.createDeposit({
  token: USDC_ADDRESS,
  amount: ethers.utils.parseUnits("1000", 6),
  paymentMethods: [venmoHash, paypalHash],
  minAmounts: [
    ethers.utils.parseUnits("10", 6),
    ethers.utils.parseUnits("10", 6)
  ],
  conversionRates: [100, 100], // 1:1 rates
});

import { Orchestrator } from "@typechain/Orchestrator";

// Signal intent to trade
const tx = await orchestrator.signalIntent({
  escrow: escrowAddress,
  depositId: depositId,
  amount: ethers.utils.parseUnits("100", 6),
  recipient: takerAddress,
  paymentMethod: venmoHash,
  payeeDetails: ethers.utils.keccak256(
    ethers.utils.toUtf8Bytes("payee-id")
  ),
  data: "0x", // Additional data if needed
});

const receipt = await tx.wait();
// Extract intentHash from events

// Build payment attestation (typically done by attestation service)
const attestation = {
  intentHash: intentHash,
  releaseAmount: ethers.utils.parseUnits("100", 6),
  dataHash: ethers.utils.keccak256(paymentData),
  signatures: [witnessSignature],
  data: encodedPaymentData,
  metadata: "0x"
};

const paymentProof = ethers.utils.defaultAbiCoder.encode(
  ["tuple(bytes32,uint256,bytes32,bytes[],bytes,bytes)"],
  [attestation]
);

// Submit for verification
await orchestrator.fulfillIntent({
  intentHash: intentHash,
  paymentProof: paymentProof,
  data: "0x",
});

import { ProtocolViewer } from "@typechain/ProtocolViewer";

// Get deposits for specific payment method
const deposits = await protocolViewer.getDepositsByPaymentMethod(
  escrowAddress,
  venmoHash
);

// Get specific deposit details
const deposit = await protocolViewer.getDeposit(
  escrowAddress,
  depositId
);

import {
  Escrow,
  Orchestrator,
  UnifiedPaymentVerifier,
  PaymentVerifierRegistry,
  NullifierRegistry,
  // ... other contracts
} from "@utils/contracts";

yarn build  # Compiles contracts and generates typechain

struct PaymentDetails {
    bytes32 method;
    bytes32 payeeId;     // Hashed for privacy
    uint256 amount;
    bytes32 currency;
    uint256 timestamp;
    bytes32 paymentId;   // Hashed for privacy
}

# Install dependencies
yarn

# Copy environment template
cp .env.default .env

# Configure .env with your keys:
# - ALCHEMY_API_KEY
# - BASE_DEPLOY_PRIVATE_KEY
# - TESTNET_DEPLOY_PRIVATE_KEY
# - BASESCAN_API_KEY
# - ETHERSCAN_KEY
# - INFURA_TOKEN

# Start local node
yarn chain

# Deploy to local node (in another terminal)
yarn deploy:localhost

# All Hardhat tests
yarn test

# Fast tests only (skip slow integration tests)
yarn test:fast

# Specific test suite
yarn test test/escrow/
yarn test test/orchestrator/
yarn test test/unifiedVerifier/

# Foundry tests
yarn test:forge              # All Foundry tests
yarn test:forge:fuzz         # Fuzz testing
yarn test:forge:invariant    # Invariant testing

# Coverage
yarn coverage                # Hardhat coverage
yarn test:forge:coverage     # Foundry coverage

# Deploy to Base
yarn deploy:base

# Deploy to Base Sepolia (testnet)
yarn deploy:base_sepolia

# Verify contracts on Basescan
yarn etherscan:base
yarn etherscan:base_sepolia

yarn build      # Full build: clean → compile → typechain → tsc
yarn compile    # Compile contracts only
yarn clean      # Clean build artifacts

releaseAmount = verifiedAmount - protocolFee - referrerFee
makerReceives = depositAmount - releaseAmount + makerFee

conversionRates: [100, 105, 98]  // Basis points (100 = 1:1)