Enum Node 

pub enum Node<N: Network> {
    Validator(Arc<Validator<N, ConsensusDB<N>>>),
    Prover(Arc<Prover<N, ConsensusMemory<N>>>),
    Client(Arc<Client<N, ConsensusDB<N>>>),
    BootstrapClient(BootstrapClient<N>),
}

Variants

Validator(Arc<Validator<N, ConsensusDB<N>>>)

A validator is a full node, capable of validating blocks.

Prover(Arc<Prover<N, ConsensusMemory<N>>>)

A prover is a light node, capable of producing proofs for consensus.

Client(Arc<Client<N, ConsensusDB<N>>>)

A client node is a full node, capable of querying with the network.

BootstrapClient(BootstrapClient<N>)

A bootstrap client node is a light node dedicated to serving lists of peers.

Implementations

impl<N: Network> Node<N>

pub async fn new_validator( node_ip: SocketAddr, bft_ip: Option<SocketAddr>, rest_ip: Option<SocketAddr>, rest_rps: u32, account: Account<N>, trusted_peers: &[SocketAddr], trusted_validators: &[SocketAddr], genesis: Block<N>, cdn: Option<Uri>, storage_mode: StorageMode, trusted_peers_only: bool, dev_txs: bool, dev: Option<u16>, shutdown: Arc<AtomicBool>, ) -> Result<Self>

Initializes a new validator node.

pub async fn new_prover( node_ip: SocketAddr, account: Account<N>, trusted_peers: &[SocketAddr], genesis: Block<N>, storage_mode: StorageMode, trusted_peers_only: bool, dev: Option<u16>, shutdown: Arc<AtomicBool>, ) -> Result<Self>

Initializes a new prover node.

pub async fn new_client( node_ip: SocketAddr, rest_ip: Option<SocketAddr>, rest_rps: u32, account: Account<N>, trusted_peers: &[SocketAddr], genesis: Block<N>, cdn: Option<Uri>, storage_mode: StorageMode, trusted_peers_only: bool, dev: Option<u16>, shutdown: Arc<AtomicBool>, ) -> Result<Self>

Initializes a new client node.

pub async fn new_bootstrap_client( listener_addr: SocketAddr, account: Account<N>, genesis_header: Header<N>, dev: Option<u16>, ) -> Result<Self>

Initializes a new bootstrap client node.

pub fn node_type(&self) -> NodeType

Returns the node type.

pub fn private_key(&self) -> &PrivateKey<N>

Returns the account private key of the node.

pub fn view_key(&self) -> &ViewKey<N>

Returns the account view key of the node.

pub fn address(&self) -> Address<N>

Returns the account address of the node.

pub fn is_dev(&self) -> bool

Returns true if the node is in development mode.

pub fn peer_pool(&self) -> &RwLock<HashMap<SocketAddr, Peer<N>>>

Returns a reference to the underlying peer pool.

pub fn ledger(&self) -> Option<&Ledger<N, ConsensusDB<N>>>

Get the underlying ledger (if any).

pub fn is_block_synced(&self) -> bool

Returns true if the node is synced up to the latest block (within the given tolerance).

pub fn num_blocks_behind(&self) -> Option<u32>

Returns the number of blocks this node is behind the greatest peer height, or None if not connected to peers yet.

pub fn get_sync_speed(&self) -> f64

Calculates the current sync speed in blocks per second. Returns None if sync speed cannot be calculated (e.g., not syncing or insufficient data).

pub async fn shut_down(&self)

Shuts down the node.

Trait Implementations

impl<N: Clone + Network> Clone for Node<N>

fn clone(&self) -> Node<N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.