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

Methods

get init pullFromAllPeers pullFromPeer start stop store

Constructors

constructor

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

Methods

get

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

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-sync.ts:62

pullFromAllPeers

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

Returns Promise<void>
- Defined in authored-data-sync.ts:117

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-sync.ts:172

start

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

stop

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

store

store(blob: Blob): Uint8Array<ArrayBufferLike> & Uint8Array<ArrayBuffer>
Hash the blob, store it under ownAgentId, and return the hash.
Parameters
- blob: Blob
  The blob to store
Returns Uint8Array<ArrayBufferLike> & Uint8Array<ArrayBuffer>
- Defined in authored-data-sync.ts:85