Safe Haskell	None
Language	Haskell2010

Cardano.Api.IPC.Version

Contents

Error types

Synopsis

class NodeToClientVersionOf a where
- nodeToClientVersionOf :: a -> NodeToClientVersion
type MinNodeToClientVersion = NodeToClientVersion
data UnsupportedNtcVersionError = UnsupportedNtcVersionError !MinNodeToClientVersion !NodeToClientVersion

Documentation

class NodeToClientVersionOf a where Source #

The query a is a versioned query, which means it requires the Node to support a minimum Node-to-Client version.

Background: The node to client protocol is such that it will disconnect on any unrecognised queries. This means that for a Node-to-Client connection, if a query is sent that was introduced in a Node-to-Client version that is newer than the Node-To-Client version of the connection, the node will disconnect the client. The client will not get any information about why the disconnect happened. This is a bad user experience for tools such as the CLI.

To improve the user experience the API needs to prevent the sending of queries that are newer than the Node-To-Client version of the connection by checking the version of the query before sending it. This affords the ability to return UnsupportedNtcVersionError, informing the caller of a Node-To-Client versioning issue.

For maintaining typeclass instances, see the NodeToClientVersion type documentation for a list of versions and the queries that were introduced for those versions.

Methods

nodeToClientVersionOf :: a -> NodeToClientVersion Source #

Instances

Instances details

NodeToClientVersionOf QueryUTxOFilter Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryUTxOFilter -> NodeToClientVersion Source #
NodeToClientVersionOf (QueryInMode result) Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInMode result -> NodeToClientVersion Source #
NodeToClientVersionOf (QueryInShelleyBasedEra era result) Source #	Mapping for queries in Shelley-based eras returning minimal node-to-client protocol versions. More information about queries versioning can be found: * https://input-output-hk.github.io/ouroboros-network/ouroboros-network/Ouroboros-Network-NodeToClient.html#t:NodeToClientVersion * https://input-output-hk.github.io/ouroboros-consensus/docs/for-developers/QueryVersioning/#implementation
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInShelleyBasedEra era result -> NodeToClientVersion Source #
NodeToClientVersionOf (QueryInEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInEra era result -> NodeToClientVersion Source #

type MinNodeToClientVersion = NodeToClientVersion Source #

Error types

data UnsupportedNtcVersionError Source #

Constructors

UnsupportedNtcVersionError !MinNodeToClientVersion !NodeToClientVersion

Instances

Instances details

Eq UnsupportedNtcVersionError Source #
Instance details Defined in Cardano.Api.IPC.Version Methods (==) :: UnsupportedNtcVersionError -> UnsupportedNtcVersionError -> Bool Source # (/=) :: UnsupportedNtcVersionError -> UnsupportedNtcVersionError -> Bool Source #
Show UnsupportedNtcVersionError Source #
Instance details Defined in Cardano.Api.IPC.Version Methods showsPrec :: Int -> UnsupportedNtcVersionError -> ShowS Source # show :: UnsupportedNtcVersionError -> String Source # showList :: [UnsupportedNtcVersionError] -> ShowS Source #