Checklist of things that need to be done

[gakonst]

Quick braindump of things we should do in terms of docs / PM moving forward

• FAQ Doc
  • foundryup vs cargo/bin installation path (either delete the .cargo/bin or set .foundrup/bin before it in your PATH)
  • i cannot see my logs (need to trigger verbosity)
  • how do I fork mainnet state? (--fork-url)
  • how do gas snapshots work?
  • how do I use a manual solc version? (--offline / --no-auto-detect / SOLC_PATH / PATH)
  • how to use console.sol (need to vendor it)
  • how do I run specific tests / contracts? (--match / --match-contract etc.)
• Patterns doc
  • using cheatcodes
  • reusable test suites (forge: Reusable Test Suites #407 (comment))
  • discarding fuzzed inputs
• Known Issues Doc
  • caching bug
  • fuzzer edge cases
  • missing libusb
• Improved Issue Template
  • How did you install foundry?
  • What is the exact set of commands that you ran to get the bug?
  • If it's a Solidity repo, do you have a minimal code example?
  • Did you check the FAQ?
  • Is this a Foundry question, or are you making a Solidity mistake?
• PR Template
  • Motivation
  • Solution
• Projects
  • Deploy
  • Etherscan Verification
  • Symbolic EVM
  • Improved Fuzzer
  • Mutation Testing
  • Coverage
  • Gas Reports
  • Refactor to be abstract over Compiler and Runtime (set up StarkNet support)
  • Solidity Book using Foundry
  • Foundry Book

What else are we missing?

[mattsse]

meta:

• add Architecture.md
• add Contributing.md Community templates #587

pending features

• solidity formatter feat: solidity formatter MVP #201
• solidity repl Feat: Solidity Repl #230 feat(shell): initial draft #240
• detect minimum supported solc version feat: add forge mssv command to assist finding the minimum supported solc version for a project #391

[alephao]

On the FAQ doc, any idea on how that should be structured? Just dump on README.md for now and figure out later?

Happy to work on those to help out:

• how do I run specific tests / contracts? (--match / --match-contract etc.) docs: document test-matchers with examples and patterns #546
• i cannot see my logs (need to trigger verbosity)

Edit: logs seem to be well explained here https://github.com/onbjerg/foundry-book/blob/master/src/forge/traces.md

[onbjerg]

• Debugging for tests with parameters (to debug fuzz tests)

[mds1]

A few other things I'd find useful that I'd like to be on this list:

• A vm.not cheatcode, or more discussion on whether it's needed / there's existing workarounds we haven't thought of: feat(cheatcodes): add negative assertions for expectEmit and expectRevert using count syntax #509
• Modifying how expectEmit works for more flexibility / stronger assertions: inline / asymmetric matchers #512 (comment)
• There's a few other fuzzer patterns we can discuss such as bounding inputs and converting "bad" inputs to good ones
• Based on bug: mockCall not working as expected #432, it seems mocking responses from a jump isn't practical. This means mockCall and expectCall work on for methods invoked via calls, not jumps. Having those methods behave the same regardless of how the function was invoked would be very helpful, and would result in less unexpected behavior (e.g. I mock response to A.foo() and now get hard to debug test failures because A.foo() gives different responses when called by A vs B
• RPC functionality is a big one Feat/forge node #174

[onbjerg]

(Note: The fix for mockCall would require a rewrite to use revm over Sputnik which is a big task)

[EricForgy]

What else are we missing?

Maybe a VS Code extension?

I was happy to learn about foundry.toml and put my remappings in there. It compiles and runs fine, but VS Code doesn't yet recognize the remappings (red triggering squiggles) and putting them in workspace settings doesn't feel great. I ended up moving back to remappings.txt temporarily.

[ultrasecreth]

Filesystem cache when running on a fork from mainnet (like hardhat), the amount of RPC requests and the time that it takes when iterating over a test is quite significant (currently >60s on some test I'm working on).
For what I can see there's an in-memory cache so running a full test suite doesn't get that bad, but when writing a test you normally have to run it many times so it gets annoying to wait 30s or more each time.

[appleseed-iii]

what do you think about removing the leading substring Address: from the cast wallet address command

foundry/cli/src/cmd/cast/wallet/mod.rs

Line 136 in 7257375

println!("Address: {}", SimpleCast::to_checksum_address(&addr));

? The leading substring makes the command a little more painful to chain & seems unnecessary.

I haven't gotten far enough to see if there are other places this pattern exists.

[mattsse]

makes sense, @appleseed-iii

feel free to open a PR

[PaulRBerg]

Can we add table tests to this checklist?

I think that it's a very important feature that it's currently missing from Forge.

[ChainsightLabs]

Can we add table tests to this checklist?

I think that it's a very important feature that it's currently missing from Forge.

Yes, table tests please!

[dalechyn]

What else are we missing?

Maybe a VS Code extension?

I was happy to learn about foundry.toml and put my remappings in there. It compiles and runs fine, but VS Code doesn't yet recognize the remappings (red triggering squiggles) and putting them in workspace settings doesn't feel great. I ended up moving back to remappings.txt temporarily.

Makes even more sense to make a separate Language Server, as there is only vscode-s one that cannot be even used in vim.

[y1cunhui]

Hello, I'm wondering what does "Solidity Book using Foundry" means? I 'm interested in this topic and willing to finish this

[milaabl]

@y1cunhui , probably something like a Solidity development with Foundry guidelines book? Not sure

[ennioVisco]

foundryup runnable natively on Windows

[zerosnacks]

Closing as open checkboxes have their individual follow-up tickets or are top of mind:

• Symbolic Rust EVM #15
• feat(testing): add mutation testing support #478
• https://github.com/foundry-rs/compilers + https://github.com/foundry-rs/starknet-foundry