npm
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionApi

Transaction API

This module provides methods related to blockchain transactions

Hierarchy

  • TransactionApi

Index

Properties

Properties

broadcastTransaction

broadcastTransaction: function

Broadcasts a transaction to the network/blockchain

param

The signed transaction payload encoded in base64

returns

The Transaction Id

Type declaration

    • Parameters

      • signedTransactionPayload: string

      Returns Promise<TransactionId>

cancelSubscription

cancelSubscription: function

Cancels a subscription

param

The argument object

returns

The Transaction Id (as promise)

Type declaration

createSubscription

createSubscription: function

Create a subscription

param

The argument object

returns

The Transaction Id (as promise)

Type declaration

getSubscription

getSubscription: function

Gets a subscription

param

The id of the subscription

returns

The Subscription Object (as promise)

Type declaration

getTransaction

getTransaction: function

Get a transaction and its details from the network/blockchain

param

The transaction Id

returns

The Transaction

Type declaration

getUnconfirmedTransactions

getUnconfirmedTransactions: function

Get the all current unconfirmed transactions

returns

The UnconfirmedTransactionList of unconfirmed transactions

Type declaration

sendAmountToMultipleRecipients

sendAmountToMultipleRecipients: function
param

A list of recipient Ids and their respective amounts to be sent

param

The fee to be paid as Planck value

param

The senders public key for sending an unsigned message

param

The senders private key to sign the message

returns

The Transaction Id

Type declaration

sendAmountToSingleRecipient

sendAmountToSingleRecipient: function

Sends burst to another account/recipient

param

The argument object

returns

The Transaction Id (as promise)

Type declaration

sendSameAmountToMultipleRecipients

sendSameAmountToMultipleRecipients: function

Sends a multi-out request to the blockchain with same value for all recipients

param

The amount to be sent as Planck value

param

The fee to be paid as Planck value

param

List of account IDs for the recipients

param

The senders public key for sending an unsigned message

param

The senders private key to sign the message

returns

The Transaction Id

Type declaration

    • (amountPlanck: string, feePlanck: string, recipientIds: string[], senderPublicKey: string, senderPrivateKey: string): Promise<TransactionId>

    • Parameters

      • amountPlanck: string
      • feePlanck: string
      • recipientIds: string[]
      • senderPublicKey: string
      • senderPrivateKey: string

      Returns Promise<TransactionId>

signAndBroadcastTransaction

signAndBroadcastTransaction: function

Signs and broadcasts a transaction

Usually, you don't need this, as all sending methods in BurstJS sign and broadcast. As not all BRS API functions are implemented yet in BurstJS this method is handy for those, i.e. all direct calls to ChainService.send

param

The unsigned Transaction Object (returned by ChainService.send)

returns

The TransactionId

Type declaration