Example foundry package

[wojciech-turek]

Description

This PR introduces base Foundry package setup.
Documentation for Foundry: https://book.getfoundry.sh/

Setup

Navigate to the example-foundry package directory and run following commands:

Download foundry on your machine:

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

Setup foundry:

foundryup

You should now be able to successfully run:

forge --version

---

Testing

Build contracts:

forge build

Run tests:

forge test

Deploy to local test network:

Run local network

anvil

Deploy contracts:

forge script script/Counter.s.sol:CounterScript --rpc-url http://127.0.0.1:8545 --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Note: Above PK is derived from test junk mnemonic account 0.

[atkinsonholly]

Some comments / next steps:

• Is it necessary to push [all of] lib? I would like us to avoid having sub-modules for this repo (I know we need a workaround for this somehow)
• As a next step, it would be great to expand the example to mirror the example-hardhat package for Lock.sol including the various kinds of tests
• It would be great to add fuzzing tests / fuzzing setup in a separate test file
• Is there a way to set the out dir as "artifacts" such that we can import our Foundry contracts in packages/deploy?

[atkinsonholly]

We should ideally be able to run all tests etc for all packages at root level in the monorepo, so we may need to review our CI

[adjisb]

Why we need this file ?

[wojciech-turek]

Right, since we run those from the root we don't need it here.

[adjisb]

If this file contains secrets maybe is better to rename it to foundry.toml.example and add foundry.toml to git ignore file

[wojciech-turek]

We can import env secrets into foundry.toml there is no need to create .example.
I will update it slightly so its shown how to do it.

[adjisb]

• If git submodules is the foundry way of doing things 👎 maybe we must install forge-std as a submodule (the files inside lib/forge-std can be removed from this PR)?
• If we decide to base everything on hardhat maybe we must consider https://hardhat.org/hardhat-runner/plugins/nomicfoundation-hardhat-foundry to use the npm scripts (using npm implies using nodejs anyway)
• We may need an explanation on the rust toolchain foundry uses and how to install it, use it, etc ?

[wojciech-turek]

@adjisb

• The forge indeed uses the sub-modules and forge-std is not available as npm package. We could package it up ourselves and import it but we would then be burdened of maintaining that package.

• I am not sure if we necessarily want to mix foundry and hardhat, in the past foundry was missing some features like ability to spin up a local node so people installed hardhat for that, now foundry can be used completely separately.

• There is a readme added to the package, please let me know if you think it should be changed/updated