README.md

Vaults •

Flexible, minimalist, and gas-optimized yield aggregator protocol for earning interest on any ERC20 token.

• Documentation
• Deployments
• Whitepaper
• Audits

Architecture

• Vault.sol: Flexible, minimalist, and gas-optimized yield aggregator for earning interest on any ERC20 token.
• VaultFactory.sol: Factory which enables deploying a Vault contract for any ERC20 token.
• modules/: Contracts used for managing and/or simplifying interaction with Vaults and the Vault Factory.
  • VaultRouterModule.sol: Module that enables depositing ETH and approval-free deposits via permit.
  • VaultConfigurationModule.sol: Module for configuring Vault parameters.
  • VaultInitializationModule.sol: Module for initializing newly created Vaults.
• interfaces/: Interfaces of external contracts Vaults and modules interact with.
  • Strategy.sol: Minimal interfaces for ERC20 and ETH compatible strategies.

Contributing

You will need a copy of DappTools installed before proceeding. See the installation guide for details.

Setup

git clone https://github.com/Rari-Capital/vaults.git
cd vaults
make

Run Tests

dapp test

Measure Coverage

dapp test --coverage

Update Gas Snapshots

dapp snapshot