Interface IAuthoredDataSyncStore

Interface that a data store needs to implement to manage blobs by their hashes.

interface IAuthoredDataSyncStore {
    get(hash: Hash, author: string): IStoredBlob | undefined;
    getByAuthorBefore(author: string, before: number): IStoredBlob[];
    getByAuthorSince(author: string, since: number): IStoredBlob[];
    getLastKnownByAuthor(author: string): IStoredBlob | undefined;
    put(hash: Hash, blob: Blob, author: string, authoredAt: number): void;
}

Implemented by

MemoryBlobStore

Index

Methods

get getByAuthorBefore getByAuthorSince getLastKnownByAuthor put

Methods

get

get(hash: Hash, author: string): IStoredBlob | undefined
Get a blob by its hash and author.
Parameters
- hash: Hash
  The blob's hash
- author: string
  Author of the blob
Returns IStoredBlob | undefined
- Defined in authored-data-sync/store.ts:50

getByAuthorBefore

getByAuthorBefore(author: string, before: number): IStoredBlob[]
Blobs by author with authoredAt < before, ascending by authoredAt. (historical segment)
Parameters
- author: string
- before: number
Returns IStoredBlob[]
- Defined in authored-data-sync/store.ts:68

getByAuthorSince

getByAuthorSince(author: string, since: number): IStoredBlob[]
Blobs by author with authoredAt >= since, ascending by authoredAt. (recent delta)
Parameters
- author: string
- since: number
Returns IStoredBlob[]
- Defined in authored-data-sync/store.ts:62

getLastKnownByAuthor

getLastKnownByAuthor(author: string): IStoredBlob | undefined
The author's most recently authored blob this node holds (max authoredAt), or undefined if none is held.
Parameters
- author: string
Returns IStoredBlob | undefined
- Defined in authored-data-sync/store.ts:56

put

put(hash: Hash, blob: Blob, author: string, authoredAt: number): void
Put a blob by an author into the store. Blob bytes are content-deduped by hash (written only once). Each (author, hash) association is recorded independently, so the same bytes can be authored by multiple agents.
Parameters
- hash: Hash
  The blob's hash
- blob: Blob
  The blob
- author: string
  Author of the blob
- authoredAt: number
  Author-assigned timestamp of the blob
Returns void
- Defined in authored-data-sync/store.ts:42