Sync status
Progress and outcome of syncing one scope.
Fetching schema…

Part of Stem. This page defines the rpc/type/sync-status message type used by the sync RPC specification. Sync and SyncStatus return it.

The formal schema is attached as the schemaDefinition of this page.

Progress and outcome of syncing one scope.

Fields

field

type

required

meaning

scope

data/scope

yes

The scope.

state

one of "idle", "running", "done", "failed"

yes

State of the latest run.

version

data/version or null

yes

The version of the scope's node this peer holds, or null.

lastRun

timestamp or null

yes

When the last run finished.

peersAsked

integer

yes

Peers contacted in the last run.

peersOk

integer

yes

Peers that answered.

blobsWanted

integer

yes

Blobs the run learned it lacked.

blobsReceived

integer

yes

Blobs received so far.

error

string or null

yes

Last error, or null.

Rules

    version is the version of the scope's node as held locally, whatever the run's state.

    Counts are for the latest run only.

    error is a human-readable string for display and is not part of the protocol's error enum.

Today (HM24)

HM24's DiscoverEntityResponse carries state, version, timing and a progress struct with peers found, synced and failed and blobs discovered, downloaded and failed. The fields are renamed and typed.

Example

{"scope": {"space": {"/": {"bytes": "7QEA…"}}, "node": "bafyrein6a6wfhym6l3vfz5zfkkibj5j6wjibagi3mnbqnspuq2idw52ijb", "depth": "subtree"}, "state": "done", "version": "bafy…13", "lastRun": 1759910470000, "peersAsked": 2, "peersOk": 2, "blobsWanted": 2, "blobsReceived": 2, "error": null}

Do you like what you are reading? Subscribe to receive updates.

Unsubscribe anytime