Skip to content

Maia-DAO/foundry-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6b98f84 · Jan 7, 2024

History

6 Commits
Jan 7, 2024
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Dec 27, 2023
Jan 2, 2024
Dec 27, 2023
Dec 27, 2023
Jan 7, 2024
Dec 27, 2023
Dec 27, 2023

Repository files navigation

Foundry Template

Version Test CI Lint Code Coverage Solidity License Docs Discord

Add a short description of the repository here.

Contributing

If you’re interested in contributing please see our contribution guidelines! This includes instructions on how to compile and run tests locally.

Documentation

A more detailed description of the project can be found in the documentation.

Architecture

Add a short description of the architecture here.

Repository Structure

All contracts are held within the ./src folder.

Note that helper contracts used by tests are held in the ./test/utils subfolder within the contracts folder. Any new test helper contracts should be added there and all foundry tests are in the ./test folder.

src
└── Counter - "Contract desciption"
test
└── Counter.t.sol

Local deployment and Usage

To utilize the contracts and deploy to a local testnet, you can install the code in your repo with forge:

forge install https://github.com/Maia-DAO/foundry-template

To integrate with the contracts, the interfaces are available to use:

License

MIT Copyright