Skip to content

FraxFinance/frax-template

Repository files navigation

Frax Template

Optional Setup

Add:

function profile() {
  FOUNDRY_PROFILE=$1 "${@:2}"}

To easily execute specific foundry profiles like profile test forge test -w

Installation

pnpm i

Compile

forge build

Test

profile test forge test

profile test forge test -w watch for file changes

profile test forge test -vvv show stack traces for failed tests

Deploy

  • Update environment variables where needed
  • source .env
`forge script src/script/{ScriptName}.s.sol \
  --rpc-url ${mainnet || fraxtal || fraxtal_testnet || polygon} \
  --etherscan-api-key {$ETHERSCAN_API_KEY || FRAXSCAN_API_KEY || POLYGONSCAN_API_KEY} \
  --broadcast --verify --watch

Tooling

This repo uses the following tools:

  • frax-standard-solidity for testing and scripting helpers
  • forge fmt & prettier for code formatting
  • lint-staged & husky for pre-commit formatting checks
  • solhint for code quality and style hints
  • foundry for compiling, testing, and deploying