Skip to content

Commit adb0b88

Browse files
arik-soarik-so
committed
Test create_payment_onion for Trampoline
1 parent 0d4c649 commit adb0b88

File tree

2 files changed

+146
-31
lines changed

2 files changed

+146
-31
lines changed

‎lightning/src/ln/blinded_payment_tests.rs

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
// licenses.
99

1010
use bitcoin::hashes::hex::FromHex;
11+
use bitcoin::hex::DisplayHex;
1112
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, schnorr};
1213
use bitcoin::secp256k1::ecdh::SharedSecret;
1314
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
@@ -30,16 +31,18 @@ use crate::ln::outbound_payment::{Retry, IDEMPOTENCY_TIMEOUT_TICKS};
3031
use crate::offers::invoice::UnsignedBolt12Invoice;
3132
use crate::offers::nonce::Nonce;
3233
use crate::prelude::*;
33-
use crate::routing::router::{BlindedTail, Path, Payee, PaymentParameters, RouteHop, RouteParameters};
34+
use crate::routing::router::{BlindedTail, Path, Payee, PaymentParameters, RouteHop, RouteParameters, TrampolineHop};
3435
use crate::sign::{NodeSigner, Recipient};
3536
use crate::util::config::UserConfig;
36-
use crate::util::ser::WithoutLength;
37+
use crate::util::ser::{WithoutLength, Writeable};
3738
use crate::util::test_utils;
3839
use lightning_invoice::RawBolt11Invoice;
3940
#[cfg(async_payments)] use {
4041
crate::ln::inbound_payment,
4142
crate::types::payment::PaymentPreimage,
4243
};
44+
use types::features::Features;
45+
use crate::blinded_path::BlindedHop;
4346

4447
fn blinded_payment_path(
4548
payment_secret: PaymentSecret, intro_node_min_htlc: u64, intro_node_max_htlc: u64,
@@ -1759,3 +1762,83 @@ fn route_blinding_spec_test_vector() {
17591762
_ => panic!("Unexpected error")
17601763
}
17611764
}
1765+
1766+
#[test]
1767+
fn combined_trampoline_onion_creation_test() {
1768+
let mut secp_ctx = Secp256k1::new();
1769+
let session_priv = SecretKey::from_slice(&<Vec<u8>>::from_hex("a64feb81abd58e473df290e9e1c07dc3e56114495cadf33191f44ba5448ebe99").unwrap()).unwrap();
1770+
1771+
let path = Path {
1772+
hops: vec![
1773+
// Bob
1774+
RouteHop {
1775+
pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()).unwrap(),
1776+
node_features: NodeFeatures::empty(),
1777+
short_channel_id: 0,
1778+
channel_features: ChannelFeatures::empty(),
1779+
fee_msat: 0,
1780+
cltv_expiry_delta: 0,
1781+
maybe_announced_channel: false,
1782+
},
1783+
1784+
// Carol
1785+
RouteHop {
1786+
pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()).unwrap(),
1787+
node_features: NodeFeatures::empty(),
1788+
short_channel_id: (572330 << 40) + (42 << 16) + 2821,
1789+
channel_features: ChannelFeatures::empty(),
1790+
fee_msat: 150_153_000,
1791+
cltv_expiry_delta: 24,
1792+
maybe_announced_channel: false,
1793+
},
1794+
],
1795+
trampoline_hops: vec![
1796+
// Carol's pubkey
1797+
TrampolineHop {
1798+
pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()).unwrap(),
1799+
node_features: Features::empty(),
1800+
fee_msat: 0,
1801+
cltv_expiry_delta: 0,
1802+
},
1803+
// Dave's pubkey (the intro node needs to be duplicated)
1804+
TrampolineHop {
1805+
pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()).unwrap(),
1806+
node_features: Features::empty(),
1807+
fee_msat: 150_500, // incorporate both base and proportional fee
1808+
cltv_expiry_delta: 36,
1809+
}
1810+
],
1811+
blinded_tail: Some(BlindedTail {
1812+
hops: vec![
1813+
BlindedHop {
1814+
blinded_node_id: PublicKey::from_slice(&<Vec<u8>>::from_hex("0295d40514096a8be54859e7dfe947b376eaafea8afe5cb4eb2c13ff857ed0b4be").unwrap()).unwrap(),
1815+
encrypted_payload: <Vec<u8>>::from_hex("0ccf3c8a58deaa603f657ee2a5ed9d604eb5c8ca1e5f801989afa8f3ea6d789bbdde2c7e7a1ef9ca8c38d2c54760febad8446d3f273ddb537569ef56613846ccd3aba78a").unwrap(),
1816+
},
1817+
BlindedHop {
1818+
blinded_node_id: PublicKey::from_slice(&<Vec<u8>>::from_hex("020e2dbadcc2005e859819ddebbe88a834ae8a6d2b049233c07335f15cd1dc5f22").unwrap()).unwrap(),
1819+
encrypted_payload: <Vec<u8>>::from_hex("bcd747394fbd4d99588da075a623316e15a576df5bc785cccc7cd6ec7b398acce6faf520175f9ec920f2ef261cdb83dc28cc3a0eeb970107b3306489bf771ef5b1213bca811d345285405861d08a655b6c237fa247a8b4491beee20c878a60e9816492026d8feb9dafa84585b253978db6a0aa2945df5ef445c61e801fb82f43d5f00716baf9fc9b3de50bc22950a36bda8fc27bfb1242e5860c7e687438d4133e058770361a19b6c271a2a07788d34dccc27e39b9829b061a4d960eac4a2c2b0f4de506c24f9af3868c0aff6dda27281c").unwrap(),
1820+
}
1821+
],
1822+
blinding_point: PublicKey::from_slice(&<Vec<u8>>::from_hex("02988face71e92c345a068f740191fd8e53be14f0bb957ef730d3c5f76087b960e").unwrap()).unwrap(),
1823+
excess_final_cltv_expiry_delta: 0,
1824+
final_value_msat: 150_000_000,
1825+
final_hop_supports_trampoline: true,
1826+
}),
1827+
};
1828+
1829+
let associated_data_slice = SecretKey::from_slice(&<Vec<u8>>::from_hex("e89bc505e84aaca09613833fc58c9069078fb43bfbea0488f34eec9db99b5f82").unwrap()).unwrap();
1830+
let associated_data = PaymentHash(associated_data_slice.secret_bytes());
1831+
let payment_secret = PaymentSecret(SecretKey::from_slice(&<Vec<u8>>::from_hex("7494b65bc092b48a75465e43e29be807eb2cc535ce8aaba31012b8ff1ceac5da").unwrap()).unwrap().secret_bytes());
1832+
let outer_session_key = SecretKey::from_slice(&<Vec<u8>>::from_hex("4f777e8dac16e6dfe333066d9efb014f7a51d11762ff76eca4d3a95ada99ba3e").unwrap()).unwrap();
1833+
let outer_onion_prng_seed = onion_utils::gen_pad_from_shared_secret(&outer_session_key.secret_bytes());
1834+
1835+
let amt_msat = 150_000_000;
1836+
let cur_height = 800_000;
1837+
let recipient_onion_fields = RecipientOnionFields::secret_only(payment_secret);
1838+
let (bob_onion, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion_internal(&secp_ctx, &path, &session_priv, amt_msat, &recipient_onion_fields, cur_height, &associated_data, &None, None, [0; 32], Some(payment_secret), Some(outer_session_key), Some(outer_onion_prng_seed)).unwrap();
1839+
1840+
let outer_onion_packet_hex = bob_onion.encode().to_lower_hex_string();
1841+
assert_eq!(outer_onion_packet_hex, "00025fd60556c134ae97e4baedba220a644037754ee67c54fd05e93bf40c17cbb73362fb9dee96001ff229945595b6edb59437a6bc143406d3f90f749892a84d8d430c6890437d26d5bfc599d565316ef51347521075bbab87c59c57bcf20af7e63d7192b46cf171e4f73cb11f9f603915389105d91ad630224bea95d735e3988add1e24b5bf28f1d7128db64284d90a839ba340d088c74b1fb1bd21136b1809428ec5399c8649e9bdf92d2dcfc694deae5046fa5b2bdf646847aaad73f5e95275763091c90e71031cae1f9a770fdea559642c9c02f424a2a28163dd0957e3874bd28a97bec67d18c0321b0e68bc804aa8345b17cb626e2348ca06c8312a167c989521056b0f25c55559d446507d6c491d50605cb79fa87929ce64b0a9860926eeaec2c431d926a1cadb9a1186e4061cb01671a122fc1f57602cbef06d6c194ec4b715c2e3dd4120baca3172cd81900b49fef857fb6d6afd24c983b608108b0a5ac0c1c6c52011f23b8778059ffadd1bb7cd06e2525417365f485a7fd1d4a9ba3818ede7cdc9e71afee8532252d08e2531ca52538655b7e8d912f7ec6d37bbcce8d7ec690709dbf9321e92c565b78e7fe2c22edf23e0902153d1ca15a112ad32fb19695ec65ce11ddf670da7915f05ad4b86c154fb908cb567315d1124f303f75fa075ebde8ef7bb12e27737ad9e4924439097338ea6d7a6fc3721b88c9b830a34e8d55f4c582b74a3895cc848fe57f4fe29f115dabeb6b3175be15d94408ed6771109cfaf57067ae658201082eae7605d26b1449af4425ae8e8f58cdda5c6265f1fd7a386fc6cea3074e4f25b909b96175883676f7610a00fdf34df9eb6c7b9a4ae89b839c69fd1f285e38cdceb634d782cc6d81179759bc9fd47d7fd060470d0b048287764c6837963274e708314f017ac7dc26d0554d59bfcfd3136225798f65f0b0fea337c6b256ebbb63a90b994c0ab93fd8b1d6bd4c74aebe535d6110014cd3d525394027dfe8faa98b4e9b2bee7949eb1961f1b026791092f84deea63afab66603dbe9b6365a102a1fef2f6b9744bc1bb091a8da9130d34d4d39f25dbad191649cfb67e10246364b7ce0c6ec072f9690cabb459d9fda0c849e17535de4357e9907270c75953fca3c845bb613926ecf73205219c7057a4b6bb244c184362bb4e2f24279dc4e60b94a5b1ec11c34081a628428ba5646c995b9558821053ba9c84a05afbf00dabd60223723096516d2f5668f3ec7e11612b01eb7a3a0506189a2272b88e89807943adb34291a17f6cb5516ffd6f945a1c42a524b21f096d66f350b1dad4db455741ae3d0e023309fbda5ef55fb0dc74f3297041448b2be76c525141963934c6afc53d263fb7836626df502d7c2ee9e79cbbd87afd84bbb8dfbf45248af3cd61ad5fac827e7683ca4f91dfad507a8eb9c17b2c9ac5ec051fe645a4a6cb37136f6f19b611e0ea8da7960af2d779507e55f57305bc74b7568928c5dd5132990fe54c22117df91c257d8c7b61935a018a28c1c3b17bab8e4294fa699161ec21123c9fc4e71079df31f300c2822e1246561e04765d3aab333eafd026c7431ac7616debb0e022746f4538e1c6348b600c988eeb2d051fc60c468dca260a84c79ab3ab8342dc345a764672848ea234e17332bc124799daf7c5fcb2e2358514a7461357e1c19c802c5ee32deccf1776885dd825bedd5f781d459984370a6b7ae885d4483a76ddb19b30f47ed47cd56aa5a079a89793dbcad461c59f2e002067ac98dd5a534e525c9c46c2af730741bf1f8629357ec0bfc0bc9ecb31af96777e507648ff4260dc3673716e098d9111dfd245f1d7c55a6de340deb8bd7a053e5d62d760f184dc70ca8fa255b9023b9b9aedfb6e419a5b5951ba0f83b603793830ee68d442d7b88ee1bbf6bbd1bcd6f68cc1af");
1842+
assert_eq!(htlc_msat, 150_153_000);
1843+
assert_eq!(htlc_cltv, 800_060);
1844+
}

‎lightning/src/ln/onion_utils.rs

Lines changed: 61 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1353,12 +1353,39 @@ pub fn create_payment_onion<T: secp256k1::Signing>(
13531353
keysend_preimage: &Option<PaymentPreimage>, invoice_request: Option<&InvoiceRequest>,
13541354
prng_seed: [u8; 32],
13551355
) -> Result<(msgs::OnionPacket, u64, u32), APIError> {
1356-
let mut trampoline_payloads = vec![];
1356+
create_payment_onion_internal(
1357+
secp_ctx,
1358+
path,
1359+
session_priv,
1360+
total_msat,
1361+
recipient_onion,
1362+
cur_block_height,
1363+
payment_hash,
1364+
keysend_preimage,
1365+
invoice_request,
1366+
prng_seed,
1367+
None,
1368+
None,
1369+
None,
1370+
)
1371+
}
1372+
1373+
/// Build a payment onion, returning the first hop msat and cltv values as well.
1374+
/// `cur_block_height` should be set to the best known block height + 1.
1375+
pub(crate) fn create_payment_onion_internal<T: secp256k1::Signing>(
1376+
secp_ctx: &Secp256k1<T>, path: &Path, session_priv: &SecretKey, total_msat: u64,
1377+
recipient_onion: &RecipientOnionFields, cur_block_height: u32, payment_hash: &PaymentHash,
1378+
keysend_preimage: &Option<PaymentPreimage>, invoice_request: Option<&InvoiceRequest>,
1379+
prng_seed: [u8; 32], secondary_payment_secret: Option<PaymentSecret>,
1380+
secondary_session_priv: Option<SecretKey>, secondary_prng_seed: Option<[u8; 32]>,
1381+
) -> Result<(msgs::OnionPacket, u64, u32), APIError> {
13571382
let mut outer_total_msat = total_msat;
13581383
let mut outer_starting_htlc_offset = cur_block_height;
13591384
let mut outer_session_priv_override = None;
1385+
let mut trampoline_packet_option = None;
13601386

13611387
if !path.trampoline_hops.is_empty() {
1388+
let trampoline_payloads;
13621389
(trampoline_payloads, outer_total_msat, outer_starting_htlc_offset) =
13631390
build_trampoline_onion_payloads(
13641391
path,
@@ -1367,18 +1394,7 @@ pub fn create_payment_onion<T: secp256k1::Signing>(
13671394
cur_block_height,
13681395
keysend_preimage,
13691396
)?;
1370-
}
13711397

1372-
let (mut onion_payloads, htlc_msat, htlc_cltv) = build_onion_payloads(
1373-
&path,
1374-
total_msat,
1375-
recipient_onion,
1376-
cur_block_height,
1377-
keysend_preimage,
1378-
invoice_request,
1379-
)?;
1380-
1381-
if !path.trampoline_hops.is_empty() {
13821398
let onion_keys =
13831399
construct_trampoline_onion_keys(&secp_ctx, &path, &session_priv).map_err(|_| {
13841400
APIError::InvalidRoute {
@@ -1396,26 +1412,39 @@ pub fn create_payment_onion<T: secp256k1::Signing>(
13961412
err: "Route size too large considering onion data".to_owned(),
13971413
})?;
13981414

1415+
trampoline_packet_option = Some(trampoline_packet);
1416+
}
1417+
1418+
let (mut onion_payloads, htlc_msat, htlc_cltv) = build_onion_payloads(
1419+
&path,
1420+
outer_total_msat,
1421+
recipient_onion,
1422+
outer_starting_htlc_offset,
1423+
keysend_preimage,
1424+
invoice_request,
1425+
)?;
1426+
1427+
if !path.trampoline_hops.is_empty() {
13991428
let last_payload = onion_payloads.pop().ok_or(APIError::InvalidRoute {
14001429
err: "Non-Trampoline path needs at least one hop".to_owned(),
14011430
})?;
14021431

14031432
match last_payload {
14041433
OutboundOnionPayload::Receive { payment_data, .. } => {
1434+
let fee_delta = path.hops.last().map_or(0, |h| h.fee_msat);
1435+
let cltv_delta = path.hops.last().map_or(0, |h| h.cltv_expiry_delta);
14051436
let multipath_trampoline_data = payment_data.map(|d| {
1406-
let trampoline_payment_secret =
1407-
Sha256::hash(&d.payment_secret.0).to_byte_array();
1408-
let total_msat = d.total_msat + path.hops.last().map_or(0, |h| h.fee_msat);
1409-
FinalOnionHopData {
1410-
payment_secret: PaymentSecret(trampoline_payment_secret),
1411-
total_msat,
1412-
}
1437+
let trampoline_payment_secret = secondary_payment_secret.unwrap_or_else(|| {
1438+
PaymentSecret(Sha256::hash(&d.payment_secret.0).to_byte_array())
1439+
});
1440+
let total_msat = fee_delta;
1441+
FinalOnionHopData { payment_secret: trampoline_payment_secret, total_msat }
14131442
});
14141443
onion_payloads.push(OutboundOnionPayload::TrampolineEntrypoint {
1415-
amt_to_forward: outer_total_msat,
1416-
outgoing_cltv_value: outer_starting_htlc_offset,
1444+
amt_to_forward: fee_delta,
1445+
outgoing_cltv_value: outer_starting_htlc_offset + cltv_delta,
14171446
multipath_trampoline_data,
1418-
trampoline_packet,
1447+
trampoline_packet: trampoline_packet_option.unwrap(),
14191448
});
14201449
},
14211450
_ => {
@@ -1426,19 +1455,22 @@ pub fn create_payment_onion<T: secp256k1::Signing>(
14261455
},
14271456
};
14281457

1429-
let session_priv_hash = Sha256::hash(&session_priv.secret_bytes()).to_byte_array();
1430-
outer_session_priv_override =
1431-
Some(SecretKey::from_slice(&session_priv_hash[..]).expect("You broke SHA-256!"));
1458+
outer_session_priv_override = Some(secondary_session_priv.unwrap_or_else(|| {
1459+
let session_priv_hash = Sha256::hash(&session_priv.secret_bytes()).to_byte_array();
1460+
SecretKey::from_slice(&session_priv_hash[..]).expect("You broke SHA-256!")
1461+
}));
14321462
}
14331463

14341464
let outer_session_priv = outer_session_priv_override.as_ref().unwrap_or(session_priv);
14351465
let onion_keys = construct_onion_keys(&secp_ctx, &path, outer_session_priv).map_err(|_| {
14361466
APIError::InvalidRoute { err: "Pubkey along hop was maliciously selected".to_owned() }
14371467
})?;
1438-
let onion_packet = construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
1439-
.map_err(|_| APIError::InvalidRoute {
1440-
err: "Route size too large considering onion data".to_owned(),
1441-
})?;
1468+
let outer_onion_prng_seed = secondary_prng_seed.unwrap_or(prng_seed);
1469+
let onion_packet =
1470+
construct_onion_packet(onion_payloads, onion_keys, outer_onion_prng_seed, payment_hash)
1471+
.map_err(|_| APIError::InvalidRoute {
1472+
err: "Route size too large considering onion data".to_owned(),
1473+
})?;
14421474
Ok((onion_packet, htlc_msat, htlc_cltv))
14431475
}
14441476

0 commit comments

Comments
 (0)