-
Notifications
You must be signed in to change notification settings - Fork 196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(cli/verify): initial version #2744
Conversation
|
docs/pages/cli/verify.mdx
Outdated
1. If using Blockscout, you need to specify the API key: | ||
|
||
```sh copy | ||
export ETHERSCAN_API_KEY=<value goes here> | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i actually think blockscout doesn't require an api key (but it might be that forge expects something to be provided as an an api key)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no blockscout API key afaik, only need to provide an etherscan API key if you use --verifier etherscan
or no --verifier
(forge defaults to etherscan)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
We (@yonadaaa and me) decided not to document Etherscan verification at this time because neither of us managed to get it working.
-
If I understand https://docs.blockscout.com/for-users/api#api-keys correctly, it means that Blockscout will serve up to 50 calls without a key every second. Yours may or may not be one of them. But with an API key you get 10 calls a second for yourself.
docs/pages/cli/verify.mdx
Outdated
| Option | Meaning | Type | Default value | | ||
| ---------------- | -------------------------------------------------------- | ------- | ---------------------------- | | ||
| `--worldAddress` | Verify the contracts of the `World` at the given address | string | none, error if unspecified | | ||
| `--version` | Show version number | boolean | `false` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need to document this, this isn't specific to this command but for the whole CLI
(same goes for all CLI commands)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should document it for completeness, but I moved it to the bottom of the list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
disagree, it's just noise here
docs/pages/cli/verify.mdx
Outdated
1. Run the command. | ||
|
||
```sh copy | ||
pnpm mud verify --worldAddress <address here> --verifier <verifier> --profle <profile> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we use --profile holesky
here since we used holesky provide in the example above?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, here we explain what to do so we need to be precise. The examples are below
Co-authored-by: Kevin Ingersoll <[email protected]>
Co-authored-by: Kevin Ingersoll <[email protected]>
No description provided.