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

chore: change snapshots API on contrib/localnet/scripts to consume state exports #2819

Merged
merged 4 commits into from
Sep 4, 2024

Conversation

julianrubino
Copy link
Member

@julianrubino julianrubino commented Sep 3, 2024

Description

We have recently changed the API that serves state exports.

  • Updated code to consume exports from new API.

How Has This Been Tested?

This change wasn't tested yet.

  • Tested CCTX in localnet
  • [] Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Summary by CodeRabbit

  • Bug Fixes

    • Improved the data retrieval process for the latest state export, ensuring more reliable access to the necessary information.
  • Chores

    • Updated the script to utilize a new endpoint for fetching the state export URL, enhancing the overall data management process.

Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The import-data.sh script has been modified to change the method of retrieving the latest state export URL. The new implementation fetches the URL from https://snapshots.rpc.zetachain.com/${NETWORK}/state/latest.json, replacing the previous endpoint. Additionally, the JSON parsing logic has been updated to navigate through a snapshots array to extract the link, altering the control flow for data retrieval.

Changes

Files Change Summary
contrib/localnet/scripts/import-data.sh Updated URL retrieval method for the latest state export and modified JSON parsing logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant API

    User->>Script: Request data import
    Script->>API: Fetch latest state export URL from new endpoint
    API-->>Script: Return JSON with snapshots array
    Script->>Script: Parse JSON to extract URL from snapshots
    Script->>API: Download data from extracted URL
    API-->>Script: Return data
    Script-->>User: Data import complete
Loading

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.

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.

@gartnera gartnera added no-changelog Skip changelog CI check UPGRADE_IMPORT_MAINNET_TESTS Run make start-upgrade-import-mainnet-test labels Sep 3, 2024
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: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 74f1ab5 and 12fabf1.

Files selected for processing (1)
  • contrib/localnet/scripts/import-data.sh (1 hunks)
Additional context used
Path-based instructions (1)
contrib/localnet/scripts/import-data.sh (1)

Pattern **/*.sh: Review the shell scripts, point out issues relative to security, performance, and maintainability.

@julianrubino julianrubino added this pull request to the merge queue Sep 4, 2024
Merged via the queue into develop with commit ebeedfc Sep 4, 2024
30 checks passed
@julianrubino julianrubino deleted the 2723-change-snapshots-api branch September 4, 2024 15:40
gartnera pushed a commit that referenced this pull request Sep 10, 2024
…ate exports (#2819)

* Refactor contrib/rpc and contrib/docker-scripts to use snapshots API

* Replace Snapshot API on localnet scripts for consuming state exports

---------

Co-authored-by: Julian Rubino <julian@zetachain.com>
gartnera pushed a commit that referenced this pull request Sep 10, 2024
…ate exports (#2819)

* Refactor contrib/rpc and contrib/docker-scripts to use snapshots API

* Replace Snapshot API on localnet scripts for consuming state exports

---------

Co-authored-by: Julian Rubino <julian@zetachain.com>
@lumtis lumtis mentioned this pull request Sep 9, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip changelog CI check UPGRADE_IMPORT_MAINNET_TESTS Run make start-upgrade-import-mainnet-test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants