[StandardToken][Core] token action interface change (remove 't'(token) param, 'qty'->'quantity', 'tag'->'memo' ) (compatibility to 'eosio.token' interface), renaming 'redeem_token' intrinsic to 'retire_token'

bezalel · bezalel · commit 17698a527828 · 2022-06-28T09:04:07.000+09:00
diff --git a/contracts/contracts/sys.tokenabi/bin/sys.tokenabi.abi b/contracts/contracts/sys.tokenabi/bin/sys.tokenabi.abi
@@ -7,34 +7,30 @@
             "name": "issue",
             "base": "",
             "fields": [
-                {
-                    "name": "t",
-                    "type": "name"
-                },
                 {
                     "name": "to",
                     "type": "name"
                 },
                 {
-                    "name": "qty",
+                    "name": "quantity",
                     "type": "asset"
                 },
                 {
-                    "name": "tag",
+                    "name": "memo",
                     "type": "string"
                 }
             ]
         },
         {
-            "name": "redeem",
+            "name": "retire",
             "base": "",
             "fields": [
                 {
-                    "name": "qty",
+                    "name": "quantity",
                     "type": "asset"
                 },
                 {
-                    "name": "tag",
+                    "name": "memo",
                     "type": "string"
                 }
             ]
@@ -61,10 +57,6 @@
             "name": "transfer",
             "base": "",
             "fields": [
-                {
-                    "name": "t",
-                    "type": "name"
-                },
                 {
                     "name": "from",
                     "type": "name"
@@ -74,11 +66,11 @@
                     "type": "name"
                 },
                 {
-                    "name": "qty",
+                    "name": "quantity",
                     "type": "asset"
                 },
                 {
-                    "name": "tag",
+                    "name": "memo",
                     "type": "string"
                 }
             ]
@@ -87,10 +79,6 @@
             "name": "txfee",
             "base": "",
             "fields": [
-                {
-                    "name": "t",
-                    "type": "name"
-                },
                 {
                     "name": "payer",
                     "type": "name"
@@ -109,8 +97,8 @@
             "ricardian_contract": ""
         },
         {
-            "name": "redeem",
-            "type": "redeem",
+            "name": "retire",
+            "type": "retire",
             "ricardian_contract": ""
         },
         {
diff --git a/contracts/contracts/sys.tokenabi/bin/sys.tokenabi.wasm b/contracts/contracts/sys.tokenabi/bin/sys.tokenabi.wasm
diff --git a/infrablockchain-bios/local_testnet_boot_bios_infrablockchain.sh b/infrablockchain-bios/local_testnet_boot_bios_infrablockchain.sh
diff --git a/libraries/chain/apply_context.cpp b/libraries/chain/apply_context.cpp
@@ -985,9 +985,9 @@ void apply_context::transfer_token( const account_name from, const account_name
    standard_token_manager.add_token_balance( *this, token_id, to, amount );
 }
 
-void apply_context::redeem_token( const share_type amount ) {
+void apply_context::retire_token( const share_type amount ) {
 
-   /// Only the contract code of an token account or native built-in token action handler code can redeem(burn) its own (action receiver's) tokens
+   /// Only the contract code of an token account or native built-in token action handler code can retire(burn) its own (action receiver's) tokens
    /// Authorization check(require_authorization) should be done outside(contract code or native action handler) of this function.
 
    EOS_ASSERT( amount > 0, token_action_validate_exception, "amount of token redemption must be greater than 0" );
@@ -1006,7 +1006,7 @@ void apply_context::redeem_token( const share_type amount ) {
    // update total supply
    standard_token_manager.update_token_total_supply(token_meta_obj_ptr, -amount);
 
-   // redeem(burn) tokens
+   // retire(burn) tokens
    standard_token_manager.subtract_token_balance( *this, token_account, token_account, amount );
 }
 
diff --git a/libraries/chain/controller.cpp b/libraries/chain/controller.cpp
@@ -275,7 +275,7 @@ struct controller_impl {
    /**
     * [InfraBlockchain Built-in Actions Feature]
     * predefined actions can be executed on every account even though an account doesn't have contract code.
-    * InfraBlockchain Standard Token operations (issue,redeem,transfer,txfee,...) are built-in actions supported on every account
+    * InfraBlockchain Standard Token operations (issue,retire,transfer,txfee,...) are built-in actions supported on every account
     */
    map< action_name, apply_handler >   built_in_action_apply_handlers;
 
@@ -397,7 +397,7 @@ struct controller_impl {
    SET_INFRABLOCKCHAIN_BUILT_IN_ACTION_APPLY_HANDLER( issue );
    SET_INFRABLOCKCHAIN_BUILT_IN_ACTION_APPLY_HANDLER( transfer );
    SET_INFRABLOCKCHAIN_BUILT_IN_ACTION_APPLY_HANDLER( txfee );
-   SET_INFRABLOCKCHAIN_BUILT_IN_ACTION_APPLY_HANDLER( redeem );
+   SET_INFRABLOCKCHAIN_BUILT_IN_ACTION_APPLY_HANDLER( retire );
 
    }
 
@@ -3522,7 +3522,7 @@ void controller_impl::on_activation<builtin_protocol_feature_t::infrablockchain_
       add_intrinsic_to_whitelist( ps.whitelisted_intrinsics, "get_token_balance" );
       add_intrinsic_to_whitelist( ps.whitelisted_intrinsics, "issue_token" );
       add_intrinsic_to_whitelist( ps.whitelisted_intrinsics, "transfer_token" );
-      add_intrinsic_to_whitelist( ps.whitelisted_intrinsics, "redeem_token" );
+      add_intrinsic_to_whitelist( ps.whitelisted_intrinsics, "retire_token" );
    } );
 }
 
diff --git a/libraries/chain/include/eosio/chain/apply_context.hpp b/libraries/chain/include/eosio/chain/apply_context.hpp
@@ -576,8 +576,8 @@ class apply_context {
       /// transfer token
       void transfer_token( const account_name from, const account_name to, const share_type amount );
 
-      /// redeem(burn) token
-      void redeem_token( const share_type amount );
+      /// retire(burn) token
+      void retire_token( const share_type amount );
 
 
    /// InfraBlockchain Core API - Transaction-Fee Management
diff --git a/libraries/chain/include/eosio/chain/webassembly/eos-vm-oc/intrinsic_mapping.hpp b/libraries/chain/include/eosio/chain/webassembly/eos-vm-oc/intrinsic_mapping.hpp
@@ -254,7 +254,7 @@ constexpr auto intrinsic_table = boost::hana::make_tuple(
    "env.get_token_balance"_s,
    "env.issue_token"_s,
    "env.transfer_token"_s,
-   "env.redeem_token"_s,
+   "env.retire_token"_s,
    "env.get_system_token_count"_s,
    "env.get_system_token_list_packed"_s,
    "env.set_system_token_list_packed"_s,
diff --git a/libraries/chain/include/infrablockchain/chain/standard_token_action_handlers.hpp b/libraries/chain/include/infrablockchain/chain/standard_token_action_handlers.hpp
@@ -27,7 +27,7 @@ namespace infrablockchain { namespace chain {
 
    void apply_infrablockchain_built_in_action_txfee( apply_context& context );
 
-   void apply_infrablockchain_built_in_action_redeem( apply_context& context );
+   void apply_infrablockchain_built_in_action_retire( apply_context& context );
 
 
       ///@}  end action handlers
diff --git a/libraries/chain/include/infrablockchain/chain/standard_token_action_types.hpp b/libraries/chain/include/infrablockchain/chain/standard_token_action_types.hpp
@@ -15,7 +15,7 @@ namespace infrablockchain { namespace chain { namespace standard_token {
    using namespace eosio::chain;
 
    /**
-    * Every account on InfraBlockchain can process built-in standard token actions (settokenmeta, issue, transfer, redeem)
+    * Every account on InfraBlockchain can process built-in standard token actions (settokenmeta, issue, transfer, retire)
     * without custom smart contract code deployed to an account.
     * An account can have optional token contract code inheriting built-in token actions.
     */
@@ -31,30 +31,27 @@ namespace infrablockchain { namespace chain { namespace standard_token {
    };
 
    struct issue {
-      account_name  t;   // token-id (token account name)
       account_name  to;  // token receiver account
-      asset         qty; // token quantity
-      std::string   tag;
+      asset         quantity; // token quantity
+      std::string   memo;
 
       static action_name get_name() {
          return N(issue);
       }
    };
 
    struct transfer {
-      account_name  t;   // token-id (token account name)
       account_name  from; // token sender account
       account_name  to;   // token receiver account
-      asset         qty;  // token quantity
-      std::string   tag;
+      asset         quantity;  // token quantity
+      std::string   memo;
 
       static action_name get_name() {
          return N(transfer);
       }
    };
 
    struct txfee {
-      account_name  t;   // token-id (token account name)
       account_name  payer;  // transaction fee payer
       asset         fee;    // token quantity to pay tx fee
 
@@ -63,20 +60,20 @@ namespace infrablockchain { namespace chain { namespace standard_token {
       }
    };
 
-   struct redeem {
-      asset         qty;  // token quantity to redeem(burn)
-      std::string   tag;
+   struct retire {
+      asset         quantity;  // token quantity to retire(burn)
+      std::string   memo;
 
       static action_name get_name() {
-         return N(redeem);
+         return N(retire);
       }
    };
 
    struct utils {
       static bool is_infrablockchain_standard_token_action(action_name action) {
          return action == transfer::get_name()
                 || action == issue::get_name()
-                || action == redeem::get_name()
+                || action == retire::get_name()
                 || action == txfee::get_name()
                 || action == settokenmeta::get_name();
       }
@@ -85,7 +82,7 @@ namespace infrablockchain { namespace chain { namespace standard_token {
 } } } /// infrablockchain::chain::standard_token
 
 FC_REFLECT( infrablockchain::chain::standard_token::settokenmeta , (sym)(url)(desc) )
-FC_REFLECT( infrablockchain::chain::standard_token::issue, (t)(to)(qty)(tag) )
-FC_REFLECT( infrablockchain::chain::standard_token::transfer, (t)(from)(to)(qty)(tag) )
-FC_REFLECT( infrablockchain::chain::standard_token::txfee, (t)(payer)(fee) )
-FC_REFLECT( infrablockchain::chain::standard_token::redeem, (qty)(tag) )
+FC_REFLECT( infrablockchain::chain::standard_token::issue, (to)(quantity)(memo) )
+FC_REFLECT( infrablockchain::chain::standard_token::transfer, (from)(to)(quantity)(memo) )
+FC_REFLECT( infrablockchain::chain::standard_token::txfee, (payer)(fee) )
+FC_REFLECT( infrablockchain::chain::standard_token::retire, (quantity)(memo) )
diff --git a/libraries/chain/include/infrablockchain/chain/standard_token_object.hpp b/libraries/chain/include/infrablockchain/chain/standard_token_object.hpp
@@ -26,7 +26,7 @@ namespace infrablockchain { namespace chain {
       id_type        id;
       token_id_type  token_id;          // token id = token account name
       symbol         sym;               // symbol name and precision
-      share_type     total_supply = 0;  // total token supply amount issued(+) and redeemed(-) by token account
+      share_type     total_supply = 0;  // total token supply amount issued(+) and retired(burned)(-) by token account
       shared_string  url;               // website url for token information managed by token issuer (owner of token account)
       shared_string  desc;              // token description
    };
diff --git a/libraries/chain/infrablockchain/standard_token_action_handlers.cpp b/libraries/chain/infrablockchain/standard_token_action_handlers.cpp
@@ -48,21 +48,20 @@ namespace infrablockchain { namespace chain {
       try {
          const token_id_type token_id = context.get_action().account;
          EOS_ASSERT( token_id == context.get_receiver(), token_action_validate_exception, "issue built-in standard token action handler should be invoked only in first receiver context" );
-         EOS_ASSERT( token_id == issue_action.t, token_action_validate_exception, "issue action account, token id (t) mismatch" );
 
-         EOS_ASSERT( issue_action.qty.is_valid(), token_action_validate_exception, "invalid quantity" );
-         EOS_ASSERT( issue_action.tag.size() <= 256, token_action_validate_exception, "tag has more than 256 bytes" );
+         EOS_ASSERT( issue_action.quantity.is_valid(), token_action_validate_exception, "invalid quantity" );
+         EOS_ASSERT( issue_action.memo.size() <= 256, token_action_validate_exception, "memo has more than 256 bytes" );
          // action parameter validation will be done in context.issue_token()
 
          const account_name to_account = issue_action.to;
-         const share_type issue_amount = issue_action.qty.get_amount();
+         const share_type issue_amount = issue_action.quantity.get_amount();
 
          auto& standard_token_manager = context.control.get_standard_token_manager();
 
          auto* token_meta_obj_ptr = standard_token_manager.get_token_meta_object(token_id);
          EOS_ASSERT( token_meta_obj_ptr, token_not_yet_created_exception, "token not yet created for the account ${account}", ("account", token_id) );
          auto token_meta_obj = *token_meta_obj_ptr;
-         EOS_ASSERT( issue_action.qty.get_symbol() == token_meta_obj.sym, token_symbol_mismatch_exception,
+         EOS_ASSERT( issue_action.quantity.get_symbol() == token_meta_obj.sym, token_symbol_mismatch_exception,
                      "token symbol of quantity field mismatches with the symbol(${sym}) of the registered token metadata",
                      ("sym", token_meta_obj.sym.to_string()) );
 
@@ -87,23 +86,22 @@ namespace infrablockchain { namespace chain {
       try {
          const token_id_type token_id = context.get_action().account;
          EOS_ASSERT( token_id == context.get_receiver(), token_action_validate_exception, "transfer built-in standard token action handler should be invoked only in first receiver context" );
-         EOS_ASSERT( token_id == transfer_action.t, token_action_validate_exception, "transfer action account, token id (t) mismatch" );
 
          const account_name from_account = transfer_action.from;
          const account_name to_account = transfer_action.to;
-         const share_type transfer_amount = transfer_action.qty.get_amount();
+         const share_type transfer_amount = transfer_action.quantity.get_amount();
 
          EOS_ASSERT( from_account != to_account, token_action_validate_exception, "same from, to account" );
-         EOS_ASSERT( transfer_action.qty.is_valid(), token_action_validate_exception, "invalid quantity" );
-         EOS_ASSERT( transfer_action.tag.size() <= 256, token_action_validate_exception, "tag has more than 256 bytes" );
+         EOS_ASSERT( transfer_action.quantity.is_valid(), token_action_validate_exception, "invalid quantity" );
+         EOS_ASSERT( transfer_action.memo.size() <= 256, token_action_validate_exception, "memo has more than 256 bytes" );
          // action parameter validation will be done in context.transfer_token()
 
          auto& standard_token_manager = context.control.get_mutable_standard_token_manager();
 
          auto* token_meta_obj_ptr = standard_token_manager.get_token_meta_object(token_id);
          EOS_ASSERT( token_meta_obj_ptr, token_not_yet_created_exception, "token not yet created for the account ${account}", ("account", token_id) );
          auto token_meta_obj = *token_meta_obj_ptr;
-         EOS_ASSERT( transfer_action.qty.get_symbol() == token_meta_obj.sym, token_symbol_mismatch_exception,
+         EOS_ASSERT( transfer_action.quantity.get_symbol() == token_meta_obj.sym, token_symbol_mismatch_exception,
                      "token symbol of quantity field mismatches with the symbol(${sym}) of the registered token metadata",
                      ("sym", token_meta_obj.sym.to_string()) );
 
@@ -130,7 +128,6 @@ namespace infrablockchain { namespace chain {
       try {
          const token_id_type token_id = context.get_action().account;
          EOS_ASSERT( token_id == context.get_receiver(), token_action_validate_exception, "txfee built-in standard token action handler should be invoked only in first receiver context" );
-         EOS_ASSERT( token_id == txfee_action.t, token_action_validate_exception, "txfee action account, token id (t) mismatch" );
 
          const account_name payer_account = txfee_action.payer;
          EOS_ASSERT( payer_account.good(), token_action_validate_exception, "invalid payer account name" );
@@ -168,38 +165,38 @@ namespace infrablockchain { namespace chain {
 
 
    /**
-    * 'redeem' standard token action apply handler
+    * 'retire' standard token action apply handler
     */
-   void apply_infrablockchain_built_in_action_redeem( apply_context& context ) {
+   void apply_infrablockchain_built_in_action_retire( apply_context& context ) {
 
-      auto redeem_action = context.get_action().data_as_built_in_common_action<redeem>();
+      auto retire_action = context.get_action().data_as_built_in_common_action<retire>();
       try {
          const token_id_type token_id = context.get_action().account;
-         EOS_ASSERT( token_id == context.get_receiver(), token_action_validate_exception, "redeem built-in standard token action handler should be invoked only in first receiver context" );
+         EOS_ASSERT( token_id == context.get_receiver(), token_action_validate_exception, "retire built-in standard token action handler should be invoked only in first receiver context" );
 
-         EOS_ASSERT( redeem_action.qty.is_valid(), token_action_validate_exception, "invalid token redemption quantity" );
-         EOS_ASSERT( redeem_action.tag.size() <= 256, token_action_validate_exception, "tag has more than 256 bytes" );
+         EOS_ASSERT( retire_action.quantity.is_valid(), token_action_validate_exception, "invalid token redemption quantity" );
+         EOS_ASSERT( retire_action.memo.size() <= 256, token_action_validate_exception, "memo has more than 256 bytes" );
          // action parameter validation will be done in context.issue_token()
 
-         const share_type redeem_amount = redeem_action.qty.get_amount();
+         const share_type retire_amount = retire_action.quantity.get_amount();
 
          auto& standard_token_manager = context.control.get_mutable_standard_token_manager();
 
          auto* token_meta_obj_ptr = standard_token_manager.get_token_meta_object(token_id);
          EOS_ASSERT( token_meta_obj_ptr, token_not_yet_created_exception, "token not yet created for the account ${account}", ("account", token_id) );
          auto token_meta_obj = *token_meta_obj_ptr;
 
-         EOS_ASSERT( redeem_action.qty.get_symbol() == token_meta_obj.sym, token_symbol_mismatch_exception,
+         EOS_ASSERT( retire_action.quantity.get_symbol() == token_meta_obj.sym, token_symbol_mismatch_exception,
                      "token symbol of redemption quantity field mismatches with the symbol(${sym}) of the registered token metadata",
                      ("sym", token_meta_obj.sym.to_string()) );
 
-         // only the token account owner can redeem(burn) tokens held by token account
+         // only the token account owner can retire(burn) tokens held by token account
          context.require_authorization( token_id );
 
          // update token balance and ram usage
-         context.redeem_token( redeem_amount );
+         context.retire_token( retire_amount );
 
-      } FC_CAPTURE_AND_RETHROW( (redeem_action) )
+      } FC_CAPTURE_AND_RETHROW( (retire_action) )
    }
 
 } } // namespace infrablockchain::chain
diff --git a/libraries/chain/infrablockchain/standard_token_manager.cpp b/libraries/chain/infrablockchain/standard_token_manager.cpp
@@ -270,7 +270,7 @@ namespace infrablockchain { namespace chain {
             uint32_t action_ordinal = trx_context.schedule_action(
                action { vector<permission_level>{ {fee_payer, config::active_name} },
                         sys_token_id,
-                        standard_token::txfee{ sys_token_id, fee_payer, asset(fee_for_this_token, token_meta_obj_ptr->sym) } }
+                        standard_token::txfee{ fee_payer, asset(fee_for_this_token, token_meta_obj_ptr->sym) } }
                , sys_token_id, false, 0, 0 );
             trx_context.execute_action( action_ordinal, 0 );
 
diff --git a/libraries/chain/wasm_interface.cpp b/libraries/chain/wasm_interface.cpp

Original file line number	Diff line number	Diff line change
`@@ -7,34 +7,30 @@`
`7`	`7`	`"name": "issue",`
`8`	`8`	`"base": "",`
`9`	`9`	`"fields": [`
`10`		`- {`
`11`		`- "name": "t",`
`12`		`- "type": "name"`
`13`		`- },`
`14`	`10`	`{`
`15`	`11`	`"name": "to",`
`16`	`12`	`"type": "name"`
`17`	`13`	`},`
`18`	`14`	`{`
`19`		`- "name": "qty",`
	`15`	`+ "name": "quantity",`
`20`	`16`	`"type": "asset"`
`21`	`17`	`},`
`22`	`18`	`{`
`23`		`- "name": "tag",`
	`19`	`+ "name": "memo",`
`24`	`20`	`"type": "string"`
`25`	`21`	`}`
`26`	`22`	`]`
`27`	`23`	`},`
`28`	`24`	`{`
`29`		`- "name": "redeem",`
	`25`	`+ "name": "retire",`
`30`	`26`	`"base": "",`
`31`	`27`	`"fields": [`
`32`	`28`	`{`
`33`		`- "name": "qty",`
	`29`	`+ "name": "quantity",`
`34`	`30`	`"type": "asset"`
`35`	`31`	`},`
`36`	`32`	`{`
`37`		`- "name": "tag",`
	`33`	`+ "name": "memo",`
`38`	`34`	`"type": "string"`
`39`	`35`	`}`
`40`	`36`	`]`
`@@ -61,10 +57,6 @@`
`61`	`57`	`"name": "transfer",`
`62`	`58`	`"base": "",`
`63`	`59`	`"fields": [`
`64`		`- {`
`65`		`- "name": "t",`
`66`		`- "type": "name"`
`67`		`- },`
`68`	`60`	`{`
`69`	`61`	`"name": "from",`
`70`	`62`	`"type": "name"`
`@@ -74,11 +66,11 @@`
`74`	`66`	`"type": "name"`
`75`	`67`	`},`
`76`	`68`	`{`
`77`		`- "name": "qty",`
	`69`	`+ "name": "quantity",`
`78`	`70`	`"type": "asset"`
`79`	`71`	`},`
`80`	`72`	`{`
`81`		`- "name": "tag",`
	`73`	`+ "name": "memo",`
`82`	`74`	`"type": "string"`
`83`	`75`	`}`
`84`	`76`	`]`
`@@ -87,10 +79,6 @@`
`87`	`79`	`"name": "txfee",`
`88`	`80`	`"base": "",`
`89`	`81`	`"fields": [`
`90`		`- {`
`91`		`- "name": "t",`
`92`		`- "type": "name"`
`93`		`- },`
`94`	`82`	`{`
`95`	`83`	`"name": "payer",`
`96`	`84`	`"type": "name"`
`@@ -109,8 +97,8 @@`
`109`	`97`	`"ricardian_contract": ""`
`110`	`98`	`},`
`111`	`99`	`{`
`112`		`- "name": "redeem",`
`113`		`- "type": "redeem",`
	`100`	`+ "name": "retire",`
	`101`	`+ "type": "retire",`
`114`	`102`	`"ricardian_contract": ""`
`115`	`103`	`},`
`116`	`104`	`{`