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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: RPC test snapshot #5144

wants to merge 3 commits into from

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

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