Skip to content

nooschain v0.1.0


nooschain / node-sync/chain-sync / SyncFromPeerOptions

Interface: SyncFromPeerOptions

Defined in: node-sync/chain-sync.ts:49

Options controlling one HTTP sync attempt against one peer.

Properties

canonicalDb

canonicalDb: Kysely<Database>

Defined in: node-sync/chain-sync.ts:51

Canonical local database where remote committed blocks are applied.


conflictPolicy?

optional conflictPolicy?: ChainConflictPolicy

Defined in: node-sync/chain-sync.ts:65

Fork/conflict policy used when remote finalized history diverges.


executionInstrumentation?

optional executionInstrumentation?: object

Defined in: node-sync/chain-sync.ts:71

Optional instrumentation for deterministic block execution during sync.

observeTiming()

observeTiming(name, durationMs): void

Parameters
name

string

durationMs

number

Returns

void

observeValue()?

optional observeValue(name, value): void

Parameters
name

string

value

number

Returns

void


force?

optional force?: boolean

Defined in: node-sync/chain-sync.ts:67

Allows sync to run while incident mode is active for explicit operator recovery.


localNodeId?

optional localNodeId?: string

Defined in: node-sync/chain-sync.ts:59

Local node id used to decide whether synced records should retain ciphertext.


localNodePrivateKey?

optional localNodePrivateKey?: string

Defined in: node-sync/chain-sync.ts:63

Optional local node private key used to sign sync-time placement and payload backfill proofs.


logger?

optional logger?: OperationalLogger

Defined in: node-sync/chain-sync.ts:69

Optional structured logger for sync and backfill progress.


maxBlocksPerBatch?

optional maxBlocksPerBatch?: number

Defined in: node-sync/chain-sync.ts:55

Maximum number of blocks requested from the peer in one HTTP batch.


membershipCredential?

optional membershipCredential?: object

Defined in: node-sync/chain-sync.ts:61

Optional local membership credential used for sync-time placement and payload backfill proofs.

credentialId?

optional credentialId?: string

expiresAt

expiresAt: string = isoDateSchema

issuedAt

issuedAt: string = isoDateSchema

issuer

issuer: string

nodeId

nodeId: string

nodePublicKey

nodePublicKey: string

organizationId

organizationId: string

permissions

permissions: ("replicate" | "serve_payloads")[]

signature

signature: string


onProgress?

optional onProgress?: (event) => void | Promise<void>

Defined in: node-sync/chain-sync.ts:73

Optional progress callback used by tests, soak harnesses, and debug logs.

Parameters

event

ChainSyncProgressEvent

Returns

void | Promise<void>


peer

peer: SyncPeer

Defined in: node-sync/chain-sync.ts:53

Trusted remote peer used for head, block, and optional payload fetches.


stopOnError?

optional stopOnError?: boolean

Defined in: node-sync/chain-sync.ts:57

Reserved compatibility flag for callers that want fail-fast behavior.

Audience-first NOOSChain documentation.