Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Ledger.Query

5 types
3 classes
6 values

Packageouroboros-consensus-4.2.1.0
Exports15
LicenceApache-2.0

valueanswerQuery

:: (BlockSupportsLedgerQuery blk, ConfigSupportsNode blk, HasAnnTip blk, MonadSTM m)
=> ExtLedgerCfg blk
-> ReadOnlyForker' m blk
-> Query blk result
-> m result

valuequeryDecodeNodeToClient

:: SerialiseNodeToClient blk (SomeBlockQuery (BlockQuery blk))
=> CodecConfig blk
-> QueryVersion
-> BlockNodeToClientVersion blk
-> forall s. Decoder s (SomeSecond Query blk)

valuequeryEncodeNodeToClient

:: (SerialiseNodeToClient blk (SomeBlockQuery (BlockQuery blk)), Show (SomeSecond Query blk), BlockSupportsLedgerQuery blk, Show (BlockNodeToClientVersion blk), Typeable blk)
=> CodecConfig blk
-> QueryVersion
-> BlockNodeToClientVersion blk
-> SomeSecond Query blk
-> Encoding

valuequeryIsSupportedOnNodeToClientVersion

:: (SupportedNetworkProtocolVersion blk, BlockSupportsLedgerQuery blk)
=> Query blk result
-> NodeToClientVersion
-> Bool

valuequerySupportedVersions

:: (SupportedNetworkProtocolVersion blk, BlockSupportsLedgerQuery blk)
=> Query blk result
-> [NodeToClientVersion]

valuenodeToClientVersionToQueryVersion :: NodeToClientVersion -> QueryVersion

classclass ConfigSupportsNode blk where

Methods

getSystemStart :: BlockConfig blk -> SystemStart
getNetworkMagic :: BlockConfig blk -> NetworkMagic

Instances2ConfigSupportsNode

CanHardFork xs => ConfigSupportsNode (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Node · orphan
ConfigSupportsNode m => ConfigSupportsNode (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

data familydata family BlockQuery :: Type -> QueryFootprint -> Type -> Type

Instances14SameDepIndex2, SerialiseBlockQueryResult, SerialiseNodeToClient, ShowQuery, ShowProxy, Show, …

SameDepIndex2 (BlockQuery (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
All SingleEraBlock xs => SameDepIndex2 (BlockQuery (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
SerialiseHFC xs => SerialiseBlockQueryResult (HardForkBlock xs) BlockQueryDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient · orphan
(forall (footprint :: QueryFootprint) result. Show (BlockQuery blk footprint result)) => Show (SomeBlockQuery (BlockQuery blk))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (SomeBlockQuery (BlockQuery (HardForkBlock xs)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient · orphan
ShowQuery (BlockQuery (DualBlock m a) footprint)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
All SingleEraBlock xs => ShowQuery (BlockQuery (HardForkBlock xs) footprint)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
Typeable xs => ShowProxy (BlockQuery (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
(Typeable m, Typeable a) => ShowProxy (BlockQuery (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
Show (BlockQuery (DualBlock m a) footprint result)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
All SingleEraBlock xs => Show (BlockQuery (HardForkBlock xs) footprint result)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
Inject (SomeBlockQuery :.: BlockQuery)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Nary
data BlockQuery (HardForkBlock xs)
- QueryIfCurrent :: QueryIfCurrent xs footprint result1 -> R:BlockQueryHardForkBlockfootprintresult xs footprint (Either (MismatchEraInfo xs) result1)
- QueryAnytime :: IsNonEmpty xs1 => QueryAnytime result -> EraIndex (x ': xs1) -> R:BlockQueryHardForkBlockfootprintresult (x ': xs1) 'QFNoTables result
- QueryHardFork :: IsNonEmpty xs1 => QueryHardFork (x ': xs1) result -> R:BlockQueryHardForkBlockfootprintresult (x ': xs1) 'QFNoTables result
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
data BlockQuery (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

class

class (forall (fp :: QueryFootprint) result. Show (BlockQuery blk fp result), forall (fp :: QueryFootprint). ShowQuery (BlockQuery blk fp), SameDepIndex2 (BlockQuery blk)) => BlockSupportsLedgerQuery blk where

Methods

answerPureBlockQuery :: ExtLedgerCfg blk -> BlockQuery blk 'QFNoTables result -> ExtLedgerState blk EmptyMK -> result
answerBlockQueryLookup :: MonadSTM m => ExtLedgerCfg blk -> BlockQuery blk 'QFLookupTables result -> ReadOnlyForker' m blk -> m result
answerBlockQueryTraverse :: MonadSTM m => ExtLedgerCfg blk -> BlockQuery blk 'QFTraverseTables result -> ReadOnlyForker' m blk -> m result
blockQueryIsSupportedOnVersion :: BlockQuery blk fp result -> BlockNodeToClientVersion blk -> Bool

Instances2BlockSupportsLedgerQuery

(All SingleEraBlock xs, BlockSupportsHFLedgerQuery xs, All BlockSupportsLedgerQuery xs, CanHardFork xs) => BlockSupportsLedgerQuery (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
Bridge m a => BlockSupportsLedgerQuery (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

datadata Query blk result where

Constructors

BlockQuery :: SingI footprint => BlockQuery blk footprint result -> Query blk result
GetSystemStart :: Query blk SystemStart
GetChainBlockNo :: Query blk (WithOrigin BlockNo)
GetChainPoint :: Query blk (Point blk)
DebugLedgerConfig :: Query blk (LedgerCfg LedgerState blk)

Instances7SerialiseResult, SameDepIndex, ShowQuery, ShowProxy, Eq, Show, …

(SerialiseBlockQueryResult blk BlockQuery, Serialise (HeaderHash blk), SerialiseNodeToClient blk (LedgerConfig blk)) => SerialiseResult blk QueryDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SameDepIndex2 (BlockQuery blk) => SameDepIndex (Query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
(forall (footprint :: QueryFootprint). ShowQuery (BlockQuery blk footprint), StandardHash blk) => ShowQuery (Query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
(forall (footprint :: QueryFootprint). Show (BlockQuery blk footprint result)) => Show (Query blk result)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
ShowProxy (BlockQuery blk) => ShowProxy (Query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SameDepIndex (Query blk) => Eq (SomeSecond Query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
Show (SomeBlockQuery (BlockQuery blk)) => Show (SomeSecond Query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query

datadata QueryFootprint

QFNoTables QFLookupTables QFTraverseTables

Instances12SingI, SameDepIndex2, SerialiseBlockQueryResult, SerialiseNodeToClient, ShowProxy, Inject, …

SingI 'QFLookupTablesDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SingI 'QFNoTablesDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SingI 'QFTraverseTablesDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SameDepIndex2 (BlockQuery (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
All SingleEraBlock xs => SameDepIndex2 (QueryIfCurrent xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query
All SingleEraBlock xs => SameDepIndex2 (BlockQuery (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
SerialiseHFC xs => SerialiseBlockQueryResult (HardForkBlock xs) BlockQueryDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient · orphan
SerialiseNodeToClient blk (SomeBlockQuery (query blk)) => SerialiseNodeToClient blk ((:.:) SomeBlockQuery query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
Typeable xs => ShowProxy (BlockQuery (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan
(Typeable m, Typeable a) => ShowProxy (BlockQuery (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
Inject (SomeBlockQuery :.: BlockQuery)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Nary
type Sing = SQueryFootprintDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query

datadata SQueryFootprint (a :: QueryFootprint) where

Constructors

SQFNoTables :: SQueryFootprint 'QFNoTables
SQFLookupTables :: SQueryFootprint 'QFLookupTables
SQFTraverseTables :: SQueryFootprint 'QFTraverseTables

datadata SomeBlockQuery (q :: QueryFootprint -> Type -> Type)

Constructors

forall footprint result. SingI footprint => SomeBlockQuery !(q footprint result)

Instances5Eq, Show, SerialiseNodeToClient, Inject

SerialiseNodeToClient blk (SomeBlockQuery (query blk)) => SerialiseNodeToClient blk ((:.:) SomeBlockQuery query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SameDepIndex2 query => Eq (SomeBlockQuery query)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
(forall (footprint :: QueryFootprint) result. Show (BlockQuery blk footprint result)) => Show (SomeBlockQuery (BlockQuery blk))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (SomeBlockQuery (BlockQuery (HardForkBlock xs)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient · orphan
Inject (SomeBlockQuery :.: BlockQuery)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Nary

datadata QueryVersion

QueryVersion1 QueryVersion2 QueryVersion3

Instances5Bounded, Enum, Eq, Ord, Show

Bounded QueryVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query.Version
Enum QueryVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query.Version
Eq QueryVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query.Version
Ord QueryVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query.Version
Show QueryVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query.Version

classclass (forall result. Show (query result)) => ShowQuery (query :: Type -> Type) where

Methods

showResult :: query result -> result -> String

Instances6ShowQuery

ShowQuery QueryAnytimeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query
All SingleEraBlock xs => ShowQuery (QueryHardFork xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query
(forall (footprint :: QueryFootprint). ShowQuery (BlockQuery blk footprint), StandardHash blk) => ShowQuery (Query blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Query
ShowQuery (BlockQuery (DualBlock m a) footprint)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
All SingleEraBlock xs => ShowQuery (QueryIfCurrent xs footprint)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query
All SingleEraBlock xs => ShowQuery (BlockQuery (HardForkBlock xs) footprint)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger.Query · orphan