git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/chain/transaction.rs

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