Interface for security token proxy deployment (ISTFactory.sol)

View Source: contracts/interfaces/ISTFactory.solโ€‹

โ†˜ Derived Contracts: STFactoryโ€‹

ISTFactory

Events

event LogicContractSet(string _version, address _logicContract, bytes _upgradeData);
event TokenUpgraded(address indexed _securityToken, uint256 indexed _version);
event DefaultTransferManagerUpdated(address indexed _oldTransferManagerFactory, address indexed _newTransferManagerFactory);
event DefaultDataStoreUpdated(address indexed _oldDataStoreFactory, address indexed _newDataStoreFactory);

Functions

deployToken

โคฟ Overridden Implementation(s): STFactory.deployTokenโ€‹

Deploys the token and adds default modules like permission manager and transfer manager. Future versions of the proxy can attach different modules or pass some other paramters.

function deployToken(string _name, string _symbol, uint8 _decimals, string _tokenDetails, address _issuer, bool _divisible, address _treasuryWallet) external nonpayable
returns(tokenAddress address)

Arguments

Name

Type

Description

_name

string

is the name of the Security token

_symbol

string

is the symbol of the Security Token

_decimals

uint8

is the number of decimals of the Security Token

_tokenDetails

string

is the off-chain data associated with the Security Token

_issuer

address

is the owner of the Security Token

_divisible

bool

whether the token is divisible or not

_treasuryWallet

address

Ethereum address which will holds the STs.

setLogicContract

โคฟ Overridden Implementation(s): STFactory.setLogicContractโ€‹

Used to set a new token logic contract

function setLogicContract(string _version, address _logicContract, bytes _initializationData, bytes _upgradeData) external nonpayable

Arguments

Name

Type

Description

_version

string

Version of upgraded module

_logicContract

address

Address of deployed module logic contract referenced from proxy

_initializationData

bytes

Initialization data that used to intialize value in the securityToken

_upgradeData

bytes

Data to be passed in call to upgradeToAndCall when a token upgrades its module

upgradeToken

โคฟ Overridden Implementation(s): STFactory.upgradeTokenโ€‹

Used to upgrade a token

function upgradeToken(uint8 _maxModuleType) external nonpayable

Arguments

Name

Type

Description

_maxModuleType

uint8

maximum module type enumeration

updateDefaultTransferManager

โคฟ Overridden Implementation(s): STFactory.updateDefaultTransferManagerโ€‹

Used to set a new default transfer manager

function updateDefaultTransferManager(address _transferManagerFactory) external nonpayable

Arguments

Name

Type

Description

_transferManagerFactory

address

Address of new default transfer manager factory

updateDefaultDataStore

โคฟ Overridden Implementation(s): STFactory.updateDefaultDataStoreโ€‹

Used to set a new default data store

function updateDefaultDataStore(address _dataStoreFactory) external nonpayable

Arguments

Name

Type

Description

_dataStoreFactory

address

Address of new default data store factory