Class IndexedDbStore

constructor

• new IndexedDbStore(
      indexedDbName: string,
      reset?: boolean,
      keepingHistory?: boolean,
  ): IndexedDbStore

• Parameters

  • indexedDbName: string
  • Optionalreset: boolean
  • keepingHistory: boolean = true

  Returns IndexedDbStore

ready

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>

addBundle

• addBundle(bundleView: 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

  • bundleView: BundleView
  • OptionalclaimChain: boolean

  Returns Promise<boolean>

addFoundBundleCallBack

• addFoundBundleCallBack(callback: BroadcastFunc): void

• Adds a callback to be called when a bundle was added by a different store and is found by the current store. Primarily intended for use with the LogBackedStore and file sharing.

  Parameters

  • callback: BroadcastFunc

    the function to be called when a new bundle is found. It needs to take two arguments, bundleBytes and bundleInfo.

  Returns void

close

• close(): Promise<void>

• Closes the underlying data store. Implicitly awaits on the this.ready promise.

  Returns Promise<void>

dropHistory

• dropHistory(container?: Muid, before?: AsOf): Promise<void>

• Parameters

  • Optionalcontainer: Muid
  • Optionalbefore: AsOf

  Returns Promise<void>

getAllContainerTuples

• getAllContainerTuples(): Promise<MuidTuple[]>

• Get every container in the store.

  Returns Promise<MuidTuple[]>

getAllEntries

• getAllEntries(): Promise<Entry[]>

• Returns Promise<Entry[]>

getAllEntryKeys

• getAllEntryKeys(): Promise<MuidTuple[]>

• Returns Promise<MuidTuple[]>

getAllRemovals

• getAllRemovals(): Promise<Removal[]>

• Returns Promise<Removal[]>

getBillionths

• getBillionths(muid: Muid, asOf?: AsOf): Promise<bigint>

• Parameters

  • muid: Muid
  • OptionalasOf: AsOf

  Returns Promise<bigint>

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>

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.

getChainTracker

• getChainTracker(): Promise<ChainTracker>

• Generates a ChainTracker describing how much of each chain this store has.

  Implicitly awaits on this.ready;

  Returns Promise<ChainTracker>

getClaimedChains

• getClaimedChains(): Promise<Map<number, ClaimedChain>>

• Returns Promise<Map<number, ClaimedChain>>

getClearanceTime

• getClearanceTime(
      trxn: Transaction,
      muidTuple: MuidTuple,
      asOfTs: number,
  ): Promise<number>

• Parameters

  • trxn: Transaction
  • muidTuple: MuidTuple
  • asOfTs: number

  Returns Promise<number>

getContainerBytes

• getContainerBytes(address: Muid): Promise<Bytes>

• Gets the protobuf bytes corresponding to a particular container's address.

  Parameters

  • address: Muid

  Returns Promise<Bytes>

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

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[]>

getEntriesBySourceOrTarget

• getEntriesBySourceOrTarget(
      vertex: Muid,
      source: boolean,
      asOf?: AsOf,
  ): Promise<Entry[]>

• Parameters

  • vertex: Muid
  • source: boolean
  • OptionalasOf: AsOf

  Returns Promise<Entry[]>

getEntryById

• getEntryById(entryMuid: Muid, asOf?: AsOf): Promise<Entry>

• Parameters

  • entryMuid: Muid
  • OptionalasOf: AsOf

  Returns Promise<Entry>

getEntryByKey

• getEntryByKey(
      container?: Muid,
      key?: ScalarKey | Muid | [Muid, Muid],
      asOf?: AsOf,
  ): Promise<Entry>

• Parameters

  • Optionalcontainer: Muid
  • Optionalkey: ScalarKey | Muid | [Muid, Muid]
  • OptionalasOf: AsOf

  Returns Promise<Entry>

getKeyedEntries

• getKeyedEntries(container: Muid, asOf?: AsOf): Promise<Map<string, Entry>>

• Parameters

  • container: Muid
  • OptionalasOf: AsOf

  Returns Promise<Map<string, Entry>>

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.

getOrderedEntries

• getOrderedEntries(
      container: Muid,
      through?: number,
      asOf?: AsOf,
  ): Promise<Map<string, Entry>>

• Returns entry data for a List. Does it in a single pass rather than using an async generator because if a user tried to await on something else between entries it would cause the IndexedDb transaction to auto-close.

  Parameters

  • container: Muid

    to get entries for
  • through: number = Infinity

    number to get, negative for starting from end
  • OptionalasOf: AsOf

    show results as of a time in the past

  Returns Promise<Map<string, Entry>>

  a promise of a list of ChangePairs

getSymmetricKey

• getSymmetricKey(keyId: number, trxn?: Transaction): Promise<Bytes>

• Retrieves a previously stored symmetric key.

  Parameters

  • keyId: number

    the id of the symmetric key to retrieve
  • Optionaltrxn: Transaction

  Returns Promise<Bytes>

getTransactionCount

• getTransactionCount(): number

• Returns number

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>

pullKeyPair

• pullKeyPair(publicKey: Bytes): Promise<KeyPair>

• Parameters

  • publicKey: Bytes

  Returns Promise<KeyPair>

saveKeyPair

• saveKeyPair(keyPair: KeyPair): Promise<void>

• Parameters

  • keyPair: KeyPair

  Returns Promise<void>

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>

startHistory

• startHistory(): void

• Returns void

stopHistory

• stopHistory(): Promise<void>

• Returns Promise<void>