nooschain / chain/state-root-engines/persistent-state-root-sidecar / PersistentStateRootSidecar
Class: PersistentStateRootSidecar
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:126
Long-running sidecar process wrapper for restart/checkpoint benchmarks.
Constructors
Constructor
new PersistentStateRootSidecar(
config):PersistentStateRootSidecar
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:148
Parameters
config
PersistentStateRootSidecarConfig
Returns
PersistentStateRootSidecar
Methods
applyBatch()
applyBatch(
mutations):Promise<string>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:304
Applies one ordered batch of state-root mutations and returns the new root.
Parameters
mutations
Returns
Promise<string>
exportCheckpoint()
exportCheckpoint(
path):Promise<string>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:316
Exports a checkpoint file from the sidecar's current in-memory state.
Parameters
path
string
Returns
Promise<string>
generateProof()
generateProof(
stateKey):Promise<NervosStateProofDocument>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:328
Requests a compiled Nervos proof for one canonical NOOSChain state key.
Parameters
stateKey
string
Returns
Promise<NervosStateProofDocument>
getRoot()
getRoot():
Promise<string>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:310
Reads the current sidecar root.
Returns
Promise<string>
getStatus()
getStatus():
PersistentStateRootSidecarStatus
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:247
Returns current process supervision metadata without exposing secrets.
Returns
PersistentStateRootSidecarStatus
health()
health():
Promise<PersistentStateRootSidecarHealth>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:288
Reads sidecar liveness, initialization, root, and leaf-count state.
Returns
Promise<PersistentStateRootSidecarHealth>
init()
init(
chainId):Promise<string>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:275
Initializes an empty sidecar tree for one chain id.
Parameters
chainId
string
Returns
Promise<string>
killForTest()
killForTest():
void
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:239
Terminates the sidecar without asking it to flush or shut down cleanly.
This method is intentionally exposed for benchmark and crash-safety tests. Production integration should treat process death as a degraded condition and recover from the last verified checkpoint rather than relying on this helper.
Returns
void
loadCheckpoint()
loadCheckpoint(
path):Promise<string>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:322
Loads a checkpoint file and returns the restored root.
Parameters
path
string
Returns
Promise<string>
start()
start():
Promise<void>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:151
Starts the sidecar process and wires stdout responses to pending requests.
Returns
Promise<void>
stop()
stop():
Promise<void>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:202
Gracefully stops the sidecar, killing it if the shutdown request fails.
Returns
Promise<void>
verifyProof()
verifyProof(
args):Promise<boolean>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:337
Verifies a compiled Nervos proof against a supplied root and value hash.
Parameters
args
proof
root
string
stateKey
string
valueHash
string
Returns
Promise<boolean>
version()
version():
Promise<PersistentStateRootSidecarVersion>
Defined in: chain/state-root-engines/persistent-state-root-sidecar.ts:281
Reads the sidecar protocol and state-root engine version.
Returns
Promise<PersistentStateRootSidecarVersion>