Add accessors to Invoice to get hrp data

Add accessors to Invoice to get hrp data

Author: sgeisler

Cargo.toml

@@ -6,7 +6,7 @@ license = "Apache-2.0"
 
 [dependencies]
 bech32 = "0.5.0"
-secp256k1 = "0.10"
-bitcoin = "0.13"
+secp256k1 = "0.11"
+bitcoin = "0.14"
 num-traits = "0.2"
-bitcoin_hashes = {git = "https://github.com/rust-bitcoin/bitcoin_hashes"}
+bitcoin_hashes = {git = "https://github.com/rust-bitcoin/bitcoin_hashes"}

src/de.rs

@@ -283,7 +283,13 @@ impl FromStr for RawHrp {
 		let si_prefix: Option<SiPrefix> = if parts.2.is_empty() {
 			None
 		} else {
-			Some(parts.2.parse()?)
+			let si: SiPrefix = parts.2.parse()?;
+			if let Some(amt) = amount {
+				if amt.checked_mul(si.multiplier()).is_none() {
+					return Err(ParseError::IntegerOverflowError);
+				}
+			}
+			Some(si)
 		};
 
 		Ok(RawHrp {
@@ -931,4 +937,4 @@ mod test {
 			)
 		)
 	}
-}
+}

src/lib.rs

@@ -159,7 +159,20 @@ pub enum SiPrefix {
 	Pico,
 }
 
-#[derive(Eq, PartialEq, Debug)]
+impl SiPrefix {
+	/// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
+	/// This is effectively 10^12 * the prefix multiplier
+	pub fn multiplier(&self) -> u64 {
+		match self {
+			&SiPrefix::Milli => 1_000_000_000,
+			&SiPrefix::Micro => 1_000_000,
+			&SiPrefix::Nano => 1_000,
+			&SiPrefix::Pico => 1,
+		}
+	}
+}
+
+#[derive(Eq, PartialEq, Debug, Clone)]
 pub enum Currency {
 	Bitcoin,
 	BitcoinTestnet,
@@ -312,14 +325,6 @@ impl<D: tb::Bool, H: tb::Bool> InvoiceBuilder<D, H> {
 		self
 	}
 
-	/// Sets the amount as a combination of a SI prefix and a multiplier. This function won't change
-	/// the SI prefix even if there is a more optimal one.
-	pub fn amount_si(mut self, amount: u64, si_prefix: SiPrefix) -> Self {
-		self.amount = Some(amount);
-		self.si_prefix = Some(si_prefix);
-		self
-	}
-
 	/// Sets the timestamp. `time` is a UNIX timestamp.
 	pub fn timestamp(mut self, time: u64) -> Self {
 		self.timestamp = Some(time);
@@ -667,6 +672,16 @@ impl RawInvoice {
 			num_traits => None,
 		}).collect::<Vec<&Route>>()
 	}
+
+	pub fn amount_pico_btc(&self) -> Option<u64> {
+		self.hrp.raw_amount.map(|v| {
+			v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
+		})
+	}
+
+	pub fn currency(&self) -> Currency {
+		self.hrp.currency.clone()
+	}
 }
 
 impl Invoice {
@@ -778,6 +793,14 @@ impl Invoice {
 	pub fn routes(&self) -> Vec<&Route> {
 		self.signed_invoice.routes()
 	}
+
+	pub fn currency(&self) -> Currency {
+		self.signed_invoice.currency()
+	}
+
+	pub fn amount_pico_btc(&self) -> Option<u64> {
+		self.signed_invoice.amount_pico_btc()
+	}
 }
 
 impl From<TaggedField> for RawTaggedField {
@@ -1033,4 +1056,4 @@ mod test {
 
 		assert!(new_signed.check_signature());
 	}
-}
+}