Add Features::set_custom_bit

Custom message handlers may need to set feature bits that are unknown to
LDK. Provide a Features::set_custom_bit to allow for this.

Author: jkczyz

lightning/src/ln/features.rs

@@ -722,6 +722,32 @@ impl<T: sealed::Context> Features<T> {
 		}
 		true
 	}
+
+	/// Sets a custom feature bit. Errors if `bit` is outside the custom range as defined by
+	/// [bLIP 2] or if it is a known `T` feature.
+	///
+	/// [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
+	pub fn set_custom_bit(&mut self, bit: usize) -> Result<(), ()> {
+		if bit < 256 {
+			return Err(());
+		}
+
+		let byte_offset = bit / 8;
+		let mask = 1 << (bit - 8 * byte_offset);
+		if byte_offset < T::KNOWN_FEATURE_MASK.len() {
+			if (T::KNOWN_FEATURE_MASK[byte_offset] & mask) != 0 {
+				return Err(());
+			}
+		}
+
+		if self.flags.len() <= byte_offset {
+			self.flags.resize(byte_offset + 1, 0u8);
+		}
+
+		self.flags[byte_offset] |= mask;
+
+		Ok(())
+	}
 }
 
 impl<T: sealed::UpfrontShutdownScript> Features<T> {
@@ -923,6 +949,26 @@ mod tests {
 		assert!(features.supports_payment_secret());
 	}
 
+	#[test]
+	fn set_custom_bits() {
+		let mut features = InvoiceFeatures::empty();
+		features.set_variable_length_onion_optional();
+		assert_eq!(features.flags[1], 0b00000010);
+
+		assert!(features.set_custom_bit(255).is_err());
+		assert!(features.set_custom_bit(256).is_ok());
+		assert!(features.set_custom_bit(258).is_ok());
+		assert_eq!(features.flags[31], 0b00000000);
+		assert_eq!(features.flags[32], 0b00000101);
+
+		let known_bit = <sealed::InvoiceContext as sealed::PaymentSecret>::EVEN_BIT;
+		let byte_offset = <sealed::InvoiceContext as sealed::PaymentSecret>::BYTE_OFFSET;
+		assert_eq!(byte_offset, 1);
+		assert_eq!(features.flags[byte_offset], 0b00000010);
+		assert!(features.set_custom_bit(known_bit).is_err());
+		assert_eq!(features.flags[byte_offset], 0b00000010);
+	}
+
 	#[test]
 	fn feature_difference() {
 		let mut features1 = InitFeatures::empty();