Externalize RPC snapshot testing

Open
#5,705 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust

Research direction

Start with the existing Forest RPC snapshot testing guide linked in the issue and review how the current snapshots are stored and consumed. Done means the suite is external to Forest, snapshots are publicly available with community uploads, they can be easily verified or explored, and node implementations can use them for RPC regression tests.

Written by the indexing model from the issue text.

Description

Implementers came to the conclusion that the best way to ensure API conformance would be to re-use existing Forest RPC snapshots testing.

Requirements:

  • the RPC snapshot testing suite lives outside of Forest for clear separation and ease of contributing,
  • Snapshots are publicly available and everyone can upload them (right now they are stored on ChainSafe's Digital Ocean bucket).
  • Snapshots should also be easily verifiable. We might want to have some web RPC snapshot file explorer.

Node implementations will use the above for RPC regression tests.

Dominant language
Rust
Stars
700
Forks
201
Avg merge
1d 17h
Merged PRs (30d)
65

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ChainSafe/forest

All issues in ChainSafe/forest

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.