Module `bridge::limiter`

Struct TransferLimiter
Struct TransferRecord
Struct UpdateRouteLimitEvent
Constants
Function get_route_limit
Function new
Function check_and_record_sending_transfer
Function update_route_limit
Function current_hour_since_epoch
Function adjust_transfer_records
Function initial_transfer_limits

<pre><code>use <a href="../bridge/chain_ids.md#bridge_chain_ids">bridge::chain_ids</a>; use <a href="../bridge/treasury.md#bridge_treasury">bridge::treasury</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/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/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/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 `TransferLimiter`

<pre><code>public struct <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">TransferLimiter</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>transfer_limits: <a href="../sui/vec_map.md#sui_vec_map_VecMap">sui::vec_map::VecMap</a><<a href="../bridge/chain_ids.md#bridge_chain_ids_BridgeRoute">bridge::chain_ids::BridgeRoute</a>, u64></code> </dt> <dd> </dd> <dt> <code>transfer_records: <a href="../sui/vec_map.md#sui_vec_map_VecMap">sui::vec_map::VecMap</a><<a href="../bridge/chain_ids.md#bridge_chain_ids_BridgeRoute">bridge::chain_ids::BridgeRoute</a>, <a href="../bridge/limiter.md#bridge_limiter_TransferRecord">bridge::limiter::TransferRecord</a>></code> </dt> <dd> </dd> </dl> </details>

Struct `TransferRecord`

<pre><code>public struct <a href="../bridge/limiter.md#bridge_limiter_TransferRecord">TransferRecord</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>hour_head: u64</code> </dt> <dd> </dd> <dt> <code>hour_tail: u64</code> </dt> <dd> </dd> <dt> <code>per_hour_amounts: vector<u64></code> </dt> <dd> </dd> <dt> <code>total_amount: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `UpdateRouteLimitEvent`

<pre><code>public struct <a href="../bridge/limiter.md#bridge_limiter_UpdateRouteLimitEvent">UpdateRouteLimitEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>sending_chain: u8</code> </dt> <dd> </dd> <dt> <code>receiving_chain: u8</code> </dt> <dd> </dd> <dt> <code>new_limit: u64</code> </dt> <dd> </dd> </dl> </details>

Constants

<pre><code>const <a href="../bridge/limiter.md#bridge_limiter_ELimitNotFoundForRoute">ELimitNotFoundForRoute</a>: u64 = 0; </code></pre>

<pre><code>const <a href="../bridge/limiter.md#bridge_limiter_MAX_TRANSFER_LIMIT">MAX_TRANSFER_LIMIT</a>: u64 = 18446744073709551615; </code></pre>

<pre><code>const <a href="../bridge/limiter.md#bridge_limiter_USD_VALUE_MULTIPLIER">USD_VALUE_MULTIPLIER</a>: u64 = 100000000; </code></pre>

Function `get_route_limit`

<pre><code>public fun <a href="../bridge/limiter.md#bridge_limiter_get_route_limit">get_route_limit</a>(self: &<a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">bridge::limiter::TransferLimiter</a>, route: &<a href="../bridge/chain_ids.md#bridge_chain_ids_BridgeRoute">bridge::chain_ids::BridgeRoute</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../bridge/limiter.md#bridge_limiter_get_route_limit">get_route_limit</a>(self: &<a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">TransferLimiter</a>, route: &BridgeRoute): u64 { self.transfer_limits[route] } </code></pre> </details>

Function `new`

<pre><code>public(package) fun <a href="../bridge/limiter.md#bridge_limiter_new">new</a>(): <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">bridge::limiter::TransferLimiter</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/limiter.md#bridge_limiter_new">new</a>(): <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">TransferLimiter</a> { // hardcoded limit for <a href="../bridge/bridge.md#bridge_bridge">bridge</a> genesis <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">TransferLimiter</a> { transfer_limits: <a href="../bridge/limiter.md#bridge_limiter_initial_transfer_limits">initial_transfer_limits</a>(), transfer_records: vec_map::empty(), } } </code></pre> </details>

Function `check_and_record_sending_transfer`

<pre><code>public(package) fun <a href="../bridge/limiter.md#bridge_limiter_check_and_record_sending_transfer">check_and_record_sending_transfer</a><T>(self: &mut <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">bridge::limiter::TransferLimiter</a>, <a href="../bridge/treasury.md#bridge_treasury">treasury</a>: &<a href="../bridge/treasury.md#bridge_treasury_BridgeTreasury">bridge::treasury::BridgeTreasury</a>, clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>, route: <a href="../bridge/chain_ids.md#bridge_chain_ids_BridgeRoute">bridge::chain_ids::BridgeRoute</a>, amount: u64): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/limiter.md#bridge_limiter_check_and_record_sending_transfer">check_and_record_sending_transfer</a><T>( self: &mut <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">TransferLimiter</a>, <a href="../bridge/treasury.md#bridge_treasury">treasury</a>: &BridgeTreasury, clock: &Clock, route: BridgeRoute, amount: u64, ): bool { // Create record for route if not exists if (!self.transfer_records.contains(&route)) { self .transfer_records .insert( route, <a href="../bridge/limiter.md#bridge_limiter_TransferRecord">TransferRecord</a> { hour_head: 0, hour_tail: 0, per_hour_amounts: vector[], total_amount: 0, }, ) }; let record = self.transfer_records.get_mut(&route); let <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a> = <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>(clock); record.<a href="../bridge/limiter.md#bridge_limiter_adjust_transfer_records">adjust_transfer_records</a>(<a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>); // Get limit for the route let route_limit = self.transfer_limits.try_get(&route); assert!(route_limit.is_some(), <a href="../bridge/limiter.md#bridge_limiter_ELimitNotFoundForRoute">ELimitNotFoundForRoute</a>); let route_limit = route_limit.destroy_some(); let route_limit_adjusted = (route_limit as u128) * (<a href="../bridge/treasury.md#bridge_treasury">treasury</a>.decimal_multiplier<T>() as u128); // Compute notional amount // Upcast to u128 to prevent overflow, to not miss out on small amounts. let value = (<a href="../bridge/treasury.md#bridge_treasury">treasury</a>.notional_value<T>() as u128); let notional_amount_with_token_multiplier = value * (amount as u128); // Check if transfer amount exceed limit // Upscale them to the token's decimal. if ( (record.total_amount as u128) * (<a href="../bridge/treasury.md#bridge_treasury">treasury</a>.decimal_multiplier<T>() as u128) + notional_amount_with_token_multiplier > route_limit_adjusted ) { return false }; // Now scale down to notional value let notional_amount = notional_amount_with_token_multiplier / (<a href="../bridge/treasury.md#bridge_treasury">treasury</a>.decimal_multiplier<T>() as u128); // Should be safe to downcast to u64 after dividing by the decimals let notional_amount = (notional_amount as u64); // Record transfer value let new_amount = record.per_hour_amounts.pop_back() + notional_amount; record.per_hour_amounts.push_back(new_amount); record.total_amount = record.total_amount + notional_amount; true } </code></pre> </details>

Function `update_route_limit`

<pre><code>public(package) fun <a href="../bridge/limiter.md#bridge_limiter_update_route_limit">update_route_limit</a>(self: &mut <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">bridge::limiter::TransferLimiter</a>, route: &<a href="../bridge/chain_ids.md#bridge_chain_ids_BridgeRoute">bridge::chain_ids::BridgeRoute</a>, new_usd_limit: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../bridge/limiter.md#bridge_limiter_update_route_limit">update_route_limit</a>( self: &mut <a href="../bridge/limiter.md#bridge_limiter_TransferLimiter">TransferLimiter</a>, route: &BridgeRoute, new_usd_limit: u64, ) { let receiving_chain = *route.destination(); if (!self.transfer_limits.contains(route)) { self.transfer_limits.insert(*route, new_usd_limit); } else { *&mut self.transfer_limits[route] = new_usd_limit; }; event::emit(<a href="../bridge/limiter.md#bridge_limiter_UpdateRouteLimitEvent">UpdateRouteLimitEvent</a> { sending_chain: *route.source(), receiving_chain, new_limit: new_usd_limit, }) } </code></pre> </details>

Function `current_hour_since_epoch`

<pre><code>fun <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>(clock: &<a href="../sui/clock.md#sui_clock_Clock">sui::clock::Clock</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>(clock: &Clock): u64 { clock::timestamp_ms(clock) / 3600000 } </code></pre> </details>

Function `adjust_transfer_records`

<pre><code>fun <a href="../bridge/limiter.md#bridge_limiter_adjust_transfer_records">adjust_transfer_records</a>(self: &mut <a href="../bridge/limiter.md#bridge_limiter_TransferRecord">bridge::limiter::TransferRecord</a>, <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../bridge/limiter.md#bridge_limiter_adjust_transfer_records">adjust_transfer_records</a>(self: &mut <a href="../bridge/limiter.md#bridge_limiter_TransferRecord">TransferRecord</a>, <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>: u64) { if (self.hour_head == <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>) { return // nothing to backfill }; let target_tail = <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a> - 23; // If `hour_head` is even older than 24 hours ago, it means all items in // `per_hour_amounts` are to be evicted. if (self.hour_head < target_tail) { self.per_hour_amounts = vector[]; self.total_amount = 0; self.hour_tail = target_tail; self.hour_head = target_tail; // Don't forget to insert this hour's record self.per_hour_amounts.push_back(0); } else { // self.hour_head is within 24 hour range. // some items in `per_hour_amounts` are still valid, we remove stale hours. while (self.hour_tail < target_tail) { self.total_amount = self.total_amount - self.per_hour_amounts.remove(0); self.hour_tail = self.hour_tail + 1; } }; // Backfill from hour_head to current hour while (self.hour_head < <a href="../bridge/limiter.md#bridge_limiter_current_hour_since_epoch">current_hour_since_epoch</a>) { self.per_hour_amounts.push_back(0); self.hour_head = self.hour_head + 1; } } </code></pre> </details>

Function `initial_transfer_limits`

<pre><code>fun <a href="../bridge/limiter.md#bridge_limiter_initial_transfer_limits">initial_transfer_limits</a>(): <a href="../sui/vec_map.md#sui_vec_map_VecMap">sui::vec_map::VecMap</a><<a href="../bridge/chain_ids.md#bridge_chain_ids_BridgeRoute">bridge::chain_ids::BridgeRoute</a>, u64> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../bridge/limiter.md#bridge_limiter_initial_transfer_limits">initial_transfer_limits</a>(): VecMap<BridgeRoute, u64> { let mut transfer_limits = vec_map::empty(); // 5M limit on Sui -> Ethereum mainnet transfer_limits.insert( <a href="../bridge/chain_ids.md#bridge_chain_ids_get_route">chain_ids::get_route</a>(<a href="../bridge/chain_ids.md#bridge_chain_ids_eth_mainnet">chain_ids::eth_mainnet</a>(), <a href="../bridge/chain_ids.md#bridge_chain_ids_sui_mainnet">chain_ids::sui_mainnet</a>()), 5_000_000 * <a href="../bridge/limiter.md#bridge_limiter_USD_VALUE_MULTIPLIER">USD_VALUE_MULTIPLIER</a>, ); // MAX limit for testnet and devnet transfer_limits.insert( <a href="../bridge/chain_ids.md#bridge_chain_ids_get_route">chain_ids::get_route</a>(<a href="../bridge/chain_ids.md#bridge_chain_ids_eth_sepolia">chain_ids::eth_sepolia</a>(), <a href="../bridge/chain_ids.md#bridge_chain_ids_sui_testnet">chain_ids::sui_testnet</a>()), <a href="../bridge/limiter.md#bridge_limiter_MAX_TRANSFER_LIMIT">MAX_TRANSFER_LIMIT</a>, ); transfer_limits.insert( <a href="../bridge/chain_ids.md#bridge_chain_ids_get_route">chain_ids::get_route</a>(<a href="../bridge/chain_ids.md#bridge_chain_ids_eth_sepolia">chain_ids::eth_sepolia</a>(), <a href="../bridge/chain_ids.md#bridge_chain_ids_sui_custom">chain_ids::sui_custom</a>()), <a href="../bridge/limiter.md#bridge_limiter_MAX_TRANSFER_LIMIT">MAX_TRANSFER_LIMIT</a>, ); transfer_limits.insert( <a href="../bridge/chain_ids.md#bridge_chain_ids_get_route">chain_ids::get_route</a>(<a href="../bridge/chain_ids.md#bridge_chain_ids_eth_custom">chain_ids::eth_custom</a>(), <a href="../bridge/chain_ids.md#bridge_chain_ids_sui_testnet">chain_ids::sui_testnet</a>()), <a href="../bridge/limiter.md#bridge_limiter_MAX_TRANSFER_LIMIT">MAX_TRANSFER_LIMIT</a>, ); transfer_limits.insert( <a href="../bridge/chain_ids.md#bridge_chain_ids_get_route">chain_ids::get_route</a>(<a href="../bridge/chain_ids.md#bridge_chain_ids_eth_custom">chain_ids::eth_custom</a>(), <a href="../bridge/chain_ids.md#bridge_chain_ids_sui_custom">chain_ids::sui_custom</a>()), <a href="../bridge/limiter.md#bridge_limiter_MAX_TRANSFER_LIMIT">MAX_TRANSFER_LIMIT</a>, ); transfer_limits } </code></pre> </details>

Struct TransferLimiter

Struct TransferRecord

Struct UpdateRouteLimitEvent

Constants

Function get_route_limit

Function new

Function check_and_record_sending_transfer

Function update_route_limit

Function current_hour_since_epoch

Function adjust_transfer_records

Function initial_transfer_limits