Translate plugin sync api into protobuf definitions and document them
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 493
- PR merge metrics
- No merged PRs in 30d
Description
plugin api for the sync process. this api must be attached during sync. it assumes the plugin is staying in sync with the chain. it cannot catch up once the hub is running. that can be a separate api to be defined later
- subscribe to zmq
- read messages
- each message is a protobuf
- structure:
- block hash: bytes
- block height: int
- prev block hash: bytes (may need this because zmq messages can arrive out of order)
- upserted: a list of Claim protobufs
- deleted: a list of claim ids
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 by locating the plugin sync API and the existing Claim protobuf definitions. Define the sync message structure described in the issue, including block metadata, upserted claims, and deleted claim IDs, then document the subscription and ordering assumptions. Done means the protobuf definitions and API documentation cover live sync without catch-up support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, blockchain, distributed-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100