- Preparing search index...
- The search index is not available
Hierarchy
- Ogmios
Indexable
Index
Properties
- Acquire
- Acquire
Response - Await
Acquire - Await
Acquire Response - Evaluate
Tx - Evaluate
TxResponse - Fault
- Find
Intersect - Find
Intersect Response - Has
Tx - Has
TxResponse - Next
Tx - Next
TxResponse - Query
- Query
Response[block Height] - Query
Response[chain Tip] - Query
Response[current Epoch] - Query
Response[current Protocol Parameters] - Query
Response[delegations And Rewards] - Query
Response[era Start] - Query
Response[era Summaries] - Query
Response[genesis Config] - Query
Response[ledger Tip] - Query
Response[non Myopic Member Rewards] - Query
Response[pool Ids] - Query
Response[pool Parameters] - Query
Response[pools Ranking] - Query
Response[proposed Protocol Parameters] - Query
Response[rewards Provenance'] - Query
Response[rewards Provenance] - Query
Response[stake Distribution] - Query
Response[system Start] - Query
Response[utxo] - Release
- Release
Mempool - Release
Mempool Response - Release
Response - Request
Next - Request
Next Response - Size
And Capacity - Size
And Capacity Response - Submit
Tx - Submit
TxResponse
Properties
Acquire
Type declaration
-
Optional args?: object
-
point: PointOrOrigin
-
-
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
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"
AwaitAcquire
Acquire a mempool snapshot. This is blocking until a new (i.e different) snapshot is available.
Type declaration
-
Optional args?: object
-
methodname: "AwaitAcquire"
-
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"
AwaitAcquireResponse
Response to a 'AwaitAcquire' request.
Type declaration
-
methodname: "AwaitAcquire"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: AwaitAcquired
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
EvaluateTx
Evaluate execution units for which redeemers's budget hasn't yet been set.
Type declaration
-
Optional args?: object
-
Optional additional
Utxo Set?: Utxo -
evaluate: string
-
-
methodname: "EvaluateTx"
-
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"
EvaluateTxResponse
Type declaration
-
methodname: "EvaluateTx"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EvaluationResult | EvaluationFailure
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
Fault
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
Ask cardano-node to find an intersection between its local chain and the given points.
Type declaration
-
Optional args?: object
-
Optional points?: PointOrOrigin[]
-
-
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
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"
HasTx
Ask whether a given transaction is present in the acquired mempool snapshot.
Type declaration
-
Optional args?: object
-
id: string
-
-
methodname: "HasTx"
-
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"
HasTxResponse
Response to a 'HasTx' request.
Type declaration
-
methodname: "HasTx"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: boolean
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
NextTx
Request the next transaction from an acquired snapshot.
Type declaration
-
Optional args?: object
-
Optional fields?: "all"
-
-
methodname: "NextTx"
-
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"
NextTxResponse
Response to a 'NextTx' request.
Query
Query the ledger / node.
Type declaration
-
Optional args?: object
-
query: "eraStart" | "eraSummaries" | "ledgerTip" | "currentEpoch" | GetNonMyopicMemberRewards | GetDelegationsAndRewards | "currentProtocolParameters" | "proposedProtocolParameters" | "stakeDistribution" | "utxo" | GetUtxoByAddress | GetUtxoByTxIn | GetGenesisConfig | "rewardsProvenance" | "rewardsProvenance'" | "poolsRanking" | "poolIds" | GetPoolParameters | "chainTip" | "blockHeight" | "systemStart"
-
-
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[blockHeight]
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" | BlockNoOrOrigin
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[chainTip]
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"
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[currentEpoch]
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 | EraMismatch | "QueryUnavailableInCurrentEra"
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[currentProtocolParameters]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | ProtocolParametersShelley | ProtocolParametersAlonzo | ProtocolParametersBabbage
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[delegationsAndRewards]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | DelegationsAndRewardsByAccounts
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[eraStart]
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[eraSummaries]
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" | EraSummary[]
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[genesisConfig]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | GenesisByron | GenesisShelley | GenesisAlonzo
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[ledgerTip]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | PointOrOrigin | "QueryUnavailableInCurrentEra"
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[nonMyopicMemberRewards]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | NonMyopicMemberRewards
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[poolIds]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | string[]
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[poolParameters]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | object
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[poolsRanking]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | PoolsRanking
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[proposedProtocolParameters]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | ProposedProtocolParametersShelley | ProposedProtocolParametersAlonzo | ProposedProtocolParametersBabbage
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[rewardsProvenance']
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | RewardsProvenance1
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[rewardsProvenance]
This query is now deprecated. Use /rewardsProvenance'/ instead.
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | RewardsProvenance
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[stakeDistribution]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | "QueryUnavailableInCurrentEra" | PoolDistribution
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[systemStart]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: string
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
QueryResponse[utxo]
Type declaration
-
methodname: "Query"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: EraMismatch | Utxo | "QueryUnavailableInCurrentEra"
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
Release
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"
Optional ReleaseMempool
Release a previously acquired mempool snapshot.
Type declaration
-
Optional args?: object
-
methodname: "ReleaseMempool"
-
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"
Optional ReleaseMempoolResponse
Response to a 'ReleaseMempool' request.
Type declaration
-
methodname: "ReleaseMempool"
-
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"
ReleaseResponse
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
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
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"
SizeAndCapacity
Get size and capacities of the mempool (acquired snapshot).
Type declaration
-
Optional args?: object
-
methodname: "SizeAndCapacity"
-
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"
SizeAndCapacityResponse
Response to a 'SizeAndCapacity' request.
Type declaration
-
methodname: "SizeAndCapacity"
-
Optional reflection?: object
Any value that was set by a client request in the 'mirror' field.
-
[k: string]: unknown
-
-
result: MempoolSizeAndCapacity
-
servicename: "ogmios"
-
type: "jsonwsp/response"
-
version: "1.0"
SubmitTx
Submit a signed and serialized transaction to the network.
Type declaration
-
Optional args?: object
-
submit: string
-
-
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
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"
Acquire a point on chain from which run queries.