Struct NodePubkey

pub struct NodePubkey(pub PublicKey);

Available on crate feature secp256k1 only.

Newtype over secp256k1::PublicKey representing a deserialized key identifying an LN node.

This can be considered similar to NodeId with these differences:

• NodeId is more performant for non-cryptographic operations.
• NodeId can not perform any cryptographic operations itself.
• NodePubkey, despite its field being public, maintains more invariants. In this library, a valid NodeId is not guaranteed to be a valid NodePubkey

Example

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

Tuple Fields

0: PublicKey

The underlying public key used for cryptographic operations.

Implementations

impl NodePubkey

pub fn verify<M: Into<Message>, C: Verification>( &self, secp: &Secp256k1<C>, message: M, signature: &[u8], ) -> Result<(), Error>

Available on crate feature node_pubkey_verify only.

Verify a message signed by this key.

This is a convenience method that simply uses slices. While this could be seen as regression from strongly-typed secp256k1 library, it should be a good tradeoff here. The reason is we know that LN signatures are not DER-encoded and there shouldn’t be a reason to need to keep message hash around.

If you need anything advanced, you can still use the raw secp256k1::PublicKey.

Example

use ln_types::secp256k1::hashes::{sha256d, Hash};

let marvin_str = "029ef8ee0ba895e2807ac1df1987a7888116c468e70f42e7b089e06811b0e45482";
let marvin = marvin_str.parse::<ln_types::NodePubkey>().unwrap();
let message = "Lightning Signed Message:I am the author of `ln-types` Rust crate.";
let signature = &[0x29, 0x79, 0x4d, 0x9a, 0x6a, 0x48, 0x68, 0x0f, 0x9b, 0x8d, 0x60, 0x97, 0xa6, 0xd8, 0xef, 0x1d, 0x5c, 0xf9, 0xdc, 0x27, 0xcd, 0x76, 0x9a, 0x86, 0x58, 0xd6, 0x94, 0x00, 0x1c, 0x12, 0xb8, 0xdd, 0x49, 0xaf, 0x2b, 0xca, 0x0a, 0x24, 0xd8, 0xf4, 0x5a, 0x3b, 0x3c, 0xc7, 0x87, 0xf0, 0x48, 0x60, 0x63, 0x23, 0xf4, 0x24, 0xba, 0xa8, 0x0f, 0x5e, 0xe6, 0x05, 0x79, 0x81, 0xe2, 0x29, 0x6f, 0x0d];
let secp = ln_types::secp256k1::Secp256k1::verification_only();
let message = sha256d::Hash::hash(message.as_bytes());
let message = secp256k1::Message::from_digest(message.to_byte_array());

marvin.verify(&secp, message, signature).unwrap();

pub fn verify_lightning_message<C: Verification>( &self, secp: &Secp256k1<C>, message: &[u8], signature: &[u8], ) -> Result<(), Error>

Available on crate feature node_pubkey_recovery only.

Verifies a message signed by signmessage Eclair/LND RPC.

The signatures of messages returned by node RPCs are not so simple. They prefix messages with Lightning Signed Message:, use double sha256 and recovery. It is the reason why this function requires the recovery feature of secp256k1.

This function takes care of all that complexity for you so that you can verify the messages conveniently.

Example

let marvin_str = "029ef8ee0ba895e2807ac1df1987a7888116c468e70f42e7b089e06811b0e45482";
let marvin = marvin_str.parse::<ln_types::NodePubkey>().unwrap();
let message = "I am the author of `ln-types` Rust crate.";
let signature = &[0x1f, 0x29, 0x79, 0x4d, 0x9a, 0x6a, 0x48, 0x68, 0x0f, 0x9b, 0x8d, 0x60, 0x97, 0xa6, 0xd8, 0xef, 0x1d, 0x5c, 0xf9, 0xdc, 0x27, 0xcd, 0x76, 0x9a, 0x86, 0x58, 0xd6, 0x94, 0x00, 0x1c, 0x12, 0xb8, 0xdd, 0x49, 0xaf, 0x2b, 0xca, 0x0a, 0x24, 0xd8, 0xf4, 0x5a, 0x3b, 0x3c, 0xc7, 0x87, 0xf0, 0x48, 0x60, 0x63, 0x23, 0xf4, 0x24, 0xba, 0xa8, 0x0f, 0x5e, 0xe6, 0x05, 0x79, 0x81, 0xe2, 0x29, 0x6f, 0x0d];
let secp = ln_types::secp256k1::Secp256k1::verification_only();

marvin.verify_lightning_message(&secp, message.as_bytes(), signature).unwrap();

pub fn to_node_id(&self) -> NodeId

Convenience conversion method.

This is more readable and less prone to inference problems than Into::into.

pub fn from_secret_key<C: Signing>(secp: &Secp256k1<C>, sk: &SecretKey) -> Self

Computes public key from a secret key and stores it as NodePubkey.

Trait Implementations

impl AsMut<PublicKey> for NodePubkey

fn as_mut(&mut self) -> &mut PublicKey

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

impl AsRef<PublicKey> for NodePubkey

fn as_ref(&self) -> &PublicKey

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

impl Borrow<PublicKey> for NodePubkey

fn borrow(&self) -> &PublicKey

Immutably borrows from an owned value.

impl BorrowMut<PublicKey> for NodePubkey

fn borrow_mut(&mut self) -> &mut PublicKey

Mutably borrows from an owned value.

impl Clone for NodePubkey

fn clone(&self) -> NodePubkey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodePubkey

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

Formats the value using the given formatter.

impl Display for NodePubkey

Shows NodePubkey as hex

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<NodePubkey> for [u8; 33]

fn from(value: NodePubkey) -> Self

Converts to this type from the input type.

impl From<NodePubkey> for NodeId

fn from(value: NodePubkey) -> Self

Converts to this type from the input type.

impl<'a> FromSql<'a> for NodePubkey

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 NodePubkey

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 NodePubkey

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 NodePubkey

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

Formats the value using the given formatter.

impl Ord for NodePubkey

fn cmp(&self, other: &NodePubkey) -> 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 NodePubkey

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 NodePubkey

fn eq(&self, other: &NodePubkey) -> 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 NodePubkey

fn partial_cmp(&self, other: &NodePubkey) -> 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 ToSql for NodePubkey

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 NodePubkey

type Error = Error

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 NodePubkey

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 NodePubkey

Available on crate feature alloc only.

type Error = Error

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 NodePubkey

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

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 NodePubkey

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 NodePubkey

Available on crate feature alloc only.

type Error = Error

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 NodePubkey

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

Formats the value using the given formatter.

impl Value for NodePubkey

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 Eq for NodePubkey

impl StructuralPartialEq for NodePubkey