Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountApi

Account API

Hierarchy

  • AccountApi

Index

Properties

generateSendTransactionQRCode

generateSendTransactionQRCode: function

Get QR Code image for a given BURST address

param

The recipient burst

param

The amount (in NQT) to request (Default = 0)

param

The fee suggestion type string (Default = 'standard')

param

The fee amount (in NQT)

param

Whether to allow this to be modified

returns

QR code image data

Type declaration

    • (receiverId: string, amountNQT?: number, feeSuggestionType?: string, feeNQT?: number, immutable?: boolean): Promise<ArrayBufferLike>
    • Parameters

      • receiverId: string
      • Optional amountNQT: number
      • Optional feeSuggestionType: string
      • Optional feeNQT: number
      • Optional immutable: boolean

      Returns Promise<ArrayBufferLike>

generateSendTransactionQRCodeAddress

generateSendTransactionQRCodeAddress: function

Generate the URL for a QR Code for a given BURST address. Useful for IMG tags in HTML.

param

The recipient burst address

param

The amount (in NQT) to request (Default = 0)

param

The fee suggestion type string (Default = 'standard')

param

The fee amount (in NQT)

param

Whether to allow this to be modified

returns

The url

Type declaration

    • (receiverId: string, amountNQT?: number, feeSuggestionType?: string, feeNQT?: number, immutable?: boolean): Promise<string>
    • Parameters

      • receiverId: string
      • Optional amountNQT: number
      • Optional feeSuggestionType: string
      • Optional feeNQT: number
      • Optional immutable: boolean

      Returns Promise<string>

getAccount

getAccount: function

Get an account given an ID

param
returns

The account from the backend, not including transactions

Type declaration

    • (accountId: string): Promise<Account>
    • Parameters

      • accountId: string

      Returns Promise<Account>

getAccountBalance

getAccountBalance: function

Get the balance of an account

param
returns

The account's balance

Type declaration

    • (accountId: string): Promise<Balance>
    • Parameters

      • accountId: string

      Returns Promise<Balance>

getAccountBlockIds

getAccountBlockIds: function

Get blockIds forged by an account

param

first block to retrieve (optional, default is zero or the last block on the blockchain)

param

the last block to retrieve (optional, default is firstIndex + 99)

returns

The list of blocks

Type declaration

    • (accountId: string): Promise<string[]>
    • Parameters

      • accountId: string

      Returns Promise<string[]>

getAccountBlocks

getAccountBlocks: function

Get blocks forged by an account

param

first block to retrieve (optional, default is zero or the last block on the blockchain)

param

the last block to retrieve (optional, default is firstIndex + 99)

returns

The list of blocks

Type declaration

    • (accountId: string): Promise<Block[]>
    • Parameters

      • accountId: string

      Returns Promise<Block[]>

getAccountSubscriptions

getAccountSubscriptions: function

Gets a list of subscriptions for this account (sender)

param

The sender account Id

returns

List of Subscriptions

Type declaration

getAccountTransactions

getAccountTransactions: function

Get transactions of given account

param

The arguments

returns

List of transactions

Type declaration

getAliases

getAliases: function

Gets the aliases of an account

param
returns

A list of aliases of given account

Type declaration

    • Parameters

      • accountId: string

      Returns Promise<AliasList>

getRewardRecipient

getRewardRecipient: function

Gets the reward recipient for an account

So you can see, if an account is bound to a pool.

param

The account Id

returns

The Reward Recipient

Type declaration

getSubscriptionsToAccount

getSubscriptionsToAccount: function

Gets a list of subscriptions paying to the given account (recipient)

param

The recipient account Id

returns

List of Subscriptions

Type declaration

getUnconfirmedAccountTransactions

getUnconfirmedAccountTransactions: function

Get unconfirmed transactions of given account

param

The numeric accountId

param

Includes indirect transaction, i.e. multi out payments. For BRS Versions before 2.3.2 this must be undefined

returns

List of unconfirmed transactions

Type declaration

setAccountInfo

setAccountInfo: function

Sets account information for an account

The transaction will be broadcasted in two steps.

  1. Send the setAccountInfo call with public key to the network
  2. Take the returned unsigned message and sign it, i.e. the private key won't be transmitted.
param

The name of the account

param

The description for the account

param

The fee to pay

param

The name of the account

param

The senders public key for sending an unsigned message

param

The senders private key to sign the message

param

The deadline, in minutes, for the transaction to be confirmed

returns

The Transaction ID

Type declaration

    • (name: string, description: string, feeNQT: string, senderPublicKey: string, senderPrivateKey: string, deadline?: number): Promise<TransactionId>
    • Parameters

      • name: string
      • description: string
      • feeNQT: string
      • senderPublicKey: string
      • senderPrivateKey: string
      • Optional deadline: number

      Returns Promise<TransactionId>

setAlias

setAlias: function

Registers an Alias with the Burst blockchain

The transaction will be broadcasted in two steps.

  1. Send the setAlias call with public key to the network
  2. Take the returned unsigned message and sign it, i.e. the private key won't be transmitted.
param

The alias name

param

The alias URI

param

The fee to pay

param

The name of the account

param

The senders public key for sending an unsigned message

param

The senders private key to sign the message

param

The deadline, in minutes, for the transaction to be confirmed

returns

The Transaction ID

Type declaration

    • (aliasName: string, aliasURI: string, feeNQT: string, senderPublicKey: string, senderPrivateKey: string, deadline?: number): Promise<TransactionId>
    • Parameters

      • aliasName: string
      • aliasURI: string
      • feeNQT: string
      • senderPublicKey: string
      • senderPrivateKey: string
      • Optional deadline: number

      Returns Promise<TransactionId>

setRewardRecipient

setRewardRecipient: function

Assigns a reward recipient for an account

This function is usually used to bind an account to a mining pool.

param

The arguments

returns

The Transaction ID

Type declaration