Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 9 commits into from
Aug 13, 2021
Merged

Automatically Update fees on outbound channels #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
29b43ba
Add standard derives for ConfirmationTarget
TheBlueMatt Jul 4, 2021
692b0c7
Set cfg=fuzzing when building fuzz crate in CI
TheBlueMatt Jul 5, 2021
03439ec
Automatically update fees on outbound channels as fees change
TheBlueMatt Jun 28, 2021
f8caa32
Add fuzz coverage of (potential) fee update messages
TheBlueMatt Jun 30, 2021
b09a60b
Add more logging during chanmon_consistency runs
TheBlueMatt Jul 13, 2021
9d49c5c
Fix re-sending commitment updates with an outbound fee update
TheBlueMatt Jun 30, 2021
b3d0a8d
Fix handling of inbound uncommitted feerate updates
TheBlueMatt Jul 12, 2021
01e8ff5
Log when we change HTLC state while sending a commitment transaction
TheBlueMatt Jul 13, 2021
d3af49e
Limit inbound fee updates by dust exposure instead of our estimator
TheBlueMatt Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ci/check-compiles.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std
107 changes: 84 additions & 23 deletions fuzz/src/chanmon_consistency.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
253
fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
// We force-close channels if our counterparty sends us a feerate which is a small multiple
// of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
// always return a HighPriority feerate here which is >= the maximum Normal feerate and a
// Background feerate which is <= the minimum Normal feerate.
match conf_target {
ConfirmationTarget::HighPriority => MAX_FEE,
ConfirmationTarget::Background => 253,
ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
}
}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
};
let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
let mut ser = VecWriter(Vec::new());
deserialized_monitor.write(&mut ser).unwrap();
map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
let fee_est = Arc::new(FuzzEstimator{});
let broadcast = Arc::new(TestBroadcaster{});

macro_rules! make_node {
($node_id: expr) => { {
($node_id: expr, $fee_estimator: expr) => { {
let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

let mut config = UserConfig::default();
config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
network,
best_block: BestBlock::from_genesis(network),
};
(ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
(ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
monitor, keys_manager)
} }
}

macro_rules! reload_node {
($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
let keys_manager = Arc::clone(& $keys_manager);
let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

let mut config = UserConfig::default();
config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

let read_args = ChannelManagerReadArgs {
keys_manager,
fee_estimator: fee_est.clone(),
fee_estimator: $fee_estimator.clone(),
chain_monitor: chain_monitor.clone(),
tx_broadcaster: broadcast.clone(),
logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
} }
}

let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
let mut last_htlc_clear_fee_a = 253;
let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
let mut last_htlc_clear_fee_b = 253;
let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
let mut last_htlc_clear_fee_c = 253;

// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
// forwarding.
let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
had_events = true;
match event {
events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
for dest in nodes.iter() {
for (idx, dest) in nodes.iter().enumerate() {
if dest.get_our_node_id() == node_id {
assert!(update_fee.is_none());
for update_add in update_add_htlcs.iter() {
out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
if !$corrupt_forward {
dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
} else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
}
}
for update_fulfill in update_fulfill_htlcs.iter() {
out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
}
for update_fail in update_fail_htlcs.iter() {
out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
}
for update_fail_malformed in update_fail_malformed_htlcs.iter() {
out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
}
if let Some(msg) = update_fee {
out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
}
let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
!update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
} });
break;
}
out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
break;
}
}
},
events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
for dest in nodes.iter() {
for (idx, dest) in nodes.iter().enumerate() {
if dest.get_our_node_id() == *node_id {
out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
}
}
},
events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
for dest in nodes.iter() {
for (idx, dest) in nodes.iter().enumerate() {
if dest.get_our_node_id() == *node_id {
out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
}
}
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
} }
}

match get_slice!(1)[0] {
let v = get_slice!(1)[0];
out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
match v {
// In general, we keep related message groups close together in binary form, allowing
// bit-twiddling mutations to have similar effects. This is probably overkill, but no
// harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
node_a_ser.0.clear();
nodes[0].write(&mut node_a_ser).unwrap();
}
let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
nodes[0] = new_node_a;
monitor_a = new_monitor_a;
},
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
bc_events.clear();
cb_events.clear();
}
let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
nodes[1] = new_node_b;
monitor_b = new_monitor_b;
},
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
node_c_ser.0.clear();
nodes[2].write(&mut node_c_ser).unwrap();
}
let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
nodes[2] = new_node_c;
monitor_c = new_monitor_c;
},
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

0x80 => {
let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
}
nodes[0].maybe_update_chan_fees();
},
0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

0x84 => {
let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
}
nodes[1].maybe_update_chan_fees();
},
0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

0x88 => {
let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
}
nodes[2].maybe_update_chan_fees();
},
0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

0xff => {
// Test that no channel is in a stuck state where neither party can send funds even
// after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
assert!(
send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
},
_ => test_return!(),
}
Expand Down
3 changes: 3 additions & 0 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
let stop_thread = Arc::new(AtomicBool::new(false));
let stop_thread_clone = stop_thread.clone();
let handle = thread::spawn(move || -> Result<(), std::io::Error> {
log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
channel_manager.timer_tick_occurred();

let mut last_freshness_call = Instant::now();
let mut last_ping_call = Instant::now();
loop {
Expand Down
1 change: 1 addition & 0 deletions lightning/src/chain/chaininterface.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
/// We are happy with this transaction confirming slowly when feerate drops some.
Background,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Automatically Update fees on outbound channels#985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 9 commits into

from

Aug 13, 2021
 Merged


Automatically Update fees on outbound channels
#985
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
29b43ba

Add standard derives for ConfirmationTarget


TheBlueMatt Jul 4, 2021
692b0c7

Set cfg=fuzzing when building fuzz crate in CI


TheBlueMatt Jul 5, 2021
03439ec

Automatically update fees on outbound channels as fees change


TheBlueMatt Jun 28, 2021
f8caa32

Add fuzz coverage of (potential) fee update messages


TheBlueMatt Jun 30, 2021
b09a60b

Add more logging during chanmon_consistency runs


TheBlueMatt Jul 13, 2021
9d49c5c

Fix re-sending commitment updates with an outbound fee update


TheBlueMatt Jun 30, 2021
b3d0a8d

Fix handling of inbound uncommitted feerate updates


TheBlueMatt Jul 12, 2021
01e8ff5

Log when we change HTLC state while sending a commitment transaction


TheBlueMatt Jul 13, 2021
d3af49e

Limit inbound fee updates by dust exposure instead of our estimator


TheBlueMatt Jun 30, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/check-compiles.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,5 +5,5 @@ echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cargo doc --document-private-items
cd fuzz && cargo check --features=stdin_fuzz
cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo check --features=stdin_fuzz
cd ../lightning && cargo check --no-default-features --features=no-std

107 changes: 84 additions & 23 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget,
use lightning::chain::keysinterface::{KeysInterface, InMemorySigner};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChainParameters, ChannelManager, PaymentSendFailure, ChannelManagerReadArgs};
use lightning::ln::channel::FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, DecodeError, UpdateAddHTLC, Init};
use lightning::ln::script::ShutdownScript;
Expand All@@ -58,16 +59,27 @@ use bitcoin::secp256k1::recovery::RecoverableSignature;
use bitcoin::secp256k1::Secp256k1;

use std::mem;
use std::cmp::Ordering;
use std::cmp::{self, Ordering};
use std::collections::{HashSet, hash_map, HashMap};
use std::sync::{Arc,Mutex};
use std::sync::atomic;
use std::io::Cursor;

struct FuzzEstimator {}
const MAX_FEE: u32 = 10_000;
struct FuzzEstimator {
	ret_val: atomic::AtomicU32,
}
impl FeeEstimator for FuzzEstimator {
	fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 253
	fn get_est_sat_per_1000_weight(&self, conf_target: ConfirmationTarget) -> u32 {
 // We force-close channels if our counterparty sends us a feerate which is a small multiple
 // of our HighPriority fee estimate or smaller than our Background fee estimate. Thus, we
 // always return a HighPriority feerate here which is >= the maximum Normal feerate and a
 // Background feerate which is <= the minimum Normal feerate.
 match conf_target {
 ConfirmationTarget::HighPriority => MAX_FEE,
 ConfirmationTarget::Background => 253,
 ConfirmationTarget::Normal => cmp::min(self.ret_val.load(atomic::Ordering::Acquire), MAX_FEE),
 }
	}
}

Expand DownExpand Up@@ -132,7 +144,7 @@ impl chain::Watch<EnforcingSigner> for TestChainMonitor {
 };
 let deserialized_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::
 read(&mut Cursor::new(&map_entry.get().1), &*self.keys).unwrap().1;
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator{}, &self.logger).unwrap();
 deserialized_monitor.update_monitor(&update, &&TestBroadcaster{}, &&FuzzEstimator { ret_val: atomic::AtomicU32::new(253) }, &self.logger).unwrap();
 let mut ser = VecWriter(Vec::new());
 deserialized_monitor.write(&mut ser).unwrap();
 map_entry.insert((update.update_id, ser.0));
Expand DownExpand Up@@ -334,14 +346,13 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des

#[inline]
pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
	let fee_est = Arc::new(FuzzEstimator{});
	let broadcast = Arc::new(TestBroadcaster{});

	macro_rules! make_node {
 ($node_id: expr) => { {
 ($node_id: expr, $fee_estimator: expr) => { {
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let keys_manager = Arc::new(KeyProvider { node_id: $node_id, rand_bytes_id: atomic::AtomicU32::new(0), revoked_commitments: Mutex::new(HashMap::new()) });
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));
 let monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(&keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -351,16 +362,16 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 network,
 best_block: BestBlock::from_genesis(network),
 };
 (ChannelManager::new(fee_est.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 (ChannelManager::new($fee_estimator.clone(), monitor.clone(), broadcast.clone(), Arc::clone(&logger), keys_manager.clone(), config, params),
 monitor, keys_manager)
 } }
	}

	macro_rules! reload_node {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr) => { {
 ($ser: expr, $node_id: expr, $old_monitors: expr, $keys_manager: expr, $fee_estimator: expr) => { {
 let keys_manager = Arc::clone(& $keys_manager);
 let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string(), out.clone()));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), fee_est.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));
 let chain_monitor = Arc::new(TestChainMonitor::new(broadcast.clone(), logger.clone(), $fee_estimator.clone(), Arc::new(TestPersister{}), Arc::clone(& $keys_manager)));

 let mut config = UserConfig::default();
 config.channel_options.forwarding_fee_proportional_millionths = 0;
Expand All@@ -379,7 +390,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {

 let read_args = ChannelManagerReadArgs {
 keys_manager,
 fee_estimator: fee_est.clone(),
 fee_estimator: $fee_estimator.clone(),
 chain_monitor: chain_monitor.clone(),
 tx_broadcaster: broadcast.clone(),
 logger,
Expand DownExpand Up@@ -497,11 +508,18 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
	}

	let fee_est_a = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_a = 253;
	let fee_est_b = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_b = 253;
	let fee_est_c = Arc::new(FuzzEstimator { ret_val: atomic::AtomicU32::new(253) });
	let mut last_htlc_clear_fee_c = 253;

	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
	// forwarding.
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2);
	let (node_a, mut monitor_a, keys_manager_a) = make_node!(0, fee_est_a);
	let (node_b, mut monitor_b, keys_manager_b) = make_node!(1, fee_est_b);
	let (node_c, mut monitor_c, keys_manager_c) = make_node!(2, fee_est_c);

	let mut nodes = [node_a, node_b, node_c];

Expand DownExpand Up@@ -637,10 +655,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 had_events = true;
 match event {
 events::MessageSendEvent::UpdateHTLCs { node_id, updates: CommitmentUpdate { update_add_htlcs, update_fail_htlcs, update_fulfill_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == node_id {
 assert!(update_fee.is_none());
 for update_add in update_add_htlcs.iter() {
 out.locked_write(format!("Delivering update_add_htlc to node {}.\n", idx).as_bytes());
 if !$corrupt_forward {
 dest.handle_update_add_htlc(&nodes[$node].get_our_node_id(), update_add);
 } else {
Expand All@@ -655,14 +673,21 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }
 }
 for update_fulfill in update_fulfill_htlcs.iter() {
 out.locked_write(format!("Delivering update_fulfill_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fulfill_htlc(&nodes[$node].get_our_node_id(), update_fulfill);
 }
 for update_fail in update_fail_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_htlc(&nodes[$node].get_our_node_id(), update_fail);
 }
 for update_fail_malformed in update_fail_malformed_htlcs.iter() {
 out.locked_write(format!("Delivering update_fail_malformed_htlc to node {}.\n", idx).as_bytes());
 dest.handle_update_fail_malformed_htlc(&nodes[$node].get_our_node_id(), update_fail_malformed);
 }
 if let Some(msg) = update_fee {
 out.locked_write(format!("Delivering update_fee to node {}.\n", idx).as_bytes());
 dest.handle_update_fee(&nodes[$node].get_our_node_id(), &msg);
 }
 let processed_change = !update_add_htlcs.is_empty() || !update_fulfill_htlcs.is_empty() ||
 !update_fail_htlcs.is_empty() || !update_fail_malformed_htlcs.is_empty();
 if $limit_events != ProcessMessages::AllMessages && processed_change {
Expand All@@ -677,21 +702,24 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } });
 break;
 }
 out.locked_write(format!("Delivering commitment_signed to node {}.\n", idx).as_bytes());
 dest.handle_commitment_signed(&nodes[$node].get_our_node_id(), &commitment_signed);
 break;
 }
 }
 },
 events::MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering revoke_and_ack to node {}.\n", idx).as_bytes());
 dest.handle_revoke_and_ack(&nodes[$node].get_our_node_id(), msg);
 }
 }
 },
 events::MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
 for dest in nodes.iter() {
 for (idx, dest) in nodes.iter().enumerate() {
 if dest.get_our_node_id() == *node_id {
 out.locked_write(format!("Delivering channel_reestablish to node {}.\n", idx).as_bytes());
 dest.handle_channel_reestablish(&nodes[$node].get_our_node_id(), msg);
 }
 }
Expand DownExpand Up@@ -824,7 +852,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 } }
 }

 match get_slice!(1)[0] {
 let v = get_slice!(1)[0];
 out.locked_write(format!("READ A BYTE! HANDLING INPUT {:x}...........\n", v).as_bytes());
 match v {
 // In general, we keep related message groups close together in binary form, allowing
 // bit-twiddling mutations to have similar effects. This is probably overkill, but no
 // harm in doing so.
Expand DownExpand Up@@ -928,7 +958,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_a_ser.0.clear();
 nodes[0].write(&mut node_a_ser).unwrap();
 }
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a);
 let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a, keys_manager_a, fee_est_a);
 nodes[0] = new_node_a;
 monitor_a = new_monitor_a;
 },
Expand All@@ -947,7 +977,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 bc_events.clear();
 cb_events.clear();
 }
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b);
 let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b, keys_manager_b, fee_est_b);
 nodes[1] = new_node_b;
 monitor_b = new_monitor_b;
 },
Expand All@@ -961,7 +991,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 node_c_ser.0.clear();
 nodes[2].write(&mut node_c_ser).unwrap();
 }
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c);
 let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c, keys_manager_c, fee_est_c);
 nodes[2] = new_node_c;
 monitor_c = new_monitor_c;
 },
Expand DownExpand Up@@ -1023,6 +1053,33 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 0x6c => { send_hop_payment(&nodes[0], &nodes[1], chan_a, &nodes[2], chan_b, 1, &mut payment_id); },
 0x6d => { send_hop_payment(&nodes[2], &nodes[1], chan_b, &nodes[0], chan_a, 1, &mut payment_id); },

 0x80 => {
 let max_feerate = last_htlc_clear_fee_a * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_a.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_a.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[0].maybe_update_chan_fees();
 },
 0x81 => { fee_est_a.ret_val.store(253, atomic::Ordering::Release); nodes[0].maybe_update_chan_fees(); },

 0x84 => {
 let max_feerate = last_htlc_clear_fee_b * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_b.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_b.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[1].maybe_update_chan_fees();
 },
 0x85 => { fee_est_b.ret_val.store(253, atomic::Ordering::Release); nodes[1].maybe_update_chan_fees(); },

 0x88 => {
 let max_feerate = last_htlc_clear_fee_c * FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE as u32;
 if fee_est_c.ret_val.fetch_add(250, atomic::Ordering::AcqRel) + 250 > max_feerate {
 fee_est_c.ret_val.store(max_feerate, atomic::Ordering::Release);
 }
 nodes[2].maybe_update_chan_fees();
 },
 0x89 => { fee_est_c.ret_val.store(253, atomic::Ordering::Release); nodes[2].maybe_update_chan_fees(); },

 0xff => {
 // Test that no channel is in a stuck state where neither party can send funds even
 // after we resolve all pending events.
Expand DownExpand Up@@ -1078,6 +1135,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 assert!(
 send_payment(&nodes[1], &nodes[2], chan_b, 10_000_000, &mut payment_id) ||
 send_payment(&nodes[2], &nodes[1], chan_b, 10_000_000, &mut payment_id));

 last_htlc_clear_fee_a = fee_est_a.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_b = fee_est_b.ret_val.load(atomic::Ordering::Acquire);
 last_htlc_clear_fee_c = fee_est_c.ret_val.load(atomic::Ordering::Acquire);
 },
 _ => test_return!(),
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,6 +140,9 @@ impl BackgroundProcessor {
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.timer_tick_occurred();

 let mut last_freshness_call = Instant::now();
 let mut last_ping_call = Instant::now();
 loop {
Expand Down

1 change: 1 addition & 0 deletions
lightning/src/chain/chaininterface.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ pub trait BroadcasterInterface {

/// An enum that represents the speed at which we want a transaction to confirm used for feerate
/// estimation.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum ConfirmationTarget {
	/// We are happy with this transaction confirming slowly when feerate drops some.
	Background,
Expand Down
Loading