Module `sui::deny_list`

Defines the <code><a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a></code> type. The <code><a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a></code> shared object is used to restrict access to instances of certain core types from being used as inputs by specified addresses in the deny list.

Struct DenyList
Struct ConfigWriteCap
Struct ConfigKey
Struct AddressKey
Struct GlobalPauseKey
Struct PerTypeConfigCreated
Struct PerTypeList
Constants
Function v2_add
Function v2_remove
Function v2_contains_current_epoch
Function v2_contains_next_epoch
Function v2_enable_global_pause
Function v2_disable_global_pause
Function v2_is_global_pause_enabled_current_epoch
Function v2_is_global_pause_enabled_next_epoch
Function migrate_v1_to_v2
Function add_per_type_config
Function borrow_per_type_config_mut
Function borrow_per_type_config
Function per_type_exists
Macro function per_type_config_entry
Function v1_add
Function v1_per_type_list_add
Function v1_remove
Function v1_per_type_list_remove
Function v1_contains
Function v1_per_type_list_contains
Function create
Function per_type_list

<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/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/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/bcs.md#sui_bcs">sui::bcs</a>; use <a href="../sui/config.md#sui_config">sui::config</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/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/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/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 `DenyList`

A shared object that stores the addresses that are blocked for a given core type.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</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> <dt> <code>lists: <a href="../sui/bag.md#sui_bag_Bag">sui::bag::Bag</a></code> </dt> <dd> The individual deny lists. </dd> </dl> </details>

Struct `ConfigWriteCap`

The capability used to write to the deny list config. Ensures that the Configs for the DenyList are modified only by this module.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a> has drop </code></pre> <details> <summary>Fields</summary> <dl> </dl> </details>

Struct `ConfigKey`

The dynamic object field key used to store the <code>Config</code> for a given type, essentially a <code>(per_type_index, per_type_key)</code> pair.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_ConfigKey">ConfigKey</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>per_type_index: u64</code> </dt> <dd> </dd> <dt> <code>per_type_key: vector<u8></code> </dt> <dd> </dd> </dl> </details>

Struct `AddressKey`

The setting key used to store the deny list for a given address in the <code>Config</code>.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>0: address</code> </dt> <dd> </dd> </dl> </details>

Struct `GlobalPauseKey`

The setting key used to store the global pause setting in the <code>Config</code>.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> </dl> </details>

Struct `PerTypeConfigCreated`

The event emitted when a new <code>Config</code> is created for a given type. This can be useful for tracking the <code>ID</code> of a type's <code>Config</code> object.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_PerTypeConfigCreated">PerTypeConfigCreated</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>key: <a href="../sui/deny_list.md#sui_deny_list_ConfigKey">sui::deny_list::ConfigKey</a></code> </dt> <dd> </dd> <dt> <code>config_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> </dd> </dl> </details>

Struct `PerTypeList`

Stores the addresses that are denied for a given core type.

<pre><code>public struct <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</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>denied_count: <a href="../sui/table.md#sui_table_Table">sui::table::Table</a><address, u64></code> </dt> <dd> Number of object types that have been banned for a given address. Used to quickly skip checks for most addresses. </dd> <dt> <code>denied_addresses: <a href="../sui/table.md#sui_table_Table">sui::table::Table</a><vector<u8>, <a href="../sui/vec_set.md#sui_vec_set_VecSet">sui::vec_set::VecSet</a><address>></code> </dt> <dd> Set of addresses that are banned for a given type. For example with <code><a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a></code>: If addresses A and B are banned from using "0...0123::my_coin::MY_COIN", this will be "0...0123::my_coin::MY_COIN" -> {A, B}. </dd> </dl> </details>

Constants

Trying to create a deny list object when not called by the system address.

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

The specified address to be removed is not already in the deny list.

<pre><code>const <a href="../sui/deny_list.md#sui_deny_list_ENotDenied">ENotDenied</a>: u64 = 1; </code></pre>

The specified address cannot be added to the deny list.

<pre><code>const <a href="../sui/deny_list.md#sui_deny_list_EInvalidAddress">EInvalidAddress</a>: u64 = 1; </code></pre>

The index into the deny list vector for the <code><a href="../sui/coin.md#sui_coin_Coin">sui::coin::Coin</a></code> type.

<pre><code>const <a href="../sui/deny_list.md#sui_deny_list_COIN_INDEX">COIN_INDEX</a>: u64 = 0; </code></pre>

These addresses are reserved and cannot be added to the deny list. The addresses listed are well known package and object addresses. So it would be meaningless to add them to the deny list.

<pre><code>const <a href="../sui/deny_list.md#sui_deny_list_RESERVED">RESERVED</a>: vector<address> = vector[0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf, 0x403, 0xdee9]; </code></pre>

Function `v2_add`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_add">v2_add</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, 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(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_add">v2_add</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, ctx: &mut TxContext, ) { let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>!(per_type_index, per_type_key, ctx); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>(addr); let next_epoch_entry = per_type_config.entry!<_, <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>, bool>( &mut <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>(), setting_name, |_deny_list, _cap, _ctx| true, ctx, ); *next_epoch_entry = true; } </code></pre> </details>

Function `v2_remove`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_remove">v2_remove</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, 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(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_remove">v2_remove</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, ctx: &mut TxContext, ) { let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>!(per_type_index, per_type_key, ctx); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>(addr); per_type_config.remove_for_next_epoch<_, <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>, bool>( &mut <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>(), setting_name, ctx, ); } </code></pre> </details>

Function `v2_contains_current_epoch`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_contains_current_epoch">v2_contains_current_epoch</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_contains_current_epoch">v2_contains_current_epoch</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, ctx: &TxContext, ): bool { if (!<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(per_type_index, per_type_key)) return false; let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config">borrow_per_type_config</a>(per_type_index, per_type_key); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>(addr); <a href="../sui/config.md#sui_config_read_setting">config::read_setting</a>(<a href="../sui/object.md#sui_object_id">object::id</a>(per_type_config), setting_name, ctx).destroy_or!(false) } </code></pre> </details>

Function `v2_contains_next_epoch`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_contains_next_epoch">v2_contains_next_epoch</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_contains_next_epoch">v2_contains_next_epoch</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, addr: address, ): bool { if (!<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(per_type_index, per_type_key)) return false; let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config">borrow_per_type_config</a>(per_type_index, per_type_key); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>(addr); per_type_config.read_setting_for_next_epoch(setting_name).destroy_or!(false) } </code></pre> </details>

Function `v2_enable_global_pause`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_enable_global_pause">v2_enable_global_pause</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, 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(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_enable_global_pause">v2_enable_global_pause</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ctx: &mut TxContext, ) { let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>!(per_type_index, per_type_key, ctx); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a>(); let next_epoch_entry = per_type_config.entry!<_, <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a>, bool>( &mut <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>(), setting_name, |_deny_list, _cap, _ctx| true, ctx, ); *next_epoch_entry = true; } </code></pre> </details>

Function `v2_disable_global_pause`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_disable_global_pause">v2_disable_global_pause</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, 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(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_disable_global_pause">v2_disable_global_pause</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ctx: &mut TxContext, ) { let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>!(per_type_index, per_type_key, ctx); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a>(); per_type_config.remove_for_next_epoch<_, <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a>, bool>( &mut <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>(), setting_name, ctx, ); } </code></pre> </details>

Function `v2_is_global_pause_enabled_current_epoch`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_is_global_pause_enabled_current_epoch">v2_is_global_pause_enabled_current_epoch</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_is_global_pause_enabled_current_epoch">v2_is_global_pause_enabled_current_epoch</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ctx: &TxContext, ): bool { if (!<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(per_type_index, per_type_key)) return false; let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config">borrow_per_type_config</a>(per_type_index, per_type_key); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a>(); <a href="../sui/config.md#sui_config_read_setting">config::read_setting</a>(<a href="../sui/object.md#sui_object_id">object::id</a>(per_type_config), setting_name, ctx).destroy_or!(false) } </code></pre> </details>

Function `v2_is_global_pause_enabled_next_epoch`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_is_global_pause_enabled_next_epoch">v2_is_global_pause_enabled_next_epoch</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v2_is_global_pause_enabled_next_epoch">v2_is_global_pause_enabled_next_epoch</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ): bool { if (!<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(per_type_index, per_type_key)) return false; let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config">borrow_per_type_config</a>(per_type_index, per_type_key); let setting_name = <a href="../sui/deny_list.md#sui_deny_list_GlobalPauseKey">GlobalPauseKey</a>(); per_type_config.read_setting_for_next_epoch(setting_name).destroy_or!(false) } </code></pre> </details>

Function `migrate_v1_to_v2`

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_migrate_v1_to_v2">migrate_v1_to_v2</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, 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(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_migrate_v1_to_v2">migrate_v1_to_v2</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ctx: &mut TxContext, ) { let bag_entry: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a> = &mut <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.lists[per_type_index]; let elements = if (!bag_entry.denied_addresses.contains(per_type_key)) vector[] else bag_entry .denied_addresses .remove(per_type_key) .into_keys(); elements.do_ref!(|addr| { let addr = *addr; let denied_count = &mut bag_entry.denied_count[addr]; *denied_count = *denied_count - 1; if (*denied_count == 0) { bag_entry.denied_count.remove(addr); } }); let per_type_config = <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>!(per_type_index, per_type_key, ctx); elements.do!(|addr| { let setting_name = <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>(addr); let next_epoch_entry = per_type_config.entry!<_, <a href="../sui/deny_list.md#sui_deny_list_AddressKey">AddressKey</a>, bool>( &mut <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>(), setting_name, |_deny_list, _cap, _ctx| true, ctx, ); *next_epoch_entry = true; }); } </code></pre> </details>

Function `add_per_type_config`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_add_per_type_config">add_per_type_config</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, 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>fun <a href="../sui/deny_list.md#sui_deny_list_add_per_type_config">add_per_type_config</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ctx: &mut TxContext, ) { let key = <a href="../sui/deny_list.md#sui_deny_list_ConfigKey">ConfigKey</a> { per_type_index, per_type_key }; let <a href="../sui/config.md#sui_config">config</a> = <a href="../sui/config.md#sui_config_new">config::new</a>(&mut <a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>(), ctx); let config_id = <a href="../sui/object.md#sui_object_id">object::id</a>(&<a href="../sui/config.md#sui_config">config</a>); ofield::internal_add(&mut <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.id, key, <a href="../sui/config.md#sui_config">config</a>); <a href="../sui/event.md#sui_event_emit">sui::event::emit</a>(<a href="../sui/deny_list.md#sui_deny_list_PerTypeConfigCreated">PerTypeConfigCreated</a> { key, config_id }); } </code></pre> </details>

Function `borrow_per_type_config_mut`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config_mut">borrow_per_type_config_mut</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>): &mut <a href="../sui/config.md#sui_config_Config">sui::config::Config</a><<a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">sui::deny_list::ConfigWriteCap</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config_mut">borrow_per_type_config_mut</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ): &mut Config<<a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>> { let key = <a href="../sui/deny_list.md#sui_deny_list_ConfigKey">ConfigKey</a> { per_type_index, per_type_key }; ofield::internal_borrow_mut(&mut <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.id, key) } </code></pre> </details>

Function `borrow_per_type_config`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config">borrow_per_type_config</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>): &<a href="../sui/config.md#sui_config_Config">sui::config::Config</a><<a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">sui::deny_list::ConfigWriteCap</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config">borrow_per_type_config</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>, ): &Config<<a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>> { let key = <a href="../sui/deny_list.md#sui_deny_list_ConfigKey">ConfigKey</a> { per_type_index, per_type_key }; ofield::internal_borrow(&<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.id, key) } </code></pre> </details>

Function `per_type_exists`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, per_type_key: vector<u8>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, per_type_key: vector<u8>): bool { let key = <a href="../sui/deny_list.md#sui_deny_list_ConfigKey">ConfigKey</a> { per_type_index, per_type_key }; ofield::exists_(&<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.id, key) } </code></pre> </details>

Macro function `per_type_config_entry`

<pre><code>macro fun <a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>($<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, $per_type_index: u64, $per_type_key: vector<u8>, $ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): &mut <a href="../sui/config.md#sui_config_Config">sui::config::Config</a><<a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">sui::deny_list::ConfigWriteCap</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>macro fun <a href="../sui/deny_list.md#sui_deny_list_per_type_config_entry">per_type_config_entry</a>( $<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, $per_type_index: u64, $per_type_key: vector<u8>, $ctx: &mut TxContext, ): &mut Config<<a href="../sui/deny_list.md#sui_deny_list_ConfigWriteCap">ConfigWriteCap</a>> { let <a href="../sui/deny_list.md#sui_deny_list">deny_list</a> = $<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>; let per_type_index = $per_type_index; let per_type_key = $per_type_key; let ctx = $ctx; if (!<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_per_type_exists">per_type_exists</a>(per_type_index, per_type_key)) { <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_add_per_type_config">add_per_type_config</a>(per_type_index, per_type_key, ctx); }; <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.<a href="../sui/deny_list.md#sui_deny_list_borrow_per_type_config_mut">borrow_per_type_config_mut</a>(per_type_index, per_type_key) } </code></pre> </details>

Function `v1_add`

Adds the given address to the deny list of the specified type, preventing it from interacting with instances of that type as an input to a transaction. For coins, the type specified is the type of the coin, not the coin type itself. For example, "00...0123::my_coin::MY_COIN" would be the type, not "00...02::coin::Coin".

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v1_add">v1_add</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, type: vector<u8>, addr: address) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v1_add">v1_add</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, `type`: vector<u8>, addr: address, ) { let reserved = <a href="../sui/deny_list.md#sui_deny_list_RESERVED">RESERVED</a>; assert!(!reserved.contains(&addr), <a href="../sui/deny_list.md#sui_deny_list_EInvalidAddress">EInvalidAddress</a>); let bag_entry: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a> = &mut <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.lists[per_type_index]; bag_entry.<a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_add">v1_per_type_list_add</a>(`type`, addr) } </code></pre> </details>

Function `v1_per_type_list_add`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_add">v1_per_type_list_add</a>(list: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">sui::deny_list::PerTypeList</a>, type: vector<u8>, addr: address) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_add">v1_per_type_list_add</a>(list: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a>, `type`: vector<u8>, addr: address) { if (!list.denied_addresses.contains(`type`)) { list.denied_addresses.add(`type`, <a href="../sui/vec_set.md#sui_vec_set_empty">vec_set::empty</a>()); }; let denied_addresses = &mut list.denied_addresses[`type`]; let already_denied = denied_addresses.contains(&addr); if (already_denied) return; denied_addresses.insert(addr); if (!list.denied_count.contains(addr)) { list.denied_count.add(addr, 0); }; let denied_count = &mut list.denied_count[addr]; *denied_count = *denied_count + 1; } </code></pre> </details>

Function `v1_remove`

Removes a previously denied address from the list. Aborts with <code><a href="../sui/deny_list.md#sui_deny_list_ENotDenied">ENotDenied</a></code> if the address is not on the list.

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v1_remove">v1_remove</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, type: vector<u8>, addr: address) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v1_remove">v1_remove</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &mut <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, `type`: vector<u8>, addr: address, ) { let reserved = <a href="../sui/deny_list.md#sui_deny_list_RESERVED">RESERVED</a>; assert!(!reserved.contains(&addr), <a href="../sui/deny_list.md#sui_deny_list_EInvalidAddress">EInvalidAddress</a>); let bag_entry: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a> = &mut <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.lists[per_type_index]; bag_entry.<a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_remove">v1_per_type_list_remove</a>(`type`, addr) } </code></pre> </details>

Function `v1_per_type_list_remove`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_remove">v1_per_type_list_remove</a>(list: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">sui::deny_list::PerTypeList</a>, type: vector<u8>, addr: address) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_remove">v1_per_type_list_remove</a>(list: &mut <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a>, `type`: vector<u8>, addr: address) { let denied_addresses = &mut list.denied_addresses[`type`]; assert!(denied_addresses.contains(&addr), <a href="../sui/deny_list.md#sui_deny_list_ENotDenied">ENotDenied</a>); denied_addresses.remove(&addr); let denied_count = &mut list.denied_count[addr]; *denied_count = *denied_count - 1; if (*denied_count == 0) { list.denied_count.remove(addr); } } </code></pre> </details>

Function `v1_contains`

Returns true iff the given address is denied for the given type.

<pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v1_contains">v1_contains</a>(<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">sui::deny_list::DenyList</a>, per_type_index: u64, type: vector<u8>, addr: address): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public(<a href="../sui/package.md#sui_package">package</a>) fun <a href="../sui/deny_list.md#sui_deny_list_v1_contains">v1_contains</a>( <a href="../sui/deny_list.md#sui_deny_list">deny_list</a>: &<a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a>, per_type_index: u64, `type`: vector<u8>, addr: address, ): bool { let reserved = <a href="../sui/deny_list.md#sui_deny_list_RESERVED">RESERVED</a>; if (reserved.contains(&addr)) return false; let bag_entry: &<a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a> = &<a href="../sui/deny_list.md#sui_deny_list">deny_list</a>.lists[per_type_index]; bag_entry.<a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_contains">v1_per_type_list_contains</a>(`type`, addr) } </code></pre> </details>

Function `v1_per_type_list_contains`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_contains">v1_per_type_list_contains</a>(list: &<a href="../sui/deny_list.md#sui_deny_list_PerTypeList">sui::deny_list::PerTypeList</a>, type: vector<u8>, addr: address): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_v1_per_type_list_contains">v1_per_type_list_contains</a>(list: &<a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a>, `type`: vector<u8>, addr: address): bool { if (!list.denied_count.contains(addr)) return false; let denied_count = &list.denied_count[addr]; if (*denied_count == 0) return false; if (!list.denied_addresses.contains(`type`)) return false; let denied_addresses = &list.denied_addresses[`type`]; denied_addresses.contains(&addr) } </code></pre> </details>

Function `create`

Creation of the deny list object is restricted to the system address via a system transaction.

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_create">create</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>fun <a href="../sui/deny_list.md#sui_deny_list_create">create</a>(ctx: &mut TxContext) { assert!(ctx.sender() == @0x0, <a href="../sui/deny_list.md#sui_deny_list_ENotSystemAddress">ENotSystemAddress</a>); let mut lists = <a href="../sui/bag.md#sui_bag_new">bag::new</a>(ctx); lists.add(<a href="../sui/deny_list.md#sui_deny_list_COIN_INDEX">COIN_INDEX</a>, <a href="../sui/deny_list.md#sui_deny_list_per_type_list">per_type_list</a>(ctx)); let deny_list_object = <a href="../sui/deny_list.md#sui_deny_list_DenyList">DenyList</a> { id: <a href="../sui/object.md#sui_object_sui_deny_list_object_id">object::sui_deny_list_object_id</a>(), lists, }; <a href="../sui/transfer.md#sui_transfer_share_object">transfer::share_object</a>(deny_list_object); } </code></pre> </details>

Function `per_type_list`

<pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_per_type_list">per_type_list</a>(ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">sui::deny_list::PerTypeList</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui/deny_list.md#sui_deny_list_per_type_list">per_type_list</a>(ctx: &mut TxContext): <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a> { <a href="../sui/deny_list.md#sui_deny_list_PerTypeList">PerTypeList</a> { id: <a href="../sui/object.md#sui_object_new">object::new</a>(ctx), denied_count: <a href="../sui/table.md#sui_table_new">table::new</a>(ctx), denied_addresses: <a href="../sui/table.md#sui_table_new">table::new</a>(ctx), } } </code></pre> </details>

Struct DenyList

Struct ConfigWriteCap

Struct ConfigKey

Struct AddressKey

Struct GlobalPauseKey

Struct PerTypeConfigCreated

Struct PerTypeList

Constants

Function v2_add

Function v2_remove

Function v2_contains_current_epoch

Function v2_contains_next_epoch

Function v2_enable_global_pause

Function v2_disable_global_pause

Function v2_is_global_pause_enabled_current_epoch

Function v2_is_global_pause_enabled_next_epoch

Function migrate_v1_to_v2

Function add_per_type_config

Function borrow_per_type_config_mut

Function borrow_per_type_config

Function per_type_exists

Macro function per_type_config_entry

Function v1_add

Function v1_per_type_list_add

Function v1_remove

Function v1_per_type_list_remove

Function v1_contains

Function v1_per_type_list_contains

Function create

Function per_type_list