mirror of
https://github.com/serai-dex/serai.git
synced 2024-12-22 19:49:22 +00:00
Update documentation on Timelocked
This commit is contained in:
parent
5c6160c398
commit
2e57168a97
2 changed files with 4 additions and 4 deletions
|
@ -33,7 +33,7 @@ pub(crate) mod output;
|
||||||
pub use output::WalletOutput;
|
pub use output::WalletOutput;
|
||||||
|
|
||||||
mod scan;
|
mod scan;
|
||||||
pub use scan::{ScanError, Scanner, GuaranteedScanner};
|
pub use scan::{Timelocked, ScanError, Scanner, GuaranteedScanner};
|
||||||
|
|
||||||
mod decoys;
|
mod decoys;
|
||||||
pub use decoys::OutputWithDecoys;
|
pub use decoys::OutputWithDecoys;
|
||||||
|
|
|
@ -41,9 +41,9 @@ impl Timelocked {
|
||||||
///
|
///
|
||||||
/// `block` is the block number of the block the additional timelock must be satsified by.
|
/// `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
|
/// `time` is represented in seconds since the epoch and is in terms of Monero's on-chain clock.
|
||||||
/// deterministic clock for time which is subject to variance from the real world time. This time
|
/// That means outputs whose additional timelocks are statisfied by `Instant::now()` (the time
|
||||||
/// argument will be evaluated against Monero's clock, not the local system's clock.
|
/// according to the local system clock) may still be locked due to variance with Monero's clock.
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn additional_timelock_satisfied_by(self, block: usize, time: u64) -> Vec<WalletOutput> {
|
pub fn additional_timelock_satisfied_by(self, block: usize, time: u64) -> Vec<WalletOutput> {
|
||||||
let mut res = vec![];
|
let mut res = vec![];
|
||||||
|
|
Loading…
Reference in a new issue