@aptos-labs/ts-sdk 2.0.1 → 3.0.0

package/src/internal/move/jwks/build/jwk/sources/dependencies/AptosStdlib/fixed_point64.move

@@ -1,447 +0,0 @@
-/// Defines a fixed-point numeric type with a 64-bit integer part and
-/// a 64-bit fractional part.
-
-module aptos_std::fixed_point64 {
-
-    /// Define a fixed-point numeric type with 64 fractional bits.
-    /// This is just a u128 integer but it is wrapped in a struct to
-    /// make a unique type. This is a binary representation, so decimal
-    /// values may not be exactly representable, but it provides more
-    /// than 9 decimal digits of precision both before and after the
-    /// decimal point (18 digits total). For comparison, double precision
-    /// floating-point has less than 16 decimal digits of precision, so
-    /// be careful about using floating-point to convert these values to
-    /// decimal.
-    struct FixedPoint64 has copy, drop, store { value: u128 }
-
-    const MAX_U128: u256 = 340282366920938463463374607431768211455;
-
-    /// The denominator provided was zero
-    const EDENOMINATOR: u64 = 0x10001;
-    /// The quotient value would be too large to be held in a `u128`
-    const EDIVISION: u64 = 0x20002;
-    /// The multiplied value would be too large to be held in a `u128`
-    const EMULTIPLICATION: u64 = 0x20003;
-    /// A division by zero was encountered
-    const EDIVISION_BY_ZERO: u64 = 0x10004;
-    /// The computed ratio when converting to a `FixedPoint64` would be unrepresentable
-    const ERATIO_OUT_OF_RANGE: u64 = 0x20005;
-    /// Abort code on calculation result is negative.
-    const ENEGATIVE_RESULT: u64 = 0x10006;
-
-    /// Returns self - y. self must be not less than y.
-    public fun sub(self: FixedPoint64, y: FixedPoint64): FixedPoint64 {
-        let x_raw = get_raw_value(self);
-        let y_raw = get_raw_value(y);
-        assert!(x_raw >= y_raw, ENEGATIVE_RESULT);
-        create_from_raw_value(x_raw - y_raw)
-    }
-    spec sub {
-        pragma opaque;
-        aborts_if self.value < y.value with ENEGATIVE_RESULT;
-        ensures result.value == self.value - y.value;
-    }
-
-    /// Returns self + y. The result cannot be greater than MAX_U128.
-    public fun add(self: FixedPoint64, y: FixedPoint64): FixedPoint64 {
-        let x_raw = get_raw_value(self);
-        let y_raw = get_raw_value(y);
-        let result = (x_raw as u256) + (y_raw as u256);
-        assert!(result <= MAX_U128, ERATIO_OUT_OF_RANGE);
-        create_from_raw_value((result as u128))
-    }
-    spec add {
-        pragma opaque;
-        aborts_if (self.value as u256) + (y.value as u256) > MAX_U128 with ERATIO_OUT_OF_RANGE;
-        ensures result.value == self.value + y.value;
-    }
-
-    /// Multiply a u128 integer by a fixed-point number, truncating any
-    /// fractional part of the product. This will abort if the product
-    /// overflows.
-    public fun multiply_u128(val: u128, multiplier: FixedPoint64): u128 {
-        // The product of two 128 bit values has 256 bits, so perform the
-        // multiplication with u256 types and keep the full 256 bit product
-        // to avoid losing accuracy.
-        let unscaled_product = (val as u256) * (multiplier.value as u256);
-        // The unscaled product has 64 fractional bits (from the multiplier)
-        // so rescale it by shifting away the low bits.
-        let product = unscaled_product >> 64;
-        // Check whether the value is too large.
-        assert!(product <= MAX_U128, EMULTIPLICATION);
-        (product as u128)
-    }
-    spec multiply_u128 {
-        pragma opaque;
-        include MultiplyAbortsIf;
-        ensures result == spec_multiply_u128(val, multiplier);
-    }
-    spec schema MultiplyAbortsIf {
-        val: num;
-        multiplier: FixedPoint64;
-        aborts_if spec_multiply_u128(val, multiplier) > MAX_U128 with EMULTIPLICATION;
-    }
-    spec fun spec_multiply_u128(val: num, multiplier: FixedPoint64): num {
-        (val * multiplier.value) >> 64
-    }
-
-    /// Divide a u128 integer by a fixed-point number, truncating any
-    /// fractional part of the quotient. This will abort if the divisor
-    /// is zero or if the quotient overflows.
-    public fun divide_u128(val: u128, divisor: FixedPoint64): u128 {
-        // Check for division by zero.
-        assert!(divisor.value != 0, EDIVISION_BY_ZERO);
-        // First convert to 256 bits and then shift left to
-        // add 64 fractional zero bits to the dividend.
-        let scaled_value = (val as u256) << 64;
-        let quotient = scaled_value / (divisor.value as u256);
-        // Check whether the value is too large.
-        assert!(quotient <= MAX_U128, EDIVISION);
-        // the value may be too large, which will cause the cast to fail
-        // with an arithmetic error.
-        (quotient as u128)
-    }
-    spec divide_u128 {
-        pragma opaque;
-        include DivideAbortsIf;
-        ensures result == spec_divide_u128(val, divisor);
-    }
-    spec schema DivideAbortsIf {
-        val: num;
-        divisor: FixedPoint64;
-        aborts_if divisor.value == 0 with EDIVISION_BY_ZERO;
-        aborts_if spec_divide_u128(val, divisor) > MAX_U128 with EDIVISION;
-    }
-    spec fun spec_divide_u128(val: num, divisor: FixedPoint64): num {
-        (val << 64) / divisor.value
-    }
-
-    /// Create a fixed-point value from a rational number specified by its
-    /// numerator and denominator. Calling this function should be preferred
-    /// for using `Self::create_from_raw_value` which is also available.
-    /// This will abort if the denominator is zero. It will also
-    /// abort if the numerator is nonzero and the ratio is not in the range
-    /// 2^-64 .. 2^64-1. When specifying decimal fractions, be careful about
-    /// rounding errors: if you round to display N digits after the decimal
-    /// point, you can use a denominator of 10^N to avoid numbers where the
-    /// very small imprecision in the binary representation could change the
-    /// rounding, e.g., 0.0125 will round down to 0.012 instead of up to 0.013.
-    public fun create_from_rational(numerator: u128, denominator: u128): FixedPoint64 {
-        // If the denominator is zero, this will abort.
-        // Scale the numerator to have 64 fractional bits, so that the quotient will have 64
-        // fractional bits.
-        let scaled_numerator = (numerator as u256) << 64;
-        assert!(denominator != 0, EDENOMINATOR);
-        let quotient = scaled_numerator / (denominator as u256);
-        assert!(quotient != 0 || numerator == 0, ERATIO_OUT_OF_RANGE);
-        // Return the quotient as a fixed-point number. We first need to check whether the cast
-        // can succeed.
-        assert!(quotient <= MAX_U128, ERATIO_OUT_OF_RANGE);
-        FixedPoint64 { value: (quotient as u128) }
-    }
-    spec create_from_rational {
-        pragma opaque;
-        pragma verify_duration_estimate = 1000; // TODO: set because of timeout (property proved).
-        include CreateFromRationalAbortsIf;
-        ensures result == spec_create_from_rational(numerator, denominator);
-    }
-    spec schema CreateFromRationalAbortsIf {
-        numerator: u128;
-        denominator: u128;
-        let scaled_numerator = (numerator as u256)<< 64;
-        let scaled_denominator = (denominator as u256);
-        let quotient = scaled_numerator / scaled_denominator;
-        aborts_if scaled_denominator == 0 with EDENOMINATOR;
-        aborts_if quotient == 0 && scaled_numerator != 0 with ERATIO_OUT_OF_RANGE;
-        aborts_if quotient > MAX_U128 with ERATIO_OUT_OF_RANGE;
-    }
-    spec fun spec_create_from_rational(numerator: num, denominator: num): FixedPoint64 {
-        FixedPoint64{value: (numerator << 128) / (denominator << 64)}
-    }
-
-    /// Create a fixedpoint value from a raw value.
-    public fun create_from_raw_value(value: u128): FixedPoint64 {
-        FixedPoint64 { value }
-    }
-    spec create_from_raw_value {
-        pragma opaque;
-        aborts_if false;
-        ensures result.value == value;
-    }
-
-    /// Accessor for the raw u128 value. Other less common operations, such as
-    /// adding or subtracting FixedPoint64 values, can be done using the raw
-    /// values directly.
-    public fun get_raw_value(self: FixedPoint64): u128 {
-        self.value
-    }
-
-    /// Returns true if the ratio is zero.
-    public fun is_zero(self: FixedPoint64): bool {
-        self.value == 0
-    }
-
-    /// Returns the smaller of the two FixedPoint64 numbers.
-    public fun min(num1: FixedPoint64, num2: FixedPoint64): FixedPoint64 {
-        if (num1.value < num2.value) {
-            num1
-        } else {
-            num2
-        }
-    }
-    spec min {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_min(num1, num2);
-    }
-    spec fun spec_min(num1: FixedPoint64, num2: FixedPoint64): FixedPoint64 {
-        if (num1.value < num2.value) {
-            num1
-        } else {
-            num2
-        }
-    }
-
-    /// Returns the larger of the two FixedPoint64 numbers.
-    public fun max(num1: FixedPoint64, num2: FixedPoint64): FixedPoint64 {
-        if (num1.value > num2.value) {
-            num1
-        } else {
-            num2
-        }
-    }
-    spec max {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_max(num1, num2);
-    }
-    spec fun spec_max(num1: FixedPoint64, num2: FixedPoint64): FixedPoint64 {
-        if (num1.value > num2.value) {
-            num1
-        } else {
-            num2
-        }
-    }
-
-    /// Returns true if self <= num2
-    public fun less_or_equal(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value <= num2.value
-    }
-    spec less_or_equal {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_less_or_equal(self, num2);
-    }
-    spec fun spec_less_or_equal(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value <= num2.value
-    }
-
-    /// Returns true if self < num2
-    public fun less(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value < num2.value
-    }
-    spec less {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_less(self, num2);
-    }
-    spec fun spec_less(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value < num2.value
-    }
-
-    /// Returns true if self >= num2
-    public fun greater_or_equal(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value >= num2.value
-    }
-    spec greater_or_equal {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_greater_or_equal(self, num2);
-    }
-    spec fun spec_greater_or_equal(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value >= num2.value
-    }
-
-    /// Returns true if self > num2
-    public fun greater(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value > num2.value
-    }
-    spec greater {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_greater(self, num2);
-    }
-    spec fun spec_greater(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value > num2.value
-    }
-
-    /// Returns true if self = num2
-    public fun equal(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value == num2.value
-    }
-    spec equal {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_equal(self, num2);
-    }
-    spec fun spec_equal(self: FixedPoint64, num2: FixedPoint64): bool {
-        self.value == num2.value
-    }
-
-    /// Returns true if self almost equals to num2, which means abs(num1-num2) <= precision
-    public fun almost_equal(self: FixedPoint64, num2: FixedPoint64, precision: FixedPoint64): bool {
-        if (self.value > num2.value) {
-            (self.value - num2.value <= precision.value)
-        } else {
-            (num2.value - self.value <= precision.value)
-        }
-    }
-    spec almost_equal {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_almost_equal(self, num2, precision);
-    }
-    spec fun spec_almost_equal(self: FixedPoint64, num2: FixedPoint64, precision: FixedPoint64): bool {
-        if (self.value > num2.value) {
-            (self.value - num2.value <= precision.value)
-        } else {
-            (num2.value - self.value <= precision.value)
-        }
-    }
-    /// Create a fixedpoint value from a u128 value.
-    public fun create_from_u128(val: u128): FixedPoint64 {
-        let value = (val as u256) << 64;
-        assert!(value <= MAX_U128, ERATIO_OUT_OF_RANGE);
-        FixedPoint64 {value: (value as u128)}
-    }
-    spec create_from_u128 {
-        pragma opaque;
-        include CreateFromU64AbortsIf;
-        ensures result == spec_create_from_u128(val);
-    }
-    spec schema CreateFromU64AbortsIf {
-        val: num;
-        let scaled_value = (val as u256) << 64;
-        aborts_if scaled_value > MAX_U128;
-    }
-    spec fun spec_create_from_u128(val: num): FixedPoint64 {
-        FixedPoint64 {value: val << 64}
-    }
-
-    /// Returns the largest integer less than or equal to a given number.
-    public fun floor(self: FixedPoint64): u128 {
-        self.value >> 64
-    }
-    spec floor {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_floor(self);
-    }
-    spec fun spec_floor(self: FixedPoint64): u128 {
-        let fractional = self.value % (1 << 64);
-        if (fractional == 0) {
-            self.value >> 64
-        } else {
-            (self.value - fractional) >> 64
-        }
-    }
-
-    /// Rounds up the given FixedPoint64 to the next largest integer.
-    public fun ceil(self: FixedPoint64): u128 {
-        let floored_num = floor(self) << 64;
-        if (self.value == floored_num) {
-            return floored_num >> 64
-        };
-        let val = ((floored_num as u256) + (1 << 64));
-        (val >> 64 as u128)
-    }
-    spec ceil {
-        // TODO: set because of timeout (property proved).
-        pragma verify_duration_estimate = 1000;
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_ceil(self);
-    }
-    spec fun spec_ceil(self: FixedPoint64): u128 {
-        let fractional = self.value % (1 << 64);
-        let one = 1 << 64;
-        if (fractional == 0) {
-            self.value >> 64
-        } else {
-            (self.value - fractional + one) >> 64
-        }
-    }
-
-    /// Returns the value of a FixedPoint64 to the nearest integer.
-    public fun round(self: FixedPoint64): u128 {
-        let floored_num = floor(self) << 64;
-        let boundary = floored_num + ((1 << 64) / 2);
-        if (self.value < boundary) {
-            floored_num >> 64
-        } else {
-            ceil(self)
-        }
-    }
-    spec round {
-        pragma opaque;
-        aborts_if false;
-        ensures result == spec_round(self);
-    }
-    spec fun spec_round(self: FixedPoint64): u128 {
-        let fractional = self.value % (1 << 64);
-        let boundary = (1 << 64) / 2;
-        let one = 1 << 64;
-        if (fractional < boundary) {
-            (self.value - fractional) >> 64
-        } else {
-            (self.value - fractional + one) >> 64
-        }
-    }
-
-    // **************** SPECIFICATIONS ****************
-
-    spec module {} // switch documentation context to module level
-
-    spec module {
-        pragma aborts_if_is_strict;
-    }
-
-    #[test]
-    public entry fun test_sub() {
-        let x = create_from_rational(9, 7);
-        let y = create_from_rational(1, 3);
-        let result = sub(x, y);
-        // 9/7 - 1/3 = 20/21
-        let expected_result = create_from_rational(20, 21);
-        assert_approx_the_same((get_raw_value(result) as u256), (get_raw_value(expected_result) as u256), 16);
-    }
-
-    #[test]
-    #[expected_failure(abort_code = 0x10006, location = Self)]
-    public entry fun test_sub_should_abort() {
-        let x = create_from_rational(1, 3);
-        let y = create_from_rational(9, 7);
-        let _ = sub(x, y);
-    }
-
-    #[test_only]
-    /// For functions that approximate a value it's useful to test a value is close
-    /// to the most correct value up to last digit
-    fun assert_approx_the_same(x: u256, y: u256, precission: u128) {
-        if (x < y) {
-            let tmp = x;
-            x = y;
-            y = tmp;
-        };
-        let mult = 1u256;
-        let n = 10u256;
-        while (precission > 0) {
-            if (precission % 2 == 1) {
-                mult = mult * n;
-            };
-            precission = precission / 2;
-            n = n * n;
-        };
-        assert!((x - y) * mult < x, 0);
-    }
-}

package/src/internal/move/jwks/build/jwk/sources/dependencies/AptosStdlib/from_bcs.move

@@ -1,91 +0,0 @@
-/// This module provides a number of functions to convert _primitive_ types from their representation in `std::bcs`
-/// to values. This is the opposite of `bcs::to_bytes`. Note that it is not safe to define a generic public `from_bytes`
-/// function because this can violate implicit struct invariants, therefore only primitive types are offerred. If
-/// a general conversion back-and-force is needed, consider the `aptos_std::Any` type which preserves invariants.
-///
-/// Example:
-/// ```
-/// use std::bcs;
-/// use aptos_std::from_bcs;
-///
-/// assert!(from_bcs::to_address(bcs::to_bytes(&@0xabcdef)) == @0xabcdef, 0);
-/// ```
-module aptos_std::from_bcs {
-    use std::string::{Self, String};
-
-    /// UTF8 check failed in conversion from bytes to string
-    const EINVALID_UTF8: u64 = 0x1;
-
-    public fun to_bool(v: vector<u8>): bool {
-        from_bytes<bool>(v)
-    }
-
-    public fun to_u8(v: vector<u8>): u8 {
-        from_bytes<u8>(v)
-    }
-
-    public fun to_u16(v: vector<u8>): u16 {
-        from_bytes<u16>(v)
-    }
-
-    public fun to_u32(v: vector<u8>): u32 {
-        from_bytes<u32>(v)
-    }
-
-    public fun to_u64(v: vector<u8>): u64 {
-        from_bytes<u64>(v)
-    }
-
-    public fun to_u128(v: vector<u8>): u128 {
-        from_bytes<u128>(v)
-    }
-
-    public fun to_u256(v: vector<u8>): u256 {
-        from_bytes<u256>(v)
-    }
-
-    public fun to_address(v: vector<u8>): address {
-        from_bytes<address>(v)
-    }
-
-    public fun to_bytes(v: vector<u8>): vector<u8> {
-        from_bytes<vector<u8>>(v)
-    }
-
-    public fun to_string(v: vector<u8>): String {
-        // To make this safe, we need to evaluate the utf8 invariant.
-        let s = from_bytes<String>(v);
-        assert!(string::internal_check_utf8(string::bytes(&s)), EINVALID_UTF8);
-        s
-    }
-
-    /// Package private native function to deserialize a type T.
-    ///
-    /// Note that this function does not put any constraint on `T`. If code uses this function to
-    /// deserialize a linear value, its their responsibility that the data they deserialize is
-    /// owned.
-    public(friend) native fun from_bytes<T>(bytes: vector<u8>): T;
-    friend aptos_std::any;
-    friend aptos_std::copyable_any;
-
-
-    #[test_only]
-    use std::bcs;
-
-    #[test]
-    fun test_address() {
-        let addr = @0x01;
-        let addr_vec = x"0000000000000000000000000000000000000000000000000000000000000001";
-        let addr_out = to_address(addr_vec);
-        let addr_vec_out = bcs::to_bytes(&addr_out);
-        assert!(addr == addr_out, 0);
-        assert!(addr_vec == addr_vec_out, 1);
-    }
-
-    #[test]
-    #[expected_failure(abort_code = 0x10001, location = Self)]
-    fun test_address_fail() {
-        let bad_vec = b"01";
-        to_address(bad_vec);
-    }
-}