Installation

Get up and running with Compose in just a few minutes.

Prerequisites

Before you begin, make sure you have the following installed:

• Foundry - Fast, portable Ethereum development framework
• Git - For cloning repositories
• Node.js 20+ - (Optional) For running tests and scripts

Quick Start

Option 1: Clone the Repository (Contributors)

If you're contributing to Compose:

# Clone the repository
git clone https://github.com/Perfect-Abstractions/Compose.git
cd Compose

# Install dependencies
forge install

# Build the project
forge build

# Run tests
forge test

Option 2: Install as Dependency (Coming Soon)

In the future, you'll be able to install Compose as a Foundry dependency:

# This will be available when Compose reaches stable release
forge install Perfect-Abstractions/Compose

Project Structure

After installation, you'll find the following structure:

Compose/
├── src/                    # Source contracts
│   ├── facets/            # Facet implementations
│   ├── libraries/         # Library helpers
│   └── interfaces/        # Standard interfaces
├── test/                  # Test files
├── script/                # Deployment scripts
├── lib/                   # Dependencies
└── foundry.toml          # Foundry configuration

Configuration

Foundry Setup

Compose includes a pre-configured foundry.toml. If you're integrating Compose into an existing project, add these settings:

[profile.default]
src = "src"
out = "out"
libs = ["lib"]
optimizer = true
optimizer_runs = 20_000
evm_version = "prague"

[profile.ci]
src = "src"
out = "out"
libs = ["lib"]
optimizer = true
optimizer_runs = 20_000
evm_version = "prague"
# Coverage settings
fuzz = { runs = 1000 }
invariant = { runs = 1000 }

[fmt]
line_length = 120
tab_width = 4
bracket_spacing = false
int_types = 'long'
multiline_func_header = 'attributes_first'
quote_style = 'double'
number_underscore = 'preserve'
single_line_statement_blocks = 'preserve'

Verify Installation

Run the tests to verify everything is working:

forge test -vvv

You should see output indicating all tests pass.

Getting Help

Having trouble with installation?

• Check the FAQ
• Ask in Discord
• Open an issue on GitHub

Development Environment

We recommend using VSCode with the Solidity extension by Juan Blanco for the best development experience.