lightning/chain/
transaction.rs

1// This file is Copyright its original authors, visible in version control
2// history.
3//
4// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7// You may not use this file except in accordance with one or both of these
8// licenses.
9
10//! Types describing on-chain transactions.
11
12use bitcoin::hash_types::Txid;
13use bitcoin::transaction::OutPoint as BitcoinOutPoint;
14use bitcoin::transaction::Transaction;
15
16/// Transaction data where each item consists of a transaction reference paired with the index of
17/// the transaction within a block.
18///
19/// Useful for passing enumerated transactions from a block, possibly filtered, in order to retain
20/// the transaction index.
21///
22/// ```
23/// extern crate bitcoin;
24/// extern crate lightning;
25///
26/// use bitcoin::block::Block;
27/// use bitcoin::constants::genesis_block;
28/// use bitcoin::network::Network;
29/// use lightning::chain::transaction::TransactionData;
30///
31/// let block = genesis_block(Network::Bitcoin);
32/// let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
33/// check_block(&block, &txdata);
34///
35/// fn check_block(block: &Block, txdata: &TransactionData) {
36/// 	assert_eq!(block.txdata.len(), 1);
37/// 	assert_eq!(txdata.len(), 1);
38///
39/// 	let (index, tx) = txdata[0];
40/// 	assert_eq!(index, 0);
41/// 	assert_eq!(tx, &block.txdata[0]);
42/// }
43/// ```
44pub type TransactionData<'a> = [(usize, &'a Transaction)];
45
46/// A reference to a transaction output.
47///
48/// Differs from bitcoin::transaction::OutPoint as the index is a u16 instead of u32
49/// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
50#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
51pub struct OutPoint {
52	/// The referenced transaction's txid.
53	pub txid: Txid,
54	/// The index of the referenced output in its transaction's vout.
55	pub index: u16,
56}
57
58impl OutPoint {
59	/// Converts this OutPoint into the OutPoint field as used by rust-bitcoin
60	///
61	/// This is not exported to bindings users as the same type is used universally in the C bindings
62	/// for all outpoints
63	pub fn into_bitcoin_outpoint(self) -> BitcoinOutPoint {
64		BitcoinOutPoint { txid: self.txid, vout: self.index as u32 }
65	}
66}
67
68impl core::fmt::Display for OutPoint {
69	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
70		write!(f, "{}:{}", self.txid, self.index)
71	}
72}
73
74impl_writeable!(OutPoint, { txid, index });
75
76#[derive(Debug, Clone)]
77pub(crate) struct MaybeSignedTransaction(pub Transaction);
78
79impl MaybeSignedTransaction {
80	pub fn is_fully_signed(&self) -> bool {
81		!self.0.input.iter().any(|input| input.witness.is_empty())
82	}
83}
84
85#[cfg(test)]
86mod tests {
87	use crate::chain::transaction::OutPoint;
88	use crate::ln::types::ChannelId;
89
90	use bitcoin::consensus::encode;
91	use bitcoin::hex::FromHex;
92	use bitcoin::transaction::Transaction;
93
94	#[test]
95	fn test_channel_id_calculation() {
96		let tx_hex = "020000000001010e0adef48412e4361325ac1c6e36411299ab09d4f083b9d8ddb55fbc06e1b0c00000000000feffffff0220a1070000000000220020f81d95e040bd0a493e38bae27bff52fe2bb58b93b293eb579c01c31b05c5af1dc072cfee54a3000016001434b1d6211af5551905dc2642d05f5b04d25a8fe80247304402207f570e3f0de50546aad25a872e3df059d277e776dda4269fa0d2cc8c2ee6ec9a022054e7fae5ca94d47534c86705857c24ceea3ad51c69dd6051c5850304880fc43a012103cb11a1bacc223d98d91f1946c6752e358a5eb1a1c983b3e6fb15378f453b76bd00000000";
97		let tx: Transaction =
98			encode::deserialize(&<Vec<u8>>::from_hex(tx_hex).unwrap()[..]).unwrap();
99
100		let txid = tx.compute_txid();
101
102		let id_0 = ChannelId::v1_from_funding_outpoint(OutPoint { txid, index: 0 });
103		let expected_0 = "3e88dd7165faf7be58b3c5bb2c9c452aebef682807ea57080f62e6f6e113c25e";
104		assert_eq!(&id_0.0[..], &Vec::<u8>::from_hex(expected_0).unwrap()[..]);
105
106		let id_1 = ChannelId::v1_from_funding_outpoint(OutPoint { txid, index: 1 });
107		let expected_1 = "3e88dd7165faf7be58b3c5bb2c9c452aebef682807ea57080f62e6f6e113c25f";
108		assert_eq!(&id_1.0[..], &Vec::<u8>::from_hex(expected_1).unwrap()[..]);
109	}
110}
lightning/chain/transaction.rs

lightning/chain/
transaction.rs
