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

feat: add dentrite testnet #762

Merged
merged 2 commits into from
Aug 29, 2024
Merged

feat: add dentrite testnet #762

merged 2 commits into from
Aug 29, 2024

Conversation

amimart
Copy link
Member

@amimart amimart commented Aug 29, 2024

Add the axone-dentrite-1 testnet

Details

Genesis start time: 2024-09-10T12:00:00Z
Register before: 2024-09-07T00:00:00Z
Axoned version: v10.0.0

Copy link

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes involve updates to various configuration files and documentation within the Axone blockchain project. Key modifications include the replacement of a network option from "drunemeton-1" to "dentrite-1" in the issue template, updates to Docker image references in workflow files, the addition of new documentation for the "dentrite-1" network, and the introduction of a new version number in the version file. These changes collectively reflect updates in network options and documentation for validator registration.

Changes

Files Change Summary
.github/ISSUE_TEMPLATE/register-validator.yml Updated network option from drunemeton-1 to dentrite-1.
.github/workflows/lint.yml, .github/workflows/test.yml Changed Docker image reference from axone-protocol/axoned to axoneprotocol/axoned.
README.md Added entry for the new dentrite-1 network with documentation link.
chains/dentrite-1/README.md Introduced documentation for registering validator nodes, including steps for creating a gentx.
chains/dentrite-1/README.md.gtpl Created a template for generating genesis configuration documentation with dynamic placeholders.
chains/dentrite-1/version.txt Updated version number to 10.0.0.

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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@amimart amimart marked this pull request as ready for review August 29, 2024 10:14
Copy link

@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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c2b6b62 and d2cb263.

Files ignored due to path filters (2)
  • chains/dentrite-1/genesis.json is excluded by !**/*.json
  • chains/dentrite-1/register-config.json is excluded by !**/*.json
Files selected for processing (7)
  • .github/ISSUE_TEMPLATE/register-validator.yml (1 hunks)
  • .github/workflows/lint.yml (1 hunks)
  • .github/workflows/test.yml (2 hunks)
  • README.md (1 hunks)
  • chains/dentrite-1/README.md (1 hunks)
  • chains/dentrite-1/README.md.gtpl (1 hunks)
  • chains/dentrite-1/version.txt (1 hunks)
Files skipped from review due to trivial changes (3)
  • .github/ISSUE_TEMPLATE/register-validator.yml
  • README.md
  • chains/dentrite-1/version.txt
Additional context used
LanguageTool
chains/dentrite-1/README.md

[style] ~4-~4: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1312 characters long)
Context: ...--dentrite--1-blue?style=for-the-badge) stability-beta audience ![incentivized-✖️](https://img.shields.io...

(EN_EXCESSIVE_EXCLAMATION)

actionlint
.github/workflows/test.yml

95-95: shellcheck reported issue in this script: SC2086:info:1:53: Double quote to prevent globbing and word splitting

(shellcheck)


95-95: shellcheck reported issue in this script: SC2046:warning:1:130: Quote this to prevent word splitting

(shellcheck)


95-95: shellcheck reported issue in this script: SC2006:style:1:130: Use $(...) notation instead of legacy backticks ...

(shellcheck)

Additional comments not posted (13)
chains/dentrite-1/README.md (4)

1-8: LGTM!

The header and badges section is informative and well-structured.

Tools
LanguageTool

[style] ~4-~4: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1312 characters long)
Context: ...--dentrite--1-blue?style=for-the-badge) stability-beta audience ![incentivized-✖️](https://img.shields.io...

(EN_EXCESSIVE_EXCLAMATION)


10-25: LGTM!

The "Register in the Genesis" section provides clear and comprehensive instructions for registering a validator node.


27-42: LGTM!

The "Create the gentx" section provides a well-documented script with all necessary parameters for creating a gentx.


Line range hint 44-71: LGTM!

The "Genesis validators" section provides a well-structured table with comprehensive information about the genesis validators.

Tools
LanguageTool

[style] ~4-~4: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1312 characters long)
Context: ...--dentrite--1-blue?style=for-the-badge) stability-beta audience ![incentivized-✖️](https://img.shields.io...

(EN_EXCESSIVE_EXCLAMATION)

.github/workflows/lint.yml (1)

119-119: LGTM! But verify the new Docker image reference.

The change in the Docker image reference might reflect a rebranding or restructuring of the Docker image repository. Ensure that the new Docker image reference is correct and accessible.

Run the following script to verify the new Docker image reference:

chains/dentrite-1/README.md.gtpl (4)

1-8: LGTM!

The header and badges section is informative and well-structured.


10-25: LGTM!

The "Register in the Genesis" section provides clear and comprehensive instructions for registering a validator node.


27-42: LGTM!

The "Create the gentx" section provides a well-documented script with all necessary parameters for creating a gentx.


44-71: LGTM!

The "Genesis validators" section provides a well-structured table with comprehensive information about the genesis validators.

.github/workflows/test.yml (4)

69-69: LGTM!

The Docker image name update is correct and ensures the correct Docker image is used.


79-79: LGTM!

The Docker image name update is correct and ensures the correct Docker image is used.


84-84: LGTM!

The Docker image name update is correct and ensures the correct Docker image is used.


90-90: LGTM!

The Docker image name update is correct and ensures the correct Docker image is used.

genesis collect-gentxs \
--home /.axoned

- name: Start the blockchain
run: |
docker run --network host --rm --name axone-node -v ${GITHUB_WORKSPACE}/${{ matrix.context.path }}:/.axoned axone-protocol/axoned:`cat ./chains/${{ matrix.context.network }}/version.txt` \
docker run --network host --rm --name axone-node -v ${GITHUB_WORKSPACE}/${{ matrix.context.path }}:/.axoned axoneprotocol/axoned:`cat ./chains/${{ matrix.context.network }}/version.txt` \
Copy link

Choose a reason for hiding this comment

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

LGTM! But fix the flagged issues.

The Docker image name update is correct and ensures the correct Docker image is used. However, the static analysis tools have flagged issues related to quoting and use of backticks.

Apply this diff to fix the flagged issues:

-          docker run --network host --rm --name axone-node -v ${GITHUB_WORKSPACE}/${{ matrix.context.path }}:/.axoned axoneprotocol/axoned:`cat ./chains/${{ matrix.context.network }}/version.txt` \
+          docker run --network host --rm --name axone-node -v "${GITHUB_WORKSPACE}/${{ matrix.context.path }}":/.axoned axoneprotocol/axoned:$(cat ./chains/${{ matrix.context.network }}/version.txt) \
              start \
              --home /.axoned \
              --moniker axone-node &
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
docker run --network host --rm --name axone-node -v ${GITHUB_WORKSPACE}/${{ matrix.context.path }}:/.axoned axoneprotocol/axoned:`cat ./chains/${{ matrix.context.network }}/version.txt` \
docker run --network host --rm --name axone-node -v "${GITHUB_WORKSPACE}/${{ matrix.context.path }}":/.axoned axoneprotocol/axoned:$(cat ./chains/${{ matrix.context.network }}/version.txt) \
start \
--home /.axoned \
--moniker axone-node &

Copy link
Contributor

@bdeneux bdeneux left a comment

Choose a reason for hiding this comment

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

🚀

@amimart amimart merged commit c0763d0 into main Aug 29, 2024
9 of 10 checks passed
@amimart amimart deleted the feat/dentrite branch August 29, 2024 10:20
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.

2 participants