⚠️ This is an early-stage contract under active development; it has not yet been properly tested, reviewed, or audited.

Table of Contents

• Setup
• Allocators
• Deployment
• Docs
• Contributing

Setup

Follow these steps to set up your local environment:

• Install foundry
• Install dependencies: forge install
• Build contracts: forge build
• Test contracts: forge test

If you intend to develop on this repo, follow the steps outlined in CONTRIBUTING.md.

Allocators

The allocators are designed to be used with the The Compact. Their purpose is to ensure that locked tokens are available to claim for fillers within the promised expiration time. This repository contains multiple allocators, each with different features.

Deployment

This repo utilizes versioned deployments. For more information on how to use forge scripts within the repo, check here.

Smart contracts are deployed or upgraded using the following command:

forge script script/Deploy.s.sol --broadcast --rpc-url <rpc_url> --verify

Docs

The documentation and architecture diagrams for the contracts within this repo can be found here. Detailed documentation generated from the NatSpec documentation of the contracts can be found here. When exploring the contracts within this repository, it is recommended to start with the interfaces first and then move on to the implementation as outlined here

Contributing

If you want to contribute to this project, please check CONTRIBUTING.md first.