onflow / onflow/docs

[DataAvailability] Document Access API streaming fork recovery protocol

Open
#1,378 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Document the process clients should use when streaming execution state data for unsealed blocks. This includes the recovery process when a fork is detected.

Contributor guide

Open the contributing guide

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.

Research direction

Locate the existing DataAvailability and Access API documentation covering streaming execution state data for unsealed blocks. Read the surrounding guidance and confirm the client steps for detecting and recovering from a fork. Done means the streaming process and fork-recovery protocol are documented clearly for clients.

Written by the indexing model from the issue text.

Assessment

Domain
api, blockchain, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.