Struct TransactionDenyRules 

pub struct TransactionDenyRules {
    pub object_deny_list: BTreeSet<ObjectID>,
    pub package_deny_list: BTreeSet<ObjectID>,
    pub address_deny_list: BTreeSet<SuiAddress>,
    pub package_publish_disabled: bool,
    pub package_upgrade_disabled: bool,
    pub shared_object_disabled: bool,
    pub user_transaction_disabled: bool,
    pub gasless_disabled: bool,
    pub receiving_objects_disabled: bool,
    pub zklogin_sig_disabled: bool,
    pub zklogin_disabled_providers: BTreeSet<String>,
}

The shareable subset of TransactionDenyConfig, rules for transactions that the node will refuse.

Fields

object_deny_list: BTreeSet<ObjectID>

A list of object IDs that are not allowed to be accessed/used in transactions. Note that since this is checked during transaction signing, only root object ids are supported here (i.e. no child-objects). Similarly this does not apply to wrapped objects as they are not directly accessible.

package_deny_list: BTreeSet<ObjectID>

A list of package object IDs that are not allowed to be called into in transactions, either directly or indirectly through transitive dependencies. Note that this does not apply to type arguments. Also since we only compare the deny list against the upgraded package ID of each dependency in the used package, when a package ID is denied, newer versions of that package are still allowed. If we want to deny the entire upgrade family of a package, we need to explicitly specify all the package IDs in the deny list.

address_deny_list: BTreeSet<SuiAddress>

A list of sui addresses that are not allowed to be used as the sender or sponsor.

package_publish_disabled: bool

Whether publishing new packages is disabled.

package_upgrade_disabled: bool

Whether upgrading existing packages is disabled.

shared_object_disabled: bool

Whether usage of shared objects is disabled.

user_transaction_disabled: bool

Whether user transactions are disabled (i.e. only system transactions are allowed). This is essentially a kill switch for transactions processing to a degree.

gasless_disabled: bool

Whether gasless transactions are disabled.

receiving_objects_disabled: bool

Whether receiving objects transferred to other objects is allowed.

zklogin_sig_disabled: bool

Whether zklogin transaction is disabled.

zklogin_disabled_providers: BTreeSet<String>

A list of disabled OAuth providers for zkLogin.

Implementations

impl TransactionDenyRules

pub const MAX_SHARE_ENTRIES: usize = 5_000

Maximum total entry count across all set fields permitted in a single peer-broadcast deny rules message.

pub const MAX_ZKLOGIN_PROVIDER_LENGTH: usize = 256

Maximum length, in bytes, of any single zkLogin provider string accepted from a peer recommendation. Real provider names are short (e.g. “Google”, “Apple”).

pub const MAX_SHARE_SERIALIZED_BYTES: u64

Maximum BCS-serialized size of a shared rules payload.

pub fn merge(&mut self, other: &Self)

Union-merge another rules set into this one. Set fields are extended; boolean fields are OR’d.

pub fn is_superset_of(&self, other: &Self) -> bool

Returns true if self contains every rule in other: each set field of other is a subset of self’s, and every boolean set in other is set in self. A peer’s proposal “votes for” a pre-listed config only when it is a superset of that config’s rules.

pub fn elements(&self) -> impl Iterator<Item = DenyElement> + '_

Iterate the individual rule elements of this rules set: one item per deny-list entry and one per true boolean flag.

pub fn apply_element(&mut self, element: &DenyElement)

Apply a single rule element to this rules set.

pub fn is_empty(&self) -> bool

pub fn entry_count(&self) -> usize

pub fn check_share_limits(&self) -> Result<(), String>

Reject rules that are too large to share via consensus. Used by both the admin endpoint (before submission) and the consensus validator (on receive) so the limits can’t drift between the two checks.

Trait Implementations

impl Clone for TransactionDenyRules

fn clone(&self) -> TransactionDenyRules

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransactionDenyRules

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransactionDenyRules

fn default() -> TransactionDenyRules

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransactionDenyRules

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TransactionDenyRules

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TransactionDenyRules

fn eq(&self, other: &TransactionDenyRules) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TransactionDenyRules

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TransactionDenyRules

impl StructuralPartialEq for TransactionDenyRules