WIP: ChannelContext refactor

Author: jkczyz

lightning/src/ln/channel.rs

@@ -1574,10 +1574,12 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	announcement_sigs_state: AnnouncementSigsState,
 
 	secp_ctx: Secp256k1<secp256k1::All>,
+	// CHANGES
 	channel_value_satoshis: u64,
 
 	latest_monitor_update_id: u64,
 
+	// REQUIRES SCOPE
 	holder_signer: ChannelSignerType<SP>,
 	shutdown_scriptpubkey: Option<ShutdownScript>,
 	destination_script: ScriptBuf,
@@ -1587,6 +1589,7 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	// cost of others, but should really just be changed.
 
 	cur_counterparty_commitment_transaction_number: u64,
+	// CHANGES
 	value_to_self_msat: u64, // Excluding all pending_htlcs, fees, and anchor outputs
 	pending_inbound_htlcs: Vec<InboundHTLCOutput>,
 	pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
@@ -1664,6 +1667,7 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	/// time.
 	update_time_counter: u32,
 
+	// BOTH NEED TO CHANGE
 	#[cfg(debug_assertions)]
 	/// Max to_local and to_remote outputs in a locally-generated commitment transaction
 	holder_max_commitment_tx_output: Mutex<(u64, u64)>,
@@ -1702,8 +1706,11 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	expecting_peer_commitment_signed: bool,
 
 	/// The hash of the block in which the funding transaction was included.
+	// UPDATE ON APPLYING SCOPE
 	funding_tx_confirmed_in: Option<BlockHash>,
+	// UPDATE ON APPLYING SCOPE
 	funding_tx_confirmation_height: u32,
+	// UPDATE ON APPLYING SCOPE
 	short_channel_id: Option<u64>,
 	/// Either the height at which this channel was created or the height at which it was last
 	/// serialized if it was serialized by versions prior to 0.0.103.
@@ -1728,8 +1735,10 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	holder_max_htlc_value_in_flight_msat: u64,
 
 	/// minimum channel reserve for self to maintain - set by them.
+	// CHANGES
 	counterparty_selected_channel_reserve_satoshis: Option<u64>,
 
+	// CHANGES
 	#[cfg(test)]
 	pub(super) holder_selected_channel_reserve_satoshis: u64,
 	#[cfg(not(test))]
@@ -1746,9 +1755,11 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 
 	counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
 
+	// WILL EVENTUALLY CHANGE
 	pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
 	/// The transaction which funds this channel. Note that for manually-funded channels (i.e.,
 	/// is_manual_broadcast is true) this will be a dummy empty transaction.
+	// NEEDS INVESTIGATION
 	funding_transaction: Option<Transaction>,
 	/// This flag indicates that it is the user's responsibility to validated and broadcast the
 	/// funding transaction.
@@ -1776,6 +1787,8 @@ pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
 	/// This can be used to rebroadcast the channel_announcement message later.
 	announcement_sigs: Option<(Signature, Signature)>,
 
+	// CHANGES?
+	//
 	// We save these values so we can make sure `next_local_commit_tx_fee_msat` and
 	// `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
 	// be, by comparing the cached values to the fee of the tranaction generated by
@@ -2768,6 +2781,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		})
 	}
 
+	// CHANGES
 	pub(crate) fn get_value_to_self_msat(&self) -> u64 {self.value_to_self_msat}
 
 	/// Allowed in any state (including after shutdown)
@@ -2913,6 +2927,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		self.outbound_scid_alias = outbound_scid_alias;
 	}
 
+	// CHANGES
 	/// Returns the funding_txo we either got from our peer, or were given by
 	/// get_funding_created.
 	pub fn get_funding_txo(&self) -> Option<OutPoint> {
@@ -3085,6 +3100,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		self.channel_transaction_parameters.holder_selected_contest_delay
 	}
 
+	// NEED TO USE FUNDING PUBKEY FROM SCOPE
 	fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
 		&self.channel_transaction_parameters.holder_pubkeys
 	}
@@ -3094,6 +3110,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 			.as_ref().map(|params| params.selected_contest_delay)
 	}
 
+	// NEED TO USE FUNDING PUBKEY FROM SCOPE
 	fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
 		&self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
 	}
@@ -3145,6 +3162,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		})
 	}
 
+	// CHANGES
 	pub fn get_value_satoshis(&self) -> u64 {
 		self.channel_value_satoshis
 	}
@@ -3283,6 +3301,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 	/// have not yet committed it. Such HTLCs will only be included in transactions which are being
 	/// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
 	/// which peer generated this transaction and "to whom" this transaction flows.
+	// PASS IN SCOPE
 	#[inline]
 	fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> CommitmentStats
 		where L::Target: Logger
@@ -3551,6 +3570,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
 	}
 
+	// CHANGES
 	fn counterparty_funding_pubkey(&self) -> &PublicKey {
 		&self.get_counterparty_pubkeys().funding_pubkey
 	}
@@ -3787,6 +3807,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 	/// Doesn't bother handling the
 	/// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
 	/// corner case properly.
+	// NEEDS TO CONSIDER ALL SCOPES
 	pub fn get_available_balances<F: Deref>(&self, fee_estimator: &LowerBoundedFeeEstimator<F>)
 	-> AvailableBalances
 	where F::Target: FeeEstimator
@@ -3942,6 +3963,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		}
 	}
 
+	// CHANGES
 	pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
 		let context = &self;
 		(context.holder_selected_channel_reserve_satoshis, context.counterparty_selected_channel_reserve_satoshis)