StateQuery | cardano-ogmios

Index

References

ChainSync Classes

EraMismatchError

StateQuery Classes

TxSubmission Classes

EraMismatchError

StateQuery Interfaces

StateQueryClient

StateQuery Functions

References

EraWithGenesis

EraWithGenesis:

GenesisConfig

GenesisConfig:

UnknownResultError

UnknownResultError:

createStateQueryClient

createStateQueryClient:

StateQuery Functions

Const blockHeight

blockHeight(context: InteractionContext): Promise<BlockNoOrOrigin>

- Defined in packages/client/src/StateQuery/queries/blockHeight.ts:11
Get height (in blocks) of the network.

Parameters
- context: InteractionContext
Returns Promise<BlockNoOrOrigin>

Const chainTip

chainTip(context: InteractionContext): Promise<PointOrOrigin>

- Defined in packages/client/src/StateQuery/queries/chainTip.ts:11
Get the current tip of the chain.

Parameters
- context: InteractionContext
Returns Promise<PointOrOrigin>

Const currentEpoch

currentEpoch(context: InteractionContext): Promise<number>

- Defined in packages/client/src/StateQuery/queries/currentEpoch.ts:14
Get the current Cardano Epoch

Parameters
- context: InteractionContext
Returns Promise<number>

Const currentProtocolParameters

currentProtocolParameters(context: InteractionContext): Promise<ProtocolParametersShelley | ProtocolParametersAlonzo | ProtocolParametersBabbage>

- Defined in packages/client/src/StateQuery/queries/currentProtocolParameters.ts:25
Get the protocol parameters of the current epoch / era.

Parameters
- context: InteractionContext
Returns Promise<ProtocolParametersShelley | ProtocolParametersAlonzo | ProtocolParametersBabbage>

Const delegationsAndRewards

delegationsAndRewards(context: InteractionContext, stakeKeyHashes: string[]): Promise<DelegationsAndRewardsByAccounts>

- Defined in packages/client/src/StateQuery/queries/delegationsAndRewards.ts:31
Get delegation choices and reward balances of some given accounts / stake addresses.

Parameters
- context: InteractionContext
- stakeKeyHashes: string[]
Returns Promise<DelegationsAndRewardsByAccounts>

Const eraStart

eraStart(context: InteractionContext): Promise<Bound>

- Defined in packages/client/src/StateQuery/queries/eraStart.ts:16
Get the beginning of this era.

Parameters
- context: InteractionContext
Returns Promise<Bound>

Const eraSummaries

eraSummaries(context: InteractionContext): Promise<[EraSummary]>

- Defined in packages/client/src/StateQuery/queries/eraSummaries.ts:19
Get summaries of all Cardano eras, necessary to do proper slotting arithmetic.

Parameters
- context: InteractionContext
Returns Promise<[EraSummary]>

Const genesisConfig

genesisConfig(context: InteractionContext, era: EraWithGenesis): Promise<GenesisConfig>

- Defined in packages/client/src/StateQuery/queries/genesisConfig.ts:29
Get the Shelley's genesis configuration.

Parameters
- context: InteractionContext
- era: EraWithGenesis
Returns Promise<GenesisConfig>

Const ledgerTip

ledgerTip(context: InteractionContext): Promise<PointOrOrigin>

- Defined in packages/client/src/StateQuery/queries/ledgerTip.ts:17
Get the current ledger tip. Will resolve the the acquired point if any.

Parameters
- context: InteractionContext
Returns Promise<PointOrOrigin>

Const nonMyopicMemberRewards

nonMyopicMemberRewards(context: InteractionContext, input: (string | bigint)[]): Promise<NonMyopicMemberRewards>

- Defined in packages/client/src/StateQuery/queries/nonMyopicMemberRewards.ts:27
Get non-myopic member rewards from a projected delegation amount; this is used to rank pools such that the system converges towards a fixed number of pools at equilibrium.

Parameters
- context: InteractionContext
- input: (string | bigint)[]
Returns Promise<NonMyopicMemberRewards>

Const poolIds

poolIds(context: InteractionContext): Promise<string[]>

- Defined in packages/client/src/StateQuery/queries/poolIds.ts:25
Get the list of ids of currently active stake pools

Parameters
- context: InteractionContext
Returns Promise<string[]>

Const poolParameters

poolParameters(context: InteractionContext, pools: string[]): Promise<object>

- Defined in packages/client/src/StateQuery/queries/poolParameters.ts:25
Get all PoolParameters registered for the given PoolId

Parameters
- context: InteractionContext
- pools: string[]
Returns Promise<object>

Const poolsRanking

poolsRanking(context: InteractionContext): Promise<PoolsRanking>

- Defined in packages/client/src/StateQuery/queries/poolsRanking.ts:25
Get stake pools ranking (a.k.a pools desirabilities).

Parameters
- context: InteractionContext
Returns Promise<PoolsRanking>

Const proposedProtocolParameters

proposedProtocolParameters(context: InteractionContext): Promise<ProposedProtocolParametersShelley | ProposedProtocolParametersAlonzo | ProposedProtocolParametersBabbage>

- Defined in packages/client/src/StateQuery/queries/proposedProtocolParameters.ts:21
Get proposed protocol parameters for update, if any.

Parameters
- context: InteractionContext
Returns Promise<ProposedProtocolParametersShelley | ProposedProtocolParametersAlonzo | ProposedProtocolParametersBabbage>

Const rewardsProvenance

rewardsProvenance(context: InteractionContext): Promise<RewardsProvenance>

- Defined in packages/client/src/StateQuery/queries/rewardsProvenance.ts:25
Get details about the rewards provenance of the previous epoch.

Parameters
- context: InteractionContext
Returns Promise<RewardsProvenance>

Const rewardsProvenanceNew

rewardsProvenanceNew(context: InteractionContext): Promise<RewardsProvenance1>

- Defined in packages/client/src/StateQuery/queries/rewardsProvenanceNew.ts:25
Get details about the rewards provenance of the previous epoch.

Parameters
- context: InteractionContext
Returns Promise<RewardsProvenance1>

Const stakeDistribution

stakeDistribution(context: InteractionContext): Promise<PoolDistribution>

- Defined in packages/client/src/StateQuery/queries/stakeDistribution.ts:21
Get the current stake {@PoolDistribution}. This request may be quite long, use with care.

Parameters
- context: InteractionContext
Returns Promise<PoolDistribution>

Const systemStart

systemStart(context: InteractionContext): Promise<Date>

- Defined in packages/client/src/StateQuery/queries/systemStart.ts:11
Get the start date of the network.

Parameters
- context: InteractionContext
Returns Promise<Date>

Const utxo

utxo(context: InteractionContext, filters: string[] | TxIn[]): Promise<Utxo>

- Defined in packages/client/src/StateQuery/queries/utxo.ts:31
Queries the Utxo associated with some Address.

Parameters
- context: InteractionContext
- filters: string[] | TxIn[]
Returns Promise<Utxo>