Tread contracts

Getting started

This project uses Foundry for smart contract testing and deployment, and uses Hardhat with Typechain to generate the TypeScript client.

See the Foundry docs for information about installing and using Foundry. You can install Hardhat and other TypeScript dependencies with npm install.

Publish TypeScript client

Make sure the version field in package.json is updated as needed.

npm run clean
npm run build:ts
npm publish

Foundry usage

Build

$ forge build

Test

$ forge test

Format

$ forge fmt

Gas Snapshots

$ forge snapshot

Anvil

$ anvil

Deploy

$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>

Cast

$ cast <subcommand>

Help

$ forge --help
$ anvil --help
$ cast --help

Slither

Use your favorite Python package manager to install Slither.

uv tool install slither-analyzer # should install the thing
slither --version # should verify the installation
npm run slither # should log out to slither-checklist.md