Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.LocalStateQuery.Type

Description

The type of the local ledger state query protocol.

This is used by local clients (like wallets and CLI tools) to query the ledger state of a local node.

Synopsis

data LocalStateQuery block point (query :: Type -> Type ) where
- StIdle :: LocalStateQuery block point query
- StAcquiring :: LocalStateQuery block point query
- StAcquired :: LocalStateQuery block point query
- StQuerying :: result -> LocalStateQuery block point query
- StDone :: LocalStateQuery block point query
data AcquireFailure
- = AcquireFailurePointTooOld
- | AcquireFailurePointNotOnChain
class ( forall result. Show (query result)) => ShowQuery query where
- showResult :: forall result. query result -> result -> String

Documentation

data LocalStateQuery block point (query :: Type -> Type ) where Source #

The kind of the local state query protocol, and the types of the states in the protocol state machine.

It is parametrised over the type of block (for points), the type of queries and query results.

Constructors

StIdle :: LocalStateQuery block point query	The client has agency. It can ask to acquire a state or terminate. There is no timeout in this state.
StAcquiring :: LocalStateQuery block point query	The server has agency. it must acquire the state at the requested point or report a failure. There is a timeout in this state.
StAcquired :: LocalStateQuery block point query	The client has agency. It can request queries against the current state, or it can release the state.
StQuerying :: result -> LocalStateQuery block point query	The server has agency. It must respond with the query result.
StDone :: LocalStateQuery block point query	Nobody has agency. The terminal state.

Instances

Instances details

( ShowProxy block, ShowProxy query) => ShowProxy ( LocalStateQuery block point query :: Type ) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods showProxy :: Proxy ( LocalStateQuery block point query) -> String Source #
Show ( ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods showsPrec :: Int -> ClientHasAgency st -> ShowS Source # show :: ClientHasAgency st -> String Source # showList :: [ ClientHasAgency st] -> ShowS Source #
( forall result. Show (query result)) => Show ( ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods showsPrec :: Int -> ServerHasAgency st -> ShowS Source # show :: ServerHasAgency st -> String Source # showList :: [ ServerHasAgency st] -> ShowS Source #
( ShowQuery query, Show point) => Show ( Message ( LocalStateQuery block point query) st st') Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods showsPrec :: Int -> Message ( LocalStateQuery block point query) st st' -> ShowS Source # show :: Message ( LocalStateQuery block point query) st st' -> String Source # showList :: [ Message ( LocalStateQuery block point query) st st'] -> ShowS Source #
Protocol ( LocalStateQuery block point query) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Associated Types data Message ( LocalStateQuery block point query) st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency :: forall (st :: LocalStateQuery block point query). ClientHasAgency st -> ServerHasAgency st -> Void Source # exclusionLemma_NobodyAndClientHaveAgency :: forall (st :: LocalStateQuery block point query). NobodyHasAgency st -> ClientHasAgency st -> Void Source # exclusionLemma_NobodyAndServerHaveAgency :: forall (st :: LocalStateQuery block point query). NobodyHasAgency st -> ServerHasAgency st -> Void Source #
data Message ( LocalStateQuery block point query) (from :: LocalStateQuery block point query) (to :: LocalStateQuery block point query) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type data Message ( LocalStateQuery block point query) (from :: LocalStateQuery block point query) (to :: LocalStateQuery block point query) where MsgAcquire :: forall k point (block :: k) (query :: Type -> Type ). Maybe point -> Message ( LocalStateQuery block point query) (' StIdle :: LocalStateQuery block point query) (' StAcquiring :: LocalStateQuery block point query) MsgAcquired :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). Message ( LocalStateQuery block point query) (' StAcquiring :: LocalStateQuery block point query) (' StAcquired :: LocalStateQuery block point query) MsgFailure :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). AcquireFailure -> Message ( LocalStateQuery block point query) (' StAcquiring :: LocalStateQuery block point query) (' StIdle :: LocalStateQuery block point query) MsgQuery :: forall k k (query :: Type -> Type ) result (block :: k) (point :: k). query result -> Message ( LocalStateQuery block point query) (' StAcquired :: LocalStateQuery block point query) (' StQuerying result :: LocalStateQuery block point query) MsgResult :: forall k k (query :: Type -> Type ) result (block :: k) (point :: k). query result -> result -> Message ( LocalStateQuery block point query) (' StQuerying result :: LocalStateQuery block point query) (' StAcquired :: LocalStateQuery block point query) MsgRelease :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). Message ( LocalStateQuery block point query) (' StAcquired :: LocalStateQuery block point query) (' StIdle :: LocalStateQuery block point query) MsgReAcquire :: forall k point (block :: k) (query :: Type -> Type ). Maybe point -> Message ( LocalStateQuery block point query) (' StAcquired :: LocalStateQuery block point query) (' StAcquiring :: LocalStateQuery block point query) MsgDone :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). Message ( LocalStateQuery block point query) (' StIdle :: LocalStateQuery block point query) (' StDone :: LocalStateQuery block point query)
data ClientHasAgency (st :: LocalStateQuery block point query) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type data ClientHasAgency (st :: LocalStateQuery block point query) where TokIdle :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). ClientHasAgency (' StIdle :: LocalStateQuery block point query) TokAcquired :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). ClientHasAgency (' StAcquired :: LocalStateQuery block point query)
data ServerHasAgency (st :: LocalStateQuery block point query) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type data ServerHasAgency (st :: LocalStateQuery block point query) where TokAcquiring :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). ServerHasAgency (' StAcquiring :: LocalStateQuery block point query) TokQuerying :: forall k k (query :: Type -> Type ) result (block :: k) (point :: k). query result -> ServerHasAgency (' StQuerying result :: LocalStateQuery block point query)
data NobodyHasAgency (st :: LocalStateQuery block point query) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type data NobodyHasAgency (st :: LocalStateQuery block point query) where TokDone :: forall k k (block :: k) (point :: k) (query :: Type -> Type ). NobodyHasAgency (' StDone :: LocalStateQuery block point query)

data AcquireFailure Source #

Constructors

AcquireFailurePointTooOld
AcquireFailurePointNotOnChain

Instances

Instances details

Enum AcquireFailure Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods succ :: AcquireFailure -> AcquireFailure Source # pred :: AcquireFailure -> AcquireFailure Source # toEnum :: Int -> AcquireFailure Source # fromEnum :: AcquireFailure -> Int Source # enumFrom :: AcquireFailure -> [ AcquireFailure ] Source # enumFromThen :: AcquireFailure -> AcquireFailure -> [ AcquireFailure ] Source # enumFromTo :: AcquireFailure -> AcquireFailure -> [ AcquireFailure ] Source # enumFromThenTo :: AcquireFailure -> AcquireFailure -> AcquireFailure -> [ AcquireFailure ] Source #
Eq AcquireFailure Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods (==) :: AcquireFailure -> AcquireFailure -> Bool Source # (/=) :: AcquireFailure -> AcquireFailure -> Bool Source #
Show AcquireFailure Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type Methods showsPrec :: Int -> AcquireFailure -> ShowS Source # show :: AcquireFailure -> String Source # showList :: [ AcquireFailure ] -> ShowS Source #

class ( forall result. Show (query result)) => ShowQuery query 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 :: forall result. query result -> result -> String Source #