View Source: contracts/tokens/SecurityToken.sol​

↗ Extends: ERC20, ReentrancyGuard, SecurityTokenStorage, IERC1594, IERC1643, IERC1644, IERC1410, Proxy ↘ Derived Contracts: MockSecurityTokenLogic, SecurityTokenMock​

SecurityToken

SecurityToken is an ERC1400 token with added capabilities:

Events

event ModuleAdded(uint8[]  _types, bytes32 indexed _name, address indexed _moduleFactory, address  _module, uint256  _moduleCost, uint256  _budget, bytes32  _label, bool  _archived);
event ModuleUpgraded(uint8[]  _types, address  _module);
event UpdateTokenDetails(string  _oldDetails, string  _newDetails);
event UpdateTokenName(string  _oldName, string  _newName);
event GranularityChanged(uint256  _oldGranularity, uint256  _newGranularity);
event FreezeIssuance();
event FreezeTransfers(bool  _status);
event CheckpointCreated(uint256 indexed _checkpointId, uint256  _investorLength);
event SetController(address indexed _oldController, address indexed _newController);
event TreasuryWalletChanged(address  _oldTreasuryWallet, address  _newTreasuryWallet);
event DisableController();
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
event TokenUpgraded(uint8  _major, uint8  _minor, uint8  _patch);
event ModuleArchived(uint8[]  _types, address  _module);
event ModuleUnarchived(uint8[]  _types, address  _module);
event ModuleRemoved(uint8[]  _types, address  _module);
event ModuleBudgetChanged(uint8[]  _moduleTypes, address  _module, uint256  _oldBudget, uint256  _budget);

Modifiers

• ​checkGranularity​

checkGranularity

modifier checkGranularity(uint256 _value) internal

Arguments

Functions

• ​()​

• ​initialize(address _getterDelegate)​

• ​isModule(address _module, uint8 _type)​

• ​_onlyModuleOrOwner(uint8 _type)​

• ​_isValidPartition(bytes32 _partition)​

• ​_isValidOperator(address _from, address _operator, bytes32 _partition)​

• ​_zeroAddressCheck(address _entity)​

• ​_isValidTransfer(bool _isTransfer)​

• ​_isValidRedeem(bool _isRedeem)​

• ​_isSignedByOwner(bool _signed)​

• ​_isIssuanceAllowed()​

• ​_onlyController()​

• ​_isAuthorised(bool _authorised)​

• ​_onlyOwner()​

• ​_onlyModule(uint8 _type)​

• ​addModuleWithLabel(address _moduleFactory, bytes _data, uint256 _maxCost, uint256 _budget, bytes32 _label, bool _archived)​

• ​_addModuleData(uint8[] _moduleTypes, address _moduleFactory, address _module, uint256 _moduleCost, uint256 _budget, bytes32 _label, bool _archived)​

• ​addModule(address _moduleFactory, bytes _data, uint256 _maxCost, uint256 _budget, bool _archived)​

• ​archiveModule(address _module)​

• ​upgradeModule(address _module)​

• ​upgradeToken()​

• ​unarchiveModule(address _module)​

• ​removeModule(address _module)​

• ​withdrawERC20(address _tokenContract, uint256 _value)​

• ​changeModuleBudget(address _module, uint256 _change, bool _increase)​

• ​updateTokenDetails(string _newTokenDetails)​

• ​changeGranularity(uint256 _granularity)​

• ​changeDataStore(address _dataStore)​

• ​changeName(string _name)​

• ​changeTreasuryWallet(address _wallet)​

• ​_adjustInvestorCount(address _from, address _to, uint256 _value)​

• ​freezeTransfers()​

• ​unfreezeTransfers()​

• ​_adjustBalanceCheckpoints(address _investor)​

• ​transfer(address _to, uint256 _value)​

• ​transferWithData(address _to, uint256 _value, bytes _data)​

• ​_transferWithData(address _from, address _to, uint256 _value, bytes _data)​

• ​transferFrom(address _from, address _to, uint256 _value)​

• ​transferFromWithData(address _from, address _to, uint256 _value, bytes _data)​

• ​balanceOfByPartition(bytes32 _partition, address _tokenHolder)​

• ​_balanceOfByPartition(bytes32 _partition, address _tokenHolder, uint256 _additionalBalance)​

• ​transferByPartition(bytes32 _partition, address _to, uint256 _value, bytes _data)​

• ​_transferByPartition(address _from, address _to, uint256 _value, bytes32 _partition, bytes _data, address _operator, bytes _operatorData)​

• ​_returnPartition(uint256 _beforeBalance, uint256 _afterBalance, uint256 _value)​

• ​authorizeOperator(address _operator)​

• ​revokeOperator(address _operator)​

• ​authorizeOperatorByPartition(bytes32 _partition, address _operator)​

• ​revokeOperatorByPartition(bytes32 _partition, address _operator)​

• ​operatorTransferByPartition(bytes32 _partition, address _from, address _to, uint256 _value, bytes _data, bytes _operatorData)​

• ​_validateOperatorAndPartition(bytes32 _partition, address _from, address _operator)​

• ​_updateTransfer(address _from, address _to, uint256 _value, bytes _data)​

• ​_executeTransfer(address _from, address _to, uint256 _value, bytes _data)​

• ​freezeIssuance(bytes _signature)​

• ​issue(address _tokenHolder, uint256 _value, bytes _data)​

• ​_issue(address _tokenHolder, uint256 _value, bytes _data)​

• ​issueMulti(address[] _tokenHolders, uint256[] _values)​

• ​issueByPartition(bytes32 _partition, address _tokenHolder, uint256 _value, bytes _data)​

• ​redeem(uint256 _value, bytes _data)​

• ​_redeem(address _from, uint256 _value, bytes _data)​

• ​redeemByPartition(bytes32 _partition, uint256 _value, bytes _data)​

• ​_redeemByPartition(bytes32 _partition, address _from, uint256 _value, address _operator, bytes _data, bytes _operatorData)​

• ​operatorRedeemByPartition(bytes32 _partition, address _tokenHolder, uint256 _value, bytes _data, bytes _operatorData)​

• ​_checkAndBurn(address _from, uint256 _value, bytes _data)​

• ​redeemFrom(address _tokenHolder, uint256 _value, bytes _data)​

• ​createCheckpoint()​

• ​setController(address _controller)​

• ​disableController(bytes _signature)​

• ​canTransfer(address _to, uint256 _value, bytes _data)​

• ​canTransferFrom(address _from, address _to, uint256 _value, bytes _data)​

• ​_canTransfer(address _from, address _to, uint256 _value, bytes _data)​

• ​canTransferByPartition(address _from, address _to, bytes32 _partition, uint256 _value, bytes _data)​

• ​setDocument(bytes32 _name, string _uri, bytes32 _documentHash)​

• ​removeDocument(bytes32 _name)​

• ​isControllable()​

• ​controllerTransfer(address _from, address _to, uint256 _value, bytes _data, bytes _operatorData)​

• ​controllerRedeem(address _tokenHolder, uint256 _value, bytes _data, bytes _operatorData)​

• ​_implementation()​

• ​updateFromRegistry()​

• ​owner()​

• ​isOwner()​

• ​transferOwnership(address newOwner)​

• ​_transferOwnership(address newOwner)​

• ​_isSuccess(bytes1 status)​

function () public nonpayable

Arguments

initialize

⤿ Overridden Implementation(s): SecurityTokenMock.initialize​

Initialization function

function initialize(address _getterDelegate) public nonpayable

Arguments

isModule

Checks if an address is a module of certain type

function isModule(address _module, uint8 _type) public view
returns(bool)

Arguments

_onlyModuleOrOwner

function _onlyModuleOrOwner(uint8 _type) internal view

Arguments

_isValidPartition

function _isValidPartition(bytes32 _partition) internal pure

Arguments

_isValidOperator

function _isValidOperator(address _from, address _operator, bytes32 _partition) internal view

Arguments

_zeroAddressCheck

function _zeroAddressCheck(address _entity) internal pure

Arguments

_isValidTransfer

function _isValidTransfer(bool _isTransfer) internal pure

Arguments

_isValidRedeem

function _isValidRedeem(bool _isRedeem) internal pure

Arguments

_isSignedByOwner

function _isSignedByOwner(bool _signed) internal pure

Arguments

_isIssuanceAllowed

function _isIssuanceAllowed() internal view

Arguments

_onlyController

function _onlyController() internal view

Arguments

_isAuthorised

function _isAuthorised(bool _authorised) internal pure

Arguments

_onlyOwner

Throws if called by any account other than the owner.

function _onlyOwner() internal view

Arguments

_onlyModule

Require msg.sender to be the specified module type

function _onlyModule(uint8 _type) internal view

Arguments

addModuleWithLabel

⤿ Overridden Implementation(s): MockSecurityTokenLogic.addModuleWithLabel​

Attachs a module to the SecurityToken

function addModuleWithLabel(address _moduleFactory, bytes _data, uint256 _maxCost, uint256 _budget, bytes32 _label, bool _archived) public nonpayable nonReentrant

Arguments

_addModuleData

function _addModuleData(uint8[] _moduleTypes, address _moduleFactory, address _module, uint256 _moduleCost, uint256 _budget, bytes32 _label, bool _archived) internal nonpayable

Arguments

addModule

addModule function will call addModuleWithLabel() with an empty label for backward compatible

function addModule(address _moduleFactory, bytes _data, uint256 _maxCost, uint256 _budget, bool _archived) external nonpayable

Arguments

archiveModule

Archives a module attached to the SecurityToken

function archiveModule(address _module) external nonpayable

Arguments

upgradeModule

Upgrades a module attached to the SecurityToken

function upgradeModule(address _module) external nonpayable

Arguments

upgradeToken

Upgrades security token

function upgradeToken() external nonpayable

Arguments

unarchiveModule

Unarchives a module attached to the SecurityToken

function unarchiveModule(address _module) external nonpayable

Arguments

removeModule

Removes a module attached to the SecurityToken

function removeModule(address _module) external nonpayable

Arguments

withdrawERC20

Allows the owner to withdraw unspent POLY stored by them on the ST or any ERC20 token.

function withdrawERC20(address _tokenContract, uint256 _value) external nonpayable

Arguments

changeModuleBudget

allows owner to increase/decrease POLY approval of one of the modules

function changeModuleBudget(address _module, uint256 _change, bool _increase) external nonpayable

Arguments

updateTokenDetails

updates the tokenDetails associated with the token

function updateTokenDetails(string _newTokenDetails) external nonpayable

Arguments

changeGranularity

Allows owner to change token granularity

function changeGranularity(uint256 _granularity) external nonpayable

Arguments

changeDataStore

Allows owner to change data store

function changeDataStore(address _dataStore) external nonpayable

Arguments

changeName

Allows owner to change token name

function changeName(string _name) external nonpayable

Arguments

changeTreasuryWallet

Allows to change the treasury wallet address

function changeTreasuryWallet(address _wallet) external nonpayable

Arguments

_adjustInvestorCount

Keeps track of the number of non-zero token holders

function _adjustInvestorCount(address _from, address _to, uint256 _value) internal nonpayable

Arguments

freezeTransfers

freezes transfers

function freezeTransfers() external nonpayable

Arguments

unfreezeTransfers

Unfreeze transfers

function unfreezeTransfers() external nonpayable

Arguments

_adjustBalanceCheckpoints

Internal - adjusts token holder balance at checkpoint before a token transfer

function _adjustBalanceCheckpoints(address _investor) internal nonpayable

Arguments

transfer

⤾ overrides ERC20.transfer​

Overloaded version of the transfer function

function transfer(address _to, uint256 _value) public nonpayable
returns(success bool)

Returns

bool success

Arguments

transferWithData

⤾ overrides IERC1594.transferWithData​

Transfer restrictions can take many forms and typically involve on-chain rules or whitelists. However for many types of approved transfers, maintaining an on-chain list of approved transfers can be cumbersome and expensive. An alternative is the co-signing approach, where in addition to the token holder approving a token transfer, and authorised entity provides signed data which further validates the transfer.

function transferWithData(address _to, uint256 _value, bytes _data) public nonpayable

Arguments

for the token contract to interpret or record. This could be signed data authorising the transfer (e.g. a dynamic whitelist) but is flexible enough to accomadate other use-cases. |

_transferWithData

function _transferWithData(address _from, address _to, uint256 _value, bytes _data) internal nonpayable

Arguments

transferFrom

⤾ overrides ERC20.transferFrom​

Overloaded version of the transferFrom function

function transferFrom(address _from, address _to, uint256 _value) public nonpayable
returns(bool)

Returns

bool success

Arguments

transferFromWithData

⤾ overrides IERC1594.transferFromWithData​

Transfer restrictions can take many forms and typically involve on-chain rules or whitelists. However for many types of approved transfers, maintaining an on-chain list of approved transfers can be cumbersome and expensive. An alternative is the co-signing approach, where in addition to the token holder approving a token transfer, and authorised entity provides signed data which further validates the transfer.

function transferFromWithData(address _from, address _to, uint256 _value, bytes _data) public nonpayable

Arguments

for the token contract to interpret or record. This could be signed data authorising the transfer (e.g. a dynamic whitelist) but is flexible enough to accomadate other use-cases. |

balanceOfByPartition

⤾ overrides IERC1410.balanceOfByPartition​

Get the balance according to the provided partitions

function balanceOfByPartition(bytes32 _partition, address _tokenHolder) public view
returns(uint256)

Returns

Amount of tokens as per the given partitions

Arguments

_balanceOfByPartition

function _balanceOfByPartition(bytes32 _partition, address _tokenHolder, uint256 _additionalBalance) internal view
returns(partitionBalance uint256)

Arguments

transferByPartition

⤾ overrides IERC1410.transferByPartition​

Transfers the ownership of tokens from a specified partition from one address to another address

function transferByPartition(bytes32 _partition, address _to, uint256 _value, bytes _data) public nonpayable
returns(bytes32)

Returns

The partition to which the transferred tokens were allocated for the _to address

Arguments

_transferByPartition

function _transferByPartition(address _from, address _to, uint256 _value, bytes32 _partition, bytes _data, address _operator, bytes _operatorData) internal nonpayable
returns(toPartition bytes32)

Arguments

_returnPartition

function _returnPartition(uint256 _beforeBalance, uint256 _afterBalance, uint256 _value) internal pure
returns(toPartition bytes32)

Arguments

authorizeOperator

⤾ overrides IERC1410.authorizeOperator​

Authorises an operator for all partitions of msg.sender. NB - Allowing investors to authorize an investor to be an operator of all partitions but it doesn't mean we operator is allowed to transfer the LOCKED partition values. Logic for this restriction is written in operatorTransferByPartition() function.

function authorizeOperator(address _operator) public nonpayable

Arguments

revokeOperator

⤾ overrides IERC1410.revokeOperator​

Revokes authorisation of an operator previously given for all partitions of msg.sender. NB - Allowing investors to authorize an investor to be an operator of all partitions but it doesn't mean we operator is allowed to transfer the LOCKED partition values. Logic for this restriction is written in operatorTransferByPartition() function.

function revokeOperator(address _operator) public nonpayable

Arguments

authorizeOperatorByPartition

⤾ overrides IERC1410.authorizeOperatorByPartition​

Authorises an operator for a given partition of msg.sender

function authorizeOperatorByPartition(bytes32 _partition, address _operator) public nonpayable

Arguments

revokeOperatorByPartition

⤾ overrides IERC1410.revokeOperatorByPartition​

Revokes authorisation of an operator previously given for a specified partition of msg.sender

function revokeOperatorByPartition(bytes32 _partition, address _operator) public nonpayable

Arguments

operatorTransferByPartition

⤾ overrides IERC1410.operatorTransferByPartition​

Transfers the ownership of tokens from a specified partition from one address to another address

function operatorTransferByPartition(bytes32 _partition, address _from, address _to, uint256 _value, bytes _data, bytes _operatorData) external nonpayable
returns(bytes32)

Returns