🐂
Polymath
🐂
Polymath
🐂
Polymath
🐂
Polymath
README
api
Proxy (Proxy.sol)
Base abstract contract to be extended by all STO modules (STO.sol)
OwnedUpgradeabilityProxy (OwnedUpgradeabilityProxy.sol)
Transfer Manager module for core transfer validation functionality (GeneralTransferManager.sol)
VotingCheckpointStorage.sol
PLCRVotingCheckpoint.sol
Factory for deploying VestingEscrowWallet module (VestingEscrowWalletFactory.sol)
Helper library use to compare or validate the semantic versions (VersionUtils.sol)
Interface to be implemented by all Wallet modules (Wallet.sol)
Factory for deploying CappedSTO module (CappedSTOFactory.sol)
Checkpoint module for issuing ERC20 dividends (ERC20DividendCheckpoint.sol)
Interface to be implemented by all Transfer Manager modules (ITransferManager.sol)
StableOracle.sol
VolumeRestrictionTM.sol
SecurityTokenRegistryProxy (SecurityTokenRegistryProxy.sol)
PreSaleSTO module Proxy (PreSaleSTOProxy.sol)
DataStoreProxy Proxy (DataStoreProxy.sol)
Proxy for deploying SecurityToken instances (STFactory.sol)
Ownable (IOwnable.sol)
Checkpoint module for issuing ether dividends (DividendCheckpoint.sol)
CountTransferManager module Proxy (BlacklistTransferManagerProxy.sol)
Security Token contract (mock) (MockSTGetter.sol)
Permission Manager module for core permissioning functionality (GeneralPermissionManager.sol)
Contract used to store layout for the CountTransferManager storage (CountTransferManagerStorage.sol)
DummySTO module Proxy (DummySTOProxy.sol)
Transfer Manager module for limiting percentage of token supply a single address can hold (Percentag
Helps contracts guard against reentrancy attacks. (ReentrancyGuard.sol)
Factory for deploying EtherDividendCheckpoint module (ScheduledCheckpointFactory.sol)
Interface that every module factory contract should implement (IModuleFactory.sol)
Factory for deploying GeneralTransferManager module (TrackedRedemptionFactory.sol)
SafeMath (SafeMath.sol)
USDTiered STO module Proxy (SecurityTokenProxy.sol)
USDTiered STO module Proxy (USDTieredSTOProxy.sol)
IOracle.sol
ManualApprovalTransferManager module Proxy (ManualApprovalTransferManagerProxy.sol)
Interface to be implemented by all permission manager modules (IPermissionManager.sol)
Factory for deploying PreSaleSTO module (PreSaleSTOFactory.sol)
MockPolyOracle.sol
Transfer Manager module for verifing transations with a signed message (SignedTransferManager.sol)
DataStoreFactory.sol
OraclizeAddrResolverI.sol
PolyTokenFaucet.sol
Registry contract for issuers to register their security tokens (MockModuleRegistry.sol)
VolumeRestrictionLib.sol
Contract used to store layout for the PercentageTransferManager storage (PercentageTransferManagerSt
Transfer Manager for limiting maximum number of token holders (CountTransferManager.sol)
ModuleRegistryProxy (ModuleRegistryProxy.sol)
Voting module for governance (WeightedVoteCheckpointProxy.sol)
Factory for deploying BlacklistTransferManager module (BlacklistTransferManagerFactory.sol)
Contract used to store layout for the GeneralPermissionManager storage (GeneralPermissionManagerStor
CountTransferManager module Proxy (LockUpTransferManagerProxy.sol)
Holds the storage variable for the DividendCheckpoint modules (i.e ERC20, Ether) (DividendCheckpoint
Factory for deploying DummySTO module (DummySTOFactory.sol)
IERC1644.sol
Core functionality for registry upgradability (PolymathRegistry.sol)
Utility contract to allow owner to retreive any ERC20 sent to the contract (ReclaimTokens.sol)
SecurityTokenMock.sol
Factory for deploying CappedSTO module (USDTieredSTOFactory.sol)
Factory for deploying ManualApprovalTransferManager module (ManualApprovalTransferManagerFactory.sol
IERC1643.sol
Transfer Manager module for core transfer validation functionality (EtherDividendCheckpointProxy.sol
solcChecker.sol
It holds the storage variables related to ERC20DividendCheckpoint module (ERC20DividendCheckpointSto
Interface for all security tokens (ISecurityToken.sol)
Base abstract contract to be implemented by all Transfer Manager modules (TransferManager.sol)
Storage layout for VolumeRestrictionTM (VolumeRestrictionTMStorage.sol)
Security Token contract (mock) (MockSecurityTokenLogic.sol)
Transfer Manager module for core transfer validation functionality (GeneralTransferManagerStorage.so
IERC1410.sol
VotingCheckpoint.sol
Factory for deploying WeightedVoteCheckpoint module (WeightedVoteCheckpointFactory.sol)
PLCRVotingCheckpointStorage.sol
IDataStore.sol
TestSTOFactory.sol
Ownable (Ownable.sol)
UpgradeabilityProxy (UpgradeabilityProxy.sol)
Mock Contract Not fit for production environment (MockFactory.sol)
Registry contract for issuers to register their security tokens (SecurityTokenRegistryMock.sol)
ICheckPermission.sol
Factory for deploying LockUpTransferManager module (LockUpTransferManagerFactory.sol)
Storage layout for the STO contract (STOStorage.sol)
Interface for the Polymath Security Token Registry contract (ISecurityTokenRegistry.sol)
Mock Contract Not fit for production environment (MockWrongTypeFactory.sol)
Transfer Manager module for core transfer validation functionality (KYCTransferManager.sol)
Factory for deploying EtherDividendCheckpoint module (EtherDividendCheckpointFactory.sol)
functionSigClash2.sol
Standard Interface of ERC1594 (IERC1594.sol)
TokenLib.sol
MakerDAOOracle.sol
Interface that any module contract should implement (Module.sol)
Interface that any module factory contract should implement (ModuleFactory.sol)
STGetter.sol
Interface to be implemented by upgradable token factories (IUpgradableTokenFactory.sol)
ERC20 interface (IERC20.sol)
KYCTransferManagerFactory.sol
Checkpoint module for issuing ether dividends (EtherDividendCheckpoint.sol)
functionSigClash1.sol
Wallet for core vesting escrow functionality (VestingEscrowWalletStorage.sol)
Interface for managing polymath feature switches (IFeatureRegistry.sol)
Encoder.sol
STRGetter.sol
OraclizeI.sol
Contract used to store layout for the CappedSTO storage (CappedSTOStorage.sol)
LockUpTransferManager.sol
Checkpoint module for token weighted vote (WeightedVoteCheckpoint.sol)
Registry contract to store registered modules (ModuleRegistry.sol)
Factory for deploying upgradable modules (UpgradableModuleFactory.sol)
Utility contract to allow pausing and unpausing of certain functions (Pausable.sol)
CountTransferManager module Proxy (CountTransferManagerProxy.sol)
Math (Math.sol)
IPolymathRegistry.sol
MockOracle.sol
Transfer Manager module for manually approving transactions between accounts (ManualApprovalTransfer
DecimalMath.sol
STO module for standard capped crowdsale (USDTieredSTO.sol)
Security Token contract (SecurityToken.sol)
PercentageTransferManager module Proxy (PercentageTransferManagerProxy.sol)
Interface to be implemented by all checkpoint modules (IBurn.sol)
Burn module for burning tokens and keeping track of burnt amounts (MockRedemptionManager.sol)
GeneralPermissionManager module Proxy (GeneralPermissionManagerProxy.sol)
STO module for sample implementation of a different crowdsale module (DummySTO.sol)
Factory for deploying CountTransferManager module (CountTransferManagerFactory.sol)
Interface to be implemented by all STO modules (ISTO.sol)
Data store contract that stores data for all the modules in a central contract. (DataStore.sol)
Transfer Manager module to automate blacklist and restrict transfers (BlacklistTransferManager.sol)
Contract used to store layout for the PreSaleSTO storage (PreSaleSTOStorage.sol)
Migrations.sol
Contract used to store layout for the CountTransferManager storage (BlacklistTransferManagerStorage.
STO module for private presales (PreSaleSTO.sol)
DataStoreStorage.sol
Storage layout for the ISTO contract (ISTOStorage.sol)
Registry contract for issuers to register their tickers and security tokens (SecurityTokenRegistry.s
Factory for deploying SignedTransferManager module (SignedTransferManagerFactory.sol)
Transfer Manager module for core transfer validation functionality (ERC20DividendCheckpointProxy.sol
Burn module for burning tokens and keeping track of burnt amounts (ScheduledCheckpoint.sol)
ERC20 interface (IPoly.sol)
Transfer Manager module for core transfer validation functionality (VolumeRestrictionTMProxy.sol)
Contract used to store layout for the DummySTO storage (DummySTOStorage.sol)
Burn module for burning tokens and keeping track of burnt amounts (TrackedRedemption.sol)
Interface that every module contract should implement (IModule.sol)
Contract used to store layout for the ManualApprovalTransferManager storage (ManualApprovalTransferM
Elliptic curve signature operations (ECDSA.sol)
Factory for deploying PercentageTransferManager module (PercentageTransferManagerFactory.sol)
Transfer Manager module for core transfer validation functionality (GeneralTransferManagerProxy.sol)
Utility contract for reusable code (Util.sol)
SecurityTokenStorage.sol
Contract used to store layout for the USDTieredSTO storage (USDTieredSTOStorage.sol)
Factory for deploying GeneralPermissionManager module (GeneralPermissionManagerFactory.sol)
Address.sol
StatusCodes.sol
Standard ERC20 token
Voting module for governance (PLCRVotingCheckpointProxy.sol)
CBOR.sol
Registry for managing polymath feature switches (FeatureRegistry.sol)
WeightedVoteCheckpointStorage.sol
Interface for the Polymath Module Registry contract (IModuleRegistry.sol)
Interface for security token proxy deployment (ISTFactory.sol)
Registry contract for issuers to register their security tokens (MockSTRGetter.sol)
Buffer.sol
BokkyPooBahsDateTimeLibrary.sol
Mock Contract Not fit for production environment (MockBurnFactory.sol)
Wallet for core vesting escrow functionality (LockUpTransferManagerStorage.sol)
Factory for deploying VolumeRestrictionTM module (VolumeRestrictionTMFactory.sol)
usingOraclize.sol
STO module for standard capped crowdsale (CappedSTO.sol)
Interface to MakerDAO Medianizer contract (IMedianizer.sol)
Interface to be implemented by all checkpoint modules (ICheckpoint.sol)
Factory for deploying ERC20DividendCheckpoint module (ERC20DividendCheckpointFactory.sol)
Factory for deploying GeneralTransferManager module (GeneralTransferManagerFactory.sol)
Escrow wallet module for vesting functionality (VestingEscrowWalletProxy.sol)
OZStorage.sol
Wallet for core vesting escrow functionality (VestingEscrowWallet.sol)
EternalStorage.sol
Factory for deploying PLCRVotingCheckpoint module (PLCRVotingCheckpointFactory.sol)
IVoting.sol
Transfer Manager for limiting maximum number of token holders (MockCountTransferManager.sol)
CappedSTO module Proxy (CappedSTOProxy.sol)
Storage for Module contract (ModuleStorage.sol)
wiki
misc
Powered by GitBook

Transfer Manager module for limiting percentage of token supply a single address can hold (Percentag

View Source: contracts/modules/TransferManager/PTM/PercentageTransferManager.sol​

↗ Extends: PercentageTransferManagerStorage, TransferManager​

PercentageTransferManager

Events

event ModifyHolderPercentage(uint256  _oldHolderPercentage, uint256  _newHolderPercentage);
event ModifyWhitelist(address  _investor, address  _addedBy, bool  _valid);
event SetAllowPrimaryIssuance(bool  _allowPrimaryIssuance);

Functions

Constructor

function (address _securityToken, address _polyToken) public nonpayable Module

Arguments

Name

Type

Description

_securityToken

address

Address of the security token

_polyToken

address

​

executeTransfer

⤾ overrides ITransferManager.executeTransfer​

Used to verify the transfer transaction and prevent a given account to end up with more tokens than allowed

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

Arguments

Name

Type

Description

_from

address

Address of the sender

_to

address

Address of the receiver

_amount

uint256

The amount of tokens to transfer

​

bytes

_from Address of the sender

verifyTransfer

⤾ overrides ITransferManager.verifyTransfer​

Used to verify the transfer transaction and prevent a given account to end up with more tokens than allowed

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

Arguments

Name

Type

Description

_from

address

Address of the sender

_to

address

Address of the receiver

_amount

uint256

The amount of tokens to transfer

​

bytes

_from Address of the sender

_verifyTransfer

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

Arguments

Name

Type

Description

_from

address

​

_to

address

​

_amount

uint256

​

configure

Used to intialize the variables of the contract

function configure(uint256 _maxHolderPercentage, bool _allowPrimaryIssuance) public nonpayable onlyFactory

Arguments

Name

Type

Description

_maxHolderPercentage

uint256

Maximum amount of ST20 tokens(in %) can hold by the investor

_allowPrimaryIssuance

bool

​

getInitFunction

⤾ overrides IModule.getInitFunction​

This function returns the signature of configure function

function getInitFunction() public pure
returns(bytes4)

Arguments

Name

Type

Description

changeHolderPercentage

sets the maximum percentage that an individual token holder can hold

function changeHolderPercentage(uint256 _maxHolderPercentage) public nonpayable withPerm

Arguments

Name

Type

Description

_maxHolderPercentage

uint256

is the new maximum percentage (multiplied by 10**16)

modifyWhitelist

adds or removes addresses from the whitelist.

function modifyWhitelist(address _investor, bool _valid) public nonpayable withPerm

Arguments

Name

Type

Description

_investor

address

is the address to whitelist

_valid

bool

whether or not the address it to be added or removed from the whitelist

modifyWhitelistMulti

adds or removes addresses from the whitelist.

function modifyWhitelistMulti(address[] _investors, bool[] _valids) public nonpayable withPerm

Arguments

Name

Type

Description

_investors

address[]

Array of the addresses to whitelist

_valids

bool[]

Array of boolean value to decide whether or not the address it to be added or removed from the whitelist

setAllowPrimaryIssuance

sets whether or not to consider primary issuance transfers

function setAllowPrimaryIssuance(bool _allowPrimaryIssuance) public nonpayable withPerm

Arguments

Name

Type

Description

_allowPrimaryIssuance

bool

whether to allow all primary issuance transfers

getPermissions

⤾ overrides IModule.getPermissions​

Return the permissions flag that are associated with Percentage transfer Manager

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

Arguments

Name

Type

Description

Previous
DummySTO module Proxy (DummySTOProxy.sol)
Next
Helps contracts guard against reentrancy attacks. (ReentrancyGuard.sol)
Last updated 1 year ago
Contents
Functions
executeTransfer
verifyTransfer
_verifyTransfer
configure
getInitFunction
changeHolderPercentage
modifyWhitelist
modifyWhitelistMulti
setAllowPrimaryIssuance
getPermissions