Git Product home page Git Product logo

swaap-v2-monorepo's Introduction

drawing

Swaap V2 Monorepo

Docs CI Status License

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

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

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

swaap-v2-monorepo's People

Contributors

christiandahdah avatar borelien avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.