fix: examples sto, dividends review issues

Author: Victor Wiebe

examples/cappedSTO.ts

@@ -2,7 +2,7 @@ import { RedundantSubprovider, RPCSubprovider, Web3ProviderEngine } from '@0x/su
 import { ModuleRegistryEvents, BigNumber, CappedSTOEvents } from '@polymathnetwork/abi-wrappers';
 import ModuleFactoryWrapper from '../src/contract_wrappers/modules/module_factory_wrapper';
 import { ApiConstructorParams, PolymathAPI } from '../src/PolymathAPI';
-import { FundRaiseType, ModuleName, ModuleType } from '../src';
+import { CappedSTOFundRaiseType, ModuleName, ModuleType } from '../src';
 
 // This file acts as a valid sandbox.ts file in root directory for adding a cappedSTO module on an unlocked node (like ganache)
 
@@ -60,7 +60,6 @@ window.addEventListener('load', async () => {
 
   console.log('Security Token Generated');
 
-  const moduleStringName = 'CappedSTO';
   const moduleName = ModuleName.CappedSTO;
 
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
@@ -79,7 +78,7 @@ window.addEventListener('load', async () => {
   });
   const resultNames = await Promise.all(names);
 
-  const index = resultNames.indexOf(moduleStringName);
+  const index = resultNames.indexOf(moduleName);
 
   // Create a Security Token Instance
   const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);
@@ -104,7 +103,7 @@ window.addEventListener('load', async () => {
     },
   });
 
-  // Get General TM Address to whitelist transfers
+  // Get General Transfer Manager to whitelist an address to buy tokens
   const generalTMAddress = (await tickerSecurityTokenInstance.getModulesByName({
     moduleName: ModuleName.GeneralTransferManager,
   }))[0];
@@ -135,7 +134,7 @@ window.addEventListener('load', async () => {
       endTime: new Date(2031, 1),
       cap: new BigNumber(10),
       rate: new BigNumber(10),
-      fundRaiseType: FundRaiseType.ETH.valueOf(),
+      fundRaiseType: CappedSTOFundRaiseType.ETH,
       fundsReceiver: await polymathAPI.getAccount(),
     },
   });
@@ -155,7 +154,7 @@ window.addEventListener('load', async () => {
   };
   await sleep(10000);
 
-  // Subscribe to event of update dividend dates
+  // Subscribe to event of token purchase
   await cappedSTO.subscribeAsync({
     eventName: CappedSTOEvents.TokenPurchase,
     indexFilterValues: {},

examples/erc20Dividend.ts

@@ -4,7 +4,7 @@ import { ApiConstructorParams, PolymathAPI } from '../src/PolymathAPI';
 import { ModuleName, ModuleType } from '../src';
 import ModuleFactoryWrapper from '../src/contract_wrappers/modules/module_factory_wrapper';
 
-// This file acts as a valid sandbox for adding a erc20Dividend  module on an unlocked node (like ganache)
+// This file acts as a valid sandbox for adding a erc20Dividend module on an unlocked node (like ganache)
 
 window.addEventListener('load', async () => {
   // Setup the redundant provider
@@ -62,7 +62,6 @@ window.addEventListener('load', async () => {
   // Create a Security Token Instance
   const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);
 
-  const moduleStringName = 'ERC20DividendCheckpoint';
   const moduleName = ModuleName.ERC20DividendCheckpoint;
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
     moduleType: ModuleType.Dividends,
@@ -78,13 +77,13 @@ window.addEventListener('load', async () => {
     names.push(instanceFactory.name());
   });
   const resultNames = await Promise.all(names);
-  const index = resultNames.indexOf(moduleStringName);
+  const index = resultNames.indexOf(moduleName);
 
   // Get setup cost
   const factory = await polymathAPI.moduleFactory.getModuleFactory(modules[index]);
   const setupCost = await factory.setupCostInPoly();
 
-  // Call to add etherdividend module
+  // Call to add erc20 dividend module
   await tickerSecurityTokenInstance.addModule({
     moduleName,
     address: modules[index],
@@ -96,7 +95,7 @@ window.addEventListener('load', async () => {
     },
   });
 
-  // Get module for ether dividend checkpoint and address for module
+  // Get module for erc20 dividend checkpoint and address for module
   const erc20DividendAddress = (await tickerSecurityTokenInstance.getModulesByName({
     moduleName: ModuleName.ERC20DividendCheckpoint,
   }))[0];
@@ -115,24 +114,6 @@ window.addEventListener('load', async () => {
     address: generalTMAddress,
   });
 
-  // Add owner address in the whitelist to allow issue tokens
-  await generalTM.modifyKYCData({
-    investor: myAddress,
-    canSendAfter: new Date(),
-    canReceiveAfter: new Date(),
-    expiryTime: new Date(2020, 0),
-    txData: {
-      from: await polymathAPI.getAccount(),
-    },
-  });
-
-  // Mint yourself some tokens and make some transfers
-  await tickerSecurityTokenInstance.issue({
-    investor: myAddress,
-    value: new BigNumber(50),
-    data: '0x00',
-  });
-
   await polymathAPI.polyToken.approve({
     spender: erc20DividendAddress,
     value: new BigNumber(4),
@@ -152,11 +133,14 @@ window.addEventListener('load', async () => {
     expiryTime: [new Date(2020, 0), new Date(2020, 0), new Date(2020, 0)],
   });
 
-  await tickerSecurityTokenInstance.transfer({ to: randomInvestors[0], value: new BigNumber(10) });
-  await tickerSecurityTokenInstance.transfer({ to: randomInvestors[1], value: new BigNumber(20) });
-  await tickerSecurityTokenInstance.transfer({ to: randomInvestors[2], value: new BigNumber(20) });
+  // Mint yourself some tokens and make some transfers
+  await tickerSecurityTokenInstance.issueMulti({
+    investors: randomInvestors,
+    values: [new BigNumber(10), new BigNumber(20), new BigNumber(20)],
+  });
 
   // Create Dividends
+  // A checkpoint is created behind the scenes
   await erc20DividendCheckpoint.createDividendWithExclusions({
     name: 'MyDividend1',
     amount: new BigNumber(1),
@@ -166,9 +150,10 @@ window.addEventListener('load', async () => {
     excluded: [randomInvestors[1], randomInvestors[2]],
   });
 
-  // Create a checkpoint
+  // Create another checkpoint
   await tickerSecurityTokenInstance.createCheckpoint({});
 
+  // Using the most recent checkpoint
   await erc20DividendCheckpoint.createDividendWithCheckpointAndExclusions({
     name: 'MyDividend2',
     amount: new BigNumber(1),
@@ -187,13 +172,14 @@ window.addEventListener('load', async () => {
     maturity: new Date(2018, 1),
   });
 
+  // Another checkpoint was created behind the scenes
   await erc20DividendCheckpoint.createDividendWithCheckpoint({
     name: 'MyDividend4',
     amount: new BigNumber(1),
     token: await polymathAPI.polyToken.address(),
     expiry: new Date(2035, 2),
     maturity: new Date(2018, 1),
-    checkpointId: 1,
+    checkpointId: 2,
   });
 
   console.log('4 types of erc20 dividends created');

examples/etherDividend.ts

@@ -1,11 +1,10 @@
 import { RedundantSubprovider, RPCSubprovider, Web3ProviderEngine } from '@0x/subproviders';
 import { EtherDividendCheckpointEvents, BigNumber } from '@polymathnetwork/abi-wrappers';
 import { ApiConstructorParams, PolymathAPI } from '../src/PolymathAPI';
-import { bytes32ToString } from '../src/utils/convert';
 import { ModuleName, ModuleType } from '../src';
 import ModuleFactoryWrapper from '../src/contract_wrappers/modules/module_factory_wrapper';
 
-// This file acts as a valid sandbox for adding a etherDividend  module on an unlocked node (like ganache)
+// This file acts as a valid sandbox for adding a etherDividend module on an unlocked node (like ganache)
 
 window.addEventListener('load', async () => {
   // Setup the redundant provider
@@ -21,7 +20,7 @@ window.addEventListener('load', async () => {
   const polymathAPI = new PolymathAPI(params);
 
   // Get some poly tokens in your account and the security token
-  const myAddress = (await polymathAPI.getAccount()).toLowerCase();
+  const myAddress = await polymathAPI.getAccount();
   await polymathAPI.getPolyTokens({ amount: new BigNumber(1000000), address: myAddress });
   // Prompt to setup your ticker and token name
   const ticker = prompt('Ticker', '');
@@ -68,7 +67,6 @@ window.addEventListener('load', async () => {
   // Create a Security Token Instance
   const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);
 
-  const moduleStringName = 'EtherDividendCheckpoint';
   const moduleName = ModuleName.EtherDividendCheckpoint;
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
     moduleType: ModuleType.Dividends,
@@ -85,7 +83,7 @@ window.addEventListener('load', async () => {
     names.push(instanceFactory.name());
   });
   const resultNames = await Promise.all(names);
-  const index = resultNames.indexOf(moduleStringName);
+  const index = resultNames.indexOf(moduleName);
 
   // Get setup cost
   const factory = await polymathAPI.moduleFactory.getModuleFactory(modules[index]);
@@ -159,6 +157,7 @@ window.addEventListener('load', async () => {
   await tickerSecurityTokenInstance.transfer({ to: randomInvestors[2], value: new BigNumber(20) });
 
   // Create Dividends
+  // A checkpoint is created behind the scenes.
   await etherDividendCheckpoint.createDividendWithExclusions({
     name: 'MyDividend1',
     value: new BigNumber(1),
@@ -167,9 +166,10 @@ window.addEventListener('load', async () => {
     excluded: [randomInvestors[1], randomInvestors[2]],
   });
 
-  // Create a checkpoint
+  // Create another checkpoint
   await tickerSecurityTokenInstance.createCheckpoint({});
 
+  // Using the most recent checkpoint
   await etherDividendCheckpoint.createDividendWithCheckpointAndExclusions({
     name: 'MyDividend2',
     value: new BigNumber(1),
@@ -186,12 +186,13 @@ window.addEventListener('load', async () => {
     maturity: new Date(2018, 1),
   });
 
+  // Another checkpoint was created behind the scenes.
   await etherDividendCheckpoint.createDividendWithCheckpoint({
     name: 'MyDividend4',
     value: new BigNumber(1),
     expiry: new Date(2035, 2),
     maturity: new Date(2018, 1),
-    checkpointId: 1,
+    checkpointId: 2,
   });
 
   console.log('4 types of ether dividends created');

examples/usdTieredSTO.ts

@@ -58,7 +58,6 @@ window.addEventListener('load', async () => {
     protocolVersion: '0',
   });
 
-  const moduleStringName = 'USDTieredSTO';
   const moduleName = ModuleName.UsdTieredSTO;
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
     moduleType: ModuleType.STO,
@@ -76,7 +75,7 @@ window.addEventListener('load', async () => {
   });
   const resultNames = await Promise.all(names);
 
-  const index = resultNames.indexOf(moduleStringName);
+  const index = resultNames.indexOf(moduleName);
 
   // Create a Security Token Instance
   const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);
@@ -88,7 +87,7 @@ window.addEventListener('load', async () => {
     value: setupCost,
   });
 
-  // Get General TM Address to whitelist transfers
+  // Get General Transfer Manager to whitelist an address to buy tokens
   const generalTMAddress = (await tickerSecurityTokenInstance.getModulesByName({
     moduleName: ModuleName.GeneralTransferManager,
   }))[0];
@@ -138,7 +137,7 @@ window.addEventListener('load', async () => {
     address: usdTieredAddress,
   });
 
-  // Subscribe to event of update dividend dates
+  // Subscribe to event for setTiers
   await usdTiered.subscribeAsync({
     eventName: USDTieredSTOEvents.SetTiers,
     indexFilterValues: {},
@@ -151,7 +150,7 @@ window.addEventListener('load', async () => {
     },
   });
 
-  // Update dividend dates
+  // Update USDTiered STO Tiers
   await usdTiered.modifyTiers({
     ratePerTier: [new BigNumber(5), new BigNumber(5)],
     ratePerTierDiscountPoly: [new BigNumber(4), new BigNumber(4)],
@@ -161,11 +160,11 @@ window.addEventListener('load', async () => {
 
   const sleep = (milliseconds: number) => {
     console.log('Sleeping until the STO starts');
-    return new Promise(resolve => setTimeout(resolve, milliseconds))
+    return new Promise(resolve => setTimeout(resolve, milliseconds));
   };
   await sleep(10000);
 
-  // Subscribe to event of update dividend dates
+  // Subscribe to event for token purchase
   await usdTiered.subscribeAsync({
     eventName: USDTieredSTOEvents.TokenPurchase,
     indexFilterValues: {},