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

Added migration net to readme #275

Merged
merged 2 commits into from
May 31, 2024
Merged

Added migration net to readme #275

merged 2 commits into from
May 31, 2024

Conversation

devbugging
Copy link
Contributor

@devbugging devbugging commented May 30, 2024

Description

Addd migrationnet endpoint.


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • Documentation
    • Added configuration details for a new public RPC endpoint for the "Migrationnet" environment in the EVM Gateway section of the README.md file.

@devbugging devbugging changed the title added migration net Added migration net to readme May 30, 2024
@devbugging
Copy link
Contributor Author

double check endpoint

Copy link
Contributor

coderabbitai bot commented May 30, 2024

Walkthrough

The recent update to the README.md file introduces a new public RPC endpoint configuration for the "Migrationnet" environment within the EVM Gateway section. This addition aims to enhance the documentation by providing detailed configuration instructions for users working with the "Migrationnet" environment.

Changes

Files Change Summary
README.md Added a new public RPC endpoint configuration for the "Migrationnet" environment in the EVM Gateway section.

Poem

In the land of code where gateways meet,
A new path opens, oh so neat!
Migrationnet now joins the fray,
Guiding devs in a seamless way.
With endpoints clear and journeys bright,
The future's coded in pure delight.
🌐✨


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 Configration 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0c139fb and 2e9c224.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
LanguageTool
README.md

[style] ~6-~6: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aging with any other EVM blockchain.** EVM Gateway implements the Ethereum JSON-RP...


[style] ~7-~7: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....io/execution-apis/api-documentation/). EVM Gateway is specifically designed to int...


[typographical] ~7-~7: Consider adding a comma here.
Context: ...in the underlying implementation details please refer to the [FLIP #243](https://github...


[uncategorized] ~9-~9: Possible missing comma found.
Context: ... majority of standard Ethereum JSON-RPC APIs allowing seamless integration with exis...


[uncategorized] ~20-~20: When you use ‘all the …’ with a countable noun, use the plural “APIs”.
Context: ...t API component that implements all the API according to the JSON RPC API specifica...


[style] ~33-~33: Consider a shorter alternative to avoid wordiness.
Context: ...### Running Locally Start Emulator In order to run the gateway locally you need to sta...


[style] ~51-~51: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ...r is run before and transactions happen in the meantime, the gateway will not fetch those histo...


[typographical] ~54-~54: It appears that a comma is missing.
Context: .... This will be improved soon. _In this example we use coa-address value set to servi...


[uncategorized] ~56-~56: A different word order might sound more natural.
Context: ...ocal running beside collecting fees. We provide also the coa-resource-create to auto-crea...


[style] ~57-~57: Consider a shorter alternative to avoid wordiness.
Context: ...needed on start-up on the coa account in order to operate gateway. gas-price is set at...

Markdownlint
README.md

11-11: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time


31-31: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time


26-26: Expected: dash; Actual: asterisk
Unordered list style


168-168: Expected: dash; Actual: asterisk
Unordered list style


169-169: Expected: dash; Actual: asterisk
Unordered list style


170-170: Expected: dash; Actual: asterisk
Unordered list style


171-171: Expected: dash; Actual: asterisk
Unordered list style


172-172: Expected: dash; Actual: asterisk
Unordered list style


173-173: Expected: dash; Actual: asterisk
Unordered list style


174-174: Expected: dash; Actual: asterisk
Unordered list style


175-175: Expected: dash; Actual: asterisk
Unordered list style


176-176: Expected: dash; Actual: asterisk
Unordered list style


177-177: Expected: dash; Actual: asterisk
Unordered list style


178-178: Expected: dash; Actual: asterisk
Unordered list style


179-179: Expected: dash; Actual: asterisk
Unordered list style


180-180: Expected: dash; Actual: asterisk
Unordered list style


181-181: Expected: dash; Actual: asterisk
Unordered list style


182-182: Expected: dash; Actual: asterisk
Unordered list style


183-183: Expected: dash; Actual: asterisk
Unordered list style


184-184: Expected: dash; Actual: asterisk
Unordered list style


185-185: Expected: dash; Actual: asterisk
Unordered list style


186-186: Expected: dash; Actual: asterisk
Unordered list style


187-187: Expected: dash; Actual: asterisk
Unordered list style


188-188: Expected: dash; Actual: asterisk
Unordered list style


189-189: Expected: dash; Actual: asterisk
Unordered list style


190-190: Expected: dash; Actual: asterisk
Unordered list style


191-191: Expected: dash; Actual: asterisk
Unordered list style


192-192: Expected: dash; Actual: asterisk
Unordered list style


193-193: Expected: dash; Actual: asterisk
Unordered list style


194-194: Expected: dash; Actual: asterisk
Unordered list style


195-195: Expected: dash; Actual: asterisk
Unordered list style


196-196: Expected: dash; Actual: asterisk
Unordered list style


197-197: Expected: dash; Actual: asterisk
Unordered list style


198-198: Expected: dash; Actual: asterisk
Unordered list style


199-199: Expected: dash; Actual: asterisk
Unordered list style


200-200: Expected: dash; Actual: asterisk
Unordered list style


201-201: Expected: dash; Actual: asterisk
Unordered list style


202-202: Expected: dash; Actual: asterisk
Unordered list style


203-203: Expected: dash; Actual: asterisk
Unordered list style


204-204: Expected: dash; Actual: asterisk
Unordered list style


205-205: Expected: dash; Actual: asterisk
Unordered list style


206-206: Expected: dash; Actual: asterisk
Unordered list style


207-207: Expected: dash; Actual: asterisk
Unordered list style


208-208: Expected: dash; Actual: asterisk
Unordered list style


209-209: Expected: dash; Actual: asterisk
Unordered list style


210-210: Expected: dash; Actual: asterisk
Unordered list style


211-211: Expected: dash; Actual: asterisk
Unordered list style


212-212: Expected: dash; Actual: asterisk
Unordered list style


213-213: Expected: dash; Actual: asterisk
Unordered list style


214-214: Expected: dash; Actual: asterisk
Unordered list style


215-215: Expected: dash; Actual: asterisk
Unordered list style


216-216: Expected: dash; Actual: asterisk
Unordered list style


217-217: Expected: dash; Actual: asterisk
Unordered list style


7-7: Expected: 0 or 2; Actual: 1
Trailing spaces


54-54: Expected: 0 or 2; Actual: 1
Trailing spaces


55-55: Expected: 0 or 2; Actual: 1
Trailing spaces


56-56: Expected: 0 or 2; Actual: 1
Trailing spaces


57-57: Expected: 0 or 2; Actual: 1
Trailing spaces


58-58: Expected: 0 or 2; Actual: 1
Trailing spaces


169-169: Expected: 0 or 2; Actual: 1
Trailing spaces


181-181: Expected: 0 or 2; Actual: 1
Trailing spaces


15-15: Expected: 1; Actual: 2
Multiple consecutive blank lines


28-28: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


31-31: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


355-355: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


358-358: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


35-35: null
Fenced code blocks should be surrounded by blank lines


37-37: null
Fenced code blocks should be surrounded by blank lines


41-41: null
Fenced code blocks should be surrounded by blank lines


121-121: null
Fenced code blocks should be surrounded by blank lines


132-132: null
Bare URL used


141-141: null
Bare URL used


144-144: null
Bare URL used


150-150: null
Bare URL used


153-153: null
Bare URL used


159-159: null
Bare URL used


162-162: null
Bare URL used


32-32: null
Emphasis used instead of a heading


61-61: null
Emphasis used instead of a heading


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


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


107-107: Expected: underscore; Actual: asterisk
Emphasis style


107-107: Expected: underscore; Actual: asterisk
Emphasis style

Additional comments not posted (5)
README.md (5)

Line range hint 1-9: The introduction provides a clear and concise overview of the EVM Gateway's purpose and design. Good job maintaining clarity and brevity.


128-136: The addition of the "Migrationnet" environment to the EVM Gateway endpoints is well-executed. Please double-check the RPC endpoint URL and other details for accuracy.


Line range hint 304-324: The configuration flags are well-documented, providing clear and comprehensive information about each option. This section helps in understanding how to configure the EVM Gateway effectively.


Line range hint 347-367: The example queries section is well-prepared, offering practical and correctly formatted JSON-RPC API calls that demonstrate how to interact with the EVM Gateway.


Line range hint 369-371: The contributing guidelines and license sections are appropriately linked and provide the necessary legal and collaborative information.

@devbugging devbugging merged commit 4ae8ce7 into main May 31, 2024
2 checks passed
@m-Peter m-Peter deleted the gregor/readme-migrationnet branch July 29, 2024 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants