Math Master

This codebase was inspired by the solady, obront.eth, and solmate codebases. Huge thanks to karma for the help on FV with Halmos.

• Math Master
• About
• Getting Started
  • Requirements
  • Quickstart
• Usage
  • Testing
    • Test Coverage
• Audit Scope Details
  • Compatibilities
• Roles
• Known Issues

About

Getting Started

Requirements

• git
  • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
• foundry
  • You'll know you did it right if you can run forge --version and you see a response like forge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)
• python3 & pip3
  • You'll know you did it right if you can run python3 --version and you see a response like Python 3.x.x
  • Halmos
    • To know you've installed it run halmos --version and you should see something like `halmos 0.1.0 (816e00b 2023-03-16T00:05:26.396218Z)
  • certoraRun
    • You'll know you did it right if you can run certoraRun --version and you get an output like: certora-cli 6.3.1

Note: I like to install certoraRun and halmos using pipx instead of pip.

Quickstart

git clone https://github.com/Cyfrin/2-math-master-audit
cd 2-math-master-audit
make

Usage

Testing

forge test

Test Coverage

forge coverage

and for coverage based testing:

forge coverage --report debug

Audit Scope Details

• Commit Hash:

c7643faa1a188a51b2167b68250816f90a9668c6

• In Scope:

#-- MathMasters.sol

Compatibilities

• Solc Version: xx
• Chain(s) to deploy contract to:
  • Ethereum
• Tokens:
  • None

Roles

XX

Known Issues

None