Class BigchaindbStore

constructor

• new BigchaindbStore(options?: BigchaindbStoreOptions): BigchaindbStore

  Parameters

  • options: BigchaindbStoreOptions = {}

  Returns BigchaindbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): BigchaindbConnectionLike

  Returns the underlying Connection for anything not wrapped here.

  Returns BigchaindbConnectionLike

append

• append(table: string, data: Record<string, unknown>): Promise<string>

  Build, sign and commit a CREATE transaction registering a new asset whose immutable asset.data is { table, ...data }. Returns the resulting transaction id (its content hash). Requires options.keypair.

  Parameters

  • table: string
  • data: Record<string, unknown>

  Returns Promise<string>

get

• get(_table: string, id: string): Promise<unknown>

  Fetch a transaction by its id (get(_, id)). Returns the signed transaction.

  Parameters

  • _table: string
  • id: string

  Returns Promise<unknown>

history

• history(_table: string, id: string): Promise<unknown>

  List every transaction (CREATE + subsequent TRANSFERs) for the asset id

  • the append-only history of that asset. Uses listTransactions.

  Parameters

  • _table: string
  • id: string

  Returns Promise<unknown>

verify

• verify(
      _table: string,
      id: string,
  ): Promise<{ id: string; valid: boolean; transaction: unknown }>

  Return the signed transaction id as its own proof of integrity: its Ed25519 signatures and content-hash id are what any party independently re-verifies against the asset data. Returns { id, valid, transaction }.

  Parameters

  • _table: string
  • id: string

  Returns Promise<{ id: string; valid: boolean; transaction: unknown }>

query

• query(text: string): Promise<unknown>

  Full-text search over asset data via searchAssets.

  Parameters

  • text: string

  Returns Promise<unknown>