|
| 1 | +// This file is Copyright its original authors, visible in version control history. |
| 2 | +// |
| 3 | +// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| 4 | +// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or |
| 5 | +// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in |
| 6 | +// accordance with one or both of these licenses. |
| 7 | + |
| 8 | +use std::time::{Duration, SystemTime, UNIX_EPOCH}; |
| 9 | + |
| 10 | +use bitcoin::Txid; |
| 11 | +use lightning::ln::channelmanager::PaymentId; |
| 12 | +use lightning::ln::msgs::DecodeError; |
| 13 | +use lightning::util::ser::{Readable, Writeable}; |
| 14 | +use lightning::{_init_and_read_len_prefixed_tlv_fields, write_tlv_fields}; |
| 15 | + |
| 16 | +use crate::data_store::{StorableObject, StorableObjectId, StorableObjectUpdate}; |
| 17 | +use crate::payment::ConfirmationStatus; |
| 18 | + |
| 19 | +/// Details of an on-chain transaction that has replaced a previous transaction (e.g., via RBF). |
| 20 | +#[derive(Clone, Debug, PartialEq, Eq)] |
| 21 | +pub struct ReplacedOnchainTransactionDetails { |
| 22 | + /// The new transaction ID. |
| 23 | + pub new_txid: Txid, |
| 24 | + /// The original transaction ID that was replaced. |
| 25 | + pub original_txid: Txid, |
| 26 | + /// The payment ID associated with the transaction. |
| 27 | + pub payment_id: PaymentId, |
| 28 | + /// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated. |
| 29 | + pub latest_update_timestamp: u64, |
| 30 | + /// The confirmation status of this payment. |
| 31 | + pub status: ConfirmationStatus, |
| 32 | +} |
| 33 | + |
| 34 | +impl ReplacedOnchainTransactionDetails { |
| 35 | + pub(crate) fn new( |
| 36 | + new_txid: Txid, original_txid: Txid, payment_id: PaymentId, status: ConfirmationStatus, |
| 37 | + ) -> Self { |
| 38 | + let latest_update_timestamp = SystemTime::now() |
| 39 | + .duration_since(UNIX_EPOCH) |
| 40 | + .unwrap_or(Duration::from_secs(0)) |
| 41 | + .as_secs(); |
| 42 | + Self { new_txid, original_txid, payment_id, latest_update_timestamp, status } |
| 43 | + } |
| 44 | +} |
| 45 | + |
| 46 | +impl Writeable for ReplacedOnchainTransactionDetails { |
| 47 | + fn write<W: lightning::util::ser::Writer>( |
| 48 | + &self, writer: &mut W, |
| 49 | + ) -> Result<(), lightning::io::Error> { |
| 50 | + write_tlv_fields!(writer, { |
| 51 | + (0, self.new_txid, required), |
| 52 | + (2, self.original_txid, required), |
| 53 | + (4, self.payment_id, required), |
| 54 | + (6, self.latest_update_timestamp, required), |
| 55 | + (8, self.status, required), |
| 56 | + }); |
| 57 | + Ok(()) |
| 58 | + } |
| 59 | +} |
| 60 | + |
| 61 | +impl Readable for ReplacedOnchainTransactionDetails { |
| 62 | + fn read<R: lightning::io::Read>( |
| 63 | + reader: &mut R, |
| 64 | + ) -> Result<ReplacedOnchainTransactionDetails, DecodeError> { |
| 65 | + let unix_time_secs = SystemTime::now() |
| 66 | + .duration_since(UNIX_EPOCH) |
| 67 | + .unwrap_or(Duration::from_secs(0)) |
| 68 | + .as_secs(); |
| 69 | + _init_and_read_len_prefixed_tlv_fields!(reader, { |
| 70 | + (0, new_txid, required), |
| 71 | + (2, original_txid, required), |
| 72 | + (4, payment_id, required), |
| 73 | + (6, latest_update_timestamp, (default_value, unix_time_secs)), |
| 74 | + (8, status, required) |
| 75 | + }); |
| 76 | + |
| 77 | + let new_txid: Txid = new_txid.0.ok_or(DecodeError::InvalidValue)?; |
| 78 | + let original_txid: Txid = original_txid.0.ok_or(DecodeError::InvalidValue)?; |
| 79 | + let payment_id: PaymentId = payment_id.0.ok_or(DecodeError::InvalidValue)?; |
| 80 | + let latest_update_timestamp: u64 = |
| 81 | + latest_update_timestamp.0.ok_or(DecodeError::InvalidValue)?; |
| 82 | + let status: ConfirmationStatus = status.0.ok_or(DecodeError::InvalidValue)?; |
| 83 | + |
| 84 | + Ok(ReplacedOnchainTransactionDetails { |
| 85 | + new_txid, |
| 86 | + original_txid, |
| 87 | + payment_id, |
| 88 | + latest_update_timestamp, |
| 89 | + status, |
| 90 | + }) |
| 91 | + } |
| 92 | +} |
| 93 | + |
| 94 | +impl StorableObjectId for Txid { |
| 95 | + fn encode_to_hex_str(&self) -> String { |
| 96 | + self.to_string() |
| 97 | + } |
| 98 | +} |
| 99 | +impl StorableObject for ReplacedOnchainTransactionDetails { |
| 100 | + type Id = Txid; |
| 101 | + type Update = ReplacedOnchainTransactionDetailsUpdate; |
| 102 | + |
| 103 | + fn id(&self) -> Self::Id { |
| 104 | + self.new_txid |
| 105 | + } |
| 106 | + |
| 107 | + fn update(&mut self, update: &Self::Update) -> bool { |
| 108 | + debug_assert_eq!( |
| 109 | + self.new_txid, update.id, |
| 110 | + "We should only ever override data for the same replacement transaction id" |
| 111 | + ); |
| 112 | + |
| 113 | + let mut updated = false; |
| 114 | + |
| 115 | + macro_rules! update_if_necessary { |
| 116 | + ($val:expr, $update:expr) => { |
| 117 | + if $val != $update { |
| 118 | + $val = $update; |
| 119 | + updated = true; |
| 120 | + } |
| 121 | + }; |
| 122 | + } |
| 123 | + |
| 124 | + if let Some(status) = update.confirmation_status { |
| 125 | + update_if_necessary!(self.status, status); |
| 126 | + } |
| 127 | + |
| 128 | + if updated { |
| 129 | + self.latest_update_timestamp = SystemTime::now() |
| 130 | + .duration_since(UNIX_EPOCH) |
| 131 | + .unwrap_or(Duration::from_secs(0)) |
| 132 | + .as_secs(); |
| 133 | + } |
| 134 | + |
| 135 | + updated |
| 136 | + } |
| 137 | + |
| 138 | + fn to_update(&self) -> Self::Update { |
| 139 | + self.into() |
| 140 | + } |
| 141 | +} |
| 142 | + |
| 143 | +#[derive(Clone, Debug, PartialEq, Eq)] |
| 144 | +pub(crate) struct ReplacedOnchainTransactionDetailsUpdate { |
| 145 | + pub id: Txid, |
| 146 | + pub confirmation_status: Option<ConfirmationStatus>, |
| 147 | +} |
| 148 | + |
| 149 | +impl From<&ReplacedOnchainTransactionDetails> for ReplacedOnchainTransactionDetailsUpdate { |
| 150 | + fn from(value: &ReplacedOnchainTransactionDetails) -> Self { |
| 151 | + Self { id: value.new_txid, confirmation_status: Some(value.status) } |
| 152 | + } |
| 153 | +} |
| 154 | + |
| 155 | +impl StorableObjectUpdate<ReplacedOnchainTransactionDetails> |
| 156 | + for ReplacedOnchainTransactionDetailsUpdate |
| 157 | +{ |
| 158 | + fn id(&self) -> <ReplacedOnchainTransactionDetails as StorableObject>::Id { |
| 159 | + self.id |
| 160 | + } |
| 161 | +} |
0 commit comments