feat: Splitter Send Config

CHANGELOG.md

@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added Validator Staking ADO [(#330)](https://github.com/andromedaprotocol/andromeda-core/pull/330)
 - Added Restake and Redelegate to Validator Staking [(#622)](https://github.com/andromedaprotocol/andromeda-core/pull/622)
 - Added andromeda-math and andromeda-account packages[(#672)](https://github.com/andromedaprotocol/andromeda-core/pull/672)
+- Added optional config for Send in Splitter contracts [(#686)](https://github.com/andromedaprotocol/andromeda-core/pull/686)
 
 
 ### Changed

contracts/finance/andromeda-set-amount-splitter/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "andromeda-set-amount-splitter"
-version = "1.0.3-beta"
+version = "1.1.0-beta"
 edition = "2021"
 rust-version = "1.75.0"
 

contracts/finance/andromeda-set-amount-splitter/src/contract.rs

@@ -124,7 +124,7 @@ pub fn handle_execute(mut ctx: ExecuteContext, msg: ExecuteMsg) -> Result<Respon
     let res = match msg {
         ExecuteMsg::UpdateRecipients { recipients } => execute_update_recipients(ctx, recipients),
         ExecuteMsg::UpdateLock { lock_time } => execute_update_lock(ctx, lock_time),
-        ExecuteMsg::Send {} => execute_send(ctx),
+        ExecuteMsg::Send { config } => execute_send(ctx, config),
         _ => ADOContract::default().execute(ctx, msg),
     }?;
     Ok(res
@@ -133,7 +133,10 @@ pub fn handle_execute(mut ctx: ExecuteContext, msg: ExecuteMsg) -> Result<Respon
         .add_events(action_response.events))
 }
 
-fn execute_send(ctx: ExecuteContext) -> Result<Response, ContractError> {
+fn execute_send(
+    ctx: ExecuteContext,
+    config: Option<Vec<AddressAmount>>,
+) -> Result<Response, ContractError> {
     let ExecuteContext { deps, info, .. } = ctx;
 
     ensure!(
@@ -159,7 +162,11 @@ fn execute_send(ctx: ExecuteContext) -> Result<Response, ContractError> {
         denom_set.insert(coin.denom);
     }
 
-    let splitter = SPLITTER.load(deps.storage)?;
+    let splitter = if let Some(config) = config {
+        config
+    } else {
+        SPLITTER.load(deps.storage)?.recipients
+    };
 
     let mut msgs: Vec<SubMsg> = Vec::new();
     let mut amp_funds: Vec<Coin> = Vec::new();
@@ -171,7 +178,7 @@ fn execute_send(ctx: ExecuteContext) -> Result<Response, ContractError> {
         let mut remainder_funds = coin.amount;
         let denom = coin.denom;
 
-        for recipient in &splitter.recipients {
+        for recipient in &splitter {
             // Find the recipient's corresponding denom for the current iteration of the sent funds
             let recipient_coin = recipient
                 .coins

contracts/finance/andromeda-set-amount-splitter/src/mock.rs

@@ -29,8 +29,14 @@ impl MockSetAmountSplitter {
         Self(res.unwrap())
     }
 
-    pub fn execute_send(&self, app: &mut MockApp, sender: Addr, funds: &[Coin]) -> ExecuteResult {
-        let msg = mock_set_amount_splitter_send_msg();
+    pub fn execute_send(
+        &self,
+        app: &mut MockApp,
+        sender: Addr,
+        funds: &[Coin],
+        config: Option<Vec<AddressAmount>>,
+    ) -> ExecuteResult {
+        let msg = mock_set_amount_splitter_send_msg(config);
 
         self.execute(app, &msg, sender, funds)
     }
@@ -55,6 +61,6 @@ pub fn mock_set_amount_splitter_instantiate_msg(
     }
 }
 
-pub fn mock_set_amount_splitter_send_msg() -> ExecuteMsg {
-    ExecuteMsg::Send {}
+pub fn mock_set_amount_splitter_send_msg(config: Option<Vec<AddressAmount>>) -> ExecuteMsg {
+    ExecuteMsg::Send { config }
 }

contracts/finance/andromeda-set-amount-splitter/src/testing/tests.rs

@@ -176,9 +176,15 @@ fn test_execute_send() {
 
     let recip_address2 = "address2".to_string();
 
+    let recip_address3 = "address3".to_string();
+
     let recip1 = Recipient::from_string(recip_address1);
     let recip2 = Recipient::from_string(recip_address2);
-
+    let recip3 = Recipient::from_string(recip_address3);
+    let config_recipient = vec![AddressAmount {
+        recipient: recip3.clone(),
+        coins: vec![coin(1_u128, "uandr"), coin(30_u128, "usdc")],
+    }];
     let recipient = vec![
         AddressAmount {
             recipient: recip1.clone(),
@@ -189,7 +195,7 @@ fn test_execute_send() {
             coins: vec![coin(1_u128, "uandr"), coin(20_u128, "usdc")],
         },
     ];
-    let msg = ExecuteMsg::Send {};
+    let msg = ExecuteMsg::Send { config: None };
 
     let amp_msg_1 = recip1
         .generate_amp_msg(&deps.as_ref(), Some(vec![Coin::new(1, "uandr")]))
@@ -230,7 +236,7 @@ fn test_execute_send() {
 
     SPLITTER.save(deps.as_mut().storage, &splitter).unwrap();
 
-    let res = execute(deps.as_mut(), env, info, msg).unwrap();
+    let res = execute(deps.as_mut(), env.clone(), info.clone(), msg).unwrap();
 
     let expected_res = Response::new()
         .add_submessages(vec![
@@ -247,6 +253,56 @@ fn test_execute_send() {
         .add_submessage(generate_economics_message(OWNER, "Send"));
 
     assert_eq!(res, expected_res);
+
+    // Test with config
+    let msg = ExecuteMsg::Send {
+        config: Some(config_recipient),
+    };
+
+    let amp_msg_1 = recip3
+        .generate_amp_msg(&deps.as_ref(), Some(vec![Coin::new(1, "uandr")]))
+        .unwrap();
+
+    let amp_msg_2 = recip3
+        .generate_amp_msg(&deps.as_ref(), Some(vec![Coin::new(30, "usdc")]))
+        .unwrap();
+
+    let amp_pkt = AMPPkt::new(
+        MOCK_CONTRACT_ADDR.to_string(),
+        MOCK_CONTRACT_ADDR.to_string(),
+        vec![amp_msg_1, amp_msg_2],
+    );
+    let amp_msg = amp_pkt
+        .to_sub_msg(
+            MOCK_KERNEL_CONTRACT,
+            Some(vec![Coin::new(1, "uandr"), Coin::new(30, "usdc")]),
+            1,
+        )
+        .unwrap();
+
+    let expected_res = Response::new()
+        .add_submessages(vec![
+            SubMsg::new(
+                // refunds remainder to sender
+                CosmosMsg::Bank(BankMsg::Send {
+                    to_address: OWNER.to_string(),
+                    amount: vec![Coin::new(9999, "uandr")],
+                }),
+            ),
+            SubMsg::new(
+                // refunds remainder to sender
+                CosmosMsg::Bank(BankMsg::Send {
+                    to_address: OWNER.to_string(),
+                    amount: vec![Coin::new(20, "usdc")],
+                }),
+            ),
+            amp_msg,
+        ])
+        .add_attributes(vec![attr("action", "send"), attr("sender", "creator")])
+        .add_submessage(generate_economics_message(OWNER, "Send"));
+    let res = execute(deps.as_mut(), env, info, msg).unwrap();
+
+    assert_eq!(res, expected_res);
 }
 
 #[test]
@@ -275,7 +331,7 @@ fn test_execute_send_ado_recipient() {
             coins: coins(1_u128, "uandr"),
         },
     ];
-    let msg = ExecuteMsg::Send {};
+    let msg = ExecuteMsg::Send { config: None };
 
     let amp_msg_1 = recip1
         .generate_amp_msg(&deps.as_ref(), Some(vec![Coin::new(1, "uandr")]))
@@ -349,7 +405,7 @@ fn test_handle_packet_exit_with_error_true() {
         "cosmos2contract",
         vec![AMPMsg::new(
             recip_address1,
-            to_json_binary(&ExecuteMsg::Send {}).unwrap(),
+            to_json_binary(&ExecuteMsg::Send { config: None }).unwrap(),
             Some(vec![Coin::new(0, "uandr")]),
         )],
     );
@@ -425,7 +481,7 @@ fn test_execute_send_error() {
             coins: coins(1_u128, "uandr"),
         },
     ];
-    let msg = ExecuteMsg::Send {};
+    let msg = ExecuteMsg::Send { config: None };
 
     let splitter = Splitter {
         recipients: recipient,

contracts/finance/andromeda-splitter/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "andromeda-splitter"
-version = "2.1.4"
+version = "2.2.0"
 edition = "2021"
 rust-version = "1.75.0"
 

contracts/finance/andromeda-splitter/src/contract.rs

@@ -105,7 +105,7 @@ pub fn handle_execute(mut ctx: ExecuteContext, msg: ExecuteMsg) -> Result<Respon
     let res = match msg {
         ExecuteMsg::UpdateRecipients { recipients } => execute_update_recipients(ctx, recipients),
         ExecuteMsg::UpdateLock { lock_time } => execute_update_lock(ctx, lock_time),
-        ExecuteMsg::Send {} => execute_send(ctx),
+        ExecuteMsg::Send { config } => execute_send(ctx, config),
         _ => ADOContract::default().execute(ctx, msg),
     }?;
     Ok(res
@@ -114,7 +114,10 @@ pub fn handle_execute(mut ctx: ExecuteContext, msg: ExecuteMsg) -> Result<Respon
         .add_events(action_response.events))
 }
 
-fn execute_send(ctx: ExecuteContext) -> Result<Response, ContractError> {
+fn execute_send(
+    ctx: ExecuteContext,
+    config: Option<Vec<AddressPercent>>,
+) -> Result<Response, ContractError> {
     let ExecuteContext { deps, info, .. } = ctx;
     ensure!(
         !info.funds.is_empty(),
@@ -131,7 +134,11 @@ fn execute_send(ctx: ExecuteContext) -> Result<Response, ContractError> {
         );
     }
 
-    let splitter = SPLITTER.load(deps.storage)?;
+    let splitter = if let Some(config) = config {
+        config
+    } else {
+        SPLITTER.load(deps.storage)?.recipients
+    };
 
     let mut msgs: Vec<SubMsg> = Vec::new();
     let mut amp_funds: Vec<Coin> = Vec::new();
@@ -148,7 +155,7 @@ fn execute_send(ctx: ExecuteContext) -> Result<Response, ContractError> {
 
     let mut pkt = AMPPkt::from_ctx(ctx.amp_ctx, ctx.env.contract.address.to_string());
 
-    for recipient_addr in &splitter.recipients {
+    for recipient_addr in &splitter {
         let recipient_percent = recipient_addr.percent;
         let mut vec_coin: Vec<Coin> = Vec::new();
         for (i, coin) in info.funds.clone().iter().enumerate() {

contracts/finance/andromeda-splitter/src/mock.rs

@@ -28,8 +28,14 @@ impl MockSplitter {
         Self(res.unwrap())
     }
 
-    pub fn execute_send(&self, app: &mut MockApp, sender: Addr, funds: &[Coin]) -> ExecuteResult {
-        let msg = mock_splitter_send_msg();
+    pub fn execute_send(
+        &self,
+        app: &mut MockApp,
+        sender: Addr,
+        funds: &[Coin],
+        config: Option<Vec<AddressPercent>>,
+    ) -> ExecuteResult {
+        let msg = mock_splitter_send_msg(config);
 
         self.execute(app, &msg, sender, funds)
     }
@@ -54,6 +60,6 @@ pub fn mock_splitter_instantiate_msg(
     }
 }
 
-pub fn mock_splitter_send_msg() -> ExecuteMsg {
-    ExecuteMsg::Send {}
+pub fn mock_splitter_send_msg(config: Option<Vec<AddressPercent>>) -> ExecuteMsg {
+    ExecuteMsg::Send { config }
 }