@burstjs/core v0.6.0-beta.6

@burstjs/core

Burst-related functions and models for building Burstcoin applications.

Installation

burstJS can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @burstjs/core

or using yarn:

yarn add @burstjs/core

Example

import {composeApi, ApiSettings} from '@burstjs/core'
import {BurstValue} from '@burstjs/util'

const apiSettings = new ApiSettings('https://testnet.burstcoin.network:6876');
const api = composeApi(apiSettings);

// this self-executing file makes turns this file into a starting point of your app

(async () => {
try{
const {balanceNQT} = await api.account.getAccountBalance('13036514135565182944')
console.log(`Account Balance: ${BurstValue.fromPlanck(balanceNQT).toString()}`)
}
catch(e){ // e is of type HttpError (as part of @burstjs/http)
console.error(`Whooops, something went wrong: ${e.message}`)
}
})()

Using in classic <script>

Each package is available as bundled standalone library using IIFE. This way burstJS can be used also within <script>-Tags. This might be useful for Wordpress and/or other PHP applications.

Just import the package using the HTML <script> tag.

<script src='https://cdn.jsdelivr.net/npm/@burstjs/core/dist/burstjs.min.js'></script>

Example

(function(){
const api = b$.composeApi({nodeHost: "https://testnet.burstcoin.network:6876"});

api.network.getBlockchainStatus().then(console.log).catch(console.error);
})()

See more here:

@burstjs/core Online Documentation

API Reference

Modules

Classes

api

const api = apiComposer .create(burstService) .withMessageApi({ sendTextMessage }) .withAccountApi({ getAccountTransactions, getUnconfirmedAccountTransactions, getAccountBalance, generateSendTransactionQRCode, generateSendTransactionQRCodeAddress, }) .compose();

• api
  • ~ApiSettings
    • new ApiSettings(nodeHost, apiVersion, httpClientOptions)

api~ApiSettings

Kind: inner class of api

new ApiSettings(nodeHost, apiVersion, httpClientOptions)

api

• api
  • ~ApiSettings
    • new ApiSettings(nodeHost, apiVersion, httpClientOptions)

api~ApiSettings

Kind: inner class of api

new ApiSettings(nodeHost, apiVersion, httpClientOptions)

api ⇒

Returns: The complete API

• api ⇒
  • ~ApiSettings
    • new ApiSettings(nodeHost, apiVersion, httpClientOptions)

api~ApiSettings

Kind: inner class of api

new ApiSettings(nodeHost, apiVersion, httpClientOptions)

core ⇒

Returns: return Identifier, if exists, otherwise undefined

• core ⇒
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core ⇒

Returns: true, if version string matches

• core ⇒
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core

• core
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string

Kind: instance method of BurstService
Returns: string - The mounted url (without host)
See: https://burstwiki.org/wiki/The_Burst_API

burstService.query(method, args, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

burstService.send(method, args, body, options) ⇒ Promise.<T>

Kind: instance method of BurstService
Returns: Promise.<T> - The response data of success
Throws:

core ⇒

Deprecated

Returns: HttpParams
Internal:

• core ⇒
  • ~BurstService
    • new BurstService(settings)
    • .toBRSEndpoint(method, data) ⇒ string
    • .query(method, args, options) ⇒ Promise.<T>
    • .send(method, args, body, options) ⇒ Promise.<T>

core~BurstService

Kind: inner class of core

• ~BurstService
  • new BurstService(settings)
  • .toBRSEndpoint(method, data) ⇒ string
  • .query(method, args, options) ⇒ Promise.<T>
  • .send(method, args, body, options) ⇒ Promise.<T>

new BurstService(settings)

burstService.toBRSEndpoint(method, data) ⇒ string