Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.39 KB

README.md

File metadata and controls

62 lines (39 loc) · 1.39 KB
Raw

Foundry template

Template foundry repository for ad-hoc smart contracts development.

How to install

First, install foundryup (foundry toolchain installer)

curl -L https://foundry.paradigm.xyz | bash

Second, install Foundry itself. This will download forge, cast, anvil, and chisel binaries

foundryup

Third, use make to install local dependencies:

make install

Or with Docker

It is recommended to use the VSCode Dev Container for development. You can do this by opening the Command Palette (Ctrl+Shift+P) and selecting the Dev Containers: Rebuild and Reopen in Container command.

How to use

The template works out of the box. To clean up the repo, you may need to delete the mock contracts and tests.

Also check out relevant dependencies in the Makefile.

Test

To run the tests, execute the following command:

make test

Or to see the coverage, run:

make coverage

Local deployment

To deploy the contracts locally, run the following commands (in the different terminals):

make private-network
make deploy-local

Other niceties

  • The template comes with presetup prettier and solhint that lint the project via husky before compilation hook.
  • The .env.example file is provided to check what is required as ENVs
  • Preinstalled @openzeppelin/contracts and @solarity/solidity-lib