fix(cat-gateway): regex and parse param (#2514)

* fix(cat-gateway): regex and parse param

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): asset name

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): bin data and code format

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): test dat for catid or stake address

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): use regex for pre check

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): format

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): asset name condition

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): format + schema

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): revert change

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): regex bin data

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): revert back to policy hash

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): regex

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): typo

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): format

Signed-off-by: bkioshn <[email protected]>

* fix(cat-gateway): regex

Signed-off-by: bkioshn <[email protected]>

---------

Signed-off-by: bkioshn <[email protected]>

Author: bkioshn

catalyst-gateway/bin/src/db/index/block/txo/insert_txo_asset.rs

@@ -29,9 +29,9 @@ pub(crate) struct Params {
     txn_index: DbTxnIndex,
     /// Transaction Output Offset inside the transaction.
     txo: DbTxnOutputOffset,
-    /// Policy hash of the asset
+    /// Asset policy hash (28 bytes).
     policy_id: Vec<u8>,
-    /// Name of the asset, within the Policy.
+    /// Asset name (range of 0 - 32 bytes).
     asset_name: Vec<u8>,
     /// Value of the asset
     value: num_bigint::BigInt,

catalyst-gateway/bin/src/db/index/block/txo/insert_unstaked_txo_asset.rs

@@ -25,9 +25,9 @@ pub(crate) struct Params {
     txn_id: DbTransactionId,
     /// Transaction Output Offset inside the transaction.
     txo: DbTxnOutputOffset,
-    /// Policy hash of the asset
+    /// Asset policy hash (28 bytes).
     policy_id: Vec<u8>,
-    /// Policy name of the asset
+    /// Asset name (range of 0 - 32 bytes).
     asset_name: Vec<u8>,
     /// Block Slot Number
     slot_no: DbSlot,

catalyst-gateway/bin/src/db/index/queries/purge/txo_assets.rs

@@ -51,9 +51,9 @@ pub(crate) struct Params {
     pub(crate) txn_index: DbTxnIndex,
     /// Transaction Output Offset inside the transaction.
     pub(crate) txo: DbTxnOutputOffset,
-    /// Asset Policy Hash - Binary 28 bytes.
+    /// Asset policy hash (28 bytes).
     policy_id: Vec<u8>,
-    /// Name of the asset, within the Policy.
+    /// Asset name (range of 0 - 32 bytes).
     asset_name: Vec<u8>,
 }
 

catalyst-gateway/bin/src/db/index/queries/purge/unstaked_txo_assets.rs

@@ -46,9 +46,9 @@ pub(crate) struct Params {
     pub(crate) txn_id: DbTransactionId,
     /// Offset in the txo list of the transaction the txo is in.
     pub(crate) txo: DbTxnOutputOffset,
-    /// Asset Policy Hash - Binary 28 bytes.
+    /// Asset policy hash (28 bytes).
     pub(crate) policy_id: Vec<u8>,
-    /// Name of the asset, within the Policy.
+    /// Asset name (range of 0 - 32 bytes).
     pub(crate) asset_name: Vec<u8>,
 }
 

catalyst-gateway/bin/src/db/index/queries/staked_ada/get_assets_by_stake_address.rs

@@ -48,9 +48,9 @@ pub(crate) struct GetAssetsByStakeAddressQuery {
     pub txo: DbTxnOutputOffset,
     /// TXO transaction slot number.
     pub slot_no: DbSlot,
-    /// Asset hash.
+    /// Asset policy hash (28 bytes).
     pub policy_id: Vec<u8>,
-    /// Asset name.
+    /// Asset name (range of 0 - 32 bytes)
     pub asset_name: Vec<u8>,
     /// Asset value.
     pub value: num_bigint::BigInt,

catalyst-gateway/bin/src/db/index/schema/cql/txo_assets_by_stake_table.cql

@@ -7,7 +7,7 @@ CREATE TABLE IF NOT EXISTS txo_assets_by_stake (
     txn_index       smallint, -- Which Transaction in the Slot is the TXO.
     txo             smallint, -- offset in the txo list of the transaction the txo is in.
     policy_id       blob,     -- asset policy hash (id) (28 byte binary hash)
-    asset_name      blob,     -- name of the asset policy (UTF8) (32 bytes)
+    asset_name      blob,     -- name of the asset policy (UTF8) (0 - 32 bytes)
 
 
     -- None Key Data of the asset.

catalyst-gateway/bin/src/db/index/schema/cql/unstaked_txo_assets_by_txn_id.cql

@@ -4,7 +4,7 @@ CREATE TABLE IF NOT EXISTS unstaked_txo_assets_by_txn_id (
     txn_id          blob,     -- 32 byte hash of this transaction.
     txo             smallint, -- offset in the txo list of the transaction the txo is in.
     policy_id       blob,     -- asset policy hash (id) (28 byte binary hash)
-    asset_name      blob,     -- name of the policy (UTF8) (32 bytes)
+    asset_name      blob,     -- name of the policy (UTF8) (0 - 32 bytes)
 
     -- Secondary Location information for the transaction.
     slot_no         varint,     -- slot number the txo was created in.

catalyst-gateway/bin/src/service/api/cardano/rbac/registrations_get/binary_data.rs

@@ -6,6 +6,7 @@ use poem_openapi::{
     registry::{MetaSchema, MetaSchemaRef},
     types::{Example, ParseError, ParseFromJSON, ParseFromParameter, ParseResult, ToJSON, Type},
 };
+use regex::Regex;
 use serde_json::Value;
 
 use crate::service::{
@@ -22,7 +23,7 @@ const DESCRIPTION: &str = "A hex encoded binary data.";
 /// An example.
 const EXAMPLE: &str = "0x56CDD154355E078A0990F9E633F9553F7D43A68B2FF9BEF78B9F5C71C808A7C8";
 /// A validation regex pattern.
-const PATTERN: &str = "0x[A-Fa-f0-9]+";
+const PATTERN: &str = "^0x[A-Fa-f0-9]+$";
 /// A format.
 const FORMAT: &str = "hex";
 
@@ -37,12 +38,28 @@ static SCHEMA: LazyLock<MetaSchema> = LazyLock::new(|| {
     }
 });
 
+/// Validate the `HexEncodedBinaryData`.
+/// This part is done separately from the `PATTERN`
+fn is_valid(hash: &str) -> bool {
+    /// Regex to validate `HexEncodedBinaryData`
+    #[allow(clippy::unwrap_used)] // Safe because the Regex is constant
+    static RE: LazyLock<Regex> = LazyLock::new(|| Regex::new(PATTERN).unwrap());
+
+    if RE.is_match(hash) {
+        if let Some(h) = hash.strip_prefix("0x") {
+            return hex::decode(h).is_ok();
+        }
+    }
+    false
+}
+
 impl_string_types!(
     /// A hex encoded binary data.
     HexEncodedBinaryData,
     "string",
     FORMAT,
-    Some(SCHEMA.clone())
+    Some(SCHEMA.clone()),
+    is_valid
 );
 
 impl From<Vec<u8>> for HexEncodedBinaryData {
@@ -62,3 +79,18 @@ impl Example for HexEncodedBinaryData {
         Self(EXAMPLE.to_owned())
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_hex_binary_data() {
+        assert!(HexEncodedBinaryData::parse_from_parameter(EXAMPLE).is_ok());
+
+        let invalid = ["123", "0x", "0xqw", "abcdefghijk"];
+        for v in invalid {
+            assert!(HexEncodedBinaryData::parse_from_parameter(v).is_err());
+        }
+    }
+}

catalyst-gateway/bin/src/service/common/objects/cardano/stake_info.rs

@@ -18,7 +18,7 @@ use crate::service::common::types::{
 #[derive(Object, Debug, Clone)]
 #[oai(example)]
 pub(crate) struct StakedTxoAssetInfo {
-    /// Token policy hash.
+    /// Asset policy hash (28 bytes).
     pub(crate) policy_hash: HexEncodedHash28,
     /// Token policies Asset Name.
     pub(crate) asset_name: AssetName,

catalyst-gateway/bin/src/service/common/types/cardano/asset_name.rs

@@ -2,10 +2,12 @@
 
 use std::sync::LazyLock;
 
+use const_format::concatcp;
 use poem_openapi::{
     registry::{MetaSchema, MetaSchemaRef},
     types::{Example, ParseError, ParseFromJSON, ParseFromParameter, ParseResult, ToJSON, Type},
 };
+use regex::Regex;
 use serde_json::Value;
 
 use crate::service::common::types::string_types::impl_string_types;
@@ -17,14 +19,19 @@ const DESCRIPTION: &str = r"The name given to the native asset when it was minte
 If the name can be converted to UTF8, its string is represented directly.
 Otherwise it will be represented as escaped ascii.
 Any `\` present in the name will be replaced with `\\` in all cases.";
+
 /// Example.
 const EXAMPLE: &str = "My Cool\nAsset";
+/// Maximum asset name in bytes.
+const ASSET_NAME_MAX_BYTES: usize = 32;
 /// Minimum length.
 const MIN_LENGTH: usize = 0;
-/// Maximum length. (True length is 32, but escaping can double its size).
-const MAX_LENGTH: usize = 64;
+/// Maximum length calculated from maximum length of escaped string * max number of bytes
+/// of asset name. <https://www.gnu.org/software/gawk/manual/html_node/Escape-Sequences.html>
+const MAX_LENGTH: usize = ASSET_NAME_MAX_BYTES * 4;
 /// Validation Regex Pattern
-const PATTERN: &str = r"[\S\s]{0,64}";
+/// Can be anything
+const PATTERN: &str = concatcp!(r"^[\S\s]{", "0,", MAX_LENGTH, "}$");
 
 /// Schema.
 static SCHEMA: LazyLock<MetaSchema> = LazyLock::new(|| {
@@ -39,12 +46,12 @@ static SCHEMA: LazyLock<MetaSchema> = LazyLock::new(|| {
     }
 });
 
-/// Because ALL the constraints are defined above, we do not ever need to define them in
-/// the API. BUT we do need to make a validator.
-/// This helps enforce uniform validation.
-fn is_valid(_name: &str) -> bool {
-    // Anything is valid.
-    true
+/// Validate `AssetName` This part is done separately from the `PATTERN`
+fn is_valid(name: &str) -> bool {
+    /// Regex to validate `AssetName`
+    #[allow(clippy::unwrap_used)] // Safe because the Regex is constant.
+    static RE: LazyLock<Regex> = LazyLock::new(|| Regex::new(PATTERN).unwrap());
+    RE.is_match(name)
 }
 
 impl_string_types!(
@@ -80,3 +87,31 @@ impl From<String> for AssetName {
         Self(value)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_asset_name() {
+        let escape_octal = r"\nnn".repeat(32);
+        // Test Data
+        // <https://preprod.cardanoscan.io/tokens>
+        let valid = [
+            EXAMPLE,
+            "This_Is_A_Very_Long_String______",
+            &escape_octal,
+            "SPLASH",
+        ];
+        for v in valid {
+            assert!(AssetName::parse_from_parameter(v).is_ok());
+        }
+        let invalid = [
+            // Add additional char
+            &format!("{escape_octal}a"),
+        ];
+        for v in invalid {
+            assert!(AssetName::parse_from_parameter(v).is_err());
+        }
+    }
+}