From: Jeffrey Czyz Date: Tue, 9 Aug 2022 22:40:26 +0000 (-0500) Subject: Builder for creating offers X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=085b3fe6ca2759d3dea2a42e419cf1f93781d92a;p=rust-lightning Builder for creating offers Add a builder for creating offers given a required description and node_id. Other settings are optional and duplicative settings will override previous settings for non-Vec fields. --- diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs index d3141cc31..169d2d1e5 100644 --- a/lightning/src/ln/features.rs +++ b/lightning/src/ln/features.rs @@ -687,6 +687,15 @@ impl Features { } } +#[cfg(test)] +impl Features { + pub(crate) fn unknown() -> Self { + let mut features = Self::empty(); + features.set_unknown_feature_required(); + features + } +} + macro_rules! impl_feature_len_prefixed_write { ($features: ident) => { impl Writeable for $features { diff --git a/lightning/src/offers/offer.rs b/lightning/src/offers/offer.rs index 847bafd66..4bdac4420 100644 --- a/lightning/src/offers/offer.rs +++ b/lightning/src/offers/offer.rs @@ -8,19 +8,225 @@ // licenses. //! Data structures and encoding for `offer` messages. +//! +//! An [`Offer`] represents an "offer to be paid." It is typically constructed by a merchant and +//! published as a QR code to be scanned by a customer. The customer uses the offer to request an +//! invoice from the merchant to be paid. +//! +//! ``` +//! extern crate bitcoin; +//! extern crate core; +//! extern crate lightning; +//! +//! use core::num::NonZeroU64; +//! use core::time::Duration; +//! +//! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey}; +//! use lightning::offers::offer::{Amount, OfferBuilder}; +//! +//! # use bitcoin::secp256k1; +//! # use lightning::onion_message::BlindedPath; +//! # #[cfg(feature = "std")] +//! # use std::time::SystemTime; +//! # +//! # fn create_blinded_path() -> BlindedPath { unimplemented!() } +//! # fn create_another_blinded_path() -> BlindedPath { unimplemented!() } +//! # +//! # #[cfg(feature = "std")] +//! # fn build() -> Result<(), secp256k1::Error> { +//! let secp_ctx = Secp256k1::new(); +//! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?); +//! let pubkey = PublicKey::from(keys); +//! +//! let one_item = NonZeroU64::new(1).unwrap(); +//! let expiration = SystemTime::now() + Duration::from_secs(24 * 60 * 60); +//! let offer = OfferBuilder::new("coffee, large".to_string(), pubkey) +//! .amount(Amount::Bitcoin { amount_msats: 20_000 }) +//! .quantity_range(one_item..) +//! .absolute_expiry(expiration.duration_since(SystemTime::UNIX_EPOCH).unwrap()) +//! .issuer("Foo Bar".to_string()) +//! .path(create_blinded_path()) +//! .path(create_another_blinded_path()) +//! .build() +//! .unwrap(); +//! # Ok(()) +//! # } +//! ``` use bitcoin::blockdata::constants::ChainHash; use bitcoin::network::constants::Network; use bitcoin::secp256k1::PublicKey; +use core::num::NonZeroU64; +use core::ops::{Bound, RangeBounds}; use core::time::Duration; +use io; use ln::features::OfferFeatures; +use ln::msgs::MAX_VALUE_MSAT; use onion_message::BlindedPath; +use util::ser::{Writeable, Writer}; use prelude::*; #[cfg(feature = "std")] use std::time::SystemTime; +/// Builds an [`Offer`] for the "offer to be paid" flow. +/// +/// See [module-level documentation] for usage. +/// +/// [module-level documentation]: self +pub struct OfferBuilder { + offer: OfferContents, +} + +impl OfferBuilder { + /// Creates a new builder for an offer with the given description, using the given pubkey for + /// signing invoices. The associated secret key must be remembered while the offer is valid. + /// + /// Use a different pubkey per offer to avoid correlating offers. + pub fn new(description: String, signing_pubkey: PublicKey) -> Self { + let offer = OfferContents { + chains: None, metadata: None, amount: None, description, + features: OfferFeatures::empty(), absolute_expiry: None, issuer: None, paths: None, + quantity_min: None, quantity_max: None, signing_pubkey: Some(signing_pubkey), + }; + OfferBuilder { offer } + } + + /// Sets a chain hash of the given [`Network`] for the offer. If not called, + /// [`Network::Bitcoin`] is assumed. + /// + /// Successive calls to this method will add another chain hash. + pub fn chain(mut self, network: Network) -> Self { + let chains = self.offer.chains.get_or_insert_with(Vec::new); + let chain = ChainHash::using_genesis_block(network); + if !chains.contains(&chain) { + chains.push(chain); + } + + self + } + + /// Sets the metadata for the offer. Useful for authentication and validating fields. + /// + /// Successive calls to this method will override the previous setting. + pub fn metadata(mut self, metadata: Vec) -> Self { + self.offer.metadata = Some(metadata); + self + } + + /// Sets the amount for the offer. + /// + /// Successive calls to this method will override the previous setting. + pub fn amount(mut self, amount: Amount) -> Self { + self.offer.amount = Some(amount); + self + } + + /// Sets the features for the offer. + /// + /// Successive calls to this method will override the previous setting. + #[cfg(test)] + pub fn features(mut self, features: OfferFeatures) -> Self { + self.offer.features = features; + self + } + + /// Sets the absolute expiry for the offer as seconds since the Unix epoch. + /// + /// Successive calls to this method will override the previous setting. + pub fn absolute_expiry(mut self, absolute_expiry: Duration) -> Self { + self.offer.absolute_expiry = Some(absolute_expiry); + self + } + + /// Sets the issuer for the offer. + /// + /// Successive calls to this method will override the previous setting. + pub fn issuer(mut self, issuer: String) -> Self { + self.offer.issuer = Some(issuer); + self + } + + /// Sets a blinded path for the offer. + /// + /// Successive calls to this method will add another blinded path. Caller is responsible for not + /// adding duplicate paths. + pub fn path(mut self, path: BlindedPath) -> Self { + self.offer.paths.get_or_insert_with(Vec::new).push(path); + self + } + + /// Sets a fixed quantity of items for the offer. If not set, `1` is assumed. + /// + /// Successive calls to this method or [`quantity_range`] will override the previous setting. + /// + /// [`quantity_range`]: Self::quantity_range + pub fn quantity_fixed(mut self, quantity: NonZeroU64) -> Self { + let quantity = Some(quantity.get()).filter(|quantity| *quantity != 1); + self.offer.quantity_min = quantity; + self.offer.quantity_max = quantity; + self + } + + /// Sets a quantity range of items for the offer. If not set, `1` is assumed. + /// + /// Successive calls to this method or [`quantity_fixed`] will override the previous setting. + /// + /// [`quantity_fixed`]: Self::quantity_fixed + pub fn quantity_range>(mut self, quantity: R) -> Self { + self.offer.quantity_min = match quantity.start_bound() { + Bound::Included(n) => Some(n.get()), + Bound::Excluded(_) => panic!("Bound::Excluded not supported for start_bound"), + Bound::Unbounded => Some(1), + }; + self.offer.quantity_max = match quantity.end_bound() { + Bound::Included(n) => Some(n.get()), + Bound::Excluded(n) => Some(n.get() - 1), + Bound::Unbounded => None, + }; + + // Use a minimal encoding whenever 1 can be inferred. + if let Some(1) = self.offer.quantity_min { + match self.offer.quantity_max { + Some(1) => { + self.offer.quantity_min = None; + self.offer.quantity_max = None; + }, + Some(_) => { + self.offer.quantity_min = None; + }, + None => {}, + } + } + + self + } + + /// Builds an [`Offer`] from the builder's settings. + pub fn build(self) -> Result { + if let Some(Amount::Currency { .. }) = self.offer.amount { + return Err(()); + } + + if self.offer.amount_msats() > MAX_VALUE_MSAT { + return Err(()); + } + + if self.offer.quantity_min() > self.offer.quantity_max() { + return Err(()); + } + + let mut bytes = Vec::new(); + self.offer.write(&mut bytes).unwrap(); + + Ok(Offer { + bytes, + contents: self.offer, + }) + } +} + /// An `Offer` is a potentially long-lived proposal for payment of a good or service. /// /// An offer is precursor to an `InvoiceRequest`. A merchant publishes an offer from which a @@ -122,24 +328,78 @@ impl Offer { /// The minimum quantity of items supported. pub fn quantity_min(&self) -> u64 { - self.contents.quantity_min.unwrap_or(1) + self.contents.quantity_min() } /// The maximum quantity of items supported. pub fn quantity_max(&self) -> u64 { - self.contents.quantity_max.unwrap_or_else(|| - self.contents.quantity_min.map_or(1, |_| u64::max_value())) + self.contents.quantity_max() } /// The public key used by the recipient to sign invoices. pub fn signing_pubkey(&self) -> PublicKey { self.contents.signing_pubkey.unwrap() } + + #[cfg(test)] + fn as_tlv_stream(&self) -> OfferTlvStreamRef { + self.contents.as_tlv_stream() + } +} + +impl OfferContents { + pub fn amount_msats(&self) -> u64 { + self.amount.as_ref().map(Amount::as_msats).unwrap_or(0) + } + + pub fn quantity_min(&self) -> u64 { + self.quantity_min.unwrap_or(1) + } + + pub fn quantity_max(&self) -> u64 { + self.quantity_max.unwrap_or_else(|| + self.quantity_min.map_or(1, |_| u64::max_value())) + } + + fn as_tlv_stream(&self) -> OfferTlvStreamRef { + let (currency, amount) = match &self.amount { + None => (None, None), + Some(Amount::Bitcoin { amount_msats }) => (None, Some(*amount_msats)), + Some(Amount::Currency { iso4217_code, amount }) => ( + Some(iso4217_code), Some(*amount) + ), + }; + + let features = { + if self.features == OfferFeatures::empty() { None } else { Some(&self.features) } + }; + + OfferTlvStreamRef { + chains: self.chains.as_ref(), + metadata: self.metadata.as_ref(), + currency, + amount, + description: Some(&self.description), + features, + absolute_expiry: self.absolute_expiry.map(|duration| duration.as_secs()), + paths: self.paths.as_ref(), + issuer: self.issuer.as_ref(), + quantity_min: self.quantity_min, + quantity_max: self.quantity_max, + node_id: self.signing_pubkey.as_ref(), + } + } +} + +impl Writeable for OfferContents { + fn write(&self, writer: &mut W) -> Result<(), io::Error> { + self.as_tlv_stream().write(writer) + } } /// The minimum amount required for an item in an [`Offer`], denominated in either bitcoin or /// another currency. -#[derive(Clone, Debug)] +#[derive(Clone, Debug, PartialEq)] pub enum Amount { /// An amount of bitcoin. Bitcoin { @@ -155,5 +415,410 @@ pub enum Amount { }, } +impl Amount { + /// Returns the amount in millisatoshi. + pub fn as_msats(&self) -> u64 { + match self { + Amount::Currency { .. } => unimplemented!(), + Amount::Bitcoin { amount_msats } => *amount_msats, + } + } +} + /// An ISO 4712 three-letter currency code (e.g., USD). pub type CurrencyCode = [u8; 3]; + +tlv_stream!(OfferTlvStream, OfferTlvStreamRef, { + (2, chains: Vec), + (4, metadata: Vec), + (6, currency: CurrencyCode), + (8, amount: u64), + (10, description: String), + (12, features: OfferFeatures), + (14, absolute_expiry: u64), + (16, paths: Vec), + (18, issuer: String), + (20, quantity_min: u64), + (22, quantity_max: u64), + (24, node_id: PublicKey), +}); + +#[cfg(test)] +mod tests { + use super::{Amount, OfferBuilder}; + + use bitcoin::blockdata::constants::ChainHash; + use bitcoin::network::constants::Network; + use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey}; + use core::num::NonZeroU64; + use core::time::Duration; + use ln::features::OfferFeatures; + use ln::msgs::MAX_VALUE_MSAT; + use onion_message::{BlindedHop, BlindedPath}; + use util::ser::Writeable; + + fn pubkey(byte: u8) -> PublicKey { + let secp_ctx = Secp256k1::new(); + PublicKey::from_secret_key(&secp_ctx, &privkey(byte)) + } + + fn privkey(byte: u8) -> SecretKey { + SecretKey::from_slice(&[byte; 32]).unwrap() + } + + #[test] + fn builds_offer_with_defaults() { + let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap(); + let tlv_stream = offer.as_tlv_stream(); + let mut buffer = Vec::new(); + offer.contents.write(&mut buffer).unwrap(); + + assert_eq!(offer.bytes, buffer.as_slice()); + assert_eq!(offer.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]); + assert_eq!(offer.metadata(), None); + assert_eq!(offer.amount(), None); + assert_eq!(offer.description(), "foo"); + assert_eq!(offer.features(), &OfferFeatures::empty()); + assert_eq!(offer.absolute_expiry(), None); + #[cfg(feature = "std")] + assert!(!offer.is_expired()); + assert_eq!(offer.paths(), &[]); + assert_eq!(offer.issuer(), None); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), 1); + assert_eq!(offer.signing_pubkey(), pubkey(42)); + + assert_eq!(tlv_stream.chains, None); + assert_eq!(tlv_stream.metadata, None); + assert_eq!(tlv_stream.currency, None); + assert_eq!(tlv_stream.amount, None); + assert_eq!(tlv_stream.description, Some(&String::from("foo"))); + assert_eq!(tlv_stream.features, None); + assert_eq!(tlv_stream.absolute_expiry, None); + assert_eq!(tlv_stream.paths, None); + assert_eq!(tlv_stream.issuer, None); + assert_eq!(tlv_stream.quantity_min, None); + assert_eq!(tlv_stream.quantity_max, None); + assert_eq!(tlv_stream.node_id, Some(&pubkey(42))); + } + + #[test] + fn builds_offer_with_chains() { + let chain = ChainHash::using_genesis_block(Network::Bitcoin); + let chains = vec![ + ChainHash::using_genesis_block(Network::Bitcoin), + ChainHash::using_genesis_block(Network::Testnet), + ]; + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .chain(Network::Bitcoin) + .build() + .unwrap(); + assert_eq!(offer.chains(), vec![chain]); + assert_eq!(offer.as_tlv_stream().chains, Some(&vec![chain])); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .chain(Network::Bitcoin) + .chain(Network::Bitcoin) + .build() + .unwrap(); + assert_eq!(offer.chains(), vec![chain]); + assert_eq!(offer.as_tlv_stream().chains, Some(&vec![chain])); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .chain(Network::Bitcoin) + .chain(Network::Testnet) + .build() + .unwrap(); + assert_eq!(offer.chains(), chains); + assert_eq!(offer.as_tlv_stream().chains, Some(&chains)); + } + + #[test] + fn builds_offer_with_metadata() { + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .metadata(vec![42; 32]) + .build() + .unwrap(); + assert_eq!(offer.metadata(), Some(&vec![42; 32])); + assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![42; 32])); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .metadata(vec![42; 32]) + .metadata(vec![43; 32]) + .build() + .unwrap(); + assert_eq!(offer.metadata(), Some(&vec![43; 32])); + assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![43; 32])); + } + + #[test] + fn builds_offer_with_amount() { + let bitcoin_amount = Amount::Bitcoin { amount_msats: 1000 }; + let currency_amount = Amount::Currency { iso4217_code: *b"USD", amount: 10 }; + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .amount(bitcoin_amount.clone()) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.amount(), Some(&bitcoin_amount)); + assert_eq!(tlv_stream.amount, Some(1000)); + assert_eq!(tlv_stream.currency, None); + + let builder = OfferBuilder::new("foo".into(), pubkey(42)) + .amount(currency_amount.clone()); + let tlv_stream = builder.offer.as_tlv_stream(); + assert_eq!(builder.offer.amount.as_ref(), Some(¤cy_amount)); + assert_eq!(tlv_stream.amount, Some(10)); + assert_eq!(tlv_stream.currency, Some(b"USD")); + match builder.build() { + Ok(_) => panic!("expected error"), + Err(e) => assert_eq!(e, ()), + } + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .amount(currency_amount.clone()) + .amount(bitcoin_amount.clone()) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(tlv_stream.amount, Some(1000)); + assert_eq!(tlv_stream.currency, None); + + let invalid_amount = Amount::Bitcoin { amount_msats: MAX_VALUE_MSAT + 1 }; + match OfferBuilder::new("foo".into(), pubkey(42)).amount(invalid_amount).build() { + Ok(_) => panic!("expected error"), + Err(e) => assert_eq!(e, ()), + } + } + + #[test] + fn builds_offer_with_features() { + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .features(OfferFeatures::unknown()) + .build() + .unwrap(); + assert_eq!(offer.features(), &OfferFeatures::unknown()); + assert_eq!(offer.as_tlv_stream().features, Some(&OfferFeatures::unknown())); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .features(OfferFeatures::unknown()) + .features(OfferFeatures::empty()) + .build() + .unwrap(); + assert_eq!(offer.features(), &OfferFeatures::empty()); + assert_eq!(offer.as_tlv_stream().features, None); + } + + #[test] + fn builds_offer_with_absolute_expiry() { + let future_expiry = Duration::from_secs(u64::max_value()); + let past_expiry = Duration::from_secs(0); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .absolute_expiry(future_expiry) + .build() + .unwrap(); + #[cfg(feature = "std")] + assert!(!offer.is_expired()); + assert_eq!(offer.absolute_expiry(), Some(future_expiry)); + assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(future_expiry.as_secs())); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .absolute_expiry(future_expiry) + .absolute_expiry(past_expiry) + .build() + .unwrap(); + #[cfg(feature = "std")] + assert!(offer.is_expired()); + assert_eq!(offer.absolute_expiry(), Some(past_expiry)); + assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(past_expiry.as_secs())); + } + + #[test] + fn builds_offer_with_paths() { + let paths = vec![ + BlindedPath { + introduction_node_id: pubkey(40), + blinding_point: pubkey(41), + blinded_hops: vec![ + BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] }, + BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] }, + ], + }, + BlindedPath { + introduction_node_id: pubkey(40), + blinding_point: pubkey(41), + blinded_hops: vec![ + BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] }, + BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] }, + ], + }, + ]; + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .path(paths[0].clone()) + .path(paths[1].clone()) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.paths(), paths.as_slice()); + assert_eq!(offer.signing_pubkey(), pubkey(42)); + assert_ne!(pubkey(42), pubkey(44)); + assert_eq!(tlv_stream.paths, Some(&paths)); + assert_eq!(tlv_stream.node_id, Some(&pubkey(42))); + } + + #[test] + fn builds_offer_with_issuer() { + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .issuer("bar".into()) + .build() + .unwrap(); + assert_eq!(offer.issuer(), Some("bar")); + assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("bar"))); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .issuer("bar".into()) + .issuer("baz".into()) + .build() + .unwrap(); + assert_eq!(offer.issuer(), Some("baz")); + assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("baz"))); + } + + #[test] + fn builds_offer_with_fixed_quantity() { + let one = NonZeroU64::new(1).unwrap(); + let five = NonZeroU64::new(5).unwrap(); + let ten = NonZeroU64::new(10).unwrap(); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_fixed(one) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), 1); + assert_eq!(tlv_stream.quantity_min, None); + assert_eq!(tlv_stream.quantity_max, None); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_fixed(ten) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 10); + assert_eq!(offer.quantity_max(), 10); + assert_eq!(tlv_stream.quantity_min, Some(10)); + assert_eq!(tlv_stream.quantity_max, Some(10)); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_fixed(ten) + .quantity_fixed(five) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 5); + assert_eq!(offer.quantity_max(), 5); + assert_eq!(tlv_stream.quantity_min, Some(5)); + assert_eq!(tlv_stream.quantity_max, Some(5)); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(..ten) + .quantity_fixed(five) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 5); + assert_eq!(offer.quantity_max(), 5); + assert_eq!(tlv_stream.quantity_min, Some(5)); + assert_eq!(tlv_stream.quantity_max, Some(5)); + } + + #[test] + fn builds_offer_with_quantity_range() { + let one = NonZeroU64::new(1).unwrap(); + let five = NonZeroU64::new(5).unwrap(); + let ten = NonZeroU64::new(10).unwrap(); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(..) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), u64::max_value()); + assert_eq!(tlv_stream.quantity_min, Some(1)); + assert_eq!(tlv_stream.quantity_max, None); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(..ten) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), 9); + assert_eq!(tlv_stream.quantity_min, None); + assert_eq!(tlv_stream.quantity_max, Some(9)); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(one..ten) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), 9); + assert_eq!(tlv_stream.quantity_min, None); + assert_eq!(tlv_stream.quantity_max, Some(9)); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(five..=ten) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 5); + assert_eq!(offer.quantity_max(), 10); + assert_eq!(tlv_stream.quantity_min, Some(5)); + assert_eq!(tlv_stream.quantity_max, Some(10)); + + let one = NonZeroU64::new(1).unwrap(); + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(one..=one) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), 1); + assert_eq!(tlv_stream.quantity_min, None); + assert_eq!(tlv_stream.quantity_max, None); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(five..=five) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 5); + assert_eq!(offer.quantity_max(), 5); + assert_eq!(tlv_stream.quantity_min, Some(5)); + assert_eq!(tlv_stream.quantity_max, Some(5)); + + let offer = OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_fixed(five) + .quantity_range(..ten) + .build() + .unwrap(); + let tlv_stream = offer.as_tlv_stream(); + assert_eq!(offer.quantity_min(), 1); + assert_eq!(offer.quantity_max(), 9); + assert_eq!(tlv_stream.quantity_min, None); + assert_eq!(tlv_stream.quantity_max, Some(9)); + + assert!(OfferBuilder::new("foo".into(), pubkey(42)) + .quantity_range(ten..five) + .build() + .is_err() + ); + } +} diff --git a/lightning/src/onion_message/blinded_route.rs b/lightning/src/onion_message/blinded_route.rs index a3824e42e..d53a0e0ca 100644 --- a/lightning/src/onion_message/blinded_route.rs +++ b/lightning/src/onion_message/blinded_route.rs @@ -22,33 +22,33 @@ use prelude::*; /// Onion messages can be sent and received to blinded routes, which serve to hide the identity of /// the recipient. -#[derive(Clone, Debug)] +#[derive(Clone, Debug, PartialEq)] pub struct BlindedRoute { /// To send to a blinded route, the sender first finds a route to the unblinded /// `introduction_node_id`, which can unblind its [`encrypted_payload`] to find out the onion /// message's next hop and forward it along. /// /// [`encrypted_payload`]: BlindedHop::encrypted_payload - pub(super) introduction_node_id: PublicKey, + pub(crate) introduction_node_id: PublicKey, /// Used by the introduction node to decrypt its [`encrypted_payload`] to forward the onion /// message. /// /// [`encrypted_payload`]: BlindedHop::encrypted_payload - pub(super) blinding_point: PublicKey, + pub(crate) blinding_point: PublicKey, /// The hops composing the blinded route. pub(crate) blinded_hops: Vec, } /// Used to construct the blinded hops portion of a blinded route. These hops cannot be identified /// by outside observers and thus can be used to hide the identity of the recipient. -#[derive(Clone, Debug)] +#[derive(Clone, Debug, PartialEq)] pub struct BlindedHop { /// The blinded node id of this hop in a blinded route. pub(crate) blinded_node_id: PublicKey, /// The encrypted payload intended for this hop in a blinded route. // The node sending to this blinded route will later encode this payload into the onion packet for // this hop. - pub(super) encrypted_payload: Vec, + pub(crate) encrypted_payload: Vec, } impl BlindedRoute { diff --git a/lightning/src/util/ser.rs b/lightning/src/util/ser.rs index c3f7c19c3..5b0b8e4a8 100644 --- a/lightning/src/util/ser.rs +++ b/lightning/src/util/ser.rs @@ -22,6 +22,7 @@ use core::ops::Deref; use bitcoin::secp256k1::{PublicKey, SecretKey}; use bitcoin::secp256k1::constants::{PUBLIC_KEY_SIZE, SECRET_KEY_SIZE, COMPACT_SIGNATURE_SIZE}; use bitcoin::secp256k1::ecdsa::Signature; +use bitcoin::blockdata::constants::ChainHash; use bitcoin::blockdata::script::Script; use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut}; use bitcoin::consensus; @@ -399,8 +400,7 @@ impl Readable for BigSize { /// In TLV we occasionally send fields which only consist of, or potentially end with, a /// variable-length integer which is simply truncated by skipping high zero bytes. This type /// encapsulates such integers implementing Readable/Writeable for them. -#[cfg_attr(test, derive(PartialEq))] -#[derive(Clone, Debug)] +#[cfg_attr(test, derive(PartialEq, Debug))] pub(crate) struct HighZeroBytesDroppedBigSize(pub T); macro_rules! impl_writeable_primitive { @@ -521,7 +521,7 @@ macro_rules! impl_array { ); } -impl_array!(3); // for rgb +impl_array!(3); // for rgb, ISO 4712 code impl_array!(4); // for IPv4 impl_array!(12); // for OnionV2 impl_array!(16); // for IPv6 @@ -532,7 +532,6 @@ impl_array!(1300); // for OnionPacket.hop_data /// For variable-length values within TLV record where the length is encoded as part of the record. /// Used to prevent encoding the length twice. -#[derive(Clone)] pub(crate) struct WithoutLength(pub T); impl Writeable for WithoutLength<&String> { @@ -888,6 +887,19 @@ impl Readable for BlockHash { } } +impl Writeable for ChainHash { + fn write(&self, w: &mut W) -> Result<(), io::Error> { + w.write_all(self.as_bytes()) + } +} + +impl Readable for ChainHash { + fn read(r: &mut R) -> Result { + let buf: [u8; 32] = Readable::read(r)?; + Ok(ChainHash::from(&buf[..])) + } +} + impl Writeable for OutPoint { fn write(&self, w: &mut W) -> Result<(), io::Error> { self.txid.write(w)?;