Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Ledger.Query

Synopsis

data family BlockQuery blk ∷ Type → Type
class (ShowQuery (BlockQuery blk), SameDepIndex (BlockQuery blk)) ⇒ BlockSupportsLedgerQuery blk where
- answerBlockQuery ∷ ExtLedgerCfg blk → BlockQuery blk result → ExtLedgerState blk → result
class ConfigSupportsNode blk where
- getSystemStart ∷ BlockConfig blk → SystemStart
- getNetworkMagic ∷ BlockConfig blk → NetworkMagic
data Query blk result where
- BlockQuery ∷ BlockQuery blk result → Query blk result
- GetSystemStart ∷ Query blk SystemStart
- GetChainBlockNo ∷ Query blk (WithOrigin BlockNo)
- GetChainPoint ∷ Query blk (Point blk)
data QueryVersion
- = QueryVersion1
- | QueryVersion2
class (∀ result. Show (query result)) ⇒ ShowQuery (query ∷ Type → Type) where
- showResult ∷ query result → result → String
answerQuery ∷ (BlockSupportsLedgerQuery blk, ConfigSupportsNode blk, HasAnnTip blk) ⇒ ExtLedgerCfg blk → Query blk result → ExtLedgerState blk → result
nodeToClientVersionToQueryVersion ∷ NodeToClientVersion → QueryVersion
queryDecodeNodeToClient ∷ ∀ blk. SerialiseNodeToClient blk (SomeSecond BlockQuery blk) ⇒ CodecConfig blk → QueryVersion → BlockNodeToClientVersion blk → ∀ s. Decoder s (SomeSecond Query blk)
queryEncodeNodeToClient ∷ ∀ blk. Typeable blk ⇒ Show (SomeSecond BlockQuery blk) ⇒ SerialiseNodeToClient blk (SomeSecond BlockQuery blk) ⇒ CodecConfig blk → QueryVersion → BlockNodeToClientVersion blk → SomeSecond Query blk → Encoding

Documentation

data family BlockQuery blk ∷ Type → Type Source #

Different queries supported by the ledger, indexed by the result type.

Instances

Instances details

All SingleEraBlock xs ⇒ SameDepIndex (BlockQuery (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods sameDepIndex ∷ BlockQuery (HardForkBlock xs) a → BlockQuery (HardForkBlock xs) b → Maybe (a :~: b) Source #
SameDepIndex (BlockQuery (DualBlock m a)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods sameDepIndex ∷ BlockQuery (DualBlock m a) a0 → BlockQuery (DualBlock m a) b → Maybe (a0 :~: b) Source #
All SingleEraBlock xs ⇒ ShowQuery (BlockQuery (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showResult ∷ BlockQuery (HardForkBlock xs) result → result → String Source #
ShowQuery (BlockQuery (DualBlock m a)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods showResult ∷ BlockQuery (DualBlock m a) result → result → String Source #
SerialiseHFC xs ⇒ SerialiseResult (HardForkBlock xs) (BlockQuery (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeResult ∷ CodecConfig (HardForkBlock xs) → BlockNodeToClientVersion (HardForkBlock xs) → BlockQuery (HardForkBlock xs) result → result → Encoding Source # decodeResult ∷ CodecConfig (HardForkBlock xs) → BlockNodeToClientVersion (HardForkBlock xs) → BlockQuery (HardForkBlock xs) result → ∀ s. Decoder s result Source #
SerialiseHFC xs ⇒ SerialiseNodeToClient (HardForkBlock xs) (SomeSecond BlockQuery (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient ∷ CodecConfig (HardForkBlock xs) → BlockNodeToClientVersion (HardForkBlock xs) → SomeSecond BlockQuery (HardForkBlock xs) → Encoding Source # decodeNodeToClient ∷ CodecConfig (HardForkBlock xs) → BlockNodeToClientVersion (HardForkBlock xs) → ∀ s. Decoder s (SomeSecond BlockQuery (HardForkBlock xs)) Source #
All SingleEraBlock xs ⇒ Show (BlockQuery (HardForkBlock xs) result) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showsPrec ∷ Int → BlockQuery (HardForkBlock xs) result → ShowS # show ∷ BlockQuery (HardForkBlock xs) result → String # showList ∷ [BlockQuery (HardForkBlock xs) result] → ShowS #
Show (BlockQuery (DualBlock m a) result) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods showsPrec ∷ Int → BlockQuery (DualBlock m a) result → ShowS # show ∷ BlockQuery (DualBlock m a) result → String # showList ∷ [BlockQuery (DualBlock m a) result] → ShowS #
Typeable xs ⇒ ShowProxy (BlockQuery (HardForkBlock xs) ∷ Type → Type) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showProxy ∷ Proxy (BlockQuery (HardForkBlock xs)) → String Source #
(Typeable m, Typeable a) ⇒ ShowProxy (BlockQuery (DualBlock m a) ∷ Type → Type) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods showProxy ∷ Proxy (BlockQuery (DualBlock m a)) → String Source #
Inject (SomeSecond BlockQuery) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary Methods inject ∷ ∀ x (xs ∷ [Type]). CanHardFork xs ⇒ Exactly xs Bound → Index xs x → SomeSecond BlockQuery x → SomeSecond BlockQuery (HardForkBlock xs) Source #
(∀ result. Show (BlockQuery blk result)) ⇒ Show (SomeSecond BlockQuery blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showsPrec ∷ Int → SomeSecond BlockQuery blk → ShowS # show ∷ SomeSecond BlockQuery blk → String # showList ∷ [SomeSecond BlockQuery blk] → ShowS #
SameDepIndex (BlockQuery blk) ⇒ Eq (SomeSecond BlockQuery blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods (==) ∷ SomeSecond BlockQuery blk → SomeSecond BlockQuery blk → Bool # (/=) ∷ SomeSecond BlockQuery blk → SomeSecond BlockQuery blk → Bool #
data BlockQuery (HardForkBlock xs) a Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query data BlockQuery (HardForkBlock xs) a where QueryIfCurrent ∷ ∀ (xs ∷ [Type]) result. QueryIfCurrent xs result → BlockQuery (HardForkBlock xs) (Either (MismatchEraInfo xs) result) QueryAnytime ∷ ∀ (xs1 ∷ [Type]) a x. IsNonEmpty xs1 ⇒ QueryAnytime a → EraIndex (x ': xs1) → BlockQuery (HardForkBlock (x ': xs1)) a QueryHardFork ∷ ∀ (xs1 ∷ [Type]) x a. IsNonEmpty xs1 ⇒ QueryHardFork (x ': xs1) a → BlockQuery (HardForkBlock (x ': xs1)) a
data BlockQuery (DualBlock m a) result Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual data BlockQuery (DualBlock m a) result

class (ShowQuery (BlockQuery blk), SameDepIndex (BlockQuery blk)) ⇒ BlockSupportsLedgerQuery blk where Source #

Query the ledger extended state.

Used by the LocalStateQuery protocol to allow clients to query the extended ledger state.

Methods

answerBlockQuery ∷ ExtLedgerCfg blk → BlockQuery blk result → ExtLedgerState blk → result Source #

Answer the given query about the extended ledger state.

Instances

Instances details

All SingleEraBlock xs ⇒ BlockSupportsLedgerQuery (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods answerBlockQuery ∷ ExtLedgerCfg (HardForkBlock xs) → BlockQuery (HardForkBlock xs) result → ExtLedgerState (HardForkBlock xs) → result Source #
Bridge m a ⇒ BlockSupportsLedgerQuery (DualBlock m a) Source #	Not used in the tests: no constructors
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods answerBlockQuery ∷ ExtLedgerCfg (DualBlock m a) → BlockQuery (DualBlock m a) result → ExtLedgerState (DualBlock m a) → result Source #

class ConfigSupportsNode blk where Source #

The BlockConfig needs to contain some information in order to support running a node.

Methods

getSystemStart ∷ BlockConfig blk → SystemStart Source #

getNetworkMagic ∷ BlockConfig blk → NetworkMagic Source #

Instances

Instances details

CanHardFork xs ⇒ ConfigSupportsNode (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Node Methods getSystemStart ∷ BlockConfig (HardForkBlock xs) → SystemStart Source # getNetworkMagic ∷ BlockConfig (HardForkBlock xs) → NetworkMagic Source #
ConfigSupportsNode m ⇒ ConfigSupportsNode (DualBlock m a) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods getSystemStart ∷ BlockConfig (DualBlock m a) → SystemStart Source # getNetworkMagic ∷ BlockConfig (DualBlock m a) → NetworkMagic Source #

data Query blk result where Source #

Different queries supported by the ledger for all block types, indexed by the result type.

Additions to the set of queries is versioned by QueryVersion

Constructors

BlockQuery ∷ BlockQuery blk result → Query blk result	This constructor is supported by all `QueryVersion`s. The `BlockQuery` argument is versioned by the `BlockNodeToClientVersion blk`.
GetSystemStart ∷ Query blk SystemStart	Get the `SystemStart` time. Supported by `QueryVersion` >= `QueryVersion1`.
GetChainBlockNo ∷ Query blk (WithOrigin BlockNo)	Get the `GetChainBlockNo` time. Supported by `QueryVersion` >= `QueryVersion2`.
GetChainPoint ∷ Query blk (Point blk)	Get the `GetChainPoint` time. Supported by `QueryVersion` >= `QueryVersion2`.

Instances

Instances details

(SerialiseResult blk (BlockQuery blk), Serialise (HeaderHash blk)) ⇒ SerialiseResult blk (Query blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods encodeResult ∷ CodecConfig blk → BlockNodeToClientVersion blk → Query blk result → result → Encoding Source # decodeResult ∷ CodecConfig blk → BlockNodeToClientVersion blk → Query blk result → ∀ s. Decoder s result Source #
SameDepIndex (BlockQuery blk) ⇒ SameDepIndex (Query blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods sameDepIndex ∷ Query blk a → Query blk b → Maybe (a :~: b) Source #
(ShowQuery (BlockQuery blk), StandardHash blk) ⇒ ShowQuery (Query blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showResult ∷ Query blk result → result → String Source #
Show (BlockQuery blk result) ⇒ Show (Query blk result) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showsPrec ∷ Int → Query blk result → ShowS # show ∷ Query blk result → String # showList ∷ [Query blk result] → ShowS #
ShowProxy (BlockQuery blk) ⇒ ShowProxy (Query blk ∷ Type → Type) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showProxy ∷ Proxy (Query blk) → String Source #
Show (SomeSecond BlockQuery blk) ⇒ Show (SomeSecond Query blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showsPrec ∷ Int → SomeSecond Query blk → ShowS # show ∷ SomeSecond Query blk → String # showList ∷ [SomeSecond Query blk] → ShowS #
Eq (SomeSecond BlockQuery blk) ⇒ Eq (SomeSecond Query blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods (==) ∷ SomeSecond Query blk → SomeSecond Query blk → Bool # (/=) ∷ SomeSecond Query blk → SomeSecond Query blk → Bool #

data QueryVersion Source #

Version of the `Query blk` type.

Multiple top level queries are now supported. The encoding now has constructor tags for the different top level queries for QueryVersion1 onwards.

Constructors

QueryVersion1
QueryVersion2

Instances

Instances details

Bounded QueryVersion Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query.Version Methods minBound ∷ QueryVersion # maxBound ∷ QueryVersion #
Enum QueryVersion Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query.Version Methods succ ∷ QueryVersion → QueryVersion # pred ∷ QueryVersion → QueryVersion # toEnum ∷ Int → QueryVersion # fromEnum ∷ QueryVersion → Int # enumFrom ∷ QueryVersion → [QueryVersion] # enumFromThen ∷ QueryVersion → QueryVersion → [QueryVersion] # enumFromTo ∷ QueryVersion → QueryVersion → [QueryVersion] # enumFromThenTo ∷ QueryVersion → QueryVersion → QueryVersion → [QueryVersion] #
Show QueryVersion Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query.Version Methods showsPrec ∷ Int → QueryVersion → ShowS # show ∷ QueryVersion → String # showList ∷ [QueryVersion] → ShowS #
Eq QueryVersion Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query.Version Methods (==) ∷ QueryVersion → QueryVersion → Bool # (/=) ∷ QueryVersion → QueryVersion → Bool #
Ord QueryVersion Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query.Version Methods compare ∷ QueryVersion → QueryVersion → Ordering # (<) ∷ QueryVersion → QueryVersion → Bool # (<=) ∷ QueryVersion → QueryVersion → Bool # (>) ∷ QueryVersion → QueryVersion → Bool # (>=) ∷ QueryVersion → QueryVersion → Bool # max ∷ QueryVersion → QueryVersion → QueryVersion # min ∷ QueryVersion → QueryVersion → QueryVersion #

class (∀ result. Show (query result)) ⇒ ShowQuery (query ∷ Type → Type) where Source #

To implement Show for:

('Message' ('LocalStateQuery' block query) st st')

we need a way to print the query GADT and its type index, result. This class contain the method we need to provide this Show instance.

We use a type class for this, as this Show constraint propagates to a lot of places.

Methods

showResult ∷ query result → result → String Source #

Instances

Instances details

ShowQuery QueryAnytime Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showResult ∷ QueryAnytime result → result → String Source #
All SingleEraBlock xs ⇒ ShowQuery (QueryHardFork xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showResult ∷ QueryHardFork xs result → result → String Source #
All SingleEraBlock xs ⇒ ShowQuery (QueryIfCurrent xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showResult ∷ QueryIfCurrent xs result → result → String Source #
All SingleEraBlock xs ⇒ ShowQuery (BlockQuery (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query Methods showResult ∷ BlockQuery (HardForkBlock xs) result → result → String Source #
ShowQuery (BlockQuery (DualBlock m a)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods showResult ∷ BlockQuery (DualBlock m a) result → result → String Source #
(ShowQuery (BlockQuery blk), StandardHash blk) ⇒ ShowQuery (Query blk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showResult ∷ Query blk result → result → String Source #

answerQuery ∷ (BlockSupportsLedgerQuery blk, ConfigSupportsNode blk, HasAnnTip blk) ⇒ ExtLedgerCfg blk → Query blk result → ExtLedgerState blk → result Source #

Answer the given query about the extended ledger state.

nodeToClientVersionToQueryVersion ∷ NodeToClientVersion → QueryVersion Source #

Get the QueryVersion supported by this NodeToClientVersion.

queryDecodeNodeToClient ∷ ∀ blk. SerialiseNodeToClient blk (SomeSecond BlockQuery blk) ⇒ CodecConfig blk → QueryVersion → BlockNodeToClientVersion blk → ∀ s. Decoder s (SomeSecond Query blk) Source #

queryEncodeNodeToClient ∷ ∀ blk. Typeable blk ⇒ Show (SomeSecond BlockQuery blk) ⇒ SerialiseNodeToClient blk (SomeSecond BlockQuery blk) ⇒ CodecConfig blk → QueryVersion → BlockNodeToClientVersion blk → SomeSecond Query blk → Encoding Source #