Hierarchy

  • Ogmios

Indexable

[k: string]: unknown

Index

Properties

Acquire

Acquire: object

Acquire a point on chain from which run queries.

Type declaration

  • Optional args?: object
  • methodname: "Acquire"
  • Optional mirror?: object

    An arbitrary JSON value that will be mirrored back in the response.

    • [k: string]: unknown
  • servicename: "ogmios"
  • type: "jsonwsp/request"
  • version: "1.0"

AcquireResponse

AcquireResponse: object

Response to an 'Acquire' request.

Type declaration

  • methodname: "Acquire"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: AcquireSuccess | AcquireFailure
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

Fault

Fault: object

A fault in the JSON-WSP protocol. This is returned by the server when a request from clients is deemed invalid or, when the server was unable to reply to a well-formed request.

Type declaration

  • fault: object
    • code: "incompatible" | "server" | "client"

      An error code telling about the nature of the fault.

    • string: string

      A descriptive error message giving hints about the fault.

  • servicename: "ogmios"
  • type: "jsonwsp/fault"
  • version: "1.0"

FindIntersect

FindIntersect: object

Ask cardano-node to find an intersection between its local chain and the given points.

Type declaration

  • Optional args?: object
  • methodname: "FindIntersect"
  • Optional mirror?: object

    An arbitrary JSON value that will be mirrored back in the response.

    • [k: string]: unknown
  • servicename: "ogmios"
  • type: "jsonwsp/request"
  • version: "1.0"

FindIntersectResponse

FindIntersectResponse: object

Type declaration

  • methodname: "FindIntersect"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: IntersectionFound | IntersectionNotFound

    Intersection found if any, alongside the cardano-node's current tip.

  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

Query

Query: object

Query the current ledger tip.

Type declaration

  • Optional args?: object
  • methodname: "Query"
  • Optional mirror?: object

    An arbitrary JSON value that will be mirrored back in the response.

    • [k: string]: unknown
  • servicename: "ogmios"
  • type: "jsonwsp/request"
  • version: "1.0"

QueryResponse[currentEpoch]

QueryResponse[currentEpoch]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: number | "QueryUnavailableInCurrentEra" | EraMismatch
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[currentProtocolParameters]

QueryResponse[currentProtocolParameters]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | ProtocolParametersShelley | ProtocolParametersAlonzo
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[delegationsAndRewards]

QueryResponse[delegationsAndRewards]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | DelegationsAndRewardsByAccounts
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[eraStart]

QueryResponse[eraStart]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: Bound | "QueryUnavailableInCurrentEra"
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[genesisConfig]

QueryResponse[genesisConfig]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | CompactGenesis
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[ledgerTip]

QueryResponse[ledgerTip]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: PointOrOrigin | "QueryUnavailableInCurrentEra" | EraMismatch
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[nonMyopicMemberRewards]

QueryResponse[nonMyopicMemberRewards]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | NonMyopicMemberRewards
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[poolIds]

QueryResponse[poolIds]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | string[]
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[poolParameters]

QueryResponse[poolParameters]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | object
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[poolsRanking]

QueryResponse[poolsRanking]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | PoolsRanking
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[proposedProtocolParameters]

QueryResponse[proposedProtocolParameters]: object

Type declaration

QueryResponse[rewardsProvenance]

QueryResponse[rewardsProvenance]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | RewardsProvenance
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[stakeDistribution]

QueryResponse[stakeDistribution]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | PoolDistribution
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

QueryResponse[utxo]

QueryResponse[utxo]: object

Type declaration

  • methodname: "Query"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "QueryUnavailableInCurrentEra" | EraMismatch | Utxo
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

Release

Release: object

Release a point on chain previously acquired.

Type declaration

  • Optional args?: object
  • methodname: "Release"
  • Optional mirror?: object

    An arbitrary JSON value that will be mirrored back in the response.

    • [k: string]: unknown
  • servicename: "ogmios"
  • type: "jsonwsp/request"
  • version: "1.0"

ReleaseResponse

ReleaseResponse: object

Response to a 'Release' request.

Type declaration

  • methodname: "Release"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "Released"
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

RequestNext

RequestNext: object

Request next block from the current cardano-node's cursor.

Type declaration

  • Optional args?: object
  • methodname: "RequestNext"
  • Optional mirror?: object

    An arbitrary JSON value that will be mirrored back in the response.

    • [k: string]: unknown
  • servicename: "ogmios"
  • type: "jsonwsp/request"
  • version: "1.0"

RequestNextResponse

RequestNextResponse: object

Request next block from the current cardano-node's cursor.

Type declaration

  • methodname: "RequestNext"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: RollForward | RollBackward
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"

SubmitTx

SubmitTx: object

Submit a signed and serialized Utxo transaction to the network.

Type declaration

  • Optional args?: object
    • bytes: string

      CBOR-serialized signed transaction, in base64

  • methodname: "SubmitTx"
  • Optional mirror?: object

    An arbitrary JSON value that will be mirrored back in the response.

    • [k: string]: unknown
  • servicename: "ogmios"
  • type: "jsonwsp/request"
  • version: "1.0"

SubmitTxResponse

SubmitTxResponse: object

Type declaration

  • methodname: "SubmitTx"
  • Optional reflection?: object

    Any value that was set by a client request in the 'mirror' field.

    • [k: string]: unknown
  • result: "SubmitSuccess" | SubmitFail
  • servicename: "ogmios"
  • type: "jsonwsp/response"
  • version: "1.0"