#chain #mempool #block #transaction #notifications #called #updated

bitcoinchain-notifications

interface for notifying when, for example: transactions are added/removed to the mempool, blocks are connected/disconnected, the block tip is updated, or the chain state is flushed

2 releases

0.1.16-alpha.0 Apr 2, 2023
0.1.12-alpha.0 Jan 19, 2023

#24 in #mempool

Download history 85/week @ 2024-03-11 111/week @ 2024-03-18 177/week @ 2024-03-25 184/week @ 2024-04-01 80/week @ 2024-04-08 109/week @ 2024-04-15 111/week @ 2024-04-22 102/week @ 2024-04-29 122/week @ 2024-05-06 101/week @ 2024-05-13 104/week @ 2024-05-20 63/week @ 2024-05-27 77/week @ 2024-06-03 83/week @ 2024-06-10 90/week @ 2024-06-17 111/week @ 2024-06-24

361 downloads per month
Used in 41 crates (8 directly)

MIT license

1MB
4K SLoC

bitcoinchain-notifications crate

The BitcoinChain-Notifications crate provides chain notifications for Bitcoin clients. This crate contains trait definitions for various events that clients can subscribe to in order to be notified about various changes in the Bitcoin chain.

The ChainNotifications trait is the main trait for listening to chain notifications. This trait is composed of other traits, including TransactionAddedToMempool, TransactionRemovedFromMempool, BlockConnected, BlockDisconnected, UpdatedBlockTip, and ChainStateFlushed. Each of these traits defines a method for listening to a specific type of event.

The TransactionAddedToMempool trait defines a method that is called when a transaction is added to the mempool.

The TransactionRemovedFromMempool trait defines a method that is called when a transaction is removed from the mempool.

This notification is fired for transactions that are removed from the mempool for various reasons including expiration, size limit, reorg, conflict, and replaced.

However, it does not fire for transactions that are removed from the mempool because they have been included in a block. Any client interested in transactions removed from the mempool for inclusion in a block can learn about those transactions from the BlockConnected notification.

The BlockConnected trait defines a method that is called when a new block is connected to the chain.

The BlockDisconnected trait defines a method that is called when a block is disconnected from the chain.

The UpdatedBlockTip trait defines a method that is called when the block tip is updated.

Finally, the ChainStateFlushed trait defines a method that is called when the chain state is flushed.

All of these traits are designed to be used on a background thread.

To use this crate, you can implement any of the traits in your client code and register your implementation with the client's notification system. When a chain event occurs that matches your implementation, the corresponding method will be called.

Dependencies

~104MB
~885K SLoC