1.0.0-beta.5 • Published 3 years ago

@quantnetwork/overledger-search v1.0.0-beta.5

Weekly downloads
8
License
Apache-2.0
Repository
github
Last release
3 years ago

@quantnetwork/overledger-search

Class encompassing Overledger SDK search functions.

Installation

Install using npm:

npm install @quantnetwork/overledger-search

Or, if you prefer using yarn:

yarn add @quantnetwork/overledger-search

API Reference

overledger-search

overledger-search.default

Search support package.

overledger-search~OverledgerSearch

new OverledgerSearch(sdk)

ParamType
sdkObject

overledgerSearch.getTransaction(transactionHash, dlt, extraFields)

ParamTypeDescription
transactionHashstringTransaction hash
dltstringthe dlt that the transactionHash resides on Optional
extraFieldsstringany extra fields required to perform this transaction search Optional

Get transaction by transaction hash

overledgerSearch.getTransactionType(hash)

ParamTypeDescription
hashstringhash

Get the transaction type based on the hash

overledgerSearch.getBlockByDltAndNumber(dlt, blockNumber)

ParamTypeDescription
dltstringThe DLT name
blockNumbernumberThe block number

Get block by DLT and number

overledgerSearch.getBlockHeightByDlt(dlt)

ParamTypeDescription
dltstringThe DLT name

Get block by DLT and number

overledgerSearch.getBlockByDltAndHash(dlt, hash)

ParamTypeDescription
dltstringThe DLT name
hashstringThe block hash

Get block by DLT and hash

overledgerSearch.smartContractQuery(dlt, contractQueryDetails)

ParamDescription
dltthe distributed ledger that this smart contract is on
contractQueryDetailsdetails on this smart contract query

Query a smart contract