Migrate to foundry

[technophile-04]

TODOs:

• Port foundry from create-eth and get it working
• Figure out a way to set packages/foundry/.env
  • In future maybe as soon the repo is cloned / installed (maybe postinstall script? or maybe a make file or initial bash script?)
  • Solved: For now we are suggesting cp packages/foundry/.env.example packages/foundry/.env in README
• Clean up scripts in foundry package a bit
  • Solved: For now moved all JS files under scripts-js so that people who are familiar with foundry don't feel weird by seeing js files in script dir.
  • In future, we can move all JS scripts to from foundry package to another package in monorepo (we could use TS too there)
• Update readme (recursive submodules or forge install)
• Configure husky pre-commit hook to do basic foundry lint
  • Runs foundry fmt && prettier as pre-commit step in packages/foundry

Testing steps:

Follow this branch README: https://github.com/scaffold-eth/scaffold-eth-2/tree/foundry-main?tab=readme-ov-file#-scaffold-eth-2

Next todos:

• Update SE-2 docs website
• Create issue from above subpoints
• Get Switch to Keystore implementation for deployer accounts in foundry projects. #812 working nicely

[technophile-04]

#812 maybe something we could handle in different PR nicely?

[portdeveloper]

Do you think if it could be any better if we could combine the following steps into one?

Could yarn install && forge install --root packages/foundry and cp packages/foundry/.env.example packages/foundry/.env be one step in the install process for people who have just started learning onchain dev?

Maybe it could be one command: yarn setup or yarn buidl

[carletex]

This is great stuff @technophile-04 tysm!! I'll start testing and report back!

[carletex]

I saw that you already commented about this in the PR comment. Having to do this is a PITA (the 3 magic commands don't work out of the box), so I've been trying some options (postinstall as you mentioned)

branch: https://github.com/scaffold-eth/scaffold-eth-2/commits/foundry-main--cp-env/
commit: 951f733

Using the smallest copy lib that I could find (even tho it installs a few other deps, maybe we can explore other options), which should work on any OS.

I remember that we had some issues with the postinstall script (not running at all in some OS? Or running after every time you run yarn install? Added the --no-overwrite in case it's the latter).

What do you think?

[carletex]

If we take this path, this can help to decide about the lib to use. https://pkg-size.dev/

eg. https://pkg-size.dev/cpy-cli => 1.3MB vs the 5 KB advertised (which doesn't count the deps)

[technophile-04]

After researching for a while I think postinstall seems a safe option.

Some notes on `postinstall` script:

1. Postinstall in yarn will run only when something in root node_modules changes(which means some package is added in dependency or devDependency of root package.json) or node_moduels is initialized

   example image :

   

2. Postinstall in yarn does not log output to stdout, which means If you do postinstall: echo 'hello world' it won't log hello world. It will only show output on error (example this image )

3. Running yarn install multiple times won't run postinstall multiple times until you add any package to root pacakage.json. If you add npm package in nextjs it won't run.

So considering all the above points, I think postinstall seems a fine options for us

not running at all in some OS?

Even I had the same feeling, but went through SE-2 issues throughly and could only found this : #275

The above issue was not related too much related to postinstall(since postinstall ran) but it was related to node js script not resolving proper path on windows.

So yeah 951f733 seems good if it works nicely on windows (hopefully it resolves path correctly internally)

Another options we could also put our own node script at root of monorepo and call it in postinstall: node startUp.js but we need to make sure it works properly on windows the path resolution thing.

[technophile-04]

Was just trying https://github.com/scaffold-eth/scaffold-eth-2/tree/foundry-main--cp-env and found a minor disadvantage that:

1. First you clone above repo and yarn install this creates .env.example nicely in pacakge/foundry
2. If you try to install node dependency in foundry package cd packages/foundry and yarn add viem it will fail :
   

basically you won't be able to install any node / js dependency in foundry package because it will fail since we are using ---no-overwrite it throwing error

An alternatie solution will be finding a library which doesn't throw error or writting our own node script which doesn't throw error if .env is already present. The only reason I am afraid of writing our own script is because of #275 where isn't properly able to get the path but maybe we should give it another shot?

[carletex]

I think this is what we need: https://www.npmjs.com/package/shx (we can use commands from linux, and we could copy... or even test if the file exist before copying)

And it takes less space https://pkg-size.dev/shx

I'll give it a shot

[carletex]

What about this (using shx): 46443fb

I pushed it to https://github.com/scaffold-eth/scaffold-eth-2/commits/foundry-main--cp-env/

If we like it, we can have Pablo to test on Windows.

[technophile-04]

Noiicee, just tried it out and works great!! Tysm!!, I think this works great!! Will merge in this changes!

[rin-st]

Is it only for me that when I'm using metamask with foundry network, my setGreeting transactions are always pending?

Reset account fixed this

[technophile-04]

Was talking with Carlos and just switched the base branch from main to foundry , thinking that #867 (comment) would be really nice if we get it working before we merge all the foundry changes to main branch and then announce the changes also was mentioned in #868.

So for this PR we get this #867 (comment) solved merge it to foundry . And then tackle #812 merge it to foundry and after that finally merge foundry => main

[technophile-04]

Just merged the postinstallchanges mentioned in #867 (comment) works nicely for me!. cc @Pabl0cks could you test it on windows once w/ without wsl and gitbash also if others could give another try too would be great 🙌

To test first run:

git clone https://github.com/scaffold-eth/scaffold-eth-2.git -b foundry-main scaffold-eth-foundry
cd scaffold-eth-foundry
yarn install && forge install --root packages/foundry

And then the three command yarn chain, yarn deploy, yarn start should work out of the box

[rin-st]

if others could give another try too would be great

for me it also works! 👍

[Pabl0cks]

Just merged the postinstallchanges mentioned in #867 (comment) works nicely for me!. cc @Pabl0cks could you test it on windows once w/ without wsl and gitbash also if others could give another try too would be great 🙌

Awesome job @technophile-04 for tackling this and @carletex @rin-st for the great reviews! ❤

It's working great on Windows with Git Bash, also installed and configured WSL with Ubuntu 20.04 and is working great too 🙌

[damianmarti]

Just merged the postinstallchanges mentioned in #867 (comment) works nicely for me!. cc @Pabl0cks could you test it on windows once w/ without wsl and gitbash also if others could give another try too would be great 🙌

To test first run:

git clone https://github.com/scaffold-eth/scaffold-eth-2.git -b foundry-main scaffold-eth-foundry
cd scaffold-eth-foundry
yarn install && yarn install && forge install --root packages/foundry

And then the three command yarn chain, yarn deploy, yarn start should work out of the box

Everything working great on Ubuntu 20.04!!

@technophile-04 Great job!!!

[portdeveloper]

Tried it on a win11 + git bash machine
It works great, without any issues!
🚀🚀🚀
Incredible work @technophile-04 !!!

[technophile-04]

Thanks all merging this in foundry branch 🙌