Class LogBackedStore

Hierarchy (View Summary)

LockableLog
- LogBackedStore

Implements

Store

Constructors

constructor

new LogBackedStore(
    filename: string,
    exclusive?: boolean,
    internalStore?: MemoryStore,
): LogBackedStore
Parameters
- filename: string
  file to store transactions and chain ownership information
- exclusive: boolean = false
  if true, lock the file until closing store, otherwise only lock as-needed.
- internalStore: MemoryStore = ...
Returns LogBackedStore
Overrides LockableLog.constructor
- Defined in implementation/LogBackedStore.ts:70

Properties

`Readonly`exclusive

exclusive: boolean = false

if true, lock the file until closing store, otherwise only lock as-needed.

`Protected`fileHandle

fileHandle: FileHandle

`Protected`fileLocked

fileLocked: boolean = false

`Readonly`filename

filename: string

file to store transactions and chain ownership information

Accessors

ready

get ready(): Promise<void>
Can be awaited on for the underlying store to be ready for operations. Methods of the store should await on this, so if initialization fails then no other method will work either.

Returns Promise<void>
Implementation of Store.ready
Overrides LockableLog.ready
- Defined in implementation/LogBackedStore.ts:81

Methods

acquireChain

acquireChain(identity: string): Promise<BundleInfo>
Tries to see if there's a free chain available with the given identity that's not currently being used by another processes, and if so, adds a claim to it and returns the final link of that chain.
Parameters
- identity: string
Returns Promise<BundleInfo>
Implementation of Store.acquireChain
- Defined in implementation/LogBackedStore.ts:321

addBundle

addBundle(bundle: BundleView, claimChain?: boolean): Promise<Boolean>
Tries to add a bundle to this store; returns truthy if actually added, false if not (e.g. if already has it). Will throw if passed a bundle without the proceeding ones in the associated chain.

Optionally can reuse/start a new chain.

Implicitly awaits on this.ready;
Parameters
- bundle: BundleView
- OptionalclaimChain: boolean
Returns Promise<Boolean>
Implementation of Store.addBundle
- Defined in implementation/LogBackedStore.ts:277

addFoundBundleCallBack

addFoundBundleCallBack(callback: BroadcastFunc): void
Add a callback if you want another function to run when a new bundle is pulled from the log file.
Parameters
- callback: BroadcastFunc
  a function to be called when a new bundle has been received from the log file. It needs to take one argument, bundleInfo
Returns void
Implementation of Store.addFoundBundleCallBack
- Defined in implementation/LogBackedStore.ts:449

close

close(): Promise<void>
Closes the underlying data store. Implicitly awaits on the this.ready promise.

Returns Promise<void>
Implementation of Store.close
- Defined in implementation/LogBackedStore.ts:161

getAllContainerTuples

getAllContainerTuples(): Promise<MuidTuple[]>
Get every container in the store.

Returns Promise<MuidTuple[]>
Implementation of Store.getAllContainerTuples
- Defined in implementation/LogBackedStore.ts:437

getAllEntries

getAllEntries(): Promise<Entry[]>
Returns Promise<Entry[]>
- Defined in implementation/LogBackedStore.ts:425

getBillionths

getBillionths(muid: Muid, asOf?: AsOf): Promise<bigint>
Parameters
- muid: Muid
- OptionalasOf: AsOf
Returns Promise<bigint>
Implementation of Store.getBillionths
- Defined in implementation/LogBackedStore.ts:85

getBundles

getBundles(callBack: (bundle: BundleView) => void): Promise<void>
Get all bundles from a store ordered by [timestamp, medallion]. Intended to be used to send to a peer.

The callback should NOT await on anything (will cause problems with the IndexedDb implementation if you do). See https://github.com/google/gink/issues/28

Implicitly awaits on this.ready;
Parameters
- callBack: (bundle: BundleView) => void
Returns Promise<void>
Implementation of Store.getBundles
- Defined in implementation/LogBackedStore.ts:385

getBundlesProcessed

getBundlesProcessed(): Promise<number>
Returns Promise<number>
- Defined in implementation/LogBackedStore.ts:265

getChainIdentity

getChainIdentity(chainInfo: [number, number]): Promise<string>
Attempts to get the identity of the user who started the chain.
Parameters
- chainInfo: [number, number]
  [Medallion, ChainStart]
Returns Promise<string>
a string of the identity of the user who started the chain.
Implementation of Store.getChainIdentity
- Defined in implementation/LogBackedStore.ts:371

getChainTracker

getChainTracker(): Promise<ChainTracker>
Generates a ChainTracker describing how much of each chain this store has.

Implicitly awaits on this.ready;

Returns Promise<ChainTracker>
Implementation of Store.getChainTracker
- Defined in implementation/LogBackedStore.ts:379

getContainerBytes

getContainerBytes(address: Muid): Promise<Bytes>
Gets the protobuf bytes corresponding to a particular container's address.
Parameters
- address: Muid
Returns Promise<Bytes>
Implementation of Store.getContainerBytes
- Defined in implementation/LogBackedStore.ts:391

getContainerProperties

getContainerProperties(
containerMuid: Muid,
asOf?: AsOf,
): Promise<Map<string, Value>>
Get the properties corresponding to a container.
Parameters
- containerMuid: Muid
  the Muid of the container to get the properties of
- OptionalasOf: AsOf
  optional timestamp to look back to
Returns Promise<Map<string, Value>>
a Map of string Muid (of the Property Container) to Value
Implementation of Store.getContainerProperties
- Defined in implementation/LogBackedStore.ts:233

getContainersByName

getContainersByName(name: string, asOf?: AsOf): Promise<Muid[]>
Returns an Array of all containers matching the provided name. Names are set using the global property.
Parameters
- name: string
- OptionalasOf: AsOf
  optional timestamp to look back to
Returns Promise<Muid[]>
Implementation of Store.getContainersByName
- Defined in implementation/LogBackedStore.ts:431

getEntriesBySourceOrTarget

getEntriesBySourceOrTarget(
    vertex: Muid,
    source: boolean,
    asOf?: AsOf,
): Promise<Entry[]>
Parameters
- vertex: Muid
- source: boolean
- OptionalasOf: AsOf
Returns Promise<Entry[]>
Implementation of Store.getEntriesBySourceOrTarget
- Defined in implementation/LogBackedStore.ts:251

getEntryById

getEntryById(entryMuid: Muid, asOf?: AsOf): Promise<Entry>
Parameters
- entryMuid: Muid
- OptionalasOf: AsOf
Returns Promise<Entry>
Implementation of Store.getEntryById
- Defined in implementation/LogBackedStore.ts:416

getEntryByKey

getEntryByKey(container?: Muid, key?: ScalarKey, asOf?: AsOf): Promise<Entry>
Parameters
- Optionalcontainer: Muid
- Optionalkey: ScalarKey
- OptionalasOf: AsOf
Returns Promise<Entry>
Implementation of Store.getEntryByKey
- Defined in implementation/LogBackedStore.ts:397

`Protected`getFileLength

getFileLength(): Promise<number>
Returns Promise<number>
Inherited from LockableLog.getFileLength
- Defined in implementation/LockableFile.ts:54

getKeyedEntries

getKeyedEntries(container: Muid, asOf?: AsOf): Promise<Map<string, Entry>>
Parameters
- container: Muid
- OptionalasOf: AsOf
Returns Promise<Map<string, Entry>>
Implementation of Store.getKeyedEntries
- Defined in implementation/LogBackedStore.ts:407

getLocation

getLocation(entry: Muid, asOf?: AsOf): Promise<Placement>
In ordered container types (Sequence and EdgeType), entries may be moved around. This method returns information about the current effective time, which may be different from the timestamp of the entry itself.
Parameters
- entry: Muid
  the muid of the entry
- OptionalasOf: AsOf
  optional timestamp to look back to
Returns Promise<Placement>
an object with the container muid, key, and the placement id.
Implementation of Store.getLocation
- Defined in implementation/LogBackedStore.ts:271

getLogContents

getLogContents(start?: number, finish?: number): Promise<LogFileBuilder>
Parameters
- start: number = 0
- Optionalfinish: number
Returns Promise<LogFileBuilder>
Inherited from LockableLog.getLogContents
- Defined in implementation/LockableLog.ts:26

getOrderedEntries

getOrderedEntries(
    container: Muid,
    through?: number,
    asOf?: AsOf,
): Promise<Map<string, Entry>>
returns a map where the entries were inserted in the desired order, and the keys correspond to ,.
Parameters
- container: Muid
- through: number = Infinity
- OptionalasOf: AsOf
Returns Promise<Map<string, Entry>>
Implementation of Store.getOrderedEntries
- Defined in implementation/LogBackedStore.ts:241

getSymmetricKey

getSymmetricKey(keyId: number): Promise<Bytes>
Retrieves a previously stored symmetric key.
Parameters
- keyId: number
  the id of the symmetric key to retrieve
Returns Promise<Bytes>
Implementation of Store.getSymmetricKey
- Defined in implementation/LogBackedStore.ts:122

getVerifyKey

getVerifyKey(chainInfo: [number, number]): Promise<Bytes>
Attempt to get the verify key for a particular chain (stored with the first bundle).
Parameters
- chainInfo: [number, number]
Returns Promise<Bytes>
Implementation of Store.getVerifyKey
- Defined in implementation/LogBackedStore.ts:90

`Protected`lockFile

lockFile(block: boolean): Promise<boolean>
Parameters
- block: boolean
Returns Promise<boolean>
Inherited from LockableLog.lockFile
- Defined in implementation/LockableFile.ts:28

pullKeyPair

pullKeyPair(publicKey: Bytes): Promise<KeyPair>
Parameters
- publicKey: Bytes
Returns Promise<KeyPair>
Implementation of Store.pullKeyPair
- Defined in implementation/LogBackedStore.ts:114

saveKeyPair

saveKeyPair(keyPair: KeyPair): Promise<void>
Parameters
- keyPair: KeyPair
Returns Promise<void>
Implementation of Store.saveKeyPair
- Defined in implementation/LogBackedStore.ts:95

saveSymmetricKey

saveSymmetricKey(symmetricKey: Bytes): Promise<number>
Saves a symmetric key for future use. Returns the keyId (a 52 bit digest of the key).
Parameters
- symmetricKey: Bytes
  the symmetric key to store
Returns Promise<number>
Implementation of Store.saveSymmetricKey
- Defined in implementation/LogBackedStore.ts:118

`Protected`unlockFile

unlockFile(): Promise<void>
Returns Promise<void>
Inherited from LockableLog.unlockFile
- Defined in implementation/LockableFile.ts:41

`Protected`writeLogFragment

writeLogFragment(fragment: LogFileBuilder, sync?: boolean): Promise<number>
Parameters
- fragment: LogFileBuilder
- Optionalsync: boolean
Returns Promise<number>
Inherited from LockableLog.writeLogFragment
- Defined in implementation/LockableLog.ts:15

`Protected`writeMagicNumber

writeMagicNumber(): Promise<number>
Returns Promise<number>
Inherited from LockableLog.writeMagicNumber
- Defined in implementation/LockableLog.ts:6

Class LogBackedStore

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LogBackedStore

Properties

Readonlyexclusive

ProtectedfileHandle

ProtectedfileLocked

Readonlyfilename

Accessors

ready

Returns Promise<void>

Methods

acquireChain

Parameters

Returns Promise<BundleInfo>

addBundle

Parameters

Returns Promise<Boolean>

addFoundBundleCallBack

Parameters

Returns void

close

Returns Promise<void>

getAllContainerTuples

Returns Promise<MuidTuple[]>

getAllEntries

Returns Promise<Entry[]>

getBillionths

Parameters

Returns Promise<bigint>

getBundles

Parameters

Returns Promise<void>

getBundlesProcessed

Returns Promise<number>

getChainIdentity

Parameters

Returns Promise<string>

getChainTracker

Returns Promise<ChainTracker>

getContainerBytes

Parameters

Returns Promise<Bytes>

getContainerProperties

Parameters

Returns Promise<Map<string, Value>>

getContainersByName

Parameters

Returns Promise<Muid[]>

getEntriesBySourceOrTarget

Parameters

Returns Promise<Entry[]>

getEntryById

Parameters

Returns Promise<Entry>

getEntryByKey

Parameters

Returns Promise<Entry>

ProtectedgetFileLength

Returns Promise<number>

getKeyedEntries

Parameters

Returns Promise<Map<string, Entry>>

getLocation

Parameters

Returns Promise<Placement>

getLogContents

Parameters

Returns Promise<LogFileBuilder>

getOrderedEntries

Parameters

`Readonly`exclusive

`Protected`fileHandle

`Protected`fileLocked

`Readonly`filename

`Protected`getFileLength

`Protected`lockFile

`Protected`unlockFile

`Protected`writeLogFragment

`Protected`writeMagicNumber