Part of Stem. This page defines the SyncStatus method of the sync RPC specification. Clients use it to show progress and the held version.
The formal schema is attached as the schemaDefinition of this page: a struct {key, input, output} with key pinned to SyncStatus.
Reports the state of syncing for a scope without starting a run.
Input
field | type | required | meaning |
|---|---|---|---|
| yes | The scope. |
Output
The output is rpc/type/sync-status.
Rules
Returns the last known status for the scope. A scope that has never been synced returns idle with a null version and null last run.
Never contacts a peer and never changes hotness.
Today (HM24)
HM24's DiscoverEntity answers with a progress struct but also touches the task; the web DiscoveryStatus key likewise nudges a run on every call. Stem separates the read from the trigger.
Example
{"key": "SyncStatus", "input": {"scope": {"space": {"/": {"bytes": "7QEA…"}}, "node": "bafyrein6a6wfhym6l3vfz5zfkkibj5j6wjibagi3mnbqnspuq2idw52ijb", "depth": "subtree"}}}{"scope": {"space": {"/": {"bytes": "7QEA…"}}, "node": "bafyrein6a6wfhym6l3vfz5zfkkibj5j6wjibagi3mnbqnspuq2idw52ijb", "depth": "subtree"}, "state": "running", "version": "bafy…13", "lastRun": 1759910470000, "peersAsked": 3, "peersOk": 1, "blobsWanted": 40, "blobsReceived": 12, "error": null}See also
Do you like what you are reading? Subscribe to receive updates.
Unsubscribe anytime