use lightning::chain::channelmonitor::ChannelMonitorUpdate as nativeChannelMonitorUpdateImport;
pub(crate) type nativeChannelMonitorUpdate = nativeChannelMonitorUpdateImport;
-/// An update generated by the underlying Channel itself which contains some new information the
-/// ChannelMonitor should be made aware of.
+/// An update generated by the underlying channel itself which contains some new information the
+/// [`ChannelMonitor`] should be made aware of.
+///
+/// Because this represents only a small number of updates to the underlying state, it is generally
+/// much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
+/// updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
+/// transaction), a single update may reach upwards of 1 MiB in serialized size.
#[must_use]
#[repr(C)]
pub struct ChannelMonitorUpdate {
/// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
/// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
/// likely to be claimed by our counterparty before we do.
- MaybeClaimableHTLCAwaitingTimeout {
- /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
- /// required to do so.
+ MaybeTimeoutClaimableHTLC {
+ /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
+ /// which will be required to do so.
claimable_amount_satoshis: u64,
/// The height at which we will be able to claim the balance if our counterparty has not
/// done so.
claimable_height: u32,
},
+ /// HTLCs which we received from our counterparty which are claimable with a preimage which we
+ /// do not currently have. This will only be claimable if we receive the preimage from the node
+ /// to which we forwarded this HTLC before the timeout.
+ MaybePreimageClaimableHTLC {
+ /// The amount potentially available to claim, in satoshis, excluding the on-chain fees
+ /// which will be required to do so.
+ claimable_amount_satoshis: u64,
+ /// The height at which our counterparty will be able to claim the balance if we have not
+ /// yet received the preimage and claimed it ourselves.
+ expiry_height: u32,
+ },
+ /// The channel has been closed, and our counterparty broadcasted a revoked commitment
+ /// transaction.
+ ///
+ /// Thus, we're able to claim all outputs in the commitment transaction, one of which has the
+ /// following amount.
+ CounterpartyRevokedOutputClaimable {
+ /// The amount, in satoshis, of the output which we can claim.
+ ///
+ /// Note that for outputs from HTLC balances this may be excluding some on-chain fees that
+ /// were already spent.
+ claimable_amount_satoshis: u64,
+ },
}
use lightning::chain::channelmonitor::Balance as BalanceImport;
pub(crate) type nativeBalance = BalanceImport;
timeout_height: timeout_height_nonref,
}
},
- Balance::MaybeClaimableHTLCAwaitingTimeout {ref claimable_amount_satoshis, ref claimable_height, } => {
+ Balance::MaybeTimeoutClaimableHTLC {ref claimable_amount_satoshis, ref claimable_height, } => {
let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
let mut claimable_height_nonref = (*claimable_height).clone();
- nativeBalance::MaybeClaimableHTLCAwaitingTimeout {
+ nativeBalance::MaybeTimeoutClaimableHTLC {
claimable_amount_satoshis: claimable_amount_satoshis_nonref,
claimable_height: claimable_height_nonref,
}
},
+ Balance::MaybePreimageClaimableHTLC {ref claimable_amount_satoshis, ref expiry_height, } => {
+ let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
+ let mut expiry_height_nonref = (*expiry_height).clone();
+ nativeBalance::MaybePreimageClaimableHTLC {
+ claimable_amount_satoshis: claimable_amount_satoshis_nonref,
+ expiry_height: expiry_height_nonref,
+ }
+ },
+ Balance::CounterpartyRevokedOutputClaimable {ref claimable_amount_satoshis, } => {
+ let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
+ nativeBalance::CounterpartyRevokedOutputClaimable {
+ claimable_amount_satoshis: claimable_amount_satoshis_nonref,
+ }
+ },
}
}
#[allow(unused)]
timeout_height: timeout_height,
}
},
- Balance::MaybeClaimableHTLCAwaitingTimeout {mut claimable_amount_satoshis, mut claimable_height, } => {
- nativeBalance::MaybeClaimableHTLCAwaitingTimeout {
+ Balance::MaybeTimeoutClaimableHTLC {mut claimable_amount_satoshis, mut claimable_height, } => {
+ nativeBalance::MaybeTimeoutClaimableHTLC {
claimable_amount_satoshis: claimable_amount_satoshis,
claimable_height: claimable_height,
}
},
+ Balance::MaybePreimageClaimableHTLC {mut claimable_amount_satoshis, mut expiry_height, } => {
+ nativeBalance::MaybePreimageClaimableHTLC {
+ claimable_amount_satoshis: claimable_amount_satoshis,
+ expiry_height: expiry_height,
+ }
+ },
+ Balance::CounterpartyRevokedOutputClaimable {mut claimable_amount_satoshis, } => {
+ nativeBalance::CounterpartyRevokedOutputClaimable {
+ claimable_amount_satoshis: claimable_amount_satoshis,
+ }
+ },
}
}
#[allow(unused)]
timeout_height: timeout_height_nonref,
}
},
- nativeBalance::MaybeClaimableHTLCAwaitingTimeout {ref claimable_amount_satoshis, ref claimable_height, } => {
+ nativeBalance::MaybeTimeoutClaimableHTLC {ref claimable_amount_satoshis, ref claimable_height, } => {
let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
let mut claimable_height_nonref = (*claimable_height).clone();
- Balance::MaybeClaimableHTLCAwaitingTimeout {
+ Balance::MaybeTimeoutClaimableHTLC {
claimable_amount_satoshis: claimable_amount_satoshis_nonref,
claimable_height: claimable_height_nonref,
}
},
+ nativeBalance::MaybePreimageClaimableHTLC {ref claimable_amount_satoshis, ref expiry_height, } => {
+ let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
+ let mut expiry_height_nonref = (*expiry_height).clone();
+ Balance::MaybePreimageClaimableHTLC {
+ claimable_amount_satoshis: claimable_amount_satoshis_nonref,
+ expiry_height: expiry_height_nonref,
+ }
+ },
+ nativeBalance::CounterpartyRevokedOutputClaimable {ref claimable_amount_satoshis, } => {
+ let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
+ Balance::CounterpartyRevokedOutputClaimable {
+ claimable_amount_satoshis: claimable_amount_satoshis_nonref,
+ }
+ },
}
}
#[allow(unused)]
timeout_height: timeout_height,
}
},
- nativeBalance::MaybeClaimableHTLCAwaitingTimeout {mut claimable_amount_satoshis, mut claimable_height, } => {
- Balance::MaybeClaimableHTLCAwaitingTimeout {
+ nativeBalance::MaybeTimeoutClaimableHTLC {mut claimable_amount_satoshis, mut claimable_height, } => {
+ Balance::MaybeTimeoutClaimableHTLC {
claimable_amount_satoshis: claimable_amount_satoshis,
claimable_height: claimable_height,
}
},
+ nativeBalance::MaybePreimageClaimableHTLC {mut claimable_amount_satoshis, mut expiry_height, } => {
+ Balance::MaybePreimageClaimableHTLC {
+ claimable_amount_satoshis: claimable_amount_satoshis,
+ expiry_height: expiry_height,
+ }
+ },
+ nativeBalance::CounterpartyRevokedOutputClaimable {mut claimable_amount_satoshis, } => {
+ Balance::CounterpartyRevokedOutputClaimable {
+ claimable_amount_satoshis: claimable_amount_satoshis,
+ }
+ },
}
}
}
}
}
#[no_mangle]
-/// Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance
-pub extern "C" fn Balance_maybe_claimable_htlcawaiting_timeout(claimable_amount_satoshis: u64, claimable_height: u32) -> Balance {
- Balance::MaybeClaimableHTLCAwaitingTimeout {
+/// Utility method to constructs a new MaybeTimeoutClaimableHTLC-variant Balance
+pub extern "C" fn Balance_maybe_timeout_claimable_htlc(claimable_amount_satoshis: u64, claimable_height: u32) -> Balance {
+ Balance::MaybeTimeoutClaimableHTLC {
claimable_amount_satoshis,
claimable_height,
}
}
+#[no_mangle]
+/// Utility method to constructs a new MaybePreimageClaimableHTLC-variant Balance
+pub extern "C" fn Balance_maybe_preimage_claimable_htlc(claimable_amount_satoshis: u64, expiry_height: u32) -> Balance {
+ Balance::MaybePreimageClaimableHTLC {
+ claimable_amount_satoshis,
+ expiry_height,
+ }
+}
+#[no_mangle]
+/// Utility method to constructs a new CounterpartyRevokedOutputClaimable-variant Balance
+pub extern "C" fn Balance_counterparty_revoked_output_claimable(claimable_amount_satoshis: u64) -> Balance {
+ Balance::CounterpartyRevokedOutputClaimable {
+ claimable_amount_satoshis,
+ }
+}
/// Checks if two Balances contain equal inner contents.
/// This ignores pointers and is_owned flags and looks at the values in fields.
#[no_mangle]
/// balance, or until our counterparty has claimed the balance and accrued several
/// confirmations on the claim transaction.
///
-/// Note that the balances available when you or your counterparty have broadcasted revoked
-/// state(s) may not be fully captured here.
+/// Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
+/// LDK prior to 0.0.111, balances may not be fully captured if our counterparty broadcasted
+/// a revoked state.
///
/// See [`Balance`] for additional details on the types of claimable balances which
/// may be returned here and their meanings.
projects / ldk-c-bindings / blobdiff