Polymath
master
master
  • 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
  • isIssuable
  • getCheckpointTimes
  • getInvestorCount
  • getInvestors
  • getInvestorsAt
  • getInvestorsSubsetAt
  • getModule
  • getModulesByName
  • getModulesByType
  • getTreasuryWallet
  • balanceOfAt
  • totalSupplyAt
  • iterateInvestors
  • checkPermission
  • isOperator
  • isOperatorForPartition
  • partitionsOf
  • getVersion
  • getDocument
  • getAllDocuments

Was this helpful?

  1. api

STGetter.sol

PreviousInterface that any module factory contract should implement (ModuleFactory.sol)NextInterface to be implemented by upgradable token factories (IUpgradableTokenFactory.sol)

Last updated 5 years ago

Was this helpful?

View Source:

↗ Extends: , ↘ Derived Contracts:

STGetter

Functions

isIssuable

A security token issuer can specify that issuance has finished for the token (i.e. no new tokens can be minted or issued).

function isIssuable() external view
returns(bool)

Returns

bool true signifies the minting is allowed. While false denotes the end of minting

Arguments

Name

Type

Description

getCheckpointTimes

Gets list of times that checkpoints were created

function getCheckpointTimes() external view
returns(uint256[])

Returns

List of checkpoint times

Arguments

Name

Type

Description

getInvestorCount

Returns the count of address that were added as (potential) investors

function getInvestorCount() external view
returns(uint256)

Returns

Investor count

Arguments

Name

Type

Description

getInvestors

returns an array of investors NB - this length may differ from investorCount as it contains all investors that ever held tokens

function getInvestors() public view
returns(investors address[])

Returns

list of addresses

Arguments

Name

Type

Description

getInvestorsAt

returns an array of investors with non zero balance at a given checkpoint

function getInvestorsAt(uint256 _checkpointId) external view
returns(address[])

Returns

list of investors

Arguments

Name

Type

Description

_checkpointId

uint256

Checkpoint id at which investor list is to be populated

getInvestorsSubsetAt

returns an array of investors with non zero balance at a given checkpoint

function getInvestorsSubsetAt(uint256 _checkpointId, uint256 _start, uint256 _end) external view
returns(address[])

Returns

list of investors

Arguments

Name

Type

Description

_checkpointId

uint256

Checkpoint id at which investor list is to be populated

_start

uint256

Position of investor to start iteration from

_end

uint256

Position of investor to stop iteration at

getModule

Returns the data associated to a module

function getModule(address _module) external view
returns(bytes32, address, address, bool, uint8[], bytes32)

Returns

bytes32 name

Arguments

Name

Type

Description

_module

address

address of the module

getModulesByName

Returns a list of modules that match the provided name

function getModulesByName(bytes32 _name) external view
returns(address[])

Returns

address[] list of modules with this name

Arguments

Name

Type

Description

_name

bytes32

name of the module

getModulesByType

Returns a list of modules that match the provided module type

function getModulesByType(uint8 _type) external view
returns(address[])

Returns

address[] list of modules with this type

Arguments

Name

Type

Description

_type

uint8

type of the module

getTreasuryWallet

use to return the global treasury wallet

function getTreasuryWallet() external view
returns(address)

Arguments

Name

Type

Description

balanceOfAt

Queries balances as of a defined checkpoint

function balanceOfAt(address _investor, uint256 _checkpointId) public view
returns(uint256)

Arguments

Name

Type

Description

_investor

address

Investor to query balance for

_checkpointId

uint256

Checkpoint ID to query as of

totalSupplyAt

Queries totalSupply as of a defined checkpoint

function totalSupplyAt(uint256 _checkpointId) external view
returns(uint256)

Returns

uint256

Arguments

Name

Type

Description

_checkpointId

uint256

Checkpoint ID to query

iterateInvestors

generates subset of investors NB - can be used in batches if investor list is large. start and end both are included in array.

function iterateInvestors(uint256 _start, uint256 _end) external view
returns(address[])

Returns

list of investors

Arguments

Name

Type

Description

_start

uint256

Position of investor to start iteration from

_end

uint256

Position of investor to stop iteration at

checkPermission

Validate permissions with PermissionManager if it exists, If no Permission return false

function checkPermission(address _delegate, address _module, bytes32 _perm) public view
returns(bool)

Returns

success

Arguments

Name

Type

Description

_delegate

address

address of delegate

_module

address

address of PermissionManager module

_perm

bytes32

the permissions

isOperator

Determines whether _operator is an operator for all partitions of _tokenHolder

function isOperator(address _operator, address _tokenHolder) external view
returns(bool)

Returns

Whether the _operator is an operator for all partitions of _tokenHolder

Arguments

Name

Type

Description

_operator

address

The operator to check

_tokenHolder

address

The token holder to check

isOperatorForPartition

Determines whether _operator is an operator for a specified partition of _tokenHolder

function isOperatorForPartition(bytes32 _partition, address _operator, address _tokenHolder) external view
returns(bool)

Returns

Whether the _operator is an operator for a specified partition of _tokenHolder

Arguments

Name

Type

Description

_partition

bytes32

The partition to check

_operator

address

The operator to check

_tokenHolder

address

The token holder to check

partitionsOf

Return all partitions

function partitionsOf(address ) external pure
returns(bytes32[])

Returns

List of partitions

Arguments

Name

Type

Description

address

getVersion

Returns the version of the SecurityToken

function getVersion() external view
returns(uint8[])

Arguments

Name

Type

Description

getDocument

Used to return the details of a document with a known name (bytes32).

function getDocument(bytes32 _name) external view
returns(string, bytes32, uint256)

Returns

string The URI associated with the document.

Arguments

Name

Type

Description

_name

bytes32

Name of the document

getAllDocuments

Used to retrieve a full list of documents attached to the smart contract.

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

Returns

bytes32 List of all documents names present in the contract.

Arguments

Name

Type

Description

contracts/tokens/STGetter.sol
OZStorage
SecurityTokenStorage
MockSTGetter
isIssuable()
getCheckpointTimes()
getInvestorCount()
getInvestors()
getInvestorsAt(uint256 _checkpointId)
getInvestorsSubsetAt(uint256 _checkpointId, uint256 _start, uint256 _end)
getModule(address _module)
getModulesByName(bytes32 _name)
getModulesByType(uint8 _type)
getTreasuryWallet()
balanceOfAt(address _investor, uint256 _checkpointId)
totalSupplyAt(uint256 _checkpointId)
iterateInvestors(uint256 _start, uint256 _end)
checkPermission(address _delegate, address _module, bytes32 _perm)
isOperator(address _operator, address _tokenHolder)
isOperatorForPartition(bytes32 _partition, address _operator, address _tokenHolder)
partitionsOf(address )
getVersion()
getDocument(bytes32 _name)
getAllDocuments()