evm-dex-pool 1.2.2

Reusable EVM DEX pool implementations (UniswapV2, UniswapV3, ERC4626) with traits and math
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! ## Bit Math Library in Rust
//!
//! This module is a Rust port of the Solidity [BitMath library](https://github.com/uniswap/v3-core/blob/main/contracts/libraries/BitMath.sol).

use alloy::primitives::Uint;

/// Trait to associate bit math functions with [`Uint`] types.
pub trait BitMath {
    #[must_use]
    fn most_significant_bit(self) -> usize;
    #[must_use]
    fn least_significant_bit(self) -> usize;
}

impl<const BITS: usize, const LIMBS: usize> BitMath for Uint<BITS, LIMBS> {
    #[inline]
    fn most_significant_bit(self) -> usize {
        most_significant_bit(self)
    }

    #[inline]
    fn least_significant_bit(self) -> usize {
        least_significant_bit(self)
    }
}

/// Returns the index of the most significant bit in a given [`Uint`].
///
/// ## Panics
///
/// Panics if the input is zero.
#[inline]
#[must_use]
pub fn most_significant_bit<const BITS: usize, const LIMBS: usize>(x: Uint<BITS, LIMBS>) -> usize {
    BITS - 1 - x.leading_zeros()
}

/// Returns the index of the least significant bit in a given [`Uint`].
#[inline]
#[must_use]
pub fn least_significant_bit<const BITS: usize, const LIMBS: usize>(x: Uint<BITS, LIMBS>) -> usize {
    x.trailing_zeros()
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloy::primitives::{uint, U256};

    const ONE: U256 = uint!(1_U256);

    #[test]
    #[should_panic(expected = "overflow")]
    fn most_significant_bit_throws_for_zero() {
        let _ = most_significant_bit(U256::ZERO);
    }

    #[test]
    fn test_most_significant_bit() {
        for i in 0..=255 {
            let x = ONE << i;
            assert_eq!(most_significant_bit(x), i);
        }
        for i in 1..=255 {
            let x = (ONE << i) - ONE;
            assert_eq!(most_significant_bit(x), i - 1);
        }
        assert_eq!(most_significant_bit(U256::MAX), 255);
    }

    #[test]
    fn test_least_significant_bit() {
        for i in 0..=255 {
            let x = ONE << i;
            assert_eq!(least_significant_bit(x), i);
        }
        for i in 1..=255 {
            let x = (ONE << i) - ONE;
            assert_eq!(least_significant_bit(x), 0);
        }
        assert_eq!(least_significant_bit(U256::MAX), 0);
    }
}