Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Allow pushing some msats on channel open by tnull · Pull Request #63 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ fn main() {

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();
Expand Down
18 changes: 13 additions & 5 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, None, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
Expand DownExpand Up@@ -841,11 +841,18 @@ impl Node {
self.channel_manager.list_channels()
}

/// Connect to a node and open a new channel. Disconnects and re-connects are handled automatically
/// Connect to a node and opens a new channel.
///
/// Returns a temporary channel id
/// Disconnects and reconnects are handled automatically.
///
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
/// channel counterparty on channel open. This can be useful to start out with the balance not
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
///
/// Returns a temporary channel id.
pub fn connect_open_channel(
&self, node_pubkey_and_address: &str, channel_amount_sats: u64, announce_channel: bool,
&self, node_pubkey_and_address: &str, channel_amount_sats: u64,
push_to_counterparty_msat: Option<u64>, announce_channel: bool,
) -> Result<(), Error> {
let runtime_lock = self.running.read().unwrap();
if runtime_lock.is_none() {
Expand DownExpand Up@@ -895,12 +902,13 @@ impl Node {
..Default::default()
};

let push_msat = push_to_counterparty_msat.unwrap_or(0);
let user_channel_id: u128 = rand::thread_rng().gen::<u128>();

match self.channel_manager.create_channel(
peer_info.pubkey,
channel_amount_sats,
0,
push_msat,
user_channel_id,
Some(user_config),
) {
Expand Down
81 changes: 50 additions & 31 deletions src/test/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,20 +20,24 @@ fn channel_full_cycle() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let funding_amount_sat = 80_000;
let push_msat = (funding_amount_sat / 2) * 1000; // balance the channel
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();
node_a.connect_open_channel(&node_b_addr, funding_amount_sat, Some(push_msat), true).unwrap();

expect_event!(node_a, ChannelPending);

Expand All@@ -55,10 +59,13 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

let onchain_fee_buffer_sat = 1500;
let node_a_balance = node_a.on_chain_balance().unwrap();
assert!(node_a_balance.get_spendable() < 50000);
assert!(node_a_balance.get_spendable() > 40000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
let node_a_upper_bound_sat = premine_amount_sat - funding_amount_sat;
let node_a_lower_bound_sat = premine_amount_sat - funding_amount_sat - onchain_fee_buffer_sat;
assert!(node_a_balance.get_spendable() < node_a_upper_bound_sat);
assert!(node_a_balance.get_spendable() > node_a_lower_bound_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

expect_event!(node_a, ChannelReady);

Expand All@@ -74,8 +81,8 @@ fn channel_full_cycle() {
};

println!("\nB receive_payment");
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_1_msat = 1000000;
let invoice = node_b.receive_payment(invoice_amount_1_msat, &"asdf", 9217).unwrap();

println!("\nA send_payment");
let payment_hash = node_a.send_payment(invoice.clone()).unwrap();
Expand All@@ -100,27 +107,27 @@ fn channel_full_cycle() {
expect_event!(node_b, PaymentReceived);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(invoice_amount_1_msat));

// Assert we fail duplicate outbound payments.
assert_eq!(Err(Error::NonUniquePaymentHash), node_a.send_payment(invoice));

// Test under-/overpayment
let invoice_amount = 1000000;
let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let invoice_amount_2_msat = 1000_000;
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();

let underpaid_amount = invoice_amount - 1;
let underpaid_amount = invoice_amount_2_msat - 1;
assert_eq!(
Err(Error::InvalidAmount),
node_a.send_payment_using_amount(invoice, underpaid_amount)
);

let invoice = node_b.receive_payment(invoice_amount, &"asdf", 9217).unwrap();
let overpaid_amount = invoice_amount + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount).unwrap();
let invoice = node_b.receive_payment(invoice_amount_2_msat, &"asdf", 9217).unwrap();
let overpaid_amount_msat = invoice_amount_2_msat + 100;
let payment_hash = node_a.send_payment_using_amount(invoice, overpaid_amount_msat).unwrap();
expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
ref e @ Event::PaymentReceived { amount_msat, .. } => {
Expand All@@ -132,20 +139,20 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, overpaid_amount);
assert_eq!(received_amount, overpaid_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(overpaid_amount_msat));

// Test "zero-amount" invoice payment
let variable_amount_invoice = node_b.receive_variable_amount_payment(&"asdf", 9217).unwrap();
let determined_amount = 1234567;
let determined_amount_msat = 1234_567;
assert_eq!(Err(Error::InvalidInvoice), node_a.send_payment(variable_amount_invoice.clone()));
let payment_hash =
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount).unwrap();
node_a.send_payment_using_amount(variable_amount_invoice, determined_amount_msat).unwrap();

expect_event!(node_a, PaymentSuccessful);
let received_amount = match node_b.next_event() {
Expand All@@ -158,13 +165,13 @@ fn channel_full_cycle() {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};
assert_eq!(received_amount, determined_amount);
assert_eq!(received_amount, determined_amount_msat);
assert_eq!(node_a.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_a.payment(&payment_hash).unwrap().direction, PaymentDirection::Outbound);
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_a.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));
assert_eq!(node_b.payment(&payment_hash).unwrap().status, PaymentStatus::Succeeded);
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount));
assert_eq!(node_b.payment(&payment_hash).unwrap().amount_msat, Some(determined_amount_msat));

node_b.close_channel(&channel_id, &node_a.node_id()).unwrap();
expect_event!(node_a, ChannelClosed);
Expand All@@ -176,8 +183,18 @@ fn channel_full_cycle() {
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();

assert!(node_a.on_chain_balance().unwrap().get_spendable() > 90000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 103234);
let sum_of_all_payments_sat =
(push_msat + invoice_amount_1_msat + overpaid_amount_msat + determined_amount_msat) / 1000;
let node_a_upper_bound_sat =
(premine_amount_sat - funding_amount_sat) + (funding_amount_sat - sum_of_all_payments_sat);
let node_a_lower_bound_sat = node_a_upper_bound_sat - onchain_fee_buffer_sat;
assert!(node_a.on_chain_balance().unwrap().get_spendable() > node_a_lower_bound_sat);
assert!(node_a.on_chain_balance().unwrap().get_spendable() < node_a_upper_bound_sat);
let expected_final_amount_node_b_sat = premine_amount_sat + sum_of_all_payments_sat;
assert_eq!(
node_b.on_chain_balance().unwrap().get_spendable(),
expected_final_amount_node_b_sat
);

node_a.stop().unwrap();
println!("\nA stopped");
Expand All@@ -201,22 +218,24 @@ fn channel_open_fails_when_funds_insufficient() {
node_b.start().unwrap();
let addr_b = node_b.new_funding_address().unwrap();

let premine_amount_sat = 100_000;

premine_and_distribute_funds(
&bitcoind,
&electrsd,
vec![addr_a, addr_b],
Amount::from_sat(100000),
Amount::from_sat(premine_amount_sat),
);
node_a.sync_wallets().unwrap();
node_b.sync_wallets().unwrap();
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), 100000);
assert_eq!(node_a.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);
assert_eq!(node_b.on_chain_balance().unwrap().get_spendable(), premine_amount_sat);

println!("\nA -- connect_open_channel -> B");
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
assert_eq!(
Err(Error::InsufficientFunds),
node_a.connect_open_channel(&node_b_addr, 120000, true)
node_a.connect_open_channel(&node_b_addr, 120000, None, true)
);
}

Expand Down