Module `bridge::treasury`

Struct BridgeTreasury
Struct BridgeTokenMetadata
Struct ForeignTokenRegistration
Struct UpdateTokenPriceEvent
Struct NewTokenEvent
Struct TokenRegistrationEvent
Constants
Function token_id
Function decimal_multiplier
Function notional_value
Function register_foreign_token
Function add_new_token
Function create
Function burn
Function mint
Function update_asset_notional_price
Function get_token_metadata

<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/u64.md#std_u64">std::u64</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/object_bag.md#sui_object_bag">sui::object_bag</a>; use <a href="../sui/package.md#sui_package">sui::package</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 `BridgeTreasury`

<pre><code>public struct <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>treasuries: <a href="../sui/object_bag.md#sui_object_bag_ObjectBag">sui::object_bag::ObjectBag</a></code> </dt> <dd> </dd> <dt> <code>supported_tokens: <a href="../sui/vec_map.md#sui_vec_map_VecMap">sui::vec_map::VecMap</a><<a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a>, <a href="../bridge/treasury.md#bridge_treasury_BridgeTokenMetadata">bridge::treasury::BridgeTokenMetadata</a>></code> </dt> <dd> </dd> <dt> <code>id_token_type_map: <a href="../sui/vec_map.md#sui_vec_map_VecMap">sui::vec_map::VecMap</a><u8, <a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a>></code> </dt> <dd> </dd> <dt> <code>waiting_room: <a href="../sui/bag.md#sui_bag_Bag">sui::bag::Bag</a></code> </dt> <dd> </dd> </dl> </details>

Struct `BridgeTokenMetadata`

<pre><code>public struct <a href="../bridge/treasury.md#bridge_treasury_BridgeTokenMetadata">BridgeTokenMetadata</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>id: u8</code> </dt> <dd> </dd> <dt> <code><a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a>: u64</code> </dt> <dd> </dd> <dt> <code>native_token: bool</code> </dt> <dd> </dd> </dl> </details>

Struct `ForeignTokenRegistration`

<pre><code>public struct <a href="../bridge/treasury.md#bridge_treasury_ForeignTokenRegistration">ForeignTokenRegistration</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>type_name: <a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a></code> </dt> <dd> </dd> <dt> <code>uc: <a href="../sui/package.md#sui_package_UpgradeCap">sui::package::UpgradeCap</a></code> </dt> <dd> </dd> <dt> <code>decimal: u8</code> </dt> <dd> </dd> </dl> </details>

Struct `UpdateTokenPriceEvent`

<pre><code>public struct <a href="../bridge/treasury.md#bridge_treasury_UpdateTokenPriceEvent">UpdateTokenPriceEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>: u8</code> </dt> <dd> </dd> <dt> <code>new_price: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `NewTokenEvent`

<pre><code>public struct <a href="../bridge/treasury.md#bridge_treasury_NewTokenEvent">NewTokenEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>: u8</code> </dt> <dd> </dd> <dt> <code>type_name: <a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a></code> </dt> <dd> </dd> <dt> <code>native_token: bool</code> </dt> <dd> </dd> <dt> <code><a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a>: u64</code> </dt> <dd> </dd> <dt> <code><a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a>: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `TokenRegistrationEvent`

<pre><code>public struct <a href="../bridge/treasury.md#bridge_treasury_TokenRegistrationEvent">TokenRegistrationEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>type_name: <a href="../std/type_name.md#std_type_name_TypeName">std::type_name::TypeName</a></code> </dt> <dd> </dd> <dt> <code>decimal: u8</code> </dt> <dd> </dd> <dt> <code>native_token: bool</code> </dt> <dd> </dd> </dl> </details>

Constants

<pre><code>const <a href="../bridge/treasury.md#bridge_treasury_EUnsupportedTokenType">EUnsupportedTokenType</a>: u64 = 1; </code></pre>

<pre><code>const <a href="../bridge/treasury.md#bridge_treasury_EInvalidUpgradeCap">EInvalidUpgradeCap</a>: u64 = 2; </code></pre>

<pre><code>const <a href="../bridge/treasury.md#bridge_treasury_ETokenSupplyNonZero">ETokenSupplyNonZero</a>: u64 = 3; </code></pre>

<pre><code>const <a href="../bridge/treasury.md#bridge_treasury_EInvalidNotionalValue">EInvalidNotionalValue</a>: u64 = 4; </code></pre>

Function `token_id`

<pre><code>public fun <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>): u8 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>): u8 { let metadata = self.<a href="../bridge/treasury.md#bridge_treasury_get_token_metadata">get_token_metadata</a><T>(); metadata.id } </code></pre> </details>

Function `decimal_multiplier`

<pre><code>public fun <a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>): u64 { let metadata = self.<a href="../bridge/treasury.md#bridge_treasury_get_token_metadata">get_token_metadata</a><T>(); metadata.<a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a> } </code></pre> </details>

Function `notional_value`

<pre><code>public fun <a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>): u64 { let metadata = self.<a href="../bridge/treasury.md#bridge_treasury_get_token_metadata">get_token_metadata</a><T>(); metadata.<a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a> } </code></pre> </details>

Function `register_foreign_token`

<pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_register_foreign_token">register_foreign_token</a><T>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>, tc: <a href="../sui/coin.md#sui_coin_TreasuryCap">sui::coin::TreasuryCap</a><T>, uc: <a href="../sui/package.md#sui_package_UpgradeCap">sui::package::UpgradeCap</a>, metadata: &<a href="../sui/coin.md#sui_coin_CoinMetadata">sui::coin::CoinMetadata</a><T>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_register_foreign_token">register_foreign_token</a><T>( self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>, tc: TreasuryCap<T>, uc: UpgradeCap, metadata: &CoinMetadata<T>, ) { // Make sure TreasuryCap has not been minted before. assert!(coin::total_supply(&tc) == 0, <a href="../bridge/treasury.md#bridge_treasury_ETokenSupplyNonZero">ETokenSupplyNonZero</a>); let type_name = type_name::with_defining_ids<T>(); let address_bytes = hex::decode(ascii::into_bytes(type_name::address_string(&type_name))); let coin_address = address::from_bytes(address_bytes); // Make sure upgrade cap is for the Coin package // FIXME: add test assert!( object::id_to_address(&package::upgrade_package(&uc)) == coin_address, <a href="../bridge/treasury.md#bridge_treasury_EInvalidUpgradeCap">EInvalidUpgradeCap</a>, ); let registration = <a href="../bridge/treasury.md#bridge_treasury_ForeignTokenRegistration">ForeignTokenRegistration</a> { type_name, uc, decimal: coin::get_decimals(metadata), }; self.waiting_room.add(type_name::into_string(type_name), registration); self.treasuries.add(type_name, tc); event::emit(<a href="../bridge/treasury.md#bridge_treasury_TokenRegistrationEvent">TokenRegistrationEvent</a> { type_name, decimal: coin::get_decimals(metadata), native_token: false, }); } </code></pre> </details>

Function `add_new_token`

<pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_add_new_token">add_new_token</a>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>, token_name: <a href="../std/ascii.md#std_ascii_String">std::ascii::String</a>, <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>: u8, native_token: bool, <a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a>: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_add_new_token">add_new_token</a>( self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>, token_name: String, <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>: u8, native_token: bool, <a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a>: u64, ) { if (!native_token) { assert!(<a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a> > 0, <a href="../bridge/treasury.md#bridge_treasury_EInvalidNotionalValue">EInvalidNotionalValue</a>); let <a href="../bridge/treasury.md#bridge_treasury_ForeignTokenRegistration">ForeignTokenRegistration</a> { type_name, uc, decimal, } = self.waiting_room.remove<String, <a href="../bridge/treasury.md#bridge_treasury_ForeignTokenRegistration">ForeignTokenRegistration</a>>(token_name); let <a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a> = 10u64.pow(decimal); self .supported_tokens .insert( type_name, <a href="../bridge/treasury.md#bridge_treasury_BridgeTokenMetadata">BridgeTokenMetadata</a> { id: <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>, <a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a>, <a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a>, native_token, }, ); self.id_token_type_map.insert(<a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>, type_name); // Freeze upgrade cap to prevent changes to the coin transfer::public_freeze_object(uc); event::emit(<a href="../bridge/treasury.md#bridge_treasury_NewTokenEvent">NewTokenEvent</a> { <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>, type_name, native_token, <a href="../bridge/treasury.md#bridge_treasury_decimal_multiplier">decimal_multiplier</a>, <a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a>, }) } // else not implemented in V1 } </code></pre> </details>

Function `create`

<pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_create">create</a>(ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_create">create</a>(ctx: &mut TxContext): <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a> { <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a> { treasuries: object_bag::new(ctx), supported_tokens: vec_map::empty(), id_token_type_map: vec_map::empty(), waiting_room: bag::new(ctx), } } </code></pre> </details>

Function `burn`

<pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_burn">burn</a><T>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>, token: <a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a><T>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_burn">burn</a><T>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>, token: Coin<T>) { let <a href="../bridge/treasury.md#bridge_treasury">treasury</a> = &mut self.treasuries[type_name::with_defining_ids<T>()]; coin::burn(<a href="../bridge/treasury.md#bridge_treasury">treasury</a>, token); } </code></pre> </details>

Function `mint`

<pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_mint">mint</a><T>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>, amount: u64, 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><T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_mint">mint</a><T>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>, amount: u64, ctx: &mut TxContext): Coin<T> { let <a href="../bridge/treasury.md#bridge_treasury">treasury</a> = &mut self.treasuries[type_name::with_defining_ids<T>()]; coin::mint(<a href="../bridge/treasury.md#bridge_treasury">treasury</a>, amount, ctx) } </code></pre> </details>

Function `update_asset_notional_price`

<pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_update_asset_notional_price">update_asset_notional_price</a>(self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>, <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>: u8, new_usd_price: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/treasury.md#bridge_treasury_update_asset_notional_price">update_asset_notional_price</a>( self: &mut <a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>, <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>: u8, new_usd_price: u64, ) { let type_name = self.id_token_type_map.try_get(&<a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>); assert!(type_name.is_some(), <a href="../bridge/treasury.md#bridge_treasury_EUnsupportedTokenType">EUnsupportedTokenType</a>); assert!(new_usd_price > 0, <a href="../bridge/treasury.md#bridge_treasury_EInvalidNotionalValue">EInvalidNotionalValue</a>); let type_name = type_name.destroy_some(); let metadata = self.supported_tokens.get_mut(&type_name); metadata.<a href="../bridge/treasury.md#bridge_treasury_notional_value">notional_value</a> = new_usd_price; event::emit(<a href="../bridge/treasury.md#bridge_treasury_UpdateTokenPriceEvent">UpdateTokenPriceEvent</a> { <a href="../bridge/treasury.md#bridge_treasury_token_id">token_id</a>, new_price: new_usd_price, }) } </code></pre> </details>

Function `get_token_metadata`

<pre><code>fun <a href="../bridge/treasury.md#bridge_treasury_get_token_metadata">get_token_metadata</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>): <a href="../bridge/treasury.md#bridge_treasury_BridgeTokenMetadata">bridge::treasury::BridgeTokenMetadata</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../bridge/treasury.md#bridge_treasury_get_token_metadata">get_token_metadata</a><T>(self: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">BridgeTreasury</a>): <a href="../bridge/treasury.md#bridge_treasury_BridgeTokenMetadata">BridgeTokenMetadata</a> { let coin_type = type_name::with_defining_ids<T>(); let metadata = self.supported_tokens.try_get(&coin_type); assert!(metadata.is_some(), <a href="../bridge/treasury.md#bridge_treasury_EUnsupportedTokenType">EUnsupportedTokenType</a>); metadata.destroy_some() } </code></pre> </details>

Struct BridgeTreasury

Struct BridgeTokenMetadata

Struct ForeignTokenRegistration

Struct UpdateTokenPriceEvent

Struct NewTokenEvent

Struct TokenRegistrationEvent

Constants

Function token_id

Function decimal_multiplier

Function notional_value

Function register_foreign_token

Function add_new_token

Function create

Function burn

Function mint

Function update_asset_notional_price

Function get_token_metadata