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
  • deploy
  • version
  • name
  • title
  • description
  • setupCost
  • getTypes
  • getTags
  • changeSetupCost
  • changeCostAndType
  • changeSTVersionBounds
  • setupCostInPoly
  • getLowerSTVersionBounds
  • getUpperSTVersionBounds
  • changeTags
  • changeName
  • changeDescription
  • changeTitle

Was this helpful?

  1. api

Interface that every module factory contract should implement (IModuleFactory.sol)

PreviousFactory for deploying EtherDividendCheckpoint module (ScheduledCheckpointFactory.sol)NextFactory for deploying GeneralTransferManager module (TrackedRedemptionFactory.sol)

Last updated 5 years ago

Was this helpful?

View Source:

↘ Derived Contracts:

IModuleFactory

Events

event ChangeSetupCost(uint256  _oldSetupCost, uint256  _newSetupCost);
event ChangeCostType(bool  _isOldCostInPoly, bool  _isNewCostInPoly);
event GenerateModuleFromFactory(address  _module, bytes32 indexed _moduleName, address indexed _moduleFactory, address  _creator, uint256  _setupCost, uint256  _setupCostInPoly);
event ChangeSTVersionBound(string  _boundType, uint8  _major, uint8  _minor, uint8  _patch);

Functions

deploy

function deploy(bytes _data) external nonpayable
returns(moduleAddress address)

Arguments

Name

Type

Description

_data

bytes

version

Get the tags related to the module factory

function version() external view
returns(moduleVersion string)

Arguments

Name

Type

Description

name

Get the tags related to the module factory

function name() external view
returns(moduleName bytes32)

Arguments

Name

Type

Description

title

Returns the title associated with the module

function title() external view
returns(moduleTitle string)

Arguments

Name

Type

Description

description

Returns the description associated with the module

function description() external view
returns(moduleDescription string)

Arguments

Name

Type

Description

setupCost

Get the setup cost of the module in USD

function setupCost() external nonpayable
returns(usdSetupCost uint256)

Arguments

Name

Type

Description

getTypes

Type of the Module factory

function getTypes() external view
returns(moduleTypes uint8[])

Arguments

Name

Type

Description

getTags

Get the tags related to the module factory

function getTags() external view
returns(moduleTags bytes32[])

Arguments

Name

Type

Description

changeSetupCost

Used to change the setup fee

function changeSetupCost(uint256 _newSetupCost) external nonpayable

Arguments

Name

Type

Description

_newSetupCost

uint256

New setup fee

changeCostAndType

Used to change the currency and amount setup cost

function changeCostAndType(uint256 _setupCost, bool _isCostInPoly) external nonpayable

Arguments

Name

Type

Description

_setupCost

uint256

new setup cost

_isCostInPoly

bool

new setup cost currency. USD or POLY

changeSTVersionBounds

Function use to change the lower and upper bound of the compatible version st

function changeSTVersionBounds(string _boundType, uint8[] _newVersion) external nonpayable

Arguments

Name

Type

Description

_boundType

string

Type of bound

_newVersion

uint8[]

New version array

setupCostInPoly

Get the setup cost of the module

function setupCostInPoly() external nonpayable
returns(polySetupCost uint256)

Arguments

Name

Type

Description

getLowerSTVersionBounds

Used to get the lower bound

function getLowerSTVersionBounds() external view
returns(lowerBounds uint8[])

Returns

Lower bound

Arguments

Name

Type

Description

getUpperSTVersionBounds

Used to get the upper bound

function getUpperSTVersionBounds() external view
returns(upperBounds uint8[])

Returns

Upper bound

Arguments

Name

Type

Description

changeTags

Updates the tags of the ModuleFactory

function changeTags(bytes32[] _tagsData) external nonpayable

Arguments

Name

Type

Description

_tagsData

bytes32[]

New list of tags

changeName

Updates the name of the ModuleFactory

function changeName(bytes32 _name) external nonpayable

Arguments

Name

Type

Description

_name

bytes32

New name that will replace the old one.

changeDescription

Updates the description of the ModuleFactory

function changeDescription(string _description) external nonpayable

Arguments

Name

Type

Description

_description

string

New description that will replace the old one.

changeTitle

Updates the title of the ModuleFactory

function changeTitle(string _title) external nonpayable

Arguments

Name

Type

Description

_title

string

New Title that will replace the old one.

⤿ 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):

BlacklistTransferManagerFactory.deploy
CappedSTOFactory.deploy
CountTransferManagerFactory.deploy
DummySTOFactory.deploy
ERC20DividendCheckpointFactory.deploy
EtherDividendCheckpointFactory.deploy
GeneralPermissionManagerFactory.deploy
GeneralTransferManagerFactory.deploy
KYCTransferManagerFactory.deploy
LockUpTransferManagerFactory.deploy
ManualApprovalTransferManagerFactory.deploy
MockBurnFactory.deploy
PercentageTransferManagerFactory.deploy
PLCRVotingCheckpointFactory.deploy
PreSaleSTOFactory.deploy
ScheduledCheckpointFactory.deploy
SignedTransferManagerFactory.deploy
TrackedRedemptionFactory.deploy
USDTieredSTOFactory.deploy
VestingEscrowWalletFactory.deploy
VolumeRestrictionTMFactory.deploy
WeightedVoteCheckpointFactory.deploy
ModuleFactory.version
UpgradableModuleFactory.version
MockFactory.getTypes
MockWrongTypeFactory.getTypes
ModuleFactory.getTypes
ModuleFactory.getTags
TestSTOFactory.getTags
ModuleFactory.changeSetupCost
ModuleFactory.changeCostAndType
ModuleFactory.changeSTVersionBounds
ModuleFactory.setupCostInPoly
ModuleFactory.getLowerSTVersionBounds
ModuleFactory.getUpperSTVersionBounds
ModuleFactory.changeTags
ModuleFactory.changeName
ModuleFactory.changeDescription
ModuleFactory.changeTitle
contracts/interfaces/IModuleFactory.sol
ModuleFactory
deploy(bytes _data)
version()
name()
title()
description()
setupCost()
getTypes()
getTags()
changeSetupCost(uint256 _newSetupCost)
changeCostAndType(uint256 _setupCost, bool _isCostInPoly)
changeSTVersionBounds(string _boundType, uint8[] _newVersion)
setupCostInPoly()
getLowerSTVersionBounds()
getUpperSTVersionBounds()
changeTags(bytes32[] _tagsData)
changeName(bytes32 _name)
changeDescription(string _description)
changeTitle(string _title)