Template used to code juicy solidity stuff - includes forge, libs, etc.
This template is a good starting point for building solidity extensions to the Juicebox Protocol. Forking this template may help you to avoid submodule related dependency issues down the road.
Do not push straight on main, rather create a new branch and open a PR - your reviewer will love you for this.
Install Forge with curl -L https://foundry.paradigm.xyz | bash. If you already have Foundry installed, run foundryup to update to the latest version. More detailed instructions can be found in the Foundry Book.
Follow the instructions in the Yarn Docs. People tend to use the latest version of Yarn 1 (not Yarn 2+).
Install dependencies (forge tests, Juice-contracts-V3, OZ) via yarn install (the preinstall script will run forge install for you)
If the dependency you would like to install has an NPM package, use yarn add [package] where [package] is the package name. This will install the dependency to node_modules.
Tell forge to look for node libraries by adding node_modules to the foundry.toml by updating libs like so: libs = ['lib', 'node_modules'].
Add dependencies to remappings.txt by running forge remappings >> remappings.txt. For example, the NPM package jbx-protocol is remapped as @jbx-protocol/=node_modules/@jbx-protocol/.
If the dependency you would like to install does not have an up-to-date NPM package, use forge install [dependency] where [dependency] is the path to the dependency repo. This will install the dependency to /lib. Forge manages dependencies using git submodules.
Run forge remappings > remappings.txt to write the dependencies to remappings.txt. Note that this will overwrite that file.
If nested dependencies are not installing, try this workaround git submodule update --init --recursive --force. Nested dependencies are dependencies of the dependencies you have installed.
More information on remappings is available in the Forge Book.
Run yarn upgrade [package].
Run foundryup to update forge.
Run forge update to update all dependencies, or run forge update [dependency] to update a specific dependency.
use yarn test to run tests
use yarn test:fork to run tests in CI mode (including slower mainnet fork tests)
use yarn size to check contract size
use yarn doc to generate natspec docs
use yarn lint to lint the code
use yarn tree to generate a Solidity dependency tree
use yarn deploy:mainnet and yarn deploy:goerli to deploy and verify (see .env.example for required env vars, using a ledger by default).
Run yarn coverageto display code coverage summary and generate an LCOV report
To display code coverage in VSCode:
- You need to install the coverage gutters extension (Ryan Luker) or any other extension handling LCOV reports
- ctrl shift p > "Coverage Gutters: Display Coverage" (coverage are the colored markdown lines in the left gutter, after the line numbers)
Github CI flow will run both unit and forked tests, log the contracts size (with the tests) and check linting compliance.