Skip to main content

DenyRuleSet

data class DenyRuleSet(var deniedAddresses: List<Address>, var deniedObjects: List<ObjectId>, var deniedPackages: List<ObjectId>, var packagePublishDisabled: Boolean, var packageUpgradeDisabled: Boolean, var sharedObjectDisabled: Boolean, var userTransactionDisabled: Boolean, var receivingObjectsDisabled: Boolean, var moveAuthenticatorDisabled: Boolean) : Disposable

A complete set of transaction deny rules.

The deny lists are exposed as sequences over the FFI; converting into the underlying set-typed Rust representation sorts and deduplicates them, so the BCS encoding is canonical regardless of the order supplied here.

BCS

The BCS serialized form for this type is defined by the following ABNF:

deny-rule-set = (vector address)   ; denied addresses
(vector object-id) ; denied objects
(vector object-id) ; denied packages
bool ; package publish disabled
bool ; package upgrade disabled
bool ; shared object disabled
bool ; user transaction disabled
bool ; receiving objects disabled
bool ; move authenticator disabled

Constructors

DenyRuleSetconstructor(deniedAddresses: List<Address>, deniedObjects: List<ObjectId>, deniedPackages: List<ObjectId>, packagePublishDisabled: Boolean, packageUpgradeDisabled: Boolean, sharedObjectDisabled: Boolean, userTransactionDisabled: Boolean, receivingObjectsDisabled: Boolean, moveAuthenticatorDisabled: Boolean)

Properties

NameSummary
deniedAddressesvar deniedAddresses: List<Address>
Addresses denied as transaction sender or gas sponsor. A denied address can still receive objects.
deniedObjectsvar deniedObjects: List<ObjectId>
Objects denied as transaction inputs or receiving objects.
deniedPackagesvar deniedPackages: List<ObjectId>
Packages denied as a (transitive) dependency of any command; upgrading a denied package is denied too.
moveAuthenticatorDisabledvar moveAuthenticatorDisabled: Boolean
Denies transactions signed with a Move authenticator.
packagePublishDisabledvar packagePublishDisabled: Boolean
Denies all package publishing.
packageUpgradeDisabledvar packageUpgradeDisabled: Boolean
Denies all package upgrades.
receivingObjectsDisabledvar receivingObjectsDisabled: Boolean
Denies transactions that contain receiving objects.
sharedObjectDisabledvar sharedObjectDisabled: Boolean
Denies transactions that use shared objects as inputs.
userTransactionDisabledvar userTransactionDisabled: Boolean
Denies all user transactions (kill switch).

Functions

NameSummary
destroyopen override fun destroy()