https://github.com/nnnnicholas/songcamp4
https://github.com/nnnnicholas/songcamp4
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nnnnicholas/songcamp4
- Owner: nnnnicholas
- Created: 2023-07-14T04:34:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-15T19:09:04.000Z (almost 2 years ago)
- Last Synced: 2025-02-05T12:27:28.629Z (4 months ago)
- Language: JavaScript
- Size: 30.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# contract-template
# Getting started
## Prerequisites
### Install & Update Foundry
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](https://book.getfoundry.sh/getting-started/installation).
### Install & Update Yarn
Follow the instructions in the [Yarn Docs](https://classic.yarnpkg.com/en/docs/install). People tend to use the latest version of Yarn 1 (not Yarn 2+).
## Install Included Dependencies
Install dependencies (forge tests, Juice-contracts-V3, OZ) via `yarn install` (the `preinstall` script will run `forge install` for you)
# Adding dependencies
## With Yarn
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']`.
## With Forge
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.
# Updating dependencies
## With Yarn
Run `yarn upgrade [package]`.
## With Forge
Run `foundryup` to update forge.
Run `forge update` to update all dependencies, or run `forge update [dependency]` to update a specific dependency.
# Usage
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).
## Code coverage
Run `yarn coverage`to 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)](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) 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)
## PR
Github CI flow will run both unit and forked tests, log the contracts size (with the tests) and check linting compliance.