Interface that any module contract should implement (Module.sol)

View Source: contracts/modules/Module.sol

↗ Extends: IModule, ModuleStorage, Pausable ↘ Derived Contracts: DividendCheckpoint, GeneralPermissionManager, STO, TrackedRedemption, TransferManager, VotingCheckpoint, Wallet

Module

Contract is abstract

Modifiers

• withPerm

• onlyFactory

withPerm

modifier withPerm(bytes32 _perm) internal

Arguments

Name	Type	Description
_perm	bytes32

onlyFactory

modifier onlyFactory() internal

Arguments

Name	Type	Description

Functions

• (address _securityToken, address _polyAddress)

• _checkPerm(bytes32 _perm, address _caller)

• _onlySecurityTokenOwner()

• pause()

• unpause()

• getDataStore()

• reclaimERC20(address _tokenContract)

• reclaimETH()

Constructor

function (address _securityToken, address _polyAddress) public nonpayable ModuleStorage

Arguments

Name	Type	Description
_securityToken	address	Address of the security token
_polyAddress	address

_checkPerm

function _checkPerm(bytes32 _perm, address _caller) internal view
returns(bool)

Arguments

Name	Type	Description
_perm	bytes32
_caller	address

_onlySecurityTokenOwner

function _onlySecurityTokenOwner() internal view

Arguments

Name	Type	Description

pause

⤾ overrides ISTO.pause

⤿ Overridden Implementation(s): STO.pause

Pause (overridden function)

function pause() public nonpayable

Arguments

Name	Type	Description

unpause

Unpause (overridden function)

function unpause() public nonpayable

Arguments

Name	Type	Description

getDataStore

used to return the data store address of securityToken

function getDataStore() public view
returns(contract IDataStore)

Arguments

Name	Type	Description

reclaimERC20

Reclaims ERC20Basic compatible tokens

function reclaimERC20(address _tokenContract) external nonpayable

Arguments

Name	Type	Description
_tokenContract	address	The address of the token contract

reclaimETH

Reclaims ETH

function reclaimETH() external nonpayable

Arguments

Name	Type	Description