Forge/remix master

[Dargon789]

Motivation

Solution

PR Checklist

• Added Tests
• Added Documentation
• Breaking changes

Summary by Sourcery

Add variant table support in documentation, refine verification provider logic, unify comparison routines, standardize gas estimation output, expose new conversions, adjust dependencies, and introduce a new counter example project with tests and CI workflows.

New Features:

• Render enum variant tables in generated documentation using try_write_variant_table

Enhancements:

• Refactor VerificationProviderType selection to match on enum variants and enforce API key requirements
• Replace total_cmp with partial_cmp in various sorting and comparison functions to avoid panics
• Standardize estimated gas amount output to always use ETH and update redaction patterns accordingly
• Implement From<Vec> for Comments and improve error message for conflicting restriction settings
• Downgrade derive_more dependency from version 2.0 to 1.0 for compatibility

Build:

• Downgrade actions/setup-python to v4 in GitHub CI workflow
• Update derive_more version in Cargo.toml

CI:

• Revise nextest workflow and add new GitHub Actions for CodeQL, Jekyll deployment, Docker image CI, APIsec scanning, and Forge-based CI for the counter example
• Add CircleCI configuration and multiple issue templates for bug reports, feature requests, and custom issues

Documentation:

• Add counter project README with Foundry overview and usage instructions

Tests:

• Include remix test contracts and Forge tests for the new counter example project
• Adjust test-utils redaction regex to match ETH output

[sourcery-ai]

Reviewer's Guide

This PR merges Forge/remix master by extending the documentation generator with variant tables, refactoring verification provider logic, standardizing comparisons via partial_cmp, and bundling a new Remix test suite along with multiple CI/workflow and sample project files.

Entity relationship diagram for Counter contract storage

erDiagram
    COUNTER {
      uint256 number
    }

Loading

Class diagram for new and updated Counter contract

classDiagram
    class Counter {
        +uint256 number
        +setNumber(newNumber uint256)
        +increment()
    }

Loading

Class diagram for BufWriter with new variant table method

classDiagram
    class BufWriter {
        +try_write_variant_table(params: EnumDefinition, comments: Comments)
        +try_write_table(...)
        +try_write_events_table(...)
        +write_bold(...)
        +writeln(...)
        +write_piped(...)
    }

Loading

Class diagram for VerificationProviderType logic refactor

classDiagram
    class VerificationProviderType {
        +client(key: Option<&str>) Result<Box<dyn VerificationProvider>>
    }
    VerificationProviderType <|-- EtherscanVerificationProvider
    VerificationProviderType <|-- SourcifyVerificationProvider

Loading

File-Level Changes

Change	Details	Files
Support rendering enum variant tables in docs	Declare variant table headers and separators Implement try_write_variant_table in BufWriter Filter and integrate custom variant comments in AsDoc Add Comments conversion from Vec	crates/doc/src/writer/buf_writer.rs crates/doc/src/writer/as_doc.rs crates/doc/src/parser/comment.rs
Refactor verification provider selection	Use matches! to select Sourcify/Etherscan branches Enforce API key presence for Etherscan Remove legacy helper methods and streamline key checks	crates/verify/src/provider.rs
Standardize numeric comparisons and formatting	Replace total_cmp with partial_cmp and unwrap_or for sorts and comparisons Update percentage comparison to use partial_cmp Unify gas estimation output using a fixed token Adjust regex redaction for ETH symbol Bump derive_more version	crates/forge/src/cmd/snapshot.rs crates/test-utils/src/util.rs crates/cli/src/utils/suggestions.rs crates/common/src/contracts.rs crates/config/src/compilation.rs crates/script/src/simulate.rs Cargo.toml
Add Remix test suite, sample project, and CI/workflows	Include .deps/remix-tests solidity libraries with tests and accounts Add CodeQL, Jekyll, Docker and CI pipeline workflows Add counter sample project with Forge scripts, tests, and config Introduce GitHub issue templates and CircleCI config	.deps/remix-tests/remix_tests.sol .deps/remix-tests/remix_accounts.sol .github/workflows/nextest.yml .github/workflows/codeql.yml .github/workflows/jekyll.yml .github/workflows/docker-image.yml .github/workflows/apisec-scan.yml crates/forge/src/cmd/snapshot.rs counter/**/* .github/ISSUE_TEMPLATE/* .circleci/config.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
next	Ready	Preview	Comment	Oct 14, 2025 9:42pm
react	Ready	Preview	Comment	Oct 14, 2025 9:42pm

[snyk-io]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[gemini-code-assist]

Summary of Changes

Hello @Dargon789, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request establishes a new Foundry project structure within the repository, complete with essential development environment configurations and CI/CD pipelines. Concurrently, it refines existing Rust codebase components by addressing floating-point comparison safety, improving error reporting, and enhancing documentation generation capabilities. The changes also streamline script simulation outputs and clarify the process for selecting external verification providers.

Highlights

• New Project Structure & Tooling Integration: This PR introduces a foundational setup for a Foundry-based project, including a complete counter/ directory with a sample Solidity contract, deployment script, and tests. It also integrates forge-std and openzeppelin-contracts as Git submodules, and adds remix-tests Solidity libraries for accounts and assertions.
• CI/CD and Development Environment Setup: New configuration files for CircleCI (.circleci/config.yml), CodeSandbox (.codesandbox/tasks.json), and GitHub Actions (counter/.github/workflows/test.yml) have been added. The GitHub Actions workflow specifically sets up Foundry for building, formatting, and testing the new counter project.
• Rust Codebase Refinements and Bug Fixes: Several Rust files across different crates have been updated. Key changes include enhancing floating-point comparisons for robustness, improving error messages, and refining documentation generation for enums to include dedicated variant tables. The derive_more dependency was also downgraded in Cargo.toml.
• Streamlined Script Simulation and Verification Logic: The script simulation output now consistently displays 'ETH' for estimated amounts, removing dynamic token symbols. Additionally, the logic for selecting verification providers (Etherscan/Sourcify) has been refactored for clearer and more explicit handling of API key requirements.

Ignored Files

• Ignored by pattern: .github/workflows/** (5)
  • .github/workflows/apisec-scan.yml
  • .github/workflows/codeql.yml
  • .github/workflows/docker-image.yml
  • .github/workflows/jekyll.yml
  • .github/workflows/nextest.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `crates/doc/src/writer/buf_writer.rs:189` </location>
<code_context>

+    /// Tries to write the variant table to the buffer.
+    /// Doesn't write anything if either params or comments are empty.
+    pub fn try_write_variant_table(
+        &mut self,
+        params: &EnumDefinition,
</code_context>

<issue_to_address>
**issue (complexity):** Consider extracting the repeated table-writing logic into a reusable helper to simplify and unify table rendering methods.

You’re introducing a lot of the same “write headers / write separator / join rows” logic that already lives in `try_write_table`. You can pull that out into a small helper and then your variant method becomes just “filter → map rows → call helper.” For example:

```rust
impl<'a> YourWriter<'a> {
    /// Writes any piped-table given a title, headers, and an iterator of row cells.
    fn write_piped_table<I>(
        &mut self,
        title: &str,
        headers: &[&str],
        rows: I,
    ) -> fmt::Result
    where
        I: IntoIterator<Item = Vec<String>>,
    {
        self.write_bold(title)?;
        self.writeln()?;
        // header row
        self.write_piped(&headers.join("|"))?;
        // separator row
        self.write_piped(&headers.iter().map(|_| "---").join("|"))?;
        // data rows
        for row in rows {
            self.write_piped(&row.join("|"))?;
        }
        self.writeln()
    }
}
```

Then collapse your `try_write_variant_table` to:

```rust
pub fn try_write_variant_table(
    &mut self,
    params: &EnumDefinition,
    comments: &Comments
) -> fmt::Result {
    let comments = comments.include_tags(&[CommentTag::Param, CommentTag::Custom("variant".into())]);
    if comments.is_empty() {
        return Ok(());
    }

    let rows = params.values.iter().map(|value| {
        let name = value.as_ref().map(|v| v.name.as_str()).unwrap_or("<none>");
        let comment = comments
            .iter()
            .find_map(|c| c.match_first_word(name))
            .unwrap_or_default()
            .replace('\n', " ");

        vec![
            Markdown::Code(name).as_doc().unwrap(),
            comment,
        ]
    });

    self.write_piped_table("Variants", &VARIANTS_TABLE_HEADERS, rows)
}
```

This preserves all behavior but removes ad-hoc joins, separators, and nesting—reusing one concise helper for every piped table.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[gemini-code-assist]

Code Review

This pull request introduces a wide range of changes, including adding support for enum variant tables in documentation, refining verification provider logic, and adding a new counter example project. The changes are generally positive, improving functionality and code structure. However, I've identified a regression in how script execution costs are displayed, which now incorrectly hardcodes "ETH" as the currency for all chains, potentially misleading users. I've also suggested a refactoring for a new Solidity test utility to improve its clarity and style.

[Dargon789]

Forge/remix master#124