Skip to main content

Deactivate

Asset Tokenization Studio Team

Deactivate

Abstract contract implementing the irreversible deactivation logic for a security token.

Implements IDeactivate. Deactivation state is stored via DeactivateStorageWrapper, which writes to a dedicated diamond storage slot. Intended to be inherited exclusively by DeactivateFacet. The state change is one-way: once the flag is set, the onlyActivated modifier blocks any further deactivate call as well as every other facet operation guarded by it.

Methods​

deactivate​

function deactivate() external nonpayable

Sets the token's deactivation flag, retiring the token irreversibly.

Composed of three preconditions: onlyUnpaused rejects the call when the token is paused (own flag or any external onlyOperational pause source), onlyRole(ROLE_DEACTIVATE) enforces caller authorisation, and onlyActivated makes the transition idempotent by reverting with Deactivated on a token that is already retired.

initializeDeactivate​

function initializeDeactivate() external nonpayable

Initialises the deactivate capability on the token.

Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.

isDeactivated​

function isDeactivated() external view returns (bool)

Reports whether the token has been deactivated.

Returns​

NameTypeDescription
_0boolTrue if deactivate has previously been invoked, false otherwise.

Events​

DeactivateInitialized​

event DeactivateInitialized()

Emitted once when the deactivate capability is initialised on a token.

Fires exclusively from initializeDeactivate.

Errors​

AccountHasNoRole​

error AccountHasNoRole(address account, bytes32 role)

Thrown when an account does not hold a required role.

Parameters​

NameTypeDescription
accountaddressThe account that lacks the role.
rolebytes32The role that is not held.

AssetNotOperational​

error AssetNotOperational(bytes32 configId, uint256 versionId)

Raised by InitializerStorageWrapper.checkOperational (and the related isConfigVersionOperational helper) when an operation is attempted on a configuration version that has not yet been marked operational.

Parameters​

NameTypeDescription
configIdbytes32Resolver-proxy configuration whose operational status was checked.
versionIduint256Configuration version whose operational status was checked.

Deactivated​

error Deactivated()

Thrown when an operation guarded by onlyActivated is attempted on a token whose deactivation flag has already been set.

FacetAlreadyRegistered​

error FacetAlreadyRegistered(bytes32 facetId, uint256 lastVersion)

Raised when an initialiser tries to register a facet that already has a non-zero last registered version (i.e. the facet is being re-initialised on a fresh install).

Parameters​

NameTypeDescription
facetIdbytes32Identifier of the offending facet.
lastVersionuint256Last version recorded for that facet at the time of the check.

IsPaused​

error IsPaused()

Thrown when an operation that requires the token to be unpaused is attempted while the token is paused (own flag or any external pause contract).

UnrecognizedResolverProxyVersion​

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

Thrown when the provided proxy version does not match any BLR compatible standard.

Parameters​

NameTypeDescription
_resolverProxyVersionbytes8proxy version that is not compatible with the BLR.

WalletRecovered​

error WalletRecovered()

Thrown when attempting to recover a wallet that has already been recovered.