Module `sui::accumulator`

Struct AccumulatorRoot
Struct U128
Struct Key
Constants
Function create
Function root_id
Function root_id_mut
Function accumulator_u128_exists
Function accumulator_u128_read
Function create_u128
Function destroy_u128
Function update_u128
Function is_zero_u128
Function accumulator_key
Function accumulator_address
Function root_has_accumulator
Function root_add_accumulator
Function root_borrow_accumulator_mut
Function root_borrow_accumulator
Function root_remove_accumulator
Function emit_deposit_event
Function emit_withdraw_event

<pre><code>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/option.md#std_option">std::option</a>; use <a href="../std/string.md#std_string">std::string</a>; use <a href="../std/vector.md#std_vector">std::vector</a>; use <a href="../sui/address.md#sui_address">sui::address</a>; use <a href="../sui/dynamic_field.md#sui_dynamic_field">sui::dynamic_field</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/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/vec_map.md#sui_vec_map">sui::vec_map</a>; </code></pre>

Struct `AccumulatorRoot`

<pre><code>public struct <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a> has key </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>id: <a href="../sui/object.md#sui_object_UID">sui::object::UID</a></code> </dt> <dd> </dd> </dl> </details>

Struct `U128`

Storage for 128-bit accumulator values.

Currently only used to represent the sum of 64 bit values (such as <code>Balance<T></code>). The additional bits are necessary to prevent overflow, as it would take 2^64 deposits of U64_MAX to cause an overflow.

<pre><code>public struct <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>value: u128</code> </dt> <dd> </dd> </dl> </details>

Struct `Key`

<code><a href="../sui/accumulator.md#sui_accumulator_Key">Key</a></code> is used only for computing the field id of accumulator objects. <code>T</code> is the type of the accumulated value, e.g. <code>Balance<SUI></code>

<pre><code>public struct <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><phantom T> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>address: address</code> </dt> <dd> </dd> </dl> </details>

Constants

<pre><code>const <a href="../sui/accumulator.md#sui_accumulator_ENotSystemAddress">ENotSystemAddress</a>: u64 = 0; </code></pre>

Function `create`

<pre><code>fun <a href="../sui/accumulator.md#sui_accumulator_create">create</a>(ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/accumulator.md#sui_accumulator_create">create</a>(ctx: &TxContext) { assert!(ctx.sender() == @0x0, <a href="../sui/accumulator.md#sui_accumulator_ENotSystemAddress">ENotSystemAddress</a>); <a href="../sui/transfer.md#sui_transfer_share_object">transfer::share_object</a>(<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a> { id: <a href="../sui/object.md#sui_object_sui_accumulator_root_object_id">object::sui_accumulator_root_object_id</a>(), }) } </code></pre> </details>

Function `root_id`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_id">root_id</a>(accumulator_root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>): &<a href="../sui/object.md#sui_object_UID">sui::object::UID</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_id">root_id</a>(accumulator_root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>): &UID { &accumulator_root.id } </code></pre> </details>

Function `root_id_mut`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_id_mut">root_id_mut</a>(accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>): &mut <a href="../sui/object.md#sui_object_UID">sui::object::UID</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_id_mut">root_id_mut</a>(accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>): &mut UID { &mut accumulator_root.id } </code></pre> </details>

Function `accumulator_u128_exists`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_u128_exists">accumulator_u128_exists</a><T>(root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, address: address): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_u128_exists">accumulator_u128_exists</a><T>(root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, address: address): bool { root.has_accumulator<T, <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a>>(<a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><T> { address }) } </code></pre> </details>

Function `accumulator_u128_read`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_u128_read">accumulator_u128_read</a><T>(root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, address: address): u128 </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_u128_read">accumulator_u128_read</a><T>(root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, address: address): u128 { let <a href="../sui/accumulator.md#sui_accumulator">accumulator</a> = root.borrow_accumulator<T, <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a>>(<a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><T> { address }); <a href="../sui/accumulator.md#sui_accumulator">accumulator</a>.value } </code></pre> </details>

Function `create_u128`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_create_u128">create_u128</a>(value: u128): <a href="../sui/accumulator.md#sui_accumulator_U128">sui::accumulator::U128</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_create_u128">create_u128</a>(value: u128): <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a> { <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a> { value } } </code></pre> </details>

Function `destroy_u128`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_destroy_u128">destroy_u128</a>(u128: <a href="../sui/accumulator.md#sui_accumulator_U128">sui::accumulator::U128</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_destroy_u128">destroy_u128</a>(u128: <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a>) { let <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a> { value: _ } = u128; } </code></pre> </details>

Function `update_u128`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_update_u128">update_u128</a>(u128: &mut <a href="../sui/accumulator.md#sui_accumulator_U128">sui::accumulator::U128</a>, merge: u128, split: u128) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_update_u128">update_u128</a>(u128: &mut <a href="../sui/accumulator.md#sui_accumulator_U128">U128</a>, merge: u128, split: u128) { u128.value = u128.value + merge - split; } </code></pre> </details>

Function `is_zero_u128`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_is_zero_u128">is_zero_u128</a>(u128: &<a href="../sui/accumulator.md#sui_accumulator_U128">sui::accumulator::U128</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_is_zero_u128">is_zero_u128</a>(u128: &<a href="../sui/accumulator.md#sui_accumulator_U128">U128</a>): bool { u128.value == 0 } </code></pre> </details>

Function `accumulator_key`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_key">accumulator_key</a><T>(address: address): <a href="../sui/accumulator.md#sui_accumulator_Key">sui::accumulator::Key</a><T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_key">accumulator_key</a><T>(address: address): <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><T> { <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a> { address } } </code></pre> </details>

Function `accumulator_address`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_address">accumulator_address</a><T>(address: address): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_accumulator_address">accumulator_address</a><T>(address: address): address { let key = <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><T> { address }; <a href="../sui/dynamic_field.md#sui_dynamic_field_hash_type_and_key">dynamic_field::hash_type_and_key</a>(sui_accumulator_root_address(), key) } </code></pre> </details>

Function `root_has_accumulator`

Balance object methods

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_has_accumulator">root_has_accumulator</a><K, V: store>(accumulator_root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">sui::accumulator::Key</a><K>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_has_accumulator">root_has_accumulator</a><K, V: store>( accumulator_root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, ): bool { <a href="../sui/dynamic_field.md#sui_dynamic_field_exists_with_type">dynamic_field::exists_with_type</a><<a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, V>(&accumulator_root.id, name) } </code></pre> </details>

Function `root_add_accumulator`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_add_accumulator">root_add_accumulator</a><K, V: store>(accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">sui::accumulator::Key</a><K>, value: V) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_add_accumulator">root_add_accumulator</a><K, V: store>( accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, value: V, ) { <a href="../sui/dynamic_field.md#sui_dynamic_field_add">dynamic_field::add</a>(&mut accumulator_root.id, name, value); } </code></pre> </details>

Function `root_borrow_accumulator_mut`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_borrow_accumulator_mut">root_borrow_accumulator_mut</a><K, V: store>(accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">sui::accumulator::Key</a><K>): &mut V </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_borrow_accumulator_mut">root_borrow_accumulator_mut</a><K, V: store>( accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, ): &mut V { <a href="../sui/dynamic_field.md#sui_dynamic_field_borrow_mut">dynamic_field::borrow_mut</a><<a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, V>(&mut accumulator_root.id, name) } </code></pre> </details>

Function `root_borrow_accumulator`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_borrow_accumulator">root_borrow_accumulator</a><K, V: store>(accumulator_root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">sui::accumulator::Key</a><K>): &V </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_borrow_accumulator">root_borrow_accumulator</a><K, V: store>( accumulator_root: &<a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, ): &V { <a href="../sui/dynamic_field.md#sui_dynamic_field_borrow">dynamic_field::borrow</a><<a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, V>(&accumulator_root.id, name) } </code></pre> </details>

Function `root_remove_accumulator`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_remove_accumulator">root_remove_accumulator</a><K, V: store>(accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">sui::accumulator::AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">sui::accumulator::Key</a><K>): V </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_root_remove_accumulator">root_remove_accumulator</a><K, V: store>( accumulator_root: &mut <a href="../sui/accumulator.md#sui_accumulator_AccumulatorRoot">AccumulatorRoot</a>, name: <a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, ): V { <a href="../sui/dynamic_field.md#sui_dynamic_field_remove">dynamic_field::remove</a><<a href="../sui/accumulator.md#sui_accumulator_Key">Key</a><K>, V>(&mut accumulator_root.id, name) } </code></pre> </details>

Function `emit_deposit_event`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_emit_deposit_event">emit_deposit_event</a><T>(<a href="../sui/accumulator.md#sui_accumulator">accumulator</a>: address, recipient: address, amount: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) native fun <a href="../sui/accumulator.md#sui_accumulator_emit_deposit_event">emit_deposit_event</a><T>( <a href="../sui/accumulator.md#sui_accumulator">accumulator</a>: address, recipient: address, amount: u64, ); </code></pre> </details>

Function `emit_withdraw_event`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/accumulator.md#sui_accumulator_emit_withdraw_event">emit_withdraw_event</a><T>(<a href="../sui/accumulator.md#sui_accumulator">accumulator</a>: address, owner: address, amount: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) native fun <a href="../sui/accumulator.md#sui_accumulator_emit_withdraw_event">emit_withdraw_event</a><T>( <a href="../sui/accumulator.md#sui_accumulator">accumulator</a>: address, owner: address, amount: u64, ); </code></pre> </details>

Struct AccumulatorRoot

Struct U128

Struct Key

Constants

Function create

Function root_id

Function root_id_mut

Function accumulator_u128_exists

Function accumulator_u128_read

Function create_u128

Function destroy_u128

Function update_u128

Function is_zero_u128

Function accumulator_key

Function accumulator_address

Function root_has_accumulator

Function root_add_accumulator

Function root_borrow_accumulator_mut

Function root_borrow_accumulator

Function root_remove_accumulator

Function emit_deposit_event

Function emit_withdraw_event