Interface that every module factory contract should implement (IModuleFactory.sol)

View Source: contracts/interfaces/IModuleFactory.sol

↘ Derived Contracts: ModuleFactory

IModuleFactory

Events

event ChangeSetupCost(uint256  _oldSetupCost, uint256  _newSetupCost);
event ChangeCostType(bool  _isOldCostInPoly, bool  _isNewCostInPoly);
event GenerateModuleFromFactory(address  _module, bytes32 indexed _moduleName, address indexed _moduleFactory, address  _creator, uint256  _setupCost, uint256  _setupCostInPoly);
event ChangeSTVersionBound(string  _boundType, uint8  _major, uint8  _minor, uint8  _patch);

Functions

• deploy(bytes _data)

• version()

• name()

• title()

• description()

• setupCost()

• getTypes()

• getTags()

• changeSetupCost(uint256 _newSetupCost)

• changeCostAndType(uint256 _setupCost, bool _isCostInPoly)

• changeSTVersionBounds(string _boundType, uint8[] _newVersion)

• setupCostInPoly()

• getLowerSTVersionBounds()

• getUpperSTVersionBounds()

• changeTags(bytes32[] _tagsData)

• changeName(bytes32 _name)

• changeDescription(string _description)

• changeTitle(string _title)

deploy

⤿ Overridden Implementation(s): BlacklistTransferManagerFactory.deploy,CappedSTOFactory.deploy,CountTransferManagerFactory.deploy,DummySTOFactory.deploy,ERC20DividendCheckpointFactory.deploy,EtherDividendCheckpointFactory.deploy,GeneralPermissionManagerFactory.deploy,GeneralTransferManagerFactory.deploy,KYCTransferManagerFactory.deploy,LockUpTransferManagerFactory.deploy,ManualApprovalTransferManagerFactory.deploy,MockBurnFactory.deploy,PercentageTransferManagerFactory.deploy,PLCRVotingCheckpointFactory.deploy,PreSaleSTOFactory.deploy,ScheduledCheckpointFactory.deploy,SignedTransferManagerFactory.deploy,TrackedRedemptionFactory.deploy,USDTieredSTOFactory.deploy,VestingEscrowWalletFactory.deploy,VolumeRestrictionTMFactory.deploy,WeightedVoteCheckpointFactory.deploy

function deploy(bytes _data) external nonpayable
returns(moduleAddress address)

Arguments

Name	Type	Description
_data	bytes

version

⤿ Overridden Implementation(s): ModuleFactory.version,UpgradableModuleFactory.version

Get the tags related to the module factory

function version() external view
returns(moduleVersion string)

Arguments

Name	Type	Description

name

Get the tags related to the module factory

function name() external view
returns(moduleName bytes32)

Arguments

Name	Type	Description

title

Returns the title associated with the module

function title() external view
returns(moduleTitle string)

Arguments

Name	Type	Description

description

Returns the description associated with the module

function description() external view
returns(moduleDescription string)

Arguments

Name	Type	Description

setupCost

Get the setup cost of the module in USD

function setupCost() external nonpayable
returns(usdSetupCost uint256)

Arguments

Name	Type	Description

getTypes

⤿ Overridden Implementation(s): MockFactory.getTypes,MockWrongTypeFactory.getTypes,ModuleFactory.getTypes

Type of the Module factory

function getTypes() external view
returns(moduleTypes uint8[])

Arguments

Name	Type	Description

getTags

⤿ Overridden Implementation(s): ModuleFactory.getTags,TestSTOFactory.getTags

Get the tags related to the module factory

function getTags() external view
returns(moduleTags bytes32[])

Arguments

Name	Type	Description

changeSetupCost

⤿ Overridden Implementation(s): ModuleFactory.changeSetupCost

Used to change the setup fee

function changeSetupCost(uint256 _newSetupCost) external nonpayable

Arguments

Name	Type	Description
_newSetupCost	uint256	New setup fee

changeCostAndType

⤿ Overridden Implementation(s): ModuleFactory.changeCostAndType

Used to change the currency and amount setup cost

function changeCostAndType(uint256 _setupCost, bool _isCostInPoly) external nonpayable

Arguments

Name	Type	Description
_setupCost	uint256	new setup cost
_isCostInPoly	bool	new setup cost currency. USD or POLY

changeSTVersionBounds

⤿ Overridden Implementation(s): ModuleFactory.changeSTVersionBounds

Function use to change the lower and upper bound of the compatible version st

function changeSTVersionBounds(string _boundType, uint8[] _newVersion) external nonpayable

Arguments

Name	Type	Description
_boundType	string	Type of bound
_newVersion	uint8[]	New version array

setupCostInPoly

⤿ Overridden Implementation(s): ModuleFactory.setupCostInPoly

Get the setup cost of the module

function setupCostInPoly() external nonpayable
returns(polySetupCost uint256)

Arguments

Name	Type	Description

getLowerSTVersionBounds

⤿ Overridden Implementation(s): ModuleFactory.getLowerSTVersionBounds

Used to get the lower bound

function getLowerSTVersionBounds() external view
returns(lowerBounds uint8[])

Returns

Lower bound

Arguments

Name	Type	Description

getUpperSTVersionBounds

⤿ Overridden Implementation(s): ModuleFactory.getUpperSTVersionBounds

Used to get the upper bound

function getUpperSTVersionBounds() external view
returns(upperBounds uint8[])

Returns

Upper bound

Arguments

Name	Type	Description

changeTags

⤿ Overridden Implementation(s): ModuleFactory.changeTags

Updates the tags of the ModuleFactory

function changeTags(bytes32[] _tagsData) external nonpayable

Arguments

Name	Type	Description
_tagsData	bytes32[]	New list of tags

changeName

⤿ Overridden Implementation(s): ModuleFactory.changeName

Updates the name of the ModuleFactory

function changeName(bytes32 _name) external nonpayable

Arguments

Name	Type	Description
_name	bytes32	New name that will replace the old one.

changeDescription

⤿ Overridden Implementation(s): ModuleFactory.changeDescription

Updates the description of the ModuleFactory

function changeDescription(string _description) external nonpayable

Arguments

Name	Type	Description
_description	string	New description that will replace the old one.

changeTitle

⤿ Overridden Implementation(s): ModuleFactory.changeTitle

Updates the title of the ModuleFactory

function changeTitle(string _title) external nonpayable

Arguments

Name	Type	Description
_title	string	New Title that will replace the old one.