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: add instructions for deploy and verify #324

Merged
merged 2 commits into from
Aug 15, 2024
Merged

Conversation

skosito
Copy link
Contributor

@skosito skosito commented Aug 14, 2024

closes: #252

tested on etherscan and blockscout explorers for sepolia network

Summary by CodeRabbit

  • Documentation
    • Enhanced deployment script documentation with detailed instructions for verifying contracts post-deployment.
    • Introduced two new verification options: etherscan and blockscout, complete with example commands for clarity.

Copy link
Contributor

coderabbitai bot commented Aug 14, 2024

Walkthrough

This update enhances the deployment script documentation by incorporating detailed instructions for contract verification after deployment. It introduces two verification methods—etherscan and blockscout—complete with example commands. This addition clarifies the deployment process, ensuring users understand how to verify their contracts effectively.

Changes

File Path Change Summary
v2/scripts/deploy/deterministic/readme.md Added instructions for verifying contracts using etherscan and blockscout, including example commands.

Assessment against linked issues

Objective Addressed Explanation
Add a script to automatically verify the contracts on a network (#252)

🐇 In the meadow, contracts bloom,
With etherscan, chase away the gloom.
blockscout joins the joyous ride,
Verification cleared, let worries subside!
🥕 Hops and scripts, a perfect blend,
Happy coding, my furry friend! 🐰


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)
v2/scripts/deploy/deterministic/readme.md (2)

31-33: Specify the language for the code block.

To improve readability and adhere to markdownlint guidelines, specify the language for the code block. For example, use bash for shell commands.

- ```
+ ```bash
Tools
Markdownlint

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


36-39: Specify the language for the code block.

To improve readability and adhere to markdownlint guidelines, specify the language for the code block. For example, use bash for shell commands.

- ```
+ ```bash
Tools
Markdownlint

36-36: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3481d17 and 100078e.

Files selected for processing (1)
  • v2/scripts/deploy/deterministic/readme.md (1 hunks)
Additional context used
Markdownlint
v2/scripts/deploy/deterministic/readme.md

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


36-36: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.81%. Comparing base (3481d17) to head (100078e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #324   +/-   ##
=======================================
  Coverage   81.81%   81.81%           
=======================================
  Files           7        7           
  Lines         297      297           
  Branches       97       97           
=======================================
  Hits          243      243           
  Misses         54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lumtis lumtis changed the title chore: add instructions for deploy and verify docs: add instructions for deploy and verify Aug 15, 2024
Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

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

LGTM
Note: PR semantic is docs instead of chore

@lumtis lumtis merged commit 7b37b69 into main Aug 15, 2024
9 checks passed
@lumtis lumtis deleted the deploy-and-verify-docs branch August 15, 2024 08:14
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.

Add a script to automatically verify the contracts on a network
5 participants