Transfer Manager module to automate blacklist and restrict transfers (BlacklistTransferManager.sol)

View Source: contracts/modules/TransferManager/BTM/BlacklistTransferManager.sol

↗ Extends: BlacklistTransferManagerStorage, TransferManager

BlacklistTransferManager

Events

event AddBlacklistType(uint256  _startTime, uint256  _endTime, bytes32  _blacklistName, uint256  _repeatPeriodTime);
event ModifyBlacklistType(uint256  _startTime, uint256  _endTime, bytes32  _blacklistName, uint256  _repeatPeriodTime);
event DeleteBlacklistType(bytes32  _blacklistName);
event AddInvestorToBlacklist(address indexed _investor, bytes32  _blacklistName);
event DeleteInvestorFromBlacklist(address indexed _investor, bytes32  _blacklistName);

Functions

• (address _securityToken, address _polyAddress)

• getInitFunction()

• executeTransfer(address _from, address , uint256 , bytes )

• verifyTransfer(address _from, address , uint256 , bytes )

• _verifyTransfer(address _from)

• addBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime)

• _addBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime)

• _addBlacklistTypeDetails(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime)

• addBlacklistTypeMulti(uint256[] _startTimes, uint256[] _endTimes, bytes32[] _blacklistNames, uint256[] _repeatPeriodTimes)

• modifyBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime)

• _modifyBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime)

• modifyBlacklistTypeMulti(uint256[] _startTimes, uint256[] _endTimes, bytes32[] _blacklistNames, uint256[] _repeatPeriodTimes)

• deleteBlacklistType(bytes32 _blacklistName)

• _deleteBlacklistType(bytes32 _blacklistName)

• deleteBlacklistTypeMulti(bytes32[] _blacklistNames)

• addInvestorToBlacklist(address _investor, bytes32 _blacklistName)

• _addInvestorToBlacklist(address _investor, bytes32 _blacklistName)

• addInvestorToBlacklistMulti(address[] _investors, bytes32 _blacklistName)

• addMultiInvestorToBlacklistMulti(address[] _investors, bytes32[] _blacklistNames)

• addInvestorToNewBlacklist(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime, address _investor)

• deleteInvestorFromBlacklist(address _investor, bytes32 _blacklistName)

• _deleteInvestorFromBlacklist(address _investor, bytes32 _blacklistName)

• deleteInvestorFromAllBlacklist(address _investor)

• _deleteInvestorFromAllBlacklist(address _investor)

• deleteInvestorFromAllBlacklistMulti(address[] _investor)

• deleteMultiInvestorsFromBlacklistMulti(address[] _investors, bytes32[] _blacklistNames)

• _validParams(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime)

• getListOfAddresses(bytes32 _blacklistName)

• getBlacklistNamesToUser(address _user)

• getAllBlacklists()

• getTokensByPartition(bytes32 _partition, address _tokenHolder, uint256 _additionalBalance)

• getPermissions()

Constructor

function (address _securityToken, address _polyAddress) public nonpayable Module

Arguments

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

getInitFunction

⤾ overrides IModule.getInitFunction

This function returns the signature of configure function

function getInitFunction() public pure
returns(bytes4)

Arguments

Name

Type

Description

executeTransfer

⤾ overrides ITransferManager.executeTransfer

Used to verify the transfer transaction

function executeTransfer(address _from, address , uint256 , bytes ) external nonpayable
returns(enum ITransferManager.Result)

Arguments

Name	Type	Description
_from	address	Address of the sender
	address	_from Address of the sender
	uint256	_from Address of the sender
	bytes	_from Address of the sender

verifyTransfer

⤾ overrides ITransferManager.verifyTransfer

Used to verify the transfer transaction (View)

function verifyTransfer(address _from, address , uint256 , bytes ) public view
returns(enum ITransferManager.Result, bytes32)

Arguments

Name	Type	Description
_from	address	Address of the sender
	address	_from Address of the sender
	uint256	_from Address of the sender
	bytes	_from Address of the sender

_verifyTransfer

function _verifyTransfer(address _from) internal view
returns(enum ITransferManager.Result, bytes32)

Arguments

Name	Type	Description
_from	address

addBlacklistType

Used to add the blacklist type

function addBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime) public nonpayable withPerm

Arguments

Name	Type	Description
_startTime	uint256	Start date of the blacklist type
_endTime	uint256	End date of the blacklist type
_blacklistName	bytes32	Name of the blacklist type
_repeatPeriodTime	uint256	Repeat period of the blacklist type in days

_addBlacklistType

function _addBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime) internal nonpayable

Arguments

Name	Type	Description
_startTime	uint256
_endTime	uint256
_blacklistName	bytes32
_repeatPeriodTime	uint256

_addBlacklistTypeDetails

function _addBlacklistTypeDetails(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime) internal nonpayable

Arguments

Name	Type	Description
_startTime	uint256
_endTime	uint256
_blacklistName	bytes32
_repeatPeriodTime	uint256

addBlacklistTypeMulti

Used to add the multiple blacklist type

function addBlacklistTypeMulti(uint256[] _startTimes, uint256[] _endTimes, bytes32[] _blacklistNames, uint256[] _repeatPeriodTimes) public nonpayable withPerm

Arguments

Name	Type	Description
_startTimes	uint256[]	Start date of the blacklist type
_endTimes	uint256[]	End date of the blacklist type
_blacklistNames	bytes32[]	Name of the blacklist type
_repeatPeriodTimes	uint256[]	Repeat period of the blacklist type

modifyBlacklistType

Used to modify the details of a given blacklist type

function modifyBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime) public nonpayable withPerm

Arguments

Name	Type	Description
_startTime	uint256	Start date of the blacklist type
_endTime	uint256	End date of the blacklist type
_blacklistName	bytes32	Name of the blacklist type
_repeatPeriodTime	uint256	Repeat period of the blacklist type

_modifyBlacklistType

function _modifyBlacklistType(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime) internal nonpayable

Arguments

Name	Type	Description
_startTime	uint256
_endTime	uint256
_blacklistName	bytes32
_repeatPeriodTime	uint256

modifyBlacklistTypeMulti

Used to modify the details of a given multpile blacklist types

function modifyBlacklistTypeMulti(uint256[] _startTimes, uint256[] _endTimes, bytes32[] _blacklistNames, uint256[] _repeatPeriodTimes) public nonpayable withPerm

Arguments

Name	Type	Description
_startTimes	uint256[]	Start date of the blacklist type
_endTimes	uint256[]	End date of the blacklist type
_blacklistNames	bytes32[]	Name of the blacklist type
_repeatPeriodTimes	uint256[]	Repeat period of the blacklist type

deleteBlacklistType

Used to delete the blacklist type

function deleteBlacklistType(bytes32 _blacklistName) public nonpayable withPerm

Arguments

Name	Type	Description
_blacklistName	bytes32	Name of the blacklist type

_deleteBlacklistType

function _deleteBlacklistType(bytes32 _blacklistName) internal nonpayable

Arguments

Name	Type	Description
_blacklistName	bytes32

deleteBlacklistTypeMulti

Used to delete the multiple blacklist type

function deleteBlacklistTypeMulti(bytes32[] _blacklistNames) public nonpayable withPerm

Arguments

Name	Type	Description
_blacklistNames	bytes32[]	Name of the blacklist type

addInvestorToBlacklist

Used to assign the blacklist type to the investor

function addInvestorToBlacklist(address _investor, bytes32 _blacklistName) public nonpayable withPerm

Arguments

Name	Type	Description
_investor	address	Address of the investor
_blacklistName	bytes32	Name of the blacklist

_addInvestorToBlacklist

function _addInvestorToBlacklist(address _investor, bytes32 _blacklistName) internal nonpayable

Arguments

Name	Type	Description
_investor	address
_blacklistName	bytes32

addInvestorToBlacklistMulti

Used to assign the blacklist type to the multiple investor

function addInvestorToBlacklistMulti(address[] _investors, bytes32 _blacklistName) public nonpayable withPerm

Arguments

Name	Type	Description
_investors	address[]	Address of the investor
_blacklistName	bytes32	Name of the blacklist

addMultiInvestorToBlacklistMulti

Used to assign the multiple blacklist type to the multiple investor

function addMultiInvestorToBlacklistMulti(address[] _investors, bytes32[] _blacklistNames) public nonpayable withPerm

Arguments

Name	Type	Description
_investors	address[]	Address of the investor
_blacklistNames	bytes32[]	Name of the blacklist

addInvestorToNewBlacklist

Used to assign the new blacklist type to the investor

function addInvestorToNewBlacklist(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime, address _investor) public nonpayable withPerm

Arguments

Name	Type	Description
_startTime	uint256	Start date of the blacklist type
_endTime	uint256	End date of the blacklist type
_blacklistName	bytes32	Name of the blacklist type
_repeatPeriodTime	uint256	Repeat period of the blacklist type
_investor	address	Address of the investor

deleteInvestorFromBlacklist

Used to delete the investor from the blacklist

function deleteInvestorFromBlacklist(address _investor, bytes32 _blacklistName) public nonpayable withPerm

Arguments

Name	Type	Description
_investor	address	Address of the investor
_blacklistName	bytes32	Name of the blacklist

_deleteInvestorFromBlacklist

Used to delete the investor from the blacklist

function _deleteInvestorFromBlacklist(address _investor, bytes32 _blacklistName) internal nonpayable

Arguments

Name	Type	Description
_investor	address	Address of the investor
_blacklistName	bytes32	Name of the blacklist

deleteInvestorFromAllBlacklist

Used to delete the investor from all the associated blacklist types

function deleteInvestorFromAllBlacklist(address _investor) public nonpayable withPerm

Arguments

Name	Type	Description
_investor	address	Address of the investor

_deleteInvestorFromAllBlacklist

Used to delete the investor from all the associated blacklist types

function _deleteInvestorFromAllBlacklist(address _investor) internal nonpayable

Arguments

Name	Type	Description
_investor	address	Address of the investor

deleteInvestorFromAllBlacklistMulti

Used to delete the multiple investor from all the associated blacklist types

function deleteInvestorFromAllBlacklistMulti(address[] _investor) public nonpayable withPerm

Arguments

Name	Type	Description
_investor	address[]	Address of the investor

deleteMultiInvestorsFromBlacklistMulti

Used to delete the multiple investor from the blacklist

function deleteMultiInvestorsFromBlacklistMulti(address[] _investors, bytes32[] _blacklistNames) public nonpayable withPerm

Arguments

Name	Type	Description
_investors	address[]	address of the investor
_blacklistNames	bytes32[]	name of the blacklist

_validParams

Internal function

function _validParams(uint256 _startTime, uint256 _endTime, bytes32 _blacklistName, uint256 _repeatPeriodTime) internal view

Arguments

Name	Type	Description
_startTime	uint256
_endTime	uint256
_blacklistName	bytes32
_repeatPeriodTime	uint256

getListOfAddresses

get the list of the investors of a blacklist type

function getListOfAddresses(bytes32 _blacklistName) external view
returns(address[])

Returns

address List of investors associated with the blacklist

Arguments

Name	Type	Description
_blacklistName	bytes32	Name of the blacklist type

getBlacklistNamesToUser

get the list of the investors of a blacklist type

function getBlacklistNamesToUser(address _user) external view
returns(bytes32[])

Returns

bytes32 List of blacklist names associated with the given address

Arguments

Name	Type	Description
_user	address	Address of the user

getAllBlacklists

get the list of blacklist names

function getAllBlacklists() external view
returns(bytes32[])

Returns

bytes32 Array of blacklist names

Arguments

Name

Type

Description

getTokensByPartition

⤾ overrides TransferManager.getTokensByPartition

return the amount of tokens for a given user as per the partition

function getTokensByPartition(bytes32 _partition, address _tokenHolder, uint256 _additionalBalance) external view
returns(uint256)

Arguments

Name	Type	Description
_partition	bytes32	Identifier
_tokenHolder	address	Whom token amount need to query
_additionalBalance	uint256	It is the _value that transfer during transfer/transferFrom function call

getPermissions

⤾ overrides IModule.getPermissions

Return the permissions flag that are associated with blacklist transfer manager

function getPermissions() public view
returns(bytes32[])

Arguments

Name

Type

Description