zkgm: better name and symbol handling, and handle decimals (#3813)

## Decimal
- Add decimals to `FungibleAssetOrder` and make it V1.
- `move` implementation dropped support for `FungibleAssetOrderV0`.
- `cosmwasm` and `evm` implementations are backwards compatible with
`FungibleAssetOrderV0`.
- All implementations now default to `FungibleAssetOrderV1` in their
`transfer` function.
  
## Token name and symbol
- Fixed a bug where we don't handle minimum lengths in symbols and names
in `cw20`.
- Added names and symbols to the `move` impl.

Author: aeryz

aptos/ibc/sources/cometbls_lc.move

@@ -707,7 +707,7 @@ module ibc::cometbls_lc {
             next_validators_hash: x"0000000000000000000000000000000000000000000000000000000000000000"
         };
 
-        let (cs, cons, _counterparty_channel_id) =
+        let (cs, cons, _counterparty_channel_id, _) =
             create_client(
                 ibc_signer,
                 0,
@@ -734,7 +734,7 @@ module ibc::cometbls_lc {
         client_state.trusting_period = 2;
         consensus_state.timestamp = 20000;
 
-        let (cs, cons, _counterparty_channel_id) =
+        let (cs, cons, _counterparty_channel_id, _) =
             create_client(
                 ibc_signer,
                 2,

aptos/ucs03-zkgm/sources/fungible_asset_order.move

@@ -73,7 +73,8 @@ module zkgm::fungible_asset_order {
         base_token_name: String,
         base_token_path: u256,
         quote_token: vector<u8>,
-        quote_amount: u256
+        quote_amount: u256,
+        decimals: u8
     }
 
     public fun new(
@@ -85,7 +86,8 @@ module zkgm::fungible_asset_order {
         base_token_name: String,
         base_token_path: u256,
         quote_token: vector<u8>,
-        quote_amount: u256
+        quote_amount: u256,
+        decimals: u8
     ): FungibleAssetOrder {
         FungibleAssetOrder {
             sender,
@@ -96,7 +98,8 @@ module zkgm::fungible_asset_order {
             base_token_name,
             base_token_path,
             quote_token,
-            quote_amount
+            quote_amount,
+            decimals
         }
     }
 
@@ -136,6 +139,10 @@ module zkgm::fungible_asset_order {
         order.quote_amount
     }
 
+    public fun decimals(order: &FungibleAssetOrder): u8 {
+        order.decimals
+    }
+
     public fun encode(order: &FungibleAssetOrder): vector<u8> {
         let buf = vector::empty();
 
@@ -173,6 +180,7 @@ module zkgm::fungible_asset_order {
         // quote_token offset
         zkgm_ethabi::encode_uint<u64>(&mut buf, dyn_offset);
         zkgm_ethabi::encode_uint<u256>(&mut buf, order.quote_amount);
+        zkgm_ethabi::encode_uint<u8>(&mut buf, order.decimals);
 
         vector::append(&mut buf, sender);
         vector::append(&mut buf, receiver);
@@ -195,7 +203,8 @@ module zkgm::fungible_asset_order {
             base_token_name: zkgm_ethabi::decode_string_from_offset(buf, &mut index),
             base_token_path: zkgm_ethabi::decode_uint(buf, &mut index),
             quote_token: zkgm_ethabi::decode_bytes_from_offset(buf, &mut index),
-            quote_amount: zkgm_ethabi::decode_uint(buf, &mut index)
+            quote_amount: zkgm_ethabi::decode_uint(buf, &mut index),
+            decimals: (zkgm_ethabi::decode_uint(buf, &mut index) as u8)
         }
     }
 

aptos/ucs03-zkgm/sources/token_denom.move

@@ -73,8 +73,9 @@ module zkgm::fa_coin {
     use aptos_framework::primary_fungible_store;
     use std::error;
     use std::signer;
-    use std::string::{Self};
+    use std::string::{Self, String};
     use std::option;
+    use std::vector;
 
     /// Only fungible asset metadata owner can make changes.
     const E_NOT_OWNER: u64 = 1;
@@ -112,8 +113,8 @@ module zkgm::fa_coin {
         primary_fungible_store::create_primary_store_enabled_fungible_asset(
             constructor_ref,
             option::none(),
-            name,
-            symbol,
+            sanitize_token_name(name),
+            sanitize_token_symbol(symbol),
             decimals,
             icon,
             project
@@ -181,6 +182,11 @@ module zkgm::fa_coin {
         fungible_asset::symbol<Metadata>(asset)
     }
 
+    #[view]
+    public fun decimals_with_metadata(asset: Object<Metadata>): u8 {
+        fungible_asset::decimals<Metadata>(asset)
+    }
+
     /// Deposit function override to ensure that the account is not denylisted and the FA coin is not paused.
     /// OPTIONAL
     public fun deposit<T: key>(
@@ -317,12 +323,51 @@ module zkgm::fa_coin {
         borrow_global<ManagedFungibleAsset>(object::object_address(&asset))
     }
 
+    public fun sanitize_token_str(name: String, max_len: u64): String {
+        let len = string::length(&name);
+        if (len > max_len) {
+            let token_name = string::sub_string(&name, len - max_len, len);
+            let i = max_len - 1;
+            let bytes = string::bytes(&token_name);
+            while (i > 0) {
+                if (*vector::borrow(bytes, i) == 47 /* '/' */ && i != max_len - 1) {
+                    return string::sub_string(&token_name, i + 1, max_len)
+                };
+                i = i - 1;
+            };
+            token_name
+        } else {
+            name
+        }
+    }
+
+    public fun sanitize_token_name(name: String): String {
+        sanitize_token_str(name, 32)
+    }
+
+    public fun sanitize_token_symbol(symbol: String): String {
+        sanitize_token_str(symbol, 10)
+    }
+
     const TEST_NAME: vector<u8> = b"Test Coin";
     const TEST_SYMBOL: vector<u8> = b"TST";
     const TEST_DECIMALS: u8 = 8;
     const TEST_ICON: vector<u8> = b"https://example.com/icon.png";
     const TEST_PROJECT: vector<u8> = b"Test Project";
 
+    #[test]
+    fun test_sanitize_token_works() {
+        use std::string::utf8;
+        assert!(sanitize_token_name(utf8(b"alesdnleansdf")) == utf8(b"alesdnleansdf"), 1);
+        assert!(sanitize_token_name(utf8(b"verylongverylongverylongverylongverylongverylongverylongverylong")) == utf8(b"verylongverylongverylongverylong"), 2);
+        assert!(sanitize_token_name(utf8(b"factory/union12qdvmw22n72mem0ysff3nlyj2c76cuy4x60lua/clown")) == utf8(b"clown"), 3);
+        assert!(sanitize_token_name(utf8(b"factory/union12qdvmw22n72mem0ysff3nlyj2c76cuy4x60lua/clown/")) == utf8(b"clown/"), 4);
+
+        assert!(sanitize_token_symbol(utf8(b"verylongverylongverylongverylongverylongverylongverylongverylong")) == utf8(b"ngverylong"), 5);
+        assert!(sanitize_token_symbol(utf8(b"factory/union12qdvmw22n72mem0ysff3nlyj2c76cuy4x60lua/clown")) == utf8(b"clown"), 6);
+    }
+
+
     #[test(creator = @0x28873b2d4265e6e14bc0739ef876dce858f06380905279ed090b82d0c75f6e57)]
     public fun test_burn_with_metadata(creator: &signer) acquires ManagedFungibleAsset {
         initialize(