[Access] Add new gRPC subscription documentation and deprecate old implementation.
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Based on comment from WebSocket documentation PR, the gRPC documentation for subscriptions should also be updated. The old implementation should be marked as deprecated.
Add:
- SubscribeBlocksFromStartBlockID
- SubscribeBlocksFromStartHeight
- SubscribeBlocksFromLatest
- SubscribeBlockHeadersFromStartBlockID
- SubscribeBlockHeadersFromStartHeight
- SubscribeBlockHeadersFromLatest
- SubscribeBlockDigestsFromStartBlockID
- SubscribeBlockDigestsFromLatest
- SubscribeTransactionStatuses
- SendAndSubscribeTransactionStatuses
- SubscribeExecutionDataFromStartBlockID
- SubscribeExecutionDataFromStartBlockHeight
- SubscribeExecutionDataFromLatest
- SubscribeEventsFromStartBlockID
- SubscribeEventsFromStartHeight
- SubscribeEventsFromLatest
- SubscribeAccountStatusesFromStartBlockID
- SubscribeAccountStatusesFromStartHeight
- SubscribeAccountStatusesFromLatestBlock
Deprecate:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the subscriptions section at developers.flow.com/networks/access-onchain-data and review the linked WebSocket documentation PR comment for context. Document each listed subscription method and mark SubscribeEvents and SubscribeExecutionData as deprecated. Done means the new gRPC methods are covered and the old implementation is clearly labeled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grpc
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100