Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.LocalTxSubmission.Type

Description

The type of the local transaction submission protocol.

This is used by local clients (like wallets and CLI tools) to submit transactions to a local node.

Synopsis

data LocalTxSubmission tx reject where
- StIdle :: LocalTxSubmission tx reject
- StBusy :: LocalTxSubmission tx reject
- StDone :: LocalTxSubmission tx reject
data SubmitResult reason
- = SubmitSuccess
- | SubmitFail reason

Documentation

data LocalTxSubmission tx reject where Source #

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

It is parametrised over the type of transactions and the type of reasons used when rejecting a transaction.

Constructors

StIdle :: LocalTxSubmission tx reject

The client has agency; it can submit a transaction or terminate.

There is no timeout in this state.

StBusy :: LocalTxSubmission tx reject

The server has agency; it must process the submitted transaction and either accept or reject it (with a reason).

There is a timeout in this state. If the mempool is full and remains so for a period then the transaction should be rejected with a suitable temporary failure reason.

StDone :: LocalTxSubmission tx reject

Nobody has agency. The terminal state.

Instances

Instances details

( ShowProxy tx, ShowProxy reject) => ShowProxy ( LocalTxSubmission tx reject :: Type ) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods showProxy :: Proxy ( LocalTxSubmission tx reject) -> String Source #
Show ( ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.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.LocalTxSubmission.Type Methods showsPrec :: Int -> ServerHasAgency st -> ShowS Source # show :: ServerHasAgency st -> String Source # showList :: [ ServerHasAgency st] -> ShowS Source #
( Eq tx, Eq reject) => Eq ( Message ( LocalTxSubmission tx reject) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods (==) :: Message ( LocalTxSubmission tx reject) from to -> Message ( LocalTxSubmission tx reject) from to -> Bool Source # (/=) :: Message ( LocalTxSubmission tx reject) from to -> Message ( LocalTxSubmission tx reject) from to -> Bool Source #
( Show tx, Show reject) => Show ( Message ( LocalTxSubmission tx reject) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods showsPrec :: Int -> Message ( LocalTxSubmission tx reject) from to -> ShowS Source # show :: Message ( LocalTxSubmission tx reject) from to -> String Source # showList :: [ Message ( LocalTxSubmission tx reject) from to] -> ShowS Source #
Protocol ( LocalTxSubmission tx reject) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Associated Types data Message ( LocalTxSubmission tx reject) st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency :: forall (st :: LocalTxSubmission tx reject). ClientHasAgency st -> ServerHasAgency st -> Void Source # exclusionLemma_NobodyAndClientHaveAgency :: forall (st :: LocalTxSubmission tx reject). NobodyHasAgency st -> ClientHasAgency st -> Void Source # exclusionLemma_NobodyAndServerHaveAgency :: forall (st :: LocalTxSubmission tx reject). NobodyHasAgency st -> ServerHasAgency st -> Void Source #
data Message ( LocalTxSubmission tx reject) (from :: LocalTxSubmission tx reject) (to :: LocalTxSubmission tx reject) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type data Message ( LocalTxSubmission tx reject) (from :: LocalTxSubmission tx reject) (to :: LocalTxSubmission tx reject) where MsgSubmitTx :: forall k tx (reject :: k). tx -> Message ( LocalTxSubmission tx reject) (' StIdle :: LocalTxSubmission tx reject) (' StBusy :: LocalTxSubmission tx reject) MsgAcceptTx :: forall k k (tx :: k) (reject :: k). Message ( LocalTxSubmission tx reject) (' StBusy :: LocalTxSubmission tx reject) (' StIdle :: LocalTxSubmission tx reject) MsgRejectTx :: forall k reject (tx :: k). reject -> Message ( LocalTxSubmission tx reject) (' StBusy :: LocalTxSubmission tx reject) (' StIdle :: LocalTxSubmission tx reject) MsgDone :: forall k k (tx :: k) (reject :: k). Message ( LocalTxSubmission tx reject) (' StIdle :: LocalTxSubmission tx reject) (' StDone :: LocalTxSubmission tx reject)
data ClientHasAgency (st :: LocalTxSubmission tx reject) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type data ClientHasAgency (st :: LocalTxSubmission tx reject) where TokIdle :: forall k k (tx :: k) (reject :: k). ClientHasAgency (' StIdle :: LocalTxSubmission tx reject)
data ServerHasAgency (st :: LocalTxSubmission tx reject) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type data ServerHasAgency (st :: LocalTxSubmission tx reject) where TokBusy :: forall k k (tx :: k) (reject :: k). ServerHasAgency (' StBusy :: LocalTxSubmission tx reject)
data NobodyHasAgency (st :: LocalTxSubmission tx reject) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type data NobodyHasAgency (st :: LocalTxSubmission tx reject) where TokDone :: forall k k (tx :: k) (reject :: k). NobodyHasAgency (' StDone :: LocalTxSubmission tx reject)

data SubmitResult reason Source #

Isomorphic with Maybe but with a name that better describes its purpose and usage.

Constructors

SubmitSuccess
SubmitFail reason

Instances

Instances details

Functor SubmitResult Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods fmap :: (a -> b) -> SubmitResult a -> SubmitResult b Source # (<$) :: a -> SubmitResult b -> SubmitResult a Source #
Eq reason => Eq ( SubmitResult reason) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods (==) :: SubmitResult reason -> SubmitResult reason -> Bool Source # (/=) :: SubmitResult reason -> SubmitResult reason -> Bool Source #