core | signumjs - The Javascript SDK for Signum Network

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

see: Get started with composeApi or LedgerClientFactory

Index

References

Enumerations

Variables

Classes

Interfaces

Functions

Type aliases

Ledger

References

AccountApi

AccountApi:

AliasApi

AliasApi:

Api

Api:

ApiComposer

ApiComposer:

ApiSettings

ApiSettings:

AssetApi

AssetApi:

BlockApi

BlockApi:

ContractApi

ContractApi:

MessageApi

MessageApi:

NetworkApi

NetworkApi:

TransactionApi

TransactionApi:

addAssetTreasuryAccount

addAssetTreasuryAccount:

addCommitment

addCommitment:

broadcastTransaction

broadcastTransaction:

burnAsset

burnAsset:

buyAlias

buyAlias:

callContractMethod

callContractMethod:

cancelAskOrder

cancelAskOrder:

cancelBidOrder

cancelBidOrder:

cancelSubscription

cancelSubscription:

composeApi

composeApi:

createSubscription

createSubscription:

distributeToAssetHolders

distributeToAssetHolders:

generateSendTransactionQRCode

generateSendTransactionQRCode:

generateSendTransactionQRCodeAddress

generateSendTransactionQRCodeAddress:

getAccount

getAccount:

getAccountBalance

getAccountBalance:

getAccountBlockIds

getAccountBlockIds:

getAccountBlocks

getAccountBlocks:

getAccountSubscriptions

getAccountSubscriptions:

getAccountTransactions

getAccountTransactions:

getAliasById

getAliasById:

getAliasByName

getAliasByName:

getAliases

getAliases:

getAliasesOnSale

getAliasesOnSale:

getAllAssets

getAllAssets:

getAllContractIds

getAllContractIds:

getAllTrades

getAllTrades:

getAsset

getAsset:

getAssetHolders

getAssetHolders:

getAssetTrades

getAssetTrades:

getAssetTradesPerAccount

getAssetTradesPerAccount:

getAssetTradesPerAsset

getAssetTradesPerAsset:

getAssetTransfers

getAssetTransfers:

getAssetTransfersPerAccount

getAssetTransfersPerAccount:

getAssetTransfersPerAsset

getAssetTransfersPerAsset:

getAssetsByIssuer

getAssetsByIssuer:

getAssetsByName

getAssetsByName:

getBlockByHeight

getBlockByHeight:

getBlockById

getBlockById:

getBlockByTimestamp

getBlockByTimestamp:

getBlockId

getBlockId:

getBlockchainStatus

getBlockchainStatus:

getBlocks

getBlocks:

getContract

getContract:

getContractMapValuesByFirstKey

getContractMapValuesByFirstKey:

getContractsByAccount

getContractsByAccount:

getDistributionAmountsFromTransaction

getDistributionAmountsFromTransaction:

getMiningInfo

getMiningInfo:

getNetworkInfo

getNetworkInfo:

getOpenAskOrders

getOpenAskOrders:

getOpenAskOrdersPerAccount

getOpenAskOrdersPerAccount:

getOpenAskOrdersPerAsset

getOpenAskOrdersPerAsset:

getOpenBidOrders

getOpenBidOrders:

getOpenBidOrdersPerAccount

getOpenBidOrdersPerAccount:

getOpenBidOrdersPerAsset

getOpenBidOrdersPerAsset:

getPeer

getPeer:

getPeers

getPeers:

getRewardRecipient

getRewardRecipient:

getServerStatus

getServerStatus:

getSingleContractMapValue

getSingleContractMapValue:

getSubscription

getSubscription:

getSubscriptionsToAccount

getSubscriptionsToAccount:

getSuggestedFees

getSuggestedFees:

getTime

getTime:

getTradeHistoryPerAccount

getTradeHistoryPerAccount:

getTransaction

getTransaction:

getUnconfirmedAccountTransactions

getUnconfirmedAccountTransactions:

getUnconfirmedTransactions

getUnconfirmedTransactions:

issueAsset

issueAsset:

mintAsset

mintAsset:

parseTransactionBytes

parseTransactionBytes:

placeAskOrder

placeAskOrder:

placeBidOrder

placeBidOrder:

publishContract

publishContract:

publishContractByReference

publishContractByReference:

removeCommitment

removeCommitment:

sellAlias

sellAlias:

sendAmountToMultipleRecipients

sendAmountToMultipleRecipients:

sendAmountToSingleRecipient

sendAmountToSingleRecipient:

sendEncryptedMessage

sendEncryptedMessage:

sendMessage

sendMessage:

sendSameAmountToMultipleRecipients

sendSameAmountToMultipleRecipients:

setAccountInfo

setAccountInfo:

setAlias

setAlias:

setRewardRecipient

setRewardRecipient:

signAndBroadcastTransaction

signAndBroadcastTransaction:

transferAsset

transferAsset:

transferMultipleAssets

transferMultipleAssets:

Variables

Const DefaultApiEndpoint

DefaultApiEndpoint: "/api" = "/api"

The default endpoint for ApiSettings

Const DefaultDeadline

DefaultDeadline: 1440 = 1440

The default deadline (in minutes) for Transactions

Functions

getAttachmentVersion

getAttachmentVersion(transaction: Transaction): string

- Defined in packages/core/src/attachment/getAttachmentVersion.ts:12
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

getRecipientAmountsFromMultiOutPayment(transaction: Transaction): Array<MultioutRecipientAmount>

- Defined in packages/core/src/transaction/getRecipientAmountsFromMultiOutPayment.ts:13
Tries to extract recipients and its amounts for multi out payments (different and same amount)

throws

An exception in case of wrong transaction types

Parameters
- transaction: Transaction
  
  The transaction
Returns Array<MultioutRecipientAmount>

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

getRecipientsAmount

getRecipientsAmount(recipientId: string, transaction: Transaction): number

- Defined in packages/core/src/transaction/getRecipientsAmount.ts:14
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

- Defined in packages/core/src/attachment/isAttachmentVersion.ts:10
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

- Defined in packages/core/src/transaction/isMultiOutSameTransaction.ts:10
Checks if a transaction is a multi out transaction with same amounts for each recipient

Parameters
- transaction: Transaction
  
  Transaction to be checked
Returns boolean

true, if is a multi out transaction

Const isMultiOutTransaction

isMultiOutTransaction(transaction: Transaction): boolean

- Defined in packages/core/src/transaction/isMultiOutTransaction.ts:10
Checks if a transaction is a multi out transaction (with different amounts)

Parameters
- transaction: Transaction
  
  Transaction to be checked
Returns boolean

true, if is a multi out transaction

Type aliases

Ledger

Ledger: Api

Alias for Api