Add voyager verification to the `verify` command #2566

cwkang1998 · 2024-10-07T11:40:39Z

This is a follow up PR to complete changes that #2288 wants to introduce.

Introduced changes

Refactor the verification modules as per its predecessor PR refactor verification crate & add voyager interface #2288.
Add Voyager as one of the contract verifier target

Additional context on a possible edge case

As Voyager backend limits the http alive time to less than 30s, given a large contract which compilation might take longer, we might have to have the compilation task run asynchronously in order and have the status polled. This is currently not implemented in this PR as testing is being done to see if this is significant enough of a problem to be addressed this way.

Checklist

Will complete this checklist after another self review.

cwkang1998 · 2024-10-10T10:11:35Z

Addressing some of @integraledelebesgue comments from #2288

#[async_trait] attribute is not required #2288 (comment)

Seems that its failing to compile without the macro. Any alternatives you might have had in your mind?

Please add descriptions of all parameters to display in help

We would like to unify the wole configuration to a TOML file. Could you please redesign the url acquisition logic to use an enum provied via CastConfig rather than an environmental variable?

Both implementations of this method are identical. You can make it a default implementation

Sure

Similarly to verify, implementations of this method differ only with the url source. How about introducing a new trait method, let's say get_base_url, implementing it manually on both types and using in a default implementation of gen_explorer_url?

This method never fails. Are there any reasons for it to return a Result?
refactor verification crate & add voyager interface #2288 (comment)

I'll try that out.
I don't think so, removing it.

cwkang1998 · 2024-10-12T19:18:16Z

Successfully made some of the methods default, and remove the need of using a base struct inside each concrete verification interface struct.

Since the verification provider api is constructed slightly differently, I don't think that replacinggen_explorer_url is a valid choice anymore since the last review. However, I did still move the configuration for the custom base api url to CastConfig as suggested.

Will move on to update the current tests tomorrow.

cwkang1998 · 2024-10-14T05:25:45Z

Tests updated! Reviews would be appreciated.

piotmag769 · 2024-10-17T14:09:22Z

cc @cptartur

cptartur

Hey, thanks for contributing. I think some parts may be improved.

Also, I haven't reviewed the tests yet but will do soon.

cptartur · 2024-10-18T12:33:19Z

CHANGELOG.md

+#### Added
+- Add Voyager API support for `verify` subcommand [Read more here](https://foundry-rs.github.io/starknet-foundry/appendix/sncast/verify.html).
+


Suggested change

#### Added

- Add Voyager API support for `verify` subcommand [Read more here](https://foundry-rs.github.io/starknet-foundry/appendix/sncast/verify.html).

#### Added

- Voyager API support for `verify` subcommand [Read more here](https://foundry-rs.github.io/starknet-foundry/appendix/sncast/verify.html).

cptartur · 2024-10-18T15:32:45Z

crates/sncast/src/starknet_commands/verification/base.rs

+
+#[async_trait]
+pub trait VerificationInterface {
+ fn get_workspace_dir(&self) -> Utf8PathBuf;


I don't think this should be a part of trait. I think all verification providers will want to handle it the same so there's no point abstracting it like that.

I'd simply change verify signature so it takes this directory as well.

Additionally read_workspace_files should be removed from this trait and should be made a free function that takes directory as an argument.

cptartur · 2024-10-18T15:35:53Z

crates/sncast/src/starknet_commands/verification/base.rs

+ async fn send_verification_request(
+ &self,
+ url: String,
+ payload: VerificationPayload,
+ ) -> Result<VerifyResponse> {
+ let json_payload = serde_json::to_string(&payload)?;
+ let client = reqwest::Client::new();
+ let api_res = client
+ .post(url)
+ .header("Content-Type", "application/json")
+ .body(json_payload)
+ .send()
+ .await
+ .context("Failed to send request to verifier API")?;
+
+ if api_res.status() == StatusCode::OK {
+ let message = api_res
+ .text()
+ .await
+ .context("Failed to read verifier API response")?;
+ Ok(VerifyResponse { message })
+ } else {
+ let message = api_res.text().await.context("Failed to verify contract")?;
+ Err(anyhow!(message))
+ }
+ }


This isn't using self anyway, I'd just make it a normal function.

cptartur · 2024-10-18T15:37:53Z

crates/sncast/src/helpers/configuration.rs

+ #[serde(
+ default,
+ rename(
+ serialize = "verification-base-url",
+ deserialize = "verification-base-url"
+ )
+ )]
+ /// Custom base url to be used for verification
+ pub verification_base_url: Option<String>,


If we want to allow overriding the URL, I think it should be done only in verify subcommand arguments not in a global configuration.

cptartur · 2024-10-18T15:41:58Z

crates/sncast/src/starknet_commands/mod.rs

@@ -7,4 +7,4 @@ pub mod multicall;
 pub mod script;
 pub mod show_config;
 pub mod tx_status;
-pub mod verify;
+pub mod verification;


I wouldn't rename that. Modules in starknet_commands generally follow the name of the commands they are related to.

cptartur · 2024-10-18T15:50:32Z

crates/sncast/src/starknet_commands/verification/base.rs

+pub trait VerificationInterface {
+ fn get_workspace_dir(&self) -> Utf8PathBuf;
+
+ fn gen_explorer_url(&self, config: CastConfig) -> String;


I think instead of having an config argument, implementations should take a base url and network arguments when being created with new.

This way usage is much simpler: provide an relevant override of gen_explorer_url that forms correct urls from information you have and verify can use it without providing anything.

cptartur · 2024-10-18T15:58:08Z

docs/src/appendix/sncast/verify.md

+
+The address of the contract that is to be verified.
+
+## `--class-name <CONTRACT_NAME>`


Why are we renaming this?

cptartur · 2024-10-18T16:03:02Z

crates/sncast/src/starknet_commands/verification/verify.rs

+ // ensure that either contract_address or class_hash is provided
+ if contract_address.is_none() && class_hash.is_none() {
+ bail!("Either contract_address or class_hash must be provided");
+ }


I think this can be done at clap level with ArgGroup and flatten

Take a look at this: https://stackoverflow.com/questions/76315540/how-do-i-require-one-of-the-two-clap-options

cptartur · 2024-10-18T16:04:02Z

docs/src/appendix/sncast/verify.md

+## `--class-hash, -c <CONTRACT_ADDRESS>`
+Required.
+
+The address of the contract that is to be verified.


Let's also say that this conflicts with the other argument and exactly one is required.

rjnrohit and others added 2 commits October 7, 2024 19:21

base implementation of voyager verification

1be8fef

add voyager specific urls

8bd0897

cwkang1998 changed the title ~~Add Voyager as a contract verifier~~ Add voyager verification interface to the verify command Oct 7, 2024

cwkang1998 changed the title ~~Add voyager verification interface to the verify command~~ Add voyager verification to the verify command Oct 7, 2024

cwkang1998 added 2 commits October 10, 2024 17:54

Merge branch 'foundry-rs:master' into feat/add-voyager-verification

2f66f39

Add docs to changelogs

4c5d105

cwkang1998 force-pushed the feat/add-voyager-verification branch from 3b1f764 to 4c5d105 Compare October 10, 2024 10:00

cwkang1998 marked this pull request as ready for review October 10, 2024 10:05

cwkang1998 requested review from ksew1, integraledelebesgue, cptartur and ddoktorski as code owners October 10, 2024 10:05

cwkang1998 added 3 commits October 11, 2024 19:49

Add description to cli args

e084803

Make verify & some shared methods default

d94be1c

Move custom base api url for verify to CastConfig

952fba0

Ammend tests for verification urls

70532da

cwkang1998 force-pushed the feat/add-voyager-verification branch from d978d39 to 70532da Compare October 14, 2024 05:25

cptartur requested changes Oct 18, 2024

View reviewed changes

cptartur self-requested a review October 18, 2024 16:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add voyager verification to the `verify` command #2566

Add voyager verification to the `verify` command #2566

cwkang1998 commented Oct 7, 2024 •

edited

Loading

cwkang1998 commented Oct 10, 2024 •

edited

Loading

cwkang1998 commented Oct 12, 2024 •

edited

Loading

cwkang1998 commented Oct 14, 2024

piotmag769 commented Oct 17, 2024

cptartur left a comment •

edited

Loading

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

cptartur Oct 18, 2024

		#### Added
		- Add Voyager API support for `verify` subcommand [Read more here](https://foundry-rs.github.io/starknet-foundry/appendix/sncast/verify.html).


		The address of the contract that is to be verified.

		## `--class-name <CONTRACT_NAME>`

Add voyager verification to the verify command #2566

Are you sure you want to change the base?

Add voyager verification to the verify command #2566

Conversation

cwkang1998 commented Oct 7, 2024 • edited Loading

Introduced changes

Additional context on a possible edge case

Checklist

cwkang1998 commented Oct 10, 2024 • edited Loading

cwkang1998 commented Oct 12, 2024 • edited Loading

cwkang1998 commented Oct 14, 2024

piotmag769 commented Oct 17, 2024

cptartur left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add voyager verification to the `verify` command #2566

Add voyager verification to the `verify` command #2566

cwkang1998 commented Oct 7, 2024 •

edited

Loading

cwkang1998 commented Oct 10, 2024 •

edited

Loading

cwkang1998 commented Oct 12, 2024 •

edited

Loading

cptartur left a comment •

edited

Loading