Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tnull merged 4 commits into from
Jun 1, 2023
Merged

Only avoid duplicate payments if we didn't fail sending (and expose list_payments) #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92dffeb
Rename `NonUniquePaymentHash` error to `DuplicatePayment`
tnull May 12, 2023
64cf5f1
Only avoid duplicate payments if we failed sending
tnull May 12, 2023
806f799
Expose `list_payments` in bindings
tnull May 12, 2023
ecd1b64
Rename test case to reflect newer persistence scheme
tnull Jun 1, 2023
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
5 changes: 4 additions & 1 deletion bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
assert(paymentReceivedEvent is Event.PaymentReceived)
node2.eventHandled()

assert(node1.listPayments().size == 1)
assert(node2.listPayments().size == 1)

node2.closeChannel(channelId, nodeId1)

val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
mine(1u)

// Sleep a bit to allow for the block to propagate to esplora
Thread.sleep(3_000)
Thread.sleep(5_000)

node1.syncWallets()
node2.syncWallets()
Expand Down
6 changes: 4 additions & 2 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
PaymentDetails? payment([ByRef]PaymentHash payment_hash);
[Throws=NodeError]
boolean remove_payment([ByRef]PaymentHash payment_hash);
sequence<PaymentDetails> list_payments();
sequence<PeerDetails> list_peers();
sequence<ChannelDetails> list_channels();
[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
"OnchainTxCreationFailed",
"ConnectionFailed",
"InvoiceCreationFailed",
"PaymentFailed",
"PaymentSendingFailed",
"ChannelCreationFailed",
"ChannelClosingFailed",
"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
"InvalidInvoice",
"InvalidChannelId",
"InvalidNetwork",
"NonUniquePaymentHash",
"DuplicatePayment",
"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
"Pending",
"SendingFailed",
"Succeeded",
"Failed",
};
Expand Down
14 changes: 8 additions & 6 deletions src/error.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
ConnectionFailed,
/// Invoice creation failed.
InvoiceCreationFailed,
/// An attempted payment has failed.
PaymentFailed,
/// Sending a payment has failed.
PaymentSendingFailed,
/// A channel could not be opened.
ChannelCreationFailed,
/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
InvalidChannelId,
/// The given network is invalid.
InvalidNetwork,
/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
/// A payment with the given hash has already been intiated.
DuplicatePayment,
/// There are insufficient funds to complete the given operation.
InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
}
Self::ConnectionFailed => write!(f, "Network connection closed."),
Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
Self::PaymentFailed => write!(f, "Failed to send the given payment."),
Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
Self::InvalidNetwork => write!(f, "The given network is invalid."),
Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
Self::DuplicatePayment => {
write!(f, "A payment with the given hash has already been initiated.")
}
Self::InsufficientFunds => {
write!(f, "There are insufficient funds to complete the given operation.")
}
Expand Down
116 changes: 76 additions & 40 deletions src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

if self.payment_store.contains(&payment_hash) {
log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
return Err(Error::NonUniquePaymentHash);
if let Some(payment) = self.payment_store.get(&payment_hash) {
if payment.status != PaymentStatus::SendingFailed {
log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
return Err(Error::DuplicatePayment);
}
}

let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
}
Err(payment::PaymentError::Sending(e)) => {
log_error!(self.logger, "Failed to send payment: {:?}", e);

let payment = PaymentDetails {
preimage: None,
hash: payment_hash,
secret: payment_secret,
amount_msat: invoice.amount_milli_satoshis(),
direction: PaymentDirection::Outbound,
status: PaymentStatus::Failed,
};
self.payment_store.insert(payment)?;

Err(Error::PaymentFailed)
match e {
channelmanager::RetryableSendFailure::DuplicatePayment => {
Err(Error::DuplicatePayment)
}
_ => {
let payment = PaymentDetails {
preimage: None,
hash: payment_hash,
secret: payment_secret,
amount_msat: invoice.amount_milli_satoshis(),
direction: PaymentDirection::Outbound,
status: PaymentStatus::SendingFailed,
};

self.payment_store.insert(payment)?;

@jkczyzjkczyzMay 31, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.

@tnulltnullJun 1, 2023•
edited
Loading

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.

@jkczyzjkczyzJun 1, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.

@tnulltnullJun 1, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.

Err(Error::PaymentSendingFailed)
}
}
}
}
}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
}

let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
if self.payment_store.contains(&payment_hash) {
log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
return Err(Error::NonUniquePaymentHash);
if let Some(payment) = self.payment_store.get(&payment_hash) {
if payment.status != PaymentStatus::SendingFailed {
log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
return Err(Error::DuplicatePayment);
}
}

let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
Err(payment::PaymentError::Sending(e)) => {
log_error!(self.logger, "Failed to send payment: {:?}", e);

let payment = PaymentDetails {
hash: payment_hash,
preimage: None,
secret: payment_secret,
amount_msat: Some(amount_msat),
direction: PaymentDirection::Outbound,
status: PaymentStatus::Failed,
};
self.payment_store.insert(payment)?;

Err(Error::PaymentFailed)
match e {
channelmanager::RetryableSendFailure::DuplicatePayment => {
Err(Error::DuplicatePayment)
}
_ => {
let payment = PaymentDetails {
hash: payment_hash,
preimage: None,
secret: payment_secret,
amount_msat: Some(amount_msat),
direction: PaymentDirection::Outbound,
status: PaymentStatus::SendingFailed,
};
self.payment_store.insert(payment)?;

Err(Error::PaymentSendingFailed)
}
}
}
}
}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

if let Some(payment) = self.payment_store.get(&payment_hash) {
if payment.status != PaymentStatus::SendingFailed {
log_error!(self.logger, "Payment error: must not send duplicate payments.");
return Err(Error::DuplicatePayment);
}
}

let route_params = RouteParameters {
payment_params: PaymentParameters::from_node_id(
node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
Err(e) => {
log_error!(self.logger, "Failed to send payment: {:?}", e);

let payment = PaymentDetails {
hash: payment_hash,
preimage: Some(payment_preimage),
secret: None,
status: PaymentStatus::Failed,
direction: PaymentDirection::Outbound,
amount_msat: Some(amount_msat),
};
self.payment_store.insert(payment)?;

Err(Error::PaymentFailed)
match e {
channelmanager::RetryableSendFailure::DuplicatePayment => {
Err(Error::DuplicatePayment)
}
_ => {
let payment = PaymentDetails {
hash: payment_hash,
preimage: Some(payment_preimage),
secret: None,
status: PaymentStatus::SendingFailed,
direction: PaymentDirection::Outbound,
amount_msat: Some(amount_msat),
};

self.payment_store.insert(payment)?;
Err(Error::PaymentSendingFailed)
}
}
}
}
}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
self.payment_store.list_filter(f)
}

/// Retrieves all payments.
pub fn list_payments(&self) -> Vec<PaymentDetails> {
self.payment_store.list_filter(|_| true)
}

/// Retrieves a list of known peers.
pub fn list_peers(&self) -> Vec<PeerDetails> {
let active_connected_peers: Vec<PublicKey> =
Expand Down
17 changes: 8 additions & 9 deletions src/payment_store.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
/// The payment is still pending.
Pending,
/// The sending of the payment failed and is safe to be retried.
SendingFailed,
/// The payment suceeded.
Succeeded,
/// The payment failed.
/// The payment failed and is not retryable.
Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
(0, Pending) => {},
(1, Succeeded) => {},
(2, Failed) => {};
(2, SendingFailed) => {},
(4, Succeeded) => {},
(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
self.payments.lock().unwrap().get(hash).cloned()
}

pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
self.payments.lock().unwrap().contains_key(hash)
}

pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
let mut updated = false;
let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
use std::sync::Arc;

#[test]
fn persistence_guard_persists_on_drop() {
fn payment_info_is_persisted() {
let store = Arc::new(TestStore::new());
let logger = Arc::new(TestLogger::new());
let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

let hash = PaymentHash([42u8; 32]);
assert!(!payment_store.contains(&hash));
assert!(!payment_store.get(&hash).is_some());

let payment = PaymentDetails {
hash,
Expand Down
13 changes: 11 additions & 2 deletions src/test/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

println!("\nA send_payment");
let payment_hash = node_a.send_payment(&invoice).unwrap();
assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

let outbound_payments_a =
node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
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));
// Assert we fail duplicate outbound payments and check the status hasn't changed.
assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
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_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_1_msat));

// Test under-/overpayment
let invoice_amount_2_msat = 1000_000;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down

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

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down

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

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down

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

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down

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

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down

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

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down

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

Skip to content
Only avoid duplicate payments if we didn't fail sending (and expose list_payments)#96

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 4 commits into

from

Jun 1, 2023
 Merged


Only avoid duplicate payments if we didn't fail sending (and expose list_payments)
#96
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
92dffeb

Rename `NonUniquePaymentHash` error to `DuplicatePayment`


tnull May 12, 2023
64cf5f1

Only avoid duplicate payments if we failed sending


tnull May 12, 2023
806f799

Expose `list_payments` in bindings


tnull May 12, 2023
ecd1b64

Rename test case to reflect newer persistence scheme


tnull Jun 1, 2023

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


5 changes: 4 additions & 1 deletion
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,9 @@ class LibraryTest {
 assert(paymentReceivedEvent is Event.PaymentReceived)
 node2.eventHandled()

 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
Expand All@@ -196,7 +199,7 @@ class LibraryTest {
 mine(1u)

 // Sleep a bit to allow for the block to propagate to esplora
 Thread.sleep(3_000)
 Thread.sleep(5_000)

 node1.syncWallets()
 node2.syncWallets()
Expand Down

6 changes: 4 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ interface LDKNode {
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	boolean remove_payment([ByRef]PaymentHash payment_hash);
	sequence<PaymentDetails> list_payments();
	sequence<PeerDetails> list_peers();
	sequence<ChannelDetails> list_channels();
	[Throws=NodeError]
Expand All@@ -81,7 +82,7 @@ enum NodeError {
	"OnchainTxCreationFailed",
	"ConnectionFailed",
	"InvoiceCreationFailed",
	"PaymentFailed",
	"PaymentSendingFailed",
	"ChannelCreationFailed",
	"ChannelClosingFailed",
	"PersistenceFailed",
Expand All@@ -101,7 +102,7 @@ enum NodeError {
	"InvalidInvoice",
	"InvalidChannelId",
	"InvalidNetwork",
	"NonUniquePaymentHash",
	"DuplicatePayment",
	"InsufficientFunds",
};

Expand All@@ -122,6 +123,7 @@ enum PaymentDirection {

enum PaymentStatus {
	"Pending",
	"SendingFailed",
	"Succeeded",
	"Failed",
};
Expand Down

14 changes: 8 additions & 6 deletions
src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,8 @@ pub enum Error {
	ConnectionFailed,
	/// Invoice creation failed.
	InvoiceCreationFailed,
	/// An attempted payment has failed.
PaymentFailed,
	/// Sending a payment has failed.
PaymentSendingFailed,
	/// A channel could not be opened.
	ChannelCreationFailed,
	/// A channel could not be closed.
Expand DownExpand Up@@ -53,8 +53,8 @@ pub enum Error {
	InvalidChannelId,
	/// The given network is invalid.
	InvalidNetwork,
	/// Payment of the given invoice has already been intiated.
NonUniquePaymentHash,
	/// A payment with the given hash has already been intiated.
DuplicatePayment,
	/// There are insufficient funds to complete the given operation.
	InsufficientFunds,
}
Expand All@@ -69,7 +69,7 @@ impl fmt::Display for Error {
 }
 Self::ConnectionFailed => write!(f, "Network connection closed."),
 Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 Self::PaymentFailed => write!(f, "Failed to send the given payment."),
 Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
 Self::ChannelClosingFailed => write!(f, "Failed to close channel."),
 Self::PersistenceFailed => write!(f, "Failed to persist data."),
Expand All@@ -89,7 +89,9 @@ impl fmt::Display for Error {
 Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
 Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 Self::InvalidNetwork => write!(f, "The given network is invalid."),
 Self::NonUniquePaymentHash => write!(f, "An invoice must not get payed twice."),
 Self::DuplicatePayment => {
 write!(f, "A payment with the given hash has already been initiated.")
 }
 Self::InsufficientFunds => {
 write!(f, "There are insufficient funds to complete the given operation.")
 }
Expand Down

116 changes: 76 additions & 40 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1402,9 +1402,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());

 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_secret = Some(*invoice.payment_secret());
Expand DownExpand Up@@ -1437,18 +1439,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 preimage: None,
 hash: payment_hash,
 secret: payment_secret,
 amount_msat: invoice.amount_milli_satoshis(),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };

 self.payment_store.insert(payment)?;
@jkczyzjkczyzMay 31, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we have any tests that check the payment store? Might be worth adding a test case for duplicate payments.
@tnulltnullJun 1, 2023•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, but checking that we fail to send duplicate payments is already covered in channel_full_cycle? Not entirely sure how we'd check the behavior on the payment store alone as the logic for handling duplicates lives (and has to live I think) in send_payment.
@jkczyzjkczyzJun 1, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we don't check that the status remains the same as before in case of a duplicate error, IIUC.
@tnulltnullJun 1, 2023

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, fair enough, now asserting that the payment details are unchanged after we receive Error::DuplicatePayment.
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1477,9 +1485,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 }

 let payment_hash = PaymentHash((*invoice.payment_hash()).into_inner());
 if self.payment_store.contains(&payment_hash) {
 log_error!(self.logger, "Payment error: an invoice must not get paid twice.");
 return Err(Error::NonUniquePaymentHash);
 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: an invoice must not be paid twice.");
 return Err(Error::DuplicatePayment);
 }
 }

 let payment_id = PaymentId(invoice.payment_hash().into_inner());
Expand DownExpand Up@@ -1532,17 +1542,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(payment::PaymentError::Sending(e)) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::Failed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: None,
 secret: payment_secret,
 amount_msat: Some(amount_msat),
 direction: PaymentDirection::Outbound,
 status: PaymentStatus::SendingFailed,
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand All@@ -1559,6 +1576,13 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());

 if let Some(payment) = self.payment_store.get(&payment_hash) {
 if payment.status != PaymentStatus::SendingFailed {
 log_error!(self.logger, "Payment error: must not send duplicate payments.");
 return Err(Error::DuplicatePayment);
 }
 }

 let route_params = RouteParameters {
 payment_params: PaymentParameters::from_node_id(
 node_id,
Expand DownExpand Up@@ -1593,17 +1617,24 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 Err(e) => {
 log_error!(self.logger, "Failed to send payment: {:?}", e);

 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::Failed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };
 self.payment_store.insert(payment)?;

 Err(Error::PaymentFailed)
 match e {
 channelmanager::RetryableSendFailure::DuplicatePayment => {
 Err(Error::DuplicatePayment)
 }
 _ => {
 let payment = PaymentDetails {
 hash: payment_hash,
 preimage: Some(payment_preimage),
 secret: None,
 status: PaymentStatus::SendingFailed,
 direction: PaymentDirection::Outbound,
 amount_msat: Some(amount_msat),
 };

 self.payment_store.insert(payment)?;
 Err(Error::PaymentSendingFailed)
 }
 }
 }
 }
	}
Expand DownExpand Up@@ -1697,6 +1728,11 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 self.payment_store.list_filter(f)
	}

	/// Retrieves all payments.
	pub fn list_payments(&self) -> Vec<PaymentDetails> {
 self.payment_store.list_filter(|_| true)
	}

	/// Retrieves a list of known peers.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let active_connected_peers: Vec<PublicKey> =
Expand Down

17 changes: 8 additions & 9 deletions
src/payment_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,16 +57,19 @@ impl_writeable_tlv_based_enum!(PaymentDirection,
pub enum PaymentStatus {
	/// The payment is still pending.
	Pending,
	/// The sending of the payment failed and is safe to be retried.
	SendingFailed,
	/// The payment suceeded.
	Succeeded,
	/// The payment failed.
	/// The payment failed and is not retryable.
	Failed,
}

impl_writeable_tlv_based_enum!(PaymentStatus,
	(0, Pending) => {},
	(1, Succeeded) => {},
	(2, Failed) => {};
	(2, SendingFailed) => {},
	(4, Succeeded) => {},
	(6, Failed) => {};
);

#[derive(Clone, Debug, PartialEq, Eq)]
Expand DownExpand Up@@ -139,10 +142,6 @@ where
 self.payments.lock().unwrap().get(hash).cloned()
	}

	pub(crate) fn contains(&self, hash: &PaymentHash) -> bool {
 self.payments.lock().unwrap().contains_key(hash)
	}

	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
 let mut updated = false;
 let mut locked_payments = self.payments.lock().unwrap();
Expand DownExpand Up@@ -210,13 +209,13 @@ mod tests {
	use std::sync::Arc;

	#[test]
	fn persistence_guard_persists_on_drop() {
	fn payment_info_is_persisted() {
 let store = Arc::new(TestStore::new());
 let logger = Arc::new(TestLogger::new());
 let payment_store = PaymentStore::new(Vec::new(), Arc::clone(&store), logger);

 let hash = PaymentHash([42u8; 32]);
 assert!(!payment_store.contains(&hash));
 assert!(!payment_store.get(&hash).is_some());

 let payment = PaymentDetails {
 hash,
Expand Down

13 changes: 11 additions & 2 deletions
src/test/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,6 +104,9 @@ fn channel_full_cycle() {

	println!("\nA send_payment");
	let payment_hash = node_a.send_payment(&invoice).unwrap();
	assert_eq!(node_a.send_payment(&invoice), Err(Error::DuplicatePayment));

	assert_eq!(node_a.list_payments().first().unwrap().hash, payment_hash);

	let outbound_payments_a =
 node_a.list_payments_with_filter(|p| p.direction == PaymentDirection::Outbound);
Expand All@@ -130,8 +133,14 @@ fn channel_full_cycle() {
	assert_eq!(node_b.payment(&payment_hash).unwrap().direction, PaymentDirection::Inbound);
	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));
	// Assert we fail duplicate outbound payments and check the status hasn't changed.
	assert_eq!(Err(Error::DuplicatePayment), node_a.send_payment(&invoice));
	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_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_1_msat));

	// Test under-/overpayment
	let invoice_amount_2_msat = 1000_000;
Expand Down