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 # show ∷ ClientHasAgency st → String # showList ∷ [ClientHasAgency st] → ShowS #
Show (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods showsPrec ∷ Int → ServerHasAgency st → ShowS # show ∷ ServerHasAgency st → String # showList ∷ [ServerHasAgency st] → ShowS #
NFData (ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods rnf ∷ ClientHasAgency st → () #
NFData (NobodyHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods rnf ∷ NobodyHasAgency st → () #
NFData (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods rnf ∷ ServerHasAgency st → () #
(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 # show ∷ Message (LocalTxSubmission tx reject) from to → String # showList ∷ [Message (LocalTxSubmission tx reject) from to] → ShowS #
(NFData tx, NFData reject) ⇒ NFData (Message (LocalTxSubmission tx reject) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods rnf ∷ Message (LocalTxSubmission tx reject) from to → () #
NFData (PeerHasAgency pr st) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods rnf ∷ PeerHasAgency pr st → () #
(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 # (/=) ∷ Message (LocalTxSubmission tx reject) from to → Message (LocalTxSubmission tx reject) from to → Bool #
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 ∷ ∀ (st ∷ LocalTxSubmission tx reject). ClientHasAgency st → ServerHasAgency st → Void Source # exclusionLemma_NobodyAndClientHaveAgency ∷ ∀ (st ∷ LocalTxSubmission tx reject). NobodyHasAgency st → ClientHasAgency st → Void Source # exclusionLemma_NobodyAndServerHaveAgency ∷ ∀ (st ∷ LocalTxSubmission tx reject). NobodyHasAgency st → ServerHasAgency st → Void Source #
data ClientHasAgency (st ∷ LocalTxSubmission tx reject) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type data ClientHasAgency (st ∷ LocalTxSubmission tx reject) where TokIdle ∷ ∀ {k} {k1} {tx ∷ k} {reject ∷ k1}. ClientHasAgency ('StIdle ∷ LocalTxSubmission tx reject)
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 ∷ ∀ {k1} tx1 (reject ∷ k1). tx1 → Message (LocalTxSubmission tx1 reject) ('StIdle ∷ LocalTxSubmission tx1 reject) ('StBusy ∷ LocalTxSubmission tx1 reject) MsgAcceptTx ∷ ∀ {k} {k1} (tx ∷ k) (reject ∷ k1). Message (LocalTxSubmission tx reject) ('StBusy ∷ LocalTxSubmission tx reject) ('StIdle ∷ LocalTxSubmission tx reject) MsgRejectTx ∷ ∀ {k} reject1 (tx ∷ k). reject1 → Message (LocalTxSubmission tx reject1) ('StBusy ∷ LocalTxSubmission tx reject1) ('StIdle ∷ LocalTxSubmission tx reject1) MsgDone ∷ ∀ {k} {k1} (tx ∷ k) (reject ∷ k1). Message (LocalTxSubmission tx reject) ('StIdle ∷ LocalTxSubmission tx reject) ('StDone ∷ 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 ∷ ∀ {k} {k1} {tx ∷ k} {reject ∷ k1}. NobodyHasAgency ('StDone ∷ 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 ∷ ∀ {k} {k1} {tx ∷ k} {reject ∷ k1}. ServerHasAgency ('StBusy ∷ 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 # (<$) ∷ a → SubmitResult b → SubmitResult a #
Eq reason ⇒ Eq (SubmitResult reason) Source #
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods (==) ∷ SubmitResult reason → SubmitResult reason → Bool # (/=) ∷ SubmitResult reason → SubmitResult reason → Bool #