Swaap V2 Monorepo

This repository contains the Swaap V2 core smart contracts — along with their tests, configuration, and deployment information.

Structure

The monorepo is has 3 main directories:

• pkg/: packages meant to be published and deployed.

• dep/: unpublished smart contract dependencies.

• pvt/: helpers and scripts for deployment and testing.

Packages

• v2-interfaces: Solidity interfaces for all Swaap V2 contracts.
• v2-errors: the Errors solidity library.
• v2-safeguard-pool: the SafeguardPool solidity contract.
• v2-vault: the Vault solidity contract, forked from Balancer V2.

Clone

This repository uses git submodules to run fuzz tests using forge. Therefore use --recurse-submodules when cloning:

$ git clone --recurse-submodules https://github.com/swaap-labs/swaap-v2-monorepo.git

Build and Test

Before any tests can be run, the repository needs to be prepared:

$ yarn # install all dependencies
$ yarn build # compile all contracts

In order to run all tests (including those with extra dependencies), run:

$ yarn test # run all tests

To instead run a single package's tests, run:

$ cd pkg/<package> # e.g. cd pkg/vault
$ yarn test

To run fuzz/invariant tests run:

$ cd pkg/<package> # e.g. cd pkg/safeguard-pool
$ yarn test-fuzz

To run test coverage:

$ cd pkg/<package> # e.g. cd pkg/safeguard-pool
$ yarn test-coverage

Security

Audits

Swaap v2 SafeguardPool have been audited by Chainsecurity and Quantstamp. The audit reports can be found in the audits folder of this repository.

Upgradability

All core smart contracts are immutable, and cannot be upgraded.

Licensing

Most of the Solidity source code is licensed under the GNU General Public License Version 3 (GPL v3): see LICENSE.

Exceptions

• All files in the openzeppelin directory of the balancer-v2-solidity-utils package are based on the OpenZeppelin Contracts library, and as such are licensed under the MIT License: see LICENSE.
• All other files, including tests and the pvt directory are unlicensed.