Enum internet2::session::node_addr::PartialNodeAddr

#[non_exhaustive]pub enum PartialNodeAddr {
    Native(PublicKey, InetAddr, Option<u16>),
    Udp(PublicKey, IpAddr, Option<u16>),
    Posix(String),
    ZmqIpc(String, ZmqType),
    ZmqInproc(String, ZmqType),
    ZmqTcpEncrypted(PublicKey, ZmqType, IpAddr, Option<u16>),
    ZmqTcpUnencrypted(ZmqType, IpAddr, Option<u16>),
    Http(PublicKey, InetAddr, Option<u16>),
    Text(PublicKey),
}

Universal Node Locator for LNP protocol (from LNPBP-19)

Type is used for visual node and specific protocol representation or parsing It is different from NodeAddr by the fact that it may not contain port information for LNP-based protocols having known default port, while NodeAddr must always contain complete information with the explicit porn number. To convert PartialNodeAddr to NodeAddr use ToNodeAddr trait.

NB: DNS addressing is not used since it is considered insecure in terms of censorship resistance.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Native(PublicKey, InetAddr, Option<u16>)

Native Lightning network connection: uses end-to-end encryption and runs on top of either TCP socket (which may be backed by Tor connection)

URL Scheme

lnp://@|:

Udp(PublicKey, IpAddr, Option<u16>)

NB: Unfinished!

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://@:

Posix(String)

Connection through POSIX (UNIX-type) socket. Does not use encryption.

URL Scheme

lnp:

ZmqIpc(String, 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>

ZmqInproc(String, 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 (context object is taken from a global variable).

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

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

URL Scheme

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

ZmqTcpUnencrypted(ZmqType, IpAddr, Option<u16>)

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

URL Schema

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

Http(PublicKey, InetAddr, Option<u16>)

URL Scheme

lnph://@|[:]

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 Scheme

lnpt://@

Implementations

impl PartialNodeAddr

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 components(
    &self
) -> (Option<PublicKey>, Option<InetAddr>, Option<u16>, Option<String>, Option<ZmqType>)

Parses PartialNodeAddr 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. [zmqsocket::ApiType] 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 [zmqsocket::ApiType] for the given locator, if any, or Option::None otherwise

Trait Implementations

impl Clone for PartialNodeAddr

pub fn clone(&self) -> PartialNodeAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartialNodeAddr

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

Formats the value using the given formatter.

impl Display for PartialNodeAddr

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

Formats the value using the given formatter.

impl Eq for PartialNodeAddr

impl From<PartialNodeAddr> for NodeAddr

pub fn from(locator: PartialNodeAddr) -> Self

Performs the conversion.

impl From<RemoteNodeAddr> for PartialNodeAddr

pub fn from(node_addr: RemoteNodeAddr) -> PartialNodeAddr

Performs the conversion.

impl FromStr for PartialNodeAddr

type Err = AddrError

The associated error which can be returned from parsing.

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

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

impl Hash for PartialNodeAddr

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<PartialNodeAddr> for PartialNodeAddr

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

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

pub fn ne(&self, other: &PartialNodeAddr) -> bool

This method tests for !=.

impl StructuralEq for PartialNodeAddr

impl StructuralPartialEq for PartialNodeAddr

impl ToNodeAddr for PartialNodeAddr

pub fn to_node_addr(&self, default_port: u16) -> Option<NodeAddr>

Constructs NodeAddr from an internal data with a default port put in place when the port details were not given is such structures as PartialNodeAddr

impl ToRemoteNodeAddr for PartialNodeAddr

pub fn to_remote_node_addr(&self, default_port: u16) -> Option<RemoteNodeAddr>

Constructs RemoteNodeAddr from an internal data with a default port put in place when the port details were not given is such structures as PartialNodeAddr

impl TryFrom<PartialNodeAddr> for LocalSocketAddr

type Error = AddrError

The type returned in the event of a conversion error.

pub fn try_from(value: PartialNodeAddr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PartialNodeAddr> for RemoteNodeAddr

type Error = AddrError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PartialNodeAddr> for ZmqSocketAddr

type Error = AddrError

The type returned in the event of a conversion error.

pub fn try_from(socket_addr: PartialNodeAddr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Url> for PartialNodeAddr

type Error = AddrError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UrlString for PartialNodeAddr

pub fn url_scheme(&self) -> &'static str

Returns full URL scheme string (i.e. including : or :// parts) corresponding to the provided address

pub fn to_url_string(&self) -> String

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