MP-3528 pass external routes to swapper (#352)

* Init swapper extraction.

* Integrate new swapper logic into CM.

* Revert "Integrate new swapper logic into CM."

This reverts commit 68d3047a00368fe3a95c03effb9d04d4fab0b4cf.

* Pass SwapperRoute from CM (and RC) to Swapper contract.

* Clean swapper aimed to be managed by feature flags.

* Fix tests.

* Make fallback to routes in state if no route provided.

* Update schema.

* Increase number of swaps for TWAP tests.

* Make RC swapping backward compatible. Use state routes if not provided.

* Make swapper params more consistent between Astro and Osmo.

* Add custom config for swapper.

* Update schema.

* Review comments.

* Revert wasm file path.

* Migration.

* Add validation for config.

Author: piobab

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name          = "mars-credit-manager"
-version       = "2.0.1"
+version       = "2.0.2"
 authors       = { workspace = true }
 license       = { workspace = true }
 edition       = { workspace = true }

contracts/credit-manager/Cargo.toml

@@ -128,6 +128,6 @@ pub fn query(deps: Deps, env: Env, msg: QueryMsg) -> ContractResult<Binary> {
 pub fn migrate(deps: DepsMut, env: Env, msg: MigrateMsg) -> ContractResult<Response> {
     match msg {
         MigrateMsg::V1_0_0ToV2_0_0(updates) => migrations::v2_0_0::migrate(deps, env, updates),
-        MigrateMsg::V2_0_0ToV2_0_1 {} => migrations::v2_0_1::migrate(deps),
+        MigrateMsg::V2_0_1ToV2_0_2 {} => migrations::v2_0_2::migrate(deps),
     }
 }

contracts/credit-manager/src/contract.rs

@@ -204,12 +204,14 @@ pub fn dispatch_actions(
                 coin_in,
                 denom_out,
                 slippage,
+                route,
             } => {
                 callbacks.push(CallbackMsg::SwapExactIn {
                     account_id: account_id.to_string(),
                     coin_in,
                     denom_out: denom_out.clone(),
                     slippage,
+                    route,
                 });
                 // check the deposit cap of the swap output denom
                 denoms_for_cap_check.insert(denom_out);
@@ -416,7 +418,8 @@ pub fn execute_callback(
             coin_in,
             denom_out,
             slippage,
-        } => swap_exact_in(deps, env, &account_id, &coin_in, &denom_out, slippage),
+            route,
+        } => swap_exact_in(deps, env, &account_id, &coin_in, &denom_out, slippage, route),
         CallbackMsg::UpdateCoinBalance {
             account_id,
             previous_balance,

contracts/credit-manager/src/execute.rs

@@ -1,2 +1,2 @@
 pub mod v2_0_0;
-pub mod v2_0_1;
+pub mod v2_0_2;

contracts/credit-manager/src/migrations/mod.rs

@@ -6,7 +6,7 @@ use crate::{
     error::ContractError,
 };
 
-const FROM_VERSION: &str = "2.0.0";
+const FROM_VERSION: &str = "2.0.1";
 
 pub fn migrate(deps: DepsMut) -> Result<Response, ContractError> {
     // make sure we're migrating the correct contract and from the correct version

contracts/credit-manager/src/migrations/v2_0_1.rs contracts/credit-manager/src/migrations/v2_0_2.rs

@@ -1,5 +1,8 @@
 use cosmwasm_std::{Coin, Decimal, DepsMut, Env, Response, Uint128};
-use mars_types::credit_manager::{ActionAmount, ActionCoin, ChangeExpected};
+use mars_types::{
+    credit_manager::{ActionAmount, ActionCoin, ChangeExpected},
+    swapper::SwapperRoute,
+};
 
 use crate::{
     error::{ContractError, ContractResult},
@@ -16,6 +19,7 @@ pub fn swap_exact_in(
     coin_in: &ActionCoin,
     denom_out: &str,
     slippage: Decimal,
+    route: Option<SwapperRoute>,
 ) -> ContractResult<Response> {
     assert_slippage(deps.storage, slippage)?;
 
@@ -49,7 +53,7 @@ pub fn swap_exact_in(
     let swapper = SWAPPER.load(deps.storage)?;
 
     Ok(Response::new()
-        .add_message(swapper.swap_exact_in_msg(&coin_in_to_trade, denom_out, slippage)?)
+        .add_message(swapper.swap_exact_in_msg(&coin_in_to_trade, denom_out, slippage, route)?)
         .add_message(update_coin_balance_msg)
         .add_attribute("action", "swapper")
         .add_attribute("account_id", account_id)

contracts/credit-manager/src/swap.rs

@@ -59,7 +59,7 @@ use mars_types::{
     },
     swapper::{
         EstimateExactInSwapResponse, InstantiateMsg as SwapperInstantiateMsg,
-        QueryMsg::EstimateExactInSwap,
+        QueryMsg::EstimateExactInSwap, SwapperRoute,
     },
 };
 use mars_zapper_mock::msg::{InstantiateMsg as ZapperInstantiateMsg, LpConfig};
@@ -684,6 +684,7 @@ impl MockEnv {
         &self,
         coin_in: &Coin,
         denom_out: &str,
+        route: SwapperRoute,
     ) -> EstimateExactInSwapResponse {
         let config = self.query_config();
         self.app
@@ -693,6 +694,7 @@ impl MockEnv {
                 &EstimateExactInSwap {
                     coin_in: coin_in.clone(),
                     denom_out: denom_out.to_string(),
+                    route: Some(route),
                 },
             )
             .unwrap()

contracts/credit-manager/tests/tests/helpers/mock_env.rs

@@ -5,6 +5,7 @@ use mars_credit_manager::error::ContractError;
 use mars_types::{
     credit_manager::{Action, ActionAmount, ActionCoin},
     params::{AssetParams, AssetParamsUpdate},
+    swapper::{OsmoRoute, OsmoSwap, SwapperRoute},
 };
 use test_case::test_case;
 
@@ -57,6 +58,12 @@ use super::helpers::{uatom_info, uosmo_info, AccountToFund, MockEnv};
             },
             denom_out: "uosmo".into(),
             slippage: Decimal::percent(5),
+            route: Some(SwapperRoute::Osmo(OsmoRoute{swaps: vec![
+                OsmoSwap {
+                    pool_id: 101,
+                    to: "uosmo".into(),
+                }
+            ]}))
         }
     ],
     true;
@@ -78,6 +85,12 @@ use super::helpers::{uatom_info, uosmo_info, AccountToFund, MockEnv};
             },
             denom_out: "uosmo".into(),
             slippage: Decimal::percent(5),
+            route: Some(SwapperRoute::Osmo(OsmoRoute{swaps: vec![
+                OsmoSwap {
+                    pool_id: 101,
+                    to: "uosmo".into(),
+                }
+            ]}))
         }
     ],
     false;

contracts/credit-manager/tests/tests/test_deposit_cap.rs

@@ -151,24 +151,24 @@ fn successful_migration() {
 }
 
 #[test]
-fn successful_migration_to_v2_0_1() {
+fn successful_migration_to_v2_0_2() {
     let mut deps = mock_dependencies();
-    cw2::set_contract_version(deps.as_mut().storage, "crates.io:mars-credit-manager", "2.0.0")
+    cw2::set_contract_version(deps.as_mut().storage, "crates.io:mars-credit-manager", "2.0.1")
         .unwrap();
 
-    let res = migrate(deps.as_mut(), mock_env(), MigrateMsg::V2_0_0ToV2_0_1 {}).unwrap();
+    let res = migrate(deps.as_mut(), mock_env(), MigrateMsg::V2_0_1ToV2_0_2 {}).unwrap();
 
     assert_eq!(res.messages, vec![]);
     assert_eq!(res.events, vec![] as Vec<Event>);
     assert!(res.data.is_none());
     assert_eq!(
         res.attributes,
-        vec![attr("action", "migrate"), attr("from_version", "2.0.0"), attr("to_version", "2.0.1")]
+        vec![attr("action", "migrate"), attr("from_version", "2.0.1"), attr("to_version", "2.0.2")]
     );
 
     let new_contract_version = ContractVersion {
         contract: "crates.io:mars-credit-manager".to_string(),
-        version: "2.0.1".to_string(),
+        version: "2.0.2".to_string(),
     };
     assert_eq!(cw2::get_contract_version(deps.as_ref().storage).unwrap(), new_contract_version);
 }

contracts/credit-manager/tests/tests/test_migration_v2.rs

@@ -3,9 +3,12 @@ use std::str::FromStr;
 use cosmwasm_std::{coins, Addr, Coin, Decimal, OverflowError, OverflowOperation::Sub, Uint128};
 use mars_credit_manager::error::ContractError;
 use mars_swapper_mock::contract::MOCK_SWAP_RESULT;
-use mars_types::credit_manager::{
-    Action::{Deposit, SwapExactIn},
-    ActionAmount, ActionCoin,
+use mars_types::{
+    credit_manager::{
+        Action::{Deposit, SwapExactIn},
+        ActionAmount, ActionCoin,
+    },
+    swapper::{OsmoRoute, OsmoSwap, SwapperRoute},
 };
 
 use super::helpers::{
@@ -29,6 +32,12 @@ fn only_token_owner_can_swap_for_account() {
             },
             denom_out: "osmo".to_string(),
             slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+            route: Some(SwapperRoute::Osmo(OsmoRoute {
+                swaps: vec![OsmoSwap {
+                    pool_id: 101,
+                    to: "osmo".to_string(),
+                }],
+            })),
         }],
         &[],
     );
@@ -57,6 +66,12 @@ fn denom_out_must_be_whitelisted() {
             coin_in: blacklisted_coin.to_action_coin(10_000),
             denom_out: "ujake".to_string(),
             slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+            route: Some(SwapperRoute::Osmo(OsmoRoute {
+                swaps: vec![OsmoSwap {
+                    pool_id: 101,
+                    to: "ujake".to_string(),
+                }],
+            })),
         }],
         &[],
     );
@@ -79,8 +94,14 @@ fn no_amount_sent() {
         &user,
         vec![SwapExactIn {
             coin_in: osmo_info.to_action_coin(0),
-            denom_out: atom_info.denom,
+            denom_out: atom_info.denom.clone(),
             slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+            route: Some(SwapperRoute::Osmo(OsmoRoute {
+                swaps: vec![OsmoSwap {
+                    pool_id: 101,
+                    to: atom_info.denom,
+                }],
+            })),
         }],
         &[],
     );
@@ -103,8 +124,14 @@ fn user_has_zero_balance_for_swap_req() {
         &user,
         vec![SwapExactIn {
             coin_in: osmo_info.to_action_coin(10_000),
-            denom_out: atom_info.denom,
+            denom_out: atom_info.denom.clone(),
             slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+            route: Some(SwapperRoute::Osmo(OsmoRoute {
+                swaps: vec![OsmoSwap {
+                    pool_id: 101,
+                    to: atom_info.denom,
+                }],
+            })),
         }],
         &[],
     );
@@ -139,8 +166,14 @@ fn slippage_too_high() {
         &user,
         vec![SwapExactIn {
             coin_in: osmo_info.to_action_coin(10_000),
-            denom_out: atom_info.denom,
+            denom_out: atom_info.denom.clone(),
             slippage,
+            route: Some(SwapperRoute::Osmo(OsmoRoute {
+                swaps: vec![OsmoSwap {
+                    pool_id: 101,
+                    to: atom_info.denom,
+                }],
+            })),
         }],
         &[],
     );
@@ -177,8 +210,14 @@ fn user_does_not_have_enough_balance_for_swap_req() {
             Deposit(osmo_info.to_coin(100)),
             SwapExactIn {
                 coin_in: osmo_info.to_action_coin(10_000),
-                denom_out: atom_info.denom,
+                denom_out: atom_info.denom.clone(),
                 slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+                route: Some(SwapperRoute::Osmo(OsmoRoute {
+                    swaps: vec![OsmoSwap {
+                        pool_id: 101,
+                        to: atom_info.denom,
+                    }],
+                })),
             },
         ],
         &[osmo_info.to_coin(100)],
@@ -209,7 +248,13 @@ fn swap_success_with_specified_amount() {
         .build()
         .unwrap();
 
-    let res = mock.query_swap_estimate(&atom_info.to_coin(10_000), &osmo_info.denom);
+    let route = SwapperRoute::Osmo(OsmoRoute {
+        swaps: vec![OsmoSwap {
+            pool_id: 101,
+            to: osmo_info.denom.clone(),
+        }],
+    });
+    let res = mock.query_swap_estimate(&atom_info.to_coin(10_000), &osmo_info.denom, route.clone());
     assert_eq!(res.amount, MOCK_SWAP_RESULT);
 
     let account_id = mock.create_credit_account(&user).unwrap();
@@ -222,6 +267,7 @@ fn swap_success_with_specified_amount() {
                 coin_in: atom_info.to_action_coin(10_000),
                 denom_out: osmo_info.denom.clone(),
                 slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+                route: Some(route),
             },
         ],
         &[atom_info.to_coin(10_000)],
@@ -256,7 +302,13 @@ fn swap_success_with_amount_none() {
         .build()
         .unwrap();
 
-    let res = mock.query_swap_estimate(&atom_info.to_coin(10_000), &osmo_info.denom);
+    let route = SwapperRoute::Osmo(OsmoRoute {
+        swaps: vec![OsmoSwap {
+            pool_id: 101,
+            to: osmo_info.denom.clone(),
+        }],
+    });
+    let res = mock.query_swap_estimate(&atom_info.to_coin(10_000), &osmo_info.denom, route.clone());
     assert_eq!(res.amount, MOCK_SWAP_RESULT);
 
     let account_id = mock.create_credit_account(&user).unwrap();
@@ -269,6 +321,7 @@ fn swap_success_with_amount_none() {
                 coin_in: atom_info.to_action_coin_full_balance(),
                 denom_out: osmo_info.denom.clone(),
                 slippage: Decimal::from_atomics(6u128, 1).unwrap(),
+                route: Some(route),
             },
         ],
         &[atom_info.to_coin(10_000)],