Trait Node

Source

pub trait Node: Entity {
    // Required methods
    fn get_alias(&self) -> Option<String>;
    fn get_bitcoin_network(&self) -> BitcoinNetwork;
    fn get_color(&self) -> Option<String>;
    fn get_conductivity(&self) -> Option<i64>;
    fn get_display_name(&self) -> String;
    fn get_public_key(&self) -> Option<String>;
    fn type_name(&self) -> &'static str;
}

Required Methods§

Source

fn get_alias(&self) -> Option<String>

A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator.

Source

fn get_bitcoin_network(&self) -> BitcoinNetwork

The Bitcoin Network this node is deployed in.

Source

fn get_color(&self) -> Option<String>

A hexadecimal string that describes a color. For example “#000000” is black, “#FFFFFF” is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator.

Source

fn get_conductivity(&self) -> Option<i64>

A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node’s conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included).

Source