Class Ogmios

url

acquireLedgerState

• acquireLedgerState(point): Promise<{
      acquired: "ledgerState";
      point: PointOrOrigin;
  }>

• Parameters

  • point: PointOrOrigin

  Returns Promise<{
      acquired: "ledgerState";
      point: PointOrOrigin;
  }>

acquireMempool

• acquireMempool(): Promise<{
      acquired: "mempool";
      slot: number;
  }>

• Returns Promise<{
      acquired: "mempool";
      slot: number;
  }>

connect

• connect(): WebSocket

• Returns WebSocket

evaluateTransaction

• evaluateTransaction(transaction, additionalUtxos?): Promise<{
      budget: ExecutionUnits;
      validator: RedeemerPointer;
  }[]>

• Parameters

  • transaction: {
        cbor: string;
    }

    • cbor: string

  • OptionaladditionalUtxos: Utxo

  Returns Promise<{
      budget: ExecutionUnits;
      validator: RedeemerPointer;
  }[]>

findIntersection

• findIntersection(points?): Promise<{
      intersection: PointOrOrigin;
      tip: TipOrOrigin;
  }>

• Parameters

  • Optionalpoints: PointOrOrigin[]

  Returns Promise<{
      intersection: PointOrOrigin;
      tip: TipOrOrigin;
  }>

hasTransaction

• hasTransaction(params): Promise<boolean>

• Parameters

  • params: {
        id: string;
    }

    • id: string

  Returns Promise<boolean>

kill

• kill(): Promise<void>

• Returns Promise<void>

nextBlock

• nextBlock(): Promise<RollForward | RollBackward>

• Returns Promise<RollForward | RollBackward>

nextTransaction

• nextTransaction(params?): Promise<{
      transaction: Schema.Transaction | {
          id: string;
      };
  }>

• Parameters

  • Optionalparams: {
        fields?: "all";
    }

    • Optionalfields?: "all"

  Returns Promise<{
      transaction: Schema.Transaction | {
          id: string;
      };
  }>

queryLedgerStateConstitution

• queryLedgerStateConstitution(): Promise<Constitution>

• Returns Promise<Constitution>

queryLedgerStateConstitutionalCommittee

• queryLedgerStateConstitutionalCommittee(): Promise<{
      members: ConstitutionalCommitteeMember[];
      quorum: string;
  }>

• Returns Promise<{
      members: ConstitutionalCommitteeMember[];
      quorum: string;
  }>

queryLedgerStateEpoch

• queryLedgerStateEpoch(): Promise<number>

• Returns Promise<number>

queryLedgerStateEraStart

• queryLedgerStateEraStart(): Promise<Bound>

• Returns Promise<Bound>

queryLedgerStateEraSummaries

• queryLedgerStateEraSummaries(): Promise<EraSummary[]>

• Returns Promise<EraSummary[]>

queryLedgerStateLiveStakeDistribution

• queryLedgerStateLiveStakeDistribution(): Promise<LiveStakeDistribution>

• Returns Promise<LiveStakeDistribution>

queryLedgerStateProjectedRewards

• queryLedgerStateProjectedRewards(params): Promise<ProjectedRewards>

• Parameters

  • params: {
        keys?: string[];
        scripts?: string[];
        stake?: ValueAdaOnly[];
    }

    • Optionalkeys?: string[]

    • Optionalscripts?: string[]

    • Optionalstake?: ValueAdaOnly[]

  Returns Promise<ProjectedRewards>

queryLedgerStateProposedProtocolParameters

• queryLedgerStateProposedProtocolParameters(): Promise<ProposedProtocolParameters[]>

• Returns Promise<ProposedProtocolParameters[]>

queryLedgerStateProtocolParameters

• queryLedgerStateProtocolParameters(): Promise<Schema.ProtocolParameters>

• Returns Promise<Schema.ProtocolParameters>

queryLedgerStateRewardAccountSummaries

• queryLedgerStateRewardAccountSummaries(params): Promise<RewardAccountSummaries>

• Parameters

  • params: {
        keys?: string[];
        scripts?: string[];
    }

    • Optionalkeys?: string[]

    • Optionalscripts?: string[]

  Returns Promise<RewardAccountSummaries>

queryLedgerStateRewardsProvenance

• queryLedgerStateRewardsProvenance(): Promise<RewardsProvenance>

• Returns Promise<RewardsProvenance>

queryLedgerStateStakePools

• queryLedgerStateStakePools(params?): Promise<{
      [k: string]: StakePool;
  }>

• Parameters

  • Optionalparams: {
        stakePools: {
            id: string;
        }[];
    }

    • stakePools: {
          id: string;
      }[]

  Returns Promise<{
      [k: string]: StakePool;
  }>

queryLedgerStateTip

• queryLedgerStateTip(): Promise<PointOrOrigin>

• Returns Promise<PointOrOrigin>

queryLedgerStateTreasuryAndReserves

• queryLedgerStateTreasuryAndReserves(): Promise<{
      reserves: ValueAdaOnly;
      treasury: ValueAdaOnly;
  }>

• Returns Promise<{
      reserves: ValueAdaOnly;
      treasury: ValueAdaOnly;
  }>

queryLedgerStateUtxo

• queryLedgerStateUtxo(params?): Promise<Utxo>

• Parameters

  • Optionalparams: UtxoByOutputReferences | UtxoByAddresses | WholeUtxo

  Returns Promise<Utxo>

queryNetworkBlockHeight

• queryNetworkBlockHeight(): Promise<number | "origin">

• Returns Promise<number | "origin">

queryNetworkGenesisConfiguration

• queryNetworkGenesisConfiguration(params): Promise<
      | QueryNetworkInvalidGenesis
      | GenesisByron
      | GenesisShelley
      | GenesisAlonzo
      | GenesisConway>

• Parameters

  • params: {
        era: EraWithGenesis;
    }

    • era: EraWithGenesis

  Returns Promise<
      | QueryNetworkInvalidGenesis
      | GenesisByron
      | GenesisShelley
      | GenesisAlonzo
      | GenesisConway>

queryNetworkStartTime

• queryNetworkStartTime(): Promise<string>

• Returns Promise<string>

queryNetworkTip

• queryNetworkTip(): Promise<PointOrOrigin>

• Returns Promise<PointOrOrigin>

releaseLedgerState

• releaseLedgerState(): Promise<{
      released: "ledgerState";
  }>

• Returns Promise<{
      released: "ledgerState";
  }>

releaseMempool

• releaseMempool(): Promise<{
      released: "mempool";
  }>

• Returns Promise<{
      released: "mempool";
  }>

request

• request<T, R>(method, params): Promise<Extract<R, "result">>

• Type Parameters

  • T extends {
        params: object;
    }
  • R extends {
        result: any;
    } | {
        error: object;
    }

  Parameters

  • method: string
  • params: T["params"]

  Returns Promise<Extract<R, "result">>

sizeOfMempool

• sizeOfMempool(): Promise<MempoolSizeAndCapacity>

• Returns Promise<MempoolSizeAndCapacity>

submitTransaction

• submitTransaction(transaction): Promise<{
      transaction: {
          id: string;
      };
  }>

• Parameters

  • transaction: {
        cbor: string;
    }

    • cbor: string

  Returns Promise<{
      transaction: {
          id: string;
      };
  }>

StaticfromDemeter

• fromDemeter(network, apiKey, region): Promise<Unwrapped.Ogmios>

• Parameters

  • network: "mainnet" | "preview"
  • apiKey: `dmtr_ogmios${string}`
  • region: "ogmios-m1"

  Returns Promise<Unwrapped.Ogmios>

Staticnew

• new(url): Promise<Unwrapped.Ogmios>

• Parameters

  • url: string

  Returns Promise<Unwrapped.Ogmios>