Fix u128 RPC serialization/deserialization (paritytech#307)

Previously, the `Balance`, `Price` and `Weight` were serialized directly into u128 numbers in chainx-org/ChainX#238, but polkadot.js could not parse them successfully. Therefore, it is necessary to serialize `Balance`, `Price`, and `Weight` back to String. Unlike before, the serialization conversion of `Balance` and `Price` only occurs at the RPC layer and does not involve the types in the pallet (because the `Weight` is an alias of u128, so we use serde derive directly on the type to complete the serialization conversion). Signed-off-by: koushiro <koushiro.cqx@gmail.com>
chainx-org · Oct 23, 2020 · 43a33fb · 43a33fb
1 parent b39c5fb
commit 43a33fb
Show file tree

Hide file tree

Showing 42 changed files with 682 additions and 254 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/primitives/Cargo.toml b/primitives/Cargo.toml
@@ -24,14 +24,14 @@ xpallet-support = { path = "../xpallets/support", default-features = false }
 default = ["std"]
 std = [
     "codec/std",
-    "serde/std",
-
+    "serde",
+    # Substrate primitives
     "sp-application-crypto/std",
     "sp-core/std",
     "sp-runtime/std",
     "sp-std/std",
-
+    # Substrate pallets
     "frame-system/std",
-
+    # ChainX pallets
     "xpallet-support/std",
 ]
diff --git a/primitives/assets-registrar/Cargo.toml b/primitives/assets-registrar/Cargo.toml
@@ -7,13 +7,17 @@ edition = "2018"
 [dependencies]
 impl-trait-for-tuples = "0.1.3"
 
+# Substrate pallets
 frame-support = { version = "2.0.0", default-features = false }
 
+# ChainX primitives
 chainx-primitives = { path = "../../primitives", default-features = false }
 
 [features]
 default = ["std"]
 std = [
+    # Substrate pallets
     "frame-support/std",
+    # ChainX primitives
     "chainx-primitives/std",
 ]
diff --git a/primitives/genesis-builder/Cargo.toml b/primitives/genesis-builder/Cargo.toml
@@ -16,7 +16,7 @@ xpallet-support = { path = "../../xpallets/support", default-features = false }
 [features]
 default = ["std"]
 std = [
-    "serde/std",
+    "serde",
     # ChainX primitives
     "chainx-primitives/std",
     # ChainX pallets

diff --git a/primitives/genesis-builder/src/lib.rs b/primitives/genesis-builder/src/lib.rs
@@ -12,14 +12,6 @@ mod genesis_params {
     use chainx_primitives::Balance;
     use serde::{Deserialize, Serialize};
 
-    fn deserialize_u128<'de, D>(deserializer: D) -> Result<u128, D::Error>
-    where
-        D: serde::Deserializer<'de>,
-    {
-        let s = String::deserialize(deserializer)?;
-        s.parse::<u128>().map_err(serde::de::Error::custom)
-    }
-
     #[derive(Debug, Default, Clone, Serialize, Deserialize)]
     pub struct AllParams<AccountId, TBalance, AssetBalanceOf, StakingBalanceOf> {
         pub balances: BalancesParams<AccountId, TBalance>,
@@ -54,15 +46,15 @@ mod genesis_params {
         pub referral_id: Vec<u8>,
         pub self_bonded: Balance,
         pub total_nomination: Balance,
-        #[serde(deserialize_with = "deserialize_u128")]
+        #[serde(with = "xpallet_support::serde_num_str")]
         pub total_weight: u128,
     }
 
     #[derive(Debug, Default, Clone, Serialize, Deserialize)]
     pub struct Nomination<AccountId, Balance> {
         pub nominee: AccountId,
         pub nomination: Balance,
-        #[serde(deserialize_with = "deserialize_u128")]
+        #[serde(with = "xpallet_support::serde_num_str")]
         pub weight: u128,
     }
 
@@ -81,14 +73,14 @@ mod genesis_params {
     #[derive(Debug, Default, Clone, Serialize, Deserialize)]
     pub struct XBtcInfo {
         pub balance: Balance,
-        #[serde(deserialize_with = "deserialize_u128")]
+        #[serde(with = "xpallet_support::serde_num_str")]
         pub weight: u128,
     }
 
     #[derive(Debug, Default, Clone, Serialize, Deserialize)]
     pub struct XBtcMiner<AccountId> {
         pub who: AccountId,
-        #[serde(deserialize_with = "deserialize_u128")]
+        #[serde(with = "xpallet_support::serde_num_str")]
         pub weight: u128,
     }
 

diff --git a/primitives/io/Cargo.toml b/primitives/io/Cargo.toml
@@ -7,6 +7,7 @@ edition = "2018"
 [dependencies]
 codec = { package = "parity-scale-codec", version = "1.3.4", default-features = false }
 
+# Substrate primitives
 sp-core = { version = "2.0.0", default-features = false }
 sp-runtime = { version = "2.0.0", default-features = false }
 sp-runtime-interface = { version = "2.0.0", default-features = false }
@@ -18,7 +19,7 @@ hex = "0.4"
 default = ["std"]
 std = [
     "codec/std",
-
+    # Substrate primitives
     "sp-core/std",
     "sp-runtime/std",
     "sp-runtime-interface/std",

diff --git a/primitives/mining/common/Cargo.toml b/primitives/mining/common/Cargo.toml
@@ -6,18 +6,20 @@ edition = "2018"
 
 [dependencies]
 # Substrate primitives
-sp-std = { version = "2.0.0", default-features = false }
-sp-runtime = { version = "2.0.0", default-features = false }
 sp-arithmetic = { version = "2.0.0", default-features = false }
+sp-runtime = { version = "2.0.0", default-features = false }
+sp-std = { version = "2.0.0", default-features = false }
 
 # ChainX primitives
 chainx-primitives = { path = "../../../primitives", default-features = false }
 
 [features]
 default = ["std"]
 std = [
-    "sp-std/std",
+    # Substrate primitives
+    "sp-arithmetic/std",
     "sp-runtime/std",
-
+    "sp-std/std",
+    # ChainX primitives
     "chainx-primitives/std",
 ]
diff --git a/primitives/mining/staking/Cargo.toml b/primitives/mining/staking/Cargo.toml
@@ -6,8 +6,8 @@ edition = "2018"
 
 [dependencies]
 # Substrate primitives
-sp-std = { version = "2.0.0", default-features = false }
 sp-runtime = { version = "2.0.0", default-features = false }
+sp-std = { version = "2.0.0", default-features = false }
 
 # ChainX primitives
 chainx-primitives = { path = "../../../primitives", default-features = false }
@@ -16,9 +16,10 @@ xp-mining-common = { path = "../common", default-features = false }
 [features]
 default = ["std"]
 std = [
-    "sp-std/std",
+    # Substrate primitives
     "sp-runtime/std",
-
+    "sp-std/std",
+    # ChainX primitives
     "chainx-primitives/std",
     "xp-mining-common/std",
 ]
diff --git a/primitives/protocol/Cargo.toml b/primitives/protocol/Cargo.toml
@@ -6,7 +6,7 @@ edition = "2018"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "1.3.4", features = ["derive"], default-features = false }
-serde = { version = "1.0", optional = true }
+serde = { version = "1.0", features = ["derive"], optional = true }
 
 # Substrate primitives
 sp-runtime = { version = "2.0.0", default-features = false }

diff --git a/primitives/runtime/Cargo.toml b/primitives/runtime/Cargo.toml
@@ -8,6 +8,7 @@ edition = "2018"
 codec = { package = "parity-scale-codec", version = "1.3.4", default-features = false }
 serde = { version = "1.0.101", optional = true, features = ["derive"] }
 
+# Substrate primitives
 sp-core = { version = "2.0.0", default-features = false }
 sp-runtime = { version = "2.0.0", default-features = false }
 sp-std = { version = "2.0.0", default-features = false }
@@ -20,7 +21,7 @@ default = ["std"]
 std = [
     "codec/std",
     "serde/std",
-
+    # Substrate primitives
     "sp-core/std",
     "sp-runtime/std",
     "sp-std/std",

diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml
@@ -6,7 +6,7 @@ edition = "2018"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "1.3.4", features = ["derive"] }
-jsonrpc-core = { version = "15.0.0", features = ["arbitrary_precision"] }
+jsonrpc-core = "15.0.0"
 jsonrpc-pubsub = "15.0.0"
 
 # Substrate client

diff --git a/rpc/src/lib.rs b/rpc/src/lib.rs
@@ -21,6 +21,9 @@ use sp_transaction_pool::TransactionPool;
 use chainx_primitives::Block;
 use chainx_runtime::{AccountId, Balance, BlockNumber, Hash, Index};
 
+use xpallet_mining_asset_rpc_runtime_api::MiningWeight;
+use xpallet_mining_staking_rpc_runtime_api::VoteWeight;
+
 /// Light client extra dependencies.
 pub struct LightDeps<C, F, P> {
     /// The client instance to use.
@@ -89,23 +92,29 @@ where
     C::Api: substrate_frame_rpc_system::AccountNonceApi<Block, AccountId, Index>,
     C::Api: pallet_transaction_payment_rpc::TransactionPaymentRuntimeApi<Block, Balance>,
     C::Api: xpallet_assets_rpc_runtime_api::XAssetsApi<Block, AccountId, Balance>,
-    C::Api:
-        xpallet_mining_staking_rpc_runtime_api::XStakingApi<Block, AccountId, Balance, BlockNumber>,
     C::Api:
         xpallet_dex_spot_rpc_runtime_api::XSpotApi<Block, AccountId, Balance, BlockNumber, Balance>,
-    C::Api: xpallet_mining_asset_rpc_runtime_api::XMiningAssetApi<
+    C::Api: xpallet_gateway_common_rpc_runtime_api::XGatewayCommonApi<Block, AccountId, Balance>,
+    C::Api: xpallet_gateway_records_rpc_runtime_api::XGatewayRecordsApi<
         Block,
         AccountId,
         Balance,
         BlockNumber,
     >,
-    C::Api: xpallet_gateway_records_rpc_runtime_api::XGatewayRecordsApi<
+    C::Api: xpallet_mining_staking_rpc_runtime_api::XStakingApi<
         Block,
         AccountId,
         Balance,
+        VoteWeight,
+        BlockNumber,
+    >,
+    C::Api: xpallet_mining_asset_rpc_runtime_api::XMiningAssetApi<
+        Block,
+        AccountId,
+        Balance,
+        MiningWeight,
         BlockNumber,
     >,
-    C::Api: xpallet_gateway_common_rpc_runtime_api::XGatewayCommonApi<Block, AccountId, Balance>,
     <C::Api as sp_api::ApiErrorExt>::Error: fmt::Debug,
     P: TransactionPool + 'static,
     SC: SelectChain<Block> + 'static,

diff --git a/runtime/src/lib.rs b/runtime/src/lib.rs
@@ -88,6 +88,8 @@ pub use xpallet_gateway_common::{
     types::{GenericTrusteeIntentionProps, GenericTrusteeSessionInfo, TrusteeInfoConfig},
 };
 pub use xpallet_gateway_records::Withdrawal;
+pub use xpallet_mining_asset::MiningWeight;
+pub use xpallet_mining_staking::VoteWeight;
 
 /// Constant values used within the runtime.
 pub mod constants;
@@ -1224,17 +1226,17 @@ impl_runtime_apis! {
         }
     }
 
-    impl xpallet_mining_staking_rpc_runtime_api::XStakingApi<Block, AccountId, Balance, BlockNumber> for Runtime {
-        fn validators() -> Vec<ValidatorInfo<AccountId, Balance, BlockNumber>> {
+    impl xpallet_mining_staking_rpc_runtime_api::XStakingApi<Block, AccountId, Balance, VoteWeight, BlockNumber> for Runtime {
+        fn validators() -> Vec<ValidatorInfo<AccountId, Balance, VoteWeight, BlockNumber>> {
             XStaking::validators_info()
         }
-        fn validator_info_of(who: AccountId) -> ValidatorInfo<AccountId, Balance, BlockNumber> {
+        fn validator_info_of(who: AccountId) -> ValidatorInfo<AccountId, Balance, VoteWeight, BlockNumber> {
             XStaking::validator_info_of(who)
         }
         fn staking_dividend_of(who: AccountId) -> BTreeMap<AccountId, Balance> {
             XStaking::staking_dividend_of(who)
         }
-        fn nomination_details_of(who: AccountId) -> BTreeMap<AccountId, NominatorLedger<Balance, BlockNumber>> {
+        fn nomination_details_of(who: AccountId) -> BTreeMap<AccountId, NominatorLedger<Balance, VoteWeight, BlockNumber>> {
             XStaking::nomination_details_of(who)
         }
         fn nominator_info_of(who: AccountId) -> NominatorInfo<BlockNumber> {
@@ -1256,16 +1258,16 @@ impl_runtime_apis! {
         }
     }
 
-    impl xpallet_mining_asset_rpc_runtime_api::XMiningAssetApi<Block, AccountId, Balance, BlockNumber> for Runtime {
-        fn mining_assets() -> Vec<MiningAssetInfo<AccountId, Balance, BlockNumber>> {
+    impl xpallet_mining_asset_rpc_runtime_api::XMiningAssetApi<Block, AccountId, Balance, MiningWeight, BlockNumber> for Runtime {
+        fn mining_assets() -> Vec<MiningAssetInfo<AccountId, Balance, MiningWeight, BlockNumber>> {
             XMiningAsset::mining_assets()
         }
 
         fn mining_dividend(who: AccountId) -> BTreeMap<AssetId, Balance> {
             XMiningAsset::mining_dividend(who)
         }
 
-        fn miner_ledger(who: AccountId) -> BTreeMap<AssetId, MinerLedger<BlockNumber>> {
+        fn miner_ledger(who: AccountId) -> BTreeMap<AssetId, MinerLedger<MiningWeight, BlockNumber>> {
             XMiningAsset::miner_ledger(who)
         }
     }

diff --git a/scripts/chainx-js/chainx_types_manual.json b/scripts/chainx-js/chainx_types_manual.json
@@ -190,7 +190,7 @@
         "is_chilled": "bool",
         "last_chilled": "Option<BlockNumber>",
         "total": "Balance",
-        "last_total_vote_weight": "WeightType",
+        "last_total_vote_weight": "VoteWeight",
         "last_total_vote_weight_update": "BlockNumber",
         "is_validating": "bool",
         "self_bonded": "Balance",
@@ -213,7 +213,7 @@
     },
     "NominatorLedger": {
         "nomination": "Balance",
-        "last_vote_weight": "WeightType",
+        "last_vote_weight": "VoteWeight",
         "last_vote_weight_update": "BlockNumber",
         "unbonded_chunks": "Vec<Unbonded>"
     },
@@ -222,7 +222,7 @@
         "mining_power": "FixedAssetPower",
         "reward_pot": "AccountId",
         "reward_pot_balance": "Balance",
-        "last_total_mining_weight": "WeightType",
+        "last_total_mining_weight": "MiningWeight",
         "last_total_mining_weight_update": "BlockNumber"
     },
     "Unbonded": {
@@ -239,17 +239,20 @@
         "data": "Vec<RpcOrder>"
     },
     "String": "Text",
+    "Price": "u128",
     "Balance": "u128",
-    "WeightType": "u128",
-    "MiningPower": "u128",
     "MiningWeight": "u128",
+    "VoteWeight": "u128",
+    "RpcPrice": "String",
+    "RpcBalance": "String",
+    "RpcMiningWeight": "String",
+    "RpcVoteWeight": "String",
     "AssetRestrictions":  {
-        "mask": "u32"
+        "bits": "u32"
     },
     "OrderInfo": "Order",
     "HandicapInfo": "Handicap",
     "FullIdentification": "ValidatorId",
-    "Price": "Balance",
     "WithdrawalRecordOf": "WithdrawalRecord",
     "RpcWithdrawalRecord": {
         "asset_id": "AssetId",