X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-invoice%2Fsrc%2Flib.rs;h=94a93fe62b7f1d160c5f1dc0c89ba66b56bf34c1;hb=68149a204f9da3462f15cc108b5efe7a054cd27b;hp=0c73ebc9d7df81f43e13bfeab293306d0923357c;hpb=854d650b5b67821b006a780b2f770be5bbb3ef0a;p=rust-lightning

diff --git a/lightning-invoice/src/lib.rs b/lightning-invoice/src/lib.rs
index 0c73ebc9..94a93fe6 100644
--- a/lightning-invoice/src/lib.rs
+++ b/lightning-invoice/src/lib.rs
@@ -47,8 +47,9 @@ extern crate serde;
 use std::time::SystemTime;
 
 use bech32::u5;
-use bitcoin_hashes::Hash;
-use bitcoin_hashes::sha256;
+use bitcoin::{Address, Network, PubkeyHash, ScriptHash};
+use bitcoin::util::address::{Payload, WitnessVersion};
+use bitcoin_hashes::{Hash, sha256};
 use lightning::ln::PaymentSecret;
 use lightning::ln::features::InvoiceFeatures;
 #[cfg(any(doc, test))]
@@ -218,7 +219,7 @@ pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
 ///  * `H`: exactly one [`TaggedField::PaymentHash`]
 ///  * `T`: the timestamp is set
 ///
-/// (C-not exported) as we likely need to manually select one set of boolean type parameters.
+/// This is not exported to bindings users as we likely need to manually select one set of boolean type parameters.
 #[derive(Eq, PartialEq, Debug, Clone)]
 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> {
 	currency: Currency,
@@ -251,7 +252,7 @@ pub struct Invoice {
 /// Represents the description of an invoice which has to be either a directly included string or
 /// a hash of a description provided out of band.
 ///
-/// (C-not exported) As we don't have a good way to map the reference lifetimes making this
+/// This is not exported to bindings users as we don't have a good way to map the reference lifetimes making this
 /// practically impossible to use safely in languages like C.
 #[derive(Eq, PartialEq, Debug, Clone)]
 pub enum InvoiceDescription<'f> {
@@ -301,7 +302,7 @@ pub struct RawInvoice {
 
 /// Data of the [`RawInvoice`] that is encoded in the human readable part.
 ///
-/// (C-not exported) As we don't yet support `Option<Enum>`
+/// This is not exported to bindings users as we don't yet support `Option<Enum>`
 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 pub struct RawHrp {
 	/// The currency deferred from the 3rd and 4th character of the bech32 transaction
@@ -361,7 +362,7 @@ impl SiPrefix {
 	/// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
 	/// multiplier.
 	///
-	/// (C-not exported) As we don't yet support a slice of enums, and also because this function
+	/// This is not exported to bindings users as we don't yet support a slice of enums, and also because this function
 	/// isn't the most critical to expose.
 	pub fn values_desc() -> &'static [SiPrefix] {
 		use crate::SiPrefix::*;
@@ -389,9 +390,32 @@ pub enum Currency {
 	Signet,
 }
 
+impl From<Network> for Currency {
+	fn from(network: Network) -> Self {
+		match network {
+			Network::Bitcoin => Currency::Bitcoin,
+			Network::Testnet => Currency::BitcoinTestnet,
+			Network::Regtest => Currency::Regtest,
+			Network::Signet => Currency::Signet,
+		}
+	}
+}
+
+impl From<Currency> for Network {
+	fn from(currency: Currency) -> Self {
+		match currency {
+			Currency::Bitcoin => Network::Bitcoin,
+			Currency::BitcoinTestnet => Network::Testnet,
+			Currency::Regtest => Network::Regtest,
+			Currency::Simnet => Network::Regtest,
+			Currency::Signet => Network::Signet,
+		}
+	}
+}
+
 /// Tagged field which may have an unknown tag
 ///
-/// (C-not exported) as we don't currently support TaggedField
+/// This is not exported to bindings users as we don't currently support TaggedField
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 pub enum RawTaggedField {
 	/// Parsed tagged field with known tag
@@ -404,7 +428,7 @@ pub enum RawTaggedField {
 ///
 /// For descriptions of the enum values please refer to the enclosed type's docs.
 ///
-/// (C-not exported) As we don't yet support enum variants with the same name the struct contained
+/// This is not exported to bindings users as we don't yet support enum variants with the same name the struct contained
 /// in the variant.
 #[allow(missing_docs)]
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
@@ -423,7 +447,7 @@ pub enum TaggedField {
 
 /// SHA-256 hash
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
-pub struct Sha256(/// (C-not exported) as the native hash types are not currently mapped
+pub struct Sha256(/// This is not exported to bindings users as the native hash types are not currently mapped
 	pub sha256::Hash);
 
 /// Description string
@@ -446,17 +470,16 @@ pub struct ExpiryTime(Duration);
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 pub struct MinFinalCltvExpiryDelta(pub u64);
 
-// TODO: better types instead onf byte arrays
 /// Fallback address in case no LN payment is possible
 #[allow(missing_docs)]
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 pub enum Fallback {
 	SegWitProgram {
-		version: u5,
+		version: WitnessVersion,
 		program: Vec<u8>,
 	},
-	PubKeyHash([u8; 20]),
-	ScriptHash([u8; 20]),
+	PubKeyHash(PubkeyHash),
+	ScriptHash(ScriptHash),
 }
 
 /// Recoverable signature
@@ -616,6 +639,18 @@ impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<tb::Fals
 		self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
 		self.set_flags()
 	}
+
+	/// Set the description or description hash. This function is only available if no description (hash) was set.
+	pub fn invoice_description(self, description: InvoiceDescription) -> InvoiceBuilder<tb::True, H, T, C, S> {
+		match description {
+			InvoiceDescription::Direct(desc) => {
+				self.description(desc.clone().into_inner())
+			}
+			InvoiceDescription::Hash(hash) => {
+				self.description_hash(hash.0)
+			}
+		}
+	}
 }
 
 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S> {
@@ -878,7 +913,7 @@ impl RawInvoice {
 	/// type `E`. Since the signature of a [`SignedRawInvoice`] is not required to be valid there
 	/// are no constraints regarding the validity of the produced signature.
 	///
-	/// (C-not exported) As we don't currently support passing function pointers into methods
+	/// This is not exported to bindings users as we don't currently support passing function pointers into methods
 	/// explicitly.
 	pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E>
 		where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
@@ -897,7 +932,7 @@ impl RawInvoice {
 
 	/// Returns an iterator over all tagged fields with known semantics.
 	///
-	/// (C-not exported) As there is not yet a manual mapping for a FilterMap
+	/// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
 	pub fn known_tagged_fields(&self)
 		-> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
 	{
@@ -946,7 +981,7 @@ impl RawInvoice {
 		find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
 	}
 
-	/// (C-not exported) as we don't support Vec<&NonOpaqueType>
+	/// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
 	pub fn fallbacks(&self) -> Vec<&Fallback> {
 		find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
 	}
@@ -1026,6 +1061,11 @@ impl From<PositiveTimestamp> for SystemTime {
 }
 
 impl Invoice {
+	/// The hash of the [`RawInvoice`] that was signed.
+	pub fn signable_hash(&self) -> [u8; 32] {
+		self.signed_invoice.hash
+	}
+
 	/// Transform the `Invoice` into it's unchecked version
 	pub fn into_signed_raw(self) -> SignedRawInvoice {
 		self.signed_invoice
@@ -1175,7 +1215,7 @@ impl Invoice {
 
 	/// Returns an iterator over all tagged fields of this Invoice.
 	///
-	/// (C-not exported) As there is not yet a manual mapping for a FilterMap
+	/// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
 	pub fn tagged_fields(&self)
 		-> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
 		self.signed_invoice.raw_invoice().known_tagged_fields()
@@ -1188,7 +1228,7 @@ impl Invoice {
 
 	/// Return the description or a hash of it for longer ones
 	///
-	/// (C-not exported) because we don't yet export InvoiceDescription
+	/// This is not exported to bindings users because we don't yet export InvoiceDescription
 	pub fn description(&self) -> InvoiceDescription {
 		if let Some(direct) = self.signed_invoice.description() {
 			return InvoiceDescription::Direct(direct);
@@ -1218,6 +1258,12 @@ impl Invoice {
 		self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
 	}
 
+	/// Returns the Duration since the Unix epoch at which the invoice expires.
+	/// Returning None if overflow occurred.
+	pub fn expires_at(&self) -> Option<Duration> {
+		self.duration_since_epoch().checked_add(self.expiry_time())
+	}
+
 	/// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
 	pub fn expiry_time(&self) -> Duration {
 		self.signed_invoice.expiry_time()
@@ -1240,6 +1286,20 @@ impl Invoice {
 		}
 	}
 
+	/// Returns the Duration remaining until the invoice expires.
+	#[cfg(feature = "std")]
+	pub fn duration_until_expiry(&self) -> Duration {
+		SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
+			.map(|now| self.expiration_remaining_from_epoch(now))
+			.unwrap_or(Duration::from_nanos(0))
+	}
+
+	/// Returns the Duration remaining until the invoice expires given the current time.
+	/// `time` is the timestamp as a duration since the Unix epoch.
+	pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration {
+		self.expires_at().map(|x| x.checked_sub(time)).flatten().unwrap_or(Duration::from_nanos(0))
+	}
+
 	/// Returns whether the expiry time would pass at the given point in time.
 	/// `at_time` is the timestamp as a duration since the Unix epoch.
 	pub fn would_expire(&self, at_time: Duration) -> bool {
@@ -1258,11 +1318,30 @@ impl Invoice {
 
 	/// Returns a list of all fallback addresses
 	///
-	/// (C-not exported) as we don't support Vec<&NonOpaqueType>
+	/// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
 	pub fn fallbacks(&self) -> Vec<&Fallback> {
 		self.signed_invoice.fallbacks()
 	}
 
+	/// Returns a list of all fallback addresses as [`Address`]es
+	pub fn fallback_addresses(&self) -> Vec<Address> {
+		self.fallbacks().iter().map(|fallback| {
+			let payload = match fallback {
+				Fallback::SegWitProgram { version, program } => {
+					Payload::WitnessProgram { version: *version, program: program.to_vec() }
+				}
+				Fallback::PubKeyHash(pkh) => {
+					Payload::PubkeyHash(*pkh)
+				}
+				Fallback::ScriptHash(sh) => {
+					Payload::ScriptHash(*sh)
+				}
+			};
+
+			Address { payload, network: self.network() }
+		}).collect()
+	}
+
 	/// Returns a list of all routes included in the invoice
 	pub fn private_routes(&self) -> Vec<&PrivateRoute> {
 		self.signed_invoice.private_routes()
@@ -1280,6 +1359,13 @@ impl Invoice {
 		self.signed_invoice.currency()
 	}
 
+	/// Returns the network for which the invoice was issued
+	///
+	/// This is not exported to bindings users, see [`Self::currency`] instead.
+	pub fn network(&self) -> Network {
+		self.signed_invoice.currency().into()
+	}
+
 	/// Returns the amount if specified in the invoice as millisatoshis.
 	pub fn amount_milli_satoshis(&self) -> Option<u64> {
 		self.signed_invoice.amount_pico_btc().map(|v| v / 10)
@@ -1564,7 +1650,7 @@ impl<'de> Deserialize<'de> for Invoice {
 	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 		let bolt11 = String::deserialize(deserializer)?
 			.parse::<Invoice>()
-			.map_err(|e| D::Error::custom(format!("{:?}", e)))?;
+			.map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
 
 		Ok(bolt11)
 	}
@@ -1572,6 +1658,7 @@ impl<'de> Deserialize<'de> for Invoice {
 
 #[cfg(test)]
 mod test {
+	use bitcoin::Script;
 	use bitcoin_hashes::hex::FromHex;
 	use bitcoin_hashes::sha256;
 
@@ -1935,7 +2022,7 @@ mod test {
 			.payee_pub_key(public_key)
 			.expiry_time(Duration::from_secs(54321))
 			.min_final_cltv_expiry_delta(144)
-			.fallback(Fallback::PubKeyHash([0;20]))
+			.fallback(Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap()))
 			.private_route(route_1.clone())
 			.private_route(route_2.clone())
 			.description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
@@ -1961,7 +2048,9 @@ mod test {
 		assert_eq!(invoice.payee_pub_key(), Some(&public_key));
 		assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
 		assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
-		assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash([0;20])]);
+		assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap())]);
+		let address = Address::from_script(&Script::new_p2pkh(&PubkeyHash::from_slice(&[0;20]).unwrap()), Network::Testnet).unwrap();
+		assert_eq!(invoice.fallback_addresses(), vec![address]);
 		assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
 		assert_eq!(
 			invoice.description(),