Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.TxSubmission.Inbound.V1

Contents

Re-exports

Synopsis

txSubmissionInbound :: forall txid tx idx (m :: Type -> Type) err. (Ord txid, NoThunks txid, NoThunks tx, MonadSTM m, MonadThrow m, MonadDelay m) => Tracer m (TraceTxSubmissionInbound txid tx) -> TxSubmissionInitDelay -> TxSubmissionConfig -> NumTxsToReq -> TxSubmissionMempoolReader txid tx idx m -> TxSubmissionMempoolWriter txid tx idx m err -> TxSubmissionServerPipelined txid tx m ()
defaultTxSubmissionConfigV1 :: TxSubmissionConfig
defaultMaxNumTxsToRequest :: NumTxsToReq
maxSaneNumTxsToRequest :: NumTxsToReq
saneMaxNumTxsToRequest :: NumTxsToReq -> Bool
clampMaxNumTxsToRequest :: NumTxsToReq -> NumTxsToReq
data TxSubmissionInitDelay
- = TxSubmissionInitDelay DiffTime
- | NoTxSubmissionInitDelay
data TxSubmissionMempoolWriter txid tx idx (m :: Type -> Type) err = TxSubmissionMempoolWriter {
- txId :: tx -> txid
- mempoolAddTxs :: [tx] -> m ([txid], [(txid, err)])
}
data TraceTxSubmissionInbound txid tx
- = TraceTxSubmissionCollected [txid]
- | TraceTxSubmissionProcessed ProcessedTxCount
- | TraceTxInboundCanRequestMoreTxs Int
- | TraceTxInboundCannotRequestMoreTxs Int
- | TraceTxInboundAddedToMempool [txid] DiffTime
- | TraceTxInboundRejectedFromMempool [txid] DiffTime
- | TraceTxInboundError TxSubmissionProtocolError
- | TraceTxInboundRequestTxs [txid]
- | TraceTxInboundMaxNumTxsToRequestClamped NumTxsToReq
- | TraceTxInboundTerminated
data TxSubmissionProtocolError
- = ProtocolErrorTxNotRequested
- | ProtocolErrorTxIdsNotRequested
- | (Typeable txid, Show txid, Eq txid) => ProtocolErrorTxSizeError [(txid, SizeInBytes, SizeInBytes)]
- | (Typeable txid, Show txid, Eq txid) => ProtocolErrorTxSizeTooLarge [(txid, SizeInBytes)]
data ProcessedTxCount = ProcessedTxCount {
- ptxcAccepted :: Int
- ptxcRejected :: Int
- ptxcScore :: Double
}
data TxSubmissionConfig = TxSubmissionConfig {
- maxNumUnacknowledgedTxIds :: !NumTxIdsToAck
- maxNumTxIdsToRequest :: !NumTxIdsToReq
}

Documentation

txSubmissionInbound Source #

Arguments

:: forall txid tx idx (m :: Type -> Type) err. (Ord txid, NoThunks txid, NoThunks tx, MonadSTM m, MonadThrow m, MonadDelay m)
=> Tracer m (TraceTxSubmissionInbound txid tx)
-> TxSubmissionInitDelay
-> TxSubmissionConfig	configuration, `defaultTxSubmissionConfigV1`
-> NumTxsToReq	maximum number of txs to request, `defaultMaxNumTxsToRequest`; it is clamped by `clampMaxNumTxsToRequest` to the range checked by `saneMaxNumTxsToRequest`
-> TxSubmissionMempoolReader txid tx idx m
-> TxSubmissionMempoolWriter txid tx idx m err
-> TxSubmissionServerPipelined txid tx m ()

defaultTxSubmissionConfigV1 :: TxSubmissionConfig Source #

TxSubmissionConfig for TxSubmissionLogicV1.

defaultMaxNumTxsToRequest :: NumTxsToReq Source #

The default number of txs to request.

maxSaneNumTxsToRequest :: NumTxsToReq Source #

The largest sane number of txs to request: a MsgReplyTxs with that many txs of max_TX_SIZE, each up to const_MAX_TX_SIZE_DISCREPANCY larger, fits within the StTxs size limit. txSubmissionInbound selects txs by count only, without a limit on their size.

saneMaxNumTxsToRequest :: NumTxsToReq -> Bool Source #

Sanity check for the number of txs to request: it must be positive (with `0` the inbound would send empty requests forever) and at most maxSaneNumTxsToRequest (otherwise an honest peer's reply can exceed the StTxs size limit).

clampMaxNumTxsToRequest :: NumTxsToReq -> NumTxsToReq Source #

Clamp the number of txs to request to the range checked by saneMaxNumTxsToRequest.

Re-exports

data TxSubmissionInitDelay Source #

Constructors

TxSubmissionInitDelay DiffTime
NoTxSubmissionInitDelay

Instances

Instances details

Show TxSubmissionInitDelay Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods showsPrec :: Int -> TxSubmissionInitDelay -> ShowS # show :: TxSubmissionInitDelay -> String # showList :: [TxSubmissionInitDelay] -> ShowS #
Eq TxSubmissionInitDelay Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods (==) :: TxSubmissionInitDelay -> TxSubmissionInitDelay -> Bool # (/=) :: TxSubmissionInitDelay -> TxSubmissionInitDelay -> Bool #

data TxSubmissionMempoolWriter txid tx idx (m :: Type -> Type) err Source #

The consensus layer functionality that the inbound side of the tx submission logic requires.

This is provided to the tx submission logic by the consensus layer.

Constructors

TxSubmissionMempoolWriter

Fields

txId :: tx -> txid
Compute the transaction id from a transaction.
This is used in the protocol handler to verify a full transaction matches a previously given transaction id.
mempoolAddTxs :: [tx] -> m ([txid], [(txid, err)])
Supply a batch of transactions to the mempool. They are either accepted or rejected individually, but in the order supplied.
Return list of valid tx's added to the mempool and a list of invalid tx's with the corresponding error.

data TraceTxSubmissionInbound txid tx Source #

Constructors

TraceTxSubmissionCollected [txid]	Number of transactions just about to be inserted.
TraceTxSubmissionProcessed ProcessedTxCount	Just processed transaction pass/fail breakdown.
TraceTxInboundCanRequestMoreTxs Int
TraceTxInboundCannotRequestMoreTxs Int
TraceTxInboundAddedToMempool [txid] DiffTime
TraceTxInboundRejectedFromMempool [txid] DiffTime
TraceTxInboundError TxSubmissionProtocolError
TraceTxInboundRequestTxs [txid]
TraceTxInboundMaxNumTxsToRequestClamped NumTxsToReq
TraceTxInboundTerminated	Server received `MsgDone`

Instances

Instances details

Show txid => Show (TraceTxSubmissionInbound txid tx) Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods showsPrec :: Int -> TraceTxSubmissionInbound txid tx -> ShowS # show :: TraceTxSubmissionInbound txid tx -> String # showList :: [TraceTxSubmissionInbound txid tx] -> ShowS #
Eq txid => Eq (TraceTxSubmissionInbound txid tx) Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods (==) :: TraceTxSubmissionInbound txid tx -> TraceTxSubmissionInbound txid tx -> Bool # (/=) :: TraceTxSubmissionInbound txid tx -> TraceTxSubmissionInbound txid tx -> Bool #

data TxSubmissionProtocolError Source #

Constructors

ProtocolErrorTxNotRequested
ProtocolErrorTxIdsNotRequested
(Typeable txid, Show txid, Eq txid) => ProtocolErrorTxSizeError [(txid, SizeInBytes, SizeInBytes)]	a list of txid for which the received size and advertised size didn't match.
(Typeable txid, Show txid, Eq txid) => ProtocolErrorTxSizeTooLarge [(txid, SizeInBytes)]	a list of txids advertised with a size above `max_TX_SIZE`.

Instances

Instances details

Exception TxSubmissionProtocolError Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods toException :: TxSubmissionProtocolError -> SomeException # fromException :: SomeException -> Maybe TxSubmissionProtocolError # displayException :: TxSubmissionProtocolError -> String # backtraceDesired :: TxSubmissionProtocolError -> Bool #
Show TxSubmissionProtocolError Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods showsPrec :: Int -> TxSubmissionProtocolError -> ShowS # show :: TxSubmissionProtocolError -> String # showList :: [TxSubmissionProtocolError] -> ShowS #
Eq TxSubmissionProtocolError Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods (==) :: TxSubmissionProtocolError -> TxSubmissionProtocolError -> Bool # (/=) :: TxSubmissionProtocolError -> TxSubmissionProtocolError -> Bool #

data ProcessedTxCount Source #

Constructors

ProcessedTxCount
Fields ptxcAccepted :: Int Just accepted this many transactions. ptxcRejected :: Int Just rejected this many transactions. ptxcScore :: Double

Instances

Instances details

Show ProcessedTxCount Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods showsPrec :: Int -> ProcessedTxCount -> ShowS # show :: ProcessedTxCount -> String # showList :: [ProcessedTxCount] -> ShowS #
Eq ProcessedTxCount Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Types Methods (==) :: ProcessedTxCount -> ProcessedTxCount -> Bool # (/=) :: ProcessedTxCount -> ProcessedTxCount -> Bool #

data TxSubmissionConfig Source #

Shared options between the inbound and outbound side.

Constructors

TxSubmissionConfig

Fields

maxNumUnacknowledgedTxIds :: !NumTxIdsToAck
maximum number of unacknowledged txids; it MUST be positive, and small enough for a MsgRequestTxs with that many txids to fit within the StIdle size limit (see max_TXID_SIZE). Before NodeToNodeV_16 it is a protocol parameter and must not be changed; since NodeToNodeV_16 it is a local setting.
maxNumTxIdsToRequest :: !NumTxIdsToReq
maximum number of txids an inbound client can request at a time.

Instances

Instances details

NFData TxSubmissionConfig Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Policy Methods rnf :: TxSubmissionConfig -> () #
Show TxSubmissionConfig Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Policy Methods showsPrec :: Int -> TxSubmissionConfig -> ShowS # show :: TxSubmissionConfig -> String # showList :: [TxSubmissionConfig] -> ShowS #
Eq TxSubmissionConfig Source #
Instance details Defined in Ouroboros.Network.TxSubmission.Inbound.V2.Policy Methods (==) :: TxSubmissionConfig -> TxSubmissionConfig -> Bool # (/=) :: TxSubmissionConfig -> TxSubmissionConfig -> Bool #