Skip to main content

DenyRuleSet

Namespace: IotaSdk

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
public record class DenyRuleSet : System.IDisposable, System.IEquatable`1[[IotaSdk.DenyRuleSet, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance ObjectDenyRuleSet
Implements IDisposable, IEquatable<DenyRuleSet>
Attributes NullableContextAttribute, NullableAttribute

Properties

DeniedAddresses

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

public Address[] DeniedAddresses { get; init; }

Property Value

Address[]

DeniedObjects

Objects denied as transaction inputs or receiving objects.

public ObjectId[] DeniedObjects { get; init; }

Property Value

ObjectId[]

DeniedPackages

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

public ObjectId[] DeniedPackages { get; init; }

Property Value

ObjectId[]

PackagePublishDisabled

Denies all package publishing.

public bool PackagePublishDisabled { get; init; }

Property Value

Boolean

PackageUpgradeDisabled

Denies all package upgrades.

public bool PackageUpgradeDisabled { get; init; }

Property Value

Boolean

SharedObjectDisabled

Denies transactions that use shared objects as inputs.

public bool SharedObjectDisabled { get; init; }

Property Value

Boolean

UserTransactionDisabled

Denies all user transactions (kill switch).

public bool UserTransactionDisabled { get; init; }

Property Value

Boolean

ReceivingObjectsDisabled

Denies transactions that contain receiving objects.

public bool ReceivingObjectsDisabled { get; init; }

Property Value

Boolean

MoveAuthenticatorDisabled

Denies transactions signed with a Move authenticator.

public bool MoveAuthenticatorDisabled { get; init; }

Property Value

Boolean

Constructors

DenyRuleSet(Address[], ObjectId[], ObjectId[], Boolean, Boolean, Boolean, Boolean, Boolean, 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
public DenyRuleSet(Address[] DeniedAddresses, ObjectId[] DeniedObjects, ObjectId[] DeniedPackages, bool PackagePublishDisabled, bool PackageUpgradeDisabled, bool SharedObjectDisabled, bool UserTransactionDisabled, bool ReceivingObjectsDisabled, bool MoveAuthenticatorDisabled)

Parameters

DeniedAddresses Address[]
Addresses denied as transaction sender or gas sponsor. A denied address can still receive objects.

DeniedObjects ObjectId[]
Objects denied as transaction inputs or receiving objects.

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

PackagePublishDisabled Boolean
Denies all package publishing.

PackageUpgradeDisabled Boolean
Denies all package upgrades.

SharedObjectDisabled Boolean
Denies transactions that use shared objects as inputs.

UserTransactionDisabled Boolean
Denies all user transactions (kill switch).

ReceivingObjectsDisabled Boolean
Denies transactions that contain receiving objects.

MoveAuthenticatorDisabled Boolean
Denies transactions signed with a Move authenticator.

Methods

Dispose()

public void Dispose()