[Feature] Public Native name_of function (#107)

* public native fun name_of * Add TypeInfo module * Remove T store
starcoinorg · Sep 2, 2022 · 7263b0a · 7263b0a
1 parent ff2d802
commit 7263b0a
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 4 deletions.
diff --git a/build/StarcoinFramework/BuildInfo.yaml b/build/StarcoinFramework/BuildInfo.yaml
@@ -282,6 +282,9 @@ compiled_package_info:
     ? address: "0x00000000000000000000000000000001"
       name: TreasuryWithdrawDaoProposal
     : StarcoinFramework
+    ? address: "0x00000000000000000000000000000001"
+      name: TypeInfo
+    : StarcoinFramework
     ? address: "0x00000000000000000000000000000001"
       name: U256
     : StarcoinFramework
@@ -303,7 +306,7 @@ compiled_package_info:
     ? address: "0x00000000000000000000000000000001"
       name: YieldFarmingV2
     : StarcoinFramework
-  source_digest: 2F6686B5BAFFE5E5DEB6F001CD6D0D8FA93121DB944E71F0E3DCBAB51D81FA90
+  source_digest: 695F4208154FB109E223367B79D9AD3C30261C91BF6F595A3B9D2226BC5103B0
   build_flags:
     dev_mode: false
     test_mode: false

diff --git a/build/StarcoinFramework/bytecode_modules/Token.mv b/build/StarcoinFramework/bytecode_modules/Token.mv
diff --git a/build/StarcoinFramework/docs/README.md b/build/StarcoinFramework/docs/README.md
@@ -104,6 +104,7 @@ This is the root document for the Move StarcoinFramework module documentation. T
 -  [`0x1::Treasury`](Treasury.md#0x1_Treasury)
 -  [`0x1::TreasuryScripts`](TreasuryScripts.md#0x1_TreasuryScripts)
 -  [`0x1::TreasuryWithdrawDaoProposal`](TreasuryWithdrawDaoProposal.md#0x1_TreasuryWithdrawDaoProposal)
+-  [`0x1::TypeInfo`](TypeInfo.md#0x1_TypeInfo)
 -  [`0x1::U256`](U256.md#0x1_U256)
 -  [`0x1::UpgradeModuleDaoProposal`](UpgradeModuleDaoProposal.md#0x1_UpgradeModuleDaoProposal)
 -  [`0x1::VMConfig`](VMConfig.md#0x1_VMConfig)

diff --git a/build/StarcoinFramework/docs/Token.md b/build/StarcoinFramework/docs/Token.md
@@ -45,6 +45,7 @@ Token implementation of Starcoin.
 -  [Function `is_same_token`](#0x1_Token_is_same_token)
 -  [Function `token_address`](#0x1_Token_token_address)
 -  [Function `token_code`](#0x1_Token_token_code)
+-  [Function `type_of`](#0x1_Token_type_of)
 -  [Function `name_of`](#0x1_Token_name_of)
 -  [Function `name_of_token`](#0x1_Token_name_of_token)
 -  [Module Specification](#@Module_Specification_1)
@@ -1709,6 +1710,30 @@ does not matter for the verification of callers.
 
 
 
+</details>
+
+<a name="0x1_Token_type_of"></a>
+
+## Function `type_of`
+
+
+
+<pre><code><b>public</b>(<b>friend</b>) <b>fun</b> <a href="Token.md#0x1_Token_type_of">type_of</a>&lt;T&gt;(): (<b>address</b>, vector&lt;u8&gt;, vector&lt;u8&gt;)
+</code></pre>
+
+
+
+<details>
+<summary>Implementation</summary>
+
+
+<pre><code><b>public</b> (<b>friend</b>) <b>fun</b> <a href="Token.md#0x1_Token_type_of">type_of</a>&lt;T&gt;(): (<b>address</b>, vector&lt;u8&gt;, vector&lt;u8&gt;){
+    <a href="Token.md#0x1_Token_name_of">name_of</a>&lt;T&gt;()
+}
+</code></pre>
+
+
+
 </details>
 
 <a name="0x1_Token_name_of"></a>
@@ -1718,7 +1743,7 @@ does not matter for the verification of callers.
 Return Token's module address, module name, and type name of <code>TokenType</code>.
 
 
-<pre><code><b>fun</b> <a href="Token.md#0x1_Token_name_of">name_of</a>&lt;TokenType: store&gt;(): (<b>address</b>, vector&lt;u8&gt;, vector&lt;u8&gt;)
+<pre><code><b>fun</b> <a href="Token.md#0x1_Token_name_of">name_of</a>&lt;TokenType&gt;(): (<b>address</b>, vector&lt;u8&gt;, vector&lt;u8&gt;)
 </code></pre>
 
 
@@ -1727,7 +1752,7 @@ Return Token's module address, module name, and type name of <code>TokenType</co
 <summary>Implementation</summary>
 
 
-<pre><code><b>native</b> <b>fun</b> <a href="Token.md#0x1_Token_name_of">name_of</a>&lt;TokenType: store&gt;(): (<b>address</b>, vector&lt;u8&gt;, vector&lt;u8&gt;);
+<pre><code><b>native</b> <b>fun</b> <a href="Token.md#0x1_Token_name_of">name_of</a>&lt;TokenType&gt;(): (<b>address</b>, vector&lt;u8&gt;, vector&lt;u8&gt;);
 </code></pre>
 
 

diff --git a/build/StarcoinFramework/source_maps/Token.mvsm b/build/StarcoinFramework/source_maps/Token.mvsm
diff --git a/sources/Token.move b/sources/Token.move
@@ -6,6 +6,7 @@ module Token {
     use StarcoinFramework::Errors;
     use StarcoinFramework::Math;
 
+    friend StarcoinFramework::TypeInfo;
     spec module {
         pragma verify;
         pragma aborts_if_is_strict;
@@ -504,8 +505,12 @@ module Token {
     /// does not matter for the verification of callers.
     spec fun spec_token_code<TokenType>(): TokenCode;
 
+    public (friend) fun type_of<T>(): (address, vector<u8>, vector<u8>){
+        name_of<T>()
+    }
+
     /// Return Token's module address, module name, and type name of `TokenType`.
-    native fun name_of<TokenType: store>(): (address, vector<u8>, vector<u8>);
+    native fun name_of<TokenType>(): (address, vector<u8>, vector<u8>);
 
     spec name_of {
         pragma opaque = true;

diff --git a/sources/TypeInfo.move b/sources/TypeInfo.move
@@ -0,0 +1,30 @@
+module StarcoinFramework::TypeInfo{
+    use StarcoinFramework::Token;
+
+    struct TypeInfo has copy, drop, store{
+        account_address: address,
+        module_name: vector<u8>,
+        struct_name: vector<u8>
+    }
+
+    public fun account_address(type_info: &TypeInfo):address{
+        type_info.account_address
+    }
+
+    public fun module_name(type_info: &TypeInfo):vector<u8>{
+        *&type_info.module_name
+    }
+
+    public fun struct_name(type_info: &TypeInfo):vector<u8>{
+        *&type_info.struct_name
+    }
+
+    public fun type_of<T>():TypeInfo{
+        let (account_address, module_name, struct_name) = Token::type_of<T>();
+        TypeInfo {
+            account_address,
+            module_name,
+            struct_name
+        }
+    }
+}