add RGB amount to bolt11 invoice

zoedberg · zoedberg · commit e4968780fb03 · 2023-04-05T16:43:58.000+02:00
diff --git a/lightning-invoice/src/de.rs b/lightning-invoice/src/de.rs
@@ -11,6 +11,7 @@ use bech32::{u5, FromBase32};
 
 use bitcoin_hashes::Hash;
 use bitcoin_hashes::sha256;
+use rgb::ContractId;
 use crate::prelude::*;
 use lightning::ln::PaymentSecret;
 use lightning::routing::gossip::RoutingFees;
@@ -24,7 +25,7 @@ use secp256k1::PublicKey;
 
 use super::{Invoice, Sha256, TaggedField, ExpiryTime, MinFinalCltvExpiry, Fallback, PayeePubKey, InvoiceSignature, PositiveTimestamp,
 	SemanticError, PrivateRoute, ParseError, ParseOrSemanticError, Description, RawTaggedField, Currency, RawHrp, SiPrefix, RawInvoice,
-	constants, SignedRawInvoice, RawDataPart, InvoiceFeatures};
+	constants, SignedRawInvoice, RawDataPart, InvoiceFeatures, RgbAmount, RgbContractId};
 
 use self::hrp_sm::parse_hrp;
 
@@ -461,6 +462,10 @@ impl FromBase32 for TaggedField {
 				Ok(TaggedField::PaymentSecret(PaymentSecret::from_base32(field_data)?)),
 			constants::TAG_FEATURES =>
 				Ok(TaggedField::Features(InvoiceFeatures::from_base32(field_data)?)),
+			constants::TAG_RGB_AMOUNT =>
+				Ok(TaggedField::RgbAmount(RgbAmount::from_base32(field_data)?)),
+			constants::TAG_RGB_CONTRACT_ID =>
+				Ok(TaggedField::RgbContractId(RgbContractId::from_base32(field_data)?)),
 			_ => {
 				// "A reader MUST skip over unknown fields"
 				Err(ParseError::Skip)
@@ -619,6 +624,32 @@ impl FromBase32 for PrivateRoute {
 	}
 }
 
+impl FromBase32 for RgbAmount {
+	type Err = ParseError;
+
+	fn from_base32(field_data: &[u5]) -> Result<RgbAmount, ParseError> {
+		let rgb_amount = parse_int_be::<u64, u5>(field_data, 32);
+		if let Some(rgb_amount) = rgb_amount {
+			Ok(RgbAmount(rgb_amount))
+		} else {
+			Err(ParseError::IntegerOverflowError)
+		}
+	}
+}
+
+impl FromBase32 for RgbContractId {
+	type Err = ParseError;
+
+	fn from_base32(field_data: &[u5]) -> Result<RgbContractId, ParseError> {
+		let bytes = Vec::<u8>::from_base32(field_data)?;
+		let rgb_contract_id_str = String::from(str::from_utf8(&bytes)?);
+		match ContractId::from_str(&rgb_contract_id_str) {
+			Ok(cid) => Ok(RgbContractId(cid)),
+			Err(_) => Err(ParseError::InvalidContractId),
+		}
+	}
+}
+
 impl Display for ParseError {
 	fn fmt(&self, f: &mut Formatter) -> fmt::Result {
 		match *self {
@@ -667,6 +698,9 @@ impl Display for ParseError {
 			ParseError::Skip => {
 				f.write_str("the tagged field has to be skipped because of an unexpected, but allowed property")
 			},
+			ParseError::InvalidContractId => {
+				f.write_str("invalid RGB contract ID")
+			},
 		}
 	}
 }
diff --git a/lightning-invoice/src/lib.rs b/lightning-invoice/src/lib.rs
@@ -55,6 +55,7 @@ use lightning::routing::gossip::RoutingFees;
 use lightning::routing::router::RouteHint;
 use lightning::util::invoice::construct_invoice_preimage;
 
+use rgb::ContractId;
 use secp256k1::PublicKey;
 use secp256k1::{Message, Secp256k1};
 use secp256k1::ecdsa::RecoverableSignature;
@@ -121,6 +122,7 @@ pub enum ParseError {
 	InvalidScriptHashLength,
 	InvalidRecoveryId,
 	InvalidSliceLength(String),
+	InvalidContractId,
 
 	/// Not an error, but used internally to signal that a part of the invoice should be ignored
 	/// according to BOLT11
@@ -416,6 +418,8 @@ pub enum TaggedField {
 	PrivateRoute(PrivateRoute),
 	PaymentSecret(PaymentSecret),
 	Features(InvoiceFeatures),
+	RgbAmount(RgbAmount),
+	RgbContractId(RgbContractId),
 }
 
 /// SHA-256 hash
@@ -443,6 +447,14 @@ pub struct ExpiryTime(Duration);
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 pub struct MinFinalCltvExpiry(pub u64);
 
+/// Requested amount for the RGB asset
+#[derive(Clone, Debug, Hash, Eq, PartialEq)]
+pub struct RgbAmount(pub u64);
+
+/// Requested RGB contract ID
+#[derive(Clone, Debug, Hash, Eq, PartialEq)]
+pub struct RgbContractId(pub ContractId);
+
 // TODO: better types instead onf byte arrays
 /// Fallback address in case no LN payment is possible
 #[allow(missing_docs)]
@@ -481,6 +493,8 @@ pub mod constants {
 	pub const TAG_PRIVATE_ROUTE: u8 = 3;
 	pub const TAG_PAYMENT_SECRET: u8 = 16;
 	pub const TAG_FEATURES: u8 = 5;
+	pub const TAG_RGB_AMOUNT: u8 = 30;
+	pub const TAG_RGB_CONTRACT_ID: u8 = 31;
 }
 
 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False> {
@@ -562,6 +576,18 @@ impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBui
 		}
 		self
 	}
+
+	/// Sets the RGB amount.
+	pub fn rgb_amount(mut self, rgb_amount: u64) -> Self {
+		self.tagged_fields.push(TaggedField::RgbAmount(RgbAmount(rgb_amount)));
+		self
+	}
+
+	/// Sets the RGB contract ID.
+	pub fn rgb_contract_id(mut self, rgb_contract_id: ContractId) -> Self {
+		self.tagged_fields.push(TaggedField::RgbContractId(RgbContractId(rgb_contract_id)));
+		self
+	}
 }
 
 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S> {
@@ -938,6 +964,14 @@ impl RawInvoice {
 		find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
 	}
 
+	pub fn rgb_amount(&self) -> Option<&RgbAmount> {
+		find_extract!(self.known_tagged_fields(), TaggedField::RgbAmount(ref x), x)
+	}
+
+	pub fn rgb_contract_id(&self) -> Option<&RgbContractId> {
+		find_extract!(self.known_tagged_fields(), TaggedField::RgbContractId(ref x), x)
+	}
+
 	/// (C-not exported) 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()
@@ -1281,6 +1315,18 @@ impl Invoice {
 	fn amount_pico_btc(&self) -> Option<u64> {
 		self.signed_invoice.amount_pico_btc()
 	}
+
+	/// Returns the invoice's `rgb_amount` if present
+	pub fn rgb_amount(&self) -> Option<u64> {
+		self.signed_invoice.rgb_amount()
+			.map(|x| x.0)
+	}
+
+	/// Returns the invoice's `rgb_contract_id` if present
+	pub fn rgb_contract_id(&self) -> Option<ContractId> {
+		self.signed_invoice.rgb_contract_id()
+			.map(|x| x.0)
+	}
 }
 
 impl From<TaggedField> for RawTaggedField {
@@ -1303,6 +1349,8 @@ impl TaggedField {
 			TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
 			TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
 			TaggedField::Features(_) => constants::TAG_FEATURES,
+			TaggedField::RgbAmount(_) => constants::TAG_RGB_AMOUNT,
+			TaggedField::RgbContractId(_) => constants::TAG_RGB_CONTRACT_ID,
 		};
 
 		u5::try_from_u8(tag).expect("all tags defined are <32")
diff --git a/lightning-invoice/src/payment.rs b/lightning-invoice/src/payment.rs
@@ -425,6 +425,7 @@ where
 			hash_map::Entry::Occupied(_) => return Err(PaymentError::Invoice("payment pending")),
 			hash_map::Entry::Vacant(entry) => entry.insert(PaymentAttempts::new()),
 		};
+		write_rgb_payment_info_file(&self.ldk_data_dir, &payment_hash, invoice.rgb_contract_id().unwrap(), invoice.rgb_amount().unwrap());
 
 		let payment_secret = Some(invoice.payment_secret().clone());
 		let mut payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
diff --git a/lightning-invoice/src/ser.rs b/lightning-invoice/src/ser.rs
@@ -4,7 +4,7 @@ use bech32::{ToBase32, u5, WriteBase32, Base32Len};
 use crate::prelude::*;
 
 use super::{Invoice, Sha256, TaggedField, ExpiryTime, MinFinalCltvExpiry, Fallback, PayeePubKey, InvoiceSignature, PositiveTimestamp,
-	PrivateRoute, Description, RawTaggedField, Currency, RawHrp, SiPrefix, constants, SignedRawInvoice, RawDataPart};
+	PrivateRoute, Description, RawTaggedField, Currency, RawHrp, SiPrefix, constants, SignedRawInvoice, RawDataPart, RgbAmount, RgbContractId};
 
 /// Converts a stream of bytes written to it to base32. On finalization the according padding will
 /// be applied. That means the results of writing two data blocks with one or two `BytesToBase32`
@@ -399,6 +399,30 @@ impl Base32Len for PrivateRoute {
 	}
 }
 
+impl ToBase32 for RgbAmount {
+	fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
+		writer.write(&encode_int_be_base32(self.0))
+	}
+}
+
+impl Base32Len for RgbAmount {
+	fn base32_len(&self) -> usize {
+		encoded_int_be_base32_size(self.0)
+	}
+}
+
+impl ToBase32 for RgbContractId {
+	fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
+		self.0.to_string().as_bytes().write_base32(writer)
+	}
+}
+
+impl Base32Len for RgbContractId {
+	fn base32_len(&self) -> usize {
+		self.0.to_string().as_bytes().base32_len()
+	}
+}
+
 impl ToBase32 for TaggedField {
 	fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
 		/// Writes a tagged field: tag, length and data. `tag` should be in `0..32` otherwise the
@@ -449,6 +473,12 @@ impl ToBase32 for TaggedField {
 			TaggedField::Features(ref features) => {
 				write_tagged_field(writer, constants::TAG_FEATURES, features)
 			},
+			TaggedField::RgbAmount(ref rgb_amount) => {
+				write_tagged_field(writer, constants::TAG_RGB_AMOUNT, rgb_amount)
+			},
+			TaggedField::RgbContractId(ref rgb_contract_id) => {
+				write_tagged_field(writer, constants::TAG_RGB_CONTRACT_ID, rgb_contract_id)
+			},
 		}
 	}
 }
diff --git a/lightning-invoice/src/utils.rs b/lightning-invoice/src/utils.rs
@@ -17,6 +17,7 @@ use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
 use lightning::routing::gossip::RoutingFees;
 use lightning::routing::router::{InFlightHtlcs, Route, RouteHint, RouteHintHop};
 use lightning::util::logger::Logger;
+use rgb::ContractId;
 use secp256k1::PublicKey;
 use core::ops::Deref;
 use core::time::Duration;
@@ -234,7 +235,7 @@ where
 /// in excess of the current time.
 pub fn create_invoice_from_channelmanager<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
-	network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32
+	network: Currency, amt_msat: Option<u64>, description: String, invoice_expiry_delta_secs: u32, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 where
 	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -248,7 +249,7 @@ where
 		.expect("for the foreseeable future this shouldn't happen");
 	create_invoice_from_channelmanager_and_duration_since_epoch(
 		channelmanager, keys_manager, logger, network, amt_msat, description, duration,
-		invoice_expiry_delta_secs
+		invoice_expiry_delta_secs, contract_id, amt_rgb
 	)
 }
 
@@ -265,7 +266,7 @@ where
 pub fn create_invoice_from_channelmanager_with_description_hash<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
-	invoice_expiry_delta_secs: u32
+	invoice_expiry_delta_secs: u32, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 where
 	M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -282,7 +283,7 @@ where
 
 	create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(
 		channelmanager, keys_manager, logger, network, amt_msat,
-		description_hash, duration, invoice_expiry_delta_secs
+		description_hash, duration, invoice_expiry_delta_secs, contract_id, amt_rgb
 	)
 }
 
@@ -292,7 +293,7 @@ where
 pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
-	duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
+	duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 		where
 			M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -304,7 +305,7 @@ pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_sin
 	_create_invoice_from_channelmanager_and_duration_since_epoch(
 		channelmanager, keys_manager, logger, network, amt_msat,
 		InvoiceDescription::Hash(&description_hash),
-		duration_since_epoch, invoice_expiry_delta_secs
+		duration_since_epoch, invoice_expiry_delta_secs, contract_id, amt_rgb
 	)
 }
 
@@ -314,7 +315,7 @@ pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_sin
 pub fn create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
-	invoice_expiry_delta_secs: u32
+	invoice_expiry_delta_secs: u32, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 		where
 			M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -328,14 +329,14 @@ pub fn create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T:
 		InvoiceDescription::Direct(
 			&Description::new(description).map_err(SignOrCreationError::CreationError)?,
 		),
-		duration_since_epoch, invoice_expiry_delta_secs
+		duration_since_epoch, invoice_expiry_delta_secs, contract_id, amt_rgb
 	)
 }
 
 fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description: InvoiceDescription,
-	duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
+	duration_since_epoch: Duration, invoice_expiry_delta_secs: u32, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 		where
 			M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -350,7 +351,7 @@ fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Der
 		.create_inbound_payment(amt_msat, invoice_expiry_delta_secs)
 		.map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
 	_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
-		channelmanager, keys_manager, logger, network, amt_msat, description, duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret)
+		channelmanager, keys_manager, logger, network, amt_msat, description, duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret, contract_id, amt_rgb)
 }
 
 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
@@ -360,7 +361,7 @@ fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Der
 pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
-	invoice_expiry_delta_secs: u32, payment_hash: PaymentHash
+	invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 	where
 		M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -377,14 +378,14 @@ pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_
 		InvoiceDescription::Direct(
 			&Description::new(description).map_err(SignOrCreationError::CreationError)?,
 		),
-		duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret
+		duration_since_epoch, invoice_expiry_delta_secs, payment_hash, payment_secret, contract_id, amt_rgb
 	)
 }
 
 fn _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description: InvoiceDescription, duration_since_epoch: Duration,
-	invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, payment_secret: PaymentSecret
+	invoice_expiry_delta_secs: u32, payment_hash: PaymentHash, payment_secret: PaymentSecret, contract_id: Option<ContractId>, amt_rgb: Option<u64>
 ) -> Result<Invoice, SignOrCreationError<()>>
 	where
 		M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
@@ -416,6 +417,12 @@ fn _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_has
 	if let Some(amt) = amt_msat {
 		invoice = invoice.amount_milli_satoshis(amt);
 	}
+	if let Some(cid) = contract_id {
+		invoice = invoice.rgb_contract_id(cid);
+	}
+	if let Some(amt) = amt_rgb {
+		invoice = invoice.rgb_amount(amt);
+	}
 
 	let route_hints = filter_channels(channels, amt_msat, &logger);
 	for hint in route_hints {
