Practical overview
When it fits
Use the repository when designing or assessing applications that need token-backed commitments with defined claim conditions, allocator authorization and arbiter-mediated processing. Its multichain scope may suit cross-chain designs, subject to the integration’s own requirements.
Who it is for
- Solidity developers evaluating token-backed commitment and claim flows.
- Application teams exploring reusable resource locks for single-chain or multichain designs.
- Depositors, sponsors, claimants, arbiters and allocator developers working with the protocol’s roles.
Documented uses
- Deposit native or ERC-20 tokens to create a resource lock represented by ERC-6909 tokens.
- Set lock properties, including allocator, scope and reset period.
- Create a compact with claim terms and a designated arbiter.
- Authorize lock transfers, withdrawals or sponsorship through an allocator.
- Process claims against compact terms and, where applicable, initiate a forced withdrawal after the reset period.
Requirements & limits
The repository is public and specifies an MIT license. The README identifies deployments on Mainnet, Unichain and Base.
- A depositor selects an allocator, a single-chain or multichain scope, and a reset period when creating a lock.
- The allocator must be registered before it can be selected; it authorizes specified lock uses to help protect claimants against reuse of committed balances.
- An arbiter is responsible for processing claims against the compact’s conditions; the README makes arbiter reliability a trust assumption for both sponsors and claimants.
- A forced withdrawal is available after the chosen reset period if the allocator fails to authorize use of an unallocated balance.
- The README warns that V1 changes interfaces and functionality from V0, making version review important for existing integrations.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Prepare the repository for Foundry development
Clone The Compact, install its dependencies and run its documented Foundry tests.
Before you start
- Foundry; the README provides its official installer command.
- Git access to the public repository.
Steps
Clone https://github.com/Uniswap/the-compact.git and enter the repository directory.
Run
forge installto install dependencies and libraries.Run
forge test -v --isolateto run the tests and gas snapshots.
Expected outcome
The repository is set up with its dependencies, and the documented Foundry test command is ready to run.
Guide limitations
- The repository also mentions a small number of optional Hardhat tests; this guide does not cover them.
- This describes the repository's documented workflow, not an independently run test.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 9 October 2026
- Original website title
- Uniswap/the-compact · Official homepage title · retained in its source language

