Module `deepbook::custodian_v2`

Struct Account
Struct AccountCap
Struct Custodian
Constants
Function create_child_account_cap
Function delete_account_cap
Function account_owner
Function account_balance
Function new
Function withdraw_asset
Function increase_user_available_balance
Function decrease_user_available_balance
Function increase_user_locked_balance
Function decrease_user_locked_balance
Function lock_balance
Function unlock_balance
Function account_available_balance
Function account_locked_balance
Function borrow_mut_account_balance

<pre><code>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/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/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/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 `Account`

<pre><code>public struct <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Account">Account</a><phantom T> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>available_balance: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><T></code> </dt> <dd> </dd> <dt> <code>locked_balance: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><T></code> </dt> <dd> </dd> </dl> </details>

Struct `AccountCap`

Capability granting permission to access an entry in <code><a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a>.account_balances</code>. Calling <code>mint_account_cap</code> creates an "admin account cap" such that id == owner with the permission to both access funds and create new <code><a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a></code>s. Calling <code><a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_create_child_account_cap">create_child_account_cap</a></code> creates a "child account cap" such that id != owner that can access funds, but cannot create new <code><a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a></code>s.

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

Struct `Custodian`

<pre><code>public struct <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><phantom T> 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>account_balances: <a href="../sui/table.md#sui_table_Table">sui::table::Table</a><address, <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Account">deepbook::custodian_v2::Account</a><T>></code> </dt> <dd> Map from the owner address of AccountCap object to an Account object </dd> </dl> </details>

Constants

<pre><code>const <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_EAdminAccountCapRequired">EAdminAccountCapRequired</a>: u64 = 2; </code></pre>

Function `create_child_account_cap`

Create a "child account cap" such that id != owner that can access funds, but cannot create new <code><a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a></code>s.

<pre><code>public fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_create_child_account_cap">create_child_account_cap</a>(admin_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="../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/custodian_v2.md#deepbook_custodian_v2_create_child_account_cap">create_child_account_cap</a>(admin_account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>, ctx: &mut TxContext): <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a> { // Only the admin account cap can create <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_new">new</a> account caps assert!(object::uid_to_address(&admin_account_cap.id) == admin_account_cap.owner, <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_EAdminAccountCapRequired">EAdminAccountCapRequired</a>); <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a> { id: object::new(ctx), owner: admin_account_cap.owner } } </code></pre> </details>

Function `delete_account_cap`

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

<pre><code>public fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_delete_account_cap">delete_account_cap</a>(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/custodian_v2.md#deepbook_custodian_v2_delete_account_cap">delete_account_cap</a>(account_cap: <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>) { let <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a> { id, owner: _ } = account_cap; object::delete(id) } </code></pre> </details>

Function `account_owner`

Return the owner of an AccountCap

<pre><code>public fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_owner">account_owner</a>(account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_owner">account_owner</a>(account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>): address { account_cap.owner } </code></pre> </details>

Function `account_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_balance">account_balance</a><Asset>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><Asset>, owner: address): (u64, u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_balance">account_balance</a><Asset>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><Asset>, owner: address ): (u64, u64) { // if <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a> account is not created yet, directly return (0, 0) rather than abort if (!table::contains(&<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner)) { return (0, 0) }; let account_balances = table::borrow(&<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner); let avail_balance = balance::value(&account_balances.available_balance); let locked_balance = balance::value(&account_balances.locked_balance); (avail_balance, locked_balance) } </code></pre> </details>

Function `new`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_new">new</a><T>(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_Custodian">deepbook::custodian_v2::Custodian</a><T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_new">new</a><T>(ctx: &mut TxContext): <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T> { <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T> { id: object::new(ctx), account_balances: table::new(ctx), } } </code></pre> </details>

Function `withdraw_asset`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_withdraw_asset">withdraw_asset</a><Asset>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><Asset>, quantity: 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><Asset> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_withdraw_asset">withdraw_asset</a><Asset>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><Asset>, quantity: u64, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>, ctx: &mut TxContext ): Coin<Asset> { coin::from_balance(<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_available_balance">decrease_user_available_balance</a><Asset>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, account_cap, quantity), ctx) } </code></pre> </details>

Function `increase_user_available_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_increase_user_available_balance">increase_user_available_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, owner: address, quantity: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><T>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_increase_user_available_balance">increase_user_available_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, owner: address, quantity: Balance<T>, ) { let account = <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_borrow_mut_account_balance">borrow_mut_account_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, owner); balance::join(&mut account.available_balance, quantity); } </code></pre> </details>

Function `decrease_user_available_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_available_balance">decrease_user_available_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, quantity: u64): <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_available_balance">decrease_user_available_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>, quantity: u64, ): Balance<T> { let account = <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_borrow_mut_account_balance">borrow_mut_account_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, account_cap.owner); balance::split(&mut account.available_balance, quantity) } </code></pre> </details>

Function `increase_user_locked_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_increase_user_locked_balance">increase_user_locked_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, quantity: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><T>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_increase_user_locked_balance">increase_user_locked_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>, quantity: Balance<T>, ) { let account = <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_borrow_mut_account_balance">borrow_mut_account_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, account_cap.owner); balance::join(&mut account.locked_balance, quantity); } </code></pre> </details>

Function `decrease_user_locked_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_locked_balance">decrease_user_locked_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, owner: address, quantity: u64): <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_locked_balance">decrease_user_locked_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, owner: address, quantity: u64, ): Balance<T> { let account = <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_borrow_mut_account_balance">borrow_mut_account_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, owner); split(&mut account.locked_balance, quantity) } </code></pre> </details>

Function `lock_balance`

Move <code>quantity</code> from the unlocked balance of <code>user</code> to the locked balance of <code>user</code>

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_lock_balance">lock_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">deepbook::custodian_v2::AccountCap</a>, quantity: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_lock_balance">lock_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, account_cap: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_AccountCap">AccountCap</a>, quantity: u64, ) { let to_lock = <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_available_balance">decrease_user_available_balance</a>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, account_cap, quantity); <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_increase_user_locked_balance">increase_user_locked_balance</a>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, account_cap, to_lock); } </code></pre> </details>

Function `unlock_balance`

Move <code>quantity</code> from the locked balance of <code>user</code> to the unlocked balance of <code>user</code>

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_unlock_balance">unlock_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, owner: address, quantity: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_unlock_balance">unlock_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, owner: address, quantity: u64, ) { let locked_balance = <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_decrease_user_locked_balance">decrease_user_locked_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, owner, quantity); <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_increase_user_available_balance">increase_user_available_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>, owner, locked_balance) } </code></pre> </details>

Function `account_available_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_available_balance">account_available_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, owner: address): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_available_balance">account_available_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, owner: address, ): u64 { balance::value(&table::borrow(&<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner).available_balance) } </code></pre> </details>

Function `account_locked_balance`

<pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_locked_balance">account_locked_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, owner: address): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_account_locked_balance">account_locked_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &<a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, owner: address, ): u64 { balance::value(&table::borrow(&<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner).locked_balance) } </code></pre> </details>

Function `borrow_mut_account_balance`

<pre><code>fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_borrow_mut_account_balance">borrow_mut_account_balance</a><T>(<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">deepbook::custodian_v2::Custodian</a><T>, owner: address): &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Account">deepbook::custodian_v2::Account</a><T> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_borrow_mut_account_balance">borrow_mut_account_balance</a><T>( <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>: &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Custodian">Custodian</a><T>, owner: address, ): &mut <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Account">Account</a><T> { if (!table::contains(&<a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner)) { table::add( &mut <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner, <a href="../deepbook/custodian_v2.md#deepbook_custodian_v2_Account">Account</a> { available_balance: balance::zero(), locked_balance: balance::zero() } ); }; table::borrow_mut(&mut <a href="../deepbook/custodian.md#deepbook_custodian">custodian</a>.account_balances, owner) } </code></pre> </details>

Struct Account

Struct AccountCap

Struct Custodian

Constants

Function create_child_account_cap

Function delete_account_cap

Function account_owner

Function account_balance

Function new

Function withdraw_asset

Function increase_user_available_balance

Function decrease_user_available_balance

Function increase_user_locked_balance

Function decrease_user_locked_balance

Function lock_balance

Function unlock_balance

Function account_available_balance

Function account_locked_balance

Function borrow_mut_account_balance