fix: cappedSTO example issues full overhaul with token purchase

Author: Victor Wiebe

examples/cappedSTO.ts

@@ -1,8 +1,7 @@
 import { RedundantSubprovider, RPCSubprovider, Web3ProviderEngine } from '@0x/subproviders';
-import { ModuleRegistryEvents, BigNumber } from '@polymathnetwork/abi-wrappers';
+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 { bytes32ToString } from '../src/utils/convert';
 import { FundRaiseType, 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)
@@ -20,9 +19,46 @@ window.addEventListener('load', async () => {
   // Instantiate the API
   const polymathAPI = new PolymathAPI(params);
 
-  const ticker = 'TEST';
-  const tokenAddress = await polymathAPI.securityTokenRegistry.getSecurityTokenAddress(ticker);
-  const TEST = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromAddress(tokenAddress);
+  // Get some poly tokens in your account and the security token
+  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', '');
+  const tokenName = prompt('Token Name', '');
+
+  // Double check available
+  await polymathAPI.securityTokenRegistry.isTickerAvailable({
+    ticker: ticker!,
+  });
+  // Get the ticker fee and approve the security token registry to spend
+  const tickerFee = await polymathAPI.securityTokenRegistry.getTickerRegistrationFee();
+  await polymathAPI.polyToken.approve({
+    spender: await polymathAPI.securityTokenRegistry.address(),
+    value: tickerFee,
+  });
+  // Register a ticker
+  await polymathAPI.securityTokenRegistry.registerTicker({
+    ticker: ticker!,
+    tokenName: tokenName!,
+  });
+  // Get the st launch fee and approve the security token registry to spend
+  const securityTokenLaunchFee = await polymathAPI.securityTokenRegistry.getSecurityTokenLaunchFee();
+  await polymathAPI.polyToken.approve({
+    spender: await polymathAPI.securityTokenRegistry.address(),
+    value: securityTokenLaunchFee,
+  });
+
+  await polymathAPI.securityTokenRegistry.generateNewSecurityToken({
+    name: tokenName!,
+    ticker: ticker!,
+    tokenDetails: 'details',
+    divisible: true,
+    treasuryWallet: myAddress,
+    protocolVersion: '0',
+  });
+
+  console.log('Security Token Generated');
 
   const moduleStringName = 'CappedSTO';
   const moduleName = ModuleName.CappedSTO;
@@ -43,17 +79,16 @@ window.addEventListener('load', async () => {
   });
   const resultNames = await Promise.all(names);
 
-  const finalNames = resultNames.map(name => {
-    return bytes32ToString(name);
-  });
-  const index = finalNames.indexOf(moduleStringName);
+  const index = resultNames.indexOf(moduleStringName);
 
+  // Create a Security Token Instance
+  const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);
   const factory = await polymathAPI.moduleFactory.getModuleFactory(modules[index]);
   const setupCost = await factory.setupCostInPoly();
 
   // Get some poly tokens on the security token instance
   await polymathAPI.polyToken.transfer({
-    to: await TEST.address(),
+    to: await tickerSecurityTokenInstance.address(),
     value: setupCost,
   });
 
@@ -69,21 +104,72 @@ window.addEventListener('load', async () => {
     },
   });
 
-  await TEST.addModule({
+  // Get General TM Address to whitelist transfers
+  const generalTMAddress = (await tickerSecurityTokenInstance.getModulesByName({
+    moduleName: ModuleName.GeneralTransferManager,
+  }))[0];
+  const generalTM = await polymathAPI.moduleFactory.getModuleInstance({
+    name: ModuleName.GeneralTransferManager,
+    address: generalTMAddress,
+  });
+
+  await generalTM.modifyKYCData({
+    investor: myAddress,
+    canSendAfter: new Date(),
+    canReceiveAfter: new Date(),
+    expiryTime: new Date(2020, 0),
+    txData: {
+      from: await polymathAPI.getAccount(),
+    },
+  });
+
+  const startTime = new Date(Date.now() + 10000);
+  await tickerSecurityTokenInstance.addModule({
     moduleName,
     address: modules[index],
     maxCost: setupCost,
     budget: setupCost,
     archived: false,
     data: {
-      startTime: new Date(),
-      endTime: new Date(2025, 8),
+      startTime,
+      endTime: new Date(2031, 1),
       cap: new BigNumber(10),
       rate: new BigNumber(10),
       fundRaiseType: FundRaiseType.ETH.valueOf(),
       fundsReceiver: await polymathAPI.getAccount(),
     },
   });
 
-  TEST.unsubscribeAll();
+  const cappedSTOAddress = (await tickerSecurityTokenInstance.getModulesByName({
+    moduleName: ModuleName.CappedSTO,
+  }))[0];
+
+  const cappedSTO = await polymathAPI.moduleFactory.getModuleInstance({
+    name: ModuleName.CappedSTO,
+    address: cappedSTOAddress,
+  });
+
+  const sleep = (milliseconds: number) => {
+    console.log('Sleeping until the STO starts');
+    return new Promise(resolve => setTimeout(resolve, milliseconds));
+  };
+  await sleep(10000);
+
+  // Subscribe to event of update dividend dates
+  await cappedSTO.subscribeAsync({
+    eventName: CappedSTOEvents.TokenPurchase,
+    indexFilterValues: {},
+    callback: async (error, log) => {
+      if (error) {
+        console.log(error);
+      } else {
+        console.log('Token Purchased!', log);
+      }
+    },
+  });
+
+  await cappedSTO.buyTokens({ beneficiary: await polymathAPI.getAccount(), value: new BigNumber(1) });
+  console.log('Buy Tokens has been called');
+
+  tickerSecurityTokenInstance.unsubscribeAll();
 });