andromeda_std/common/

mod.rs

pub mod actions;
pub mod context;
pub mod denom;
pub mod expiration;
pub mod milliseconds;
pub mod rates;
pub mod reply;
pub mod response;
pub mod withdraw;

pub use milliseconds::*;

use crate::error::ContractError;
use cosmwasm_std::{
    ensure, has_coins, to_json_binary, BankMsg, Binary, Coin, CosmosMsg, SubMsg, Uint128,
};
use cw20::Cw20Coin;

use serde::Serialize;
use std::collections::BTreeMap;

use cosmwasm_schema::cw_serde;
#[cw_serde]
pub enum OrderBy {
    Asc,
    Desc,
}

pub fn encode_binary<T>(val: &T) -> Result<Binary, ContractError>
where
    T: Serialize,
{
    match to_json_binary(val) {
        Ok(encoded_val) => Ok(encoded_val),
        Err(err) => Err(err.into()),
    }
}

#[cw_serde]
pub enum Funds {
    Native(Coin),
    Cw20(Cw20Coin),
}

impl Funds {
    // There is probably a more idiomatic way of doing this with From and Into...
    pub fn try_get_coin(&self) -> Result<Coin, ContractError> {
        match self {
            Funds::Native(coin) => Ok(coin.clone()),
            Funds::Cw20(_) => Err(ContractError::ParsingError {
                err: "Funds is not of type Native".to_string(),
            }),
        }
    }
}

/// Merges bank messages to the same recipient to a single bank message. Any sub messages
/// that do not contain bank messages are left as is. Note: Original order is not necessarily maintained.
///
/// ## Arguments
/// * `msgs`  - The sub messages to merge.
///
/// Returns a Vec<SubMsg> containing the merged bank messages.
pub fn merge_sub_msgs(msgs: Vec<SubMsg>) -> Vec<SubMsg> {
    // BTreeMap used instead of HashMap for determinant ordering in tests. Both should work
    // on-chain as hashmap randomness is fixed in cosmwasm. We get O(logn) instead of O(1)
    // performance this way which is not a huge difference.
    let mut map: BTreeMap<String, Vec<Coin>> = BTreeMap::new();

    let mut merged_msgs: Vec<SubMsg> = vec![];
    for msg in msgs.into_iter() {
        match msg.msg {
            CosmosMsg::Bank(BankMsg::Send { to_address, amount }) => {
                let current_coins = map.get(&to_address);
                match current_coins {
                    Some(current_coins) => {
                        map.insert(
                            to_address.to_owned(),
                            merge_coins(current_coins.to_vec(), amount),
                        );
                    }
                    None => {
                        map.insert(to_address.to_owned(), amount);
                    }
                }
            }
            _ => merged_msgs.push(msg),
        }
    }

    for (to_address, amount) in map.into_iter() {
        merged_msgs.push(SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
            to_address,
            amount,
        })));
    }

    merged_msgs
}

/// Adds coins in `coins_to_add` to `coins` by merging those of the same denom and
/// otherwise appending.
///
/// ## Arguments
/// * `coins`        - Mutable reference to a vec of coins which will be modified in-place.
/// * `coins_to_add` - The `Vec<Coin>` to add, it is assumed that it contains no coins of the
///                    same denom
///
/// Returns nothing as it is done in place.
pub fn merge_coins(coins: Vec<Coin>, coins_to_add: Vec<Coin>) -> Vec<Coin> {
    let mut new_coins: Vec<Coin> = if !coins.is_empty() {
        merge_coins(vec![], coins.to_vec())
    } else {
        vec![]
    };
    // Not the most efficient algorithm (O(n * m)) but we don't expect to deal with very large arrays of Coin,
    // typically at most 2 denoms. Even in the future there are not that many Terra native coins
    // where this will be a problem.

    for coin in coins_to_add {
        let mut same_denom_coins = new_coins.iter_mut().filter(|c| c.denom == coin.denom);
        if let Some(same_denom_coin) = same_denom_coins.next() {
            same_denom_coin.amount += coin.amount
        } else {
            new_coins.push(coin);
        }
    }

    new_coins
}

/// Checks if the required funds can be covered by merging the provided coins.
///
/// ## Arguments
/// * `coins` - The vector of `Coin` structs representing the available coins
/// * `required` - The vector of `Coin` structs representing the required funds
///
/// Returns true if the required funds can be covered by merging the available coins, false otherwise.
pub fn has_coins_merged(coins: &[Coin], required: &[Coin]) -> bool {
    let merged_coins = merge_coins(vec![], coins.to_vec());
    let merged_required = merge_coins(vec![], required.to_vec());

    for required_funds in merged_required {
        if !has_coins(&merged_coins, &required_funds) {
            return false;
        };
    }

    true
}

/// Deducts a given amount from a vector of `Coin` structs. Alters the given vector, does not return a new vector.
///
/// ## Arguments
/// * `coins` - The vector of `Coin` structs from which to deduct the given funds
/// * `funds` - The amount to deduct
pub fn deduct_funds(coins: &mut [Coin], funds: &Coin) -> Result<(), ContractError> {
    let coin_amount: Vec<&mut Coin> = coins
        .iter_mut()
        .filter(|c| c.denom.eq(&funds.denom))
        .collect();

    let mut remainder = funds.amount;
    for same_coin in coin_amount {
        if same_coin.amount > remainder {
            same_coin.amount = same_coin.amount.checked_sub(remainder)?;
            return Ok(());
        } else {
            remainder = remainder.checked_sub(same_coin.amount)?;
            same_coin.amount = Uint128::zero();
        }
    }

    ensure!(
        remainder == Uint128::zero(),
        ContractError::InsufficientFunds {}
    );

    Ok(())
}

#[cfg(test)]
mod test {
    use cosmwasm_std::{coin, Uint128, WasmMsg};
    use cw20::Expiration;

    use super::*;

    #[cw_serde]
    struct TestStruct {
        name: String,
        expiration: Expiration,
    }

    #[test]
    fn test_merge_coins() {
        let coins = vec![coin(100, "uusd"), coin(100, "uluna")];
        let funds_to_add = vec![
            coin(25, "uluna"),
            coin(50, "uusd"),
            coin(100, "ucad"),
            coin(50, "uluna"),
            coin(100, "uluna"),
            coin(100, "ucad"),
        ];

        let res = merge_coins(coins, funds_to_add);
        assert_eq!(
            vec![coin(150, "uusd"), coin(275, "uluna"), coin(200, "ucad")],
            res
        );
    }

    #[test]
    fn test_merge_sub_messages() {
        let sub_msgs: Vec<SubMsg> = vec![
            SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
                to_address: "A".to_string(),
                amount: vec![coin(100, "uusd"), coin(50, "uluna")],
            })),
            SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
                to_address: "A".to_string(),
                amount: vec![coin(100, "uusd"), coin(50, "ukrw")],
            })),
            SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
                to_address: "B".to_string(),
                amount: vec![coin(100, "uluna")],
            })),
            SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
                to_address: "B".to_string(),
                amount: vec![coin(50, "uluna")],
            })),
            SubMsg::new(CosmosMsg::Wasm(WasmMsg::Execute {
                contract_addr: "C".to_string(),
                funds: vec![],
                msg: encode_binary(&"").unwrap(),
            })),
        ];

        let merged_msgs = merge_sub_msgs(sub_msgs);
        assert_eq!(
            vec![
                SubMsg::new(CosmosMsg::Wasm(WasmMsg::Execute {
                    contract_addr: "C".to_string(),
                    funds: vec![],
                    msg: encode_binary(&"").unwrap(),
                })),
                SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
                    to_address: "A".to_string(),
                    amount: vec![coin(200, "uusd"), coin(50, "uluna"), coin(50, "ukrw")],
                })),
                SubMsg::new(CosmosMsg::Bank(BankMsg::Send {
                    to_address: "B".to_string(),
                    amount: vec![coin(150, "uluna")],
                })),
            ],
            merged_msgs
        );

        assert_eq!(3, merged_msgs.len());
    }

    #[test]
    fn test_deduct_funds() {
        let mut funds: Vec<Coin> = vec![coin(5, "uluna"), coin(100, "uusd"), coin(100, "uluna")];

        deduct_funds(&mut funds, &coin(10, "uluna")).unwrap();

        assert_eq!(Uint128::zero(), funds[0].amount);
        assert_eq!(String::from("uluna"), funds[0].denom);
        assert_eq!(Uint128::from(95u128), funds[2].amount);
        assert_eq!(String::from("uluna"), funds[2].denom);

        let mut funds: Vec<Coin> = vec![Coin {
            denom: String::from("uluna"),
            amount: Uint128::from(5u64),
        }];

        let e = deduct_funds(&mut funds, &coin(10, "uluna")).unwrap_err();

        assert_eq!(ContractError::InsufficientFunds {}, e);
    }
    #[test]
    fn test_has_coins_merged() {
        let available_coins: Vec<Coin> = vec![
            coin(50, "uluna"),
            coin(200, "uusd"),
            coin(50, "ukrw"),
            coin(25, "uluna"),
            coin(25, "uluna"),
        ];
        let required_funds: Vec<Coin> = vec![
            coin(50, "uluna"),
            coin(100, "uusd"),
            coin(50, "ukrw"),
            coin(50, "uluna"),
        ];

        assert!(has_coins_merged(&available_coins, &required_funds));

        let insufficient_funds: Vec<Coin> =
            vec![coin(10, "uluna"), coin(100, "uusd"), coin(50, "ukrw")];

        assert!(!has_coins_merged(&insufficient_funds, &required_funds));
    }
}