Enum lnpbp::lnp::NodeLocator

pub enum NodeLocator {
    Native(PublicKey, InetAddr, Option<u16>),
    Udp(PublicKey, IpAddr, Option<u16>),
    Ipc(PathBuf, ZmqType),
    Inproc(String, Context, ZmqType),
    ZmqEncrypted(PublicKey, ZmqType, IpAddr, Option<u16>),
    ZmqUnencrypted(ZmqType, IpAddr, Option<u16>),
    Text(PublicKey),
}

Universal Node Locator for LNP protocol (from LNPBP-19) NB: DNS addressing is not used since it is considered insecure in terms of censorship resistance.

Variants

Native(PublicKey, InetAddr, Option<u16>)

Native Lightning network connection: uses end-to-end encryption and runs on top of either TCP or Tor socket

URL Scheme

lnp://@|:

Udp(PublicKey, IpAddr, Option<u16>)

UDP-based connection that uses UDP packets instead of TCP. Can't work with Tor, but may use UDP hole punching in a secure way, since the connection is still required to be encrypted.

URL Scheme

lnpu://@:

Ipc(PathBuf, ZmqType)

Local (for inter-process communication based on POSIX sockets) connection without encryption. Relies on ZMQ IPC sockets internally; specific socket pair for ZMQ is provided via query parameter

URL Schema

lnpz:?api=<p2p|rpc|sub>

Inproc(String, Context, ZmqType)

LNP protocol supports in-process communications (between threads of the same process using Mutex'es and other sync managing routines) without encryption. It relies on ZMQ IPC sockets internally. However, such connection can be done only withing the same process, and can't be represented in the form of URL. It requires presence of ZMQ context object, which can't be encoded as a string.

ZmqEncrypted(PublicKey, ZmqType, IpAddr, Option<u16>)

SHOULD be used only for DMZ area connections; otherwise NodeLocator::Native or [NodeLocator::Websocket] connection MUST be used

URL Schema

lnpz://@|:/?api=<p2p|rpc|sub>

ZmqUnencrypted(ZmqType, IpAddr, Option<u16>)

SHOULD be used only for DMZ area connections; otherwise NodeLocator::Native or [NodeLocator::Websocket] connection MUST be used

URL Schema

lnpz://|:/?api=<p2p|rpc|sub>

Text(PublicKey)

Text (Bech32-based) connection for high latency or non-interactive protocols. Can work with SMPT, for mesh and satellite networks – or with other mediums of communications (chat messages, QR codes etc).

URL Schema

lnpt://@

Implementations

impl NodeLocator

pub fn with_port(&self, port: u16) -> Self

Adds port information to the node locator, if it can contain port. In case if it does not, performs no action. Returns cloned Self with the updated data.

pub fn scheme(&self) -> String

Returns URL schema name for the given node locator type

pub fn to_url_string(&self) -> String

Returns URL string representation for a given node locator. If you need full URL address, plsease use Url::from() instead (this will require url feature for LNP/BP Core Library).

pub fn components(
    &self
) -> (Option<PublicKey>, Option<InetAddr>, Option<u16>, Option<String>, Option<ZmqType>)

Parses NodeLocator into it's optional components, returned as a single tuple of optionals:

1. node public key,
2. InetAddr of the node,
3. port
4. file path or POSIX socket name
5. ZmqType parameter for ZMQ based locators

pub fn node_id(&self) -> Option<PublicKey>

Returns node id for the given locator, if any, or Option::None otherwise

pub fn inet_addr(&self) -> Option<InetAddr>

Returns InetAddr for the given locator, if any, or Option::None otherwise

pub fn port(&self) -> Option<u16>

Returns port number for the given locator, if any, or Option::None otherwise

pub fn socket_name(&self) -> Option<String>

Returns socket name if for the given locator, if any, or Option::None otherwise

pub fn api_type(&self) -> Option<ZmqType>

Returns ZmqType for the given locator, if any, or Option::None otherwise

Trait Implementations

impl Clone for NodeLocator

fn clone(&self) -> NodeLocator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeLocator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for NodeLocator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for NodeLocator

impl<'_> From<&'_ NodeLocator> for Url

fn from(locator: &NodeLocator) -> Self

Performs the conversion.

impl From<NodeAddr> for NodeLocator

fn from(addr: NodeAddr) -> Self

Performs the conversion.

impl FromStr for NodeLocator

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NodeLocator

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<NodeLocator> for NodeLocator

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TryFrom<NodeLocator> for NodeAddr

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(locator: NodeLocator) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Url> for NodeLocator

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self, Self::Error>

Performs the conversion.