Options
All
  • Public
  • Public/Protected
  • All
Menu

External module core

This is the main package, and almost all you may need to interact with the Burstcoin API

see

Get started with composeApi

Index

References

Enumerations

Variables

Classes

Interfaces

Functions

References

AccountApi

AccountApi:

AliasApi

AliasApi:

Api

Api:

ApiComposer

ApiComposer:

ApiSettings

ApiSettings:

AssetApi

AssetApi:

BlockApi

BlockApi:

ContractApi

ContractApi:

MessageApi

MessageApi:

NetworkApi

NetworkApi:

TransactionApi

TransactionApi:

addCommitment

addCommitment:

broadcastTransaction

broadcastTransaction:

callContractMethod

callContractMethod:

cancelAskOrder

cancelAskOrder:

cancelBidOrder

cancelBidOrder:

cancelSubscription

cancelSubscription:

composeApi

composeApi:

createSubscription

createSubscription:

generateSendTransactionQRCode

generateSendTransactionQRCode:

generateSendTransactionQRCodeAddress

generateSendTransactionQRCodeAddress:

getAccount

getAccount:

getAccountBalance

getAccountBalance:

getAccountBlockIds

getAccountBlockIds:

getAccountBlocks

getAccountBlocks:

getAccountSubscriptions

getAccountSubscriptions:

getAccountTransactions

getAccountTransactions:

getAliasById

getAliasById:

getAliasByName

getAliasByName:

getAliases

getAliases:

getAllAssets

getAllAssets:

getAllContractIds

getAllContractIds:

getAsset

getAsset:

getBlockByHeight

getBlockByHeight:

getBlockById

getBlockById:

getBlockByTimestamp

getBlockByTimestamp:

getBlockId

getBlockId:

getBlockchainStatus

getBlockchainStatus:

getBlocks

getBlocks:

getContract

getContract:

getContractsByAccount

getContractsByAccount:

getPeer

getPeer:

getPeers

getPeers:

getRewardRecipient

getRewardRecipient:

getServerStatus

getServerStatus:

getSubscription

getSubscription:

getSubscriptionsToAccount

getSubscriptionsToAccount:

getSuggestedFees

getSuggestedFees:

getTime

getTime:

getTransaction

getTransaction:

getUnconfirmedAccountTransactions

getUnconfirmedAccountTransactions:

getUnconfirmedTransactions

getUnconfirmedTransactions:

issueAsset

issueAsset:

placeAskOrder

placeAskOrder:

placeBidOrder

placeBidOrder:

publishContract

publishContract:

removeCommitment

removeCommitment:

sendAmountToMultipleRecipients

sendAmountToMultipleRecipients:

sendAmountToSingleRecipient

sendAmountToSingleRecipient:

sendEncryptedMessage

sendEncryptedMessage:

sendMessage

sendMessage:

sendSameAmountToMultipleRecipients

sendSameAmountToMultipleRecipients:

setAccountInfo

setAccountInfo:

setAlias

setAlias:

setRewardRecipient

setRewardRecipient:

signAndBroadcastTransaction

signAndBroadcastTransaction:

transferAsset

transferAsset:

Variables

Const DefaultApiEndpoint

DefaultApiEndpoint: "/burst" = "/burst"

The default endpoint for ApiSettings

Const DefaultDeadline

DefaultDeadline: 1440 = 1440

The default deadline (in minutes) for Transactions

Functions

getAttachmentVersion

  • getAttachmentVersion(transaction: Transaction): string
  • Get the transaction attachment version identifier

    Attachment types are identified by a field version.

    Parameters

    • transaction: Transaction

      The transaction to be checked

    Returns string

    return Identifier, if exists, otherwise undefined

getRecipientAmountsFromMultiOutPayment

getRecipientsAmount

  • getRecipientsAmount(recipientId: string, transaction: Transaction): number
  • Gets the amount from a transaction, considering ordinary and multi out transactions (with same and different payments)

    Parameters

    • recipientId: string

      The numeric id of the recipient

    • transaction: Transaction

      The payment transaction

    Returns number

    the amount in BURST (not NQT)

isAttachmentVersion

  • isAttachmentVersion(transaction: Transaction, versionIdentifier: string): boolean
  • Checks if a transaction attachment is of specific version

    Parameters

    • transaction: Transaction

      The transaction to be checked

    • versionIdentifier: string

      The version string, i.e. MultiOutCreation

    Returns boolean

    true, if version string matches

Const isMultiOutSameTransaction

  • isMultiOutSameTransaction(transaction: Transaction): boolean

Const isMultiOutTransaction

  • isMultiOutTransaction(transaction: Transaction): boolean