QRL Explorer Helpers
A helper library for front end interfaces to the QRL
v2 API functions are documented below. Legacy API calls to this module remain functional.
Installation
npm install @theqrl/explorer-helpers
Usage
var explorerHelpers = require("@theqrl/explorer-helpers")
(or import equivalent in Meteor)
qrlPrice() => price number
Queries Bittrex market price of $QRL.
| Description | |
|---|---|
| Function type | async |
| Parameters | none |
| Returns | number price: price per $QRL in USD |
var x = await explorerHelpers.qrlPrice()
console.log(`1 QRL = $${x}`)
tx(response json) => formatted json
Takes a grpc query response and formats it for browser display.
| Description | |
|---|---|
| Function type | sync |
| Parameters | response object a response to a grpc query |
| Returns | formatted json reformatted json object for browser display or element queries |
var x = explorerHelpers.tx(response)
console.log(x)
block(response json) => formatted json
Takes a grpc query response from GetObject and formats it for browser display where the requested data was a block.
| Description | |
|---|---|
| Function type | sync |
| Parameters | response object a response to a grpc query |
| Returns | formatted json reformatted json object for browser display or element queries |
var x = explorerHelpers.block(response)
console.log(x)
a(response json) => formatted json
Takes a grpc query response from GetObject and formats it for browser display where the requested data was an address.
| Description | |
|---|---|
| Function type | sync |
| Parameters | response object a response to a grpc query |
| Returns | formatted json reformatted json object for browser display or element queries |
var x = explorerHelpers.a(response)
console.log(x)
tokens(response json) => formatted json
Takes a grpc query response from GetTokensByAddress and formats it for browser display.
| Description | |
|---|---|
| Function type | sync |
| Parameters | response object a response to a grpc query |
| Returns | formatted json reformatted json object for browser display or element queries |
var x = explorerHelpers.tokens(response)
console.log(x)
multisig(response json) => formatted json
Takes a grpc query response from GetMultiSigAddressesByAddress and formats it for browser display.
| Description | |
|---|---|
| Function type | sync |
| Parameters | response object a response to a grpc query |
| Returns | formatted json reformatted json object for browser display or element queries |
var x = explorerHelpers.multisig(response)
console.log(x)
Tests
npm test