feat(forge): allow `--verifier custom` option (#9311) #6

Dargon789 · 2024-11-14T21:27:55Z

feat(forge): allow --verifier custom option
Changes after review: add description of custom verifier, reorg err message, add custom verifier api key
Fix descriptions
Update crates/verify/src/provider.rs

Motivation

Solution

Summary by Sourcery

Add support for a custom verification provider by introducing the --verifier custom option, along with the ability to specify a custom verifier API key and URL.

New Features:

Introduce a --verifier custom option to allow users to specify a custom verification provider.

Enhancements:

Add support for a custom verifier API key and URL, enabling integration with custom verification providers.

* feat(forge): allow `--verifier custom` option * Changes after review: add description of custom verifier, reorg err message, add custom verifier api key * Fix descriptions * Update crates/verify/src/provider.rs Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> --------- Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com>

sourcery-ai · 2024-11-14T21:28:00Z

Reviewer's Guide by Sourcery

This PR adds support for custom verification providers by introducing a new --verifier custom option. The implementation extends the existing verification infrastructure to handle custom providers that are compatible with the Etherscan API. It also adds a new --verifier-api-key parameter and improves error handling in the retry mechanism.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added support for custom verification provider type	Added new Custom variant to VerificationProviderType enum Implemented FromStr and Display traits for the Custom provider type Set up Custom provider to use EtherscanVerificationProvider as its backend	`crates/verify/src/provider.rs`
Enhanced verifier configuration with API key support	Added new verifier_api_key field to VerifierArgs struct Updated Default implementation for VerifierArgs Added API key handling in figment Provider implementations	`crates/verify/src/verify.rs` `crates/verify/src/bytecode.rs`
Improved error handling in retry mechanism	Updated error message formatting in handle_err method Switched to sh_warn! macro for error logging	`crates/common/src/retry.rs`

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.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a 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. You can also use
this command to specify where the summary should be inserted.

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.

sourcery-ai

Hey @Dargon789 - I've reviewed your changes - here's some feedback:

Overall Comments:

Please add tests for the custom verifier functionality to ensure it works as expected
The PR description is empty - please fill out the motivation and solution sections to help reviewers understand the context and purpose of these changes

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

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

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

crates/verify/src/verify.rs

* begin api and rough comments * impl cheatcode * add check for eoa * fix eoa check on each prank call * add to assets * prank compiling * delegate call working, storage not upating * delegate call working, some tidy up * add prank2 calls * impl remaining tests * formatting * forge fmt * add pranks to cheatcodes.json * run cargo cheats * If verbosity level is 1 or higher, it shows dirty files. * Fix, add EOA prank test * Revert "If verbosity level is 1 or higher, it shows dirty files." This reverts commit d03ac1d. * Fix test * apply on extdelegatecall --------- Co-authored-by: mgiagante <251503-mgiagante@users.noreply.gitlab.com> Co-authored-by: grandizzy <grandizzy.the.egg@gmail.com>

…9321) * add --sizes and --names JSON compatibility + generalize report kind * add additional json output tests * fix feedback nit

Dargon789

feat(forge): allow --verifier custom option (foundry-rs#9311) #6

* test: enhance tests * update ws url * Assert json unordered * Update crates/test-utils/src/util.rs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * Changes after review * Fix rpc url test --------- Co-authored-by: grandizzy <grandizzy.the.egg@gmail.com> Co-authored-by: grandizzy <38490174+grandizzy@users.noreply.github.com> Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>

Locking 40 packages to latest compatible versions Updating allocator-api2 v0.2.19 -> v0.2.20 Updating alloy-dyn-abi v0.8.11 -> v0.8.12 Updating alloy-json-abi v0.8.11 -> v0.8.12 Updating alloy-primitives v0.8.11 -> v0.8.12 Updating alloy-sol-macro v0.8.11 -> v0.8.12 Updating alloy-sol-macro-expander v0.8.11 -> v0.8.12 Updating alloy-sol-macro-input v0.8.11 -> v0.8.12 Updating alloy-sol-type-parser v0.8.11 -> v0.8.12 Updating alloy-sol-types v0.8.11 -> v0.8.12 Updating aws-sdk-sts v1.49.0 -> v1.50.0 Updating axum v0.7.7 -> v0.7.9 Updating bstr v1.10.0 -> v1.11.0 Updating cc v1.1.37 -> v1.2.1 Updating clap v4.5.20 -> v4.5.21 Updating clap_builder v4.5.20 -> v4.5.21 Updating clap_complete v4.5.37 -> v4.5.38 Updating clap_lex v0.7.2 -> v0.7.3 Updating comfy-table v7.1.1 -> v7.1.3 Updating cpufeatures v0.2.14 -> v0.2.15 Removing crossterm v0.27.0 Adding diff v0.1.13 Updating flate2 v1.0.34 -> v1.0.35 Updating indicatif v0.17.8 -> v0.17.9 Adding indoc v2.0.5 Updating instability v0.3.2 -> v0.3.3 Removing instant v0.1.13 Updating libc v0.2.162 -> v0.2.164 Adding pretty_assertions v1.4.1 Updating quinn v0.11.5 -> v0.11.6 Updating quinn-proto v0.11.8 -> v0.11.9 Updating regex-automata v0.4.8 -> v0.4.9 Updating rustix v0.38.39 -> v0.38.40 Updating rustls v0.23.16 -> v0.23.17 Updating scc v2.2.4 -> v2.2.5 Updating serde v1.0.214 -> v1.0.215 Updating serde_derive v1.0.214 -> v1.0.215 Updating syn-solidity v0.8.11 -> v0.8.12 Removing thiserror v1.0.68 Adding thiserror v1.0.69 (available: v2.0.3) Adding thiserror v2.0.3 Removing thiserror-impl v1.0.68 Adding thiserror-impl v1.0.69 Adding thiserror-impl v2.0.3 Adding web-time v1.1.0 note: pass `--verbose` to see 44 unchanged dependencies behind latest Co-authored-by: mattsse <19890894+mattsse@users.noreply.github.com>

Dargon789

update cargo.lock

Dargon789

feat(forge): allow --verifier custom option (foundry-rs#9311) #6
test

Dargon789

test again

* feat(cast storage): allow ugly printing of layout Prior to this change, `cast storage $ADDRESS --rpc-url $RPC_URL --etherscan-api-key $ETHERSCAN_API_KEY` always provided a prettified output. This change adds a `--pretty` flag to `cast storage` which defaults to `true` thus retaining backwards compatibility. Passing `--pretty=false` to `cast storage` results in the json output of the storage layout being produced instead. * fix: remove default value from help text The default value is accessible via `cast storage --help` * fix(cast storage): provide output json path * test(cast): add storage_layout_simple_json test * fix(cast storage): use `--json` flag to ugly print * fix(cast storage): include values in json mode * fix(cast-storage): quiet compilation in all cases * chore: cargo clippy * use fixtures, assert JSON * only quiet if JSON mode, avoid unnecessary warning (if you pass an API key you already expect to fetch remote, very likely default) --------- Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> Co-authored-by: zerosnacks <zerosnacks@protonmail.com>

* chore: Update to Cancun * cancun to TEST_DATA_DEFAULT, add TEST_DATA_PARIS * Shanghai compat test * Redact gaswaster address

Dargon789

crates file test

…les to compile (#9325) * If verbosity level is 1 or higher, it shows dirty files. * Adds verbose message variant for compilation. * Removing `if..else` statement to always display `self.send_msg`. * Changes order of messages. * Removes semicolons and adds comment on message order. * Removes verbose variant in favor of the already existing variant. * nits, sort the dirty files list and prefix with - * Raises verbosity level to 5+ * Update crates/common/src/term.rs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> --------- Co-authored-by: mgiagante <251503-mgiagante@users.noreply.gitlab.com> Co-authored-by: zerosnacks <zerosnacks@protonmail.com> Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>

* chore: move archive endpoints to different provider * Make archive endpoints configurable in env vars * Truncate fork url in err * Include only provider in failed fork message * Add env vars from secrets * Fix tests --------- Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

Dargon789

crates/forge/tests/cli/coverage.rs

Dargon789

custom option test

Fix typographical error in default value assignment for FOUNDRY_DIR

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

inherit secrets, use alchemy as default for external PRs, comment out infura

Co-authored-by: grandizzy <grandizzy.the.egg@gmail.com>

* add EIP-7702 cheatcodes: createDelegation, signDelegation, attachDelegation * add cheatcode implementations for EIP-7702: createDelegationCall, signDelegationCall, attachDelegationCall; modify broadcast to check if sender has a delegation * add delegations hashmap to Cheatcodes struct * add revm crate * create AttachDelegationTest for EIP-7702 transactions * regen cheatcodes.json * cargo fmt * move broadcast under attachDelegation * combine createDelegationCall logic with signDelegationCall in order to create and sign delegation in a single call; remove delegation logic from broadcast() - no need to track delegations here * remove revm import from workspace * combine createDelegation logic inton signDelegation for simplicity * remove revm from forge script deps * combine createDelegation with signDelegation * WIP - refactor test to use SimpleDelegateContract and ERC20 - test currently failing bc 7702 implementation.execute not executed as Alice EOA * add logic to include authorization_list for EIP 7702 in TransactionRequest by searching delegations hash map by active_delegation * add address authority param to attachDelegation; remove nonce param from signDelegation, as it can be constructed in cheatcode. * remove 7702 tx request construction logic - now handled in attachDelegation cheatcode implementation * refactor attachDelegation cheatcode implementation to handle verifying signature and setting bytecode on EOA; refactor signDelegation cheatcode implementation to get nonce from signer * remove nonce param from attachDelegation cheatcode in favor of loading from authority account * refactor test to check for code on alice account and call execute on alice account through SimpleDelegateContract * revert refactor on TransactionRequest * format * cargo fmt * fix clippy errors * remove faulty logic comparing nonce to itself - nonce still checked by recovered signature * add more tests to cover revert cases on attachDelegation and multiple calls via delegation contract * cargo fmt * restore logic to check if there's an active delegation when building TransactionRequest; add fixed values for gas and max_priority_fee_per_gas to ensure tx success, with TODO comment to explain what's left * remove obsolete comment * add comments explaining delegations and active_delegation * cargo fmt * add logic to increase gas limit by PER_EMPTY_ACCOUNT_COST(25k) if tx includes authorization list for EIP 7702 tx, which is seemingly not accounted for in gas estimation; remove hardcoded gas values from call_with_executor * revert logic to add PER_EMPTY_ACCOUNT_COST for EIP 7702 txs - handled inside of revm now * remove manually setting transaction type to 4 if auth list is present - handled in revm * add method set_delegation to Executor for setting EIP-7702 authorization list in the transaction environment; call set_delegation from simulate_and_fill if auth list is not empty * remove redundancy with TransactionMaybeSigned var tx * cargo fmt * refactor: use authorization_list() helper to return authorization_list and set delegation * refactor: change Cheatcodes::active_delegation to Option<SignedAuthorization> and remove delegations hashmap - tx will only use one active delegation at a time, so no need for mapping * replace verbose logic to set bytecode on EOA with journaled_state.set_code helper * cargo fmt * increment nonce of authority account * add logic to set authorization_list to None if active_delegation is None * add test testSwitchDelegation to assert that attaching an additional delegation switches the implementation on the EOA * remove set_delegation logic in favor of adding call_raw_with_authorization - previous approach kept the delegation in the TxEnv, resulting in higher gas cost for all subsequent calls after the delegation was applied * refactor signDelegation to return struct SignedDelegation and for attachDelegation to accept SignedDelegation * update delegation tests to reflect change in cheatcode interface for signDelegation and attachDelegation * add cheatcode signAndAttachDelegation * add signAndAttachDelegationCall cheatcode logic; refactor helper methods for shared logic used in 7702 delegation cheatcodes * add test testCallSingleSignAndAttachDelegation for new cheatcode signAndAttachDelegation * add comments to SignedDelegation struct and cargo fmt * cargo fmt * fix ci * fix spec --------- Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com> Co-authored-by: grandizzy <38490174+grandizzy@users.noreply.github.com>

* rename ShellOpts to GlobalOpts * prefer arg / command over clap * add global opts * remove redundant GlobalOpts injection, only use where access to the global variables is required * add global thread pool * add try_jobs method for global rayon pool * limit unnecessary globalopts injection where shell::* is preferred * fix tests * port custom threads iterator to use global rayon thread pool * remove redundant ignores * remove leftover from merge conflict, fix clashing args with inlined global in nodeargs / anvil top level args * leftovers * add back global args in script args * fix unused global opts * ignore attempted multiple initializations of the global thread pool * add init, default spawn with default rayon settings on forge test * make test thread number configurable * add back max threads back test to reduce pressure * remove global --jobs rayon pool, revert to current implementation * fix import

Dargon789

nexttest fail

Dargon789

fork test

* bump alloy to 0.6.1 * fix: ui - use AnyRpcBlock * fix: wallets - use PrimitveSig * bump 0.6.2 * replace: AnyNetworkBlock with AnyRpcBlock + HeaderResponse with BlockHeader * fix: configure_tx_env * fix: crypto cheatcodes * fix: anvil_core tx * fix * fix: verify-bytecode * fix cast + get_pretty_tx_attr * fix(`anvil`): core TypedTx + BlockListener task * fix * fix: anvil tests * fix: test_deser_block * fix: transaction_build * fix: test load state files * fix: deny.toml * fix: try_from AnyRpcTx to DepositTx + bump op-alloy types * bump * fix: configure_tx_env * fix: UiFmt * fix: vb * fix: common-fmt tests * nit * fix: sig encoding * fix: process deposit tx in transaction_build * fix: common-fmt tests * fix * Update deny.toml Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> * fixes * fix: use alloy impls for conversions * nit * fix: transaction_build * nit * fix: eip155 check and rm anvil core utils * clippy * nits * fix * nit * fix: impl UIfmt for TxEnvelope and AnyTxEnvelope * make header in pretty_block_basics exhaustive * clippy * fix * fix: txpool_content * fix * fix * fix overriding hashes * fix --------- Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> Co-authored-by: grandizzy <38490174+grandizzy@users.noreply.github.com>

Dargon789

feat(forge)

* feat(`anvil`): --cache-path * nits * test * nit * run with tempdir * nit

* feat: add global -j, --threads * Update crates/cli/src/opts/global.rs * fix tests after comment update --------- Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> Co-authored-by: zerosnacks <zerosnacks@protonmail.com>

Dargon789

cargo.tomi

Dargon789

mod file test

sourcery-ai bot previously approved these changes Nov 14, 2024

View reviewed changes

crates/verify/src/verify.rs Show resolved Hide resolved

Dargon789 enabled auto-merge (squash) November 14, 2024 21:44

auto-merge was automatically disabled November 15, 2024 14:02
Head branch was pushed to by a user without write access

mattsse dismissed sourcery-ai[bot]’s stale review via c526cab November 15, 2024 14:02

grandizzy and others added 3 commits November 15, 2024 16:29

feat(forge build): err if no source file in specified paths (#9329)

9d7557f

feat(forge build): add --sizes and --names JSON compatibility (#…

a79dfae

…9321) * add --sizes and --names JSON compatibility + generalize report kind * add additional json output tests * fix feedback nit

chore: fix clippy (#9333)

3eb47ea

Dargon789 commented Nov 16, 2024

View reviewed changes

Dargon789 enabled auto-merge (squash) November 16, 2024 12:53

auto-merge was automatically disabled November 17, 2024 09:06
Head branch was pushed to by a user without write access

Dargon789 commented Nov 17, 2024

View reviewed changes

Dargon789 enabled auto-merge (squash) November 17, 2024 15:45

Dargon789 linked an issue Nov 17, 2024 that may be closed by this pull request

bug: release workflow failed #7

Closed

chore: fix getArtifactPath flaky test (#9339)

44c86e7

auto-merge was automatically disabled November 18, 2024 06:56
Head branch was pushed to by a user without write access

Dargon789 commented Nov 18, 2024

View reviewed changes

Dargon789 enabled auto-merge (rebase) November 18, 2024 08:08

auto-merge was automatically disabled November 18, 2024 14:48
Head branch was pushed to by a user without write access

feat(config): set default evm version to cancun (#9131)

60dd1d7

* chore: Update to Cancun * cancun to TEST_DATA_DEFAULT, add TEST_DATA_PARIS * Shanghai compat test * Redact gaswaster address

Dargon789 commented Nov 18, 2024

View reviewed changes

chore: update test values to cancun (#9344)

550ebd8

Dargon789 enabled auto-merge (squash) November 18, 2024 17:44

DaniPopes and others added 2 commits November 19, 2024 17:33

test: update external forge-std (#9356)

9f0c26d

Dargon789 commented Nov 19, 2024

View reviewed changes

Dargon789 enabled auto-merge (squash) November 19, 2024 21:38

Dargon789 commented Nov 19, 2024

View reviewed changes

Dargon789 disabled auto-merge November 19, 2024 21:47

Dargon789 enabled auto-merge November 19, 2024 21:47

Dargon789 disabled auto-merge November 20, 2024 03:08

grandizzy and others added 8 commits November 20, 2024 09:46

chore: pick provider urls by next index (#9359)

4648d5c

fix: correct shell substitution in installer (#9351)

d20c142

Fix typographical error in default value assignment for FOUNDRY_DIR

chore: TestSetup cleanup (#9355)

e577693

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

chore(ci): proper read of archive nodes (#9362)

3a95440

inherit secrets, use alchemy as default for external PRs, comment out infura

chore(test-utils): simplify next calls (#9361)

999cc1b

Co-authored-by: grandizzy <grandizzy.the.egg@gmail.com>

chore(deps): bump foundry-compilers 0.12.2 (#9364)

b9ee7de

Dargon789 commented Nov 20, 2024

View reviewed changes

chore(deps): bump foundry-compilers 0.12.3 (#9368)

fb5f0e1

Dargon789 commented Nov 20, 2024

View reviewed changes

Dargon789 enabled auto-merge (squash) November 20, 2024 20:01

feat(anvil): --cache-path (#9343)

057c8ac

* feat(`anvil`): --cache-path * nits * test * nit * run with tempdir * nit

auto-merge was automatically disabled November 21, 2024 07:02
Head branch was pushed to by a user without write access

yash-atreya and others added 3 commits November 21, 2024 10:13

chore: rm flaky cache-path test (#9372)

9504f78

feat: add global -j, --threads (#9367)

fef2098

* feat: add global -j, --threads * Update crates/cli/src/opts/global.rs * fix tests after comment update --------- Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> Co-authored-by: zerosnacks <zerosnacks@protonmail.com>

feat: Update to soldeer 0.5.2 (#9373)

41b4359

Dargon789 commented Nov 21, 2024

View reviewed changes

Dargon789 enabled auto-merge (squash) November 21, 2024 15:38

Dargon789 commented Nov 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(forge): allow `--verifier custom` option (#9311) #6

feat(forge): allow `--verifier custom` option (#9311) #6

Dargon789 commented Nov 14, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Nov 14, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

Dargon789 left a comment

feat(forge): allow --verifier custom option (#9311) #6

Are you sure you want to change the base?

feat(forge): allow --verifier custom option (#9311) #6

Conversation

Dargon789 commented Nov 14, 2024 • edited by sourcery-ai bot Loading

Motivation

Solution

Summary by Sourcery

sourcery-ai bot commented Nov 14, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

Dargon789 left a comment

Choose a reason for hiding this comment

feat(forge): allow `--verifier custom` option (#9311) #6

feat(forge): allow `--verifier custom` option (#9311) #6

Dargon789 commented Nov 14, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Nov 14, 2024 •

edited

Loading