feat(hermes): Add utilities for regex sorting and integer macc operations (#506)

* feat(hermes): Add utilities for regex sorting and integer macc operations

* fix(hermes): fix format

Author: stevenj

.config/dictionaries/project.dic

@@ -16,6 +16,7 @@ bootstrapper
 BROTLI
 cantopen
 cardano
+catfact
 cbor
 cbork
 cdylib
@@ -47,6 +48,7 @@ dockerhub
 dotenv
 dotenvy
 dotglob
+DOTSTAR
 drep
 dreps
 Earthfile
@@ -94,6 +96,7 @@ jorm
 jormungandr
 Jörmungandr
 jsonschema
+justfile
 lcov
 Leshiy
 libipld
@@ -150,12 +153,13 @@ preopen
 preopened
 preopens
 preprod
+projectcatalyst
 psql
 pubk
 pubkey
 pubspec
 pwrite
-rustls
+QMARK
 qpsg
 quic
 rafal
@@ -165,8 +169,8 @@ redoc
 reloc
 REMOVEDIR
 renameat
-retriggering
 reqwest
+retriggering
 rngs
 rulelist
 rulename
@@ -176,9 +180,11 @@ rustdocflags
 rustflags
 rustfmt
 rustls
+rustup
 rustyline
 saibatizoku
 sandboxed
+sandboxing
 scanorder
 scanstatus
 Sched
@@ -207,6 +213,7 @@ tinygo
 toobig
 toolsets
 Traceback
+tweakable
 txns
 typenum
 unfinalized
@@ -231,10 +238,3 @@ xpub
 yamux
 yoroi
 zstack
-reqwest
-projectcatalyst
-yamux
-justfile
-sandboxing
-catfact
-rustup

hermes/Cargo.lock

@@ -34,6 +34,7 @@ path = "tests/integration/tests/mod.rs"
 hermes-ipfs = { version = "0.0.5", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "hermes-ipfs/v0.0.5" }
 cardano-blockchain-types = { version = "0.0.5", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "cardano-blockchain-types-v0.0.5" }
 cardano-chain-follower = { version = "0.0.11", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "cardano-chain-follower-v0.0.11" }
+catalyst-types = { version = "0.0.6", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "catalyst-types-v0.0.6" }
 
 # HDF5 is consumed using a git tag, because the latest release is very old, but the code is much more advanced.
 hdf5 = { package = "hdf5-metno", version = "0.10.1", features = [ "static", "blosc", "blosc-zstd" ] }
@@ -92,6 +93,7 @@ usvg = "0.45.1"
 uuid = { version = "1.17.0", features = ["v4"] }
 reqwest = "0.12.22"
 url = "2.5.4"
+num-traits = "0.2.19"
 
 [build-dependencies]
 build-info-build = "0.0.41"

hermes/bin/Cargo.toml

@@ -1,3 +1,5 @@
 //! Hermes runtime extensions utilities.
 
 pub(crate) mod conversion;
+pub(crate) mod mul_add;
+pub(crate) mod regex_ranking;

hermes/bin/src/runtime_extensions/utils/mod.rs

@@ -0,0 +1,97 @@
+//! Signed Integer Multiply and
+
+use catalyst_types::conversion::from_saturating;
+
+/// A trait providing a saturating multiply-accumulate:
+///
+/// `self + (y * z)` with saturating arithmetic, updating `Self`.
+///
+/// `self` is the Accumulator, and can be any integer but will saturate at max i128 if
+/// its a `u128` or larger.  Otherwise it will saturate within the bounds of its type.
+///
+/// `y` and `z` can be any integer type.
+///
+/// Works across any combination of integer types (signed or unsigned).
+pub trait SaturatingMulAdd<U, V> {
+    /// Multiply and Accumulate Integers.
+    fn mul_add(
+        &mut self,
+        y: U,
+        z: V,
+    );
+}
+
+/// Implement the trait for various integer types.
+macro_rules! impl_saturating_mul_add {
+    ($($t:ty),*) => {
+        $(
+            impl<U, V> SaturatingMulAdd<U, V> for $t
+            where
+                U: Copy
+                    + TryInto<i128>
+                    + std::ops::Sub<Output = U>
+                    + std::cmp::PartialOrd<U>
+                    + num_traits::identities::Zero,
+                V: Copy
+                    + TryInto<i128>
+                    + std::ops::Sub<Output = V>
+                    + std::cmp::PartialOrd<V>
+                    + num_traits::identities::Zero,
+            {
+                fn mul_add(&mut self, y: U, z: V) {
+                    let self128: i128 = from_saturating(*self);
+                    let y128:i128 = from_saturating(y);
+                    let z128:i128 = from_saturating(z);
+
+                    *self = from_saturating(z128.saturating_mul(y128).saturating_add(self128));
+                }
+            }
+        )*
+    };
+}
+
+// Implement for all signed integer types
+impl_saturating_mul_add!(i8, i16, i32, i64, i128, isize);
+// Implement for all unsigned integer types
+impl_saturating_mul_add!(u8, u16, u32, u64, usize);
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn i32_u64_i8() {
+        let mut s: i32 = 5;
+        let y: u128 = 10;
+        let z: i8 = -3;
+        s.mul_add(y, z);
+        assert_eq!(s, -25);
+    }
+
+    #[test]
+    fn u8_i64_u128_pos() {
+        let mut s: u8 = 5;
+        let y: i64 = 10000;
+        let z: u128 = 1_234_567;
+        s.mul_add(y, z);
+        assert_eq!(s, 255);
+    }
+
+    #[test]
+    fn u8_i64_u128_neg() {
+        let mut s: u8 = 5;
+        let y: i64 = -10000;
+        let z: u128 = 1_234_567;
+        s.mul_add(y, z);
+        assert_eq!(s, 0);
+    }
+
+    #[test]
+    fn i16_i64_u128_neg() {
+        let mut s: i16 = 5;
+        let y: i64 = -10000;
+        let z: u128 = 1_234_567;
+        s.mul_add(y, z);
+        assert_eq!(s, -32768);
+    }
+}