Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2025-03-23 23:58:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

3.13 Better document the offset mapping

Browse source
This commit is contained in:
Luke Parker 2023-07-10 15:02:34 -04:00
parent 677b9b681f
commit df67b7d94c
No known key found for this signature in database
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
coins/bitcoin/src/wallet/mod.rs
View file

@ -114,6 +114,9 @@ impl Scanner {
/// Due to Bitcoin's requirement that points are even, not every offset may be used. /// Due to Bitcoin's requirement that points are even, not every offset may be used.
/// If an offset isn't usable, it will be incremented until it is. If this offset is already /// If an offset isn't usable, it will be incremented until it is. If this offset is already
/// present, None is returned. Else, Some(offset) will be, with the used offset. /// present, None is returned. Else, Some(offset) will be, with the used offset.
///
/// This means offsets are surjective, not bijective, and the order offsets are registered in
/// may determine the validity of future offsets.
pub fn register_offset(&mut self, mut offset: Scalar) -> Option<Scalar> { pub fn register_offset(&mut self, mut offset: Scalar) -> Option<Scalar> {
// This loop will terminate as soon as an even point is found, with any point having a ~50% // This loop will terminate as soon as an even point is found, with any point having a ~50%
// chance of being even // chance of being even