Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 1 commit into from
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978 #1985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 24 additions & 22 deletions lightning-invoice/src/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
///
/// 'duration_since_epoch' is the current time since epoch in seconds.
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
Comment on lines +44 to +46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?

@TheBlueMattTheBlueMattJan 30, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
let description = InvoiceDescription::Direct(&description,);
_create_phantom_invoice::<ES, NS, L>(
amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
///
/// 'duration_since_epoch' is the current time since epoch in seconds.
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
_create_phantom_invoice::<ES, NS, L>(
amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
min_final_cltv_expiry_delta,
min_final_cltv_expiry_delta, duration_since_epoch,
)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
ES::Target: EntropySource,
NS::Target: NodeSigner,
L::Target: Logger,
{
use std::time::{SystemTime, UNIX_EPOCH};

if phantom_route_hints.len() == 0 {
return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
amt_msat,
payment_hash,
invoice_expiry_delta_secs,
SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("Time must be > 1970")
duration_since_epoch
.as_secs(),
min_final_cltv_expiry_delta,
)
Expand All@@ -176,9 +179,7 @@ where
amt_msat,
invoice_expiry_delta_secs,
&entropy_source,
SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("Time must be > 1970")
duration_since_epoch
.as_secs(),
min_final_cltv_expiry_delta,
)
Expand All@@ -189,7 +190,7 @@ where
phantom_route_hints.len(), log_bytes!(payment_hash.0));

let mut invoice = invoice
.current_timestamp()
.duration_since_epoch(duration_since_epoch)
.payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
.payment_secret(payment_secret)
.min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
Currency::BitcoinTestnet, None,
Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
).unwrap();
let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
&test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
"test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
&nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
&nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
>(
Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
Currency::BitcoinTestnet, None,
Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
)
.unwrap();
assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
let non_default_invoice_expiry_secs = 4200;
let min_final_cltv_expiry_delta = Some(100);
let duration_since_epoch = Duration::from_secs(1234567);
let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
&test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
"".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
&nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
&nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
assert_eq!(invoice.amount_pico_btc(), Some(200_000));
assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
&test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
&invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
&invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

let invoice_hints = invoice.private_routes();

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content
Remove std::SystemTime from create_phantom_invoice, ref #1978#1985

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content
Remove std::SystemTime from create_phantom_invoice, ref #1978#1985

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Jan 30, 2023
 Merged


Remove std::SystemTime from create_phantom_invoice, ref #1978
#1985
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 24 additions & 22 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::keysinterface::{Recipient, NodeSigner, SignerProvider, EntropySource};
use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::channelmanager::{ChannelDetails, ChannelManager, PaymentId, PaymentSendFailure, MIN_FINAL_CLTV_EXPIRY_DELTA};
#[cfg(feature = "std")]
use lightning::ln::channelmanager::{PhantomRouteHints, MIN_CLTV_EXPIRY_DELTA};
use lightning::ln::inbound_payment::{create, create_from_hash, ExpandedKey};
use lightning::routing::gossip::RoutingFees;
Expand All@@ -21,7 +20,6 @@ use secp256k1::PublicKey;
use core::ops::Deref;
use core::time::Duration;

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -41,6 +39,11 @@ use core::time::Duration;
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Comment on lines

+44
 to 
+46

@dunxendunxenJan 27, 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.

Can this (and the one below) not just be part of the release notes?
@TheBlueMattTheBlueMattJan 30, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.
///
/// You can specify a custom `min_final_cltv_expiry_delta`, or let LDK default it to
/// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]. The provided expiry must be at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`] - 3.
Expand All@@ -60,7 +63,7 @@ use core::time::Duration;
pub fn create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: String,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -71,11 +74,10 @@ where
	let description = InvoiceDescription::Direct(&description,);
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, description, invoice_expiry_delta_secs, phantom_route_hints,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta,
 entropy_source, node_signer, logger, network, min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
/// Utility to create an invoice that can be paid to one of multiple nodes, or a "phantom invoice."
/// See [`PhantomKeysManager`] for more information on phantom node payments.
///
Expand All@@ -97,6 +99,11 @@ where
///
/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
/// in excess of the current time.
/// 
/// 'duration_since_epoch' is the current time since epoch in seconds.
/// 
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment, 
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.
///
/// Note that the provided `keys_manager`'s `NodeSigner` implementation must support phantom
/// invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
Expand All@@ -110,7 +117,7 @@ where
pub fn create_phantom_invoice_with_description_hash<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, invoice_expiry_delta_secs: u32,
	description_hash: Sha256, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
Expand All@@ -120,22 +127,20 @@ where
	_create_phantom_invoice::<ES, NS, L>(
 amt_msat, payment_hash, InvoiceDescription::Hash(&description_hash),
 invoice_expiry_delta_secs, phantom_route_hints, entropy_source, node_signer, logger, network,
 min_final_cltv_expiry_delta,
 min_final_cltv_expiry_delta, duration_since_epoch,
	)
}

#[cfg(feature = "std")]
fn _create_phantom_invoice<ES: Deref, NS: Deref, L: Deref>(
	amt_msat: Option<u64>, payment_hash: Option<PaymentHash>, description: InvoiceDescription,
	invoice_expiry_delta_secs: u32, phantom_route_hints: Vec<PhantomRouteHints>, entropy_source: ES,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>,
	node_signer: NS, logger: L, network: Currency, min_final_cltv_expiry_delta: Option<u16>, duration_since_epoch: Duration,
) -> Result<Invoice, SignOrCreationError<()>>
where
	ES::Target: EntropySource,
	NS::Target: NodeSigner,
	L::Target: Logger,
{
	use std::time::{SystemTime, UNIX_EPOCH};

	if phantom_route_hints.len() == 0 {
 return Err(SignOrCreationError::CreationError(
Expand All@@ -162,9 +167,7 @@ where
 amt_msat,
 payment_hash,
 invoice_expiry_delta_secs,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -176,9 +179,7 @@ where
 amt_msat,
 invoice_expiry_delta_secs,
 &entropy_source,
 SystemTime::now()
 .duration_since(UNIX_EPOCH)
 .expect("Time must be > 1970")
 duration_since_epoch
 .as_secs(),
 min_final_cltv_expiry_delta,
 )
Expand All@@ -189,7 +190,7 @@ where
 phantom_route_hints.len(), log_bytes!(payment_hash.0));

	let mut invoice = invoice
 .current_timestamp()
 .duration_since_epoch(duration_since_epoch)
 .payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
 .payment_secret(payment_secret)
 .min_final_cltv_expiry_delta(
Expand DownExpand Up@@ -1072,7 +1073,7 @@ mod test {
 crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestLogger>(
 Some(payment_amt), payment_hash, "test".to_string(), non_default_invoice_expiry_secs,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567)
 ).unwrap();
 let (payment_hash, payment_secret) = (PaymentHash(invoice.payment_hash().into_inner()), *invoice.payment_secret());
 let payment_preimage = if user_generated_pmt_hash {
Expand DownExpand Up@@ -1182,7 +1183,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), Some(payment_hash),
 "test".to_string(), 3600, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, None).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let chan_0_1 = &nodes[1].node.list_usable_channels()[0];
 assert_eq!(invoice.route_hints()[0].0[0].htlc_minimum_msat, chan_0_1.inbound_htlc_minimum_msat);
Expand DownExpand Up@@ -1214,7 +1215,7 @@ mod test {
 >(
 Some(payment_amt), None, non_default_invoice_expiry_secs, description_hash,
 route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager, &nodes[1].logger,
 Currency::BitcoinTestnet, None,
 Currency::BitcoinTestnet, None, Duration::from_secs(1234567),
 )
 .unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
Expand All@@ -1240,10 +1241,11 @@ mod test {
 let payment_hash = Some(PaymentHash(Sha256::hash(&user_payment_preimage.0[..]).into_inner()));
 let non_default_invoice_expiry_secs = 4200;
 let min_final_cltv_expiry_delta = Some(100);
 let duration_since_epoch = Duration::from_secs(1234567);
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(Some(payment_amt), payment_hash,
 "".to_string(), non_default_invoice_expiry_secs, route_hints, &nodes[1].keys_manager, &nodes[1].keys_manager,
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta).unwrap();
 &nodes[1].logger, Currency::BitcoinTestnet, min_final_cltv_expiry_delta, duration_since_epoch).unwrap();
 assert_eq!(invoice.amount_pico_btc(), Some(200_000));
 assert_eq!(invoice.min_final_cltv_expiry_delta(), (min_final_cltv_expiry_delta.unwrap() + 3) as u64);
 assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into()));
Expand DownExpand Up@@ -1557,7 +1559,7 @@ mod test {
 let invoice = crate::utils::create_phantom_invoice::<&test_utils::TestKeysInterface,
 &test_utils::TestKeysInterface, &test_utils::TestLogger>(invoice_amt, None, "test".to_string(),
 3600, phantom_route_hints, &invoice_node.keys_manager, &invoice_node.keys_manager,
 &invoice_node.logger, Currency::BitcoinTestnet, None).unwrap();
 &invoice_node.logger, Currency::BitcoinTestnet, None, Duration::from_secs(1234567)).unwrap();

 let invoice_hints = invoice.private_routes();

Expand Down