Contract Reference

​

Constants

​

State Variables

​

Types

​

Escrow (Internal Storage)

struct Escrow {
    address client;    // 20 bytes — depositor address
    uint40  refundAt;  // 5 bytes  — timestamp when refund becomes available
    uint56  amount;    // 7 bytes  — USDC locked (up to ~72B USDC)
}

​

EscrowView (Returned by getEscrow)

struct EscrowView {
    address client;
    uint256 amount;
    uint256 refundAt;
    bool    canRefund;
    uint256 timeUntilRefund;
}

​

Functions

​

initialize

function initialize(
    address _usdc,
    address _facilitator,
    address _admin,
    address _owner
) external initializer

• ZeroAddress() — if any parameter is address(0).
• NotContract() — if _usdc has no code.

​

settle

function settle(
    address client,
    uint256 maxAmount,
    uint256 validAfter,
    uint256 validBefore,
    bytes32 nonce,
    uint8 v,
    bytes32 r,
    bytes32 s
) external onlyRole(FACILITATOR_ROLE) nonReentrant returns (bytes32 escrowId)

• InvalidAmount() — if maxAmount is zero or exceeds type(uint56).max.
• NotYetValid() — if block.timestamp < validAfter.
• TimeoutExpired() — if block.timestamp >= validBefore.
• EscrowAlreadyExists() — if an active escrow with this ID already exists.
• TransferMismatch() — if the actual USDC received differs from maxAmount.

• Deposited(escrowId, client, maxAmount)

​

release

function release(
    bytes32 escrowId,
    uint256 facilitatorAmount
) external onlyRole(FACILITATOR_ROLE) nonReentrant

• Payment goes to msg.sender (the calling facilitator), not a stored address.
• If facilitatorAmount == 0, the full amount returns to the client.
• If facilitatorAmount == escrow.amount, nothing returns to the client.
• Escrow storage is cleared before transfers.

• EscrowNotFound() — if the escrow does not exist or was already settled/refunded.
• InvalidAmount() — if facilitatorAmount > escrow.amount.

• Released(escrowId, msg.sender, facilitatorAmount, clientRefund)

​

refundAfterTimeout

function refundAfterTimeout(bytes32 escrowId) external nonReentrant

• The full amount transfers to the stored client address regardless of who calls this function.
• Escrow storage is cleared before the transfer.

• EscrowNotFound() — if the escrow does not exist.
• TimeoutNotReached() — if block.timestamp < escrow.refundAt.

• Refunded(escrowId, client, amount)

​

setTimeout

function setTimeout(uint256 _timeoutSecs) external onlyRole(DEFAULT_ADMIN_ROLE)

• InvalidTimeout() — if outside the valid range.

• TimeoutUpdated(_timeoutSecs)

​

getEscrow

function getEscrow(bytes32 escrowId) external view returns (EscrowView memory)

• client — depositor address (zero if the escrow doesn’t exist).
• amount — USDC locked.
• refundAt — timestamp when refund becomes available.
• canRefund — true if refundAfterTimeout() can be called now.
• timeUntilRefund — seconds remaining until refund is available (0 if eligible).

​

Events

​

Deposited

event Deposited(bytes32 indexed escrowId, address indexed client, uint256 amount);

​

Released

event Released(
    bytes32 indexed escrowId,
    address indexed facilitator,
    uint256 toFacilitator,
    uint256 toClient
);

​

Refunded

event Refunded(bytes32 indexed escrowId, address indexed client, uint256 amount);

​

TimeoutUpdated

event TimeoutUpdated(uint256 newTimeoutSecs);

​

Errors