Class MidgardQuery

Class for retrieving data and processing it from the Midgard API using MidgardCache to optimize the number of requests (MAYAChain L2 API).

Index

Constructors

Properties

Methods

getLatestBlockHeight getMAYANameDetails getMAYANameReverseLookup getMemberDetails getNetwork getPool getPoolStats getPools

Constructors

constructor

new MidgardQuery(midgardCache?): MidgardQuery
Constructor to create a MidgardQuery instance.
Parameters
- midgardCache: MidgardCache = ...
  An instance of the MidgardCache (could be pointing to stagenet, testnet, mainnet).
Returns MidgardQuery
MidgardQuery
- Defined in midgard-query.ts:19

Properties

`Private` midgardCache

midgardCache: MidgardCache

Methods

getLatestBlockHeight

getLatestBlockHeight(): Promise<number>
Retrieves the latest block height using the Health endpoint within Midgard.

Returns Promise<number>
The latest block height.
- Defined in midgard-query.ts:27

getMAYANameDetails

getMAYANameDetails(mayaName): Promise<undefined | THORNameDetails>
Retrieves MAYAName details.
Parameters
- mayaName: string
  The MAYAName.
Returns Promise<undefined | THORNameDetails>
An array of chains and their addresses associated with the given MAYAName.
- Defined in midgard-query.ts:70

getMAYANameReverseLookup

getMAYANameReverseLookup(address): Promise<undefined | ReverseTHORNames>
Performs a reverse lookup to get MAYAName(s) associated with the given address.
Parameters
- address: string
  The address to check for associated MAYAName(s).
Returns Promise<undefined | ReverseTHORNames>
An array of MAYAName(s) associated with the given address.
- Defined in midgard-query.ts:79

getMemberDetails

getMemberDetails(address): Promise<MemberDetails>
Retrieves member details.
Parameters
- address: string
  The member address.
Returns Promise<MemberDetails>
An array of statistics for all the liquidity providers associated with a given member address.
- Defined in midgard-query.ts:88

getNetwork

getNetwork(): Network
Gets the network MidgardQuery is working with.

Returns Network
The network.
- Defined in midgard-query.ts:96

getPool

getPool(asset): Promise<PoolDetail>
Retrieves the pool details for a specific asset.
Parameters
- asset: Asset
  The asset for which pool details are requested.
Returns Promise<PoolDetail>
Details of the selected pool.

Throws
If the pool for the asset cannot be found.
- Defined in midgard-query.ts:46

getPoolStats

getPoolStats(asset): Promise<PoolStatsDetail>
Retrieves pool statistics for a particular asset.
Parameters
- asset: Asset
  The asset string to query its pool stats.
Returns Promise<PoolStatsDetail>
Pool statistics details.
- Defined in midgard-query.ts:61

getPools

getPools(): Promise<PoolDetail[]>
Retrieves the list of pools.

Returns Promise<PoolDetail[]>
An array containing details for a set of pools.
- Defined in midgard-query.ts:36

Generated using TypeDoc