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

Interface AccountApi

Account API

Hierarchy

  • AccountApi

Index

Properties

Properties

addCommitment

addCommitment: function

Adds an additional amount as commitment

The commitment is part of the PoC+ consensus, and allows miners to improve their mining power through additionally locked amount

param

The args

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

see

AccountApi.removeCommitment

Type declaration

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

The arguments

returns

The account from the backend, not including transactions

Type declaration

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

The arguments

returns

The list of blocks

Type declaration

getAccountBlocks

getAccountBlocks: function

Get blocks forged by an account

param

The arguments

returns

The list of blocks

Type declaration

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

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

getTradeHistoryPerAccount

getTradeHistoryPerAccount: function

The trade history is a journal about open/filled and/or cancelled trades for a given account and optionally set asset

param

The args object

param

trade history

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

removeCommitment

removeCommitment: function

Removes/Reduces a miners commitment

The commitment is part of the PoC+ consensus, and allows miners to improve their mining power through additionally locked amount

param

The args

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

see

AccountApi.addCommitment

Type declaration

setAccountInfo

setAccountInfo: function

Sets account information for an account

param

The arguments

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

Type declaration

setAlias

setAlias: function

Sets or Updates an Alias

param

The arguments

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

Type declaration

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 or Unsigned Bytes as Hex String if no private key was sent

Type declaration