Merge pull request #18 from oraichain/fix/charge-relayer-fees-round-tripfees

feat: add round trip relayer fees & refactor code

Author: ducphamle2

contracts/cw-ics20-latest/src/contract.rs

@@ -3,8 +3,8 @@ use std::vec;
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    from_binary, to_binary, Addr, Binary, Deps, DepsMut, Empty, Env, IbcEndpoint, IbcQuery,
-    MessageInfo, Order, PortIdResponse, Response, StdError, StdResult, Storage, Uint128,
+    from_binary, to_binary, Addr, Binary, CosmosMsg, Deps, DepsMut, Empty, Env, IbcEndpoint,
+    IbcQuery, MessageInfo, Order, PortIdResponse, Response, StdError, StdResult, Storage, Uint128,
 };
 use cw2::set_contract_version;
 use cw20::{Cw20Coin, Cw20ReceiveMsg};
@@ -14,9 +14,7 @@ use oraiswap::asset::AssetInfo;
 use oraiswap::router::RouterController;
 
 use crate::error::ContractError;
-use crate::ibc::{
-    build_ibc_send_packet, collect_fee_msgs, parse_voucher_denom, process_deduct_fee,
-};
+use crate::ibc::{build_ibc_send_packet, parse_voucher_denom, process_deduct_fee};
 use crate::msg::{
     AllowMsg, AllowedInfo, AllowedResponse, ChannelResponse, ChannelWithKeyResponse,
     ConfigResponse, DeletePairMsg, ExecuteMsg, InitMsg, ListAllowedResponse, ListChannelsResponse,
@@ -26,8 +24,8 @@ use crate::msg::{
 use crate::state::{
     get_key_ics20_ibc_denom, ics20_denoms, increase_channel_balance, override_channel_balance,
     reduce_channel_balance, AllowInfo, Config, MappingMetadata, RelayerFee, ReplyArgs, TokenFee,
-    ADMIN, ALLOW_LIST, CHANNEL_INFO, CHANNEL_REVERSE_STATE, CONFIG, RELAYER_FEE,
-    RELAYER_FEE_ACCUMULATOR, REPLY_ARGS, SINGLE_STEP_REPLY_ARGS, TOKEN_FEE, TOKEN_FEE_ACCUMULATOR,
+    ADMIN, ALLOW_LIST, CHANNEL_INFO, CHANNEL_REVERSE_STATE, CONFIG, RELAYER_FEE, REPLY_ARGS,
+    SINGLE_STEP_REPLY_ARGS, TOKEN_FEE,
 };
 use cw20_ics20_msg::amount::{convert_local_to_remote, Amount};
 use cw_utils::{maybe_addr, nonpayable, one_coin};
@@ -458,7 +456,7 @@ pub fn execute_transfer_back_to_remote_chain(
         .ok_or(ContractError::MappingPairNotFound {})?;
 
     // if found mapping, then deduct fee based on mapping
-    let (new_deducted_amount, token_fee, relayer_fee) = process_deduct_fee(
+    let fee_data = process_deduct_fee(
         deps.storage,
         &deps.querier,
         deps.api,
@@ -469,6 +467,40 @@ pub fn execute_transfer_back_to_remote_chain(
         &config.swap_router_contract,
     )?;
 
+    let mut cosmos_msgs: Vec<CosmosMsg> = vec![];
+    if !fee_data.token_fee.is_empty() {
+        cosmos_msgs.push(
+            fee_data
+                .token_fee
+                .send_amount(config.token_fee_receiver.into_string(), None),
+        )
+    }
+    if !fee_data.relayer_fee.is_empty() {
+        cosmos_msgs.push(
+            fee_data
+                .relayer_fee
+                .send_amount(config.relayer_fee_receiver.into_string(), None),
+        )
+    }
+
+    // send response
+    let token_fee_str = fee_data.token_fee.amount().to_string();
+    let relayer_fee_str = fee_data.relayer_fee.amount().to_string();
+    let attributes = vec![
+        ("action", "transfer_back_to_remote_chain"),
+        ("sender", sender.as_str()),
+        ("receiver", &msg.remote_address),
+        ("token_fee", &token_fee_str),
+        ("relayer_fee", &relayer_fee_str),
+    ];
+
+    // if our fees have drained the initial amount entirely, then we just get all the fees and that's it
+    if fee_data.deducted_amount.is_zero() {
+        return Ok(Response::new()
+            .add_messages(cosmos_msgs)
+            .add_attributes(attributes));
+    }
+
     let ibc_denom = mapping.key;
     // ensure the requested channel is registered
     if !CHANNEL_INFO.has(deps.storage, &msg.local_channel_id) {
@@ -486,7 +518,7 @@ pub fn execute_transfer_back_to_remote_chain(
     let timeout = env.block.time.plus_seconds(timeout_delta);
     // need to convert decimal of cw20 to remote decimal before transferring
     let amount_remote = convert_local_to_remote(
-        new_deducted_amount,
+        fee_data.deducted_amount,
         mapping.pair_mapping.remote_decimals,
         mapping.pair_mapping.asset_info_decimals,
     )?;
@@ -510,30 +542,14 @@ pub fn execute_transfer_back_to_remote_chain(
         &msg.local_channel_id,
         timeout.into(),
     )?;
-
-    let mut cosmos_msgs = collect_fee_msgs(
-        deps.storage,
-        config.token_fee_receiver.into_string(),
-        TOKEN_FEE_ACCUMULATOR,
-    )?;
-    cosmos_msgs.push(ibc_msg.into());
-    cosmos_msgs.append(&mut collect_fee_msgs(
-        deps.storage,
-        config.relayer_fee_receiver.into_string(),
-        RELAYER_FEE_ACCUMULATOR,
-    )?);
-
-    // send response
-    let res = Response::new()
+    Ok(Response::new()
         .add_messages(cosmos_msgs)
-        .add_attribute("action", "transfer_back_to_remote_chain")
-        .add_attribute("sender", sender.as_str())
-        .add_attribute("receiver", &msg.remote_address)
-        .add_attribute("denom", &ibc_denom)
-        .add_attribute("amount", &amount_remote.to_string())
-        .add_attribute("token_fee", token_fee)
-        .add_attribute("relayer_fee", relayer_fee);
-    Ok(res)
+        .add_message(ibc_msg)
+        .add_attributes(attributes)
+        .add_attributes(vec![
+            ("denom", &ibc_denom),
+            ("amount", &amount_remote.to_string()),
+        ]))
 }
 
 /// The gov contract can allow new contracts, or increase the gas limit on existing contracts.
@@ -642,19 +658,19 @@ pub fn execute_delete_mapping_pair(
 }
 
 #[entry_point]
-pub fn migrate(deps: DepsMut, _env: Env, msg: MigrateMsg) -> Result<Response, ContractError> {
+pub fn migrate(deps: DepsMut, _env: Env, _msg: MigrateMsg) -> Result<Response, ContractError> {
     // we don't need to save anything if migrating from the same version
-    CONFIG.save(
-        deps.storage,
-        &Config {
-            default_timeout: msg.default_timeout,
-            default_gas_limit: msg.default_gas_limit,
-            fee_denom: msg.fee_denom,
-            swap_router_contract: RouterController(msg.swap_router_contract),
-            token_fee_receiver: deps.api.addr_validate(&msg.token_fee_receiver)?,
-            relayer_fee_receiver: deps.api.addr_validate(&msg.relayer_fee_receiver)?,
-        },
-    )?;
+    // CONFIG.save(
+    //     deps.storage,
+    //     &Config {
+    //         default_timeout: msg.default_timeout,
+    //         default_gas_limit: msg.default_gas_limit,
+    //         fee_denom: msg.fee_denom,
+    //         swap_router_contract: RouterController(msg.swap_router_contract),
+    //         token_fee_receiver: deps.api.addr_validate(&msg.token_fee_receiver)?,
+    //         relayer_fee_receiver: deps.api.addr_validate(&msg.relayer_fee_receiver)?,
+    //     },
+    // )?;
     set_contract_version(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
     Ok(Response::new())
 }
@@ -903,7 +919,7 @@ mod test {
 
     use super::*;
     use crate::ibc::{handle_packet_refund, ibc_packet_receive, Ics20Packet, REFUND_FAILURE_ID};
-    use crate::state::{Ratio, TOKEN_FEE_ACCUMULATOR};
+    use crate::state::Ratio;
     use crate::test_helpers::*;
 
     use cosmwasm_std::testing::{mock_env, mock_info};
@@ -1453,15 +1469,6 @@ mod test {
             }
         );
 
-        // we need to reset fee accumulator because when execute returns error, the test state is still applied
-        TOKEN_FEE_ACCUMULATOR
-            .save(
-                deps.as_mut().storage,
-                "cw20:token-addr",
-                &Uint128::from(0u64),
-            )
-            .unwrap();
-
         // prepare some mock packets
         let recv_packet =
             mock_receive_packet(remote_channel, local_channel, amount, denom, custom_addr);
@@ -1497,7 +1504,7 @@ mod test {
 
         assert_eq!(res.messages[0].gas_limit, None);
         println!("res messages: {:?}", res.messages);
-        assert_eq!(2, res.messages.len()); // 2 because it also has deduct fee msg
+        assert_eq!(res.messages.len(), 2); // 2 because it also has deduct fee msg
         match res.messages[1].msg.clone() {
             CosmosMsg::Ibc(IbcMsg::SendPacket {
                 channel_id,
@@ -1652,15 +1659,6 @@ mod test {
             }
         );
 
-        // we need to reset fee accumulator because when execute returns error, the test state is still applied
-        TOKEN_FEE_ACCUMULATOR
-            .save(
-                deps.as_mut().storage,
-                "cw20:token-addr",
-                &Uint128::from(0u64),
-            )
-            .unwrap();
-
         // prepare some mock packets
         let recv_packet =
             mock_receive_packet(remote_channel, local_channel, amount, denom, custom_addr);

contracts/cw-ics20-latest/src/error.rs

@@ -2,7 +2,7 @@ use std::num::TryFromIntError;
 use std::string::FromUtf8Error;
 use thiserror::Error;
 
-use cosmwasm_std::StdError;
+use cosmwasm_std::{OverflowError, StdError};
 use cw_controllers::AdminError;
 use cw_utils::PaymentError;
 
@@ -15,6 +15,9 @@ pub enum ContractError {
     #[error("{0}")]
     Std(#[from] StdError),
 
+    #[error("{0}")]
+    Overflow(#[from] OverflowError),
+
     #[error("{0}")]
     Payment(#[from] PaymentError),