floresta_wire/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
// SPDX-License-Identifier: MIT OR Apache-2.0

//! # Floresta Wire
//! This crate provides the core networking logic for a full node using libfloresta,
//! including the P2P network and the mempool. You can easily integrate it with any
//! other crate that provides a `BlockchainInterface` and `UpdatableChainstate`
//! implementation.
//!
//! A node also gives you a `handle` that you can use to send messages to the node,
//! like requesting blocks, mempool transactions or asking to connect with a given
//! peer.

// cargo docs customization
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/249173822")]
#![doc(
    html_favicon_url = "https://raw.githubusercontent.com/getfloresta/floresta-media/master/logo_png/Icon-Green(main).png"
)]

use bitcoin::block::Header as BlockHeader;
use bitcoin::Block;
use bitcoin::Transaction;
pub use rustreexo;
#[cfg(not(target_arch = "wasm32"))]
mod p2p_wire;
#[cfg(not(target_arch = "wasm32"))]
pub use p2p_wire::address_man;
#[cfg(not(target_arch = "wasm32"))]
pub use p2p_wire::block_proof;
#[cfg(not(target_arch = "wasm32"))]
pub use p2p_wire::error;
#[cfg(not(target_arch = "wasm32"))]
pub use p2p_wire::node;
#[cfg(not(target_arch = "wasm32"))]
pub use p2p_wire::node_context;
#[cfg(not(target_arch = "wasm32"))]
pub use p2p_wire::node_interface;
pub use p2p_wire::transport::TransportProtocol;
pub use p2p_wire::UtreexoNodeConfig;

/// NodeHooks is a trait that defines the hooks that a node can use to interact with the network
/// and the blockchain. Every time an event happens, the node will call the corresponding hook.
pub trait NodeHooks {
    /// We've received a new block
    fn on_block_received(&mut self, block: &Block);
    /// We've received a new transaction
    fn on_transaction_received(&mut self, transaction: &Transaction);
    /// We've received a new peer
    fn on_peer_connected(&mut self, peer: &u32);
    /// We've lost a peer
    fn on_peer_disconnected(&mut self, peer: &u32);
    /// We've received a new header
    fn on_header_received(&mut self, header: &BlockHeader);
}