aurora-evm 2.2.1

Aurora Ethereum Virtual Machine implementation written in pure Rust
Documentation
use crate::core::utils::I256;
use crate::utils::{U256_ONE, U256_VALUE_32, U256_ZERO};
use core::convert::TryInto;
use core::ops::Rem;
use primitive_types::{U256, U512};

#[inline]
pub fn div(op1: U256, op2: U256) -> U256 {
    if op2 == U256_ZERO {
        U256_ZERO
    } else {
        op1 / op2
    }
}

#[inline]
pub fn sdiv(op1: U256, op2: U256) -> U256 {
    let op1: I256 = op1.into();
    let op2: I256 = op2.into();
    let ret = op1 / op2;
    ret.into()
}

#[inline]
pub fn rem(op1: U256, op2: U256) -> U256 {
    if op2 == U256_ZERO {
        U256_ZERO
    } else {
        op1.rem(op2)
    }
}

#[inline]
pub fn srem(op1: U256, op2: U256) -> U256 {
    if op2 == U256_ZERO {
        U256_ZERO
    } else {
        let op1: I256 = op1.into();
        let op2: I256 = op2.into();
        let ret = op1.rem(op2);
        ret.into()
    }
}

#[inline]
pub fn addmod(op1: U256, op2: U256, op3: U256) -> U256 {
    let op1: U512 = op1.into();
    let op2: U512 = op2.into();
    let op3: U512 = op3.into();

    if op3 == U512::zero() {
        U256_ZERO
    } else {
        let v = (op1 + op2) % op3;
        v.try_into().expect("ADDMOD_OP3_OVERFLOW")
    }
}

#[inline]
pub fn mulmod(op1: U256, op2: U256, op3: U256) -> U256 {
    let op1: U512 = op1.into();
    let op2: U512 = op2.into();
    let op3: U512 = op3.into();

    if op3 == U512::zero() {
        U256_ZERO
    } else {
        let v = (op1 * op2) % op3;
        v.try_into().expect("MULMOD_OP3_OVERFLOW")
    }
}

#[inline]
pub fn exp(op1: U256, op2: U256) -> U256 {
    let mut op1 = op1;
    let mut op2 = op2;
    let mut r: U256 = 1.into();

    while op2 != U256_ZERO {
        if op2 & U256_ONE != U256_ZERO {
            r = r.overflowing_mul(op1).0;
        }
        op2 >>= 1;
        op1 = op1.overflowing_mul(op1).0;
    }

    r
}

/// In the yellow paper `SIGNEXTEND` is defined to take two inputs, we will call them
/// `x` and `y`, and produce one output. The first `t` bits of the output (numbering from the
/// left, starting from 0) are equal to the `t`-th bit of `y`, where `t` is equal to
/// `256 - 8(x + 1)`. The remaining bits of the output are equal to the corresponding bits of `y`.
/// Note: if `x >= 32` then the output is equal to `y` since `t <= 0`. To efficiently implement
/// this algorithm in the case `x < 32` we do the following. Let `b` be equal to the `t`-th bit
/// of `y` and let `s = 255 - t = 8x + 7` (this is effectively the same index as `t`, but
/// numbering the bits from the right instead of the left). We can create a bit mask which is all
/// zeros up to and including the `t`-th bit, and all ones afterwards by computing the quantity
/// `2^s - 1`. We can use this mask to compute the output depending on the value of `b`.
/// If `b == 1` then the yellow paper says the output should be all ones up to
/// and including the `t`-th bit, followed by the remaining bits of `y`; this is equal to
/// `y | !mask` where `|` is the bitwise `OR` and `!` is bitwise negation. Similarly, if
/// `b == 0` then the yellow paper says the output should start with all zeros, then end with
/// bits from `b`; this is equal to `y & mask` where `&` is bitwise `AND`.
#[inline]
pub fn signextend(op1: U256, op2: U256) -> U256 {
    if op1 < U256_VALUE_32 {
        // `low_u32` works since op1 < 32
        #[allow(clippy::as_conversions)]
        let bit_index = (8 * op1.low_u32() + 7) as usize;
        let bit = op2.bit(bit_index);
        let mask = (U256_ONE << bit_index) - U256_ONE;
        if bit {
            op2 | !mask
        } else {
            op2 & mask
        }
    } else {
        op2
    }
}

#[cfg(test)]
mod tests {
    use super::{signextend, U256};
    use crate::utils::{U256_ONE, U256_VALUE_32, U256_ZERO};

    /// Test to ensure new (optimized) `signextend` implementation is equivalent to the previous
    /// implementation.
    #[test]
    fn test_signextend() {
        let test_values = vec![
            U256_ZERO,
            U256_ONE,
            U256::from(8),
            U256::from(10),
            U256::from(65),
            U256::from(100),
            U256::from(128),
            U256::from(11) * (U256_ONE << 65),
            U256::from(7) * (U256_ONE << 123),
            U256::MAX / 167,
            U256::MAX,
        ];
        for x in 0..64 {
            for y in &test_values {
                compare_old_signextend(x.into(), *y);
            }
        }
    }

    fn compare_old_signextend(x: U256, y: U256) {
        let old = old_signextend(x, y);
        let new = signextend(x, y);

        assert_eq!(old, new);
    }

    fn old_signextend(op1: U256, op2: U256) -> U256 {
        if op1 > U256_VALUE_32 {
            op2
        } else {
            let mut ret = U256_ZERO;
            let len: usize = op1.as_usize();
            let t: usize = 8 * (len + 1) - 1;
            let t_bit_mask = U256_ONE << t;
            let t_value = (op2 & t_bit_mask) >> t;
            for i in 0..256 {
                let bit_mask = U256_ONE << i;
                let i_value = (op2 & bit_mask) >> i;
                if i <= t {
                    ret = ret.overflowing_add(i_value << i).0;
                } else {
                    ret = ret.overflowing_add(t_value << i).0;
                }
            }
            ret
        }
    }
}