Polymath
master
dev-2.1.0dev-2.2.0dev-3.0.0dev-3.1.0dev-3.1.0-mastermaster
master
dev-2.1.0dev-2.2.0dev-3.0.0dev-3.1.0dev-3.1.0-mastermaster
  • 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
    • Dividend-Module
    • Transfer-manager-results
    • General Permission Manager
    • Transfer-Feature
    • Voting-Checkpoint-Modules
    • USDTieredSTO
    • Contract-Manager
    • Vesting-Escrow-Wallet
    • General Transfer Manager
    • Permission-Manager
    • Dividends-Manager
    • Manual Approval Transfer Manager
    • Transfer-Ownership
    • Transfer-Manager
    • How-to-Use-the-Investor-Portal
    • Count Transfer Manager
    • VolumeRestrictionTransferManager
    • Time-Travel-(Contract-Testing)
    • Percentage Transfer Manager
    • Prerequisite-Instructions-for-Deploying-and-Setting-Up-the-Polymath-Contracts
    • How to Create and Launch an STO
    • Token-Manager
    • How to set up and use the POLY Faucet
    • Advanced PLCR Voting Checkpoint
    • Welcome to the Polymath Core Wiki
    • Capped STO
    • _Sidebar
    • CLI for Polymath-core
    • Lockup Transfer Manager
    • The-STO-Manager
    • Blacklist Transfer Manager (BTM)
  • misc
    • Multiple Transfer Managers
    • PolyOracle Encrypted URL
    • ethereum_status_codes
    • Flags List
    • Permissions List
Powered by GitBook
On this page
  • Functions
  • useModule
  • useModule
  • registerModule
  • removeModule
  • isCompatibleModule
  • verifyModule
  • unverifyModule
  • getFactoryDetails
  • getTagsByTypeAndToken
  • getTagsByType
  • getAllModulesByType
  • getModulesByType
  • getModulesByTypeAndToken
  • updateFromRegistry
  • owner
  • isPaused
  • reclaimERC20
  • pause
  • unpause
  • transferOwnership

Was this helpful?

  1. api

Interface for the Polymath Module Registry contract (IModuleRegistry.sol)

PreviousWeightedVoteCheckpointStorage.solNextInterface for security token proxy deployment (ISTFactory.sol)

Last updated 5 years ago

Was this helpful?

View Source:

↘ Derived Contracts:

IModuleRegistry

Events

event Pause(address  account);
event Unpause(address  account);
event ModuleUsed(address indexed _moduleFactory, address indexed _securityToken);
event ModuleRegistered(address indexed _moduleFactory, address indexed _owner);
event ModuleVerified(address indexed _moduleFactory);
event ModuleUnverified(address indexed _moduleFactory);
event ModuleRemoved(address indexed _moduleFactory, address indexed _decisionMaker);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

Functions

useModule

Called by a security token (2.x) to notify the registry it is using a module

function useModule(address _moduleFactory) external nonpayable

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the relevant module factory

useModule

Called by a security token to notify the registry it is using a module

function useModule(address _moduleFactory, bool _isUpgrade) external nonpayable

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the relevant module factory

_isUpgrade

bool

whether the use is part of an existing module upgrade

registerModule

Called by the ModuleFactory owner to register new modules for SecurityToken to use

function registerModule(address _moduleFactory) external nonpayable

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the module factory to be registered

removeModule

Called by the ModuleFactory owner or registry curator to delete a ModuleFactory

function removeModule(address _moduleFactory) external nonpayable

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the module factory to be deleted

isCompatibleModule

Check that a module and its factory are compatible

function isCompatibleModule(address _moduleFactory, address _securityToken) external view
returns(isCompatible bool)

Returns

bool whether module and token are compatible

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the relevant module factory

_securityToken

address

is the address of the relevant security token

verifyModule

Called by Polymath to verify modules for SecurityToken to use.

function verifyModule(address _moduleFactory) external nonpayable

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the module factory to be registered

unverifyModule

Called by Polymath to unverify modules for SecurityToken to use.

function unverifyModule(address _moduleFactory) external nonpayable

Arguments

Name

Type

Description

_moduleFactory

address

is the address of the module factory to be registered

getFactoryDetails

Returns the verified status, and reputation of the entered Module Factory

function getFactoryDetails(address _factoryAddress) external view
returns(isVerified bool, factoryOwner address, usingTokens address[])

Returns

bool indicating whether module factory is verified

Arguments

Name

Type

Description

_factoryAddress

address

is the address of the module factory

getTagsByTypeAndToken

Returns all the tags related to the a module type which are valid for the given token

function getTagsByTypeAndToken(uint8 _moduleType, address _securityToken) external view
returns(tags bytes32[], factories address[])

Returns

list of tags

Arguments

Name

Type

Description

_moduleType

uint8

is the module type

_securityToken

address

is the token

getTagsByType

Returns all the tags related to the a module type which are valid for the given token

function getTagsByType(uint8 _moduleType) external view
returns(tags bytes32[], factories address[])

Returns

list of tags

Arguments

Name

Type

Description

_moduleType

uint8

is the module type

getAllModulesByType

Returns the list of addresses of all Module Factory of a particular type

function getAllModulesByType(uint8 _moduleType) external view
returns(factories address[])

Returns

address array that contains the list of addresses of module factory contracts.

Arguments

Name

Type

Description

_moduleType

uint8

Type of Module

getModulesByType

Returns the list of addresses of Module Factory of a particular type

function getModulesByType(uint8 _moduleType) external view
returns(factories address[])

Returns

address array that contains the list of addresses of module factory contracts.

Arguments

Name

Type

Description

_moduleType

uint8

Type of Module

getModulesByTypeAndToken

Returns the list of available Module factory addresses of a particular type for a given token.

function getModulesByTypeAndToken(uint8 _moduleType, address _securityToken) external view
returns(factories address[])

Returns

address array that contains the list of available addresses of module factory contracts.

Arguments

Name

Type

Description

_moduleType

uint8

is the module type to look for

_securityToken

address

is the address of SecurityToken

updateFromRegistry

Use to get the latest contract address of the regstries

function updateFromRegistry() external nonpayable

Arguments

Name

Type

Description

owner

Get the owner of the contract

function owner() external view
returns(ownerAddress address)

Returns

address owner

Arguments

Name

Type

Description

isPaused

Check whether the contract operations is paused or not

function isPaused() external view
returns(paused bool)

Returns

bool

Arguments

Name

Type

Description

reclaimERC20

Reclaims all ERC20Basic compatible tokens

function reclaimERC20(address _tokenContract) external nonpayable

Arguments

Name

Type

Description

_tokenContract

address

The address of the token contract

pause

Called by the owner to pause, triggers stopped state

function pause() external nonpayable

Arguments

Name

Type

Description

unpause

Called by the owner to unpause, returns to normal state

function unpause() external nonpayable

Arguments

Name

Type

Description

transferOwnership

Allows the current owner to transfer control of the contract to a newOwner.

function transferOwnership(address _newOwner) external nonpayable

Arguments

Name

Type

Description

_newOwner

address

The address to transfer ownership to.

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

⤿ Overridden Implementation(s):

ModuleRegistry.useModule
ModuleRegistry.useModule
ModuleRegistry.registerModule
ModuleRegistry.removeModule
ModuleRegistry.isCompatibleModule
ModuleRegistry.verifyModule
ModuleRegistry.unverifyModule
ModuleRegistry.getFactoryDetails
ModuleRegistry.getTagsByTypeAndToken
ModuleRegistry.getTagsByType
ModuleRegistry.getAllModulesByType
ModuleRegistry.getModulesByType
ModuleRegistry.getModulesByTypeAndToken
ModuleRegistry.updateFromRegistry
ModuleRegistry.owner
ModuleRegistry.isPaused
ModuleRegistry.reclaimERC20
ModuleRegistry.pause
ModuleRegistry.unpause
ModuleRegistry.transferOwnership
contracts/interfaces/IModuleRegistry.sol
ModuleRegistry
useModule(address _moduleFactory)
useModule(address _moduleFactory, bool _isUpgrade)
registerModule(address _moduleFactory)
removeModule(address _moduleFactory)
isCompatibleModule(address _moduleFactory, address _securityToken)
verifyModule(address _moduleFactory)
unverifyModule(address _moduleFactory)
getFactoryDetails(address _factoryAddress)
getTagsByTypeAndToken(uint8 _moduleType, address _securityToken)
getTagsByType(uint8 _moduleType)
getAllModulesByType(uint8 _moduleType)
getModulesByType(uint8 _moduleType)
getModulesByTypeAndToken(uint8 _moduleType, address _securityToken)
updateFromRegistry()
owner()
isPaused()
reclaimERC20(address _tokenContract)
pause()
unpause()
transferOwnership(address _newOwner)