Module `deepbook::clob`

Struct PoolCreated
Struct OrderPlacedV2
Struct OrderCanceled
Struct OrderFilledV2
Struct Order
Struct TickLevel
Struct Pool
Struct OrderPlaced
Struct OrderFilled
Constants
Function destroy_empty_level
Function create_account
Function create_pool
Function deposit_base
Function deposit_quote
Function withdraw_base
Function withdraw_quote
Function swap_exact_base_for_quote
Function swap_exact_quote_for_base
Function place_market_order
Function place_limit_order
Function order_is_bid
Function emit_order_canceled
Function cancel_order
Function remove_order
Function cancel_all_orders
Function batch_cancel_order
Function list_open_orders
Function account_balance
Function get_market_price
Function get_level2_book_status_bid_side
Function get_level2_book_status_ask_side
Function get_level2_book_status
Function get_order_status

<pre><code>use <a href="../deepbook/critbit.md#deepbook_critbit">deepbook::critbit</a>; use <a href="../deepbook/custodian.md#deepbook_custodian">deepbook::custodian</a>; use <a href="../deepbook/math.md#deepbook_math">deepbook::math</a>; use <a href="../std/address.md#std_address">std::address</a>; use <a href="../std/ascii.md#std_ascii">std::ascii</a>; use <a href="../std/bcs.md#std_bcs">std::bcs</a>; use <a href="../std/internal.md#std_internal">std::internal</a>; use <a href="../std/option.md#std_option">std::option</a>; use <a href="../std/string.md#std_string">std::string</a>; use <a href="../std/type_name.md#std_type_name">std::type_name</a>; use <a href="../std/u128.md#std_u128">std::u128</a>; use <a href="../std/vector.md#std_vector">std::vector</a>; use <a href="../sui/accumulator.md#sui_accumulator">sui::accumulator</a>; use <a href="../sui/accumulator_settlement.md#sui_accumulator_settlement">sui::accumulator_settlement</a>; use <a href="../sui/address.md#sui_address">sui::address</a>; use <a href="../sui/bag.md#sui_bag">sui::bag</a>; use <a href="../sui/balance.md#sui_balance">sui::balance</a>; use <a href="../sui/bcs.md#sui_bcs">sui::bcs</a>; use <a href="../sui/clock.md#sui_clock">sui::clock</a>; use <a href="../sui/coin.md#sui_coin">sui::coin</a>; use <a href="../sui/config.md#sui_config">sui::config</a>; use <a href="../sui/deny_list.md#sui_deny_list">sui::deny_list</a>; use <a href="../sui/dynamic_field.md#sui_dynamic_field">sui::dynamic_field</a>; use <a href="../sui/dynamic_object_field.md#sui_dynamic_object_field">sui::dynamic_object_field</a>; use <a href="../sui/event.md#sui_event">sui::event</a>; use <a href="../sui/funds_accumulator.md#sui_funds_accumulator">sui::funds_accumulator</a>; use <a href="../sui/hash.md#sui_hash">sui::hash</a>; use <a href="../sui/hex.md#sui_hex">sui::hex</a>; use <a href="../sui/linked_table.md#sui_linked_table">sui::linked_table</a>; use <a href="../sui/object.md#sui_object">sui::object</a>; use <a href="../sui/party.md#sui_party">sui::party</a>; use <a href="../sui/protocol_config.md#sui_protocol_config">sui::protocol_config</a>; use <a href="../sui/sui.md#sui_sui">sui::sui</a>; use <a href="../sui/table.md#sui_table">sui::table</a>; use <a href="../sui/transfer.md#sui_transfer">sui::transfer</a>; use <a href="../sui/tx_context.md#sui_tx_context">sui::tx_context</a>; use <a href="../sui/types.md#sui_types">sui::types</a>; use <a href="../sui/url.md#sui_url">sui::url</a>; use <a href="../sui/vec_map.md#sui_vec_map">sui::vec_map</a>; use <a href="../sui/vec_set.md#sui_vec_set">sui::vec_set</a>; </code></pre>

Struct `PoolCreated`

Emitted when a new pool is created

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_PoolCreated">PoolCreated</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the newly created pool </dd> <dt> <code>base_asset: <a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a></code> </dt> <dd> </dd> <dt> <code>quote_asset: <a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a></code> </dt> <dd> </dd> <dt> <code>taker_fee_rate: u64</code> </dt> <dd> </dd> <dt> <code>maker_rebate_rate: u64</code> </dt> <dd> </dd> <dt> <code>tick_size: u64</code> </dt> <dd> </dd> <dt> <code>lot_size: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `OrderPlacedV2`

Emitted when a maker order is injected into the order book.

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_OrderPlacedV2">OrderPlacedV2</a><phantom BaseAsset, phantom QuoteAsset> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the pool the order was placed on </dd> <dt> <code>order_id: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>is_bid: bool</code> </dt> <dd> </dd> <dt> <code>owner: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code>base_asset_quantity_placed: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> <dt> <code>expire_timestamp: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `OrderCanceled`

Emitted when a maker order is canceled.

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_OrderCanceled">OrderCanceled</a><phantom BaseAsset, phantom QuoteAsset> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the pool the order was placed on </dd> <dt> <code>order_id: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>is_bid: bool</code> </dt> <dd> </dd> <dt> <code>owner: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code>base_asset_quantity_canceled: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `OrderFilledV2`

Emitted only when a maker order is filled.

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_OrderFilledV2">OrderFilledV2</a><phantom BaseAsset, phantom QuoteAsset> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the pool the order was placed on </dd> <dt> <code>order_id: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>is_bid: bool</code> </dt> <dd> </dd> <dt> <code>owner: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code>total_quantity: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_filled: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_remaining: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> <dt> <code>taker_commission: u64</code> </dt> <dd> </dd> <dt> <code>maker_rebates: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `Order`

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_Order">Order</a> has drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>order_id: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> <dt> <code>quantity: u64</code> </dt> <dd> </dd> <dt> <code>is_bid: bool</code> </dt> <dd> </dd> <dt> <code>owner: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> </dd> <dt> <code>expire_timestamp: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `TickLevel`

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_TickLevel">TickLevel</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>price: u64</code> </dt> <dd> </dd> <dt> <code>open_orders: <a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, <a href="../deepbook/clob.md#deepbook_clob_Order">deepbook::clob::Order</a>></code> </dt> <dd> </dd> </dl> </details>

Struct `Pool`

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><phantom BaseAsset, phantom QuoteAsset> has key </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>id: <a href="../sui/object.md#sui_object_UID">sui::object::UID</a></code> </dt> <dd> </dd> <dt> <code>bids: <a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob.md#deepbook_clob_TickLevel">deepbook::clob::TickLevel</a>></code> </dt> <dd> </dd> <dt> <code>asks: <a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob.md#deepbook_clob_TickLevel">deepbook::clob::TickLevel</a>></code> </dt> <dd> </dd> <dt> <code>next_bid_order_id: u64</code> </dt> <dd> </dd> <dt> <code>next_ask_order_id: u64</code> </dt> <dd> </dd> <dt> <code>usr_open_orders: <a href="../sui/table.md#sui_table_Table">sui::table::Table</a><<a href="../sui/object.md#sui_object_ID">sui::object::ID</a>, <a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, u64>></code> </dt> <dd> </dd> <dt> <code>taker_fee_rate: u64</code> </dt> <dd> </dd> <dt> <code>maker_rebate_rate: u64</code> </dt> <dd> </dd> <dt> <code>tick_size: u64</code> </dt> <dd> </dd> <dt> <code>lot_size: u64</code> </dt> <dd> </dd> <dt> <code>base_custodian: <a href="../deepbook/custodian.md#deepbook_custodian_Custodian">deepbook::custodian::Custodian</a><BaseAsset></code> </dt> <dd> </dd> <dt> <code>quote_custodian: <a href="../deepbook/custodian.md#deepbook_custodian_Custodian">deepbook::custodian::Custodian</a><QuoteAsset></code> </dt> <dd> </dd> <dt> <code>creation_fee: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>></code> </dt> <dd> </dd> <dt> <code>base_asset_trading_fees: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><BaseAsset></code> </dt> <dd> </dd> <dt> <code>quote_asset_trading_fees: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><QuoteAsset></code> </dt> <dd> </dd> </dl> </details>

Struct `OrderPlaced`

Deprecated since v1.0.0, use <code><a href="../deepbook/clob.md#deepbook_clob_OrderPlacedV2">OrderPlacedV2</a></code> instead.

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_OrderPlaced">OrderPlaced</a><phantom BaseAsset, phantom QuoteAsset> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the pool the order was placed on </dd> <dt> <code>order_id: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>is_bid: bool</code> </dt> <dd> </dd> <dt> <code>owner: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code>base_asset_quantity_placed: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `OrderFilled`

Deprecated since v1.0.0, use <code><a href="../deepbook/clob.md#deepbook_clob_OrderFilledV2">OrderFilledV2</a></code> instead.

<pre><code>public struct <a href="../deepbook/clob.md#deepbook_clob_OrderFilled">OrderFilled</a><phantom BaseAsset, phantom QuoteAsset> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the pool the order was placed on </dd> <dt> <code>order_id: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>is_bid: bool</code> </dt> <dd> </dd> <dt> <code>owner: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> object ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code>total_quantity: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_filled: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_remaining: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> </dl> </details>

Constants

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_DEPRECATED">DEPRECATED</a>: u64 = 0; </code></pre>

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_EInvalidOrderId">EInvalidOrderId</a>: u64 = 3; </code></pre>

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_EUnauthorizedCancel">EUnauthorizedCancel</a>: u64 = 4; </code></pre>

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_EInvalidQuantity">EInvalidQuantity</a>: u64 = 6; </code></pre>

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_EInvalidTickPrice">EInvalidTickPrice</a>: u64 = 11; </code></pre>

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_EInvalidUser">EInvalidUser</a>: u64 = 12; </code></pre>

<pre><code>const <a href="../deepbook/clob.md#deepbook_clob_MIN_ASK_ORDER_ID">MIN_ASK_ORDER_ID</a>: u64 = 9223372036854775808; </code></pre>

Function `destroy_empty_level`

<pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_destroy_empty_level">destroy_empty_level</a>(level: <a href="../deepbook/clob.md#deepbook_clob_TickLevel">deepbook::clob::TickLevel</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_destroy_empty_level">destroy_empty_level</a>(level: <a href="../deepbook/clob.md#deepbook_clob_TickLevel">TickLevel</a>) { let <a href="../deepbook/clob.md#deepbook_clob_TickLevel">TickLevel</a> { price: _, open_orders: orders, } = level; linked_table::destroy_empty(orders); } </code></pre> </details>

Function `create_account`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_create_account">create_account</a>(_ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_create_account">create_account</a>(_ctx: &mut TxContext): AccountCap { abort <a href="../deepbook/clob.md#deepbook_clob_DEPRECATED">DEPRECATED</a> } </code></pre> </details>

Function `create_pool`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_create_pool">create_pool</a><BaseAsset, QuoteAsset>(_tick_size: u64, _lot_size: u64, _creation_fee: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>>, _ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_create_pool">create_pool</a><BaseAsset, QuoteAsset>( _tick_size: u64, _lot_size: u64, _creation_fee: Coin<SUI>, _ctx: &mut TxContext, ) { abort <a href="../deepbook/clob.md#deepbook_clob_DEPRECATED">DEPRECATED</a> } </code></pre> </details>

Function `deposit_base`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_deposit_base">deposit_base</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, _coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, _account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_deposit_base">deposit_base</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, _coin: Coin<BaseAsset>, _account_cap: &AccountCap ) { abort 1337 } </code></pre> </details>

Function `deposit_quote`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_deposit_quote">deposit_quote</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, _coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, _account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_deposit_quote">deposit_quote</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, _coin: Coin<QuoteAsset>, _account_cap: &AccountCap ) { abort 1337 } </code></pre> </details>

Function `withdraw_base`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_withdraw_base">withdraw_base</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, quantity: u64, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_withdraw_base">withdraw_base</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, quantity: u64, account_cap: &AccountCap, ctx: &mut TxContext ): Coin<BaseAsset> { assert!(quantity > 0, <a href="../deepbook/clob.md#deepbook_clob_EInvalidQuantity">EInvalidQuantity</a>); <a href="../deepbook/custodian.md#deepbook_custodian_withdraw_asset">custodian::withdraw_asset</a>(&mut pool.base_custodian, quantity, account_cap, ctx) } </code></pre> </details>

Function `withdraw_quote`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_withdraw_quote">withdraw_quote</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, quantity: u64, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_withdraw_quote">withdraw_quote</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, quantity: u64, account_cap: &AccountCap, ctx: &mut TxContext ): Coin<QuoteAsset> { assert!(quantity > 0, <a href="../deepbook/clob.md#deepbook_clob_EInvalidQuantity">EInvalidQuantity</a>); <a href="../deepbook/custodian.md#deepbook_custodian_withdraw_asset">custodian::withdraw_asset</a>(&mut pool.quote_custodian, quantity, account_cap, ctx) } </code></pre> </details>

Function `swap_exact_base_for_quote`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_swap_exact_base_for_quote">swap_exact_base_for_quote</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, _quantity: u64, _base_coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, _quote_coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, _clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>, _ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): (<a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_swap_exact_base_for_quote">swap_exact_base_for_quote</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, _quantity: u64, _base_coin: Coin<BaseAsset>, _quote_coin: Coin<QuoteAsset>, _clock: &Clock, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>, u64) { abort 1337 } </code></pre> </details>

Function `swap_exact_quote_for_base`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_swap_exact_quote_for_base">swap_exact_quote_for_base</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, _quantity: u64, _clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>, _quote_coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, _ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): (<a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_swap_exact_quote_for_base">swap_exact_quote_for_base</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, _quantity: u64, _clock: &Clock, _quote_coin: Coin<QuoteAsset>, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>, u64) { abort 1337 } </code></pre> </details>

Function `place_market_order`

Place a market order to the order book.

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_place_market_order">place_market_order</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, _quantity: u64, _is_bid: bool, _base_coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, _quote_coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, _clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>, _ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): (<a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_place_market_order">place_market_order</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, _quantity: u64, _is_bid: bool, mut _base_coin: Coin<BaseAsset>, mut _quote_coin: Coin<QuoteAsset>, _clock: &Clock, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>) { abort 1337 } </code></pre> </details>

Function `place_limit_order`

Place a limit order to the order book. Returns (base quantity filled, quote quantity filled, whether a maker order is being placed, order id of the maker order). When the limit order is not successfully placed, we return false to indicate that and also returns a meaningless order_id 0. When the limit order is successfully placed, we return true to indicate that and also the corresponding order_id. So please check that boolean value first before using the order id.

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_place_limit_order">place_limit_order</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, _price: u64, _quantity: u64, _is_bid: bool, _expire_timestamp: u64, _restriction: u8, _clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>, _account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>, _ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): (u64, u64, bool, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_place_limit_order">place_limit_order</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, _price: u64, _quantity: u64, _is_bid: bool, _expire_timestamp: u64, // Expiration timestamp in ms in absolute value inclusive. _restriction: u8, _clock: &Clock, _account_cap: &AccountCap, _ctx: &mut TxContext ): (u64, u64, bool, u64) { abort 1337 } </code></pre> </details>

Function `order_is_bid`

<pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_order_is_bid">order_is_bid</a>(order_id: u64): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_order_is_bid">order_is_bid</a>(order_id: u64): bool { return order_id < <a href="../deepbook/clob.md#deepbook_clob_MIN_ASK_ORDER_ID">MIN_ASK_ORDER_ID</a> } </code></pre> </details>

Function `emit_order_canceled`

<pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_emit_order_canceled">emit_order_canceled</a><BaseAsset, QuoteAsset>(pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a>, order: &<a href="../deepbook/clob.md#deepbook_clob_Order">deepbook::clob::Order</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_emit_order_canceled">emit_order_canceled</a><BaseAsset, QuoteAsset>( pool_id: ID, order: &<a href="../deepbook/clob.md#deepbook_clob_Order">Order</a> ) { event::emit(<a href="../deepbook/clob.md#deepbook_clob_OrderCanceled">OrderCanceled</a><BaseAsset, QuoteAsset> { pool_id, order_id: order.order_id, is_bid: order.is_bid, owner: order.owner, base_asset_quantity_canceled: order.quantity, price: order.price }) } </code></pre> </details>

Function `cancel_order`

Cancel and opening order. Abort if order_id is invalid or if the order is not submitted by the transaction sender.

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_cancel_order">cancel_order</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, order_id: u64, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_cancel_order">cancel_order</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, order_id: u64, account_cap: &AccountCap ) { // First check the highest bit of the order id to see whether it's bid or ask. // Then retrieve the price using the order id. // Using the price to retrieve the corresponding PriceLevel from the bids / asks Critbit Tree. // Retrieve and remove the order from open orders of the PriceLevel. let user = object::id(account_cap); assert!(contains(&pool.usr_open_orders, user), <a href="../deepbook/clob.md#deepbook_clob_EInvalidUser">EInvalidUser</a>); let usr_open_orders = borrow_mut(&mut pool.usr_open_orders, user); assert!(linked_table::contains(usr_open_orders, order_id), <a href="../deepbook/clob.md#deepbook_clob_EInvalidOrderId">EInvalidOrderId</a>); let tick_price = *linked_table::borrow(usr_open_orders, order_id); let is_bid = <a href="../deepbook/clob.md#deepbook_clob_order_is_bid">order_is_bid</a>(order_id); let (tick_exists, tick_index) = find_leaf( if (is_bid) { &pool.bids } else { &pool.asks }, tick_price); assert!(tick_exists, <a href="../deepbook/clob.md#deepbook_clob_EInvalidOrderId">EInvalidOrderId</a>); let order = <a href="../deepbook/clob.md#deepbook_clob_remove_order">remove_order</a>( if (is_bid) { &mut pool.bids } else { &mut pool.asks }, usr_open_orders, tick_index, order_id, user ); if (is_bid) { let balance_locked = clob_math::mul(order.quantity, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, user, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, user, order.quantity); }; <a href="../deepbook/clob.md#deepbook_clob_emit_order_canceled">emit_order_canceled</a><BaseAsset, QuoteAsset>(*object::uid_as_inner(&pool.id), &order); } </code></pre> </details>

Function `remove_order`

<pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_remove_order">remove_order</a>(open_orders: &mut <a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob.md#deepbook_clob_TickLevel">deepbook::clob::TickLevel</a>>, usr_open_orders: &mut <a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, u64>, tick_index: u64, order_id: u64, user: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a>): <a href="../deepbook/clob.md#deepbook_clob_Order">deepbook::clob::Order</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_remove_order">remove_order</a>( open_orders: &mut CritbitTree<<a href="../deepbook/clob.md#deepbook_clob_TickLevel">TickLevel</a>>, usr_open_orders: &mut LinkedTable<u64, u64>, tick_index: u64, order_id: u64, user: ID, ): <a href="../deepbook/clob.md#deepbook_clob_Order">Order</a> { linked_table::remove(usr_open_orders, order_id); let tick_level = borrow_leaf_by_index(open_orders, tick_index); assert!(linked_table::contains(&tick_level.open_orders, order_id), <a href="../deepbook/clob.md#deepbook_clob_EInvalidOrderId">EInvalidOrderId</a>); let mut_tick_level = borrow_mut_leaf_by_index(open_orders, tick_index); let order = linked_table::remove(&mut mut_tick_level.open_orders, order_id); assert!(order.owner == user, <a href="../deepbook/clob.md#deepbook_clob_EUnauthorizedCancel">EUnauthorizedCancel</a>); if (linked_table::is_empty(&mut_tick_level.open_orders)) { <a href="../deepbook/clob.md#deepbook_clob_destroy_empty_level">destroy_empty_level</a>(remove_leaf_by_index(open_orders, tick_index)); }; order } </code></pre> </details>

Function `cancel_all_orders`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_cancel_all_orders">cancel_all_orders</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_cancel_all_orders">cancel_all_orders</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, account_cap: &AccountCap ) { let pool_id = *object::uid_as_inner(&pool.id); let user = object::id(account_cap); assert!(contains(&pool.usr_open_orders, user), <a href="../deepbook/clob.md#deepbook_clob_EInvalidUser">EInvalidUser</a>); let usr_open_order_ids = table::borrow_mut(&mut pool.usr_open_orders, user); while (!linked_table::is_empty(usr_open_order_ids)) { let order_id = *option::borrow(linked_table::back(usr_open_order_ids)); let order_price = *linked_table::borrow(usr_open_order_ids, order_id); let is_bid = <a href="../deepbook/clob.md#deepbook_clob_order_is_bid">order_is_bid</a>(order_id); let open_orders = if (is_bid) { &mut pool.bids } else { &mut pool.asks }; let (_, tick_index) = <a href="../deepbook/critbit.md#deepbook_critbit_find_leaf">critbit::find_leaf</a>(open_orders, order_price); let order = <a href="../deepbook/clob.md#deepbook_clob_remove_order">remove_order</a>( open_orders, usr_open_order_ids, tick_index, order_id, user ); if (is_bid) { let balance_locked = clob_math::mul(order.quantity, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, user, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, user, order.quantity); }; <a href="../deepbook/clob.md#deepbook_clob_emit_order_canceled">emit_order_canceled</a><BaseAsset, QuoteAsset>(pool_id, &order); }; } </code></pre> </details>

Function `batch_cancel_order`

Batch cancel limit orders to save gas cost. Abort if any of the order_ids are not submitted by the sender. Skip any order_id that is invalid. Note that this function can reduce gas cost even further if caller has multiple orders at the same price level, and if orders with the same price are grouped together in the vector. For example, if we have the following order_id to price mapping, {0: 100., 1: 200., 2: 100., 3: 200.}. Grouping order_ids like [0, 2, 1, 3] would make it the most gas efficient.

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_batch_cancel_order">batch_cancel_order</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, order_ids: vector<u64>, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_batch_cancel_order">batch_cancel_order</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, order_ids: vector<u64>, account_cap: &AccountCap ) { let pool_id = *object::uid_as_inner(&pool.id); // First group the order ids according to price level, // so that we don't have to retrieve the PriceLevel multiple times if there are orders at the same price level. // Iterate over each price level, retrieve the corresponding PriceLevel. // Iterate over the order ids that need to be canceled at that price level, // retrieve and remove the order from open orders of the PriceLevel. let user = object::id(account_cap); assert!(contains(&pool.usr_open_orders, user), 0); let mut tick_index: u64 = 0; let mut tick_price: u64 = 0; let n_order = vector::length(&order_ids); let mut i_order = 0; let usr_open_orders = borrow_mut(&mut pool.usr_open_orders, user); while (i_order < n_order) { let order_id = *vector::borrow(&order_ids, i_order); assert!(linked_table::contains(usr_open_orders, order_id), <a href="../deepbook/clob.md#deepbook_clob_EInvalidOrderId">EInvalidOrderId</a>); let new_tick_price = *linked_table::borrow(usr_open_orders, order_id); let is_bid = <a href="../deepbook/clob.md#deepbook_clob_order_is_bid">order_is_bid</a>(order_id); if (new_tick_price != tick_price) { tick_price = new_tick_price; let (tick_exists, new_tick_index) = find_leaf( if (is_bid) { &pool.bids } else { &pool.asks }, tick_price ); assert!(tick_exists, <a href="../deepbook/clob.md#deepbook_clob_EInvalidTickPrice">EInvalidTickPrice</a>); tick_index = new_tick_index; }; let order = <a href="../deepbook/clob.md#deepbook_clob_remove_order">remove_order</a>( if (is_bid) { &mut pool.bids } else { &mut pool.asks }, usr_open_orders, tick_index, order_id, user ); if (is_bid) { let balance_locked = clob_math::mul(order.quantity, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, user, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, user, order.quantity); }; <a href="../deepbook/clob.md#deepbook_clob_emit_order_canceled">emit_order_canceled</a><BaseAsset, QuoteAsset>(pool_id, &order); i_order = i_order + 1; } } </code></pre> </details>

Function `list_open_orders`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_list_open_orders">list_open_orders</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>): vector<<a href="../deepbook/clob.md#deepbook_clob_Order">deepbook::clob::Order</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_list_open_orders">list_open_orders</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, account_cap: &AccountCap ): vector<<a href="../deepbook/clob.md#deepbook_clob_Order">Order</a>> { let user = object::id(account_cap); let usr_open_order_ids = table::borrow(&pool.usr_open_orders, user); let mut open_orders = vector::empty<<a href="../deepbook/clob.md#deepbook_clob_Order">Order</a>>(); let mut order_id = linked_table::front(usr_open_order_ids); while (!option::is_none(order_id)) { let order_price = *linked_table::borrow(usr_open_order_ids, *option::borrow(order_id)); let tick_level = if (<a href="../deepbook/clob.md#deepbook_clob_order_is_bid">order_is_bid</a>(*option::borrow(order_id))) borrow_leaf_by_key(&pool.bids, order_price) else borrow_leaf_by_key(&pool.asks, order_price); let order = linked_table::borrow(&tick_level.open_orders, *option::borrow(order_id)); vector::push_back(&mut open_orders, <a href="../deepbook/clob.md#deepbook_clob_Order">Order</a> { order_id: order.order_id, price: order.price, quantity: order.quantity, is_bid: order.is_bid, owner: order.owner, expire_timestamp: order.expire_timestamp }); order_id = linked_table::next(usr_open_order_ids, *option::borrow(order_id)); }; open_orders } </code></pre> </details>

Function `account_balance`

query user balance inside custodian

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_account_balance">account_balance</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>): (u64, u64, u64, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_account_balance">account_balance</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, account_cap: &AccountCap ): (u64, u64, u64, u64) { let user = object::id(account_cap); let (base_avail, base_locked) = <a href="../deepbook/custodian.md#deepbook_custodian_account_balance">custodian::account_balance</a>(&pool.base_custodian, user); let (quote_avail, quote_locked) = <a href="../deepbook/custodian.md#deepbook_custodian_account_balance">custodian::account_balance</a>(&pool.quote_custodian, user); (base_avail, base_locked, quote_avail, quote_locked) } </code></pre> </details>

Function `get_market_price`

Query the market price of order book returns (best_bid_price, best_ask_price)

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_market_price">get_market_price</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>): (u64, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_market_price">get_market_price</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset> ): (u64, u64){ let (bid_price, _) = <a href="../deepbook/critbit.md#deepbook_critbit_max_leaf">critbit::max_leaf</a>(&pool.bids); let (ask_price, _) = <a href="../deepbook/critbit.md#deepbook_critbit_min_leaf">critbit::min_leaf</a>(&pool.asks); return (bid_price, ask_price) } </code></pre> </details>

Function `get_level2_book_status_bid_side`

Enter a price range and return the level2 order depth of all valid prices within this price range in bid side returns two vectors of u64 The previous is a list of all valid prices The latter is the corresponding depth list

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status_bid_side">get_level2_book_status_bid_side</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, price_low: u64, price_high: u64, clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>): (vector<u64>, vector<u64>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status_bid_side">get_level2_book_status_bid_side</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, mut price_low: u64, mut price_high: u64, clock: &Clock ): (vector<u64>, vector<u64>) { let (price_low_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_min_leaf">critbit::min_leaf</a>(&pool.bids); if (price_low < price_low_) price_low = price_low_; let (price_high_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_max_leaf">critbit::max_leaf</a>(&pool.bids); if (price_high > price_high_) price_high = price_high_; price_low = <a href="../deepbook/critbit.md#deepbook_critbit_find_closest_key">critbit::find_closest_key</a>(&pool.bids, price_low); price_high = <a href="../deepbook/critbit.md#deepbook_critbit_find_closest_key">critbit::find_closest_key</a>(&pool.bids, price_high); let mut price_vec = vector::empty<u64>(); let mut depth_vec = vector::empty<u64>(); if (price_low == 0) { return (price_vec, depth_vec) }; while (price_low <= price_high) { let depth = <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status">get_level2_book_status</a>( &pool.bids, price_low, clock::timestamp_ms(clock) ); vector::push_back(&mut price_vec, price_low); vector::push_back(&mut depth_vec, depth); let (next_price, _) = <a href="../deepbook/critbit.md#deepbook_critbit_next_leaf">critbit::next_leaf</a>(&pool.bids, price_low); if (next_price == 0) { break } else { price_low = next_price }; }; (price_vec, depth_vec) } </code></pre> </details>

Function `get_level2_book_status_ask_side`

Enter a price range and return the level2 order depth of all valid prices within this price range in ask side returns two vectors of u64 The previous is a list of all valid prices The latter is the corresponding depth list

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status_ask_side">get_level2_book_status_ask_side</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, price_low: u64, price_high: u64, clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>): (vector<u64>, vector<u64>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status_ask_side">get_level2_book_status_ask_side</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, mut price_low: u64, mut price_high: u64, clock: &Clock ): (vector<u64>, vector<u64>) { let (price_low_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_min_leaf">critbit::min_leaf</a>(&pool.asks); if (price_low < price_low_) price_low = price_low_; let (price_high_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_max_leaf">critbit::max_leaf</a>(&pool.asks); if (price_high > price_high_) price_high = price_high_; price_low = <a href="../deepbook/critbit.md#deepbook_critbit_find_closest_key">critbit::find_closest_key</a>(&pool.asks, price_low); price_high = <a href="../deepbook/critbit.md#deepbook_critbit_find_closest_key">critbit::find_closest_key</a>(&pool.asks, price_high); let mut price_vec = vector::empty<u64>(); let mut depth_vec = vector::empty<u64>(); if (price_low == 0) { return (price_vec, depth_vec) }; while (price_low <= price_high) { let depth = <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status">get_level2_book_status</a>( &pool.asks, price_low, clock::timestamp_ms(clock) ); vector::push_back(&mut price_vec, price_low); vector::push_back(&mut depth_vec, depth); let (next_price, _) = <a href="../deepbook/critbit.md#deepbook_critbit_next_leaf">critbit::next_leaf</a>(&pool.asks, price_low); if (next_price == 0) { break } else { price_low = next_price }; }; (price_vec, depth_vec) } </code></pre> </details>

Function `get_level2_book_status`

internal func to retrieve single depth of a tick price

<pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status">get_level2_book_status</a>(open_orders: &<a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob.md#deepbook_clob_TickLevel">deepbook::clob::TickLevel</a>>, price: u64, time_stamp: u64): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob.md#deepbook_clob_get_level2_book_status">get_level2_book_status</a>( open_orders: &CritbitTree<<a href="../deepbook/clob.md#deepbook_clob_TickLevel">TickLevel</a>>, price: u64, time_stamp: u64 ): u64 { let tick_level = <a href="../deepbook/critbit.md#deepbook_critbit_borrow_leaf_by_key">critbit::borrow_leaf_by_key</a>(open_orders, price); let tick_open_orders = &tick_level.open_orders; let mut depth = 0; let mut order_id = linked_table::front(tick_open_orders); let mut order: &<a href="../deepbook/clob.md#deepbook_clob_Order">Order</a>; while (!option::is_none(order_id)) { order = linked_table::borrow(tick_open_orders, *option::borrow(order_id)); if (order.expire_timestamp > time_stamp) depth = depth + order.quantity; order_id = linked_table::next(tick_open_orders, *option::borrow(order_id)); }; depth } </code></pre> </details>

Function `get_order_status`

<pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_order_status">get_order_status</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">deepbook::clob::Pool</a><BaseAsset, QuoteAsset>, order_id: u64, account_cap: &<a href="../deepbook/custodian.md#deepbook_custodian_AccountCap">deepbook::custodian::AccountCap</a>): &<a href="../deepbook/clob.md#deepbook_clob_Order">deepbook::clob::Order</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob.md#deepbook_clob_get_order_status">get_order_status</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob.md#deepbook_clob_Pool">Pool</a><BaseAsset, QuoteAsset>, order_id: u64, account_cap: &AccountCap ): &<a href="../deepbook/clob.md#deepbook_clob_Order">Order</a> { let user = object::id(account_cap); assert!(table::contains(&pool.usr_open_orders, user), <a href="../deepbook/clob.md#deepbook_clob_EInvalidUser">EInvalidUser</a>); let usr_open_order_ids = table::borrow(&pool.usr_open_orders, user); assert!(linked_table::contains(usr_open_order_ids, order_id), <a href="../deepbook/clob.md#deepbook_clob_EInvalidOrderId">EInvalidOrderId</a>); let order_price = *linked_table::borrow(usr_open_order_ids, order_id); let open_orders = if (order_id < <a href="../deepbook/clob.md#deepbook_clob_MIN_ASK_ORDER_ID">MIN_ASK_ORDER_ID</a>) { &pool.bids } else { &pool.asks }; let tick_level = <a href="../deepbook/critbit.md#deepbook_critbit_borrow_leaf_by_key">critbit::borrow_leaf_by_key</a>(open_orders, order_price); let tick_open_orders = &tick_level.open_orders; let order = linked_table::borrow(tick_open_orders, order_id); order } </code></pre> </details>

Struct PoolCreated

Struct OrderPlacedV2

Struct OrderCanceled

Struct OrderFilledV2

Struct Order

Struct TickLevel

Struct Pool

Struct OrderPlaced

Struct OrderFilled

Constants

Function destroy_empty_level

Function create_account

Function create_pool

Function deposit_base

Function deposit_quote

Function withdraw_base

Function withdraw_quote

Function swap_exact_base_for_quote

Function swap_exact_quote_for_base

Function place_market_order

Function place_limit_order

Function order_is_bid

Function emit_order_canceled

Function cancel_order

Function remove_order

Function cancel_all_orders

Function batch_cancel_order

Function list_open_orders

Function account_balance

Function get_market_price

Function get_level2_book_status_bid_side

Function get_level2_book_status_ask_side

Function get_level2_book_status

Function get_order_status