Skip to main content

ICore

Asset Tokenization Studio Team

ICore

Consolidated interface for the token "Core" domain: identity-defining methods (ERC20 metadata readers, ERC3643 name/symbol setters, and version). Also owns the ERC20Metadata struct, since the only initializer for this data (initializeCore) lives in CoreFacet.

Methods​

decimals​

function decimals() external view returns (uint8)

Returns the decimals simulating non-triggered decimal adjustments up until current timestamp.

Returns​

NameTypeDescription
_0uint8The number of decimals used for token amounts.

getERC20Metadata​

function getERC20Metadata() external view returns (struct ICore.ERC20Metadata)

Returns the full metadata struct of the security token.

Returns​

NameTypeDescription
_0ICore.ERC20MetadataThe persisted ERC20Metadata.

initializeCore​

function initializeCore(ICore.ERC20Metadata _metadata) external nonpayable

Parameters​

NameTypeDescription
_metadataICore.ERC20Metadataundefined

name​

function name() external view returns (string)

Returns the name of the security token.

Returns​

NameTypeDescription
_0stringThe token name string.

setName​

function setName(string _name) external nonpayable

Updates the token name. Restricted to the TREX owner role.

Parameters​

NameTypeDescription
_namestringNew name to assign to the token.

setSymbol​

function setSymbol(string _symbol) external nonpayable

Updates the token symbol. Restricted to the TREX owner role.

Parameters​

NameTypeDescription
_symbolstringNew symbol to assign to the token.

symbol​

function symbol() external view returns (string)

Returns the symbol of the security token.

Returns​

NameTypeDescription
_0stringThe token symbol string.

version​

function version() external view returns (string)

Returns the ERC3643 version string of the token.

Returns​

NameTypeDescription
_0stringThe version string (e.g. "4.0.0").

Events​

CoreInitialized​

event CoreInitialized(ICore.ERC20Metadata metadata)

Emitted once when the core ERC-20 metadata is initialised on a token.

Fires exclusively from initializeCore after the storage write succeeds.

Parameters​

NameTypeDescription
metadataICore.ERC20MetadataThe ERC-20 metadata persisted at initialisation.