@burstjs/core

@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 {convertNQTStringToNumber} from '@burstjs/util'

const apiSettings = new ApiSettings('http://at-testnet.burst-alliance.org:6876', 'burst');
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: ${convertNQTStringToNumber(balanceNQT)} BURST`)
}
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: "http://at-testnet.burst-alliance.org:6876",
apiRootUrl: "/burst"
});

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

See more here:

@burstjs/core Online Documentation

---

API Reference

Modules

api

core

Classes

ApiSettings

Settings for API used in [[composeApi]]

BurstService

Generic BRS Web Service class.

Members

ApiSettings ⇒

Composes the API, i.e. setup the environment and mounts the API structure with its functions.

const api = composeApi({
  nodeHost: 'https://wallet1.burst-team.us:2083', // one of the mainnet nodes
})

Note, that this method mounts the entire API, i.e. all available methods. One may also customize the API composition using [[ApiComposer]].

Functions

createParametersFromAttachment(attachment, params) ⇒

Creates BRS Http send parameters for a transaction from attachment data

api

• api
  • ~ApiImpl
  • ~ApiComposer
    • instance
      • .withBlockApi(creatorMap)
      • .withAccountApi(creatorMap)
      • .withNetworkApi(creatorMap)
      • .withMessageApi(creatorMap)
      • .withTransactionApi(creatorMap)
      • .withAliasApi(creatorMap)
      • .withAssetApi(creatorMap)
      • .withContractApi(creatorMap)
      • .compose()
    • static
      • .create(service) ⇒

api~ApiImpl

Copyright (c) 2019 Burst Apps Team

Kind: inner class of api

api~ApiComposer

The API composer mounts the API for given service and selected methods

Usually you would use [[composeApi]], which gives you all available API methods. Unfortunately, this will import almost all dependencies, even if you need only a fraction of the methods. To take advantage of tree-shaking (dead code elimination) you can compose your own API with the methods you need. This can reduce your final bundle significantly.

Usage:

const burstService = new BurstService({
    nodeHost: 'https://testnet.burst.fun',
})
const api = apiComposer
.create(burstService)
.withMessageApi({
sendTextMessage
})
.withAccountApi({
getAccountTransactions,
getUnconfirmedAccountTransactions,
getAccountBalance,
generateSendTransactionQRCode,
generateSendTransactionQRCodeAddress,
})
.compose();

The with<section>Api uses factory methods from the api.core.factories package

Kind: inner class of api

• ~ApiComposer
  • instance
    • .withBlockApi(creatorMap)
    • .withAccountApi(creatorMap)
    • .withNetworkApi(creatorMap)
    • .withMessageApi(creatorMap)
    • .withTransactionApi(creatorMap)
    • .withAliasApi(creatorMap)
    • .withAssetApi(creatorMap)
    • .withContractApi(creatorMap)
    • .compose()
  • static
    • .create(service) ⇒

apiComposer.withBlockApi(creatorMap)

Adds the [[BlockApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withAccountApi(creatorMap)

Adds the [[AccountApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withNetworkApi(creatorMap)

Adds the [[NetworkApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withMessageApi(creatorMap)

Adds the [[MessageApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withTransactionApi(creatorMap)

Adds the [[TransactionApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withAliasApi(creatorMap)

Adds the [[AliasApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withAssetApi(creatorMap)

Adds the [[AssetApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.withContractApi(creatorMap)

Adds the [[ContractApi]] to be composed

Kind: instance method of ApiComposer

Param	Description
creatorMap	A map of creator/factory functions for the endpoints

apiComposer.compose()

Composes the API Note: As of being a builder pattern, this need to call this method as last

Kind: instance method of ApiComposer

ApiComposer.create(service) ⇒

Creates the composer instance

Kind: static method of ApiComposer
Returns:

the composer instance

Param
service

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core

• core
  • static
    • .FeeQuantPlanck
    • .DefaultDeadline
    • .Attachment
    • .AttachmentMessage
  • inner
    • ~Account
    • ~Attachment
    • ~BurstNode
    • ~TransactionArbitrarySubtype
    • ~TransactionAssetSubtype
    • ~TransactionEscrowSubtype
    • ~TransactionLeasingSubtype
    • ~TransactionMarketplaceSubtype
    • ~TransactionPaymentSubtype
    • ~TransactionRewardRecipientSubtype
    • ~TransactionSmartContractSubtype
    • ~TransactionType
    • ~FeeQuantPlanck
    • ~getAttachmentVersion(transaction) ⇒
    • ~isAttachmentVersion(transaction, versionIdentifier) ⇒
    • ~constructAttachment(transaction, params) ⇒
    • ~signAndBroadcastTransaction(unsignedTransaction, service) ⇒
    • ~getRecipientAmountsFromMultiOutPayment(transaction) ⇒
    • ~getRecipientsAmount(recipientId, transaction) ⇒
    • ~isMultiOutSameTransaction(transaction) ⇒
    • ~isMultiOutTransaction(transaction) ⇒

core.FeeQuantPlanck

The default deadline (in minutes) for Transactions

Kind: static property of core

core.DefaultDeadline

The default endpoint for [[ApiSettings]]

Kind: static property of core

core.Attachment

Message class

The Message class is used to model a plain message attached to a transaction.

Kind: static property of core

core.AttachmentMessage

EncryptedMessage class

The EncryptedMessage class is a model for a encrypted message attached to a transaction.

Kind: static property of core

core~Account

Account class

The account class serves as a model for a Burstcoin account. It's meant to model the response from BRS API, except publicKey has been moved into the keys object.

Kind: inner class of core

core~Attachment

Attachment class

The attachment class is used to appended to transaction where appropriate. It is a super class for Message and EncryptedMessage.

Kind: inner class of core

core~BurstNode

Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team

Kind: inner class of core

core~TransactionArbitrarySubtype

Constants for arbitrary subtypes

Kind: inner property of core

core~TransactionAssetSubtype

Constants for asset subtypes

Kind: inner property of core

core~TransactionEscrowSubtype

Constants for escrow subtypes

Kind: inner property of core

core~TransactionLeasingSubtype

Constants for leasing subtypes

Kind: inner property of core

core~TransactionMarketplaceSubtype

Constants for marketplace subtypes

Kind: inner property of core

core~TransactionPaymentSubtype

Constants for payment subtypes

Kind: inner property of core

core~TransactionRewardRecipientSubtype

Constants for reward recipient subtypes (Pool Operation)

Kind: inner property of core

core~TransactionSmartContractSubtype

Constants for smart contract (aka AT) subtypes

Kind: inner property of core

core~TransactionType

Constants for transaction types

The transaction type is part of every [[Transaction]] object and used to distinguish block data. Additionally, to the transaction type a subtype is sent, that specifies the kind of transaction more detailly.

Kind: inner property of core

core~FeeQuantPlanck

The smallest possible fee

Kind: inner constant of core

core~getAttachmentVersion(transaction) ⇒

Get the transaction attachment version identifier

Attachment types are identified by a field version.

Kind: inner method of core
Returns:

return Identifier, if exists, otherwise undefined

Param	Description
transaction	The transaction to be checked

core~isAttachmentVersion(transaction, versionIdentifier) ⇒

Checks if a transaction attachment is of specific version

Kind: inner method of core
Returns:

true, if version string matches

Param	Description
transaction	The transaction to be checked
versionIdentifier	The version string, i.e. MultiOutCreation

core~constructAttachment(transaction, params) ⇒

Deprecated

Kind: inner method of core
Returns:

HttpParams

Hidden:

Param	Description
transaction	The transaction with the attachment
params	Some HttpParams

core~signAndBroadcastTransaction(unsignedTransaction, service) ⇒

Signs and broadcasts a transaction

Kind: inner method of core
Returns:

The transaction Id

Hidden:

Param	Description
unsignedTransaction	The unsigned transaction context
service	The service used for

core~getRecipientAmountsFromMultiOutPayment(transaction) ⇒

Tries to extract recipients and its amounts for multi out payments (different and same amount)

Kind: inner method of core
Returns:

A list of recipients and their payed amount (in NQT)

Throws:

• An exception in case of wrong transaction types

Param	Description
transaction	The transaction

core~getRecipientsAmount(recipientId, transaction) ⇒

Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

Kind: inner method of core
Returns:

the amount in BURST (not NQT)

Param	Description
recipientId	The numeric id of the recipient
transaction	The payment transaction

core~isMultiOutSameTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction with same amounts for each recipient

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

core~isMultiOutTransaction(transaction) ⇒

Checks if a transaction is a multi out transaction (with different amounts)

Kind: inner method of core
Returns:

true, if is a multi out transaction

Param	Description
transaction	Transaction to be checked

ApiSettings

Settings for API used in [[composeApi]]

Kind: global class

new ApiSettings(nodeHost, apiVersion, httpClientOptions)

Param	Type	Description
nodeHost	string	The url of the Burst peer
apiVersion	ApiVersion	For future usage.
httpClientOptions	any | AxiosRequestSettings	Optional http options, like additional header. The default implementation uses axios. In case of a custom client pass your own options. see Axios Configuration

BurstService

Generic BRS Web Service class.

Kind: global class

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

new BurstService(settings)

Creates Service instance

Param	Description
settings	The settings for the service

burstService.toBRSEndpoint(method, data) ⇒ string

Mounts a BRS conform API (V1) endpoint of format <host>?requestType=getBlock&height=123

Kind: instance method of BurstService
Returns: string -

The mounted url (without host)

See: https://burstwiki.org/wiki/The_Burst_API

Param	Type	Description
method	string	The method name for requestType
data	any	A JSON object which will be mapped to url params

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

Requests a query to BRS

Kind: instance method of BurstService
Returns: Promise.<T> -

The response data of success

Throws:

• HttpError in case of failure

Param	Type	Description
method	string	The BRS method according https://burstwiki.org/wiki/The_Burst_API
args	any	A JSON object which will be mapped to url params
options	any | AxiosRequestConfig	The optional request configuration for the passed Http client

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

Send data to BRS

Kind: instance method of BurstService
Returns: Promise.<T> -

The response data of success

Throws:

• HttpError in case of failure

Param	Type	Description
method	string	The BRS method according https://burstwiki.org/wiki/The_Burst_API. Note that there are only a few POST methods
args	any	A JSON object which will be mapped to url params
body	any	An object with key value pairs to submit as post body
options	any | AxiosRequestConfig	The optional request configuration for the passed Http client

ApiSettings ⇒

Composes the API, i.e. setup the environment and mounts the API structure with its functions.

const api = composeApi({
  nodeHost: 'https://wallet1.burst-team.us:2083', // one of the mainnet nodes
})

Note, that this method mounts the entire API, i.e. all available methods. One may also customize the API composition using [[ApiComposer]].

Kind: global variable
Returns:

The complete API

Param	Description
settings	necessary execution context

new ApiSettings(nodeHost, apiVersion, httpClientOptions)

Param	Type	Description
nodeHost	string	The url of the Burst peer
apiVersion	ApiVersion	For future usage.
httpClientOptions	any | AxiosRequestSettings	Optional http options, like additional header. The default implementation uses axios. In case of a custom client pass your own options. see Axios Configuration

createParametersFromAttachment(attachment, params) ⇒

Creates BRS Http send parameters for a transaction from attachment data

Kind: global function
Returns:

HttpParams

Hidden:

Param	Description
attachment	The attachment
params	Any object