Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix: zero amount order bug #1816

Merged
merged 3 commits into from
Apr 18, 2024
Merged

Fix: zero amount order bug #1816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e22a296
add tests that fail and shouldn't
lemunozm Apr 17, 2024
c21a170
add fix
lemunozm Apr 17, 2024
00229e4
add extra tests
lemunozm Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions pallets/foreign-investments/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1592,3 +1592,126 @@ mod notifications {
});
}
}

mod zero_amount_order {
use super::*;

#[test]
fn when_increase_with_zero() {
new_test_ext().execute_with(|| {
util::base_configuration();

assert_ok!(ForeignInvestment::increase_foreign_investment(
&USER,
INVESTMENT_ID,
0,
FOREIGN_CURR
));

assert_err!(
Swaps::order_id(&USER, (INVESTMENT_ID, Action::Investment)),
pallet_swaps::Error::<Runtime>::OrderNotFound
);
});
}

#[test]
fn when_increase_after_decrease_but_math_precission() {
new_test_ext().execute_with(|| {
const FOREIGN_AMOUNT: Balance = 100;

util::base_configuration();

MockTokenSwaps::mock_convert_by_market(|to, from, amount_from| {
Ok(match (from, to) {
(POOL_CURR, FOREIGN_CURR) => amount_from / 3 + 1,
(FOREIGN_CURR, POOL_CURR) => amount_from * 3,
_ => unreachable!(),
})
});

assert_ok!(ForeignInvestment::increase_foreign_investment(
&USER,
INVESTMENT_ID,
FOREIGN_AMOUNT,
FOREIGN_CURR
));

util::fulfill_last_swap(Action::Investment, FOREIGN_AMOUNT);

assert!(Swaps::order_id(&USER, (INVESTMENT_ID, Action::Investment)).is_err());

assert_ok!(ForeignInvestment::decrease_foreign_investment(
&USER,
INVESTMENT_ID,
FOREIGN_AMOUNT,
FOREIGN_CURR
));

MockDecreaseInvestHook::mock_notify_status_change(|_, msg| {
assert_eq!(
msg,
ExecutedForeignDecreaseInvest {
amount_decreased: FOREIGN_AMOUNT + 1,
foreign_currency: FOREIGN_CURR,
amount_remaining: FOREIGN_AMOUNT,
}
);
Ok(())
});

assert_ok!(ForeignInvestment::increase_foreign_investment(
&USER,
INVESTMENT_ID,
FOREIGN_AMOUNT + 1,
FOREIGN_CURR
));

assert_err!(
Swaps::order_id(&USER, (INVESTMENT_ID, Action::Investment)),
pallet_swaps::Error::<Runtime>::OrderNotFound
);
});
}

#[test]
fn when_increase_fulfill_is_notified() {
new_test_ext().execute_with(|| {
util::base_configuration();

assert_ok!(ForeignInvestment::increase_foreign_investment(
&USER,
INVESTMENT_ID,
AMOUNT,
FOREIGN_CURR
));

util::fulfill_last_swap(Action::Investment, 0);
});
}

#[test]
fn when_decrease_fulfill_is_notified() {
new_test_ext().execute_with(|| {
util::base_configuration();

assert_ok!(ForeignInvestment::increase_foreign_investment(
&USER,
INVESTMENT_ID,
AMOUNT,
FOREIGN_CURR
));

util::fulfill_last_swap(Action::Investment, AMOUNT);

assert_ok!(ForeignInvestment::decrease_foreign_investment(
&USER,
INVESTMENT_ID,
AMOUNT,
FOREIGN_CURR
));

util::fulfill_last_swap(Action::Investment, 0);
});
}
}
41 changes: 41 additions & 0 deletions pallets/order-book/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,47 @@ fn correct_order_details() {
});
}

#[test]
fn fulfill_zero_amount_order() {
new_test_ext().execute_with(|| {
let order_id = <OrderBook as TokenSwaps<AccountId>>::place_order(
FROM,
CURRENCY_B,
CURRENCY_A,
0,
OrderRatio::Custom(DEFAULT_RATIO),
)
.unwrap();

util::expect_notification(order_id, 0, 0, 0);

assert_ok!(OrderBook::fill_order(
RuntimeOrigin::signed(FROM),
order_id,
0
));
});
}

#[test]
fn close_zero_amount_order() {
new_test_ext().execute_with(|| {
let order_id = <OrderBook as TokenSwaps<AccountId>>::place_order(
FROM,
CURRENCY_B,
CURRENCY_A,
0,
OrderRatio::Custom(DEFAULT_RATIO),
)
.unwrap();

assert_ok!(OrderBook::cancel_order(
RuntimeOrigin::signed(FROM),
order_id
));
});
}

mod market {
use super::*;

Expand Down
40 changes: 24 additions & 16 deletions pallets/swaps/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,20 +145,24 @@ pub mod pallet {
) -> Result<(SwapStatus<T::Balance>, Option<T::OrderId>), DispatchError> {
match over_order_id {
None => {
let order_id = T::OrderBook::place_order(
who.clone(),
new_swap.currency_in,
new_swap.currency_out,
new_swap.amount_out,
OrderRatio::Market,
)?;
let order_id = if !new_swap.amount_out.is_zero() {
Some(T::OrderBook::place_order(
who.clone(),
new_swap.currency_in,
new_swap.currency_out,
new_swap.amount_out,
OrderRatio::Market,
)?)
} else {
None
};

Ok((
SwapStatus {
swapped: T::Balance::zero(),
pending: new_swap.amount_out,
},
Some(order_id),
order_id,
))
}
Some(order_id) => {
Expand Down Expand Up @@ -228,20 +232,24 @@ pub mod pallet {
let amount_to_swap =
new_swap.amount_out.ensure_sub(inverse_swap_amount_in)?;

let order_id = T::OrderBook::place_order(
who.clone(),
new_swap.currency_in,
new_swap.currency_out,
amount_to_swap,
OrderRatio::Market,
)?;
let order_id = if !amount_to_swap.is_zero() {
Some(T::OrderBook::place_order(
who.clone(),
new_swap.currency_in,
new_swap.currency_out,
amount_to_swap,
OrderRatio::Market,
)?)
} else {
None
};

Ok((
SwapStatus {
swapped: inverse_swap.amount_out,
pending: amount_to_swap,
},
Some(order_id),
order_id,
))
}
}
Expand Down
83 changes: 83 additions & 0 deletions pallets/swaps/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,3 +490,86 @@ mod fulfill {
});
}
}

mod zero_amount_order {
use super::*;

#[test]
fn when_apply_over_no_swap() {
new_test_ext().execute_with(|| {
MockTokenSwaps::mock_place_order(|_, _, _, _, _| {
panic!("this mock should not be called");
});

assert_ok!(
<Swaps as TSwaps<AccountId>>::apply_swap(
&USER,
SWAP_ID,
Swap {
currency_in: CURRENCY_B,
currency_out: CURRENCY_A,
amount_out: 0,
},
),
SwapStatus {
swapped: 0,
pending: 0,
}
);

assert_eq!(OrderIdToSwapId::<Runtime>::get(ORDER_ID), None);
assert_eq!(SwapIdToOrderId::<Runtime>::get((USER, SWAP_ID)), None);
});
}

#[test]
fn when_apply_over_smaller_inverse_swap_but_math_precission() {
Copy link
Contributor Author

@lemunozm lemunozm Apr 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not really need this test if we have the pallet-swaps tests. But I wanted to force a use case from FI PoV. We can finally remove it once we're sure it's fully solved.

const AMOUNT_A: Balance = 100;

new_test_ext().execute_with(|| {
MockTokenSwaps::mock_convert_by_market(|to, from, amount_from| match (from, to) {
(CURRENCY_B, CURRENCY_A) => Ok(amount_from * 3),
(CURRENCY_A, CURRENCY_B) => Ok(amount_from / 3 + 1),
_ => unreachable!(),
});
MockTokenSwaps::mock_get_order_details(|_| {
// Inverse swap
Some(OrderInfo {
swap: Swap {
currency_in: CURRENCY_A,
currency_out: CURRENCY_B,
amount_out: AMOUNT_A / 3,
},
ratio: OrderRatio::Market,
})
});
MockTokenSwaps::mock_cancel_order(|_| Ok(()));

MockTokenSwaps::mock_place_order(|_, _, _, amount, _| {
assert_eq!(amount, 0);
panic!("this mock should not be called");
});

Swaps::update_id(&USER, SWAP_ID, Some(ORDER_ID)).unwrap();

assert_ok!(
<Swaps as TSwaps<AccountId>>::apply_swap(
&USER,
SWAP_ID,
Swap {
currency_out: CURRENCY_A,
currency_in: CURRENCY_B,
amount_out: AMOUNT_A - 1,
},
),
SwapStatus {
swapped: AMOUNT_A / 3,
pending: 0,
}
);

assert_eq!(OrderIdToSwapId::<Runtime>::get(ORDER_ID), None);
assert_eq!(SwapIdToOrderId::<Runtime>::get((USER, SWAP_ID)), None);
});
}
}
Loading