Class AuthoredDataSync

Contract for a module that can be attached to a IPeerkitNode

The node calls init() when registering the module, then start() to begin activity. stop() terminates activity gracefully on shutdown.

Implements

INodeModule

Index

Constructors

Accessors

Methods

get init pullFromAllPeers pullFromPeer start stop store

Constructors

constructor

new AuthoredDataSync(
    dataSyncStore: IAuthoredDataSyncStore,
    strategy: IDataDistributionPolicy,
    pullIntervalMs: number,
    epochDurationMs?: number,
    pullTimeoutMs?: number,
): AuthoredDataSync
Parameters
- dataSyncStore: IAuthoredDataSyncStore
- strategy: IDataDistributionPolicy
- pullIntervalMs: number
- OptionalepochDurationMs: number
- OptionalpullTimeoutMs: number
Returns AuthoredDataSync
- Defined in authored-data-pull.ts:37

Accessors

epochDuration

get epochDuration(): number
The epoch in milliseconds

Blobs authored between now and the epoch threshold are recent. Blobs authored before the epoch threshold are historical.

Returns number
- Defined in authored-data-pull.ts:58

Methods

get

get(hash: Hash, author: string): StoredBlob | undefined
Get a stored blob by its hash and author
Parameters
- hash: Hash
- author: string
Returns StoredBlob | undefined
- Defined in authored-data-pull.ts:89

init

init(core: IPeerkitNode): void
Called by the node immediately after registration to wire up the module.
Parameters
- core: IPeerkitNode
Returns void
Implementation of INodeModule.init
- Defined in authored-data-pull.ts:62

pullFromAllPeers

pullFromAllPeers(): Promise<void>
Run one pull round with every currently connected peer, in sequence.

Returns Promise<void>
- Defined in authored-data-pull.ts:96

pullFromPeer

pullFromPeer(remoteAgentId: string): Promise<void>
Request all authored blobs from the peer that this node does not yet hold.

Requester side of the pull. See package docs for the full protocol sequence.
Parameters
- remoteAgentId: string
Returns Promise<void>
- Defined in authored-data-pull.ts:151

start

start(): Promise<void>
Returns Promise<void>
Implementation of INodeModule.start
- Defined in authored-data-pull.ts:111

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of INodeModule.stop
- Defined in authored-data-pull.ts:136

store

store(blob: Blob): Hash
Author a blob: store it under ownAgentId via the store (which owns hashing and the authoring clock) and return its hash.
Parameters
- blob: Blob
  The blob to store
Returns Hash
- Defined in authored-data-pull.ts:82