Skip to content

AGENTS.md

Latest commit

 

History

History
117 lines (86 loc) · 4.1 KB

AGENTS.md

File metadata and controls

117 lines (86 loc) · 4.1 KB
Raw

Sablier EVM Monorepo

Smart contracts for Sablier onchain token distribution protocol.

Tech Stack

  • Language: Solidity 0.8.29
  • Framework: Foundry
  • Package Manager: Bun
  • Task Runner: Just
  • Testing: Foundry with Bulloak (BTT)
  • Linting: Solhint, Prettier

Monorepo Structure

├── airdrops/   # Merkle-based token distribution
├── bob/        # Price-target vaults with yield adapters + OTC escrow
├── flow/       # Open-ended token streaming
├── lockup/     # Fixed-term vesting and airdrops
├── utils/      # Shared utilities and comptroller
└── misc/       # Examples and gas benchmarks (not published)

Each package has its own AGENTS.md with protocol-specific context.

Prerequisites

  • Node.js v20+
  • Just — command runner
  • Bun — package manager (≥1.3)
  • Ni — package manager resolver
  • Foundry — EVM development framework
  • Rust — required by Bulloak
  • Bulloak — BTT test scaffolder

Setup

git clone git@github.com:sablier-labs/evm-monorepo.git && cd evm-monorepo
bun install                 # installs root + per-package deps, creates symlinks via `just setup`
cp .env.example .env        # populate mnemonic + API keys
just build-all              # build every package
git switch staging          # all development happens on staging

Commands

just --list                 # list all root recipes
just <pkg>                  # list recipes for a package (airdrops|bob|flow|lockup|utils)

misc/ is not a root module; cd misc && just --list to use its recipes.

Common recipes (substitute <pkg> for any of the five root modules):

just build-all              # build every package
just test-all               # run every package's tests
just full-check-all         # lint + format + test across all packages
just <pkg>::build           # build one package
just <pkg>::test            # run tests
just <pkg>::test-lite       # fast tests, no optimizer
just <pkg>::test-optimized  # tests with optimizer profile
just <pkg>::test-bulloak    # verify BTT structure
just <pkg>::coverage        # coverage report
just <pkg>::full-check      # lint + format + test
just <pkg>::full-write      # auto-fix lint + format
just <pkg>::deploy          # deterministic deploy script

Generate concrete BTT tests from a tree file:

bulloak scaffold -wf path/to/file.tree

Code Standards

  • Line length: 120 characters
  • NatSpec on every public/external function
  • Follow existing patterns in each package
  • Tests use Branching Tree Technique (BTT) via .tree files
  • misc/ (examples, benchmarks) is not part of build-all / test-all and is unpublished

Pull Requests

Not accepted. This repository is no longer maintained, and main must remain byte-for-byte verifiable against the deployed addresses. Do not open PRs — including comment-only or docs-only changes — as even trivial edits to source files can alter the compiled bytecode.

Environment Variables

Local: copy .env.example to .env and populate the mnemonic + API keys. The just setup recipe symlinks the root .env into each package.

CI on forks: add ROUTEMESH_API_KEY (Routemesh) to the fork's GitHub Secrets so workflows can run.

VSCode

Recommended extensions:

Security

All protocols are audited. See SECURITY.md for the disclosure policy and bug-bounty terms.

References

  • @justfile
  • @package.json