ouroboros-consensus-0.1.0.2: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Mempool

Description

The mempool API and implementation.

Synopsis

Documentation

type TxSizeInBytes = Word32 Source #

Transactions are typically not big, but in principle in future we could have ones over 64k large.

data TraceEventMempool blk Source #

Events traced by the Mempool.

Constructors

TraceMempoolAddedTx 

Fields

  • (Validated (GenTx blk))

    New, valid transaction that was added to the Mempool.

  • MempoolSize

    The size of the Mempool before adding the transaction.

  • MempoolSize

    The size of the Mempool after adding the transaction.

TraceMempoolRejectedTx 

Fields

  • (GenTx blk)

    New, invalid transaction thas was rejected and thus not added to the Mempool.

  • (ApplyTxErr blk)

    The reason for rejecting the transaction.

  • MempoolSize

    The current size of the Mempool.

TraceMempoolRemoveTxs 

Fields

  • [Validated (GenTx blk)]

    Previously valid transactions that are no longer valid because of changes in the ledger state. These transactions have been removed from the Mempool.

  • MempoolSize

    The current size of the Mempool.

TraceMempoolManuallyRemovedTxs 

Fields

  • [GenTxId blk]

    Transactions that have been manually removed from the Mempool.

  • [Validated (GenTx blk)]

    Previously valid transactions that are no longer valid because they dependend on transactions that were manually removed from the Mempool. These transactions have also been removed from the Mempool.

    This list shares not transactions with the list of manually removed transactions.

  • MempoolSize

    The current size of the Mempool.

Instances

Instances details
(Eq (GenTx blk), Eq (Validated (GenTx blk)), Eq (GenTxId blk), Eq (ApplyTxErr blk)) ⇒ Eq (TraceEventMempool blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.API

(Show (GenTx blk), Show (Validated (GenTx blk)), Show (GenTxId blk), Show (ApplyTxErr blk)) ⇒ Show (TraceEventMempool blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.API

data MempoolSize Source #

The size of a mempool.

Constructors

MempoolSize 

Fields

data MempoolSnapshot blk idx Source #

A pure snapshot of the contents of the mempool. It allows fetching information about transactions in the mempool, and fetching individual transactions.

This uses a transaction sequence number type for identifying transactions within the mempool sequence. The sequence number is local to this mempool, unlike the transaction hash. This allows us to ask for all transactions after a known sequence number, to get new transactions. It is also used to look up individual transactions.

Note that it is expected that getTx will often return Nothing even for tx sequence numbers returned in previous snapshots. This happens when the transaction has been removed from the mempool between snapshots.

Constructors

MempoolSnapshot 

Fields

data MempoolCapacityBytesOverride Source #

An override for the default MempoolCapacityBytes which is 2x the maximum transaction capacity

Constructors

NoMempoolCapacityBytesOverride

Use 2x the maximum transaction capacity of a block. This will change dynamically with the protocol parameters adopted in the current ledger.

MempoolCapacityBytesOverride !MempoolCapacityBytes

Use the following MempoolCapacityBytes.

newtype MempoolCapacityBytes Source #

Represents the maximum number of bytes worth of transactions that a Mempool can contain.

data ForgeLedgerState blk Source #

The ledger state wrt to which we should produce a block

The transactions in the mempool will be part of the body of a block, but a block consists of a header and a body, and the full validation of a block consists of first processing its header and only then processing the body. This is important, because processing the header may change the state of the ledger: the update system might be updated, scheduled delegations might be applied, etc., and such changes should take effect before we validate any transactions.

Constructors

ForgeInKnownSlot SlotNo (TickedLedgerState blk)

The slot number of the block is known

This will only be the case when we realized that we are the slot leader and we are actually producing a block. It is the caller's responsibility to call applyChainTick and produce the ticked ledger state.

ForgeInUnknownSlot (LedgerState blk)

The slot number of the block is not yet known

When we are validating transactions before we know in which block they will end up, we have to make an assumption about which slot number to use for applyChainTick to prepare the ledger state; we will assume that they will end up in the slot after the slot at the tip of the ledger.

data MempoolAddTxResult blk Source #

The result of attempting to add a transaction to the mempool.

Constructors

MempoolTxAdded !(Validated (GenTx blk))

The transaction was added to the mempool.

MempoolTxRejected !(GenTx blk) !(ApplyTxErr blk)

The transaction was rejected and could not be added to the mempool for the specified reason.

Instances

Instances details
(Eq (GenTx blk), Eq (Validated (GenTx blk)), Eq (ApplyTxErr blk)) ⇒ Eq (MempoolAddTxResult blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.API

(Show (GenTx blk), Show (Validated (GenTx blk)), Show (ApplyTxErr blk)) ⇒ Show (MempoolAddTxResult blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.API

data Mempool m blk idx Source #

Mempool

The mempool is the set of transactions that should be included in the next block. In principle this is a set of all the transactions that we receive from our peers. In order to avoid flooding the network with invalid transactions, however, we only want to keep valid transactions in the mempool. That raises the question: valid with respect to which ledger state?

We opt for a very simple answer to this: the mempool will be interpreted as a list of transactions; which are validated strictly in order, starting from the current ledger state. This has a number of advantages:

  • It's simple to implement and it's efficient. In particular, no search for a valid subset is ever required.
  • When producing a block, we can simply take the longest possible prefix of transactions that fits in a block.
  • It supports wallets that submit dependent transactions (where later transaction depends on outputs from earlier ones).

When only one thread is operating on the mempool, operations that mutate the state based on the input arguments (tryAddTxs and removeTxs) will produce the same result whether they process transactions one by one or all in one go, so this equality holds:

void (tryAddTxs wti txs) === forM_ txs (tryAddTxs wti . (:[]))
void (trAddTxs wti [x,y]) === tryAddTxs wti x >> void (tryAddTxs wti y)

This shows that tryAddTxs wti is an homomorphism from ++ and >>, which informally makes these operations "distributive".

Constructors

Mempool 

Fields

  • tryAddTxsWhetherToIntervene → [GenTx blk] → m ([MempoolAddTxResult blk], [GenTx blk])

    Add a bunch of transactions (oldest to newest)

    As long as we keep the mempool entirely in-memory this could live in STM m; we keep it in m instead to leave open the possibility of persistence.

    The new transactions provided will be validated, in order, against the ledger state obtained by applying all the transactions already in the Mempool to it. Transactions which are found to be invalid, with respect to the ledger state, are dropped, whereas valid transactions are added to the mempool.

    Note that transactions that are invalid, with respect to the ledger state, will never be added to the mempool. However, it is possible that, at a given point in time, transactions which were once valid but are now invalid, with respect to the current ledger state, could exist within the mempool until they are revalidated and dropped from the mempool via a call to syncWithLedger or by the background thread that watches the ledger for changes.

    This function will return two lists

    1. A list containing the following transactions:
    • Those transactions provided which were found to be valid, as a MempoolTxAdded value. These transactions are now in the Mempool.
    • Those transactions provided which were found to be invalid, along with their accompanying validation errors, as a MempoolTxRejected value. These transactions are not in the Mempool.
    1. A list containing the transactions that have not yet been added, as the capacity of the Mempool has been reached. I.e., there is no space in the Mempool to add the first transaction in this list. Note that we won't try to add smaller transactions after that first transaction because they might depend on the first transaction.

    POSTCONDITION: > let prj = case > MempoolTxAdded vtx -> txForgetValidated vtx > MempoolTxRejected tx _err -> tx > (processed, toProcess) <- tryAddTxs wti txs > map prj processed ++ toProcess == txs

    Note that previously valid transaction that are now invalid with respect to the current ledger state are dropped from the mempool, but are not part of the first returned list (nor the second).

    In principle it is possible that validation errors are transient; for example, it is possible that a transaction is rejected because one of its inputs is not yet available in the UTxO (the transaction it depends on is not yet in the chain, nor in the mempool). In practice however it is likely that rejected transactions will still be rejected later, and should just be dropped.

    It is important to note one important special case of transactions being "invalid": a transaction will also be considered invalid if that very same transaction is already included on the blockchain (after all, by definition that must mean its inputs have been used). Rejected transactions are therefore not necessarily a sign of malicious behaviour. Indeed, we would expect most transactions that are reported as invalid by tryAddTxs to be invalid precisely because they have already been included. Distinguishing between these two cases can be done in theory, but it is expensive unless we have an index of transaction hashes that have been included on the blockchain.

  • removeTxs ∷ [GenTxId blk] → m ()

    Manually remove the given transactions from the mempool.

  • syncWithLedger ∷ m (MempoolSnapshot blk idx)

    Sync the transactions in the mempool with the current ledger state of the ChainDB.

    The transactions that exist within the mempool will be revalidated against the current ledger state. Transactions which are found to be invalid with respect to the current ledger state, will be dropped from the mempool, whereas valid transactions will remain.

    We keep this in m instead of STM m to leave open the possibility of persistence. Additionally, this makes it possible to trace the removal of invalid transactions.

    n.b. in our current implementation, when one opens a mempool, we spawn a thread which performs this action whenever the ChainDB tip point changes.

  • getSnapshotSTM m (MempoolSnapshot blk idx)

    Get a snapshot of the current mempool state. This allows for further pure queries on the snapshot.

    This doesn't look at the ledger state at all.

  • getSnapshotForForgeLedgerState blk → STM m (MempoolSnapshot blk idx)

    Get a snapshot of the mempool state that is valid with respect to the given ledger state

    This does not update the state of the mempool.

  • getCapacitySTM m MempoolCapacityBytes

    Get the mempool's capacity in bytes.

    Note that the capacity of the Mempool, unless it is overridden with MempoolCapacityBytesOverride, can dynamically change when the ledger state is updated: it will be set to twice the current ledger's maximum transaction capacity of a block.

    When the capacity happens to shrink at some point, we do not remove transactions from the Mempool to satisfy this new lower limit. Instead, we treat it the same way as a Mempool which is at capacity, i.e., we won't admit new transactions until some have been removed because they have become invalid.

  • getTxSizeGenTx blk → TxSizeInBytes

    Return the post-serialisation size in bytes of a GenTx.

  • zeroIdx ∷ idx

    Represents the initial value at which the transaction ticket number counter will start (i.e. the zeroth ticket number).

addTxs ∷ ∀ m blk idx. MonadSTM m ⇒ Mempool m blk idx → [GenTx blk] → m [MempoolAddTxResult blk] Source #

Wrapper around implTryAddTxs that blocks until all transaction have either been added to the Mempool or rejected.

This function does not sync the Mempool contents with the ledger state in case the latter changes, it relies on the background thread to do that.

See the necessary invariants on the Haddock for tryAddTxs.

addLocalTxs ∷ ∀ m blk idx. MonadSTM m ⇒ Mempool m blk idx → [GenTx blk] → m [MempoolAddTxResult blk] Source #

Variation on addTxs that is more forgiving when possible

See Intervene.

computeMempoolCapacityLedgerSupportsMempool blk ⇒ TickedLedgerState blk → MempoolCapacityBytesOverrideMempoolCapacityBytes Source #

If no override is provided, calculate the default mempool capacity as 2x the current ledger's maximum transaction capacity of a block.

data TicketNo Source #

We allocate each transaction a (monotonically increasing) ticket number as it enters the mempool.

Instances

Instances details
Bounded TicketNo Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.TxSeq

Enum TicketNo Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.TxSeq

Eq TicketNo Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.TxSeq

Ord TicketNo Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.TxSeq

Show TicketNo Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.TxSeq

NoThunks TicketNo Source # 
Instance details

Defined in Ouroboros.Consensus.Mempool.TxSeq

Methods

noThunks ∷ Context → TicketNoIO (Maybe ThunkInfo) #

wNoThunks ∷ Context → TicketNoIO (Maybe ThunkInfo) #

showTypeOfProxy TicketNoString #

data LedgerInterface m blk Source #

Abstract interface needed to run a Mempool.

Constructors

LedgerInterface 

openMempool ∷ (IOLike m, LedgerSupportsMempool blk, HasTxId (GenTx blk), ValidateEnvelope blk) ⇒ ResourceRegistry m → LedgerInterface m blk → LedgerConfig blk → MempoolCapacityBytesOverride → Tracer m (TraceEventMempool blk) → (GenTx blk → TxSizeInBytes) → m (Mempool m blk TicketNo) Source #

Create a Mempool m blk TicketNo in m to manipulate the mempool. It will also fork a thread that syncs the mempool and the ledger when the ledger changes.

openMempoolWithoutSyncThread ∷ (IOLike m, LedgerSupportsMempool blk, HasTxId (GenTx blk), ValidateEnvelope blk) ⇒ LedgerInterface m blk → LedgerConfig blk → MempoolCapacityBytesOverride → Tracer m (TraceEventMempool blk) → (GenTx blk → TxSizeInBytes) → m (Mempool m blk TicketNo) Source #

Unlike openMempool, this function does not fork a background thread that synchronises with the ledger state whenever the later changes.

Intended for testing purposes.