feat(starkex_handler): Fixed starkex implementation & added tests

Author: akhercha

pragma-node/src/handlers/entries/subscribe_to_entry.rs

@@ -21,7 +21,9 @@ use crate::AppState;
 
 use super::{AssetOraclePrice, SignedPublisherPrice};
 
-const PRAGMA_ORACLE_NAME: &str = "PRAGMA";
+/// "PRAGMA" to number is bigger than 2**40 - we alias it to "PRGM" to fit in 40 bits.
+/// Needed for StarkEx signature.
+const PRAGMA_ORACLE_NAME: &str = "PRGM";
 const CHANNEL_UPDATE_INTERVAL_IN_MS: u64 = 500;
 
 #[derive(Default, Debug, Serialize, Deserialize)]

pragma-node/src/utils/starkex.rs

@@ -17,15 +17,15 @@ pub fn get_external_asset_id(oracle_name: &str, pair_id: &str) -> Result<String,
     let pair_id = cairo_short_string_to_felt(pair_id).map_err(|_| HashError::ConversionError)?;
     let pair_id: u128 = pair_id.try_into().map_err(|_| HashError::ConversionError)?;
     let pair_as_hex = format!("{:0<width$x}", pair_id, width = 32);
-    Ok(format!("{}{}", pair_as_hex, oracle_as_hex))
+    Ok(format!("0x{}{}", pair_as_hex, oracle_as_hex))
 }
 
 /// Builds the second number for the hash computation based on timestamp and price.
 fn build_second_number(timestamp: u128, price: &BigDecimal) -> Result<FieldElement, HashError> {
     let price = price.to_u128().ok_or(HashError::ConversionError)?;
     let price_as_hex = format!("{:x}", price);
     let timestamp_as_hex = format!("{:x}", timestamp);
-    let v = format!("{}{}", price_as_hex, timestamp_as_hex);
+    let v = format!("0x{}{}", price_as_hex, timestamp_as_hex);
     FieldElement::from_hex_be(&v).map_err(|_| HashError::ConversionError)
 }
 
@@ -51,7 +51,8 @@ pub fn get_entry_hash(
     timestamp: u64,
     price: &BigDecimal,
 ) -> Result<FieldElement, HashError> {
-    let external_asset_id = get_external_asset_id(oracle_name, pair_id)?;
+    let pair_id = pair_id.replace('/', ""); // Remove the "/" from the pair_id if it exists
+    let external_asset_id = get_external_asset_id(oracle_name, &pair_id)?;
     let first_number =
         FieldElement::from_hex_be(&external_asset_id).map_err(|_| HashError::ConversionError)?;
     let second_number = build_second_number(timestamp as u128, price)?;
@@ -65,27 +66,44 @@ mod tests {
     use super::*;
     use bigdecimal::BigDecimal;
 
-    // Example from:
-    // https://docs.starkware.co/starkex/perpetual/becoming-an-oracle-provider-for-starkex.html#signing_prices
-    #[test]
-    fn test_get_entry_hash_with_example() {
-        // 1. Setup
-        let oracle_name = "Maker";
-        let asset = "BTCUSD";
-        let price = BigDecimal::from_str("11512340000000000000000").unwrap();
-        let timestamp = 1577836800_u64;
+    // Test case structure - ((oracle_name, pair_id, price, timestamp), expected_hash)
+    type TestCase<'a> = ((&'a str, &'a str, &'a str, u64), &'a str);
 
-        // 2. Action
-        let hashed_data =
-            get_entry_hash(oracle_name, asset, timestamp, &price).expect("Could not build hash");
+    #[test]
+    fn test_get_entry_hash() {
+        let tests_cases: Vec<TestCase> = vec![
+            (
+                ("Maker", "BTCUSD", "11512340000000000000000", 1577836800),
+                "3e4113feb6c403cb0c954e5c09d239bf88fedb075220270f44173ac3cd41858",
+            ),
+            (
+                ("Maker", "BTC/USD", "11512340000000000000000", 1577836800),
+                "3e4113feb6c403cb0c954e5c09d239bf88fedb075220270f44173ac3cd41858",
+            ),
+            (
+                ("PRGM", "SOLUSD", "19511280076", 1577216800),
+                "3d683d36601ab3fd05dfbfecea8971a798f3c2e418fa54594c363e6e6816979",
+            ),
+            (
+                ("PRGM", "ETHUSD", "369511280076", 1577816800),
+                "6641dffd4e3499051ca0cd57e5c12b203bcf184576ce72e18d832de941e9656",
+            ),
+            (
+                ("TEST", "DOGEUSD", "51128006", 1517816800),
+                "18320fa96c61b1d8f98e1c85ae0a5a1159a46580ad32415122661c470d8d99f",
+            ),
+            (
+                ("TEST", "DOGE/USD", "51128006", 1517816800),
+                "18320fa96c61b1d8f98e1c85ae0a5a1159a46580ad32415122661c470d8d99f",
+            ),
+        ];
 
-        // 3. Check
-        let expected_data = FieldElement::from_hex_be(
-            "3e4113feb6c403cb0c954e5c09d239bf88fedb075220270f44173ac3cd41858",
-        )
-        .unwrap();
-        assert_eq!(hashed_data, expected_data);
+        for ((oracle_name, pair_id, price, timestamp), expected_hash) in tests_cases {
+            let price = BigDecimal::from_str(price).unwrap();
+            let hashed_data = get_entry_hash(oracle_name, pair_id, timestamp, &price)
+                .expect("Could not build hash");
+            let expected_data = FieldElement::from_hex_be(expected_hash).unwrap();
+            assert_eq!(hashed_data, expected_data);
+        }
     }
-
-    // TODO(akhercha): do way more tests
 }