Struct NodeId

pub struct NodeId(/* private fields */);

Byte representation of a node identifier.

This type is used when referring to nodes without doing cryptographic operations. It can be used in search algorithms, LN explorers, manager UIs etc. By avoiding cryptography it is significantly more performant but may make debugging harder. It is therefore recommended to perform checking at system boundaries where performance is not very important - e.g. user inputs.

Despite this not being a guaranteed point on the curve it still performs cheap basic sanity check: whether the key begins with 0x02 or 0x03.

Example

let marvin_str = "029ef8ee0ba895e2807ac1df1987a7888116c468e70f42e7b089e06811b0e45482";
let marvin = marvin_str.parse::<ln_types::NodeId>().unwrap();
assert_eq!(marvin.to_string(), marvin_str);

Implementations

impl NodeId

pub fn from_raw_bytes(bytes: [u8; 33]) -> Result<Self, InvalidNodeId>

Creates NodeId from raw byte representation.

pub fn to_vec(self) -> Vec<u8>

Available on crate feature alloc only.

Puts the byte representation into Vec<u8>.

This is meant for convenience around APIs that require Vec<u8>. Since it allocates it’s best to avoid it if possible.

pub fn to_array(self) -> [u8; 33]

Convenience conversion to byte array.

This can be used instead of From to avoid inference issues.

Trait Implementations

impl AsRef<[u8]> for NodeId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 33]> for NodeId

fn as_ref(&self) -> &[u8; 33]

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for NodeId

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Borrow<[u8; 33]> for NodeId

fn borrow(&self) -> &[u8; 33]

Immutably borrows from an owned value.

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

Same as Display

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeId

Available on crate feature serde only.

NodeId is deserialized as hex from human-readable formats and as bytes from non-human-readable.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NodeId

Shows NodeId as hex

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

Formats the value using the given formatter.

impl<'a> From<&'a NodePubkey> for NodeId

Available on crate feature secp256k1 only.

fn from(value: &'a NodePubkey) -> Self

Converts to this type from the input type.

impl From<NodeId> for [u8; 33]

fn from(value: NodeId) -> Self

Converts to this type from the input type.

impl From<NodePubkey> for NodeId

Available on crate feature secp256k1 only.

fn from(value: NodePubkey) -> Self

Converts to this type from the input type.

impl<'a> FromSql<'a> for NodeId

Available on crate feature postgres-types only.

Supports BYTEA, TEXT, and VARCHAR.

Decoded as bytes if BYTEA is used, as hex string otherwise.

fn from_sql( ty: &Type, raw: &'a [u8], ) -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Creates a new value of this type from a buffer of data of the specified Postgres Type in its binary format.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be created from the specified Postgres Type.

fn from_sql_null(ty: &Type) -> Result<Self, Box<dyn Error + Send + Sync>>

Creates a new value of this type from a NULL SQL value.

fn from_sql_nullable( ty: &Type, raw: Option<&'a [u8]>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

A convenience function that delegates to from_sql and from_sql_null depending on the value of raw.

impl FromStr for NodeId

Expects hex representation

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 NodeId

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for NodeId

Same as Display

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

Formats the value using the given formatter.

impl Ord for NodeId

fn cmp(&self, other: &NodeId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParseArgFromStr for NodeId

Available on crate feature parse_arg only.

fn describe_type<W: Write>(writer: W) -> Result

Writes human-readable description of the type to the writer.

impl PartialEq for NodeId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NodeId

fn partial_cmp(&self, other: &NodeId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NodeId

Available on crate feature serde only.

NodeId is serialized as hex to human-readable formats and as bytes to non-human-readable.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSql for NodeId

Available on crate feature postgres-types only.

Supports BYTEA, TEXT, and VARCHAR.

Stored as bytes if BYTEA is used, as hex string otherwise.

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Send + Sync + 'static>>

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl<'a> TryFrom<&'a [u8]> for NodeId

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(slice: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for NodeId

Expects hex representation

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Box<[u8]>> for NodeId

Available on crate feature alloc only.

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(slice: Box<[u8]>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Box<str>> for NodeId

Available on crate feature alloc only.

Expects hex representation

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NodeId> for NodePubkey

Available on crate feature secp256k1 only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for NodeId

Available on crate feature alloc only.

Expects hex representation

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for NodeId

Available on crate feature alloc only.

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(vec: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for NodeId

As Display but with upper-case letters

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

Formats the value using the given formatter.

impl Value for NodeId

Available on crate feature slog only.

Currently uses Display but may use emit_bytes if/when it’s implemented.

fn serialize( &self, _rec: &Record<'_>, key: Key, serializer: &mut dyn Serializer, ) -> Result

Serialize self into Serializer

impl Copy for NodeId

impl Eq for NodeId

impl StructuralPartialEq for NodeId