feat(trading-proto-upgrade): fees fixes among other things

mm2src/coins/lp_coins.rs

@@ -1259,6 +1259,8 @@ pub struct SendTakerFundingArgs<'a> {
     pub maker_pub: &'a [u8],
     /// DEX fee
     pub dex_fee: &'a DexFee,
+    /// The extra fee added to the trading volume to cover the taker payment transaction fees
+    pub taker_payment_fee: BigDecimal,
     /// Additional reward for maker (premium)
     pub premium_amount: BigDecimal,
     /// Actual volume of taker's payment
@@ -1280,7 +1282,7 @@ pub struct RefundFundingSecretArgs<'a, Coin: ParseCoinAssocTypes + ?Sized> {
 }
 
 /// Helper struct wrapping arguments for [TakerCoinSwapOpsV2::gen_taker_funding_spend_preimage]
-pub struct GenTakerFundingSpendArgs<'a, Coin: ParseCoinAssocTypes + ?Sized> {
+pub struct GenTakerPaymentPreimageArgs<'a, Coin: ParseCoinAssocTypes + ?Sized> {
     /// Taker payment transaction serialized to raw bytes
     pub funding_tx: &'a Coin::Tx,
     /// Maker's pubkey
@@ -1295,6 +1297,8 @@ pub struct GenTakerFundingSpendArgs<'a, Coin: ParseCoinAssocTypes + ?Sized> {
     pub taker_payment_time_lock: u64,
     /// The hash of the secret generated by maker
     pub maker_secret_hash: &'a [u8],
+    /// The extra fee added to the trading volume to cover the taker payment transaction fees
+    pub taker_payment_fee: BigDecimal,
 }
 
 /// Helper struct wrapping arguments for [TakerCoinSwapOpsV2::validate_taker_funding]
@@ -1309,6 +1313,8 @@ pub struct ValidateTakerFundingArgs<'a, Coin: ParseCoinAssocTypes + ?Sized> {
     pub other_pub: &'a Coin::Pubkey,
     /// DEX fee amount
     pub dex_fee: &'a DexFee,
+    /// The extra fee added to the trading volume to cover the taker payment transaction fees
+    pub taker_payment_fee: BigDecimal,
     /// Additional reward for maker (premium)
     pub premium_amount: BigDecimal,
     /// Actual volume of taker's payment
@@ -1417,6 +1423,8 @@ impl From<UtxoRpcError> for ValidateSwapV2TxError {
 /// Enum covering error cases that can happen during taker funding spend preimage validation.
 #[derive(Debug, Display, EnumFromStringify)]
 pub enum ValidateTakerFundingSpendPreimageError {
+    /// Error during conversion of BigDecimal amount to coin's specific monetary units (satoshis, wei, etc.).
+    NumConversion(String),
     /// Funding tx has no outputs
     FundingTxNoOutputs,
     /// Actual preimage fee is either too high or too small
@@ -1437,6 +1445,10 @@ pub enum ValidateTakerFundingSpendPreimageError {
     Rpc(String),
 }
 
+impl From<NumConversError> for ValidateTakerFundingSpendPreimageError {
+    fn from(err: NumConversError) -> Self { ValidateTakerFundingSpendPreimageError::NumConversion(err.to_string()) }
+}
+
 impl From<TxGenError> for ValidateTakerFundingSpendPreimageError {
     fn from(err: TxGenError) -> Self { ValidateTakerFundingSpendPreimageError::TxGenError(format!("{:?}", err)) }
 }
@@ -1667,6 +1679,12 @@ pub trait MakerCoinSwapOpsV2: ParseCoinAssocTypes + Send + Sync + 'static {
 
     /// Spend maker payment transaction
     async fn spend_maker_payment_v2(&self, args: SpendMakerPaymentArgs<'_, Self>) -> Result<Self::Tx, TransactionErr>;
+
+    /// Get the fee to be paid for the processing of the maker payment transaction.
+    async fn get_maker_payment_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee>;
+
+    /// Get the fee to be paid for the processing of the maker payment spend transaction aka the claimation transaction.
+    async fn get_maker_payment_spend_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee>;
 }
 
 #[async_trait]
@@ -1809,24 +1827,24 @@ pub trait TakerCoinSwapOpsV2: ParseCoinAssocTypes + Send + Sync + 'static {
     ) -> Result<Option<FundingTxSpend<Self>>, SearchForFundingSpendErr>;
 
     /// Generates and signs a preimage spending funding tx to the combined taker payment
-    async fn gen_taker_funding_spend_preimage(
+    async fn gen_taker_payment_preimage(
         &self,
-        args: &GenTakerFundingSpendArgs<'_, Self>,
+        args: &GenTakerPaymentPreimageArgs<'_, Self>,
         swap_unique_data: &[u8],
     ) -> GenPreimageResult<Self>;
 
     /// Validates taker funding spend preimage generated and signed by maker
-    async fn validate_taker_funding_spend_preimage(
+    async fn validate_taker_payment_preimage(
         &self,
-        gen_args: &GenTakerFundingSpendArgs<'_, Self>,
+        gen_args: &GenTakerPaymentPreimageArgs<'_, Self>,
         preimage: &TxPreimageWithSig<Self>,
     ) -> ValidateTakerFundingSpendPreimageResult;
 
     /// Generates and signs a preimage spending funding tx to the combined taker payment
-    async fn sign_and_send_taker_funding_spend(
+    async fn sign_and_send_taker_payment(
         &self,
         preimage: &TxPreimageWithSig<Self>,
-        args: &GenTakerFundingSpendArgs<'_, Self>,
+        args: &GenTakerPaymentPreimageArgs<'_, Self>,
         swap_unique_data: &[u8],
     ) -> Result<Self::Tx, TransactionErr>;
 
@@ -1867,6 +1885,25 @@ pub trait TakerCoinSwapOpsV2: ParseCoinAssocTypes + Send + Sync + 'static {
 
     /// Derives an HTLC key-pair and returns a public key corresponding to that key.
     fn derive_htlc_pubkey_v2(&self, swap_unique_data: &[u8]) -> Self::Pubkey;
+
+    /// Get the fee to be paid for the processing of the funding transaction.
+    /// Txs in success case (no refund) go as follows:
+    ///    Chain A: funding -> taker payment -> taker payment spend (aka preimage) (to the maker & dex)
+    ///    Chain B:            maker payment -> maker payment spend (aka claimation) (to the taker)
+    async fn get_funding_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee>;
+
+    /// Get the fee to be paid for the processing of the funding-spend transaction aka taker payment transaction.
+    ///
+    /// Don't use this method, use [TakerCoinSwapOpsV2::get_taker_payment_fee] instead.
+    async fn get_funding_spend_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee> {
+        self.get_taker_payment_fee(stage).await
+    }
+
+    /// Get the fee to be paid for the processing of the taker payment transaction.
+    async fn get_taker_payment_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee>;
+
+    /// Get the fee to be paid for the processing of the taker payment spend transaction aka the preimage transaction.
+    async fn get_taker_payment_spend_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee>;
 }
 
 /// Operations that coins have independently from the MarketMaker.

mm2src/coins/test_coin.rs

@@ -5,7 +5,7 @@ use super::{CoinBalance, FundingTxSpend, HistorySyncState, MarketCoinOps, MmCoin
             WaitForTakerPaymentSpendError};
 use crate::coin_errors::ValidatePaymentResult;
 use crate::{coin_errors::MyAddressError, BalanceFut, CanRefundHtlc, CheckIfMyPaymentSentArgs, CoinFutSpawner,
-            ConfirmPaymentInput, FeeApproxStage, FoundSwapTxSpend, GenPreimageResult, GenTakerFundingSpendArgs,
+            ConfirmPaymentInput, FeeApproxStage, FoundSwapTxSpend, GenPreimageResult, GenTakerPaymentPreimageArgs,
             GenTakerPaymentSpendArgs, MakerSwapTakerCoin, MmCoinEnum, NegotiateSwapContractAddrErr,
             ParseCoinAssocTypes, PaymentInstructionArgs, PaymentInstructions, PaymentInstructionsErr,
             RawTransactionResult, RefundFundingSecretArgs, RefundPaymentArgs, RefundResult, SearchForSwapTxSpendInput,
@@ -492,26 +492,26 @@ impl TakerCoinSwapOpsV2 for TestCoin {
         todo!()
     }
 
-    async fn gen_taker_funding_spend_preimage(
+    async fn gen_taker_payment_preimage(
         &self,
-        args: &GenTakerFundingSpendArgs<'_, Self>,
+        args: &GenTakerPaymentPreimageArgs<'_, Self>,
         swap_unique_data: &[u8],
     ) -> GenPreimageResult<Self> {
         todo!()
     }
 
-    async fn validate_taker_funding_spend_preimage(
+    async fn validate_taker_payment_preimage(
         &self,
-        gen_args: &GenTakerFundingSpendArgs<'_, Self>,
+        gen_args: &GenTakerPaymentPreimageArgs<'_, Self>,
         preimage: &TxPreimageWithSig<Self>,
     ) -> ValidateTakerFundingSpendPreimageResult {
         todo!()
     }
 
-    async fn sign_and_send_taker_funding_spend(
+    async fn sign_and_send_taker_payment(
         &self,
         preimage: &TxPreimageWithSig<Self>,
-        args: &GenTakerFundingSpendArgs<'_, Self>,
+        args: &GenTakerPaymentPreimageArgs<'_, Self>,
         swap_unique_data: &[u8],
     ) -> Result<Self::Tx, TransactionErr> {
         todo!()
@@ -557,4 +557,10 @@ impl TakerCoinSwapOpsV2 for TestCoin {
     }
 
     fn derive_htlc_pubkey_v2(&self, swap_unique_data: &[u8]) -> Self::Pubkey { todo!() }
+
+    async fn get_funding_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee> { todo!() }
+
+    async fn get_taker_payment_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee> { todo!() }
+
+    async fn get_taker_payment_spend_fee(&self, stage: &FeeApproxStage) -> TradePreimageResult<TradeFee> { todo!() }
 }

mm2src/coins/utxo.rs

@@ -551,7 +551,7 @@ pub struct UtxoCoinConf {
     /// Address and privkey checksum type
     pub checksum_type: ChecksumType,
     /// Fork id used in sighash
-    pub fork_id: u32,
+    pub fork_id: u8,
     /// Signature version
     pub signature_version: SignatureVersion,
     pub required_confirmations: AtomicU64,

mm2src/coins/utxo/qtum.rs

@@ -1018,7 +1018,7 @@ impl UtxoSignerOps for QtumCoin {
             })
     }
 
-    fn fork_id(&self) -> u32 { self.utxo_arc.conf.fork_id }
+    fn fork_id(&self) -> u8 { self.utxo_arc.conf.fork_id }
 
     fn branch_id(&self) -> u32 { self.utxo_arc.conf.consensus_branch_id }
 

mm2src/coins/utxo/utxo_builder/utxo_conf_builder.rs

@@ -34,6 +34,8 @@ pub enum UtxoConfError {
     InvalidVersionGroupId(String),
     InvalidAddressFormat(String),
     InvalidDecimals(String),
+    #[display(fmt = "Invalid fork id: {}, valid fork ids are values between 0x00 - 0xff", _0)]
+    InvalidForkId(String),
 }
 
 impl From<Bip32Error> for UtxoConfError {
@@ -91,8 +93,8 @@ impl<'a> UtxoConfBuilder<'a> {
         let tx_fee_volatility_percent = self.tx_fee_volatility_percent();
         let version_group_id = self.version_group_id(tx_version, overwintered)?;
         let consensus_branch_id = self.consensus_branch_id(tx_version)?;
-        let signature_version = self.signature_version();
-        let fork_id = self.fork_id();
+        let signature_version = self.signature_version()?;
+        let fork_id = self.fork_id()?;
 
         // should be sufficient to detect zcash by overwintered flag
         let zcash = overwintered;
@@ -244,23 +246,23 @@ impl<'a> UtxoConfBuilder<'a> {
         Ok(consensus_branch_id)
     }
 
-    fn signature_version(&self) -> SignatureVersion {
-        let default_signature_version = if self.ticker == "BCH" || self.fork_id() != 0 {
+    fn signature_version(&self) -> UtxoConfResult<SignatureVersion> {
+        let default_signature_version = if self.ticker == "BCH" || self.fork_id()? != 0 {
             SignatureVersion::ForkId
         } else {
             SignatureVersion::Base
         };
-        json::from_value(self.conf["signature_version"].clone()).unwrap_or(default_signature_version)
+        Ok(json::from_value(self.conf["signature_version"].clone()).unwrap_or(default_signature_version))
     }
 
-    fn fork_id(&self) -> u32 {
+    fn fork_id(&self) -> UtxoConfResult<u8> {
         let default_fork_id = match self.ticker {
             "BCH" => "0x40",
             _ => "0x0",
         };
         let hex_string = self.conf["fork_id"].as_str().unwrap_or(default_fork_id);
-        let fork_id = u32::from_str_radix(hex_string.trim_start_matches("0x"), 16).unwrap();
-        fork_id
+        u8::from_str_radix(hex_string.trim_start_matches("0x"), 16)
+            .map_to_mm(|e| UtxoConfError::InvalidForkId(e.to_string()))
     }
 
     fn required_confirmations(&self) -> u64 {