From 2e57168a97f56dd405b2c45568bd901f18efb5be Mon Sep 17 00:00:00 2001 From: Luke Parker Date: Fri, 20 Sep 2024 04:01:55 -0400 Subject: [PATCH] Update documentation on Timelocked --- networks/monero/wallet/src/lib.rs | 2 +- networks/monero/wallet/src/scan.rs | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/networks/monero/wallet/src/lib.rs b/networks/monero/wallet/src/lib.rs index 63f7488a..3c6c1807 100644 --- a/networks/monero/wallet/src/lib.rs +++ b/networks/monero/wallet/src/lib.rs @@ -33,7 +33,7 @@ pub(crate) mod output; pub use output::WalletOutput; mod scan; -pub use scan::{ScanError, Scanner, GuaranteedScanner}; +pub use scan::{Timelocked, ScanError, Scanner, GuaranteedScanner}; mod decoys; pub use decoys::OutputWithDecoys; diff --git a/networks/monero/wallet/src/scan.rs b/networks/monero/wallet/src/scan.rs index 0de35f35..19f4d50f 100644 --- a/networks/monero/wallet/src/scan.rs +++ b/networks/monero/wallet/src/scan.rs @@ -41,9 +41,9 @@ impl Timelocked { /// /// `block` is the block number of the block the additional timelock must be satsified by. /// - /// `time` is represented in seconds since the epoch. Please note Monero uses an on-chain - /// deterministic clock for time which is subject to variance from the real world time. This time - /// argument will be evaluated against Monero's clock, not the local system's clock. + /// `time` is represented in seconds since the epoch and is in terms of Monero's on-chain clock. + /// That means outputs whose additional timelocks are statisfied by `Instant::now()` (the time + /// according to the local system clock) may still be locked due to variance with Monero's clock. #[must_use] pub fn additional_timelock_satisfied_by(self, block: usize, time: u64) -> Vec { let mut res = vec![];