Skip to content

Commit

Permalink
dex: fix incorrect use of nomenclature
Browse files Browse the repository at this point in the history
  • Loading branch information
@erwanor
erwanor committed Apr 1, 2024
1 parent ca16ab1 commit d2c8dd5
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 86 deletions.
16 changes: 8 additions & 8 deletions crates/bin/pcli/src/command/tx/liquidity_position.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ pub enum OrderCmd {
/// Only spend funds originally received by the given address index.
#[clap(long, default_value = "0")]
source: u32,
/// When set, tags the position as being a limit-sell order.
/// When set, tags the position as an auto-closing buy.
#[clap(long)]
limit_order: bool,
auto_close: bool,
/// The selected fee tier to multiply the fee amount by.
#[clap(short, long, value_enum, default_value_t)]
fee_tier: FeeTier,
Expand All @@ -115,9 +115,9 @@ pub enum OrderCmd {
/// Only spend funds originally received by the given address index.
#[clap(long, default_value = "0")]
source: u32,
/// When set, tags the position as being a limit-sell order.
/// When set, tags the position as an auto-closing sell.
#[clap(long)]
limit_order: bool,
auto_close: bool,
/// The selected fee tier to multiply the fee amount by.
#[clap(short, long, value_enum, default_value_t)]
fee_tier: FeeTier,
Expand All @@ -139,10 +139,10 @@ impl OrderCmd {
}
}

pub fn limit_order(&self) -> bool {
pub fn is_auto_closing(&self) -> bool {
match self {
OrderCmd::Buy { limit_order, .. } => *limit_order,
OrderCmd::Sell { limit_order, .. } => *limit_order,
OrderCmd::Buy { auto_close, .. } => *auto_close,
OrderCmd::Sell { auto_close, .. } => *auto_close,
}
}

Expand All @@ -166,7 +166,7 @@ impl OrderCmd {
};
tracing::info!(?position);

if self.limit_order() {
if self.is_auto_closing() {
position.close_on_fill = true;
}

Expand Down
6 changes: 3 additions & 3 deletions crates/core/component/dex/src/component/circuit_breaker/value.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ mod tests {
use crate::component::{StateReadExt as _, StateWriteExt as _};
use crate::lp::plan::PositionWithdrawPlan;
use crate::{
component::{router::limit_buy, tests::TempStorageExt},
component::{router::create_buy, tests::TempStorageExt},
state_key, DirectedUnitPair,
};
use crate::{BatchSwapOutputData, PositionOpen};
Expand Down Expand Up @@ -132,7 +132,7 @@ mod tests {
let one = 1u64.into();
let price1 = one;
// Create a position buying 1 gm with 1 gn (i.e. reserves will be 1gn).
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);

// Create the PositionOpen action
let pos_open = PositionOpen {
Expand Down Expand Up @@ -220,7 +220,7 @@ mod tests {
let one = 1u64.into();
let price1 = one;
// Create a position buying 1 gm with 1 gn (i.e. reserves will be 1gn).
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);

let id = buy_1.id();

Expand Down
2 changes: 1 addition & 1 deletion crates/core/component/dex/src/component/router/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ pub use route_and_fill::{HandleBatchSwaps, RouteAndFill};
mod tests;

#[cfg(test)]
pub(crate) use tests::{limit_buy, limit_sell};
pub(crate) use tests::{create_buy, create_sell};
120 changes: 60 additions & 60 deletions crates/core/component/dex/src/component/router/tests.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ async fn create_test_positions_basic<S: StateWrite>(s: &mut S, misprice: bool) {

/// Create a `Position` to buy `asset_1` using `asset_2` with explicit p/q.
/// e.g. "Buy `quantity` of `asset_1` for `price` units of `asset_2` each.
fn limit_buy_pq(
fn create_buy_pq(
market: DirectedUnitPair,
quantity: Amount,
p: Amount,
Expand All @@ -361,7 +361,7 @@ fn limit_buy_pq(

/// Create a `Position` to buy `asset_1` using `asset_2`.
/// e.g. "Buy `quantity` of `asset_1` for `price` units of `asset_2` each.
pub(crate) fn limit_buy(
pub(crate) fn create_buy(
market: DirectedUnitPair,
quantity: Amount,
price_in_numeraire: Amount,
Expand All @@ -380,7 +380,7 @@ pub(crate) fn limit_buy(
}

/// Create a `Position` to sell `asset_1` into `asset_2`.
pub(crate) fn limit_sell(
pub(crate) fn create_sell(
market: DirectedUnitPair,
quantity: Amount,
price_in_numeraire: Amount,
Expand Down Expand Up @@ -489,8 +489,8 @@ async fn test_multiple_similar_position() -> anyhow::Result<()> {

let one = 1u64.into();
let price1 = one;
let mut buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let mut buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let mut buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let mut buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
buy_1.nonce = [1u8; 32];
buy_2.nonce = [2u8; 32];
state_tx.open_position(buy_1.clone()).await.unwrap();
Expand Down Expand Up @@ -569,18 +569,18 @@ async fn fill_route_constraint_stacked() -> anyhow::Result<()> {
let price1 = one;
let price2 = 2u64.into();

let buy_1 = limit_buy(pair_1.clone(), 3u64.into(), price2);
let buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 3u64.into(), price2);
let buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();

/* pair 2 */
let price2 = Amount::from(2u64);

let buy_1 = limit_buy(pair_2.clone(), 1u64.into(), price2);
let buy_2 = limit_buy(pair_2.clone(), 50u64.into(), price1);
let buy_3 = limit_buy(pair_2.clone(), 50u64.into(), price1);
let buy_4 = limit_buy(pair_2.clone(), 50u64.into(), price1);
let buy_1 = create_buy(pair_2.clone(), 1u64.into(), price2);
let buy_2 = create_buy(pair_2.clone(), 50u64.into(), price1);
let buy_3 = create_buy(pair_2.clone(), 50u64.into(), price1);
let buy_4 = create_buy(pair_2.clone(), 50u64.into(), price1);

state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
Expand All @@ -594,11 +594,11 @@ async fn fill_route_constraint_stacked() -> anyhow::Result<()> {
let price3100 = 3100u64.into();
let price10000 = 10_000u64.into();

let buy_1 = limit_buy(pair_3.clone(), 1u64.into(), price2000);
let buy_2 = limit_buy(pair_3.clone(), 1u64.into(), price2500);
let buy_3 = limit_buy(pair_3.clone(), 198u64.into(), price3000);
let buy_4 = limit_buy(pair_3.clone(), 1u64.into(), price3100);
let buy_5 = limit_buy(pair_3.clone(), 1u64.into(), price10000);
let buy_1 = create_buy(pair_3.clone(), 1u64.into(), price2000);
let buy_2 = create_buy(pair_3.clone(), 1u64.into(), price2500);
let buy_3 = create_buy(pair_3.clone(), 198u64.into(), price3000);
let buy_4 = create_buy(pair_3.clone(), 1u64.into(), price3100);
let buy_5 = create_buy(pair_3.clone(), 1u64.into(), price10000);

state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
Expand Down Expand Up @@ -680,16 +680,16 @@ async fn fill_route_constraint_1() -> anyhow::Result<()> {

let price1 = one;

let buy_1 = limit_buy(pair_1.clone(), 200u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 200u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();

/* pair 2 */
let price2 = Amount::from(2u64);

let buy_1 = limit_buy(pair_2.clone(), 50u64.into(), price2);
let buy_2 = limit_buy(pair_2.clone(), 50u64.into(), price2);
let buy_3 = limit_buy(pair_2.clone(), 50u64.into(), price2);
let buy_4 = limit_buy(pair_2.clone(), 50u64.into(), price2);
let buy_1 = create_buy(pair_2.clone(), 50u64.into(), price2);
let buy_2 = create_buy(pair_2.clone(), 50u64.into(), price2);
let buy_3 = create_buy(pair_2.clone(), 50u64.into(), price2);
let buy_4 = create_buy(pair_2.clone(), 50u64.into(), price2);

state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
Expand All @@ -703,11 +703,11 @@ async fn fill_route_constraint_1() -> anyhow::Result<()> {
let price3100 = 3100u64.into();
let price10000 = 10_000u64.into();

let buy_1 = limit_buy(pair_3.clone(), 1u64.into(), price2000);
let buy_2 = limit_buy(pair_3.clone(), 1u64.into(), price2500);
let buy_3 = limit_buy(pair_3.clone(), 198u64.into(), price3000);
let buy_4 = limit_buy(pair_3.clone(), 1u64.into(), price3100);
let buy_5 = limit_buy(pair_3.clone(), 1u64.into(), price10000);
let buy_1 = create_buy(pair_3.clone(), 1u64.into(), price2000);
let buy_2 = create_buy(pair_3.clone(), 1u64.into(), price2500);
let buy_3 = create_buy(pair_3.clone(), 198u64.into(), price3000);
let buy_4 = create_buy(pair_3.clone(), 1u64.into(), price3100);
let buy_5 = create_buy(pair_3.clone(), 1u64.into(), price10000);

state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
Expand Down Expand Up @@ -783,22 +783,22 @@ async fn fill_route_unconstrained() -> anyhow::Result<()> {

let one = 1u64.into();
let price1 = one;
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();

let buy_1 = limit_buy(pair_2.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_2.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_2.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_2.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();

let price1500 = 1500u64.into();
let buy_1 = limit_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_2 = limit_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_3 = limit_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_4 = limit_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_5 = limit_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_1 = create_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_2 = create_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_3 = create_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_4 = create_buy(pair_3.clone(), 1u64.into(), price1500);
let buy_5 = create_buy(pair_3.clone(), 1u64.into(), price1500);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
state_tx.open_position(buy_3).await.unwrap();
Expand Down Expand Up @@ -877,14 +877,14 @@ async fn fill_route_hit_spill_price() -> anyhow::Result<()> {

let one = 1u64.into();
let price1 = one;
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_1.clone(), 2u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_1.clone(), 2u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();

let buy_1 = limit_buy(pair_2.clone(), one, price1);
let buy_2 = limit_buy(pair_2.clone(), one, price1);
let buy_3 = limit_buy(pair_2.clone(), one, price1);
let buy_1 = create_buy(pair_2.clone(), one, price1);
let buy_2 = create_buy(pair_2.clone(), one, price1);
let buy_3 = create_buy(pair_2.clone(), one, price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
state_tx.open_position(buy_3).await.unwrap();
Expand All @@ -893,9 +893,9 @@ async fn fill_route_hit_spill_price() -> anyhow::Result<()> {
let price1400 = Amount::from(1400u64);
let price1300 = Amount::from(1300u64);

let buy_1 = limit_buy(pair_3.clone(), one, price1500);
let buy_2 = limit_buy(pair_3.clone(), one, price1400);
let buy_3 = limit_buy(pair_3.clone(), one, price1300);
let buy_1 = create_buy(pair_3.clone(), one, price1500);
let buy_2 = create_buy(pair_3.clone(), one, price1400);
let buy_3 = create_buy(pair_3.clone(), one, price1300);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
state_tx.open_position(buy_3).await.unwrap();
Expand Down Expand Up @@ -955,7 +955,7 @@ async fn simple_route() -> anyhow::Result<()> {
let pair_1 = DirectedUnitPair::new(gn.clone(), penumbra.clone());

// Create a single 1:1 gn:penumbra position (i.e. buy 1 gn at 1 penumbra).
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), 1u64.into());
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), 1u64.into());
state_tx.open_position(buy_1).await.unwrap();
state_tx.apply();

Expand Down Expand Up @@ -990,7 +990,7 @@ async fn best_position_route_and_fill() -> anyhow::Result<()> {
let pair_1 = DirectedUnitPair::new(gn.clone(), penumbra.clone());

// Create a single 1:1 gn:penumbra position (i.e. buy 1 gn at 1 penumbra).
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), 1u64.into());
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), 1u64.into());
state_tx.open_position(buy_1).await.unwrap();
state_tx.apply();

Expand Down Expand Up @@ -1068,7 +1068,7 @@ async fn multi_hop_route_and_fill() -> anyhow::Result<()> {
let pair_gm_penumbra = DirectedUnitPair::new(gm.clone(), penumbra.clone());

// Create a 2:1 penumbra:gm position (i.e. buy 20 gm at 2 penumbra each).
let buy_1 = limit_buy_pq(
let buy_1 = create_buy_pq(
pair_gm_penumbra.clone(),
5u64.into(),
1u64.into(),
Expand All @@ -1078,7 +1078,7 @@ async fn multi_hop_route_and_fill() -> anyhow::Result<()> {
state_tx.open_position(buy_1).await.unwrap();

// Create a 2.1:1 penumbra:gm position (i.e. buy 40 gm at 2.1 penumbra each).
let buy_2 = limit_buy_pq(
let buy_2 = create_buy_pq(
pair_gm_penumbra.clone(),
40u64.into(),
1000000u64.into(),
Expand All @@ -1088,7 +1088,7 @@ async fn multi_hop_route_and_fill() -> anyhow::Result<()> {
state_tx.open_position(buy_2).await.unwrap();

// Create a 2.2:1 penumbra:gm position (i.e. buy 160 gm at 2.2 penumbra each).
let buy_3 = limit_buy_pq(
let buy_3 = create_buy_pq(
pair_gm_penumbra.clone(),
160u64.into(),
1000000u64.into(),
Expand All @@ -1098,7 +1098,7 @@ async fn multi_hop_route_and_fill() -> anyhow::Result<()> {
state_tx.open_position(buy_3).await.unwrap();

// Create a 1:1 gm:gn position (i.e. buy 100 gm at 1 gn each).
let buy_4 = limit_buy_pq(
let buy_4 = create_buy_pq(
pair_gm_gn.clone(),
100u64.into(),
1u64.into(),
Expand All @@ -1123,7 +1123,7 @@ async fn multi_hop_route_and_fill() -> anyhow::Result<()> {
state_tx.open_position(buy_5).await.unwrap();

// Create a 1:1 gm:gn position (i.e. buy 100 gn at 1 gm each).
let buy_6 = limit_buy_pq(
let buy_6 = create_buy_pq(
pair_gn_gm.clone(),
100u64.into(),
1u64.into(),
Expand Down Expand Up @@ -1217,8 +1217,8 @@ async fn fill_dust_route() -> anyhow::Result<()> {

let one = 1u64.into();
let price1 = one;
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
let dust_constraint = Position::new(
Expand Down Expand Up @@ -1282,8 +1282,8 @@ async fn fill_route_dust() {

let one = 1u64.into();
let price1 = one;
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();
let dust_constraint = Position::new(
Expand Down Expand Up @@ -1347,8 +1347,8 @@ async fn fill_route_with_dust_constraint() -> anyhow::Result<()> {

let one = 1u64.into();
let price1 = one;
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();

Expand Down Expand Up @@ -1378,7 +1378,7 @@ async fn fill_route_with_dust_constraint() -> anyhow::Result<()> {

state_tx.open_position(dust_constraint).await.unwrap();
state_tx.open_position(normal_order).await.unwrap();
let buy_1 = limit_buy(pair_3, 100u64.into(), 1400u64.into());
let buy_1 = create_buy(pair_3, 100u64.into(), 1400u64.into());
state_tx.open_position(buy_1).await.unwrap();

let delta_1 = Value {
Expand Down Expand Up @@ -1435,8 +1435,8 @@ async fn fill_route_with_stacked_dust_constraint() -> anyhow::Result<()> {

let one = 1u64.into();
let price1 = one;
let buy_1 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = limit_buy(pair_1.clone(), 1u64.into(), price1);
let buy_1 = create_buy(pair_1.clone(), 1u64.into(), price1);
let buy_2 = create_buy(pair_1.clone(), 1u64.into(), price1);
state_tx.open_position(buy_1).await.unwrap();
state_tx.open_position(buy_2).await.unwrap();

Expand Down Expand Up @@ -1494,7 +1494,7 @@ async fn fill_route_with_stacked_dust_constraint() -> anyhow::Result<()> {
state_tx.open_position(dust_constraint_p3).await.unwrap();
state_tx.open_position(normal_order_p3).await.unwrap();

let buy_1 = limit_buy(pair_4, 100u64.into(), 1400u64.into());
let buy_1 = create_buy(pair_4, 100u64.into(), 1400u64.into());
state_tx.open_position(buy_1).await.unwrap();

let delta_1 = Value {
Expand Down
Loading

0 comments on commit d2c8dd5

Please sign in to comment.