Merge pull request #9 from CetusProtocol/unit-tests

Unit tests

Author: CetusProtocol

.gitignore

@@ -7,3 +7,5 @@
 /build
 /.idea
 /.aptos
+/sui/.coverage_map.mvcov
+/sui/.trace

sui/Move.toml

@@ -4,6 +4,7 @@
 name = "IntegerMate"
 version = "1.2.0"
 published-at = "0xf1e4fae2183dabebc4827b0a46ddae9c0d0a6afa06a416e1f887a4ffd33f5067"
+edition = "2024"
 
 [dependencies]
 Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "mainnet-v1.48.2" }

sui/migration.patch

@@ -0,0 +1,40 @@
+--- ./sources/i128.move
++++ ./sources/i128.move
+@@ -14 +14 @@
+-    struct I128 has copy, drop, store {
++    public struct I128 has copy, drop, store {
+@@ -53,2 +53,2 @@
+-        let sum = num1.bits ^ num2.bits;
+-        let carry = (num1.bits & num2.bits) << 1;
++        let mut sum = num1.bits ^ num2.bits;
++        let mut carry = (num1.bits & num2.bits) << 1;
+--- ./sources/i32.move
++++ ./sources/i32.move
+@@ -11 +11 @@
+-    struct I32 has copy, drop, store {
++    public struct I32 has copy, drop, store {
+@@ -48,2 +48,2 @@
+-        let sum = num1.bits ^ num2.bits;
+-        let carry = (num1.bits & num2.bits) << 1;
++        let mut sum = num1.bits ^ num2.bits;
++        let mut carry = (num1.bits & num2.bits) << 1;
+--- ./sources/i64.move
++++ ./sources/i64.move
+@@ -11 +11 @@
+-    struct I64 has copy, drop, store {
++    public struct I64 has copy, drop, store {
+@@ -48,2 +48,2 @@
+-        let sum = num1.bits ^ num2.bits;
+-        let carry = (num1.bits & num2.bits) << 1;
++        let mut sum = num1.bits ^ num2.bits;
++        let mut carry = (num1.bits & num2.bits) << 1;
+--- ./tests/i32_tests.move
++++ ./tests/i32_tests.move
+@@ -733 +733 @@
+-        let i = mod(neg_from(2), from(5));
++        let mut i = mod(neg_from(2), from(5));
+--- ./tests/i64_tests.move
++++ ./tests/i64_tests.move
+@@ -622 +622 @@
+-        let i = mod(neg_from(2), from(5));
++        let mut i = mod(neg_from(2), from(5));

sui/sources/full_math_u128.move

@@ -19,6 +19,12 @@ module integer_mate::full_math_u128 {
         (product as u128)
     }
 
+
+    #[
+        deprecated(
+            note = b"This function converts num1 and num2 to u256, multiplies them, then left-shifts the result by the specified number of bits, and finally coerces the result into u128. The left shift does not perform overflow checks, so it is recommended not to use this function to avoid unexpected results.",
+        ),
+    ]
     public fun mul_shl(num1: u128, num2: u128, shift: u8): u128 {
         let product = full_mul(num1, num2) << shift;
         (product as u128)

sui/sources/full_math_u64.move

@@ -19,6 +19,11 @@ module integer_mate::full_math_u64 {
         (r as u64)
     }
 
+    #[
+        deprecated(
+            note = b"This function converts num1 and num2 to u128, multiplies them, then left-shifts the result by the specified number of bits, and finally coerces the result into u64. The left shift does not perform overflow checks, so it is recommended not to use this function to avoid unexpected results.",
+        ),
+    ]
     public fun mul_shl(num1: u64, num2: u64, shift: u8): u64 {
         let r = full_mul(num1, num2) << shift;
         (r as u64)