Skip to content

circlefin/malachite-mempool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Malachite consensus engine mempool

A mempool implementation for Malachite BFT Consensus Engine

Note: This project is currently under active development and is not yet production-ready.

Transaction flow

The following diagram shows how a transaction flows through the mempool system:

sequenceDiagram
    participant App as Enpoint
    participant Mempool as Mempool Actor
    participant AppActor as App Actor  
    participant Network as Network Actor
    
    Note over AppActor,Mempool: Initial Setup
    AppActor->>+Mempool: Subscribe(output_port_subscriber)
    Mempool-->>-AppActor: Subscription confirmed
    
    Note over App,Network: Transaction Processing
    App->>+Mempool: Add { tx, reply }
    
    Note over Mempool: Check if mempool is full<br/>(max_pool_size)
    
    alt Mempool Full
        Mempool->>App: Error(MempoolFull)
    else Space Available
        Mempool->>+AppActor: CheckTx { tx, reply } (via output_port)
        
        AppActor->>+AppActor: check_tx(tx)
        Note over AppActor: Deserialize & validate transaction<br/>Always returns outcome if validation succeeds
        
        AppActor->>+Mempool: CheckTxResult { tx, result, reply }
        
        alt Validation Failed
            Mempool->>App: Error(InvalidTransaction)
        else Validation Successul
            Note over Mempool: Outcome received<br/>Check if transaction is valid
            
            alt Transaction Invalid (outcome.is_valid() = false)
                Note over Mempool: Transaction not added to mempool<br/>but still reply with success
                Mempool->>App: Success(tx invalid)
            else Transaction Valid (outcome.is_valid())
                Note over Mempool: Check for duplicates<br/>using tx_hash
            
                alt Duplicate Transaction
                    Note over Mempool: Transaction already exists<br/>in mempool
                    Mempool->>App: Error(TxAlreadyExists)
                else Not Duplicate
                    Mempool->>Mempool: Add to to mempool
                    
                    alt Local Transaction
                        Mempool->>+Network: Broadcast(tx) (gossip)
                        Network-->>-Mempool: Gossip to peers
                    end
                    
                    Mempool->>App: Success(tx valid)
                end
            end
        end
    end
Loading

Key behaviors:

  • Network transactions: Transactions received from peer nodes follow the same validation flow but are not re-gossiped to prevent network loops and duplicate transaction.
  • Individual gossip: Each transaction is currently gossiped individually without batching optimization
  • Error types: The mempool returns specific MempoolError variants:
    • MempoolFull: When the mempool has reached its maximum capacity
    • InvalidTransaction: When transaction validation fails
    • TxAlreadyExists: When attempting to add a duplicate transaction

License

Copyright 2025 Circle Internet Financial, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

A production-ready mempool ready to be used with Malachite BFT Consensus Engine

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages