lpETH

Usage

This is a list of the most frequently needed commands.

Build

Build the contracts:

forge build

Clean

Delete the build artifacts and cache directories:

forge clean

Compile

Compile the contracts:

forge build

Coverage

Get a test coverage report:

forge coverage

Deploy

Deploy to Anvil:

bash script/deploy.local.sh

Format

Format the contracts:

forge fmt

Gas Usage

Get a gas report:

forge test --gas-report

Lint

Lint the contracts:

bun run lint

Test

Run the tests:

forge test

Generate test coverage and output result to the terminal:

bun run test:coverage

Generate test coverage with lcov report (you'll have to open the ./coverage/index.html file in your browser, to do so simply copy paste the path):

bun run test:coverage:report

License

This project is licensed under MIT.