Module `deepbook::clob_v2`

Struct PoolCreated
Struct OrderPlaced
Struct OrderCanceled
Struct AllOrdersCanceledComponent
Struct AllOrdersCanceled
Struct OrderFilled
Struct DepositAsset
Struct WithdrawAsset
Struct MatchedOrderMetadata
Struct Order
Struct TickLevel
Struct Pool
Struct PoolOwnerCap
Constants
Function usr_open_orders_exist
Function usr_open_orders_for_address
Function usr_open_orders
Function withdraw_fees
Function delete_pool_owner_cap
Function destroy_empty_level
Function create_account
Function create_pool
Function create_customized_pool
Function create_pool_with_return
Function create_customized_pool_with_return
Function create_customized_pool_v2
Function deposit_base
Function deposit_quote
Function withdraw_base
Function withdraw_quote
Function swap_exact_base_for_quote
Function swap_exact_base_for_quote_with_metadata
Function swap_exact_quote_for_base
Function swap_exact_quote_for_base_with_metadata
Function place_market_order
Function place_market_order_with_metadata
Function place_limit_order
Function place_limit_order_with_metadata
Function order_is_bid
Function emit_order_canceled
Function cancel_order
Function remove_order
Function cancel_all_orders
Function batch_cancel_order
Function clean_up_expired_orders
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
Function matched_order_metadata_info
Function asks
Function bids
Function tick_size
Function maker_rebate_rate
Function taker_fee_rate
Function pool_size
Function open_orders
Function order_id
Function tick_level
Function original_quantity
Function quantity
Function is_bid
Function owner
Function expire_timestamp
Function quote_asset_trading_fees_value
Function clone_order

<pre><code>use <a href="../deepbook/critbit.md#deepbook_critbit">deepbook::critbit</a>; use <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2">deepbook::custodian_v2</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_v2.md#deepbook_clob_v2_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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_taker_fee_rate">taker_fee_rate</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_maker_rebate_rate">maker_rebate_rate</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_size">tick_size</a>: u64</code> </dt> <dd> </dd> <dt> <code>lot_size: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `OrderPlaced`

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

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>client_order_id: u64</code> </dt> <dd> ID of the order defined by client </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: bool</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_placed: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `OrderCanceled`

Emitted when a maker order is canceled.

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>client_order_id: u64</code> </dt> <dd> ID of the order defined by client </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: bool</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that canceled the order </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_canceled: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `AllOrdersCanceledComponent`

A struct to make all orders canceled a more efficient struct

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceledComponent">AllOrdersCanceledComponent</a><phantom BaseAsset, phantom QuoteAsset> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>client_order_id: u64</code> </dt> <dd> ID of the order defined by client </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: bool</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that canceled the order </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: u64</code> </dt> <dd> </dd> <dt> <code>base_asset_quantity_canceled: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `AllOrdersCanceled`

Emitted when batch of orders are canceled.

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceled">AllOrdersCanceled</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>orders_canceled: vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceledComponent">deepbook::clob_v2::AllOrdersCanceledComponent</a><BaseAsset, QuoteAsset>></code> </dt> <dd> </dd> </dl> </details>

Struct `OrderFilled`

Emitted only when a maker order is filled.

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code>taker_client_order_id: u64</code> </dt> <dd> ID of the order defined by taker client </dd> <dt> <code>maker_client_order_id: u64</code> </dt> <dd> ID of the order defined by maker client </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: bool</code> </dt> <dd> </dd> <dt> <code>taker_address: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that filled the order </dd> <dt> <code>maker_address: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: 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 `DepositAsset`

Emitted when user deposit asset to custodian

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_DepositAsset">DepositAsset</a><phantom Asset> 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 that asset deposit to </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64</code> </dt> <dd> quantity of the asset deposited </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> owner address of the <code>AccountCap</code> that deposit the asset </dd> </dl> </details>

Struct `WithdrawAsset`

Emitted when user withdraw asset from custodian

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_WithdrawAsset">WithdrawAsset</a><phantom Asset> 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 that asset withdraw from </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64</code> </dt> <dd> quantity of the asset user withdrew </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that withdrew the asset </dd> </dl> </details>

Struct `MatchedOrderMetadata`

Returned as metadata only when a maker order is filled from place order functions.

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">MatchedOrderMetadata</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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64</code> </dt> <dd> ID of the order within the pool </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: bool</code> </dt> <dd> Direction of order. </dd> <dt> <code>taker_address: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that filled the order </dd> <dt> <code>maker_address: address</code> </dt> <dd> owner ID of the <code>AccountCap</code> that placed the order </dd> <dt> <code>base_asset_quantity_filled: u64</code> </dt> <dd> qty of base asset filled. </dd> <dt> <code>price: u64</code> </dt> <dd> price at which basset asset filled. </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_v2.md#deepbook_clob_v2_Order">Order</a> has drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64</code> </dt> <dd> </dd> <dt> <code>client_order_id: u64</code> </dt> <dd> </dd> <dt> <code>price: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: bool</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> Order can only be canceled by the <code>AccountCap</code> with this owner ID </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>: u64</code> </dt> <dd> </dd> <dt> <code>self_matching_prevention: u8</code> </dt> <dd> </dd> </dl> </details>

Struct `TickLevel`

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

Struct `Pool`

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><phantom BaseAsset, phantom QuoteAsset> has key, store </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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>: <a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::TickLevel</a>></code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>: <a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>: <a href="../sui/table.md#sui_table_Table">sui::table::Table</a><address, <a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, u64>></code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_taker_fee_rate">taker_fee_rate</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_maker_rebate_rate">maker_rebate_rate</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_size">tick_size</a>: u64</code> </dt> <dd> </dd> <dt> <code>lot_size: u64</code> </dt> <dd> </dd> <dt> <code>base_custodian: <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><BaseAsset></code> </dt> <dd> </dd> <dt> <code>quote_custodian: <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::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 `PoolOwnerCap`

Capability granting permission to access an entry in <code><a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a>.quote_asset_trading_fees</code>. The pool objects created for older pools do not have a PoolOwnerCap because they were created prior to the addition of this feature. Here is a list of 11 pools on mainnet that do not have this capability: 0x31d1790e617eef7f516555124155b28d663e5c600317c769a75ee6336a54c07f 0x6e417ee1c12ad5f2600a66bc80c7bd52ff3cb7c072d508700d17cf1325324527 0x17625f1a241d34d2da0dc113086f67a2b832e3e8cd8006887c195cd24d3598a3 0x276ff4d99ecb3175091ba4baffa9b07590f84e2344e3f16e95d30d2c1678b84c 0xd1f0a9baacc1864ab19534e2d4c5d6c14f2e071a1f075e8e7f9d51f2c17dc238 0x4405b50d791fd3346754e8171aaab6bc2ed26c2c46efdd033c14b30ae507ac33 0xf0f663cf87f1eb124da2fc9be813e0ce262146f3df60bc2052d738eb41a25899 0xd9e45ab5440d61cc52e3b2bd915cdd643146f7593d587c715bc7bfa48311d826 0x5deafda22b6b86127ea4299503362638bea0ca33bb212ea3a67b029356b8b955 0x7f526b1263c4b91b43c9e646419b5696f424de28dda3c1e6658cc0a54558baa7 0x18d871e3c3da99046dfc0d3de612c5d88859bc03b8f0568bd127d0e70dbc58be

<pre><code>public struct <a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">PoolOwnerCap</a> has key, store </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><a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address</code> </dt> <dd> The owner of this AccountCap. Note: this is derived from an object ID, not a user address </dd> </dl> </details>

Constants

<pre><code>const <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EIncorrectPoolOwner">EIncorrectPoolOwner</a>: u64 = 1; </code></pre>

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

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

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

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

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

<pre><code>const <a href="../deepbook/clob_v2.md#deepbook_clob_v2_ENotEqual">ENotEqual</a>: u64 = 13; </code></pre>

<pre><code>const <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidExpireTimestamp">EInvalidExpireTimestamp</a>: u64 = 19; </code></pre>

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

Function `usr_open_orders_exist`

Accessor functions

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders_exist">usr_open_orders_exist</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders_exist">usr_open_orders_exist</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address ): bool { table::contains(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>) } </code></pre> </details>

Function `usr_open_orders_for_address`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders_for_address">usr_open_orders_for_address</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address): &<a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, u64> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders_for_address">usr_open_orders_for_address</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address ): &LinkedTable<u64, u64> { table::borrow(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>) } </code></pre> </details>

Function `usr_open_orders`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): &<a href="../sui/table.md#sui_table_Table">sui::table::Table</a><address, <a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, u64>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, ): &Table<address, LinkedTable<u64, u64>> { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a> } </code></pre> </details>

Function `withdraw_fees`

Function to withdraw fees created from a pool

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_withdraw_fees">withdraw_fees</a><BaseAsset, QuoteAsset>(pool_owner_cap: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">deepbook::clob_v2::PoolOwnerCap</a>, pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, 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><QuoteAsset> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_withdraw_fees">withdraw_fees</a><BaseAsset, QuoteAsset>( pool_owner_cap: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">PoolOwnerCap</a>, pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, ctx: &mut TxContext, ): Coin<QuoteAsset> { assert!(pool_owner_cap.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> == object::uid_to_address(&pool.id), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EIncorrectPoolOwner">EIncorrectPoolOwner</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a> = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quote_asset_trading_fees_value">quote_asset_trading_fees_value</a>(pool); let to_withdraw = balance::split(&mut pool.quote_asset_trading_fees, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>); coin::from_balance(to_withdraw, ctx) } </code></pre> </details>

Function `delete_pool_owner_cap`

Destroy the given <code>pool_owner_cap</code> object

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_delete_pool_owner_cap">delete_pool_owner_cap</a>(pool_owner_cap: <a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">deepbook::clob_v2::PoolOwnerCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_delete_pool_owner_cap">delete_pool_owner_cap</a>(pool_owner_cap: <a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">PoolOwnerCap</a>) { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">PoolOwnerCap</a> { id, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: _ } = pool_owner_cap; object::delete(id) } </code></pre> </details>

Function `destroy_empty_level`

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

Function `create_account`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_account">create_account</a>(_ctx: &mut TxContext): AccountCap { abort 1337 } </code></pre> </details>

Function `create_pool`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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_v2.md#deepbook_clob_v2_create_pool">create_pool</a><BaseAsset, QuoteAsset>( _tick_size: u64, _lot_size: u64, _creation_fee: Coin<SUI>, _ctx: &mut TxContext, ) { abort 1337 } </code></pre> </details>

Function `create_customized_pool`

Function for creating pool with customized taker fee rate and maker rebate rate. The taker_fee_rate should be greater than or equal to the maker_rebate_rate, and both should have a scaling of 10^9. Taker_fee_rate of 0.25% should be 2_500_000 for example

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_customized_pool">create_customized_pool</a><BaseAsset, QuoteAsset>(_tick_size: u64, _lot_size: u64, _taker_fee_rate: u64, _maker_rebate_rate: 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_v2.md#deepbook_clob_v2_create_customized_pool">create_customized_pool</a><BaseAsset, QuoteAsset>( _tick_size: u64, _lot_size: u64, _taker_fee_rate: u64, _maker_rebate_rate: u64, _creation_fee: Coin<SUI>, _ctx: &mut TxContext, ) { abort 1337 } </code></pre> </details>

Function `create_pool_with_return`

Function for creating an external pool. This API can be used to wrap deepbook pools into other objects.

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_pool_with_return">create_pool_with_return</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>): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_pool_with_return">create_pool_with_return</a><BaseAsset, QuoteAsset>( _tick_size: u64, _lot_size: u64, _creation_fee: Coin<SUI>, _ctx: &mut TxContext, ): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset> { abort 1337 } </code></pre> </details>

Function `create_customized_pool_with_return`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_customized_pool_with_return">create_customized_pool_with_return</a><BaseAsset, QuoteAsset>(_tick_size: u64, _lot_size: u64, _taker_fee_rate: u64, _maker_rebate_rate: 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>): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_customized_pool_with_return">create_customized_pool_with_return</a><BaseAsset, QuoteAsset>( _tick_size: u64, _lot_size: u64, _taker_fee_rate: u64, _maker_rebate_rate: u64, _creation_fee: Coin<SUI>, _ctx: &mut TxContext, ) : <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset> { abort 1337 } </code></pre> </details>

Function `create_customized_pool_v2`

A V2 function for creating customized pools for better PTB friendliness/compostability. If a user wants to create a pool and then destroy/lock the pool_owner_cap one can do so with this function.

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_customized_pool_v2">create_customized_pool_v2</a><BaseAsset, QuoteAsset>(_tick_size: u64, _lot_size: u64, _taker_fee_rate: u64, _maker_rebate_rate: 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>): (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">deepbook::clob_v2::PoolOwnerCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_create_customized_pool_v2">create_customized_pool_v2</a><BaseAsset, QuoteAsset>( _tick_size: u64, _lot_size: u64, _taker_fee_rate: u64, _maker_rebate_rate: u64, _creation_fee: Coin<SUI>, _ctx: &mut TxContext, ) : (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_PoolOwnerCap">PoolOwnerCap</a>) { abort 1337 } </code></pre> </details>

Function `deposit_base`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_deposit_base">deposit_base</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><BaseAsset>, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_deposit_base">deposit_base</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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_v2.md#deepbook_clob_v2_deposit_quote">deposit_quote</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _coin: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><QuoteAsset>, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_deposit_quote">deposit_quote</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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_v2.md#deepbook_clob_v2_withdraw_base">withdraw_base</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::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_v2.md#deepbook_clob_v2_withdraw_base">withdraw_base</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64, account_cap: &AccountCap, ctx: &mut TxContext ): Coin<BaseAsset> { assert!(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a> > 0, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidQuantity">EInvalidQuantity</a>); event::emit(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_WithdrawAsset">WithdrawAsset</a><BaseAsset>{ pool_id: *object::uid_as_inner(&pool.id), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: account_owner(account_cap) }); <a href="../deepbook/custodian.md#deepbook_custodian_withdraw_asset">custodian::withdraw_asset</a>(&mut pool.base_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, account_cap, ctx) } </code></pre> </details>

Function `withdraw_quote`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_withdraw_quote">withdraw_quote</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::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_v2.md#deepbook_clob_v2_withdraw_quote">withdraw_quote</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: u64, account_cap: &AccountCap, ctx: &mut TxContext ): Coin<QuoteAsset> { assert!(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a> > 0, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidQuantity">EInvalidQuantity</a>); event::emit(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_WithdrawAsset">WithdrawAsset</a><QuoteAsset>{ pool_id: *object::uid_as_inner(&pool.id), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: account_owner(account_cap) }); <a href="../deepbook/custodian.md#deepbook_custodian_withdraw_asset">custodian::withdraw_asset</a>(&mut pool.quote_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, account_cap, ctx) } </code></pre> </details>

Function `swap_exact_base_for_quote`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_swap_exact_base_for_quote">swap_exact_base_for_quote</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _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_v2.md#deepbook_clob_v2_swap_exact_base_for_quote">swap_exact_base_for_quote</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &AccountCap, _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_base_for_quote_with_metadata`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_swap_exact_base_for_quote_with_metadata">swap_exact_base_for_quote_with_metadata</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _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, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">deepbook::clob_v2::MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_swap_exact_base_for_quote_with_metadata">swap_exact_base_for_quote_with_metadata</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &AccountCap, _quantity: u64, _base_coin: Coin<BaseAsset>, _quote_coin: Coin<QuoteAsset>, _clock: &Clock, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>, u64, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) { abort 1337 } </code></pre> </details>

Function `swap_exact_quote_for_base`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_swap_exact_quote_for_base">swap_exact_quote_for_base</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _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_v2.md#deepbook_clob_v2_swap_exact_quote_for_base">swap_exact_quote_for_base</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &AccountCap, _quantity: u64, _clock: &Clock, _quote_coin: Coin<QuoteAsset>, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>, u64) { abort 1337 } </code></pre> </details>

Function `swap_exact_quote_for_base_with_metadata`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_swap_exact_quote_for_base_with_metadata">swap_exact_quote_for_base_with_metadata</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _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, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">deepbook::clob_v2::MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_swap_exact_quote_for_base_with_metadata">swap_exact_quote_for_base_with_metadata</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _account_cap: &AccountCap, _quantity: u64, _clock: &Clock, _quote_coin: Coin<QuoteAsset>, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>, u64, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) { 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_v2.md#deepbook_clob_v2_place_market_order">place_market_order</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _client_order_id: u64, _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_v2.md#deepbook_clob_v2_place_market_order">place_market_order</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _account_cap: &AccountCap, _client_order_id: u64, _quantity: u64, _is_bid: bool, _base_coin: Coin<BaseAsset>, _quote_coin: Coin<QuoteAsset>, _clock: &Clock, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>) { abort 1337 } </code></pre> </details>

Function `place_market_order_with_metadata`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_place_market_order_with_metadata">place_market_order_with_metadata</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _client_order_id: u64, _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>, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">deepbook::clob_v2::MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_place_market_order_with_metadata">place_market_order_with_metadata</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _account_cap: &AccountCap, _client_order_id: u64, _quantity: u64, _is_bid: bool, _base_coin: Coin<BaseAsset>, _quote_coin: Coin<QuoteAsset>, _clock: &Clock, _ctx: &mut TxContext, ): (Coin<BaseAsset>, Coin<QuoteAsset>, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">MatchedOrderMetadata</a><BaseAsset, 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_v2.md#deepbook_clob_v2_place_limit_order">place_limit_order</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _price: u64, _quantity: u64, _self_matching_prevention: u8, _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_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::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_v2.md#deepbook_clob_v2_place_limit_order">place_limit_order</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _price: u64, _quantity: u64, _self_matching_prevention: u8, _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 `place_limit_order_with_metadata`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_place_limit_order_with_metadata">place_limit_order_with_metadata</a><BaseAsset, QuoteAsset>(_pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _price: u64, _quantity: u64, _self_matching_prevention: u8, _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_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, _ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): (u64, u64, bool, u64, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">deepbook::clob_v2::MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_place_limit_order_with_metadata">place_limit_order_with_metadata</a><BaseAsset, QuoteAsset>( _pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, _client_order_id: u64, _price: u64, _quantity: u64, _self_matching_prevention: u8, _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, vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">MatchedOrderMetadata</a><BaseAsset, QuoteAsset>>) { abort 1337 } </code></pre> </details>

Function `order_is_bid`

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

Function `emit_order_canceled`

<pre><code>fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_emit_order_canceled">emit_order_canceled</a><BaseAsset, QuoteAsset>( pool_id: ID, order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a> ) { event::emit(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_OrderCanceled">OrderCanceled</a><BaseAsset, QuoteAsset> { pool_id, client_order_id: order.client_order_id, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>, base_asset_quantity_canceled: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, 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_v2.md#deepbook_clob_v2_cancel_order">cancel_order</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_cancel_order">cancel_order</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: 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 <a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> / <a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> Critbit Tree. // Retrieve and remove the order from open orders of the PriceLevel. let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = account_owner(account_cap); assert!(contains(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidUser">EInvalidUser</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a> = borrow_mut(&mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); assert!(linked_table::contains(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidOrderId">EInvalidOrderId</a>); let tick_price = *linked_table::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a> = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_is_bid">order_is_bid</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let (tick_exists, tick_index) = find_leaf( if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }, tick_price); assert!(tick_exists, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidOrderId">EInvalidOrderId</a>); let order = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_remove_order">remove_order</a>( if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, tick_index, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> ); if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { let (_, balance_locked) = clob_math::unsafe_mul_round(order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>); }; <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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_v2.md#deepbook_clob_v2_remove_order">remove_order</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>: &mut <a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::TickLevel</a>>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>: &mut <a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, u64>, tick_index: u64, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_remove_order">remove_order</a>( <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>: &mut CritbitTree<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">TickLevel</a>>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>: &mut LinkedTable<u64, u64>, tick_index: u64, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: address, ): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a> { linked_table::remove(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a> = borrow_leaf_by_index(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, tick_index); assert!(linked_table::contains(&<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidOrderId">EInvalidOrderId</a>); let mut_tick_level = borrow_mut_leaf_by_index(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, tick_index); let order = linked_table::remove(&mut mut_tick_level.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); assert!(order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> == <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EUnauthorizedCancel">EUnauthorizedCancel</a>); if (linked_table::is_empty(&mut_tick_level.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>)) { <a href="../deepbook/clob_v2.md#deepbook_clob_v2_destroy_empty_level">destroy_empty_level</a>(remove_leaf_by_index(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, tick_index)); }; order } </code></pre> </details>

Function `cancel_all_orders`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_cancel_all_orders">cancel_all_orders</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_cancel_all_orders">cancel_all_orders</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, account_cap: &AccountCap ) { let pool_id = *object::uid_as_inner(&pool.id); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = account_owner(account_cap); assert!(contains(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidUser">EInvalidUser</a>); let usr_open_order_ids = table::borrow_mut(&mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); let mut canceled_order_events = vector[]; while (!linked_table::is_empty(usr_open_order_ids)) { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = *option::borrow(linked_table::back(usr_open_order_ids)); let order_price = *linked_table::borrow(usr_open_order_ids, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a> = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_is_bid">order_is_bid</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> = if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }; let (_, tick_index) = <a href="../deepbook/critbit.md#deepbook_critbit_find_leaf">critbit::find_leaf</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, order_price); let order = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_remove_order">remove_order</a>( <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, usr_open_order_ids, tick_index, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> ); if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { let (_, balance_locked) = clob_math::unsafe_mul_round(order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>); }; let canceled_order_event = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceledComponent">AllOrdersCanceledComponent</a><BaseAsset, QuoteAsset> { client_order_id: order.client_order_id, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>, base_asset_quantity_canceled: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, price: order.price }; vector::push_back(&mut canceled_order_events, canceled_order_event); }; if (!vector::is_empty(&canceled_order_events)) { event::emit(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceled">AllOrdersCanceled</a><BaseAsset, QuoteAsset> { pool_id, orders_canceled: canceled_order_events, }); }; } </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_v2.md#deepbook_clob_v2_batch_cancel_order">batch_cancel_order</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, order_ids: vector<u64>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_batch_cancel_order">batch_cancel_order</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_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 <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = account_owner(account_cap); assert!(contains(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>), 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 <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a> = borrow_mut(&mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); let mut canceled_order_events = vector[]; while (i_order < n_order) { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = *vector::borrow(&order_ids, i_order); assert!(linked_table::contains(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidOrderId">EInvalidOrderId</a>); let new_tick_price = *linked_table::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a> = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_is_bid">order_is_bid</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); if (new_tick_price != tick_price) { tick_price = new_tick_price; let (tick_exists, new_tick_index) = find_leaf( if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }, tick_price ); assert!(tick_exists, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidTickPrice">EInvalidTickPrice</a>); tick_index = new_tick_index; }; let order = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_remove_order">remove_order</a>( if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, tick_index, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> ); if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { let (_is_round_down, balance_locked) = clob_math::unsafe_mul_round(order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>); }; let canceled_order_event = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceledComponent">AllOrdersCanceledComponent</a><BaseAsset, QuoteAsset> { client_order_id: order.client_order_id, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>, base_asset_quantity_canceled: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, price: order.price }; vector::push_back(&mut canceled_order_events, canceled_order_event); i_order = i_order + 1; }; if (!vector::is_empty(&canceled_order_events)) { event::emit(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceled">AllOrdersCanceled</a><BaseAsset, QuoteAsset> { pool_id, orders_canceled: canceled_order_events, }); }; } </code></pre> </details>

Function `clean_up_expired_orders`

Clean up expired orders Note that this function can reduce gas cost if orders with the same price are grouped together in the vector because we would not need the computation to find the tick_index. 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. Order owners should be the owner addresses from the account capacities which placed the orders, and they should correspond to the order IDs one by one.

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_clean_up_expired_orders">clean_up_expired_orders</a><BaseAsset, QuoteAsset>(pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>, order_ids: vector<u64>, order_owners: vector<address>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_clean_up_expired_orders">clean_up_expired_orders</a><BaseAsset, QuoteAsset>( pool: &mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, clock: &Clock, order_ids: vector<u64>, order_owners: vector<address> ) { let pool_id = *object::uid_as_inner(&pool.id); let now = clock::timestamp_ms(clock); let n_order = vector::length(&order_ids); assert!(n_order == vector::length(&order_owners), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_ENotEqual">ENotEqual</a>); let mut i_order = 0; let mut tick_index: u64 = 0; let mut tick_price: u64 = 0; let mut canceled_order_events = vector[]; while (i_order < n_order) { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = *vector::borrow(&order_ids, i_order); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = *vector::borrow(&order_owners, i_order); if (!table::contains(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>)) { continue }; let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a> = borrow_mut(&mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); if (!linked_table::contains(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)) { continue }; let new_tick_price = *linked_table::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a> = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_is_bid">order_is_bid</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> = if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &mut pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }; if (new_tick_price != tick_price) { tick_price = new_tick_price; let (tick_exists, new_tick_index) = find_leaf( <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, tick_price ); assert!(tick_exists, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidTickPrice">EInvalidTickPrice</a>); tick_index = new_tick_index; }; let order = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_remove_order">remove_order</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, tick_index, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); assert!(order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a> < now, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidExpireTimestamp">EInvalidExpireTimestamp</a>); if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>) { let (_is_round_down, balance_locked) = clob_math::unsafe_mul_round(order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, order.price); <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.quote_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, balance_locked); } else { <a href="../deepbook/custodian.md#deepbook_custodian_unlock_balance">custodian::unlock_balance</a>(&mut pool.base_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>); }; let canceled_order_event = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceledComponent">AllOrdersCanceledComponent</a><BaseAsset, QuoteAsset> { client_order_id: order.client_order_id, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>, base_asset_quantity_canceled: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, price: order.price }; vector::push_back(&mut canceled_order_events, canceled_order_event); i_order = i_order + 1; }; if (!vector::is_empty(&canceled_order_events)) { event::emit(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_AllOrdersCanceled">AllOrdersCanceled</a><BaseAsset, QuoteAsset> { pool_id, orders_canceled: canceled_order_events, }); }; } </code></pre> </details>

Function `list_open_orders`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_list_open_orders">list_open_orders</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>): vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_list_open_orders">list_open_orders</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, account_cap: &AccountCap ): vector<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>> { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = account_owner(account_cap); let mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> = vector::empty<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>>(); if (!<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders_exist">usr_open_orders_exist</a>(pool, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>)) { return <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> }; let usr_open_order_ids = table::borrow(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); let mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = linked_table::front(usr_open_order_ids); while (!option::is_none(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)) { let order_price = *linked_table::borrow(usr_open_order_ids, *option::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a> = if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_is_bid">order_is_bid</a>(*option::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>))) borrow_leaf_by_key(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>, order_price) else borrow_leaf_by_key(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>, order_price); let order = linked_table::borrow(&<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, *option::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)); vector::push_back(&mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a> { <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, client_order_id: order.client_order_id, price: order.price, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>, self_matching_prevention: order.self_matching_prevention }); <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = linked_table::next(usr_open_order_ids, *option::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)); }; <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> } </code></pre> </details>

Function `account_balance`

query user balance inside custodian

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_account_balance">account_balance</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>): (u64, u64, u64, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_account_balance">account_balance</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, account_cap: &AccountCap ): (u64, u64, u64, u64) { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = account_owner(account_cap); let (base_avail, base_locked) = <a href="../deepbook/custodian.md#deepbook_custodian_account_balance">custodian::account_balance</a>(&pool.base_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); let (quote_avail, quote_locked) = <a href="../deepbook/custodian.md#deepbook_custodian_account_balance">custodian::account_balance</a>(&pool.quote_custodian, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); (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) if there exists bid/ask order in the order book, otherwise returns None

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_market_price">get_market_price</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): (<a href="../std/option.md#std_option_Option">std::option::Option</a><u64>, <a href="../std/option.md#std_option_Option">std::option::Option</a><u64>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_market_price">get_market_price</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset> ): (Option<u64>, Option<u64>){ let bid_price = if (!<a href="../deepbook/critbit.md#deepbook_critbit_is_empty">critbit::is_empty</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>)) { let (result, _) = <a href="../deepbook/critbit.md#deepbook_critbit_max_leaf">critbit::max_leaf</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>); option::some<u64>(result) } else { option::none<u64>() }; let ask_price = if (!<a href="../deepbook/critbit.md#deepbook_critbit_is_empty">critbit::is_empty</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>)) { let (result, _) = <a href="../deepbook/critbit.md#deepbook_critbit_min_leaf">critbit::min_leaf</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>); option::some<u64>(result) } else { option::none<u64>() }; 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_v2.md#deepbook_clob_v2_get_level2_book_status_bid_side">get_level2_book_status_bid_side</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::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_v2.md#deepbook_clob_v2_get_level2_book_status_bid_side">get_level2_book_status_bid_side</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, mut price_low: u64, mut price_high: u64, clock: &Clock ): (vector<u64>, vector<u64>) { let mut price_vec = vector::empty<u64>(); let mut depth_vec = vector::empty<u64>(); if (<a href="../deepbook/critbit.md#deepbook_critbit_is_empty">critbit::is_empty</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>)) { return (price_vec, depth_vec) }; let (price_low_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_min_leaf">critbit::min_leaf</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>); let (price_high_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_max_leaf">critbit::max_leaf</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>); // If price_low is greater than the highest element in the tree, we return empty if (price_low > price_high_) { return (price_vec, depth_vec) }; if (price_low < price_low_) price_low = price_low_; 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.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>, price_low); price_high = <a href="../deepbook/critbit.md#deepbook_critbit_find_closest_key">critbit::find_closest_key</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>, price_high); while (price_low <= price_high) { let depth = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_level2_book_status">get_level2_book_status</a>( &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>, price_low, clock::timestamp_ms(clock) ); if (depth != 0) { 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.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>, 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_v2.md#deepbook_clob_v2_get_level2_book_status_ask_side">get_level2_book_status_ask_side</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::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_v2.md#deepbook_clob_v2_get_level2_book_status_ask_side">get_level2_book_status_ask_side</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, mut price_low: u64, mut price_high: u64, clock: &Clock ): (vector<u64>, vector<u64>) { let mut price_vec = vector::empty<u64>(); let mut depth_vec = vector::empty<u64>(); if (<a href="../deepbook/critbit.md#deepbook_critbit_is_empty">critbit::is_empty</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>)) { return (price_vec, depth_vec) }; let (price_low_, _) = <a href="../deepbook/critbit.md#deepbook_critbit_min_leaf">critbit::min_leaf</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>); // Price_high is less than the lowest leaf in the tree then we return an empty array if (price_high < price_low_) { return (price_vec, depth_vec) }; 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.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>); 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.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>, price_low); price_high = <a href="../deepbook/critbit.md#deepbook_critbit_find_closest_key">critbit::find_closest_key</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>, price_high); while (price_low <= price_high) { let depth = <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_level2_book_status">get_level2_book_status</a>( &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>, price_low, clock::timestamp_ms(clock) ); if (depth != 0) { 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.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>, 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_v2.md#deepbook_clob_v2_get_level2_book_status">get_level2_book_status</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>: &<a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::TickLevel</a>>, price: u64, time_stamp: u64): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_level2_book_status">get_level2_book_status</a>( <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>: &CritbitTree<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">TickLevel</a>>, price: u64, time_stamp: u64 ): u64 { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a> = <a href="../deepbook/critbit.md#deepbook_critbit_borrow_leaf_by_key">critbit::borrow_leaf_by_key</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, price); let tick_open_orders = &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>; let mut depth = 0; let mut <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = linked_table::front(tick_open_orders); let mut order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>; while (!option::is_none(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)) { order = linked_table::borrow(tick_open_orders, *option::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)); if (order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a> > time_stamp) depth = depth + order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>; <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> = linked_table::next(tick_open_orders, *option::borrow(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>)); }; depth } </code></pre> </details>

Function `get_order_status`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_order_status">get_order_status</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>): &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_get_order_status">get_order_status</a><BaseAsset, QuoteAsset>( pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: u64, account_cap: &AccountCap ): &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a> { let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> = account_owner(account_cap); assert!(table::contains(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidUser">EInvalidUser</a>); let usr_open_order_ids = table::borrow(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_usr_open_orders">usr_open_orders</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>); assert!(linked_table::contains(usr_open_order_ids, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>), <a href="../deepbook/clob_v2.md#deepbook_clob_v2_EInvalidOrderId">EInvalidOrderId</a>); let order_price = *linked_table::borrow(usr_open_order_ids, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> = if (<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> < <a href="../deepbook/clob_v2.md#deepbook_clob_v2_MIN_ASK_ORDER_ID">MIN_ASK_ORDER_ID</a>) { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } else { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> }; let <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a> = <a href="../deepbook/critbit.md#deepbook_critbit_borrow_leaf_by_key">critbit::borrow_leaf_by_key</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>, order_price); let tick_open_orders = &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>; let order = linked_table::borrow(tick_open_orders, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>); order } </code></pre> </details>

Function `matched_order_metadata_info`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_matched_order_metadata_info">matched_order_metadata_info</a><BaseAsset, QuoteAsset>(_matched_order_metadata: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">deepbook::clob_v2::MatchedOrderMetadata</a><BaseAsset, QuoteAsset>): (<a href="../sui/object.md#sui_object_ID">sui::object::ID</a>, u64, bool, address, address, u64, u64, u64, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_matched_order_metadata_info">matched_order_metadata_info</a><BaseAsset, QuoteAsset>( _matched_order_metadata: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_MatchedOrderMetadata">MatchedOrderMetadata</a><BaseAsset, QuoteAsset> ) : ( ID, u64, bool, address, address, u64, u64, u64, u64) { abort 1337 } </code></pre> </details>

Function `asks`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): &<a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::TickLevel</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): &CritbitTree<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">TickLevel</a>> { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a> } </code></pre> </details>

Function `bids`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): &<a href="../deepbook/critbit.md#deepbook_critbit_CritbitTree">deepbook::critbit::CritbitTree</a><<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::TickLevel</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): &CritbitTree<<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">TickLevel</a>> { &pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a> } </code></pre> </details>

Function `tick_size`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_size">tick_size</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_size">tick_size</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): u64 { pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_size">tick_size</a> } </code></pre> </details>

Function `maker_rebate_rate`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_maker_rebate_rate">maker_rebate_rate</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_maker_rebate_rate">maker_rebate_rate</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): u64 { pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_maker_rebate_rate">maker_rebate_rate</a> } </code></pre> </details>

Function `taker_fee_rate`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_taker_fee_rate">taker_fee_rate</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_taker_fee_rate">taker_fee_rate</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): u64 { pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_taker_fee_rate">taker_fee_rate</a> } </code></pre> </details>

Function `pool_size`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_pool_size">pool_size</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_pool_size">pool_size</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): u64 { <a href="../deepbook/critbit.md#deepbook_critbit_size">critbit::size</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_asks">asks</a>) + <a href="../deepbook/critbit.md#deepbook_critbit_size">critbit::size</a>(&pool.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_bids">bids</a>) } </code></pre> </details>

Function `open_orders`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">deepbook::clob_v2::TickLevel</a>): &<a href="../sui/linked_table.md#sui_linked_table_LinkedTable">sui::linked_table::LinkedTable</a><u64, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a>(<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_TickLevel">TickLevel</a>): &LinkedTable<u64, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>> { &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_open_orders">open_orders</a> } </code></pre> </details>

Function `order_id`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): u64 { order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a> } </code></pre> </details>

Function `tick_level`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_tick_level">tick_level</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): u64 { order.price } </code></pre> </details>

Function `original_quantity`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): u64 { order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a> } </code></pre> </details>

Function `quantity`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): u64 { order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a> } </code></pre> </details>

Function `is_bid`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): bool { order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a> } </code></pre> </details>

Function `owner`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): address { order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a> } </code></pre> </details>

Function `expire_timestamp`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): u64 { order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a> } </code></pre> </details>

Function `quote_asset_trading_fees_value`

<pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quote_asset_trading_fees_value">quote_asset_trading_fees_value</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">deepbook::clob_v2::Pool</a><BaseAsset, QuoteAsset>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quote_asset_trading_fees_value">quote_asset_trading_fees_value</a><BaseAsset, QuoteAsset>(pool: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Pool">Pool</a><BaseAsset, QuoteAsset>): u64 { balance::value(&pool.quote_asset_trading_fees) } </code></pre> </details>

Function `clone_order`

<pre><code>public(package) fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_clone_order">clone_order</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a>): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">deepbook::clob_v2::Order</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/clob_v2.md#deepbook_clob_v2_clone_order">clone_order</a>(order: &<a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a>): <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a> { <a href="../deepbook/clob_v2.md#deepbook_clob_v2_Order">Order</a> { <a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_order_id">order_id</a>, client_order_id: order.client_order_id, price: order.price, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_original_quantity">original_quantity</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_quantity">quantity</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_is_bid">is_bid</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_owner">owner</a>, <a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>: order.<a href="../deepbook/clob_v2.md#deepbook_clob_v2_expire_timestamp">expire_timestamp</a>, self_matching_prevention: order.self_matching_prevention } } </code></pre> </details>

Struct PoolCreated

Struct OrderPlaced

Struct OrderCanceled

Struct AllOrdersCanceledComponent

Struct AllOrdersCanceled

Struct OrderFilled

Struct DepositAsset

Struct WithdrawAsset

Struct MatchedOrderMetadata

Struct Order

Struct TickLevel

Struct Pool

Struct PoolOwnerCap

Constants

Function usr_open_orders_exist

Function usr_open_orders_for_address

Function usr_open_orders

Function withdraw_fees

Function delete_pool_owner_cap

Function destroy_empty_level

Function create_account

Function create_pool

Function create_customized_pool

Function create_pool_with_return

Function create_customized_pool_with_return

Function create_customized_pool_v2

Function deposit_base

Function deposit_quote

Function withdraw_base

Function withdraw_quote

Function swap_exact_base_for_quote

Function swap_exact_base_for_quote_with_metadata

Function swap_exact_quote_for_base

Function swap_exact_quote_for_base_with_metadata

Function place_market_order

Function place_market_order_with_metadata

Function place_limit_order

Function place_limit_order_with_metadata

Function order_is_bid

Function emit_order_canceled

Function cancel_order

Function remove_order

Function cancel_all_orders

Function batch_cancel_order

Function clean_up_expired_orders

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

Function matched_order_metadata_info

Function asks

Function bids

Function tick_size

Function maker_rebate_rate

Function taker_fee_rate

Function pool_size

Function open_orders

Function order_id

Function tick_level

Function original_quantity

Function quantity

Function is_bid

Function owner

Function expire_timestamp

Function quote_asset_trading_fees_value

Function clone_order