fix: outstanding naming and method argument naming on examples

Author: Victor Wiebe

examples/cappedSTO.ts

@@ -26,7 +26,7 @@ window.addEventListener('load', async () => {
   const TEST = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromAddress(tokenAddress);
 
   const moduleStringName = 'CappedSTO';
-  const moduleName = ModuleName.cappedSTO;
+  const moduleName = ModuleName.CappedSTO;
 
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
     moduleType: ModuleType.TransferManager,

examples/investInCappedSTO.ts

@@ -23,15 +23,15 @@ window.addEventListener('load', async () => {
   const tokenAddress = await polymathAPI.securityTokenRegistry.getSecurityTokenAddress(ticker);
   const TEST = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromAddress(tokenAddress);
 
-  const cappedSTOAddress = (await TEST.getModulesByName({ moduleName: ModuleName.cappedSTO }))[0];
+  const cappedSTOAddress = (await TEST.getModulesByName({ moduleName: ModuleName.CappedSTO }))[0];
   const cappedSTO = await polymathAPI.moduleFactory.getModuleInstance({
-    name: ModuleName.cappedSTO,
+    name: ModuleName.CappedSTO,
     address: cappedSTOAddress,
   });
 
-  const generalTMAddress = (await TEST.getModulesByName({ moduleName: ModuleName.generalTransferManager }))[0];
+  const generalTMAddress = (await TEST.getModulesByName({ moduleName: ModuleName.GeneralTransferManager }))[0];
   const generalTM = await polymathAPI.moduleFactory.getModuleInstance({
-    name: ModuleName.generalTransferManager,
+    name: ModuleName.GeneralTransferManager,
     address: generalTMAddress,
   });
 

examples/mintTokenToInvestor.ts

@@ -23,7 +23,7 @@ window.addEventListener('load', async () => {
   const tokenAddress = await polymathAPI.securityTokenRegistry.getSecurityTokenAddress(ticker);
   const TEST = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromAddress(tokenAddress);
   const investorAddress = '<investor address>'.toLowerCase();
-  const generalTMAddress = (await TEST.getModulesByName({ moduleName: ModuleName.generalTransferManager }))[0];
+  const generalTMAddress = (await TEST.getModulesByName({ moduleName: ModuleName.GeneralTransferManager }))[0];
 
   const generalTM = await polymathAPI.moduleFactory.getModuleInstance({
     name: ModuleName.GeneralTransferManager,

examples/percentageTransferManager.ts

@@ -22,7 +22,7 @@ window.addEventListener('load', async () => {
   const ticker = 'TEST';
   const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker);
   const moduleStringName = 'PercentageTransferManager';
-  const moduleName = ModuleName.percentageTransferManager;
+  const moduleName = ModuleName.PercentageTransferManager;
 
   // Get permission manager factory address
   const modules = await polymathAPI.moduleRegistry.getModulesByType({

examples/usdTieredSTO.ts

@@ -62,7 +62,7 @@ window.addEventListener('load', async () => {
   });
 
   const moduleStringName = 'USDTieredSTO';
-  const moduleName = ModuleName.usdTieredSTO;
+  const moduleName = ModuleName.UsdTieredSTO;
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
     moduleType: ModuleType.STO,
   });
@@ -113,17 +113,17 @@ window.addEventListener('load', async () => {
       minimumInvestmentUSD: new BigNumber(5),
       fundRaiseTypes: [FundRaiseType.ETH, FundRaiseType.POLY],
       wallet: '0x3333333333333333333333333333333333333333',
-      reserveWallet: '0x5555555555555555555555555555555555555555',
+      treasuryWallet: '0x5555555555555555555555555555555555555555',
       usdTokens: ['0x6666666666666666666666666666666666666666', '0x4444444444444444444444444444444444444444'],
     },
   });
   console.log(usdTieredResult);
 
   const usdTieredAddress = (await tickerSecurityTokenInstance.getModulesByName({
-    moduleName: ModuleName.usdTieredSTO,
+    moduleName: ModuleName.UsdTieredSTO,
   }))[0];
   const usdTiered = await polymathAPI.moduleFactory.getModuleInstance({
-    name: ModuleName.usdTieredSTO,
+    name: ModuleName.UsdTieredSTO,
     address: usdTieredAddress,
   });
   const buyWithETH = await usdTiered.buyWithETH({ value: new BigNumber(1), beneficiary: myAddress });

examples/volumeRestrictionTransferManager.ts

@@ -4,7 +4,7 @@ import { VolumeRestrictionTMEvents } 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 { ModuleName, ModuleType, RestrictionTypes } from '../src';
+import { ModuleName, ModuleType, RestrictionType } from '../src';
 
 // This file acts as a valid sandbox for using a volume restriction transfer manager module on an unlocked node (like ganache)
 
@@ -67,7 +67,7 @@ window.addEventListener('load', async () => {
 
   // Get sto factory address
   const moduleStringName = 'VolumeRestrictionTM';
-  const moduleName = ModuleName.volumeRestrictionTM;
+  const moduleName = ModuleName.VolumeRestrictionTM;
 
   const modules = await polymathAPI.moduleRegistry.getModulesByType({
     moduleType: ModuleType.TransferManager,
@@ -104,25 +104,25 @@ window.addEventListener('load', async () => {
 
   // Get Count TM address and create count transfer manager
   const vrtmAddress = (await tickerSecurityTokenInstance.getModulesByName({
-    moduleName: ModuleName.volumeRestrictionTM,
+    moduleName: ModuleName.VolumeRestrictionTM,
   }))[0];
   const vrtm = await polymathAPI.moduleFactory.getModuleInstance({
-    name: ModuleName.volumeRestrictionTM,
+    name: ModuleName.VolumeRestrictionTM,
     address: vrtmAddress,
   });
 
   // Get General TM Address and allow all transfers so we can test unlocked account transfers
   const generalTMAddress = (await tickerSecurityTokenInstance.getModulesByName({
-    moduleName: ModuleName.generalTransferManager,
+    moduleName: ModuleName.GeneralTransferManager,
   }))[0];
   const generalTM = await polymathAPI.moduleFactory.getModuleInstance({
-    name: ModuleName.generalTransferManager,
+    name: ModuleName.GeneralTransferManager,
     address: generalTMAddress,
   });
   await generalTM.changeAllowAllTransfers({ allowAllTransfers: true });
 
   // Mint yourself some tokens and make some transfers
-  await tickerSecurityTokenInstance.mint({ investor: myAddress, value: new BigNumber(1000) });
+  await tickerSecurityTokenInstance.issue({ investor: myAddress, value: new BigNumber(1000), data: '' });
 
   // VRTM
   const delay = 3000;
@@ -149,7 +149,7 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 1),
     rollingPeriodInDays: 1,
-    restrictionType: RestrictionTypes.Fixed,
+    restrictionType: RestrictionType.Fixed,
     allowedTokens: new BigNumber(10),
   });
   // Transfer
@@ -160,12 +160,12 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 1),
     allowedTokens: new BigNumber(50),
-    restrictionType: RestrictionTypes.Percentage,
+    restrictionType: RestrictionType.Percentage,
   });
   await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary2, value: new BigNumber(20) });
   // Remove
   await vrtm.removeIndividualDailyRestriction({
-    holder: myAddress,
+    investor: myAddress,
   });
 
   // Add individual restriction
@@ -174,7 +174,7 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 1),
     allowedTokens: new BigNumber(20),
-    restrictionType: RestrictionTypes.Fixed,
+    restrictionType: RestrictionType.Fixed,
     rollingPeriodInDays: 2,
   });
   // Modify individual restriction
@@ -183,14 +183,14 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 2),
     allowedTokens: new BigNumber(25),
-    restrictionType: RestrictionTypes.Fixed,
+    restrictionType: RestrictionType.Fixed,
     rollingPeriodInDays: 2,
   });
   // Transfer
   await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary1, value: new BigNumber(15) });
   // Remove
   await vrtm.removeIndividualRestriction({
-    holder: randomBeneficiary1,
+    investor: randomBeneficiary1,
   });
 
   // Add Individual Daily Restriction Multi
@@ -199,7 +199,7 @@ window.addEventListener('load', async () => {
     startTimes: [new Date(Date.now().valueOf() + delay), new Date(Date.now().valueOf() + delay)],
     endTimes: [new Date(2035, 1), new Date(2035, 1)],
     allowedTokens: [new BigNumber(20), new BigNumber(20)],
-    restrictionTypes: [RestrictionTypes.Fixed, RestrictionTypes.Fixed],
+    restrictionTypes: [RestrictionType.Fixed, RestrictionType.Fixed],
   });
   // Transfers
   await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary1, value: new BigNumber(10) });
@@ -210,7 +210,7 @@ window.addEventListener('load', async () => {
     startTimes: [new Date(Date.now().valueOf() + delay), new Date(Date.now().valueOf() + delay)],
     endTimes: [new Date(2035, 2), new Date(2035, 2)],
     allowedTokens: [new BigNumber(30), new BigNumber(30)],
-    restrictionTypes: [RestrictionTypes.Fixed, RestrictionTypes.Fixed],
+    restrictionTypes: [RestrictionType.Fixed, RestrictionType.Fixed],
   });
   // Remove Individual Daily Restriction Multi
   await vrtm.removeIndividualDailyRestrictionMulti({ holders: [myAddress, randomBeneficiary2] });
@@ -221,7 +221,7 @@ window.addEventListener('load', async () => {
     startTimes: [new Date(Date.now().valueOf() + delay), new Date(Date.now().valueOf() + delay)],
     endTimes: [new Date(2035, 1), new Date(2035, 1)],
     allowedTokens: [new BigNumber(20), new BigNumber(20)],
-    restrictionTypes: [RestrictionTypes.Fixed, RestrictionTypes.Fixed],
+    restrictionTypes: [RestrictionType.Fixed, RestrictionType.Fixed],
     rollingPeriodInDays: [2, 3],
   });
   // Transfers
@@ -233,7 +233,7 @@ window.addEventListener('load', async () => {
     startTimes: [new Date(Date.now().valueOf() + delay), new Date(Date.now().valueOf() + delay)],
     endTimes: [new Date(2035, 2), new Date(2035, 2)],
     allowedTokens: [new BigNumber(30), new BigNumber(30)],
-    restrictionTypes: [RestrictionTypes.Fixed, RestrictionTypes.Fixed],
+    restrictionTypes: [RestrictionType.Fixed, RestrictionType.Fixed],
     rollingPeriodInDays: [3, 4],
   });
   // Remove
@@ -244,7 +244,7 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 1),
     allowedTokens: new BigNumber(50),
-    restrictionType: RestrictionTypes.Percentage,
+    restrictionType: RestrictionType.Percentage,
     rollingPeriodInDays: 2,
   });
   // Transfers
@@ -255,7 +255,7 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 2),
     allowedTokens: new BigNumber(45),
-    restrictionType: RestrictionTypes.Percentage,
+    restrictionType: RestrictionType.Percentage,
     rollingPeriodInDays: 3,
   });
   // Remove
@@ -266,7 +266,7 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2035, 1),
     allowedTokens: new BigNumber(80),
-    restrictionType: RestrictionTypes.Percentage,
+    restrictionType: RestrictionType.Percentage,
   });
   // Transfer
   await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary1, value: new BigNumber(4) });
@@ -276,7 +276,7 @@ window.addEventListener('load', async () => {
     startTime: new Date(Date.now().valueOf() + delay),
     endTime: new Date(2036, 2),
     allowedTokens: new BigNumber(85),
-    restrictionType: RestrictionTypes.Fixed,
+    restrictionType: RestrictionType.Fixed,
   });
   // Remove the default daily restriction
   await vrtm.removeDefaultDailyRestriction({});

src/contract_wrappers/modules/transfer_manager/volume_restriction_transfer_manager_wrapper.ts

@@ -649,7 +649,7 @@ export default class VolumeRestrictionTransferManagerWrapper extends ModuleWrapp
     );
   };
 
-  public removeIndividualRestrictionMulti = async (params: IndividualRestrictionMultiParams) => {
+  public removeIndividualRestrictionMulti = async (params: RemoveIndividualRestrictionMultiParams) => {
     assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
     params.holders.forEach(address => assert.isNonZeroETHAddressHex('holders', address));
     await Promise.all(
@@ -681,7 +681,7 @@ export default class VolumeRestrictionTransferManagerWrapper extends ModuleWrapp
     );
   };
 
-  public removeIndividualDailyRestrictionMulti = async (params: IndividualRestrictionMultiParams) => {
+  public removeIndividualDailyRestrictionMulti = async (params: RemoveIndividualRestrictionMultiParams) => {
     assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
     await Promise.all(
       params.holders.map(async holder =>