Skip to main content

Type Alias: DenyRuleSet

type DenyRuleSet = {
  deniedAddresses: AddressLike[];
  deniedObjects: ObjectIdLike[];
  deniedPackages: ObjectIdLike[];
  moveAuthenticatorDisabled: boolean;
  packagePublishDisabled: boolean;
  packageUpgradeDisabled: boolean;
  receivingObjectsDisabled: boolean;
  sharedObjectDisabled: boolean;
  userTransactionDisabled: boolean;
};

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

Properties​

deniedAddresses​

deniedAddresses: AddressLike[];

Addresses denied as transaction sender or gas sponsor. A denied address can still receive objects.

deniedObjects​

deniedObjects: ObjectIdLike[];

Objects denied as transaction inputs or receiving objects.

deniedPackages​

deniedPackages: ObjectIdLike[];

Packages denied as a (transitive) dependency of any command; upgrading a denied package is denied too.

moveAuthenticatorDisabled​

moveAuthenticatorDisabled: boolean;

Denies transactions signed with a Move authenticator.

packagePublishDisabled​

packagePublishDisabled: boolean;

Denies all package publishing.

packageUpgradeDisabled​

packageUpgradeDisabled: boolean;

Denies all package upgrades.

receivingObjectsDisabled​

receivingObjectsDisabled: boolean;

Denies transactions that contain receiving objects.

sharedObjectDisabled​

sharedObjectDisabled: boolean;

Denies transactions that use shared objects as inputs.

userTransactionDisabled​

userTransactionDisabled: boolean;

Denies all user transactions (kill switch).