Interfaces

​

Core Protocol Interfaces

​

IOrchestrator

• signalIntent() - Create a new intent to take liquidity
• fulfillIntent() - Complete an intent with payment proof
• cancelIntent() - Cancel a pending intent
• releaseFundsToPayer() - Manual release mechanism
• pruneIntents() - Clean up expired intents (escrow-only)

• Intent - Complete intent data structure with owner, amount, payment method, conversion rate, and hook configuration
• SignalIntentParams - Parameters for creating a new intent
• FulfillIntentParams - Parameters for fulfilling an intent with proof

​

IOrchestratorV2

• Pre-intent hook validation during signalIntent()
• Whitelist hook for access control
• Manager fee snapshots for delegated rate managers
• cleanupOrphanedIntents() for anyone to clean up orphaned intents
• Separate preIntentHookData and persisted data fields

• setDepositPreIntentHook() - Configure pre-intent validation hook
• setDepositWhitelistHook() - Configure whitelist access control hook
• getDepositPreIntentHook() - Query pre-intent hook for a deposit
• getDepositWhitelistHook() - Query whitelist hook for a deposit

​

IEscrow

• lockFunds() - Lock funds for an intent (orchestrator-only)
• unlockFunds() - Unlock funds when intent is cancelled
• unlockAndTransferFunds() - Unlock and transfer on fulfillment
• extendIntentExpiry() - Extend intent expiration time
• getDeposit() - Retrieve deposit information
• getExpiredIntents() - Find expired intents and reclaimable amounts

• Deposit - Deposit configuration including token, ranges, state, and guardian
• DepositPaymentMethodData - Payment method configuration with gating service and verification data
• Currency - Currency code with minimum conversion rate
• Intent - Intent tracking with hash, amount, timestamp, and expiry

​

IEscrowV2

• Oracle-based conversion rates with spread configuration
• Delegated rate manager support
• Orchestrator registry for multi-orchestrator deployments
• Batch oracle configuration methods

• OracleRateConfig - Oracle adapter, config, spread, and staleness settings
• RateManagerConfig - Rate manager address and ID

• setOracleRateConfig() - Configure oracle-based rates for a currency
• setOracleRateConfigBatch() - Batch configure oracle rates
• removeOracleRateConfig() - Remove oracle rate configuration
• setRateManager() - Delegate rate management to external contract
• clearRateManager() - Clear rate manager delegation
• getEffectiveRate() - Get effective rate (oracle or manual)
• getManagerFee() - Get manager fee for a deposit

​

Verification Interfaces

​

IPaymentVerifier

• verifyPayment() - Verify payment proof and return release amount

• VerifyPaymentData - Intent hash, payment proof, and additional data
• PaymentVerificationResult - Success flag, intent hash, and release amount

• Zero-knowledge proofs (zkEmail, Groth16)
• TLS-based proofs (TLSNotary, TLSProxy)
• Attestations from trusted witnesses

​

IAttestationVerifier

• verify() - Verify attestations for a given digest

• Multi-signature attestations
• Threshold signatures
• TEE attestations

​

Hook Interfaces

​

IPostIntentHook

• execute() - Post-intent hook execution

• _intent - Full intent data structure
• _amountNetFees - Amount available after fees
• _fulfillIntentData - Data from fulfillIntent call

• Bridging tokens to another chain
• Swapping tokens
• Staking or yield farming
• Custom distribution logic

​

IPostIntentHookV2

• HookIntentContext - Intent data without referrer/fees
• HookExecutionContext - Complete execution context with token and executable amount

• execute() - Execute hook with structured context

​

IPreIntentHook

• validateSignalIntent() - Validate incoming intent, revert to reject

• PreIntentContext - Taker, escrow, deposit, amount, payment details, and hook data

• Whitelist/blacklist enforcement
• KYC/compliance checks
• Custom eligibility logic
• Rate validation

​

Registry Interfaces

​

IPaymentVerifierRegistry

• isPaymentMethod() - Check if payment method exists
• getPaymentMethods() - List all payment methods
• getVerifier() - Get verifier for a payment method
• isCurrency() - Check if currency is supported for a payment method
• getCurrencies() - List currencies for a payment method

​

IEscrowRegistry

• isWhitelistedEscrow() - Check if escrow is whitelisted
• isAcceptingAllEscrows() - Check if all escrows are accepted
• getWhitelistedEscrows() - List whitelisted escrows

​

IOrchestratorRegistry

• addOrchestrator() - Add orchestrator to allowlist
• removeOrchestrator() - Remove orchestrator from allowlist
• isOrchestrator() - Check if address is authorized orchestrator

​

IPostIntentHookRegistry

• isWhitelistedHook() - Check if hook is whitelisted
• getWhitelistedHooks() - List whitelisted hooks

​

IRelayerRegistry

• isWhitelistedRelayer() - Check if relayer is whitelisted
• getWhitelistedRelayers() - List whitelisted relayers

​

INullifierRegistry

• addNullifier() - Register a nullifier
• isNullified() - Check if nullifier has been used

​

Oracle and Rate Interfaces

​

IOracleAdapter

• validateConfig() - Validate and normalize adapter configuration
• getRate() - Get current market rate in preciseUnits (1e18)

• valid - Whether quote is usable
• rate - Market rate (fiat per deposit token)
• updatedAt - Oracle timestamp

• Chainlink price feeds
• Pyth Network
• Custom oracle implementations

​

IRateManager

• getRate() - Get effective rate for deposit/currency pair
• getFee() - Get fee terms for rate manager
• isRateManager() - Check if manager ID exists
• onDepositOptIn() - Called when deposit opts into delegation

​

Utility Interfaces

​

IProtocolViewer

• getDepositFromIds() - Get detailed deposit views with all payment methods and currencies
• getAccountIntents() - Get all intents for an account with full context

• DepositView - Deposit with available liquidity, payment methods, and intents
• IntentView - Intent with associated deposit information
• PaymentMethodDataView - Payment method with verification data and currencies

​

IProtocolViewerV2

​

External Oracle Interfaces

​

IChainlinkAggregatorV3

• latestRoundData() - Get latest price data
• decimals() - Get price decimals

​

IPyth

• getPrice() - Get current price for price ID
• updatePriceFeeds() - Update price feeds with off-chain data

​

Version Comparison

​

V1 vs V2 Differences

• V2 adds pre-intent hooks for validation before signaling
• V2 adds whitelist hooks for access control
• V2 adds manager fee snapshots for rate delegation
• V2 separates ephemeral (preIntentHookData) from persisted (data) hook data
• V2 adds cleanupOrphanedIntents() for anyone to clean up

• V2 adds oracle-based conversion rates with spread configuration
• V2 adds delegated rate manager support
• V2 adds orchestrator registry for multi-orchestrator deployments
• V2 provides getEffectiveRate() and getManagerFee() helpers

• V2 uses structured HookExecutionContext instead of raw Intent
• V2 separates signal-time and fulfill-time hook data

​

Interface Dependencies

IOrchestrator/IOrchestratorV2
├── IEscrow/IEscrowV2 (fund management)
├── IPaymentVerifierRegistry (verification routing)
├── IPostIntentHookRegistry (hook validation)
├── IEscrowRegistry (escrow validation)
├── IRelayerRegistry (relayer validation)
└── IPostIntentHook/IPostIntentHookV2 (optional hooks)

IEscrow/IEscrowV2
├── IPaymentVerifierRegistry (payment method validation)
├── IOrchestratorRegistry (V2 only - orchestrator validation)
├── IOracleAdapter (V2 only - oracle rates)
└── IRateManager (V2 only - delegated rates)

IOrchestratorV2 (additional)
└── IPreIntentHook (pre-intent validation)

IPaymentVerifier
├── IAttestationVerifier (optional - for attestation-based proofs)
└── INullifierRegistry (optional - for ZK proofs)