Class Middleware

Hierarchy (View Summary)

Middleware
- Middleware

Index

Constructors

Properties

Methods

getAccountActivities getAccountDexSwaps getAccountNameClaims getAccountPointees getAccountTransactionsCount getActiveAccountsStats getAex141ByContract getAex141ContractTemplates getAex141ContractTokens getAex141ContractTransfers getAex141OwnedTokens getAex141TemplateTokens getAex141TokenOwner getAex9AccountBalances getAex9ByContract getAex9ContractAccountBalance getAex9ContractAccountBalanceHistory getAex9ContractBalances getAex9TokensCount getAex9TransfersStats getBlocksStats getChannel getChannels getContract getContractCalls getContractLogs getContractsStats getDeltaStats getDexSwaps getDexSwapsByContractId getDifficultyStats getEpochs getEpochTop getHashrateStats getKeyBlock getKeyBlockMicroBlocks getKeyBlocks getMicroBlock getMicroBlockTransactions getMinerStats getName getNameAuction getNameAuctionClaims getNameClaims getNames getNamesAuctions getNamesCount getNamesStats getNameTransfers getNameUpdates getOracle getOracleExtends getOracleQueries getOracleResponses getOracles getPendingTransactions getPendingTransactionsCount getSchedule getSchedules getSortedAex141Contracts getSortedAex9Tokens getStats getStatus getTopValidatorDelegates getTotalAccountsStats getTotalStats getTransaction getTransactions getTransactionsCount getTransactionsStats getTransfers getValidator getValidatorDelegates getValidators requestByPath sendOperationRequest

Constructors

constructor

new Middleware(
    url: string,
    options?: MiddlewareOptionalParams & {
        ignoreVersion?: boolean;
        retryCount?: number;
        retryOverallDelay?: number;
    },
): Middleware
Parameters
- url: string
  Url for middleware API
- options: MiddlewareOptionalParams & {
      ignoreVersion?: boolean;
      retryCount?: number;
      retryOverallDelay?: number;
  } = {}
  Options
  - OptionalignoreVersion?: boolean
    Print warning instead of throwing exception if middleware is not supported, use with caution
  - OptionalretryCount?: number
    Amount of extra requests to do in case of failure
  - OptionalretryOverallDelay?: number
    Time in ms to wait between all retries
Returns Middleware
Overrides Middleware.constructor
- Defined in Middleware.ts:32

Properties

`Readonly`$host

$host: string

Methods

getAccountActivities

getAccountActivities(
accountId: `ak_${string}`,
options?: GetAccountActivitiesOptionalParams,
): Promise<GetAccountActivitiesResponse>
Get an account activities.
Parameters
- accountId: `ak_${string}`
  The account address Account address
- Optionaloptions: GetAccountActivitiesOptionalParams
  The options parameters.
Returns Promise<GetAccountActivitiesResponse>
Inherited from Middleware.getAccountActivities
- Defined in apis/middleware/middleware.ts:202

getAccountDexSwaps

getAccountDexSwaps(
accountId: `ak_${string}`,
options?: GetAccountDexSwapsOptionalParams,
): Promise<GetAccountDexSwapsResponse>
Get DEX swap tokens
Parameters
- accountId: `ak_${string}`
  The account id Account address
- Optionaloptions: GetAccountDexSwapsOptionalParams
  The options parameters.
Returns Promise<GetAccountDexSwapsResponse>
Inherited from Middleware.getAccountDexSwaps
- Defined in apis/middleware/middleware.ts:247

getAccountNameClaims

getAccountNameClaims(
accountId: `ak_${string}`,
options?: GetAccountNameClaimsOptionalParams,
): Promise<GetAccountNameClaimsResponse>
Get all name claims of an account
Parameters
- accountId: `ak_${string}`
  The account that made the claims Account address
- Optionaloptions: GetAccountNameClaimsOptionalParams
  The options parameters.
Returns Promise<GetAccountNameClaimsResponse>
Inherited from Middleware.getAccountNameClaims
- Defined in apis/middleware/middleware.ts:262

getAccountPointees

getAccountPointees(
accountId: `ak_${string}`,
options?: GetAccountPointeesOptionalParams,
): Promise<GetAccountPointeesResponse>
Get account pointees
Parameters
- accountId: `ak_${string}`
  The account that names point to Account address
- Optionaloptions: GetAccountPointeesOptionalParams
  The options parameters.
Returns Promise<GetAccountPointeesResponse>
Inherited from Middleware.getAccountPointees
- Defined in apis/middleware/middleware.ts:277

getAccountTransactionsCount

getAccountTransactionsCount(
    accountId: `ak_${string}`,
    options?: GetAccountTransactionsCountOptionalParams,
): Promise<
    PathsXcg812V3AccountsAccountidTransactionsCountGetResponses200ContentApplicationJsonSchema,
>
Get transactions count and its type for given aeternity ID.
Parameters
- accountId: `ak_${string}`
  The ID of the address/name/oracle/etc Account address
- Optionaloptions: GetAccountTransactionsCountOptionalParams
  The options parameters.
Returns Promise<
PathsXcg812V3AccountsAccountidTransactionsCountGetResponses200ContentApplicationJsonSchema,
>
Inherited from Middleware.getAccountTransactionsCount
- Defined in apis/middleware/middleware.ts:292

getActiveAccountsStats

getActiveAccountsStats(
options?: GetActiveAccountsStatsOptionalParams,
): Promise<GetActiveAccountsStatsResponse>
Get active accounts stats.
Parameters
- Optionaloptions: GetActiveAccountsStatsOptionalParams
  The options parameters.
Returns Promise<GetActiveAccountsStatsResponse>
Inherited from Middleware.getActiveAccountsStats
- Defined in apis/middleware/middleware.ts:944

getAex141ByContract

getAex141ByContract(
id: `ct_${string}`,
options?: GetAex141ByContractOptionalParams,
): 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>
Inherited from Middleware.getAex141ByContract
- Defined in apis/middleware/middleware.ts:399

getAex141ContractTemplates

getAex141ContractTemplates(
contractId: `ct_${string}`,
options?: GetAex141ContractTemplatesOptionalParams,
): 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>
Inherited from Middleware.getAex141ContractTemplates
- Defined in apis/middleware/middleware.ts:320

getAex141ContractTokens

getAex141ContractTokens(
contractId: `ct_${string}`,
options?: GetAex141ContractTokensOptionalParams,
): 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>
Inherited from Middleware.getAex141ContractTokens
- Defined in apis/middleware/middleware.ts:352

getAex141ContractTransfers

getAex141ContractTransfers(
contractId: `ct_${string}`,
options?: GetAex141ContractTransfersOptionalParams,
): 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>
Inherited from Middleware.getAex141ContractTransfers
- Defined in apis/middleware/middleware.ts:384

getAex141OwnedTokens

getAex141OwnedTokens(
accountId: `ak_${string}`,
options?: GetAex141OwnedTokensOptionalParams,
): 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>
Inherited from Middleware.getAex141OwnedTokens
- Defined in apis/middleware/middleware.ts:217

getAex141TemplateTokens

getAex141TemplateTokens(
    contractId: `ct_${string}`,
    templateId: number,
    options?: GetAex141TemplateTokensOptionalParams,
): 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>
Inherited from Middleware.getAex141TemplateTokens
- Defined in apis/middleware/middleware.ts:336

getAex141TokenOwner

getAex141TokenOwner(
    contractId: `ct_${string}`,
    tokenId: number,
    options?: GetAex141TokenOwnerOptionalParams,
): Promise<Aex141TokenDetailResponse>
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<Aex141TokenDetailResponse>
Inherited from Middleware.getAex141TokenOwner
- Defined in apis/middleware/middleware.ts:368

getAex9AccountBalances

getAex9AccountBalances(
accountId: `ak_${string}`,
options?: GetAex9AccountBalancesOptionalParams,
): 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>
Inherited from Middleware.getAex9AccountBalances
- Defined in apis/middleware/middleware.ts:232

getAex9ByContract

getAex9ByContract(
id: `ct_${string}`,
options?: GetAex9ByContractOptionalParams,
): 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>
Inherited from Middleware.getAex9ByContract
- Defined in apis/middleware/middleware.ts:489

getAex9ContractAccountBalance

getAex9ContractAccountBalance(
    contractId: `ct_${string}`,
    accountId: `ak_${string}`,
    options?: GetAex9ContractAccountBalanceOptionalParams,
): 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,
>
Inherited from Middleware.getAex9ContractAccountBalance
- Defined in apis/middleware/middleware.ts:456

getAex9ContractAccountBalanceHistory

getAex9ContractAccountBalanceHistory(
    contractId: `ct_${string}`,
    accountId: `ak_${string}`,
    options?: GetAex9ContractAccountBalanceHistoryOptionalParams,
): 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>
Inherited from Middleware.getAex9ContractAccountBalanceHistory
- Defined in apis/middleware/middleware.ts:473

getAex9ContractBalances

getAex9ContractBalances(
contractId: `ct_${string}`,
options?: GetAex9ContractBalancesOptionalParams,
): Promise<GetAex9ContractBalancesResponse>
Get AEX9 balances on a contract.
Parameters
- contractId: `ct_${string}`
  Contract id Contract address
- Optionaloptions: GetAex9ContractBalancesOptionalParams
  The options parameters.
Returns Promise<GetAex9ContractBalancesResponse>
Inherited from Middleware.getAex9ContractBalances
- Defined in apis/middleware/middleware.ts:440

getAex9TokensCount

getAex9TokensCount(
options?: GetAex9TokensCountOptionalParams,
): Promise<
Paths19IxhsmV3Aex9CountGetResponses200ContentApplicationJsonSchema,
>
Get AEX9 tokens count.
Parameters
- Optionaloptions: GetAex9TokensCountOptionalParams
  The options parameters.
Returns Promise<Paths19IxhsmV3Aex9CountGetResponses200ContentApplicationJsonSchema>
Inherited from Middleware.getAex9TokensCount
- Defined in apis/middleware/middleware.ts:426

getAex9TransfersStats

getAex9TransfersStats(
options?: GetAex9TransfersStatsOptionalParams,
): Promise<GetAex9TransfersStatsResponse>
Get total AEx9 token transfers.
Parameters
- Optionaloptions: GetAex9TransfersStatsOptionalParams
  The options parameters.
Returns Promise<GetAex9TransfersStatsResponse>
Inherited from Middleware.getAex9TransfersStats
- Defined in apis/middleware/middleware.ts:957

getBlocksStats

getBlocksStats(
options?: GetBlocksStatsOptionalParams,
): Promise<GetBlocksStatsResponse>
Get total blocks count stats.
Parameters
- Optionaloptions: GetBlocksStatsOptionalParams
  The options parameters.
Returns Promise<GetBlocksStatsResponse>
Inherited from Middleware.getBlocksStats
- Defined in apis/middleware/middleware.ts:970

getChannel

getChannel(
id: `ch_${string}`,
options?: GetChannelOptionalParams,
): Promise<Channel>
Get a single channel.
Parameters
- id: `ch_${string}`
  The channel Channel ID
- Optionaloptions: GetChannelOptionalParams
  The options parameters.
Returns Promise<Channel>
Inherited from Middleware.getChannel
- Defined in apis/middleware/middleware.ts:514

getChannels

getChannels(options?: GetChannelsOptionalParams): Promise<GetChannelsResponse>
Get multiple channels.
Parameters
- Optionaloptions: GetChannelsOptionalParams
  The options parameters.
Returns Promise<GetChannelsResponse>
Inherited from Middleware.getChannels
- Defined in apis/middleware/middleware.ts:503

getContract

getContract(
id: `ct_${string}`,
options?: GetContractOptionalParams,
): 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>
Inherited from Middleware.getContract
- Defined in apis/middleware/middleware.ts:549

getContractCalls

getContractCalls(
options?: GetContractCallsOptionalParams,
): Promise<GetContractCallsResponse>
Get contract calls.
Parameters
- Optionaloptions: GetContractCallsOptionalParams
  The options parameters.
Returns Promise<GetContractCallsResponse>
Inherited from Middleware.getContractCalls
- Defined in apis/middleware/middleware.ts:525

getContractLogs

getContractLogs(
options?: GetContractLogsOptionalParams,
): Promise<GetContractLogsResponse>
Get contract logs.
Parameters
- Optionaloptions: GetContractLogsOptionalParams
  The options parameters.
Returns Promise<GetContractLogsResponse>
Inherited from Middleware.getContractLogs
- Defined in apis/middleware/middleware.ts:538

getContractsStats

getContractsStats(
options?: GetContractsStatsOptionalParams,
): Promise<GetContractsStatsResponse>
Get the created contracts count per interval.
Parameters
- Optionaloptions: GetContractsStatsOptionalParams
  The options parameters.
Returns Promise<GetContractsStatsResponse>
Inherited from Middleware.getContractsStats
- Defined in apis/middleware/middleware.ts:980

getDeltaStats

getDeltaStats(
options?: GetDeltaStatsOptionalParams,
): Promise<GetDeltaStatsResponse>
Get delta stats.
Parameters
- Optionaloptions: GetDeltaStatsOptionalParams
  The options parameters.
Returns Promise<GetDeltaStatsResponse>
Inherited from Middleware.getDeltaStats
- Defined in apis/middleware/middleware.ts:993

getDexSwaps

getDexSwaps(options?: GetDexSwapsOptionalParams): Promise<GetDexSwapsResponse>
Get DEX swap tokens
Parameters
- Optionaloptions: GetDexSwapsOptionalParams
  The options parameters.
Returns Promise<GetDexSwapsResponse>
Inherited from Middleware.getDexSwaps
- Defined in apis/middleware/middleware.ts:560

getDexSwapsByContractId

getDexSwapsByContractId(
contractId: `ct_${string}`,
options?: GetDexSwapsByContractIdOptionalParams,
): Promise<GetDexSwapsByContractIdResponse>
Get DEX swap tokens
Parameters
- contractId: `ct_${string}`
  The contract id Contract address
- Optionaloptions: GetDexSwapsByContractIdOptionalParams
  The options parameters.
Returns Promise<GetDexSwapsByContractIdResponse>
Inherited from Middleware.getDexSwapsByContractId
- Defined in apis/middleware/middleware.ts:571

getDifficultyStats

getDifficultyStats(
options?: GetDifficultyStatsOptionalParams,
): Promise<GetDifficultyStatsResponse>
Get total blocks difficulty stats.
Parameters
- Optionaloptions: GetDifficultyStatsOptionalParams
  The options parameters.
Returns Promise<GetDifficultyStatsResponse>
Inherited from Middleware.getDifficultyStats
- Defined in apis/middleware/middleware.ts:1003

getEpochs

getEpochs(options?: GetEpochsOptionalParams): Promise<GetEpochsResponse>
Get Epoch information
Parameters
- Optionaloptions: GetEpochsOptionalParams
  The options parameters.
Returns Promise<GetEpochsResponse>
Inherited from Middleware.getEpochs
- Defined in apis/middleware/middleware.ts:585

getEpochTop

getEpochTop(options?: GetEpochTopOptionalParams): Promise<EpochInfo>
Get Top Epoch information
Parameters
- Optionaloptions: GetEpochTopOptionalParams
  The options parameters.
Returns Promise<EpochInfo>
Inherited from Middleware.getEpochTop
- Defined in apis/middleware/middleware.ts:593

getHashrateStats

getHashrateStats(
options?: GetHashrateStatsOptionalParams,
): Promise<GetHashrateStatsResponse>
Get total blocks hashrate stats.
Parameters
- Optionaloptions: GetHashrateStatsOptionalParams
  The options parameters.
Returns Promise<GetHashrateStatsResponse>
Inherited from Middleware.getHashrateStats
- Defined in apis/middleware/middleware.ts:1016

getKeyBlock

getKeyBlock(
hashOrKbi: number | `kh_${string}`,
options?: GetKeyBlockOptionalParams,
): Promise<KeyBlockExtended>
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<KeyBlockExtended>
Inherited from Middleware.getKeyBlock
- Defined in apis/middleware/middleware.ts:694

getKeyBlockMicroBlocks

getKeyBlockMicroBlocks(
hashOrKbi: number | `kh_${string}`,
options?: GetKeyBlockMicroBlocksOptionalParams,
): 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>
Inherited from Middleware.getKeyBlockMicroBlocks
- Defined in apis/middleware/middleware.ts:709

getKeyBlocks

getKeyBlocks(
options?: GetKeyBlocksOptionalParams,
): Promise<GetKeyBlocksResponse>
Get multiple key blocks.
Parameters
- Optionaloptions: GetKeyBlocksOptionalParams
  The options parameters.
Returns Promise<GetKeyBlocksResponse>
Inherited from Middleware.getKeyBlocks
- Defined in apis/middleware/middleware.ts:683

getMicroBlock

getMicroBlock(
hash: `mh_${string}`,
options?: GetMicroBlockOptionalParams,
): Promise<MicroBlockExtended>
Get a micro block
Parameters
- hash: `mh_${string}`
  The micro block encoded hash Micro block hash
- Optionaloptions: GetMicroBlockOptionalParams
  The options parameters.
Returns Promise<MicroBlockExtended>
Inherited from Middleware.getMicroBlock
- Defined in apis/middleware/middleware.ts:724

getMicroBlockTransactions

getMicroBlockTransactions(
hash: `mh_${string}`,
options?: GetMicroBlockTransactionsOptionalParams,
): 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>
Inherited from Middleware.getMicroBlockTransactions
- Defined in apis/middleware/middleware.ts:739

getMinerStats

getMinerStats(
options?: GetMinerStatsOptionalParams,
): Promise<GetMinerStatsResponse>
Get miners list with total rewards obtained through mining.
Parameters
- Optionaloptions: GetMinerStatsOptionalParams
  The options parameters.
Returns Promise<GetMinerStatsResponse>
Inherited from Middleware.getMinerStats
- Defined in apis/middleware/middleware.ts:1029

getName

getName(
id: `${string}.chain` | `nm_${string}`,
options?: GetNameOptionalParams,
): Promise<Name>
Get a single name.
Parameters
- id: `${string}.chain` | `nm_${string}`
  The name
- Optionaloptions: GetNameOptionalParams
  The options parameters.
Returns Promise<Name>
Inherited from Middleware.getName
- Defined in apis/middleware/middleware.ts:815

getNameAuction

getNameAuction(
id: `${string}.chain` | `nm_${string}`,
options?: GetNameAuctionOptionalParams,
): Promise<Auction>
Get name auction
Parameters
- id: `${string}.chain` | `nm_${string}`
  The name
- Optionaloptions: GetNameAuctionOptionalParams
  The options parameters.
Returns Promise<Auction>
Inherited from Middleware.getNameAuction
- Defined in apis/middleware/middleware.ts:775

getNameAuctionClaims

getNameAuctionClaims(
    id: `${string}.chain` | `nm_${string}`,
    options?: GetNameAuctionClaimsOptionalParams,
): Promise<
    PathsCrb9BgV3NamesAuctionsIdClaimsGetResponses200ContentApplicationJsonSchema,
>
Get name auction claims
Parameters
- id: `${string}.chain` | `nm_${string}`
  The name
- Optionaloptions: GetNameAuctionClaimsOptionalParams
  The options parameters.
Returns Promise<
PathsCrb9BgV3NamesAuctionsIdClaimsGetResponses200ContentApplicationJsonSchema,
>
Inherited from Middleware.getNameAuctionClaims
- Defined in apis/middleware/middleware.ts:790

getNameClaims

getNameClaims(
id: `${string}.chain` | `nm_${string}`,
options?: GetNameClaimsOptionalParams,
): Promise<GetNameClaimsResponse>
Get name claims
Parameters
- id: `${string}.chain` | `nm_${string}`
  The name or name hash
- Optionaloptions: GetNameClaimsOptionalParams
  The options parameters.
Returns Promise<GetNameClaimsResponse>
Inherited from Middleware.getNameClaims
- Defined in apis/middleware/middleware.ts:827

getNames

getNames(options?: GetNamesOptionalParams): Promise<GetNamesResponse>
Get multiple names.
Parameters
- Optionaloptions: GetNamesOptionalParams
  The options parameters.
Returns Promise<GetNamesResponse>
Inherited from Middleware.getNames
- Defined in apis/middleware/middleware.ts:753

getNamesAuctions

getNamesAuctions(
options?: GetNamesAuctionsOptionalParams,
): Promise<GetNamesAuctionsResponse>
Get multiple names.
Parameters
- Optionaloptions: GetNamesAuctionsOptionalParams
  The options parameters.
Returns Promise<GetNamesAuctionsResponse>
Inherited from Middleware.getNamesAuctions
- Defined in apis/middleware/middleware.ts:761

getNamesCount

getNamesCount(
options?: GetNamesCountOptionalParams,
): Promise<GetNamesCountResponse>
Get the total number of active names.
Parameters
- Optionaloptions: GetNamesCountOptionalParams
  The options parameters.
Returns Promise<GetNamesCountResponse>
Inherited from Middleware.getNamesCount
- Defined in apis/middleware/middleware.ts:804

getNamesStats

getNamesStats(
options?: GetNamesStatsOptionalParams,
): Promise<GetNamesStatsResponse>
Get total names count stats.
Parameters
- Optionaloptions: GetNamesStatsOptionalParams
  The options parameters.
Returns Promise<GetNamesStatsResponse>
Inherited from Middleware.getNamesStats
- Defined in apis/middleware/middleware.ts:1039

getNameTransfers

getNameTransfers(
id: `${string}.chain` | `nm_${string}`,
options?: GetNameTransfersOptionalParams,
): Promise<GetNameTransfersResponse>
Get name transfers
Parameters
- id: `${string}.chain` | `nm_${string}`
  The name or name hash
- Optionaloptions: GetNameTransfersOptionalParams
  The options parameters.
Returns Promise<GetNameTransfersResponse>
Inherited from Middleware.getNameTransfers
- Defined in apis/middleware/middleware.ts:842

getNameUpdates

getNameUpdates(
id: `${string}.chain` | `nm_${string}`,
options?: GetNameUpdatesOptionalParams,
): Promise<GetNameUpdatesResponse>
Get name updates
Parameters
- id: `${string}.chain` | `nm_${string}`
  The name or name hash
- Optionaloptions: GetNameUpdatesOptionalParams
  The options parameters.
Returns Promise<GetNameUpdatesResponse>
Inherited from Middleware.getNameUpdates
- Defined in apis/middleware/middleware.ts:857

getOracle

getOracle(
id: `ok_${string}`,
options?: GetOracleOptionalParams,
): Promise<Oracle>
Get a single oracle.
Parameters
- id: `ok_${string}`
  The oracle Oracle address
- Optionaloptions: GetOracleOptionalParams
  The options parameters.
Returns Promise<Oracle>
Inherited from Middleware.getOracle
- Defined in apis/middleware/middleware.ts:880

getOracleExtends

getOracleExtends(
id: `ok_${string}`,
options?: GetOracleExtendsOptionalParams,
): Promise<GetOracleExtendsResponse>
Get an oracle's extensions.
Parameters
- id: `ok_${string}`
  The oracle Oracle address
- Optionaloptions: GetOracleExtendsOptionalParams
  The options parameters.
Returns Promise<GetOracleExtendsResponse>
Inherited from Middleware.getOracleExtends
- Defined in apis/middleware/middleware.ts:892

getOracleQueries

getOracleQueries(
id: `ok_${string}`,
options?: GetOracleQueriesOptionalParams,
): Promise<GetOracleQueriesResponse>
Get an oracle's queries.
Parameters
- id: `ok_${string}`
  The oracle Oracle address
- Optionaloptions: GetOracleQueriesOptionalParams
  The options parameters.
Returns Promise<GetOracleQueriesResponse>
Inherited from Middleware.getOracleQueries
- Defined in apis/middleware/middleware.ts:907

getOracleResponses

getOracleResponses(
id: `ok_${string}`,
options?: GetOracleResponsesOptionalParams,
): Promise<GetOracleResponsesResponse>
Get an oracle's responses.
Parameters
- id: `ok_${string}`
  The oracle Oracle address
- Optionaloptions: GetOracleResponsesOptionalParams
  The options parameters.
Returns Promise<GetOracleResponsesResponse>
Inherited from Middleware.getOracleResponses
- Defined in apis/middleware/middleware.ts:922

getOracles

getOracles(options?: GetOraclesOptionalParams): Promise<GetOraclesResponse>
Get multiple oracles.
Parameters
- Optionaloptions: GetOraclesOptionalParams
  The options parameters.
Returns Promise<GetOraclesResponse>
Inherited from Middleware.getOracles
- Defined in apis/middleware/middleware.ts:871

getPendingTransactions

getPendingTransactions(
options?: GetPendingTransactionsOptionalParams,
): Promise<GetPendingTransactionsResponse>
Get pending transactions.
Parameters
- Optionaloptions: GetPendingTransactionsOptionalParams
  The options parameters.
Returns Promise<GetPendingTransactionsResponse>
Inherited from Middleware.getPendingTransactions
- Defined in apis/middleware/middleware.ts:1116

getPendingTransactionsCount

getPendingTransactionsCount(
options?: GetPendingTransactionsCountOptionalParams,
): Promise<GetPendingTransactionsCountResponse>
Get count of pending transactions.
Parameters
- Optionaloptions: GetPendingTransactionsCountOptionalParams
  The options parameters.
Returns Promise<GetPendingTransactionsCountResponse>
Inherited from Middleware.getPendingTransactionsCount
- Defined in apis/middleware/middleware.ts:1129

getSchedule

getSchedule(
height: number,
options?: GetScheduleOptionalParams,
): Promise<Schedule>
Get Schedule information
Parameters
- height: number
  Schedule height
- Optionaloptions: GetScheduleOptionalParams
  The options parameters.
Returns Promise<Schedule>
Inherited from Middleware.getSchedule
- Defined in apis/middleware/middleware.ts:614

getSchedules

getSchedules(
options?: GetSchedulesOptionalParams,
): Promise<GetSchedulesResponse>
Get Schedule information
Parameters
- Optionaloptions: GetSchedulesOptionalParams
  The options parameters.
Returns Promise<GetSchedulesResponse>
Inherited from Middleware.getSchedules
- Defined in apis/middleware/middleware.ts:603

getSortedAex141Contracts

getSortedAex141Contracts(
options?: GetSortedAex141ContractsOptionalParams,
): Promise<GetSortedAex141ContractsResponse>
Get AEX141 contracts sorted by creation time, name or symbol.
Parameters
- Optionaloptions: GetSortedAex141ContractsOptionalParams
  The options parameters.
Returns Promise<GetSortedAex141ContractsResponse>
Inherited from Middleware.getSortedAex141Contracts
- Defined in apis/middleware/middleware.ts:306

getSortedAex9Tokens

getSortedAex9Tokens(
options?: GetSortedAex9TokensOptionalParams,
): Promise<GetSortedAex9TokensResponse>
Get AEX9 tokens sorted by creation time, name or symbol.
Parameters
- Optionaloptions: GetSortedAex9TokensOptionalParams
  The options parameters.
Returns Promise<GetSortedAex9TokensResponse>
Inherited from Middleware.getSortedAex9Tokens
- Defined in apis/middleware/middleware.ts:413

getStats

getStats(options?: GetStatsOptionalParams): Promise<Stats>
Get stats.
Parameters
- Optionaloptions: GetStatsOptionalParams
  The options parameters.
Returns Promise<Stats>
Inherited from Middleware.getStats
- Defined in apis/middleware/middleware.ts:936

getStatus

getStatus(options?: GetStatusOptionalParams): Promise<Status>
Gets the current syncing status of both middleware and the node
Parameters
- Optionaloptions: GetStatusOptionalParams
  The options parameters.
Returns Promise<Status>
Inherited from Middleware.getStatus
- Defined in apis/middleware/middleware.ts:1085

getTopValidatorDelegates

getTopValidatorDelegates(
validator: `ak_${string}`,
options?: GetTopValidatorDelegatesOptionalParams,
): Promise<GetTopValidatorDelegatesResponse>
Get top Delegates information for validator
Parameters
- validator: `ak_${string}`
  Validator address Account address
- Optionaloptions: GetTopValidatorDelegatesOptionalParams
  The options parameters.
Returns Promise<GetTopValidatorDelegatesResponse>
Inherited from Middleware.getTopValidatorDelegates
- Defined in apis/middleware/middleware.ts:669

getTotalAccountsStats

getTotalAccountsStats(
options?: GetTotalAccountsStatsOptionalParams,
): Promise<GetTotalAccountsStatsResponse>
Get total accounts created per interval stats.
Parameters
- Optionaloptions: GetTotalAccountsStatsOptionalParams
  The options parameters.
Returns Promise<GetTotalAccountsStatsResponse>
Inherited from Middleware.getTotalAccountsStats
- Defined in apis/middleware/middleware.ts:1059

getTotalStats

getTotalStats(
options?: GetTotalStatsOptionalParams,
): Promise<GetTotalStatsResponse>
Get total accumulated stats.
Parameters
- Optionaloptions: GetTotalStatsOptionalParams
  The options parameters.
Returns Promise<GetTotalStatsResponse>
Inherited from Middleware.getTotalStats
- Defined in apis/middleware/middleware.ts:1049

getTransaction

getTransaction(
hash: `th_${string}`,
options?: GetTransactionOptionalParams,
): Promise<Transaction>
Get a single transaction.
Parameters
- hash: `th_${string}`
  The transaction encoded hash Transaction hash
- Optionaloptions: GetTransactionOptionalParams
  The options parameters.
Returns Promise<Transaction>
Inherited from Middleware.getTransaction
- Defined in apis/middleware/middleware.ts:1143

getTransactions

getTransactions(
options?: GetTransactionsOptionalParams,
): Promise<GetTransactionsResponse>
Get multiple transactions.
Parameters
- Optionaloptions: GetTransactionsOptionalParams
  The options parameters.
Returns Promise<GetTransactionsResponse>
Inherited from Middleware.getTransactions
- Defined in apis/middleware/middleware.ts:1093

getTransactionsCount

getTransactionsCount(
options?: GetTransactionsCountOptionalParams,
): Promise<GetTransactionsCountResponse>
Get count of transactions at the latest height.
Parameters
- Optionaloptions: GetTransactionsCountOptionalParams
  The options parameters.
Returns Promise<GetTransactionsCountResponse>
Inherited from Middleware.getTransactionsCount
- Defined in apis/middleware/middleware.ts:1103

getTransactionsStats

getTransactionsStats(
options?: GetTransactionsStatsOptionalParams,
): Promise<GetTransactionsStatsResponse>
Get total transactions count stats.
Parameters
- Optionaloptions: GetTransactionsStatsOptionalParams
  The options parameters.
Returns Promise<GetTransactionsStatsResponse>
Inherited from Middleware.getTransactionsStats
- Defined in apis/middleware/middleware.ts:1072

getTransfers

getTransfers(
options?: GetTransfersOptionalParams,
): Promise<GetTransfersResponse>
Get multiple transfers.
Parameters
- Optionaloptions: GetTransfersOptionalParams
  The options parameters.
Returns Promise<GetTransfersResponse>
Inherited from Middleware.getTransfers
- Defined in apis/middleware/middleware.ts:1157

getValidator

getValidator(
validator: `ak_${string}`,
options?: GetValidatorOptionalParams,
): Promise<Validator>
Get Validator information
Parameters
- validator: `ak_${string}`
  Validator address Account address
- Optionaloptions: GetValidatorOptionalParams
  The options parameters.
Returns Promise<Validator>
Inherited from Middleware.getValidator
- Defined in apis/middleware/middleware.ts:639

getValidatorDelegates

getValidatorDelegates(
validator: `ak_${string}`,
options?: GetValidatorDelegatesOptionalParams,
): Promise<GetValidatorDelegatesResponse>
Get Delegates information for validator
Parameters
- validator: `ak_${string}`
  Validator address Account address
- Optionaloptions: GetValidatorDelegatesOptionalParams
  The options parameters.
Returns Promise<GetValidatorDelegatesResponse>
Inherited from Middleware.getValidatorDelegates
- Defined in apis/middleware/middleware.ts:654

getValidators

getValidators(
options?: GetValidatorsOptionalParams,
): Promise<GetValidatorsResponse>
Get Validators information
Parameters
- Optionaloptions: GetValidatorsOptionalParams
  The options parameters.
Returns Promise<GetValidatorsResponse>
Inherited from Middleware.getValidators
- Defined in apis/middleware/middleware.ts:628

requestByPath

requestByPath<Response = unknown>(pathWithQuery: string): Promise<Response>
Get a middleware response by path instead of a method name and arguments.
Type Parameters
- Response = unknown
Parameters
- pathWithQuery: string
  a path to request starting with /v3/
Returns Promise<Response>
- Defined in Middleware.ts:75

sendOperationRequest

sendOperationRequest<T>(
operationArguments: OperationArguments,
operationSpec: OperationSpec,
): Promise<T>
Send an HTTP request that is populated using the provided OperationSpec.
Type Parameters
- T
  The typed result of the request, based on the OperationSpec.
Parameters
- operationArguments: OperationArguments
  The arguments that the HTTP request's templated values will be populated from.
- operationSpec: OperationSpec
  The OperationSpec to use to populate the httpRequest.
Returns Promise<T>
Overrides MiddlewareApi.sendOperationRequest
- Defined in Middleware.ts:119

Class Middleware

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalignoreVersion?: boolean

OptionalretryCount?: number

OptionalretryOverallDelay?: number

Returns Middleware

Properties

Readonly$host

Methods

getAccountActivities

Parameters

Returns Promise<GetAccountActivitiesResponse>

getAccountDexSwaps

Parameters

Returns Promise<GetAccountDexSwapsResponse>

getAccountNameClaims

Parameters

Returns Promise<GetAccountNameClaimsResponse>

getAccountPointees

Parameters

Returns Promise<GetAccountPointeesResponse>

getAccountTransactionsCount

Parameters

Returns Promise< PathsXcg812V3AccountsAccountidTransactionsCountGetResponses200ContentApplicationJsonSchema,>

getActiveAccountsStats

Parameters

Returns Promise<GetActiveAccountsStatsResponse>

getAex141ByContract

Parameters

Returns Promise<Aex141Response>

getAex141ContractTemplates

Parameters

Returns Promise<GetAex141ContractTemplatesResponse>

getAex141ContractTokens

Parameters

Returns Promise<GetAex141ContractTokensResponse>

getAex141ContractTransfers

Parameters

Returns Promise<GetAex141ContractTransfersResponse>

getAex141OwnedTokens

Parameters

Returns Promise<GetAex141OwnedTokensResponse>

getAex141TemplateTokens

Parameters

Returns Promise<GetAex141TemplateTokensResponse>

getAex141TokenOwner

Parameters

Returns Promise<Aex141TokenDetailResponse>

getAex9AccountBalances

Parameters

Returns Promise<GetAex9AccountBalancesResponse>

getAex9ByContract

Parameters

Returns Promise<Aex9Response>

getAex9ContractAccountBalance

Parameters

Returns Promise< PathsKr825V3Aex9ContractidBalancesAccountidGetResponses200ContentApplicationJsonSchema,>

getAex9ContractAccountBalanceHistory

Parameters

Returns Promise<GetAex9ContractAccountBalanceHistoryResponse>

getAex9ContractBalances

Parameters

Returns Promise<GetAex9ContractBalancesResponse>

getAex9TokensCount

Parameters

Returns Promise<Paths19IxhsmV3Aex9CountGetResponses200ContentApplicationJsonSchema>

getAex9TransfersStats

Parameters

Returns Promise<GetAex9TransfersStatsResponse>

getBlocksStats

Parameters

Returns Promise<GetBlocksStatsResponse>

getChannel

`Optional`ignoreVersion?: boolean

`Optional`retryCount?: number

`Optional`retryOverallDelay?: number

`Readonly`$host

Returns Promise<
PathsXcg812V3AccountsAccountidTransactionsCountGetResponses200ContentApplicationJsonSchema,
>

Returns Promise<
PathsKr825V3Aex9ContractidBalancesAccountidGetResponses200ContentApplicationJsonSchema,
>

Returns Promise<
PathsCrb9BgV3NamesAuctionsIdClaimsGetResponses200ContentApplicationJsonSchema,
>