Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.LocalTxMonitor.Type

Description

The type of the local transaction monitoring protocol.

This is used by local clients (like wallets, explorers and CLI tools) to monitor the transactions passing through the mempool of a local node.

The protocol is stateful such that the server keeps track of the transactions already sent to the client.

                   START
                     ⇓
                   ┌───────────────┐
           ┌──────▶│     Idle      │⇒ DONE
           │       └───┬───────────┘
           │           │
           │   Acquire │
           │           ▼
           │       ┌───────────────┐
   Release │       │   Acquiring   │
           │       └───┬───────────┘
           │           │       ▲
           │  Acquired │       │ AwaitAcquire
           │           ▼       │
           │       ┌───────────┴───┐
           └───────┤   Acquired    │
                   └───┬───────────┘
                       │       ▲
 HasTx|NextTx|GetSizes │       │ Reply (HasTx|NextTx|GetSizes)
                       ▼       │
                   ┌───────────┴───┐
                   │      Busy     │
                   └───────────────┘

Synopsis

data LocalTxMonitor txid tx slot where
- StIdle :: LocalTxMonitor txid tx slot
- StAcquiring :: LocalTxMonitor txid tx slot
- StAcquired :: LocalTxMonitor txid tx slot
- StBusy :: StBusyKind -> LocalTxMonitor txid tx slot
- StDone :: LocalTxMonitor txid tx slot
data StBusyKind where
- NextTx :: StBusyKind
- HasTx :: StBusyKind
- GetSizes :: StBusyKind
data MempoolSizeAndCapacity = MempoolSizeAndCapacity {
- capacityInBytes :: ! Word32
- sizeInBytes :: ! Word32
- numberOfTxs :: ! Word32
}
data TokBusyKind (k :: StBusyKind ) where
- TokNextTx :: TokBusyKind NextTx
- TokHasTx :: TokBusyKind HasTx
- TokGetSizes :: TokBusyKind GetSizes

Documentation

data LocalTxMonitor txid tx slot where Source #

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

It is parametrised over the type of transactions.

Constructors

StIdle :: LocalTxMonitor txid tx slot	The client has agency; it can request a transaction or terminate. There is no timeout in this state.
StAcquiring :: LocalTxMonitor txid tx slot	The server has agency; it is capturing the latest mempool snapshot.
StAcquired :: LocalTxMonitor txid tx slot	The client has agency; The server is locked on a particular mempool snapshot. The client can now perform various requests on that snapshot, or acquire a new one, more recent.
StBusy :: StBusyKind -> LocalTxMonitor txid tx slot	The server has agency; It must respond, there's no timeout.
StDone :: LocalTxMonitor txid tx slot	Nobody has agency. The terminal state.

Instances

Instances details

( ShowProxy txid, ShowProxy tx, ShowProxy slot) => ShowProxy ( LocalTxMonitor txid tx slot :: Type ) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods showProxy :: Proxy ( LocalTxMonitor txid tx slot) -> String Source #
Show ( ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods showsPrec :: Int -> ClientHasAgency st -> ShowS Source # show :: ClientHasAgency st -> String Source # showList :: [ ClientHasAgency st] -> ShowS Source #
Show ( ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods showsPrec :: Int -> ServerHasAgency st -> ShowS Source # show :: ServerHasAgency st -> String Source # showList :: [ ServerHasAgency st] -> ShowS Source #
( Show txid, Show tx, Show slot) => Show ( Message ( LocalTxMonitor txid tx slot) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods showsPrec :: Int -> Message ( LocalTxMonitor txid tx slot) from to -> ShowS Source # show :: Message ( LocalTxMonitor txid tx slot) from to -> String Source # showList :: [ Message ( LocalTxMonitor txid tx slot) from to] -> ShowS Source #
Protocol ( LocalTxMonitor txid tx slot) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Associated Types data Message ( LocalTxMonitor txid tx slot) st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency :: forall (st :: LocalTxMonitor txid tx slot). ClientHasAgency st -> ServerHasAgency st -> Void Source # exclusionLemma_NobodyAndClientHaveAgency :: forall (st :: LocalTxMonitor txid tx slot). NobodyHasAgency st -> ClientHasAgency st -> Void Source # exclusionLemma_NobodyAndServerHaveAgency :: forall (st :: LocalTxMonitor txid tx slot). NobodyHasAgency st -> ServerHasAgency st -> Void Source #
data Message ( LocalTxMonitor txid tx slot) (from :: LocalTxMonitor txid tx slot) (to :: LocalTxMonitor txid tx slot) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type data Message ( LocalTxMonitor txid tx slot) (from :: LocalTxMonitor txid tx slot) (to :: LocalTxMonitor txid tx slot) where MsgAcquire :: forall k k k (txid :: k) (tx :: k) (slot :: k). Message ( LocalTxMonitor txid tx slot) (' StIdle :: LocalTxMonitor txid tx slot) (' StAcquiring :: LocalTxMonitor txid tx slot) MsgAcquired :: forall k k slot (txid :: k) (tx :: k). slot -> Message ( LocalTxMonitor txid tx slot) (' StAcquiring :: LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) MsgAwaitAcquire :: forall k k k (txid :: k) (tx :: k) (slot :: k). Message ( LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) (' StAcquiring :: LocalTxMonitor txid tx slot) MsgNextTx :: forall k k k (txid :: k) (tx :: k) (slot :: k). Message ( LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) (' StBusy ' NextTx :: LocalTxMonitor txid tx slot) MsgReplyNextTx :: forall k k tx (txid :: k) (slot :: k). Maybe tx -> Message ( LocalTxMonitor txid tx slot) (' StBusy ' NextTx :: LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) MsgHasTx :: forall k k txid (tx :: k) (slot :: k). txid -> Message ( LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) (' StBusy ' HasTx :: LocalTxMonitor txid tx slot) MsgReplyHasTx :: forall k k k (txid :: k) (tx :: k) (slot :: k). Bool -> Message ( LocalTxMonitor txid tx slot) (' StBusy ' HasTx :: LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) MsgGetSizes :: forall k k k (txid :: k) (tx :: k) (slot :: k). Message ( LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) (' StBusy ' GetSizes :: LocalTxMonitor txid tx slot) MsgReplyGetSizes :: forall k k k (txid :: k) (tx :: k) (slot :: k). MempoolSizeAndCapacity -> Message ( LocalTxMonitor txid tx slot) (' StBusy ' GetSizes :: LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) MsgRelease :: forall k k k (txid :: k) (tx :: k) (slot :: k). Message ( LocalTxMonitor txid tx slot) (' StAcquired :: LocalTxMonitor txid tx slot) (' StIdle :: LocalTxMonitor txid tx slot) MsgDone :: forall k k k (txid :: k) (tx :: k) (slot :: k). Message ( LocalTxMonitor txid tx slot) (' StIdle :: LocalTxMonitor txid tx slot) (' StDone :: LocalTxMonitor txid tx slot)
data ClientHasAgency (st :: LocalTxMonitor txid tx slot) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type data ClientHasAgency (st :: LocalTxMonitor txid tx slot) where TokIdle :: forall k k k (txid :: k) (tx :: k) (slot :: k). ClientHasAgency (' StIdle :: LocalTxMonitor txid tx slot) TokAcquired :: forall k k k (txid :: k) (tx :: k) (slot :: k). ClientHasAgency (' StAcquired :: LocalTxMonitor txid tx slot)
data ServerHasAgency (st :: LocalTxMonitor txid tx slot) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type data ServerHasAgency (st :: LocalTxMonitor txid tx slot) where TokAcquiring :: forall k k k (txid :: k) (tx :: k) (slot :: k). ServerHasAgency (' StAcquiring :: LocalTxMonitor txid tx slot) TokBusy :: forall k k k (txid :: k) (tx :: k) (slot :: k) (k :: StBusyKind ). TokBusyKind k -> ServerHasAgency (' StBusy k :: LocalTxMonitor txid tx slot)
data NobodyHasAgency (st :: LocalTxMonitor txid tx slot) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type data NobodyHasAgency (st :: LocalTxMonitor txid tx slot) where TokDone :: forall k k k (txid :: k) (tx :: k) (slot :: k). NobodyHasAgency (' StDone :: LocalTxMonitor txid tx slot)

data StBusyKind where Source #

Constructors

NextTx :: StBusyKind	The server is busy fetching the next transaction from the mempool
HasTx :: StBusyKind	The server is busy looking for the presence of a specific transaction in the mempool
GetSizes :: StBusyKind	The server is busy looking for the current size and max capacity of the mempool

data MempoolSizeAndCapacity Source #

Describes the MemPool sizes and capacity for a given snapshot.

Constructors

MempoolSizeAndCapacity
Fields capacityInBytes :: ! Word32 The maximum capacity of the mempool. Note that this may dynamically change when the ledger state is updated. sizeInBytes :: ! Word32 The summed byte size of all the transactions in the mempool. numberOfTxs :: ! Word32 The number of transactions in the mempool

Instances

Instances details

Eq MempoolSizeAndCapacity Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods (==) :: MempoolSizeAndCapacity -> MempoolSizeAndCapacity -> Bool Source # (/=) :: MempoolSizeAndCapacity -> MempoolSizeAndCapacity -> Bool Source #
Show MempoolSizeAndCapacity Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods showsPrec :: Int -> MempoolSizeAndCapacity -> ShowS Source # show :: MempoolSizeAndCapacity -> String Source # showList :: [ MempoolSizeAndCapacity ] -> ShowS Source #
Generic MempoolSizeAndCapacity Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Associated Types type Rep MempoolSizeAndCapacity :: Type -> Type Source # Methods from :: MempoolSizeAndCapacity -> Rep MempoolSizeAndCapacity x Source # to :: Rep MempoolSizeAndCapacity x -> MempoolSizeAndCapacity Source #
type Rep MempoolSizeAndCapacity Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type type Rep MempoolSizeAndCapacity = D1 (' MetaData "MempoolSizeAndCapacity" "Ouroboros.Network.Protocol.LocalTxMonitor.Type" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' False ) ( C1 (' MetaCons "MempoolSizeAndCapacity" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "capacityInBytes") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word32 ) :: ( S1 (' MetaSel (' Just "sizeInBytes") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word32 ) :: S1 (' MetaSel (' Just "numberOfTxs") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word32 ))))

data TokBusyKind (k :: StBusyKind ) where Source #

Constructors

TokNextTx :: TokBusyKind NextTx
TokHasTx :: TokBusyKind HasTx
TokGetSizes :: TokBusyKind GetSizes