@mstable/protocol
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.2 • Public • Published

    CI Coverage Status Discord npm version


    This repo contains all contracts and tests relevant to the core mStable protocol. mStable is a protocol built to make stablecoins easy, robust and profitable.

    mStable Assets (mAssets) are tokens that allow minting and redemption for underlying Basket Assets (bAssets) of the same peg (i.e. USD, BTC, Gold). The InvariantValidator applies both min and max weights to these bAssets, and enforces penalties and bonuses when minting with these assets to provide low slippage swaps. This Invariant applies progressive penalties and bonuses on either end of the weight scale - having the result of having a large area of low slippage. bAssets are integrated with lending protocols (initially Aave, Compound) to generate interest which is accrued in mAsset terms. mAssets can be deposited to earn native interest through their respective Savings Contract, just like you would with a savings account. bAssets within an mAsset can also be swapped with low slippage (provided they remain within their validator limits), with a swapFee credited additionally to Savers.

    Core mAsset contracts utilise OpenZeppelin's InitializableAdminUpgradeabilityProxy to facilitate future upgrades, fixes or feature additions. The upgrades are proposed by the mStable Governors (with current governor address stored in the Nexus - the system kernel) and executed via the DelayedProxyAdmin. Both changes to the governor, and contract upgrades have a one week delay built in to execution. This allows mStable users a one week opt out window if they do not agree with the given change.

    mStable rewards those who contribute to its utility and growth - for more information see MTA.


    🏠 https://mstable.org
    📀 https://app.mstable.org
    📄 https://docs.mstable.org


    Bug bounty

    Found a bug? Claim a reward from our open Bug Bounty by reporting it to mStable (following the responsible disclosure policy)




    Branches

    • master contains complete, tested and audited contract code, generally on mainnet
    • beta is for the pre-release code, generally on ropsten

    Artifacts

    We publish the contract artifacts to an npm package called @mstable/protocol. You can browse them via unpkg.com.


    Dev notes

    Prerequisites

    Installing dependencies

    $ yarn
    

    Testing

    Tests are written with Hardhat, Ethers, Waffle & Typescript, using Typechain to generate typings for all contracts. Tests are executed using hardhat in hardhats evm.

    $ yarn test
    

    Suite

    Key folders:

    • /contracts/z_mocks: All mocks used throughout the test suite
    • /security: Scripts used to run static analysis tools like Slither and Securify
    • /test: Unit tests in folders corresponding to contracts/xx
    • /test-utils: Core util files used throughout the test framework
      • /machines: Mock contract machines for creating configurable instances of the contracts
    • /types: TS Types used throughout the suite
      • /generated: Output from Typechain; strongly-typed, Ethers-flavoured contract interfaces

    Coverage

    Solidity-coverage is used to run coverage analysis on test suite.

    This produces reports that are visible in the /coverage folder, and navigatable/uploadable. Ultimately they are used as a reference that there is some sort of adequate cover, although they will not be a source of truth for a robust test framework. Reports publically available on coveralls.

    NB: solidity-coverage runs with solc optimizer=false (see discussion)

    CI

    Codebase rules are enforced through a passing CI (visible in .circleci/config.yml). These rules are:

    • Linting of both the contracts (through Solium) and TS files (ESLint)
    • Passing test suite
    • Maintaining high unit testing coverage

    Code formatting

    • Solidity imports deconstructed as import { xxx } from "../xxx.sol"
    • Solidity commented as per NatSpec format
    • Internal function ordering from high > low order

    Command Line Interface

    Hardhat Tasks are used for command line interactions with the mStable contracts. The tasks can be found in the tasks folder.

    A separate Hardhat config file tasks.config.ts is used for task config. This inherits from the main Hardhat config file hardhat.config.ts. This avoids circular dependencies when the repository needs to be compiled before the Typechain artifacts have been generated. This means the --config tasks.config.ts Hardhat option needs to be used to run the mStable tasks.

    Config your network. If you are just using readonly tasks like mBTC-snap you don't need to have a signer with Ether in it so the default Hardhat test account is ok to use. For safety, the mainnet config is not committed to the repository to avoid accidentally running tasks against mainnet.

    mainnet: {
        url: process.env.NODE_URL || "",
        accounts: {
            mnemonic: "test test test test test test test test test test test junk",
        },
    },
    

    Never commit mainnet private keys, mnemonics or provider URLs to the repository.

    Examples of using the Hardhat tasks

    # List all Hardhat tasks
    hh --config tasks.config.ts
    
    # Set the provider url
    export NODE_URL=https://mainnet.infura.io/v3/yourApiKey
    
    # To run the mBTC-snap task against mainnet
    yarn task mBTC-snap --network mainnet

    Keywords

    none

    Install

    npm i @mstable/protocol

    DownloadsWeekly Downloads

    727

    Version

    2.3.2

    License

    AGPL-3.0-or-later

    Unpacked Size

    24.2 MB

    Total Files

    1336

    Last publish

    Collaborators

    • alsco77
    • jlefrere
    • circlo
    • naddison36