/hats-audit

IBO, Vesting & Bond mecanism repo prepared for Hat finance audit competition

Primary LanguageJavaScript

Audit contest Hats 1 - Convergence

Repo archi

  • contracts : Convergence Protocol

    • interfaces : Smart Contract interfaces
    • mock : Mocked contracts, ONLY FOR TESTING PURPOSE
    • Any other folder sorts contracts per feature

  • docs : Generated doc by hardhat-docgen

  • scripts : Deployment & utility scripts interacting with contracts **DeployHelper.js** containing the deployment script context

  • tasks : Hardhat tasks

  • technical-docs : Sequential diagrams & Description of complex functions

  • test : Unit & Integration testing. TestHelper containing the deployment script context

  • utils : Utility classes & functions

To run the project

To install dependencies

npm i

To run a local network forking the mainnet :

npm run mainnet-forking

Test

Unit testing are located in test folder. To run the full test :

npm run test

Single test:

npm run test --grep path/to/file

Entire folder:

npm run test --grep path/to/folder/**