Add test_invalid_channel_announcemnt + test utilities
[rust-lightning] / src / chain / transaction.rs
1 use bitcoin::util::hash::Sha256dHash;
2 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
3
4 /// A reference to a transaction output.
5 /// Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
6 /// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
7 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
8 pub struct OutPoint {
9         /// The referenced transaction's txid.
10         pub txid: Sha256dHash,
11         /// The index of the referenced output in its transaction's vout.
12         pub index: u16,
13 }
14
15 impl OutPoint {
16         /// Creates a new `OutPoint` from the txid and the index.
17         pub fn new(txid: Sha256dHash, index: u16) -> OutPoint {
18                 OutPoint { txid, index }
19         }
20
21         /// Convert an `OutPoint` to a lightning channel id.
22         pub fn to_channel_id(&self) -> [u8; 32] {
23                 let mut res = [0; 32];
24                 res[..].copy_from_slice(&self.txid[..]);
25                 res[30] ^= ((self.index >> 8) & 0xff) as u8;
26                 res[31] ^= ((self.index >> 0) & 0xff) as u8;
27                 res
28         }
29
30         pub fn into_bitcoin_outpoint(self) -> BitcoinOutPoint {
31                 BitcoinOutPoint {
32                         txid: self.txid,
33                         vout: self.index as u32,
34                 }
35         }
36 }
37
38 #[cfg(test)]
39 mod tests {
40         use chain::transaction::OutPoint;
41
42         use bitcoin::blockdata::transaction::Transaction;
43         use bitcoin::network::serialize;
44
45         use hex;
46
47         #[test]
48         fn test_channel_id_calculation() {
49                 let tx: Transaction = serialize::deserialize(&hex::decode("020000000001010e0adef48412e4361325ac1c6e36411299ab09d4f083b9d8ddb55fbc06e1b0c00000000000feffffff0220a1070000000000220020f81d95e040bd0a493e38bae27bff52fe2bb58b93b293eb579c01c31b05c5af1dc072cfee54a3000016001434b1d6211af5551905dc2642d05f5b04d25a8fe80247304402207f570e3f0de50546aad25a872e3df059d277e776dda4269fa0d2cc8c2ee6ec9a022054e7fae5ca94d47534c86705857c24ceea3ad51c69dd6051c5850304880fc43a012103cb11a1bacc223d98d91f1946c6752e358a5eb1a1c983b3e6fb15378f453b76bd00000000").unwrap()[..]).unwrap();
50                 assert_eq!(&OutPoint {
51                         txid: tx.txid(),
52                         index: 0
53                 }.to_channel_id(), &hex::decode("3e88dd7165faf7be58b3c5bb2c9c452aebef682807ea57080f62e6f6e113c25e").unwrap()[..]);
54                 assert_eq!(&OutPoint {
55                         txid: tx.txid(),
56                         index: 1
57                 }.to_channel_id(), &hex::decode("3e88dd7165faf7be58b3c5bb2c9c452aebef682807ea57080f62e6f6e113c25f").unwrap()[..]);
58         }
59 }