> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymath/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymath/api.md).

# api

- [Proxy (Proxy.sol)](https://developers.polymath.network/polymath/api/proxy.md)
- [Base abstract contract to be extended by all STO modules (STO.sol)](https://developers.polymath.network/polymath/api/sto.md)
- [OwnedUpgradeabilityProxy (OwnedUpgradeabilityProxy.sol)](https://developers.polymath.network/polymath/api/ownedupgradeabilityproxy.md)
- [Transfer Manager module for core transfer validation functionality (GeneralTransferManager.sol)](https://developers.polymath.network/polymath/api/generaltransfermanager.md)
- [VotingCheckpointStorage.sol](https://developers.polymath.network/polymath/api/votingcheckpointstorage.md)
- [PLCRVotingCheckpoint.sol](https://developers.polymath.network/polymath/api/plcrvotingcheckpoint.md)
- [Factory for deploying VestingEscrowWallet module (VestingEscrowWalletFactory.sol)](https://developers.polymath.network/polymath/api/vestingescrowwalletfactory.md)
- [Helper library use to compare or validate the semantic versions (VersionUtils.sol)](https://developers.polymath.network/polymath/api/versionutils.md)
- [Interface to be implemented by all Wallet modules (Wallet.sol)](https://developers.polymath.network/polymath/api/wallet.md)
- [Factory for deploying CappedSTO module (CappedSTOFactory.sol)](https://developers.polymath.network/polymath/api/cappedstofactory.md)
- [Checkpoint module for issuing ERC20 dividends (ERC20DividendCheckpoint.sol)](https://developers.polymath.network/polymath/api/erc20dividendcheckpoint.md)
- [Interface to be implemented by all Transfer Manager modules (ITransferManager.sol)](https://developers.polymath.network/polymath/api/itransfermanager.md)
- [StableOracle.sol](https://developers.polymath.network/polymath/api/stableoracle.md)
- [VolumeRestrictionTM.sol](https://developers.polymath.network/polymath/api/volumerestrictiontm.md)
- [SecurityTokenRegistryProxy (SecurityTokenRegistryProxy.sol)](https://developers.polymath.network/polymath/api/securitytokenregistryproxy.md)
- [PreSaleSTO module Proxy (PreSaleSTOProxy.sol)](https://developers.polymath.network/polymath/api/presalestoproxy.md)
- [DataStoreProxy Proxy (DataStoreProxy.sol)](https://developers.polymath.network/polymath/api/datastoreproxy.md)
- [Proxy for deploying SecurityToken instances (STFactory.sol)](https://developers.polymath.network/polymath/api/stfactory.md)
- [Ownable (IOwnable.sol)](https://developers.polymath.network/polymath/api/iownable.md)
- [Checkpoint module for issuing ether dividends (DividendCheckpoint.sol)](https://developers.polymath.network/polymath/api/dividendcheckpoint.md)
- [CountTransferManager module Proxy (BlacklistTransferManagerProxy.sol)](https://developers.polymath.network/polymath/api/blacklisttransfermanagerproxy.md)
- [Security Token contract (mock) (MockSTGetter.sol)](https://developers.polymath.network/polymath/api/mockstgetter.md)
- [Permission Manager module for core permissioning functionality (GeneralPermissionManager.sol)](https://developers.polymath.network/polymath/api/generalpermissionmanager.md)
- [Contract used to store layout for the CountTransferManager storage (CountTransferManagerStorage.sol)](https://developers.polymath.network/polymath/api/counttransfermanagerstorage.md)
- [DummySTO module Proxy (DummySTOProxy.sol)](https://developers.polymath.network/polymath/api/dummystoproxy.md)
- [Transfer Manager module for limiting percentage of token supply a single address can hold (Percentag](https://developers.polymath.network/polymath/api/percentagetransfermanager.md)
- [Helps contracts guard against reentrancy attacks. (ReentrancyGuard.sol)](https://developers.polymath.network/polymath/api/reentrancyguard.md)
- [Factory for deploying EtherDividendCheckpoint module (ScheduledCheckpointFactory.sol)](https://developers.polymath.network/polymath/api/scheduledcheckpointfactory.md)
- [Interface that every module factory contract should implement (IModuleFactory.sol)](https://developers.polymath.network/polymath/api/imodulefactory.md)
- [Factory for deploying GeneralTransferManager module (TrackedRedemptionFactory.sol)](https://developers.polymath.network/polymath/api/trackedredemptionfactory.md)
- [SafeMath (SafeMath.sol)](https://developers.polymath.network/polymath/api/safemath.md)
- [USDTiered STO module Proxy (SecurityTokenProxy.sol)](https://developers.polymath.network/polymath/api/securitytokenproxy.md)
- [USDTiered STO module Proxy (USDTieredSTOProxy.sol)](https://developers.polymath.network/polymath/api/usdtieredstoproxy.md)
- [IOracle.sol](https://developers.polymath.network/polymath/api/ioracle.md)
- [ManualApprovalTransferManager module Proxy (ManualApprovalTransferManagerProxy.sol)](https://developers.polymath.network/polymath/api/manualapprovaltransfermanagerproxy.md)
- [Interface to be implemented by all permission manager modules (IPermissionManager.sol)](https://developers.polymath.network/polymath/api/ipermissionmanager.md)
- [Factory for deploying PreSaleSTO module (PreSaleSTOFactory.sol)](https://developers.polymath.network/polymath/api/presalestofactory.md)
- [MockPolyOracle.sol](https://developers.polymath.network/polymath/api/mockpolyoracle.md)
- [Transfer Manager module for verifing transations with a signed message (SignedTransferManager.sol)](https://developers.polymath.network/polymath/api/signedtransfermanager.md)
- [DataStoreFactory.sol](https://developers.polymath.network/polymath/api/datastorefactory.md)
- [OraclizeAddrResolverI.sol](https://developers.polymath.network/polymath/api/oraclizeaddrresolveri.md)
- [PolyTokenFaucet.sol](https://developers.polymath.network/polymath/api/polytokenfaucet.md)
- [Registry contract for issuers to register their security tokens (MockModuleRegistry.sol)](https://developers.polymath.network/polymath/api/mockmoduleregistry.md)
- [VolumeRestrictionLib.sol](https://developers.polymath.network/polymath/api/volumerestrictionlib.md)
- [Contract used to store layout for the PercentageTransferManager storage (PercentageTransferManagerSt](https://developers.polymath.network/polymath/api/percentagetransfermanagerstorage.md)
- [Transfer Manager for limiting maximum number of token holders (CountTransferManager.sol)](https://developers.polymath.network/polymath/api/counttransfermanager.md)
- [ModuleRegistryProxy (ModuleRegistryProxy.sol)](https://developers.polymath.network/polymath/api/moduleregistryproxy.md)
- [Voting module for governance (WeightedVoteCheckpointProxy.sol)](https://developers.polymath.network/polymath/api/weightedvotecheckpointproxy.md)
- [Factory for deploying BlacklistTransferManager module (BlacklistTransferManagerFactory.sol)](https://developers.polymath.network/polymath/api/blacklisttransfermanagerfactory.md)
- [Contract used to store layout for the GeneralPermissionManager storage (GeneralPermissionManagerStor](https://developers.polymath.network/polymath/api/generalpermissionmanagerstorage.md)
- [CountTransferManager module Proxy (LockUpTransferManagerProxy.sol)](https://developers.polymath.network/polymath/api/lockuptransfermanagerproxy.md)
- [Holds the storage variable for the DividendCheckpoint modules (i.e ERC20, Ether) (DividendCheckpoint](https://developers.polymath.network/polymath/api/dividendcheckpointstorage.md)
- [Factory for deploying DummySTO module (DummySTOFactory.sol)](https://developers.polymath.network/polymath/api/dummystofactory.md)
- [IERC1644.sol](https://developers.polymath.network/polymath/api/ierc1644.md)
- [Core functionality for registry upgradability (PolymathRegistry.sol)](https://developers.polymath.network/polymath/api/polymathregistry.md)
- [Utility contract to allow owner to retreive any ERC20 sent to the contract (ReclaimTokens.sol)](https://developers.polymath.network/polymath/api/reclaimtokens.md)
- [SecurityTokenMock.sol](https://developers.polymath.network/polymath/api/securitytokenmock.md)
- [Factory for deploying CappedSTO module (USDTieredSTOFactory.sol)](https://developers.polymath.network/polymath/api/usdtieredstofactory.md)
- [Factory for deploying ManualApprovalTransferManager module (ManualApprovalTransferManagerFactory.sol](https://developers.polymath.network/polymath/api/manualapprovaltransfermanagerfactory.md)
- [IERC1643.sol](https://developers.polymath.network/polymath/api/ierc1643.md)
- [Transfer Manager module for core transfer validation functionality (EtherDividendCheckpointProxy.sol](https://developers.polymath.network/polymath/api/etherdividendcheckpointproxy.md)
- [solcChecker.sol](https://developers.polymath.network/polymath/api/solcchecker.md)
- [It holds the storage variables related to ERC20DividendCheckpoint module (ERC20DividendCheckpointSto](https://developers.polymath.network/polymath/api/erc20dividendcheckpointstorage.md)
- [Interface for all security tokens (ISecurityToken.sol)](https://developers.polymath.network/polymath/api/isecuritytoken.md)
- [Base abstract contract to be implemented by all Transfer Manager modules (TransferManager.sol)](https://developers.polymath.network/polymath/api/transfermanager.md)
- [Storage layout for VolumeRestrictionTM (VolumeRestrictionTMStorage.sol)](https://developers.polymath.network/polymath/api/volumerestrictiontmstorage.md)
- [Security Token contract (mock) (MockSecurityTokenLogic.sol)](https://developers.polymath.network/polymath/api/mocksecuritytokenlogic.md)
- [Transfer Manager module for core transfer validation functionality (GeneralTransferManagerStorage.so](https://developers.polymath.network/polymath/api/generaltransfermanagerstorage.md)
- [IERC1410.sol](https://developers.polymath.network/polymath/api/ierc1410.md)
- [VotingCheckpoint.sol](https://developers.polymath.network/polymath/api/votingcheckpoint.md)
- [Factory for deploying WeightedVoteCheckpoint module (WeightedVoteCheckpointFactory.sol)](https://developers.polymath.network/polymath/api/weightedvotecheckpointfactory.md)
- [PLCRVotingCheckpointStorage.sol](https://developers.polymath.network/polymath/api/plcrvotingcheckpointstorage.md)
- [IDataStore.sol](https://developers.polymath.network/polymath/api/idatastore.md)
- [TestSTOFactory.sol](https://developers.polymath.network/polymath/api/teststofactory.md)
- [Ownable (Ownable.sol)](https://developers.polymath.network/polymath/api/ownable.md)
- [UpgradeabilityProxy (UpgradeabilityProxy.sol)](https://developers.polymath.network/polymath/api/upgradeabilityproxy.md)
- [Mock Contract Not fit for production environment (MockFactory.sol)](https://developers.polymath.network/polymath/api/mockfactory.md)
- [Registry contract for issuers to register their security tokens (SecurityTokenRegistryMock.sol)](https://developers.polymath.network/polymath/api/securitytokenregistrymock.md)
- [ICheckPermission.sol](https://developers.polymath.network/polymath/api/icheckpermission.md)
- [Factory for deploying LockUpTransferManager module (LockUpTransferManagerFactory.sol)](https://developers.polymath.network/polymath/api/lockuptransfermanagerfactory.md)
- [Storage layout for the STO contract (STOStorage.sol)](https://developers.polymath.network/polymath/api/stostorage.md)
- [Interface for the Polymath Security Token Registry contract (ISecurityTokenRegistry.sol)](https://developers.polymath.network/polymath/api/isecuritytokenregistry.md)
- [Mock Contract Not fit for production environment (MockWrongTypeFactory.sol)](https://developers.polymath.network/polymath/api/mockwrongtypefactory.md)
- [Transfer Manager module for core transfer validation functionality (KYCTransferManager.sol)](https://developers.polymath.network/polymath/api/kyctransfermanager.md)
- [Factory for deploying EtherDividendCheckpoint module (EtherDividendCheckpointFactory.sol)](https://developers.polymath.network/polymath/api/etherdividendcheckpointfactory.md)
- [functionSigClash2.sol](https://developers.polymath.network/polymath/api/functionsigclash2.md)
- [Standard Interface of ERC1594 (IERC1594.sol)](https://developers.polymath.network/polymath/api/ierc1594.md)
- [TokenLib.sol](https://developers.polymath.network/polymath/api/tokenlib.md)
- [MakerDAOOracle.sol](https://developers.polymath.network/polymath/api/makerdaooracle.md)
- [Interface that any module contract should implement (Module.sol)](https://developers.polymath.network/polymath/api/module.md)
- [Interface that any module factory contract should implement (ModuleFactory.sol)](https://developers.polymath.network/polymath/api/modulefactory.md)
- [STGetter.sol](https://developers.polymath.network/polymath/api/stgetter.md)
- [Interface to be implemented by upgradable token factories (IUpgradableTokenFactory.sol)](https://developers.polymath.network/polymath/api/iupgradabletokenfactory.md)
- [ERC20 interface (IERC20.sol)](https://developers.polymath.network/polymath/api/ierc20.md)
- [KYCTransferManagerFactory.sol](https://developers.polymath.network/polymath/api/kyctransfermanagerfactory.md)
- [Checkpoint module for issuing ether dividends (EtherDividendCheckpoint.sol)](https://developers.polymath.network/polymath/api/etherdividendcheckpoint.md)
- [functionSigClash1.sol](https://developers.polymath.network/polymath/api/functionsigclash1.md)
- [Wallet for core vesting escrow functionality (VestingEscrowWalletStorage.sol)](https://developers.polymath.network/polymath/api/vestingescrowwalletstorage.md)
- [Interface for managing polymath feature switches (IFeatureRegistry.sol)](https://developers.polymath.network/polymath/api/ifeatureregistry.md)
- [Encoder.sol](https://developers.polymath.network/polymath/api/encoder.md)
- [STRGetter.sol](https://developers.polymath.network/polymath/api/strgetter.md)
- [OraclizeI.sol](https://developers.polymath.network/polymath/api/oraclizei.md)
- [Contract used to store layout for the CappedSTO storage (CappedSTOStorage.sol)](https://developers.polymath.network/polymath/api/cappedstostorage.md)
- [LockUpTransferManager.sol](https://developers.polymath.network/polymath/api/lockuptransfermanager.md)
- [Checkpoint module for token weighted vote (WeightedVoteCheckpoint.sol)](https://developers.polymath.network/polymath/api/weightedvotecheckpoint.md)
- [Registry contract to store registered modules (ModuleRegistry.sol)](https://developers.polymath.network/polymath/api/moduleregistry.md)
- [Factory for deploying upgradable modules (UpgradableModuleFactory.sol)](https://developers.polymath.network/polymath/api/upgradablemodulefactory.md)
- [Utility contract to allow pausing and unpausing of certain functions (Pausable.sol)](https://developers.polymath.network/polymath/api/pausable.md)
- [CountTransferManager module Proxy (CountTransferManagerProxy.sol)](https://developers.polymath.network/polymath/api/counttransfermanagerproxy.md)
- [Math (Math.sol)](https://developers.polymath.network/polymath/api/math.md)
- [IPolymathRegistry.sol](https://developers.polymath.network/polymath/api/ipolymathregistry.md)
- [MockOracle.sol](https://developers.polymath.network/polymath/api/mockoracle.md)
- [Transfer Manager module for manually approving transactions between accounts (ManualApprovalTransfer](https://developers.polymath.network/polymath/api/manualapprovaltransfermanager.md)
- [DecimalMath.sol](https://developers.polymath.network/polymath/api/decimalmath.md)
- [STO module for standard capped crowdsale (USDTieredSTO.sol)](https://developers.polymath.network/polymath/api/usdtieredsto.md)
- [Security Token contract (SecurityToken.sol)](https://developers.polymath.network/polymath/api/securitytoken.md)
- [PercentageTransferManager module Proxy (PercentageTransferManagerProxy.sol)](https://developers.polymath.network/polymath/api/percentagetransfermanagerproxy.md)
- [Interface to be implemented by all checkpoint modules (IBurn.sol)](https://developers.polymath.network/polymath/api/iburn.md)
- [Burn module for burning tokens and keeping track of burnt amounts (MockRedemptionManager.sol)](https://developers.polymath.network/polymath/api/mockredemptionmanager.md)
- [GeneralPermissionManager module Proxy (GeneralPermissionManagerProxy.sol)](https://developers.polymath.network/polymath/api/generalpermissionmanagerproxy.md)
- [STO module for sample implementation of a different crowdsale module (DummySTO.sol)](https://developers.polymath.network/polymath/api/dummysto.md)
- [Factory for deploying CountTransferManager module (CountTransferManagerFactory.sol)](https://developers.polymath.network/polymath/api/counttransfermanagerfactory.md)
- [Interface to be implemented by all STO modules (ISTO.sol)](https://developers.polymath.network/polymath/api/isto.md)
- [Data store contract that stores data for all the modules in a central contract. (DataStore.sol)](https://developers.polymath.network/polymath/api/datastore.md)
- [Transfer Manager module to automate blacklist and restrict transfers (BlacklistTransferManager.sol)](https://developers.polymath.network/polymath/api/blacklisttransfermanager.md)
- [Contract used to store layout for the PreSaleSTO storage (PreSaleSTOStorage.sol)](https://developers.polymath.network/polymath/api/presalestostorage.md)
- [Migrations.sol](https://developers.polymath.network/polymath/api/migrations.md)
- [Contract used to store layout for the CountTransferManager storage (BlacklistTransferManagerStorage.](https://developers.polymath.network/polymath/api/blacklisttransfermanagerstorage.md)
- [STO module for private presales (PreSaleSTO.sol)](https://developers.polymath.network/polymath/api/presalesto.md)
- [DataStoreStorage.sol](https://developers.polymath.network/polymath/api/datastorestorage.md)
- [Storage layout for the ISTO contract (ISTOStorage.sol)](https://developers.polymath.network/polymath/api/istostorage.md)
- [Registry contract for issuers to register their tickers and security tokens (SecurityTokenRegistry.s](https://developers.polymath.network/polymath/api/securitytokenregistry.md)
- [Factory for deploying SignedTransferManager module (SignedTransferManagerFactory.sol)](https://developers.polymath.network/polymath/api/signedtransfermanagerfactory.md)
- [Transfer Manager module for core transfer validation functionality (ERC20DividendCheckpointProxy.sol](https://developers.polymath.network/polymath/api/erc20dividendcheckpointproxy.md)
- [Burn module for burning tokens and keeping track of burnt amounts (ScheduledCheckpoint.sol)](https://developers.polymath.network/polymath/api/scheduledcheckpoint.md)
- [ERC20 interface (IPoly.sol)](https://developers.polymath.network/polymath/api/ipoly.md)
- [Transfer Manager module for core transfer validation functionality (VolumeRestrictionTMProxy.sol)](https://developers.polymath.network/polymath/api/volumerestrictiontmproxy.md)
- [Contract used to store layout for the DummySTO storage (DummySTOStorage.sol)](https://developers.polymath.network/polymath/api/dummystostorage.md)
- [Burn module for burning tokens and keeping track of burnt amounts (TrackedRedemption.sol)](https://developers.polymath.network/polymath/api/trackedredemption.md)
- [Interface that every module contract should implement (IModule.sol)](https://developers.polymath.network/polymath/api/imodule.md)
- [Contract used to store layout for the ManualApprovalTransferManager storage (ManualApprovalTransferM](https://developers.polymath.network/polymath/api/manualapprovaltransfermanagerstorage.md)
- [Elliptic curve signature operations (ECDSA.sol)](https://developers.polymath.network/polymath/api/ecdsa.md)
- [Factory for deploying PercentageTransferManager module (PercentageTransferManagerFactory.sol)](https://developers.polymath.network/polymath/api/percentagetransfermanagerfactory.md)
- [Transfer Manager module for core transfer validation functionality (GeneralTransferManagerProxy.sol)](https://developers.polymath.network/polymath/api/generaltransfermanagerproxy.md)
- [Utility contract for reusable code (Util.sol)](https://developers.polymath.network/polymath/api/util.md)
- [SecurityTokenStorage.sol](https://developers.polymath.network/polymath/api/securitytokenstorage.md)
- [Contract used to store layout for the USDTieredSTO storage (USDTieredSTOStorage.sol)](https://developers.polymath.network/polymath/api/usdtieredstostorage.md)
- [Factory for deploying GeneralPermissionManager module (GeneralPermissionManagerFactory.sol)](https://developers.polymath.network/polymath/api/generalpermissionmanagerfactory.md)
- [Address.sol](https://developers.polymath.network/polymath/api/address.md)
- [StatusCodes.sol](https://developers.polymath.network/polymath/api/statuscodes.md)
- [Standard ERC20 token](https://developers.polymath.network/polymath/api/erc20.md)
- [Voting module for governance (PLCRVotingCheckpointProxy.sol)](https://developers.polymath.network/polymath/api/plcrvotingcheckpointproxy.md)
- [CBOR.sol](https://developers.polymath.network/polymath/api/cbor.md)
- [Registry for managing polymath feature switches (FeatureRegistry.sol)](https://developers.polymath.network/polymath/api/featureregistry.md)
- [WeightedVoteCheckpointStorage.sol](https://developers.polymath.network/polymath/api/weightedvotecheckpointstorage.md)
- [Interface for the Polymath Module Registry contract (IModuleRegistry.sol)](https://developers.polymath.network/polymath/api/imoduleregistry.md)
- [Interface for security token proxy deployment (ISTFactory.sol)](https://developers.polymath.network/polymath/api/istfactory.md)
- [Registry contract for issuers to register their security tokens (MockSTRGetter.sol)](https://developers.polymath.network/polymath/api/mockstrgetter.md)
- [Buffer.sol](https://developers.polymath.network/polymath/api/buffer.md)
- [BokkyPooBahsDateTimeLibrary.sol](https://developers.polymath.network/polymath/api/bokkypoobahsdatetimelibrary.md)
- [Mock Contract Not fit for production environment (MockBurnFactory.sol)](https://developers.polymath.network/polymath/api/mockburnfactory.md)
- [Wallet for core vesting escrow functionality (LockUpTransferManagerStorage.sol)](https://developers.polymath.network/polymath/api/lockuptransfermanagerstorage.md)
- [Factory for deploying VolumeRestrictionTM module (VolumeRestrictionTMFactory.sol)](https://developers.polymath.network/polymath/api/volumerestrictiontmfactory.md)
- [usingOraclize.sol](https://developers.polymath.network/polymath/api/usingoraclize.md)
- [STO module for standard capped crowdsale (CappedSTO.sol)](https://developers.polymath.network/polymath/api/cappedsto.md)
- [Interface to MakerDAO Medianizer contract (IMedianizer.sol)](https://developers.polymath.network/polymath/api/imedianizer.md)
- [Interface to be implemented by all checkpoint modules (ICheckpoint.sol)](https://developers.polymath.network/polymath/api/icheckpoint.md)
- [Factory for deploying ERC20DividendCheckpoint module (ERC20DividendCheckpointFactory.sol)](https://developers.polymath.network/polymath/api/erc20dividendcheckpointfactory.md)
- [Factory for deploying GeneralTransferManager module (GeneralTransferManagerFactory.sol)](https://developers.polymath.network/polymath/api/generaltransfermanagerfactory.md)
- [Escrow wallet module for vesting functionality (VestingEscrowWalletProxy.sol)](https://developers.polymath.network/polymath/api/vestingescrowwalletproxy.md)
- [OZStorage.sol](https://developers.polymath.network/polymath/api/ozstorage.md)
- [Wallet for core vesting escrow functionality (VestingEscrowWallet.sol)](https://developers.polymath.network/polymath/api/vestingescrowwallet.md)
- [EternalStorage.sol](https://developers.polymath.network/polymath/api/eternalstorage.md)
- [Factory for deploying PLCRVotingCheckpoint module (PLCRVotingCheckpointFactory.sol)](https://developers.polymath.network/polymath/api/plcrvotingcheckpointfactory.md)
- [IVoting.sol](https://developers.polymath.network/polymath/api/ivoting.md)
- [Transfer Manager for limiting maximum number of token holders (MockCountTransferManager.sol)](https://developers.polymath.network/polymath/api/mockcounttransfermanager.md)
- [CappedSTO module Proxy (CappedSTOProxy.sol)](https://developers.polymath.network/polymath/api/cappedstoproxy.md)
- [Storage for Module contract (ModuleStorage.sol)](https://developers.polymath.network/polymath/api/modulestorage.md)