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
  • Summary:
  • How it works
  • How to Use this CLI Feature (Instructions)
  • Example Scenario:

Was this helpful?

  1. wiki

Contract-Manager

Summary:

This CLI feature allows you to run the contract_manager to manage all the details surrounding Polymath, Features, Security Token and Module registries.

How it works

The Contract Manager allows you to modify the following areas:

  • [1] PolymathRegistry

  • [2] FeatureRegistry

  • [3] SecurityTokenRegistry

  • [4] ModuleRegistry

**Note: Currently options [1], [2] and [4] are under development.

However,[3] Security Token Registry can be run. It handles the following:

  • [1] Modify Ticker

  • [2] Remove Ticker

  • [3] Modify SecurityToken

  • [4] Change Expiry Limit

  • [5] Change registration fee

  • [6] Change ST launch fee

  • [0] CANCEL

How to Use this CLI Feature (Instructions)

To start, run either of the following commands:

 $ node CLI/polymath-cli cm  or   $ node CLI/polymath-cli contract_manager

Example Scenario:

*********************************************
Welcome to the Command-Line Contract Manager.
*********************************************

Issuer Account: 0x23f95b881149018E3240A6c98d4Ec3A111aDc5DF


Contract Manager - Contract selection

[1] PolymathRegistry
[2] FeatureRegistry
[3] SecurityTokenRegistry
[4] ModuleRegistry
[0] CANCEL

Select a contract [1...4 / 0]:

NOTE: Option [1], [2] and [4] are not yet available.

Begin with Option [3]

Select a contract [1...4 / 0]: 3

Security Token Registry - Main menu

[1] Modify Ticker
[2] Remove Ticker
[3] Modify SecurityToken
[4] Change Expiry Limit
[5] Change registration fee
[6] Change ST launch fee
[0] CANCEL

What do you want to do? [1...6 / 0]:

Choosing the MODIFYING TICKER option:

What do you want to do? [1...6 / 0]: 1

Enter the token symbol that you want to add or modify: LFV

-- Current Ticker details --
  Owner: 0x23f95b881149018E3240A6c98d4Ec3A111aDc5DF
  Registration date: 1539272399
  Expiry date: 1544456399
  Token name: 
  Status: Deployed

Before you choose to modify anything with respect to your token it gives you your current token/ticker details

Enter the token owner: 0x23f95b881149018E3240A6c98d4Ec3A111aDc5DF
Enter the token name: Leaf Ventures

Enter the Unix Epoch time on which ticker get registered: 1539272808
Enter the Unix Epoch time on wich the ticker will expire: 1541864766
Is the token deployed? [y/n]: y

Above you need to confirm the token owner address, the token name, the your ticker was registered, the date in which the ticker will expire and answer if the token has been deployed yet.

---- Transaction executed: modifyTicker - Gas limit provided: 205029 ----

  Your transaction is being processed. Please wait...
  TxHash: 0x86a6fe1bb8e78dd759feb28d4067b9aa4ddcb2a13b7c53c4fd5eeb87ea6c5159

  Congratulations! The transaction was successfully completed.
  Gas used: 121686 - Gas spent: 0.0060843 Ether
  Review it on Etherscan.
  TxHash: 0x86a6fe1bb8e78dd759feb28d4067b9aa4ddcb2a13b7c53c4fd5eeb87ea6c5159

Ticker has been updated successfully

We now need to return to the main menu and select the Security Token Registry option again:

[1] PolymathRegistry
[2] FeatureRegistry
[3] SecurityTokenRegistry
[4] ModuleRegistry
[0] CANCEL

Select a contract [1...4 / 0]: 3

Security Token Registry - Main menu

[1] Modify Ticker
[2] Remove Ticker
[3] Modify SecurityToken
[4] Change Expiry Limit
[5] Change registration fee
[6] Change ST launch fee
[0] CANCEL

Choosing the REMOVING TICKER option:

What do you want to do? [1...6 / 0]: 2

Enter the token symbol that you want to remove: LFV

Selecting a previous token symbol that we registered so that we don’t have to remove the LFV token that we will be using for the rest of the walkthroughs

---- Transaction executed: removeTicker - Gas limit provided: 428439 ----

  Your transaction is being processed. Please wait...
  TxHash: 0x45862377d36dc35709b723028cef7c00f03f5760a28454c40abb7dd1bf0b0c18

  Congratulations! The transaction was successfully completed.
  Gas used: 52813 - Gas spent: 0.00264065 Ether
  Review it on Etherscan.
  TxHash: 0x45862377d36dc35709b723028cef7c00f03f5760a28454c40abb7dd1bf0b0c18

Ticker has been removed successfully

We now need to return to the main menu and select the Security Token Registry option again

Choosing the MODIFY SECURITY TOKEN option:

What do you want to do? [1...6 / 0]: 3
Enter the security token address that you want to add or modify: 0xE447e88c37017550a9f85511cDaAEbC9529e845b

Chose the contract address of the LFV security token we created earlier (should be in your token details above):

-- Current Security Token data --
  Ticker: LFV
  Token details: 
  Deployed at: 1539272653
-- Current Ticker details --
  Owner: 0x23f95b881149018E3240A6c98d4Ec3A111aDc5DF
  Token name: Leaf Ventures

Enter the token name: LFV
Enter the token owner: 0x23f95b881149018E3240A6c98d4Ec3A111aDc5DF
Enter the token details: 
Enter the Unix Epoch timestamp at which security token was deployed: 1539272808
---- Transaction executed: modifySecurityToken - Gas limit provided: 232848 ----

Entering my token information that can be found in your terminal command information from when you originally

  Your transaction is being processed. Please wait...
  TxHash: 0xfb5703852b1bc7c292c91e3f44155ee3bf74d885039052eb2885ec0b189988d6

  Congratulations! The transaction was successfully completed.
  Gas used: 140232 - Gas spent: 0.0070116 Ether
  Review it on Etherscan.
  TxHash: 0xfb5703852b1bc7c292c91e3f44155ee3bf74d885039052eb2885ec0b189988d6

Security Token has been updated successfully

Choosing CHANGE EXPIRY DATE the option:

What do you want to do? [1...6 / 0]: 4
Current expiry limit is 60 days
Enter a new value in days for expiry limit: 70

---- Transaction executed: changeExpiryLimit - Gas limit provided: 38071 ----

You can change the expiry date to whatever amount of days that you see fit

  Your transaction is being processed. Please wait...
  TxHash: 0x10b9958cad8e3a661ed149897efd6b789a8e59108af5a040dad2934aaf6a6afc

  Congratulations! The transaction was successfully completed.
  Gas used: 31726 - Gas spent: 0.0015863 Ether
  Review it on Etherscan.
  TxHash: 0x10b9958cad8e3a661ed149897efd6b789a8e59108af5a040dad2934aaf6a6afc

Expiry limit was changed successfully. New limit is 70 days

Choosing the CHANGE REGISTRATION FEE option

What do you want to do? [1...6 / 0]: 5

Current ticker registration fee is 250 POLY
Enter a new value in POLY for ticker registration fee: 255


---- Transaction executed: changeTickerRegistrationFee - Gas limit provided: 38900 ----

As the manager you can change the ticker registration fee whatever amount of POLY you see fit

  Your transaction is being processed. Please wait...
  TxHash: 0x3877f387e2e5683be0a410940a20d1a25f521eee9ab5c96416459331f20a574e

  Congratulations! The transaction was successfully completed.
  Gas used: 32417 - Gas spent: 0.00162085 Ether
  Review it on Etherscan.
  TxHash: 0x3877f387e2e5683be0a410940a20d1a25f521eee9ab5c96416459331f20a574e

Fee was changed successfully. New fee is 255 POLY

Choosing the CHANGE STO LAUNCH FEE option

What do you want to do? [1...6 / 0]: 6

Current ST launch fee is 250 POLY
Enter a new value in POLY for ST launch fee: 255

You can change the STO launch fee here. As you can see we increased the 250 fee to 255 for this example.

---- Transaction executed: changeSecurityLaunchFee - Gas limit provided: 38663 ----

  Your transaction is being processed. Please wait...
  TxHash: 0xbbe59445c5f22e621594989840ea17137a049a72ae2a49ab94a802762271ed0e

  Congratulations! The transaction was successfully completed.
  Gas used: 32219 - Gas spent: 0.00161095 Ether
  Review it on Etherscan.
  TxHash: 0xbbe59445c5f22e621594989840ea17137a049a72ae2a49ab94a802762271ed0e

Fee was changed successfully. New fee is 255 POLY

Troubleshooting / FAQs

NOTE: Option [1], [2] and [4] are not yet available.

PreviousUSDTieredSTONextVesting-Escrow-Wallet

Last updated 5 years ago

Was this helpful?