feat(tron): initial groundwork for full TRON integration

mm2src/coins/Cargo.toml

@@ -23,11 +23,13 @@ doctest = false
 async-std = { version = "1.5", features = ["unstable"] }
 async-trait = "0.1.52"
 base64 = "0.21.2"
+# Todo: remove this and rely on bs58 throught the whole codebase
 base58 = "0.2.0"
 bip32 = { version = "0.2.2", default-features = false, features = ["alloc", "secp256k1-ffi"] }
 bitcoin_hashes = "0.11"
 bitcrypto = { path = "../mm2_bitcoin/crypto" }
 blake2b_simd = { version = "0.5.10", optional = true }
+bs58 = "0.4.0"
 byteorder = "1.3"
 bytes = "0.4"
 cfg-if = "1.0"

mm2src/coins/eth.rs

@@ -158,6 +158,9 @@ use fee_estimation::eip1559::{block_native::BlocknativeGasApiCaller, infura::Inf
 
 pub mod erc20;
 use erc20::get_token_decimals;
+
+pub mod tron;
+
 pub(crate) mod eth_swap_v2;
 use eth_swap_v2::{extract_id_from_tx_data, EthPaymentType, PaymentMethod, SpendTxSearchParams};
 
@@ -762,6 +765,30 @@ struct SavedErc20Events {
     latest_block: U64,
 }
 
+/// Specifies which blockchain the EthCoin operates on: EVM-compatible or TRON.
+/// This distinction allows unified logic for EVM & TRON coins.
+#[derive(Clone, Debug)]
+pub enum ChainSpec {
+    Evm { chain_id: u64 },
+    Tron { network: tron::Network },
+}
+
+impl ChainSpec {
+    pub fn chain_id(&self) -> Option<u64> {
+        match self {
+            ChainSpec::Evm { chain_id } => Some(*chain_id),
+            ChainSpec::Tron { .. } => None,
+        }
+    }
+
+    pub fn kind(&self) -> &'static str {
+        match self {
+            ChainSpec::Evm { .. } => "EVM",
+            ChainSpec::Tron { .. } => "TRON",
+        }
+    }
+}
+
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum EthCoinType {
     /// Ethereum itself or it's forks: ETC/others
@@ -816,6 +843,8 @@ impl From<PrivKeyBuildPolicy> for EthPrivKeyBuildPolicy {
 pub struct EthCoinImpl {
     ticker: String,
     pub coin_type: EthCoinType,
+    /// Specifies the underlying blockchain (EVM or TRON).
+    pub chain_spec: ChainSpec,
     pub(crate) priv_key_policy: EthPrivKeyPolicy,
     /// Either an Iguana address or a 'EthHDWallet' instance.
     /// Arc is used to use the same hd wallet from platform coin if we need to.
@@ -836,7 +865,6 @@ pub struct EthCoinImpl {
     /// Coin needs access to the context in order to reuse the logging and shutdown facilities.
     /// Using a weak reference by default in order to avoid circular references and leaks.
     pub ctx: MmWeak,
-    chain_id: u64,
     /// The name of the coin with which Trezor wallet associates this asset.
     trezor_coin: Option<String>,
     /// the block range used for eth_getLogs
@@ -1043,7 +1071,7 @@ impl EthCoinImpl {
     }
 
     #[inline(always)]
-    pub fn chain_id(&self) -> u64 { self.chain_id }
+    pub fn chain_id(&self) -> Option<u64> { self.chain_spec.chain_id() }
 }
 
 async fn get_raw_transaction_impl(coin: EthCoin, req: RawTransactionRequest) -> RawTransactionResult {
@@ -1161,7 +1189,16 @@ pub async fn withdraw_erc1155(ctx: MmArc, withdraw_type: WithdrawErc1155) -> Wit
         .build()
         .map_to_mm(|e| WithdrawError::InternalError(e.to_string()))?;
     let secret = eth_coin.priv_key_policy.activated_key_or_err()?.secret();
-    let signed = tx.sign(secret, Some(eth_coin.chain_id))?;
+    let chain_id = match eth_coin.chain_spec {
+        ChainSpec::Evm { chain_id } => chain_id,
+        // Todo: Add support for Tron NFTs
+        ChainSpec::Tron { .. } => {
+            return MmError::err(WithdrawError::InternalError(
+                "Tron is not supported for withdraw_erc1155 yet".to_owned(),
+            ))
+        },
+    };
+    let signed = tx.sign(secret, Some(chain_id))?;
     let signed_bytes = rlp::encode(&signed);
     let fee_details = EthTxFeeDetails::new(gas, pay_for_gas_option, fee_coin)?;
 
@@ -1252,7 +1289,16 @@ pub async fn withdraw_erc721(ctx: MmArc, withdraw_type: WithdrawErc721) -> Withd
         .build()
         .map_to_mm(|e| WithdrawError::InternalError(e.to_string()))?;
     let secret = eth_coin.priv_key_policy.activated_key_or_err()?.secret();
-    let signed = tx.sign(secret, Some(eth_coin.chain_id))?;
+    let chain_id = match eth_coin.chain_spec {
+        ChainSpec::Evm { chain_id } => chain_id,
+        // Todo: Add support for Tron NFTs
+        ChainSpec::Tron { .. } => {
+            return MmError::err(WithdrawError::InternalError(
+                "Tron is not supported for withdraw_erc721 yet".to_owned(),
+            ))
+        },
+    };
+    let signed = tx.sign(secret, Some(chain_id))?;
     let signed_bytes = rlp::encode(&signed);
     let fee_details = EthTxFeeDetails::new(gas, pay_for_gas_option, fee_coin)?;
 
@@ -2639,9 +2685,18 @@ async fn sign_transaction_with_keypair<'a>(
     let tx_builder = tx_builder_with_pay_for_gas_option(coin, tx_builder, pay_for_gas_option)
         .map_err(|e| TransactionErr::Plain(e.get_inner().to_string()))?;
     let tx = tx_builder.build()?;
+    let chain_id = match coin.chain_spec {
+        ChainSpec::Evm { chain_id } => chain_id,
+        // Todo: Add Tron signing logic
+        ChainSpec::Tron { .. } => {
+            return Err(TransactionErr::Plain(
+                "Tron is not supported for sign_transaction_with_keypair yet".into(),
+            ))
+        },
+    };
 
     Ok((
-        tx.sign(key_pair.secret(), Some(coin.chain_id))?,
+        tx.sign(key_pair.secret(), Some(chain_id))?,
         web3_instances_with_latest_nonce,
     ))
 }
@@ -6403,7 +6458,7 @@ pub async fn eth_coin_from_conf_and_request(
     }
 
     let (coin_type, decimals) = match protocol {
-        CoinProtocol::ETH => (EthCoinType::Eth, ETH_DECIMALS),
+        CoinProtocol::ETH { .. } => (EthCoinType::Eth, ETH_DECIMALS),
         CoinProtocol::ERC20 {
             platform,
             contract_address,
@@ -6444,6 +6499,8 @@ pub async fn eth_coin_from_conf_and_request(
 
     let sign_message_prefix: Option<String> = json::from_value(conf["sign_message_prefix"].clone()).unwrap_or(None);
 
+    // Todo: write documentation note about this
+    // Kept only for v1 activation but should be removed in time, needed for both ETH and ERC20
     let chain_id = try_s!(conf["chain_id"]
         .as_u64()
         .ok_or_else(|| format!("chain_id is not set for {}", ticker)));
@@ -6480,6 +6537,8 @@ pub async fn eth_coin_from_conf_and_request(
         priv_key_policy: key_pair,
         derivation_method: Arc::new(derivation_method),
         coin_type,
+        // Tron is not supported for v1 activation
+        chain_spec: ChainSpec::Evm { chain_id },
         sign_message_prefix,
         swap_contract_address,
         swap_v2_contracts: None,
@@ -6493,7 +6552,6 @@ pub async fn eth_coin_from_conf_and_request(
         max_eth_tx_type,
         ctx: ctx.weak(),
         required_confirmations,
-        chain_id,
         trezor_coin,
         logs_block_range: conf["logs_block_range"].as_u64().unwrap_or(DEFAULT_LOGS_BLOCK_RANGE),
         address_nonce_locks,
@@ -6782,6 +6840,8 @@ fn calc_total_fee(gas: U256, pay_for_gas_option: &PayForGasOption) -> NumConvers
     }
 }
 
+// Todo: Tron have a different concept from gas (Energy, Bandwidth and Free Transaction), it should be added as a different function
+// and this should be part of a trait abstracted over both types
 #[allow(clippy::result_large_err)]
 fn tx_builder_with_pay_for_gas_option(
     eth_coin: &EthCoin,
@@ -6793,9 +6853,14 @@ fn tx_builder_with_pay_for_gas_option(
         PayForGasOption::Eip1559(Eip1559FeePerGas {
             max_priority_fee_per_gas,
             max_fee_per_gas,
-        }) => tx_builder
-            .with_priority_fee_per_gas(max_fee_per_gas, max_priority_fee_per_gas)
-            .with_chain_id(eth_coin.chain_id),
+        }) => {
+            let chain_id = eth_coin
+                .chain_id()
+                .ok_or_else(|| WithdrawError::InternalError("chain_id should be set for an EVM coin".to_string()))?;
+            tx_builder
+                .with_priority_fee_per_gas(max_fee_per_gas, max_priority_fee_per_gas)
+                .with_chain_id(chain_id)
+        },
     };
     Ok(tx_builder)
 }
@@ -7299,6 +7364,7 @@ impl EthCoin {
         let coin = EthCoinImpl {
             ticker: self.ticker.clone(),
             coin_type: new_coin_type,
+            chain_spec: self.chain_spec.clone(),
             priv_key_policy: self.priv_key_policy.clone(),
             derivation_method: Arc::clone(&self.derivation_method),
             sign_message_prefix: self.sign_message_prefix.clone(),
@@ -7315,7 +7381,6 @@ impl EthCoin {
             swap_txfee_policy: Mutex::new(self.swap_txfee_policy.lock().unwrap().clone()),
             max_eth_tx_type: self.max_eth_tx_type,
             ctx: self.ctx.clone(),
-            chain_id: self.chain_id,
             trezor_coin: self.trezor_coin.clone(),
             logs_block_range: self.logs_block_range,
             address_nonce_locks: Arc::clone(&self.address_nonce_locks),