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: RPC test snapshot #5144

Merged
merged 5 commits into from
Jan 17, 2025
Merged

docs: RPC test snapshot #5144

merged 5 commits into from
Jan 17, 2025

Conversation

hanabi1224
Copy link
Contributor

@hanabi1224 hanabi1224 commented Jan 15, 2025

Summary of changes

Changes introduced in this pull request:

  • developer documents on how RPC test snapshots can be generated and used

Reference issue to close (if applicable)

Closes #5126

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

@hanabi1224 hanabi1224 force-pushed the hm/rpc-snapshot-docs branch from 630f3b6 to 016107d Compare January 15, 2025 13:41
@hanabi1224 hanabi1224 marked this pull request as ready for review January 15, 2025 13:44
@hanabi1224 hanabi1224 requested a review from a team as a code owner January 15, 2025 13:44
@hanabi1224 hanabi1224 requested review from lemmih and LesnyRumcajs and removed request for a team January 15, 2025 13:44
Comment on lines 10 to 12
An RPC test dump contains the name of the RPC method, the request payload, and the response of an RPC call. It is used to dump a minimal database snapshot and replay the request in a subsequent process.

To generate test dumps, add `--dump-dir [PATH]` to `forest-tool api compare` command. e.g., `forest-tool api compare forest_snapshot_calibnet_2025-01-15_height_2320334.forest.car.zst --dump-dir /var/tmp/rpc-dump`
Copy link
Member

Choose a reason for hiding this comment

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

Let's note that a running instance of Forest and Lotus are required, the latter requiring some environmental variables set (refer to docker compose file).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@LesnyRumcajs please re-approve if the change look good, thanks!

@hanabi1224 hanabi1224 force-pushed the hm/rpc-snapshot-docs branch from 8265d9d to 2cb8e9b Compare January 16, 2025 23:37
@hanabi1224 hanabi1224 enabled auto-merge January 16, 2025 23:38
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@hanabi1224 hanabi1224 added this pull request to the merge queue Jan 17, 2025
Merged via the queue into main with commit 80c5002 Jan 17, 2025
16 checks passed
@hanabi1224 hanabi1224 deleted the hm/rpc-snapshot-docs branch January 17, 2025 16:15
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.

Doc page on generating RPC test snapshots
3 participants