Interface Ogmios

interface Ogmios {
    AcquireLedgerState: AcquireLedgerState;
    AcquireLedgerStateFailure?: AcquireLedgerStateFailure;
    AcquireLedgerStateResponse: AcquireLedgerStateFailure | AcquireLedgerStateSuccess;
    AcquireMempool: AcquireMempool;
    AcquireMempoolResponse: AcquireMempoolResponse;
    EvaluateTransaction: EvaluateTransaction;
    EvaluateTransactionResponse: EvaluateTransactionSuccess | EvaluateTransactionError | EvaluateTransactionDeserialisationError;
    FindIntersection: FindIntersection;
    FindIntersectionResponse: IntersectionFound | IntersectionNotFound | IntersectionInterleaved;
    HasTransaction: HasTransaction;
    HasTransactionResponse: MustAcquireMempoolFirst | HasTransactionResponse;
    MustAcquireMempoolFirst?: MustAcquireMempoolFirst;
    NextBlock: NextBlock;
    NextBlockResponse: NextBlockResponse;
    NextTransaction: NextTransaction;
    NextTransactionResponse: MustAcquireMempoolFirst | NextTransactionResponse;
    QueryLedgerStateAcquiredExpired?: QueryLedgerStateAcquiredExpired;
    QueryLedgerStateConstitution: QueryLedgerStateConstitution;
    QueryLedgerStateConstitutionResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateConstitutionResponse;
    QueryLedgerStateConstitutionalCommittee: QueryLedgerStateConstitutionalCommittee;
    QueryLedgerStateConstitutionalCommitteeResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateConstitutionalCommitteeResponse;
    QueryLedgerStateEpoch: QueryLedgerStateEpoch;
    QueryLedgerStateEpochResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateEpochResponse;
    QueryLedgerStateEraMismatch?: QueryLedgerStateEraMismatch;
    QueryLedgerStateEraStart: QueryLedgerStateEraStart;
    QueryLedgerStateEraStartResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateEraStartResponse;
    QueryLedgerStateEraSummaries: QueryLedgerStateEraSummaries;
    QueryLedgerStateEraSummariesResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateEraSummariesResponse;
    QueryLedgerStateLiveStakeDistribution: QueryLedgerStateLiveStakeDistribution;
    QueryLedgerStateLiveStakeDistributionResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateLiveStakeDistributionResponse;
    QueryLedgerStateProjectedRewards: QueryLedgerStateProjectedRewards;
    QueryLedgerStateProjectedRewardsResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateProjectedRewardsResponse;
    QueryLedgerStateProposedProtocolParameters: QueryLedgerStateProposedProtocolParameters;
    QueryLedgerStateProposedProtocolParametersResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateProposedProtocolParametersResponse;
    QueryLedgerStateProtocolParameters: QueryLedgerStateProtocolParameters;
    QueryLedgerStateProtocolParametersResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateProtocolParametersResponse;
    QueryLedgerStateRewardAccountSummaries: QueryLedgerStateRewardAccountSummaries;
    QueryLedgerStateRewardAccountSummariesResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateRewardAccountSummariesResponse;
    QueryLedgerStateRewardsProvenance: QueryLedgerStateRewardsProvenance;
    QueryLedgerStateRewardsProvenanceResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateRewardsProvenanceResponse;
    QueryLedgerStateStakePools: QueryLedgerStateStakePools;
    QueryLedgerStateStakePoolsResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateStakePoolsResponse;
    QueryLedgerStateTip: QueryLedgerStateTip;
    QueryLedgerStateTipResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateTipResponse;
    QueryLedgerStateTreasuryAndReserves: QueryLedgerStateTreasuryAndReserves;
    QueryLedgerStateTreasuryAndReservesResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateTreasuryAndReservesResponse;
    QueryLedgerStateUnavailableInCurrentEra?: QueryLedgerStateUnavailableInCurrentEra;
    QueryLedgerStateUtxo: QueryLedgerStateUtxo;
    QueryLedgerStateUtxoResponse:
        | QueryLedgerStateEraMismatch
        | QueryLedgerStateUnavailableInCurrentEra
        | QueryLedgerStateAcquiredExpired
        | QueryLedgerStateUtxoResponse;
    QueryNetworkBlockHeight: QueryNetworkBlockHeight;
    QueryNetworkBlockHeightResponse: QueryNetworkBlockHeightResponse;
    QueryNetworkGenesisConfiguration: QueryNetworkGenesisConfiguration;
    QueryNetworkGenesisConfigurationResponse: QueryNetworkGenesisConfigurationResponse;
    QueryNetworkInvalidGenesis?: QueryNetworkInvalidGenesis;
    QueryNetworkStartTime: QueryNetworkStartTime;
    QueryNetworkStartTimeResponse: QueryNetworkStartTimeResponse;
    QueryNetworkTip: QueryNetworkTip;
    QueryNetworkTipResponse: QueryNetworkTipResponse;
    ReleaseLedgerState: ReleaseLedgerState;
    ReleaseLedgerStateResponse: ReleaseLedgerStateResponse;
    ReleaseMempool: ReleaseMempool;
    ReleaseMempoolResponse: MustAcquireMempoolFirst | ReleaseMempoolResponse;
    RpcError: RpcError;
    SizeOfMempool: SizeOfMempool;
    SizeOfMempoolResponse?: MustAcquireMempoolFirst | SizeOfMempoolResponse;
    SubmitTransaction: SubmitTransaction;
    SubmitTransactionResponse: SubmitTransactionSuccess | SubmitTransactionError | SubmitTransactionDeserialisationError;
}

Properties

AcquireLedgerState AcquireLedgerStateFailure? AcquireLedgerStateResponse AcquireMempool AcquireMempoolResponse EvaluateTransaction EvaluateTransactionResponse FindIntersection FindIntersectionResponse HasTransaction HasTransactionResponse MustAcquireMempoolFirst? NextBlock NextBlockResponse NextTransaction NextTransactionResponse QueryLedgerStateAcquiredExpired? QueryLedgerStateConstitution QueryLedgerStateConstitutionResponse QueryLedgerStateConstitutionalCommittee QueryLedgerStateConstitutionalCommitteeResponse QueryLedgerStateEpoch QueryLedgerStateEpochResponse QueryLedgerStateEraMismatch? QueryLedgerStateEraStart QueryLedgerStateEraStartResponse QueryLedgerStateEraSummaries QueryLedgerStateEraSummariesResponse QueryLedgerStateLiveStakeDistribution QueryLedgerStateLiveStakeDistributionResponse QueryLedgerStateProjectedRewards QueryLedgerStateProjectedRewardsResponse QueryLedgerStateProposedProtocolParameters QueryLedgerStateProposedProtocolParametersResponse QueryLedgerStateProtocolParameters QueryLedgerStateProtocolParametersResponse QueryLedgerStateRewardAccountSummaries QueryLedgerStateRewardAccountSummariesResponse QueryLedgerStateRewardsProvenance QueryLedgerStateRewardsProvenanceResponse QueryLedgerStateStakePools QueryLedgerStateStakePoolsResponse QueryLedgerStateTip QueryLedgerStateTipResponse QueryLedgerStateTreasuryAndReserves QueryLedgerStateTreasuryAndReservesResponse QueryLedgerStateUnavailableInCurrentEra? QueryLedgerStateUtxo QueryLedgerStateUtxoResponse QueryNetworkBlockHeight QueryNetworkBlockHeightResponse QueryNetworkGenesisConfiguration QueryNetworkGenesisConfigurationResponse QueryNetworkInvalidGenesis? QueryNetworkStartTime QueryNetworkStartTimeResponse QueryNetworkTip QueryNetworkTipResponse ReleaseLedgerState ReleaseLedgerStateResponse ReleaseMempool ReleaseMempoolResponse RpcError SizeOfMempool SizeOfMempoolResponse? SubmitTransaction SubmitTransactionResponse

Properties

AcquireLedgerState

AcquireLedgerState: AcquireLedgerState

OptionalAcquireLedgerStateFailure

AcquireLedgerStateFailure?: AcquireLedgerStateFailure

AcquireLedgerStateResponse

AcquireLedgerStateResponse: AcquireLedgerStateFailure | AcquireLedgerStateSuccess

AcquireMempool

AcquireMempool: AcquireMempool

AcquireMempoolResponse

AcquireMempoolResponse: AcquireMempoolResponse

EvaluateTransaction

EvaluateTransaction: EvaluateTransaction

EvaluateTransactionResponse

EvaluateTransactionResponse: EvaluateTransactionSuccess | EvaluateTransactionError | EvaluateTransactionDeserialisationError

FindIntersection

FindIntersection: FindIntersection

FindIntersectionResponse

FindIntersectionResponse: IntersectionFound | IntersectionNotFound | IntersectionInterleaved

HasTransaction

HasTransaction: HasTransaction

HasTransactionResponse

HasTransactionResponse: MustAcquireMempoolFirst | HasTransactionResponse

OptionalMustAcquireMempoolFirst

MustAcquireMempoolFirst?: MustAcquireMempoolFirst

NextBlock

NextBlock: NextBlock

NextBlockResponse

NextBlockResponse: NextBlockResponse

NextTransaction

NextTransaction: NextTransaction

NextTransactionResponse

NextTransactionResponse: MustAcquireMempoolFirst | NextTransactionResponse

OptionalQueryLedgerStateAcquiredExpired

QueryLedgerStateAcquiredExpired?: QueryLedgerStateAcquiredExpired

QueryLedgerStateConstitution

QueryLedgerStateConstitution: QueryLedgerStateConstitution

QueryLedgerStateConstitutionResponse

QueryLedgerStateConstitutionResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateConstitutionResponse

QueryLedgerStateConstitutionalCommittee

QueryLedgerStateConstitutionalCommittee: QueryLedgerStateConstitutionalCommittee

QueryLedgerStateConstitutionalCommitteeResponse

QueryLedgerStateConstitutionalCommitteeResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateConstitutionalCommitteeResponse

QueryLedgerStateEpoch

QueryLedgerStateEpoch: QueryLedgerStateEpoch

QueryLedgerStateEpochResponse

QueryLedgerStateEpochResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateEpochResponse

OptionalQueryLedgerStateEraMismatch

QueryLedgerStateEraMismatch?: QueryLedgerStateEraMismatch

QueryLedgerStateEraStart

QueryLedgerStateEraStart: QueryLedgerStateEraStart

QueryLedgerStateEraStartResponse

QueryLedgerStateEraStartResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateEraStartResponse

QueryLedgerStateEraSummaries

QueryLedgerStateEraSummaries: QueryLedgerStateEraSummaries

QueryLedgerStateEraSummariesResponse

QueryLedgerStateEraSummariesResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateEraSummariesResponse

QueryLedgerStateLiveStakeDistribution

QueryLedgerStateLiveStakeDistribution: QueryLedgerStateLiveStakeDistribution

QueryLedgerStateLiveStakeDistributionResponse

QueryLedgerStateLiveStakeDistributionResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateLiveStakeDistributionResponse

QueryLedgerStateProjectedRewards

QueryLedgerStateProjectedRewards: QueryLedgerStateProjectedRewards

QueryLedgerStateProjectedRewardsResponse

QueryLedgerStateProjectedRewardsResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateProjectedRewardsResponse

QueryLedgerStateProposedProtocolParameters

QueryLedgerStateProposedProtocolParameters: QueryLedgerStateProposedProtocolParameters

QueryLedgerStateProposedProtocolParametersResponse

QueryLedgerStateProposedProtocolParametersResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateProposedProtocolParametersResponse

QueryLedgerStateProtocolParameters

QueryLedgerStateProtocolParameters: QueryLedgerStateProtocolParameters

QueryLedgerStateProtocolParametersResponse

QueryLedgerStateProtocolParametersResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateProtocolParametersResponse

QueryLedgerStateRewardAccountSummaries

QueryLedgerStateRewardAccountSummaries: QueryLedgerStateRewardAccountSummaries

QueryLedgerStateRewardAccountSummariesResponse

QueryLedgerStateRewardAccountSummariesResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateRewardAccountSummariesResponse

QueryLedgerStateRewardsProvenance

QueryLedgerStateRewardsProvenance: QueryLedgerStateRewardsProvenance

QueryLedgerStateRewardsProvenanceResponse

QueryLedgerStateRewardsProvenanceResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateRewardsProvenanceResponse

QueryLedgerStateStakePools

QueryLedgerStateStakePools: QueryLedgerStateStakePools

QueryLedgerStateStakePoolsResponse

QueryLedgerStateStakePoolsResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateStakePoolsResponse

QueryLedgerStateTip

QueryLedgerStateTip: QueryLedgerStateTip

QueryLedgerStateTipResponse

QueryLedgerStateTipResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateTipResponse

QueryLedgerStateTreasuryAndReserves

QueryLedgerStateTreasuryAndReserves: QueryLedgerStateTreasuryAndReserves

QueryLedgerStateTreasuryAndReservesResponse

QueryLedgerStateTreasuryAndReservesResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateTreasuryAndReservesResponse

OptionalQueryLedgerStateUnavailableInCurrentEra

QueryLedgerStateUnavailableInCurrentEra?: QueryLedgerStateUnavailableInCurrentEra

QueryLedgerStateUtxo

QueryLedgerStateUtxo: QueryLedgerStateUtxo

QueryLedgerStateUtxoResponse

QueryLedgerStateUtxoResponse:
    | QueryLedgerStateEraMismatch
    | QueryLedgerStateUnavailableInCurrentEra
    | QueryLedgerStateAcquiredExpired
    | QueryLedgerStateUtxoResponse

QueryNetworkBlockHeight

QueryNetworkBlockHeight: QueryNetworkBlockHeight

QueryNetworkBlockHeightResponse

QueryNetworkBlockHeightResponse: QueryNetworkBlockHeightResponse

QueryNetworkGenesisConfiguration

QueryNetworkGenesisConfiguration: QueryNetworkGenesisConfiguration

QueryNetworkGenesisConfigurationResponse

QueryNetworkGenesisConfigurationResponse: QueryNetworkGenesisConfigurationResponse

OptionalQueryNetworkInvalidGenesis

QueryNetworkInvalidGenesis?: QueryNetworkInvalidGenesis

QueryNetworkStartTime

QueryNetworkStartTime: QueryNetworkStartTime

QueryNetworkStartTimeResponse

QueryNetworkStartTimeResponse: QueryNetworkStartTimeResponse

QueryNetworkTip

QueryNetworkTip: QueryNetworkTip

QueryNetworkTipResponse

QueryNetworkTipResponse: QueryNetworkTipResponse

ReleaseLedgerState

ReleaseLedgerState: ReleaseLedgerState

ReleaseLedgerStateResponse

ReleaseLedgerStateResponse: ReleaseLedgerStateResponse

ReleaseMempool

ReleaseMempool: ReleaseMempool

ReleaseMempoolResponse

ReleaseMempoolResponse: MustAcquireMempoolFirst | ReleaseMempoolResponse

RpcError

RpcError: RpcError

SizeOfMempool

SizeOfMempool: SizeOfMempool

OptionalSizeOfMempoolResponse

SizeOfMempoolResponse?: MustAcquireMempoolFirst | SizeOfMempoolResponse

SubmitTransaction

SubmitTransaction: SubmitTransaction

SubmitTransactionResponse

SubmitTransactionResponse: SubmitTransactionSuccess | SubmitTransactionError | SubmitTransactionDeserialisationError

Settings

Member Visibility

On This Page

Properties
AcquireLedgerStateAcquireLedgerStateFailureAcquireLedgerStateResponseAcquireMempoolAcquireMempoolResponseEvaluateTransactionEvaluateTransactionResponseFindIntersectionFindIntersectionResponseHasTransactionHasTransactionResponseMustAcquireMempoolFirstNextBlockNextBlockResponseNextTransactionNextTransactionResponseQueryLedgerStateAcquiredExpiredQueryLedgerStateConstitutionQueryLedgerStateConstitutionResponseQueryLedgerStateConstitutionalCommitteeQueryLedgerStateConstitutionalCommitteeResponseQueryLedgerStateEpochQueryLedgerStateEpochResponseQueryLedgerStateEraMismatchQueryLedgerStateEraStartQueryLedgerStateEraStartResponseQueryLedgerStateEraSummariesQueryLedgerStateEraSummariesResponseQueryLedgerStateLiveStakeDistributionQueryLedgerStateLiveStakeDistributionResponseQueryLedgerStateProjectedRewardsQueryLedgerStateProjectedRewardsResponseQueryLedgerStateProposedProtocolParametersQueryLedgerStateProposedProtocolParametersResponseQueryLedgerStateProtocolParametersQueryLedgerStateProtocolParametersResponseQueryLedgerStateRewardAccountSummariesQueryLedgerStateRewardAccountSummariesResponseQueryLedgerStateRewardsProvenanceQueryLedgerStateRewardsProvenanceResponseQueryLedgerStateStakePoolsQueryLedgerStateStakePoolsResponseQueryLedgerStateTipQueryLedgerStateTipResponseQueryLedgerStateTreasuryAndReservesQueryLedgerStateTreasuryAndReservesResponseQueryLedgerStateUnavailableInCurrentEraQueryLedgerStateUtxoQueryLedgerStateUtxoResponseQueryNetworkBlockHeightQueryNetworkBlockHeightResponseQueryNetworkGenesisConfigurationQueryNetworkGenesisConfigurationResponseQueryNetworkInvalidGenesisQueryNetworkStartTimeQueryNetworkStartTimeResponseQueryNetworkTipQueryNetworkTipResponseReleaseLedgerStateReleaseLedgerStateResponseReleaseMempoolReleaseMempoolResponseRpcErrorSizeOfMempoolSizeOfMempoolResponseSubmitTransactionSubmitTransactionResponse