Interface AssetApi

Asset API

The Asset API provides all functions for Asset/Token operations

interface AssetApi {
    addAssetTreasuryAccount: ((args: AddAssetTreasuryAccountArgs) => Promise<TransactionId | UnsignedTransaction>);
    burnAsset: ((args: Omit<TransferAssetArgs, "recipientPublicKey" | "recipientId">) => Promise<TransactionId | UnsignedTransaction>);
    calculateDistributionFee: ((args: CalculateDistributionFeeArgs) => Promise<DistributionFee>);
    cancelAskOrder: ((args: CancelOrderArgs) => Promise<TransactionId | UnsignedTransaction>);
    cancelBidOrder: ((args: CancelOrderArgs) => Promise<TransactionId | UnsignedTransaction>);
    distributeToAssetHolders: ((args: DistributeToAssetHoldersArgs) => Promise<TransactionId | UnsignedTransaction>);
    getAllAssets: ((args: GetAllAssetsArgs) => Promise<AssetList>);
    getAllTrades: ((args: GetAllTradesArgs) => Promise<AssetTradeList>);
    getAsset: ((args: GetAssetArgs) => Promise<Asset>);
    getAssetHolders: ((args: GetAssetHoldersArgs) => Promise<AssetAccountList>);
    getAssetTrades: ((args: GetAssetTradesArgs) => Promise<AssetTradeList>);
    getAssetTradesPerAccount: ((args: GetAssetTradesPerAccountArgs) => Promise<AssetTradeList>);
    getAssetTradesPerAsset: ((args: GetAssetTradesPerAssetArgs) => Promise<AssetTradeList>);
    getAssetTransfers: ((args: GetAssetTransfersArgs) => Promise<AssetTransferList>);
    getAssetTransfersPerAccount: ((args: GetAssetTransfersPerAccountArgs) => Promise<AssetTransferList>);
    getAssetTransfersPerAsset: ((args: GetAssetTransfersPerAssetArgs) => Promise<AssetTransferList>);
    getAssetsByIssuer: ((args: GetAssetsByIssuerArgs) => Promise<AssetList>);
    getAssetsByName: ((args: GetAssetsByNameArgs) => Promise<AssetList>);
    getAssetsByOwner: ((args: GetAssetsByIssuerArgs) => Promise<AssetList>);
    getOpenAskOrders: ((args: GetAssetOpenOrdersArgs) => Promise<AssetAskOrderList>);
    getOpenAskOrdersPerAccount: ((args: GetAssetOpenOrdersPerAccountArgs) => Promise<AssetAskOrderList>);
    getOpenAskOrdersPerAsset: ((args: GetAssetOpenOrdersPerAssetArgs) => Promise<AssetAskOrderList>);
    getOpenBidOrders: ((args: GetAssetOpenOrdersArgs) => Promise<AssetBidOrderList>);
    getOpenBidOrdersPerAccount: ((args: GetAssetOpenOrdersPerAccountArgs) => Promise<AssetBidOrderList>);
    getOpenBidOrdersPerAsset: ((args: GetAssetOpenOrdersPerAssetArgs) => Promise<AssetBidOrderList>);
    getTradeHistoryPerAccount: ((args: GetTradeHistoryPerAccountArgs) => Promise<TradeHistory>);
    issueAsset: ((args: IssueAssetArgs) => Promise<TransactionId | UnsignedTransaction>);
    mintAsset: ((args: MintAssetArgs) => Promise<TransactionId | UnsignedTransaction>);
    placeAskOrder: ((args: PlaceOrderArgs) => Promise<TransactionId | UnsignedTransaction>);
    placeBidOrder: ((args: PlaceOrderArgs) => Promise<TransactionId | UnsignedTransaction>);
    transferAsset: ((args: TransferAssetArgs) => Promise<TransactionId | UnsignedTransaction>);
    transferAssetOwnership: ((args: TransferAssetOwnershipArgs) => Promise<TransactionId | UnsignedTransaction>);
    transferMultipleAssets: ((args: TransferMultipleAssetsArgs) => Promise<TransactionId | UnsignedTransaction>);
}

Properties

addAssetTreasuryAccount burnAsset calculateDistributionFee cancelAskOrder cancelBidOrder distributeToAssetHolders getAllAssets getAllTrades getAsset getAssetHolders getAssetTrades getAssetTradesPerAccount getAssetTradesPerAsset getAssetTransfers getAssetTransfersPerAccount getAssetTransfersPerAsset getAssetsByIssuer getAssetsByName getAssetsByOwner getOpenAskOrders getOpenAskOrdersPerAccount getOpenAskOrdersPerAsset getOpenBidOrders getOpenBidOrdersPerAccount getOpenBidOrdersPerAsset getTradeHistoryPerAccount issueAsset mintAsset placeAskOrder placeBidOrder transferAsset transferAssetOwnership transferMultipleAssets

Properties

addAssetTreasuryAccount

addAssetTreasuryAccount: ((args: AddAssetTreasuryAccountArgs) => Promise<TransactionId | UnsignedTransaction>)

Adds/Marks an account as treasury account for a given asset

Treasury Accounts are excluded from distributions for token/asset holders.

Type declaration

Throws

Error in case of unsuccessful transaction

burnAsset

burnAsset: ((args: Omit<TransferAssetArgs, "recipientPublicKey" | "recipientId">) => Promise<TransactionId | UnsignedTransaction>)

Burns assets, i.e. is de facto a transfer to recipient address '0'

Type declaration

calculateDistributionFee

calculateDistributionFee: ((args: CalculateDistributionFeeArgs) => Promise<DistributionFee>)

Calculates the fee for AssetApi.distributeToAssetHolders

Type declaration

cancelAskOrder

cancelAskOrder: ((args: CancelOrderArgs) => Promise<TransactionId | UnsignedTransaction>)

Cancel Ask Order

Type declaration

cancelBidOrder

cancelBidOrder: ((args: CancelOrderArgs) => Promise<TransactionId | UnsignedTransaction>)

Cancel Bid Order

Type declaration

distributeToAssetHolders

distributeToAssetHolders: ((args: DistributeToAssetHoldersArgs) => Promise<TransactionId | UnsignedTransaction>)

Distributes Signa and/or another asset to the holders of a given asset. Just pass the total amount to be distributed and it will be sent/distributed proportionally (at very high transaction rate, i.e. 5K TPS) to all holders.

To inspect the share a token holder received you need to use TransactionApi.getDistributionAmountsFromTransaction

To calculate the fees upfront use AssetApi.calculateDistributionFee.

Type declaration

Throws

Error in case of unsuccessful transaction

getAllAssets

getAllAssets: ((args: GetAllAssetsArgs) => Promise<AssetList>)

Get all available assets

Type declaration

    • (args): Promise<AssetList>

    • Parameters

      • args: GetAllAssetsArgs

        The argument object

      Returns Promise<AssetList>

      List of assets

getAllTrades

getAllTrades: ((args: GetAllTradesArgs) => Promise<AssetTradeList>)

Search for asset trades

Type declaration

getAsset

getAsset: ((args: GetAssetArgs) => Promise<Asset>)

Get asset information by its id

Type declaration

    • (args): Promise<Asset>

    • Parameters

      Returns Promise<Asset>

      The asset, if exists

getAssetHolders

getAssetHolders: ((args: GetAssetHoldersArgs) => Promise<AssetAccountList>)

Get all accounts that holds the fiven asset

Type declaration

getAssetTrades

getAssetTrades: ((args: GetAssetTradesArgs) => Promise<AssetTradeList>)

Get all asset trades by accountId and/or assetId

Type declaration

See

also AssetApi.getAssetTradesPerAsset or AssetApi.getAssetTradesPerAccount

Throws

Error if not at least assetId or accountId was giveb

getAssetTradesPerAccount

getAssetTradesPerAccount: ((args: GetAssetTradesPerAccountArgs) => Promise<AssetTradeList>)

A convenience function to get all asset transfers by accountId

Type declaration

See

also AssetApi.getAssetTrades

getAssetTradesPerAsset

getAssetTradesPerAsset: ((args: GetAssetTradesPerAssetArgs) => Promise<AssetTradeList>)

A convenience function to get all asset transfers by assetId

Type declaration

See

also AssetApi.getAssetTrades

getAssetTransfers

getAssetTransfers: ((args: GetAssetTransfersArgs) => Promise<AssetTransferList>)

Get all asset transfers by accountId and/or assetId

Type declaration

See

also AssetApi.getAssetTransfersPerAsset or AssetApi.getAssetTransfersPerAccount

Throws

Error if not at least assetId or accountId was giveb

getAssetTransfersPerAccount

getAssetTransfersPerAccount: ((args: GetAssetTransfersPerAccountArgs) => Promise<AssetTransferList>)

A convenience function to get all asset transfers by accountId

Type declaration

See

also AssetApi.getAssetTransfers

getAssetTransfersPerAsset

getAssetTransfersPerAsset: ((args: GetAssetTransfersPerAssetArgs) => Promise<AssetTransferList>)

A convenience function to get all asset transfers by assetId

Type declaration

See

also AssetApi.getAssetTransfers

getAssetsByIssuer

getAssetsByIssuer: ((args: GetAssetsByIssuerArgs) => Promise<AssetList>)

Gets all assets by given issuer. So, if an ownership was transferred the asset won't be listed by this call.

Type declaration

getAssetsByName

getAssetsByName: ((args: GetAssetsByNameArgs) => Promise<AssetList>)

Gets all assets by name (or parts of it)

Type declaration

getAssetsByOwner

getAssetsByOwner: ((args: GetAssetsByIssuerArgs) => Promise<AssetList>)

Gets all assets by given owner. So, if an ownership was transferred this new owner is considered byt this call.

Type declaration

getOpenAskOrders

getOpenAskOrders: ((args: GetAssetOpenOrdersArgs) => Promise<AssetAskOrderList>)

Gets all open Ask Orders

Type declaration

getOpenAskOrdersPerAccount

getOpenAskOrdersPerAccount: ((args: GetAssetOpenOrdersPerAccountArgs) => Promise<AssetAskOrderList>)

Gets all open Ask Orders

Type declaration

getOpenAskOrdersPerAsset

getOpenAskOrdersPerAsset: ((args: GetAssetOpenOrdersPerAssetArgs) => Promise<AssetAskOrderList>)

Gets all open Ask Orders per asset

Type declaration

getOpenBidOrders

getOpenBidOrders: ((args: GetAssetOpenOrdersArgs) => Promise<AssetBidOrderList>)

Gets all open Bid Orders

Type declaration

getOpenBidOrdersPerAccount

getOpenBidOrdersPerAccount: ((args: GetAssetOpenOrdersPerAccountArgs) => Promise<AssetBidOrderList>)

Gets all open Bid Orders per account

Type declaration

getOpenBidOrdersPerAsset

getOpenBidOrdersPerAsset: ((args: GetAssetOpenOrdersPerAssetArgs) => Promise<AssetBidOrderList>)

Gets all open Bid Orders per asset

Type declaration

getTradeHistoryPerAccount

getTradeHistoryPerAccount: ((args: GetTradeHistoryPerAccountArgs) => Promise<TradeHistory>)

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

Type declaration

issueAsset

issueAsset: ((args: IssueAssetArgs) => Promise<TransactionId | UnsignedTransaction>)

Issues assets

Type declaration

mintAsset

mintAsset: ((args: MintAssetArgs) => Promise<TransactionId | UnsignedTransaction>)

Mints assets

Type declaration

placeAskOrder

placeAskOrder: ((args: PlaceOrderArgs) => Promise<TransactionId | UnsignedTransaction>)

Place Ask Order

Type declaration

placeBidOrder

placeBidOrder: ((args: PlaceOrderArgs) => Promise<TransactionId | UnsignedTransaction>)

Place Ask Order

Type declaration

transferAsset

transferAsset: ((args: TransferAssetArgs) => Promise<TransactionId | UnsignedTransaction>)

Transfer assets

Type declaration

transferAssetOwnership

transferAssetOwnership: ((args: TransferAssetOwnershipArgs) => Promise<TransactionId | UnsignedTransaction>)

Transfer assets ownership

Type declaration

transferMultipleAssets

transferMultipleAssets: ((args: TransferMultipleAssetsArgs) => Promise<TransactionId | UnsignedTransaction>)

Transfer multiple (2-4) assets in one transaction.

Type declaration

Settings

Member Visibility

On This Page

Properties