Identity
Asset Tokenization Studio Team
Identity
Abstract implementation of IIdentity, exposing identity-registry and onchainID accessors and their authorised setters.
Stateless wrapper that delegates the actual reads/writes to {ERC3643StorageWrapper}. Setters are gated by onlyUnpaused and onlyRole(ROLE_TREX_OWNER). Intended to be inherited by IdentityFacet.
Methods
identityRegistry
function identityRegistry() external view returns (contract IIdentityRegistry)
Returns the address of the identity registry contract.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | contract IIdentityRegistry | The current identity registry as IIdentityRegistry. |
initializeIdentity
function initializeIdentity(address _identityRegistry) external nonpayable
Initialises the identity capability on the token and wires the identity registry.
Wires the identity-registry address, marks the identity facet as ready, and emits IdentityInitialized. One-shot is enforced by onlyFacetNotRegistered.
Parameters
| Name | Type | Description |
|---|---|---|
| _identityRegistry | address | Address of the identity registry that vets token holders. |
onchainID
function onchainID() external view returns (address)
Returns the onchainID address associated with the token.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | The current onchainID address. |
setIdentityRegistry
function setIdentityRegistry(address _identityRegistry) external nonpayable
Sets the identity registry contract address.
Emits IdentityRegistryAdded so off-chain indexers can track which registry vetted holders at any historical block.
Parameters
| Name | Type | Description |
|---|---|---|
| _identityRegistry | address | The new identity registry contract address. |
setOnchainID
function setOnchainID(address _onchainID) external nonpayable
Sets the onchainID of the token to _onchainID.
Restricted to ROLE_TREX_OWNER and only callable when the token is not paused. Emits an UpdatedTokenInformation event from the underlying storage wrapper.
Parameters
| Name | Type | Description |
|---|---|---|
| _onchainID | address | The new onchainID address to associate with the token. |
Events
IdentityInitialized
event IdentityInitialized(address identityRegistry)
Emitted once when the identity capability is initialised on a token.
Fires exclusively from initializeIdentity.
Parameters
| Name | Type | Description |
|---|---|---|
| identityRegistry | address | The identity-registry address wired at initialisation. |
IdentityRegistryAdded
event IdentityRegistryAdded(address indexed identityRegistry)
Emitted when the identity registry contract address is updated.
Parameters
| Name | Type | Description |
|---|---|---|
identityRegistry indexed | address | Address of the newly wired identity registry. |
UpdatedTokenInformation
event UpdatedTokenInformation(string indexed newName, string indexed newSymbol, uint8 newDecimals, string newVersion, address indexed newOnchainID)
Emitted when core token metadata is updated.
Parameters
| Name | Type | Description |
|---|---|---|
newName indexed | string | New token name. |
newSymbol indexed | string | New token symbol. |
| newDecimals | uint8 | New decimal precision. |
| newVersion | string | New token version string. |
newOnchainID indexed | address | New onchainID address associated with the token. |
Errors
AccountHasNoRole
error AccountHasNoRole(address account, bytes32 role)
Thrown when an account does not hold a required role.
Parameters
| Name | Type | Description |
|---|---|---|
| account | address | The account that lacks the role. |
| role | bytes32 | The 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
| Name | Type | Description |
|---|---|---|
| configId | bytes32 | Resolver-proxy configuration whose operational status was checked. |
| versionId | uint256 | Configuration 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
| Name | Type | Description |
|---|---|---|
| facetId | bytes32 | Identifier of the offending facet. |
| lastVersion | uint256 | Last 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
| Name | Type | Description |
|---|---|---|
| _resolverProxyVersion | bytes8 | proxy version that is not compatible with the BLR. |
WalletRecovered
error WalletRecovered()
Thrown when attempting to recover a wallet that has already been recovered.