Skip to content
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

Merged
merged 18 commits into from
Apr 27, 2024
Merged

docs(cli/verify): initial version #2744

merged 18 commits into from
Apr 27, 2024

Conversation

qbzzt
Copy link
Contributor

@qbzzt qbzzt commented Apr 25, 2024

No description provided.

@qbzzt qbzzt requested review from ludns, alvrs, holic and yonadaa as code owners April 25, 2024 22:22
Copy link

changeset-bot bot commented Apr 25, 2024

⚠️ No Changeset found

Latest commit: 69c8656

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Comment on lines 19 to 23
1. If using Blockscout, you need to specify the API key:

```sh copy
export ETHERSCAN_API_KEY=<value goes here>
```
Copy link
Member

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)

Copy link
Member

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)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. We (@yonadaaa and me) decided not to document Etherscan verification at this time because neither of us managed to get it working.

  2. 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 Show resolved Hide resolved
| 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` |
Copy link
Member

@holic holic Apr 25, 2024

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)

Copy link
Contributor Author

@qbzzt qbzzt Apr 26, 2024

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.

Copy link
Member

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 Show resolved Hide resolved
docs/pages/cli/verify.mdx Outdated Show resolved Hide resolved
1. Run the command.

```sh copy
pnpm mud verify --worldAddress <address here> --verifier <verifier> --profle <profile>
Copy link
Member

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?

Copy link
Contributor Author

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

docs/pages/cli/verify.mdx Outdated Show resolved Hide resolved
@qbzzt qbzzt requested a review from alvrs April 26, 2024 21:12
docs/pages/cli/verify.mdx Outdated Show resolved Hide resolved
docs/pages/cli/verify.mdx Outdated Show resolved Hide resolved
docs/pages/cli/verify.mdx Outdated Show resolved Hide resolved
Co-authored-by: Kevin Ingersoll <[email protected]>
@holic holic merged commit 0c1136a into main Apr 27, 2024
5 checks passed
@holic holic deleted the 240419-mud-verify branch April 27, 2024 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants