⚒️ Start your next Solidity project with Foundry in seconds
MIT License
.env.example
file to .env
and fill in the variables.yarn install
. In case there is an error with the commands, run foundryup
and try them again.The default way to build the code is suboptimal but fast, you can run it via:
yarn build
In order to build a more optimized code (via IR), run:
yarn build:optimized
Unit tests should be isolated from any externalities, while Integration usually run in a fork of the blockchain. In this boilerplate you will find example of both.
In order to run both unit and integration tests, run:
yarn test
In order to just run unit tests, run:
yarn test:unit
In order to run unit tests and run way more fuzzing than usual (5x), run:
yarn test:unit:deep
In order to just run integration tests, run:
yarn test:integration
In order to just run the echidna fuzzing campaign (requires Echidna installed), run:
yarn test:fuzz
In order to just run the symbolic execution tests (requires Halmos installed), run:
yarn test:symbolic
In order to check your current code coverage, run:
yarn coverage
Configure the .env
variables and source them:
source .env
Import your private keys into Foundry's encrypted keystore:
cast wallet import $MAINNET_DEPLOYER_NAME --interactive
cast wallet import $SEPOLIA_DEPLOYER_NAME --interactive
yarn deploy:sepolia
yarn deploy:mainnet
The deployments are stored in ./broadcast
See the Foundry Book for available options.
Export TypeScript interfaces from Solidity contracts and interfaces providing compatibility with TypeChain. Publish the exported packages to NPM.
To enable this feature, make sure you've set the NPM_TOKEN
on your org's secrets. Then set the job's conditional to true
:
jobs:
export:
name: Generate Interfaces And Contracts
# Remove the following line if you wish to export your Solidity contracts and interfaces and publish them to NPM
if: true
...
Also, remember to update the package_name
param to your package name:
- name: Export Solidity - ${{ matrix.export_type }}
uses: defi-wonderland/solidity-exporter-action@1dbf5371c260add4a354e7a8d3467e5d3b9580b8
with:
# Update package_name with your package name
package_name: "my-cool-project"
...
- name: Publish to NPM - ${{ matrix.export_type }}
# Update `my-cool-project` with your package name
run: cd export/my-cool-project-${{ matrix.export_type }} && npm publish --access public
...
You can take a look at our solidity-exporter-action repository for more information and usage examples.
The primary license for the boilerplate is MIT, see LICENSE