Skip to content

Commit 6ed496d

Browse files
author
Antoine Riard
committed
Add bolt2 msgs serialization tests
1 parent 2b2c713 commit 6ed496d

File tree

1 file changed

+299
-1
lines changed

1 file changed

+299
-1
lines changed

‎src/ln/msgs.rs

Lines changed: 299 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1392,10 +1392,15 @@ impl_writeable_len_match!(NodeAnnouncement, {
13921392
mod tests {
13931393
use hex;
13941394
use ln::msgs;
1395-
use ln::msgs::{GlobalFeatures, OptionalField};
1395+
use ln::msgs::{GlobalFeatures, OptionalField, OnionErrorPacket};
1396+
use ln::channelmanager::{PaymentPreimage, PaymentHash};
13961397
use util::ser::Writeable;
13971398

13981399
use bitcoin::util::hash::Sha256dHash;
1400+
use bitcoin::util::address::Address;
1401+
use bitcoin::network::constants::Network;
1402+
use bitcoin::blockdata::script::Builder;
1403+
use bitcoin::blockdata::opcodes;
13991404

14001405
use secp256k1::key::{PublicKey,SecretKey};
14011406
use secp256k1::{Secp256k1, Message};
@@ -1592,4 +1597,297 @@ mod tests {
15921597
do_encoding_channel_update(false, false, false, true);
15931598
do_encoding_channel_update(true, true, true, true);
15941599
}
1600+
1601+
fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
1602+
let (_, pubkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1603+
let (_, pubkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202");
1604+
let (_, pubkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303");
1605+
let (_, pubkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404");
1606+
let (_, pubkey_5, _) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505");
1607+
let (_, pubkey_6, _) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606");
1608+
let open_channel = msgs::OpenChannel {
1609+
chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1610+
temporary_channel_id: [2; 32],
1611+
funding_satoshis: 2316138423780173,
1612+
push_msat: 2316138423780173,
1613+
dust_limit_satoshis: 2316138423780173,
1614+
max_htlc_value_in_flight_msat: 2316138423780173,
1615+
channel_reserve_satoshis: 2316138423780173,
1616+
htlc_minimum_msat: 2316138423780173,
1617+
feerate_per_kw: 821716,
1618+
to_self_delay: 49340,
1619+
max_accepted_htlcs: 49340,
1620+
funding_pubkey: pubkey_1,
1621+
revocation_basepoint: pubkey_2,
1622+
payment_basepoint: pubkey_3,
1623+
delayed_payment_basepoint: pubkey_4,
1624+
htlc_basepoint: pubkey_5,
1625+
first_per_commitment_point: pubkey_6,
1626+
channel_flags: if random_bit { 1 << 5 } else { 0 },
1627+
shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&pubkey_1, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1628+
};
1629+
let encoded_value = open_channel.encode();
1630+
let mut target_value = Vec::new();
1631+
if non_bitcoin_chain_hash {
1632+
target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1633+
} else {
1634+
target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1635+
}
1636+
target_value.append(&mut hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00083a840000034d00083a840000034d00083a840000034d00083a840000034d00083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
1637+
if random_bit {
1638+
target_value.append(&mut hex::decode("20").unwrap());
1639+
} else {
1640+
target_value.append(&mut hex::decode("00").unwrap());
1641+
}
1642+
if shutdown {
1643+
target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1644+
}
1645+
assert_eq!(encoded_value, target_value);
1646+
}
1647+
1648+
#[test]
1649+
fn encoding_open_channel() {
1650+
do_encoding_open_channel(false, false, false);
1651+
do_encoding_open_channel(true, false, false);
1652+
do_encoding_open_channel(false, true, false);
1653+
do_encoding_open_channel(false, false, true);
1654+
do_encoding_open_channel(true, true, true);
1655+
}
1656+
1657+
fn do_encoding_accept_channel(shutdown: bool) {
1658+
let (_, pubkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1659+
let (_, pubkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202");
1660+
let (_, pubkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303");
1661+
let (_, pubkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404");
1662+
let (_, pubkey_5, _) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505");
1663+
let (_, pubkey_6, _) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606");
1664+
let accept_channel = msgs::AcceptChannel {
1665+
temporary_channel_id: [2; 32],
1666+
dust_limit_satoshis: 2316138423780173,
1667+
max_htlc_value_in_flight_msat: 2316138423780173,
1668+
channel_reserve_satoshis: 2316138423780173,
1669+
htlc_minimum_msat: 2316138423780173,
1670+
minimum_depth: 821716,
1671+
to_self_delay: 49340,
1672+
max_accepted_htlcs: 49340,
1673+
funding_pubkey: pubkey_1,
1674+
revocation_basepoint: pubkey_2,
1675+
payment_basepoint: pubkey_3,
1676+
delayed_payment_basepoint: pubkey_4,
1677+
htlc_basepoint: pubkey_5,
1678+
first_per_commitment_point: pubkey_6,
1679+
shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&pubkey_1, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1680+
};
1681+
let encoded_value = accept_channel.encode();
1682+
let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00083a840000034d00083a840000034d00083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
1683+
if shutdown {
1684+
target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1685+
}
1686+
assert_eq!(encoded_value, target_value);
1687+
}
1688+
1689+
#[test]
1690+
fn encoding_accept_channel() {
1691+
do_encoding_accept_channel(false);
1692+
do_encoding_accept_channel(true);
1693+
}
1694+
1695+
#[test]
1696+
fn encoding_funding_created() {
1697+
let (privkey_1, _, secp_ctx_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1698+
let sig_1 = get_sig_on!(privkey_1, secp_ctx_1, String::from("01010101010101010101010101010101"));
1699+
let funding_created = msgs::FundingCreated {
1700+
temporary_channel_id: [2; 32],
1701+
funding_txid: Sha256dHash::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
1702+
funding_output_index: 255,
1703+
signature: sig_1,
1704+
};
1705+
let encoded_value = funding_created.encode();
1706+
let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1707+
assert_eq!(encoded_value, target_value);
1708+
}
1709+
1710+
#[test]
1711+
fn encoding_funding_signed() {
1712+
let (privkey_1, _, secp_ctx_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1713+
let sig_1 = get_sig_on!(privkey_1, secp_ctx_1, String::from("01010101010101010101010101010101"));
1714+
let funding_signed = msgs::FundingSigned {
1715+
channel_id: [2; 32],
1716+
signature: sig_1,
1717+
};
1718+
let encoded_value = funding_signed.encode();
1719+
let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1720+
assert_eq!(encoded_value, target_value);
1721+
}
1722+
1723+
#[test]
1724+
fn encoding_funding_locked() {
1725+
let (_, pubkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1726+
let funding_locked = msgs::FundingLocked {
1727+
channel_id: [2; 32],
1728+
next_per_commitment_point: pubkey_1,
1729+
};
1730+
let encoded_value = funding_locked.encode();
1731+
let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1732+
assert_eq!(encoded_value, target_value);
1733+
}
1734+
1735+
fn do_encoding_shutdown(script_type: u8) {
1736+
let (_, pubkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1737+
let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1738+
let shutdown = msgs::Shutdown {
1739+
channel_id: [2; 32],
1740+
scriptpubkey: if script_type == 1 { Address::p2pkh(&pubkey_1, Network::Testnet).script_pubkey() } else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() } else if script_type == 3 { Address::p2wpkh(&pubkey_1, Network::Testnet).script_pubkey() } else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
1741+
};
1742+
let encoded_value = shutdown.encode();
1743+
let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
1744+
if script_type == 1 {
1745+
target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1746+
} else if script_type == 2 {
1747+
target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
1748+
} else if script_type == 3 {
1749+
target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
1750+
} else if script_type == 4 {
1751+
target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
1752+
}
1753+
assert_eq!(encoded_value, target_value);
1754+
}
1755+
1756+
#[test]
1757+
fn encoding_shutdown() {
1758+
do_encoding_shutdown(1);
1759+
do_encoding_shutdown(2);
1760+
do_encoding_shutdown(3);
1761+
do_encoding_shutdown(4);
1762+
}
1763+
1764+
#[test]
1765+
fn encoding_closing_signed() {
1766+
let (privkey_1, _, secp_ctx_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1767+
let sig_1 = get_sig_on!(privkey_1, secp_ctx_1, String::from("01010101010101010101010101010101"));
1768+
let closing_signed = msgs::ClosingSigned {
1769+
channel_id: [2; 32],
1770+
fee_satoshis: 2316138423780173,
1771+
signature: sig_1,
1772+
};
1773+
let encoded_value = closing_signed.encode();
1774+
let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1775+
assert_eq!(encoded_value, target_value);
1776+
}
1777+
1778+
#[test]
1779+
fn encoding_update_add_htlc() {
1780+
let (_, pubkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1781+
let onion_routing_packet = msgs::OnionPacket {
1782+
version: 255,
1783+
public_key: Ok(pubkey_1),
1784+
hop_data: [1; 20*65],
1785+
hmac: [2; 32]
1786+
};
1787+
let update_add_htlc = msgs::UpdateAddHTLC {
1788+
channel_id: [2; 32],
1789+
htlc_id: 2316138423780173,
1790+
amount_msat: 2316138423780173,
1791+
payment_hash: PaymentHash([1; 32]),
1792+
cltv_expiry: 821716,
1793+
onion_routing_packet
1794+
};
1795+
let encoded_value = update_add_htlc.encode();
1796+
let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00083a840000034d0101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
1797+
assert_eq!(encoded_value, target_value);
1798+
}
1799+
1800+
#[test]
1801+
fn encoding_update_fulfill_htlc() {
1802+
let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
1803+
channel_id: [2; 32],
1804+
htlc_id: 2316138423780173,
1805+
payment_preimage: PaymentPreimage([1; 32]),
1806+
};
1807+
let encoded_value = update_fulfill_htlc.encode();
1808+
let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
1809+
assert_eq!(encoded_value, target_value);
1810+
}
1811+
1812+
#[test]
1813+
fn encoding_update_fail_htlc() {
1814+
let reason = OnionErrorPacket {
1815+
data: [1; 32].to_vec(),
1816+
};
1817+
let update_fail_htlc = msgs::UpdateFailHTLC {
1818+
channel_id: [2; 32],
1819+
htlc_id: 2316138423780173,
1820+
reason
1821+
};
1822+
let encoded_value = update_fail_htlc.encode();
1823+
let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
1824+
assert_eq!(encoded_value, target_value);
1825+
}
1826+
1827+
#[test]
1828+
fn encoding_update_fail_malformed_htlc() {
1829+
let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
1830+
channel_id: [2; 32],
1831+
htlc_id: 2316138423780173,
1832+
sha256_of_onion: [1; 32],
1833+
failure_code: 255
1834+
};
1835+
let encoded_value = update_fail_malformed_htlc.encode();
1836+
let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
1837+
assert_eq!(encoded_value, target_value);
1838+
}
1839+
1840+
fn do_encoding_commitment_signed(htlcs: bool) {
1841+
let (privkey_1, _, secp_ctx_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1842+
let (privkey_2, _, secp_ctx_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202");
1843+
let (privkey_3, _, secp_ctx_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303");
1844+
let (privkey_4, _, secp_ctx_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404");
1845+
let sig_1 = get_sig_on!(privkey_1, secp_ctx_1, String::from("01010101010101010101010101010101"));
1846+
let sig_2 = get_sig_on!(privkey_2, secp_ctx_2, String::from("01010101010101010101010101010101"));
1847+
let sig_3 = get_sig_on!(privkey_3, secp_ctx_3, String::from("01010101010101010101010101010101"));
1848+
let sig_4 = get_sig_on!(privkey_4, secp_ctx_4, String::from("01010101010101010101010101010101"));
1849+
let commitment_signed = msgs::CommitmentSigned {
1850+
channel_id: [2; 32],
1851+
signature: sig_1,
1852+
htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
1853+
};
1854+
let encoded_value = commitment_signed.encode();
1855+
let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1856+
if htlcs {
1857+
target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1858+
} else {
1859+
target_value.append(&mut hex::decode("0000").unwrap());
1860+
}
1861+
assert_eq!(encoded_value, target_value);
1862+
}
1863+
1864+
#[test]
1865+
fn encoding_commitment_signed() {
1866+
do_encoding_commitment_signed(true);
1867+
do_encoding_commitment_signed(false);
1868+
}
1869+
1870+
#[test]
1871+
fn encoding_revoke_and_ack() {
1872+
let (_, pubkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101");
1873+
let raa = msgs::RevokeAndACK {
1874+
channel_id: [2; 32],
1875+
per_commitment_secret: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
1876+
next_per_commitment_point: pubkey_1,
1877+
};
1878+
let encoded_value = raa.encode();
1879+
let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1880+
assert_eq!(encoded_value, target_value);
1881+
}
1882+
1883+
#[test]
1884+
fn encoding_update_fee() {
1885+
let update_fee = msgs::UpdateFee {
1886+
channel_id: [2; 32],
1887+
feerate_per_kw: 20190119,
1888+
};
1889+
let encoded_value = update_fee.encode();
1890+
let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
1891+
assert_eq!(encoded_value, target_value);
1892+
}
15951893
}

0 commit comments

Comments
 (0)