LedgerStateQueryClient | cardano-ogmios

A State Query client.

Hierarchy

LedgerStateQueryClient

Properties

context

context: InteractionContext

Methods

acquireLedgerState

acquireLedgerState(point: "origin" | Point): Promise<void>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:47
Parameters
- point: "origin" | Point
Returns Promise<void>

constitution

constitution(): Promise<Constitution>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:51
Returns Promise<Constitution>

epoch

epoch(): Promise<number>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:52
Returns Promise<number>

eraStart

eraStart(): Promise<Bound>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:53
Returns Promise<Bound>

eraSummaries

eraSummaries(): Promise<EraSummary[]>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:54
Returns Promise<EraSummary[]>

genesisConfiguration

genesisConfiguration(era: "byron"): Promise<GenesisByron>
genesisConfiguration(era: "shelley"): Promise<GenesisShelley>
genesisConfiguration(era: "alonzo"): Promise<GenesisAlonzo>
genesisConfiguration(era: "conway"): Promise<GenesisConway>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:56
Parameters
- era: "byron"
Returns Promise<GenesisByron>
- Defined in packages/client/src/LedgerStateQuery/Client.ts:57
Parameters
- era: "shelley"
Returns Promise<GenesisShelley>
- Defined in packages/client/src/LedgerStateQuery/Client.ts:58
Parameters
- era: "alonzo"
Returns Promise<GenesisAlonzo>
- Defined in packages/client/src/LedgerStateQuery/Client.ts:59
Parameters
- era: "conway"
Returns Promise<GenesisConway>

governanceProposals

governanceProposals(filter?: GovernanceProposalReference[]): Promise<GovernanceProposalState[]>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:55
Parameters
- Optional filter: GovernanceProposalReference[]
Returns Promise<GovernanceProposalState[]>

ledgerTip

ledgerTip(): Promise<"origin" | Point>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:60
Returns Promise<"origin" | Point>

liveStakeDistribution

liveStakeDistribution(): Promise<LiveStakeDistribution>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:61
Returns Promise<LiveStakeDistribution>

networkBlockHeight

networkBlockHeight(): Promise<number | "origin">

- Defined in packages/client/src/LedgerStateQuery/Client.ts:62
Returns Promise<number | "origin">

networkStartTime

networkStartTime(): Promise<Date>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:63
Returns Promise<Date>

networkTip

networkTip(): Promise<"origin" | Point>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:64
Returns Promise<"origin" | Point>

projectedRewards

projectedRewards(filter: object): Promise<ProjectedRewards>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:65
Parameters
- filter: object
  - Optional keys?: string[]
  - Optional scripts?: string[]
  - Optional stake?: ValueAdaOnly[]
Returns Promise<ProjectedRewards>

proposedProtocolParameters

proposedProtocolParameters(): Promise<ProposedProtocolParameters>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:70
Returns Promise<ProposedProtocolParameters>

protocolParameters

protocolParameters(): Promise<ProtocolParameters>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:71
Returns Promise<ProtocolParameters>

releaseLedgerState

releaseLedgerState(): Promise<void>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:48
Returns Promise<void>

rewardAccountSummaries

rewardAccountSummaries(filter: object): Promise<RewardAccountSummaries>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:72
Parameters
- filter: object
  - Optional keys?: string[]
  - Optional scripts?: string[]
Returns Promise<RewardAccountSummaries>

rewardsProvenance

rewardsProvenance(): Promise<RewardsProvenance>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:76
Returns Promise<RewardsProvenance>

shutdown

shutdown(): Promise<void>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:49
Returns Promise<void>

stakePools

stakePools(filter?: object[]): Promise<object>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:77
Parameters
- Optional filter: object[]
Returns Promise<object>

utxo

utxo(filter?: UtxoByOutputReferences | UtxoByAddresses): Promise<Utxo>

- Defined in packages/client/src/LedgerStateQuery/Client.ts:78
Parameters
- Optional filter: UtxoByOutputReferences | UtxoByAddresses
Returns Promise<Utxo>