feat(kusama-asset-hub): Add ability to force to use ChargeAssetTxPayment (#4541)

* feat(kusama-asset-hub): Add ability to force to use `ChargeAssetTxPayment` for native tip

* feat(kusama-asset-hub): Add a unit test

Author: satoshiotomakan

rust/chains/tw_polkadot/src/entry.rs

@@ -56,7 +56,7 @@ impl PolkadotEntry {
         builder.extension(CheckEra { era, current_hash });
         builder.extension(CheckNonce::new(input.nonce as u32));
         if let Some(fee_asset_id) = ctx.fee_asset_id {
-            builder.extension(ChargeAssetTxPayment::new(tip, fee_asset_id));
+            builder.extension(ChargeAssetTxPayment::new(tip, fee_asset_id.as_u32()));
         } else {
             builder.extension(ChargeTransactionPayment::new(tip));
         }

rust/chains/tw_polkadot/src/lib.rs

@@ -25,15 +25,22 @@ pub fn network_id_from_tw(input: &'_ Proto::SigningInput<'_>) -> EncodeResult<Ne
     Ok(NetworkId::try_from(input.network as u16).map_err(|_| EncodeError::InvalidNetworkId)?)
 }
 
-pub fn fee_asset_id_from_tw(input: &'_ Proto::SigningInput<'_>) -> Option<u32> {
+pub fn fee_asset_id_from_tw(input: &'_ Proto::SigningInput<'_>) -> Option<FeeAssetId> {
     // Special case for batches.
-    match &input.message_oneof {
-        SigningVariant::balance_call(b) => match &b.message_oneof {
-            BalanceVariant::asset_transfer(at) => Some(at.fee_asset_id),
-            BalanceVariant::batch_asset_transfer(bat) => Some(bat.fee_asset_id),
-            _ => None,
-        },
-        _ => None,
+    if let SigningVariant::balance_call(b) = &input.message_oneof {
+        match &b.message_oneof {
+            BalanceVariant::asset_transfer(at) => return Some(FeeAssetId::Asset(at.fee_asset_id)),
+            BalanceVariant::batch_asset_transfer(bat) => {
+                return Some(FeeAssetId::Asset(bat.fee_asset_id))
+            },
+            _ => {},
+        }
+    }
+
+    if input.charge_native_as_asset_tx_payment {
+        Some(FeeAssetId::Native)
+    } else {
+        None
     }
 }
 

rust/frameworks/tw_substrate/src/lib.rs

@@ -44,14 +44,29 @@ impl From<EncodeError> for SigningErrorType {
 pub type EncodeResult<T> = Result<T, TWError<EncodeError>>;
 pub type WithCallIndexResult<T> = Result<WithCallIndex<T>, TWError<EncodeError>>;
 
+#[derive(Debug, Clone)]
+pub enum FeeAssetId {
+    Native,
+    Asset(u32),
+}
+
+impl FeeAssetId {
+    pub fn as_u32(&self) -> u32 {
+        match self {
+            FeeAssetId::Native => 0,
+            FeeAssetId::Asset(id) => *id,
+        }
+    }
+}
+
 #[derive(Debug, Clone)]
 pub struct SubstrateContext {
     pub multi_address: bool,
     pub check_metadata: bool,
     pub network: NetworkId,
     pub spec_version: u32,
     pub transaction_version: u32,
-    pub fee_asset_id: Option<u32>,
+    pub fee_asset_id: Option<FeeAssetId>,
 }
 
 impl SubstrateContext {

rust/tw_tests/tests/chains/polkadot/polkadot_sign.rs

@@ -740,6 +740,58 @@ fn test_sign_transfer_kusama_new_spec() {
     assert_eq!(signed.as_deref(), Some("450284009dca538b7a925b8ea979cc546464a3c5f81d2398a3a272f6f93bdf4803f2f78300fc5a463d3b6972ac7e0b701110f9d95d377be5b6a2f356765553104c04765fc0066c235c11dabde650d487760dc310003d607abceaf85a0a0f47f1a90e3680029501590200000400001a2447c661c9b168bba4a2a178baef7d79eee006c1d145ffc832be76ff6ee9ce0300943577"));
 }
 
+#[test]
+fn test_sign_transfer_kusama_asset_hub() {
+    let block_hash = "0xa08d580076533e7262904ea3105c7abb1923e10b4a44c2b8e2121fca23c99d63"
+        .decode_hex()
+        .unwrap();
+    let block_number = 11410063;
+    let genesis_hash = "0x48239ef607d7928874027a43a67689209727dfb3d3dc5e5b03a39bdc2eda771a"
+        .decode_hex()
+        .unwrap();
+    // GtrrH11FcafS3wNr59t5PwZSr94Zatc3nj1dTN1ET3drJ5k
+    let private_key = "f5636ddc5583a9d3f95748328b56f36b5a4197f9b8473c546378eee3648b070f"
+        .decode_hex()
+        .unwrap();
+
+    let input = Proto::SigningInput {
+        network: 2,
+        private_key: private_key.into(),
+        multi_address: false,
+        nonce: 1,
+        block_hash: block_hash.into(),
+        genesis_hash: genesis_hash.into(),
+        spec_version: 1009002,
+        transaction_version: 15,
+        charge_native_as_asset_tx_payment: true,
+        era: Some(Proto::Era {
+            block_number,
+            period: 64,
+        }),
+        message_oneof: balance_call(Proto::mod_Balance::OneOfmessage_oneof::transfer(
+            Proto::mod_Balance::Transfer {
+                to_address: "DrRsYwWQN4QH6RCqyw5xLJbq8V37NodsJjuWKhMhx1GnJm1".into(),
+                value: Cow::Owned(U256::from(90_000_000_000u64).to_big_endian().to_vec()), // 0.09
+                call_indices: Some(Proto::CallIndices {
+                    variant: Proto::mod_CallIndices::OneOfvariant::custom(
+                        Proto::CustomCallIndices {
+                            module_index: 0x0A, // Balances pallet
+                            method_index: 0x00, // transfer_allow_death
+                        },
+                    ),
+                }),
+                ..Default::default()
+            },
+        )),
+        ..Default::default()
+    };
+
+    let (_preimage, signed) = helper_encode_and_maybe_sign(CoinType::Polkadot, input);
+    // Successfully broadcasted tx:
+    // https://assethub-kusama.subscan.io/extrinsic/0xc3dd4b245cbd31ca0b6ea17ad1f7aad12b5984e705da1bee8b127e1d338301a4
+    assert_eq!(signed.as_deref(), Some("49028400bf14d379a6d161a3cfcbb12dc1ae6c9a5e89c9c22924060e8fecab41e6124acf00a26875c8f4f1760319ffaa1a4a44d0841fec3a7d7abf0c820ac931574e18cda960bedbc32886fc9d050b4ebf291db1ded94e6ee55cfb83372cc800fceeacea03f500040000000a000038858d284516bcf0991d66e09c18815afb33c22f1d0d29cf43be56debd5777610700046bf414"));
+}
+
 // TEST(PolkadotExtrinsic, Polkadot_EncodePayloadWithNewSpec)
 #[test]
 fn test_encode_payload_with_new_spec() {

src/proto/Polkadot.proto

@@ -269,6 +269,10 @@ message SigningInput {
     // Whether enable MultiAddress
     bool multi_address = 10;
 
+    // Whether to use `ChargeAssetTxPayment` extrinsic extension instead of `ChargeTransactionPayment`
+    // when paying transaction tip in native chain token.
+    bool charge_native_as_asset_tx_payment = 13;
+
     // Payload message
     oneof message_oneof {
         Balance balance_call = 11;