https://github.com/Rari-Capital/vaults

Flexible, minimalist, and gas-optimized yield aggregator protocol for earning interest on any ERC20 token.
https://github.com/Rari-Capital/vaults

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/Rari-Capital/vaults
• Owner: Rari-Capital
• License: agpl-3.0
• Created: 2021-06-22T06:29:35.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-18T22:36:50.000Z (over 2 years ago)
• Last Synced: 2024-07-11T13:57:31.100Z (4 months ago)
• Language: Solidity
• Homepage:
• Size: 2.57 MB
• Stars: 281
• Watchers: 9
• Forks: 76
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audits/Fixed-Point-Solutions/Vault.pdf

Awesome Lists containing this project

• awesome-dapptools - Rari Vaults

README

        
# Vaults • [![Tests](https://github.com/Rari-Capital/vaults/actions/workflows/tests.yml/badge.svg)](https://github.com/Rari-Capital/vaults/actions/workflows/tests.yml) [![License](https://img.shields.io/badge/License-AGPL--3.0-blue)](LICENSE.md)

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

- [Documentation](https://docs.rari.capital/vaults)

- [Deployments](https://github.com/Rari-Capital/vaults/releases)

- [Whitepaper](whitepaper/Whitepaper.pdf)

- [Audits](audits)

## Architecture

- [`Vault.sol`](src/Vault.sol): Flexible, minimalist, and gas-optimized yield aggregator for earning interest on any ERC20 token.

- [`VaultFactory.sol`](src/VaultFactory.sol): Factory which enables deploying a Vault contract for any ERC20 token.

- [`modules/`](src/modules): Contracts used for managing and/or simplifying interaction with Vaults and the Vault Factory.

  - [`VaultRouterModule.sol`](src/modules/VaultRouterModule.sol): Module that enables depositing ETH and approval-free deposits via permit.

  - [`VaultConfigurationModule.sol`](src/modules/VaultConfigurationModule.sol): Module for configuring Vault parameters.

  - [`VaultInitializationModule.sol`](src/modules/VaultInitializationModule.sol): Module for initializing newly created Vaults.

- [`interfaces/`](src/interfaces): Interfaces of external contracts Vaults and modules interact with.

  - [`Strategy.sol`](src/interfaces/Strategy.sol): Minimal interfaces for ERC20 and ETH compatible strategies.

![Diagram](https://lucid.app/publicSegments/view/8069beaa-d2fc-48de-8f38-9e30edcb5f08/image.png)

## Contributing

You will need a copy of [DappTools](https://dapp.tools) installed before proceeding. See the [installation guide](https://github.com/dapphub/dapptools#installation) for details.

### Setup

```sh

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

cd vaults

make

```

### Run Tests

```sh

dapp test

```

### Measure Coverage

```sh

dapp test --coverage

```

### Update Gas Snapshots

```sh

dapp snapshot

```