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

External module core.api.factories

This submodule describes the Factory Methods of the API. You almost will like to use composeApi or LedgerClientFactory.createClient rather than using the Factory Methods itself

The factory methods are higher-order functions which receives a ChainService instance in first order, and the payload in second order.

factoryMethod(chainServiceInstance)(methodArgs)

The factory methods are used ApiComposer and composeApi

Index

Functions

Functions

Const addAssetTreasuryAccount

  • addAssetTreasuryAccount(service: ChainService): (Anonymous function)

Const addCommitment

  • addCommitment(service: ChainService): (Anonymous function)

Const broadcastTransaction

Const burnAsset

Const buyAlias

Const buyTopLevelDomain

  • buyTopLevelDomain(service: ChainService): (Anonymous function)

Const calculateDistributionFee

Const callContractMethod

  • callContractMethod(service: ChainService): (Anonymous function)

Const cancelAskOrder

  • cancelAskOrder(service: ChainService): (Anonymous function)

Const cancelBidOrder

  • cancelBidOrder(service: ChainService): (Anonymous function)

Const cancelSubscription

  • cancelSubscription(service: ChainService): (Anonymous function)

Const createSubscription

  • createSubscription(service: ChainService): (Anonymous function)

Const distributeToAssetHolders

  • distributeToAssetHolders(service: ChainService): (Anonymous function)

Const generateSendTransactionQRCode

  • generateSendTransactionQRCode(service: ChainService): function

Const generateSendTransactionQRCodeAddress

  • generateSendTransactionQRCodeAddress(service: ChainService): function

Const getAccount

Const getAccountBalance

Const getAccountBlockIds

Const getAccountBlocks

Const getAccountSubscriptions

Const getAccountTransactions

Const getAliasById

Const getAliasByName

Const getAliases

Const getAliasesOnSale

Const getAllAssets

Const getAllContractIds

Const getAllContractsByCodeHash

  • getAllContractsByCodeHash(service: ChainService): function

Const getAllTrades

Const getAsset

Const getAssetHolders

Const getAssetTrades

Const getAssetTradesPerAccount

Const getAssetTradesPerAsset

Const getAssetTransfers

Const getAssetTransfersPerAccount

  • getAssetTransfersPerAccount(service: ChainService): function

Const getAssetTransfersPerAsset

  • getAssetTransfersPerAsset(service: ChainService): function

Const getAssetsByIssuer

Const getAssetsByName

Const getAssetsByOwner

Const getBlockByHeight

Const getBlockById

Const getBlockByTimestamp

Const getBlockId

Const getBlockchainStatus

Const getBlocks

Const getContract

Const getContractMapValuesByFirstKey

  • getContractMapValuesByFirstKey(service: ChainService): function

Const getContractsByAccount

Const getDistributionAmountsFromTransaction

  • getDistributionAmountsFromTransaction(service: ChainService): function

Const getMiningInfo

Const getNetworkInfo

Const getOpenAskOrders

Const getOpenAskOrdersPerAccount

  • getOpenAskOrdersPerAccount(service: ChainService): function

Const getOpenAskOrdersPerAsset

Const getOpenBidOrders

Const getOpenBidOrdersPerAccount

  • getOpenBidOrdersPerAccount(service: ChainService): function

Const getOpenBidOrdersPerAsset

Const getPeer

Const getPeers

Const getRewardRecipient

Const getServerStatus

Const getSingleContractMapValue

  • getSingleContractMapValue(service: ChainService): function

Const getSubscription

Const getSubscriptionPayments

Const getSubscriptionsToAccount

  • getSubscriptionsToAccount(service: ChainService): function

Const getSuggestedFees

Const getTime

Const getTopLevelDomains

Const getTradeHistoryPerAccount

  • getTradeHistoryPerAccount(service: ChainService): function

Const getTransaction

Const getTransactionByFullHash

Const getUnconfirmedAccountTransactions

  • getUnconfirmedAccountTransactions(service: ChainService): function

Const getUnconfirmedTransactions

  • getUnconfirmedTransactions(service: ChainService): function

Const issueAsset

Const mintAsset

Const parseTransactionBytes

Const placeAskOrder

  • placeAskOrder(service: ChainService): (Anonymous function)

Const placeBidOrder

  • placeBidOrder(service: ChainService): (Anonymous function)

Const publishContract

  • publishContract(service: ChainService): (Anonymous function)

Const publishContractByReference

  • publishContractByReference(service: ChainService): (Anonymous function)

Const removeCommitment

  • removeCommitment(service: ChainService): (Anonymous function)

Const searchAliasesByName

Const sellAlias

Const sendAmountToMultipleRecipients

  • sendAmountToMultipleRecipients(service: ChainService): (Anonymous function)

Const sendAmountToSingleRecipient

  • sendAmountToSingleRecipient(service: ChainService): (Anonymous function)

Const sendEncryptedMessage

  • sendEncryptedMessage(service: ChainService): (Anonymous function)

Const sendMessage

Const sendSameAmountToMultipleRecipients

  • sendSameAmountToMultipleRecipients(service: ChainService): (Anonymous function)

Const setAccountInfo

  • setAccountInfo(service: ChainService): (Anonymous function)

Const setAlias

Const setRewardRecipient

  • setRewardRecipient(service: ChainService): (Anonymous function)

Const signAndBroadcastTransaction

  • signAndBroadcastTransaction(chainService: ChainService): function

Const transferAsset

  • transferAsset(service: ChainService): (Anonymous function)

Const transferAssetOwnership

  • transferAssetOwnership(service: ChainService): (Anonymous function)

Const transferMultipleAssets

  • transferMultipleAssets(service: ChainService): (Anonymous function)