WIP Add package template unit tests

Author: Antoine Riard

lightning/src/chain/onchain_utils.rs

@@ -820,3 +820,129 @@ pub(crate) fn get_height_timer(current_height: u32, timelock_expiration: u32) ->
 	}
 	current_height + 15
 }
+
+#[cfg(test)]
+mod tests {
+	use chain::onchain_utils::{CounterpartyHTLCOutput, PackageTemplate, PackageMalleability, PackageSolvingData, RevokedOutput, WEIGHT_REVOKED_OFFERED_HTLC};
+	use chain::Txid;
+	use ln::chan_utils::HTLCOutputInCommitment;
+	use ln::PaymentHash;
+
+	use bitcoin::hashes::hex::FromHex;
+
+	use bitcoin::secp256k1::key::{PublicKey,SecretKey};
+	use bitcoin::secp256k1::Secp256k1;
+
+	macro_rules! dumb_revk_output {
+		($secp_ctx: expr) => {
+			{
+				let dumb_scalar = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
+				let dumb_point = PublicKey::from_secret_key(&$secp_ctx, &dumb_scalar);
+				PackageSolvingData::RevokedOutput(RevokedOutput::build(dumb_point, dumb_scalar, dumb_point, dumb_point, WEIGHT_REVOKED_OFFERED_HTLC, 0, None, 0))
+			}
+		}
+	}
+
+	macro_rules! dumb_counterparty_output {
+		($secp_ctx: expr) => {
+			{
+				let dumb_scalar = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
+				let dumb_point = PublicKey::from_secret_key(&$secp_ctx, &dumb_scalar);
+				let hash = PaymentHash([1; 32]);
+				let htlc = HTLCOutputInCommitment { offered: true, amount_msat: 0, cltv_expiry: 0, payment_hash: hash, transaction_output_index: None };
+				PackageSolvingData::CounterpartyHTLCOutput(CounterpartyHTLCOutput::build(dumb_point, dumb_point, dumb_point, None, htlc))
+			}
+		}
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_differing_heights() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+
+		let mut package_one_hundred = PackageTemplate::build_package(txid, 0, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		let package_two_hundred = PackageTemplate::build_package(txid, 1, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 200);
+		package_one_hundred.merge_package(package_two_hundred);
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_untractable_merge_to() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+
+		let mut untractable_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), PackageMalleability::Untractable, 1000, true, 0, None, 100);
+		let malleable_package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		untractable_package.merge_package(malleable_package);
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_untractable_merge_from() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+
+		let mut malleable_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		let untractable_package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), PackageMalleability::Untractable, 1000, true, 0, None, 100);
+		malleable_package.merge_package(untractable_package);
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_noaggregation_to() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+
+		let mut noaggregation_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), PackageMalleability::Malleable, 1000, false, 0, None, 100);
+		let aggregation_package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		noaggregation_package.merge_package(aggregation_package);
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_noaggregation_from() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+
+		let mut aggregation_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		let noaggregation_package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), PackageMalleability::Malleable, 1000, false, 0, None, 100);
+		aggregation_package.merge_package(noaggregation_package);
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_empty() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+
+		let mut empty_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		empty_package.inputs = vec![];
+		let package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		empty_package.merge_package(package);
+	}
+
+	#[test]
+	#[should_panic]
+	fn test_package_differing_categories() {
+		let txid = Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
+		let secp_ctx = Secp256k1::new();
+		let revk_outp = dumb_revk_output!(secp_ctx);
+		let counterparty_outp = dumb_counterparty_output!(secp_ctx);
+
+		let mut revoked_package = PackageTemplate::build_package(txid, 0, revk_outp, PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		let counterparty_package = PackageTemplate::build_package(txid, 1, counterparty_outp, PackageMalleability::Malleable, 1000, true, 0, None, 100);
+		revoked_package.merge_package(counterparty_package);
+	}
+
+	//TODO: split_package
+	//TODO: package_amounts
+	//TODO: package_weights
+	//TODO: finalize_package
+}