Class Middleware

constructor

• new Middleware($host, options?): Middleware

• Initializes a new instance of the Middleware class.

  Parameters

  • $host: string

    server parameter
  • Optionaloptions: MiddlewareOptionalParams

    The parameter options

  Returns Middleware

Readonly$host

getAccountActivities

• getAccountActivities(id, options?): Promise<GetAccountActivitiesResponse>

• Get an account activities.

  Parameters

  • id: `ak_${string}`

    The account address Account address
  • Optionaloptions: GetAccountActivitiesOptionalParams

    The options parameters.

  Returns Promise<GetAccountActivitiesResponse>

getAccountDexSwaps

• getAccountDexSwaps(accountId, options?): Promise<GetAccountDexSwapsResponse>

• Get DEX swap tokens

  Parameters

  • accountId: `ak_${string}`

    The account id Account address
  • Optionaloptions: GetAccountDexSwapsOptionalParams

    The options parameters.

  Returns Promise<GetAccountDexSwapsResponse>

getAccountPointees

• getAccountPointees(id, options?): Promise<GetAccountPointeesResponse>

• Get account pointees

  Parameters

  • id: `ak_${string}`

    The account that names point to Account address
  • Optionaloptions: GetAccountPointeesOptionalParams

    The options parameters.

  Returns Promise<GetAccountPointeesResponse>

getAccountTransactionsCount

• getAccountTransactionsCount(id, options?): Promise<PathsLv15NfV3TransactionsCountIdGetResponses200ContentApplicationJsonSchema>

• Get transactions count and its type for given aeternity ID.

  Parameters

  • id: `ak_${string}`

    The ID of the address/name/oracle/etc Account address
  • Optionaloptions: GetAccountTransactionsCountOptionalParams

    The options parameters.

  Returns Promise<PathsLv15NfV3TransactionsCountIdGetResponses200ContentApplicationJsonSchema>

getAex141ByContract

• getAex141ByContract(id, options?): Promise<Aex141Response>

• Get AEX141 contract meta-info, extensions, limits and stats.

  Parameters

  • id: `ct_${string}`

    The contract id Contract address
  • Optionaloptions: GetAex141ByContractOptionalParams

    The options parameters.

  Returns Promise<Aex141Response>

getAex141ContractTemplates

• getAex141ContractTemplates(contractId, options?): Promise<GetAex141ContractTemplatesResponse>

• Get templates AEX-141 contract tokens.

  Parameters

  • contractId: `ct_${string}`

    The contract id Contract address
  • Optionaloptions: GetAex141ContractTemplatesOptionalParams

    The options parameters.

  Returns Promise<GetAex141ContractTemplatesResponse>

getAex141ContractTokens

• getAex141ContractTokens(contractId, options?): Promise<GetAex141ContractTokensResponse>

• Get owners of tokens of a AEX-141 contract.

  Parameters

  • contractId: `ct_${string}`

    The contract id Contract address
  • Optionaloptions: GetAex141ContractTokensOptionalParams

    The options parameters.

  Returns Promise<GetAex141ContractTokensResponse>

getAex141ContractTransfers

• getAex141ContractTransfers(contractId, options?): Promise<GetAex141ContractTransfersResponse>

• Get AEX-141 transfers on a contract.

  Parameters

  • contractId: `ct_${string}`

    Contract id Contract address
  • Optionaloptions: GetAex141ContractTransfersOptionalParams

    The options parameters.

  Returns Promise<GetAex141ContractTransfersResponse>

getAex141OwnedTokens

• getAex141OwnedTokens(accountId, options?): Promise<GetAex141OwnedTokensResponse>

• Get tokens owned by an account.

  Parameters

  • accountId: `ak_${string}`

    The account id Account address
  • Optionaloptions: GetAex141OwnedTokensOptionalParams

    The options parameters.

  Returns Promise<GetAex141OwnedTokensResponse>

getAex141TemplateTokens

• getAex141TemplateTokens(contractId, templateId, options?): Promise<GetAex141TemplateTokensResponse>

• Get AEX-141 template tokens.

  Parameters

  • contractId: `ct_${string}`

    Contract id Contract address
  • templateId: number

    Template id
  • Optionaloptions: GetAex141TemplateTokensOptionalParams

    The options parameters.

  Returns Promise<GetAex141TemplateTokensResponse>

getAex141TokenOwner

• getAex141TokenOwner(contractId, tokenId, options?): Promise<Paths1Fbvaw8V3Aex141ContractidTokensTokenidGetResponses200ContentApplicationJsonSchema>

• Get owner of a NFT (AEX-141 token).

  Parameters

  • contractId: `ct_${string}`

    The contract id Contract address
  • tokenId: number

    The nft token id
  • Optionaloptions: GetAex141TokenOwnerOptionalParams

    The options parameters.

  Returns Promise<Paths1Fbvaw8V3Aex141ContractidTokensTokenidGetResponses200ContentApplicationJsonSchema>

getAex9AccountBalances

• getAex9AccountBalances(accountId, options?): Promise<GetAex9AccountBalancesResponse>

• Get all AEX9 balances for an account on the last block.

  Parameters

  • accountId: `ak_${string}`

    Account id Account address
  • Optionaloptions: GetAex9AccountBalancesOptionalParams

    The options parameters.

  Returns Promise<GetAex9AccountBalancesResponse>

getAex9ByContract

• getAex9ByContract(id, options?): Promise<Aex9Response>

• Get AEX9 creation and meta_info information by contract id.

  Parameters

  • id: `ct_${string}`

    The contract id Contract address
  • Optionaloptions: GetAex9ByContractOptionalParams

    The options parameters.

  Returns Promise<Aex9Response>

getAex9ContractAccountBalance

• getAex9ContractAccountBalance(contractId, accountId, options?): Promise<PathsKr825V3Aex9ContractidBalancesAccountidGetResponses200ContentApplicationJsonSchema>

• Get AEX9 balance for an account on a contract.

  Parameters

  • contractId: `ct_${string}`

    Contract id Contract address
  • accountId: `ak_${string}`

    Account id Account address
  • Optionaloptions: GetAex9ContractAccountBalanceOptionalParams

    The options parameters.

  Returns Promise<PathsKr825V3Aex9ContractidBalancesAccountidGetResponses200ContentApplicationJsonSchema>

getAex9ContractAccountBalanceHistory

• getAex9ContractAccountBalanceHistory(contractId, accountId, options?): Promise<GetAex9ContractAccountBalanceHistoryResponse>

• Get AEX9 account balance on a contract throughout all heights when changed.

  Parameters

  • contractId: `ct_${string}`

    Contract id Contract address
  • accountId: `ak_${string}`

    Account id Account address
  • Optionaloptions: GetAex9ContractAccountBalanceHistoryOptionalParams

    The options parameters.

  Returns Promise<GetAex9ContractAccountBalanceHistoryResponse>

getAex9ContractBalances

• getAex9ContractBalances(contractId, options?): Promise<GetAex9ContractBalancesResponse>

• Get AEX9 balances on a contract.

  Parameters

  • contractId: `ct_${string}`

    Contract id Contract address
  • Optionaloptions: GetAex9ContractBalancesOptionalParams

    The options parameters.

  Returns Promise<GetAex9ContractBalancesResponse>

getAex9TokensCount

• getAex9TokensCount(options?): Promise<Paths19IxhsmV3Aex9CountGetResponses200ContentApplicationJsonSchema>

• Get AEX9 tokens count.

  Parameters

  • Optionaloptions: GetAex9TokensCountOptionalParams

    The options parameters.

  Returns Promise<Paths19IxhsmV3Aex9CountGetResponses200ContentApplicationJsonSchema>

getBlocksStats

• getBlocksStats(options?): Promise<GetBlocksStatsResponse>

• Get total blocks count stats.

  Parameters

  • Optionaloptions: GetBlocksStatsOptionalParams

    The options parameters.

  Returns Promise<GetBlocksStatsResponse>

getChannel

• getChannel(id, options?): Promise<Channel>

• Get a single channel.

  Parameters

  • id: `ch_${string}`

    The channel Channel ID
  • Optionaloptions: GetChannelOptionalParams

    The options parameters.

  Returns Promise<Channel>

getChannels

• getChannels(options?): Promise<GetChannelsResponse>

• Get multiple channels.

  Parameters

  • Optionaloptions: GetChannelsOptionalParams

    The options parameters.

  Returns Promise<GetChannelsResponse>

getContract

• getContract(id, options?): Promise<Contract>

• Gets contract creation info.

  Parameters

  • id: `ct_${string}`

    Contract that emitted the logs Contract address
  • Optionaloptions: GetContractOptionalParams

    The options parameters.

  Returns Promise<Contract>

getContractCalls

• getContractCalls(options?): Promise<GetContractCallsResponse>

• Get contract calls.

  Parameters

  • Optionaloptions: GetContractCallsOptionalParams

    The options parameters.

  Returns Promise<GetContractCallsResponse>

getContractLogs

• getContractLogs(options?): Promise<GetContractLogsResponse>

• Get contract logs.

  Parameters

  • Optionaloptions: GetContractLogsOptionalParams

    The options parameters.

  Returns Promise<GetContractLogsResponse>

getDeltaStats

• getDeltaStats(options?): Promise<GetDeltaStatsResponse>

• Get delta stats.

  Parameters

  • Optionaloptions: GetDeltaStatsOptionalParams

    The options parameters.

  Returns Promise<GetDeltaStatsResponse>

getDexSwaps

• getDexSwaps(options?): Promise<GetDexSwapsResponse>

• Get DEX swap tokens

  Parameters

  • Optionaloptions: GetDexSwapsOptionalParams

    The options parameters.

  Returns Promise<GetDexSwapsResponse>

getDexSwapsByContractId

• getDexSwapsByContractId(contractId, options?): Promise<GetDexSwapsByContractIdResponse>

• Get DEX swap tokens

  Parameters

  • contractId: `ct_${string}`

    The contract id Contract address
  • Optionaloptions: GetDexSwapsByContractIdOptionalParams

    The options parameters.

  Returns Promise<GetDexSwapsByContractIdResponse>

getKeyBlock

• getKeyBlock(hashOrKbi, options?): Promise<KeyBlock>

• Get a single key block.

  Parameters

  • hashOrKbi: number | `kh_${string}`

    The key block encoded hash or key block index
  • Optionaloptions: GetKeyBlockOptionalParams

    The options parameters.

  Returns Promise<KeyBlock>

getKeyBlockMicroBlocks

• getKeyBlockMicroBlocks(hashOrKbi, options?): Promise<GetKeyBlockMicroBlocksResponse>

• Get the key block micro blocks.

  Parameters

  • hashOrKbi: number | `kh_${string}`

    The key block encoded hash or key block index
  • Optionaloptions: GetKeyBlockMicroBlocksOptionalParams

    The options parameters.

  Returns Promise<GetKeyBlockMicroBlocksResponse>

getKeyBlocks

• getKeyBlocks(options?): Promise<GetKeyBlocksResponse>

• Get multiple key blocks.

  Parameters

  • Optionaloptions: GetKeyBlocksOptionalParams

    The options parameters.

  Returns Promise<GetKeyBlocksResponse>

getMicroBlock

• getMicroBlock(hash, options?): Promise<MicroBlock>

• Get a micro block

  Parameters

  • hash: `mh_${string}`

    The micro block encoded hash Micro block hash
  • Optionaloptions: GetMicroBlockOptionalParams

    The options parameters.

  Returns Promise<MicroBlock>

getMicroBlockTransactions

• getMicroBlockTransactions(hash, options?): Promise<GetMicroBlockTransactionsResponse>

• Get a micro block transactions

  Parameters

  • hash: `mh_${string}`

    The micro block encoded hash Micro block hash
  • Optionaloptions: GetMicroBlockTransactionsOptionalParams

    The options parameters.

  Returns Promise<GetMicroBlockTransactionsResponse>

getMinerStats

• getMinerStats(options?): Promise<GetMinerStatsResponse>

• Get miners list with total rewards obtained through mining.

  Parameters

  • Optionaloptions: GetMinerStatsOptionalParams

    The options parameters.

  Returns Promise<GetMinerStatsResponse>

getName

• getName(id, options?): Promise<Name>

• Get a single name.

  Parameters

  • id: `${string}.chain` | `nm_${string}`

    The name
  • Optionaloptions: GetNameOptionalParams

    The options parameters.

  Returns Promise<Name>

getNameAuction

• getNameAuction(id, options?): Promise<Auction>

• Get name auction

  Parameters

  • id: `${string}.chain` | `nm_${string}`

    The name
  • Optionaloptions: GetNameAuctionOptionalParams

    The options parameters.

  Returns Promise<Auction>

getNameAuctionClaims

• getNameAuctionClaims(id, options?): Promise<PathsCrb9BgV3NamesAuctionsIdClaimsGetResponses200ContentApplicationJsonSchema>

• Get name auction claims

  Parameters

  • id: `${string}.chain` | `nm_${string}`

    The name
  • Optionaloptions: GetNameAuctionClaimsOptionalParams

    The options parameters.

  Returns Promise<PathsCrb9BgV3NamesAuctionsIdClaimsGetResponses200ContentApplicationJsonSchema>

getNameClaims

• getNameClaims(id, options?): Promise<GetNameClaimsResponse>

• Get name claims

  Parameters

  • id: `${string}.chain` | `nm_${string}`

    The name or name hash
  • Optionaloptions: GetNameClaimsOptionalParams

    The options parameters.

  Returns Promise<GetNameClaimsResponse>

getNames

• getNames(options?): Promise<GetNamesResponse>

• Get multiple names.

  Parameters

  • Optionaloptions: GetNamesOptionalParams

    The options parameters.

  Returns Promise<GetNamesResponse>

getNamesAuctions

• getNamesAuctions(options?): Promise<GetNamesAuctionsResponse>

• Get multiple names.

  Parameters

  • Optionaloptions: GetNamesAuctionsOptionalParams

    The options parameters.

  Returns Promise<GetNamesAuctionsResponse>

getNamesCount

• getNamesCount(options?): Promise<GetNamesCountResponse>

• Get the total number of active names.

  Parameters

  • Optionaloptions: GetNamesCountOptionalParams

    The options parameters.

  Returns Promise<GetNamesCountResponse>

getNamesStats

• getNamesStats(options?): Promise<GetNamesStatsResponse>

• Get total names count stats.

  Parameters

  • Optionaloptions: GetNamesStatsOptionalParams

    The options parameters.

  Returns Promise<GetNamesStatsResponse>

getNameTransfers

• getNameTransfers(id, options?): Promise<GetNameTransfersResponse>

• Get name transfers

  Parameters

  • id: `${string}.chain` | `nm_${string}`

    The name or name hash
  • Optionaloptions: GetNameTransfersOptionalParams

    The options parameters.

  Returns Promise<GetNameTransfersResponse>

getNameUpdates

• getNameUpdates(id, options?): Promise<GetNameUpdatesResponse>

• Get name updates

  Parameters

  • id: `${string}.chain` | `nm_${string}`

    The name or name hash
  • Optionaloptions: GetNameUpdatesOptionalParams

    The options parameters.

  Returns Promise<GetNameUpdatesResponse>

getOracle

• getOracle(id, options?): Promise<Oracle>

• Get a single oracle.

  Parameters

  • id: `ok_${string}`

    The oracle Oracle address
  • Optionaloptions: GetOracleOptionalParams

    The options parameters.

  Returns Promise<Oracle>

getOracleExtends

• getOracleExtends(id, options?): Promise<GetOracleExtendsResponse>

• Get an oracle's extensions.

  Parameters

  • id: `ok_${string}`

    The oracle Oracle address
  • Optionaloptions: GetOracleExtendsOptionalParams

    The options parameters.

  Returns Promise<GetOracleExtendsResponse>

getOracleQueries

• getOracleQueries(id, options?): Promise<GetOracleQueriesResponse>

• Get an oracle's queries.

  Parameters

  • id: `ok_${string}`

    The oracle Oracle address
  • Optionaloptions: GetOracleQueriesOptionalParams

    The options parameters.

  Returns Promise<GetOracleQueriesResponse>

getOracleResponses

• getOracleResponses(id, options?): Promise<GetOracleResponsesResponse>

• Get an oracle's responses.

  Parameters

  • id: `ok_${string}`

    The oracle Oracle address
  • Optionaloptions: GetOracleResponsesOptionalParams

    The options parameters.

  Returns Promise<GetOracleResponsesResponse>

getOracles

• getOracles(options?): Promise<GetOraclesResponse>

• Get multiple oracles.

  Parameters

  • Optionaloptions: GetOraclesOptionalParams

    The options parameters.

  Returns Promise<GetOraclesResponse>

getSortedAex141Contracts

• getSortedAex141Contracts(options?): Promise<GetSortedAex141ContractsResponse>

• Get AEX141 contracts sorted by creation time, name or symbol.

  Parameters

  • Optionaloptions: GetSortedAex141ContractsOptionalParams

    The options parameters.

  Returns Promise<GetSortedAex141ContractsResponse>

getSortedAex9Tokens

• getSortedAex9Tokens(options?): Promise<GetSortedAex9TokensResponse>

• Get AEX9 tokens sorted by creation time, name or symbol.

  Parameters

  • Optionaloptions: GetSortedAex9TokensOptionalParams

    The options parameters.

  Returns Promise<GetSortedAex9TokensResponse>

getStats

• getStats(options?): Promise<Stats>

• Get stats.

  Parameters

  • Optionaloptions: GetStatsOptionalParams

    The options parameters.

  Returns Promise<Stats>

getStatus

• getStatus(options?): Promise<Status>

• Gets the current syncing status of both middleware and the node

  Parameters

  • Optionaloptions: GetStatusOptionalParams

    The options parameters.

  Returns Promise<Status>

getTotalStats

• getTotalStats(options?): Promise<GetTotalStatsResponse>

• Get total accumulated stats.

  Parameters

  • Optionaloptions: GetTotalStatsOptionalParams

    The options parameters.

  Returns Promise<GetTotalStatsResponse>

getTransaction

• getTransaction(hash, options?): Promise<Transaction>

• Get a single transaction.

  Parameters

  • hash: `th_${string}`

    The transaction encoded hash Transaction hash
  • Optionaloptions: GetTransactionOptionalParams

    The options parameters.

  Returns Promise<Transaction>

getTransactions

• getTransactions(options?): Promise<GetTransactionsResponse>

• Get multiple transactions.

  Parameters

  • Optionaloptions: GetTransactionsOptionalParams

    The options parameters.

  Returns Promise<GetTransactionsResponse>

getTransactionsCount

• getTransactionsCount(options?): Promise<GetTransactionsCountResponse>

• Get count of transactions at the latest height.

  Parameters

  • Optionaloptions: GetTransactionsCountOptionalParams

    The options parameters.

  Returns Promise<GetTransactionsCountResponse>

getTransactionsStats

• getTransactionsStats(options?): Promise<GetTransactionsStatsResponse>

• Get total transactions count stats.

  Parameters

  • Optionaloptions: GetTransactionsStatsOptionalParams

    The options parameters.

  Returns Promise<GetTransactionsStatsResponse>

getTransfers

• getTransfers(options?): Promise<GetTransfersResponse>

• Get multiple transfers.

  Parameters

  • Optionaloptions: GetTransfersOptionalParams

    The options parameters.

  Returns Promise<GetTransfersResponse>