Skip to main content

BatchControllerFacet

Asset Tokenization Studio Team

BatchControllerFacet

Diamond facet exposing controller-only batch transfer operations.

Registers the batchForcedTransfer selector. Inherits business logic from the BatchController abstract contract.

Methods​

batchForcedTransfer​

function batchForcedTransfer(address[] _fromList, address[] _toList, uint256[] _amounts) external nonpayable

Batch forced transfer of tokens from multiple source addresses to multiple destinations.

Restricted to accounts holding the controller or agent role. Requires the token to be controllable and operating in single-partition mode. Emits one IController.ControllerTransfer event per element.

Parameters​

NameTypeDescription
_fromListaddress[]Source addresses to debit.
_toListaddress[]Destination addresses to credit.
_amountsuint256[]Amounts to transfer, positionally aligned with _fromList and _toList.

getStaticFunctionSelectors​

function getStaticFunctionSelectors() external pure returns (bytes4[])

Gets all function selectors of a facet

Returns​

NameTypeDescription
_0bytes4[]Face functions selectors

getStaticInterfaceIds​

function getStaticInterfaceIds() external pure returns (bytes4[])

Gets all interfaces ids of a facet.

Returns​

NameTypeDescription
_0bytes4[]Face interface ids

getStaticResolverKey​

function getStaticResolverKey() external pure returns (bytes32 staticResolverKey_)

Gets the static resolver key

Returns​

NameTypeDescription
staticResolverKey_bytes32Static resolver key

initializeBatchController​

function initializeBatchController() external nonpayable

Initialises the batch controller capability on the token.

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

Events​

BatchControllerInitialized​

event BatchControllerInitialized()

Emitted once when the batch controller capability is initialised on a token.

Fires exclusively from initializeBatchController after the storage write succeeds.

ControllerTransfer​

event ControllerTransfer(address controller, address indexed from, address indexed to, uint256 value, bytes data, bytes operatorData)

Emitted when an authorised controller transfers tokens between two holders.

Parameters​

NameTypeDescription
controlleraddressThe address of the controller that initiated the transfer.
from indexedaddressThe address tokens are transferred from.
to indexedaddressThe address tokens are transferred to.
valueuint256The amount of tokens transferred.
databytesOptional data attached to the transfer for validation.
operatorDatabytesOptional data attached by the controller for event attribution.

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.

AccountHasNoRoles​

error AccountHasNoRoles(address account, bytes32[] roles)

Thrown when an account does not hold any of the specified roles.

Parameters​

NameTypeDescription
accountaddressThe account that lacks the roles.
rolesbytes32[]The roles that are 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.

InputAmountsArrayLengthMismatch​

error InputAmountsArrayLengthMismatch()

Thrown when the lengths of two input amount arrays do not match.

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).

NotAllowedInMultiPartitionMode​

error NotAllowedInMultiPartitionMode()

Thrown when a single-partition operation is attempted on a multi-partition token.

TokenIsNotControllable​

error TokenIsNotControllable()

Thrown when an operation requires the token to be controllable but it is not.

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.

ZeroValue​

error ZeroValue()

Thrown when a zero token amount is supplied to an operation that requires a positive value.