fix: add missing procedure arguments to the ProcedureArguments interface

monitz87 · monitz87 · commit cce4789bba7b · 2019-07-30T15:22:12.000-04:00
also renamed the Approve procedure to ApproveErc20 and created a TransferErc20 procedure

BREAKING CHANGE: rename `ProcedureType` enum's member `Approve` to `ApproveErc20`, rename the
`ApproveProcedureArgs` interface to `ApproveErc20ProcedureArgs`. This affects the
`ProcedureArguments` interface
diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
     "@0x/subproviders": "^3.0.2",
     "@babel/polyfill": "^7.0.0",
     "@babel/runtime": "^7.2.0",
-    "@polymathnetwork/contract-wrappers": "2.0.0-beta.6",
+    "@polymathnetwork/contract-wrappers": "2.0.0-beta.7",
     "ethereum-address": "^0.0.4",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
diff --git a/src/procedures/ApproveErc20.ts b/src/procedures/ApproveErc20.ts
@@ -1,10 +1,13 @@
 import { BigNumber } from '@polymathnetwork/contract-wrappers';
 import { Procedure } from './Procedure';
-import { ApproveProcedureArgs, ErrorCode, ProcedureType, PolyTransactionTag } from '../types';
+import { ApproveErc20ProcedureArgs, ErrorCode, ProcedureType, PolyTransactionTag } from '../types';
 import { PolymathError } from '../PolymathError';
 
-export class Approve extends Procedure<ApproveProcedureArgs> {
-  public type = ProcedureType.Approve;
+/**
+ * Procedure to approve spending funds on an ERC20 token. If no token address is specified, it defaults to POLY
+ */
+export class ApproveErc20 extends Procedure<ApproveErc20ProcedureArgs> {
+  public type = ProcedureType.ApproveErc20;
 
   public async prepareTransactions() {
     const { amount, spender, tokenAddress, owner } = this.args;
@@ -48,15 +51,13 @@ export class Approve extends Procedure<ApproveProcedureArgs> {
     const isTestnet = await contractWrappers.isTestnet();
 
     if (balance.lt(amount)) {
-      if (isTestnet) {
-        if (address.toUpperCase() === polyTokenAddress.toUpperCase()) {
-          await this.addTransaction(contractWrappers.getPolyTokens, {
-            tag: PolyTransactionTag.GetTokens,
-          })({
-            amount: amount.minus(balance).decimalPlaces(0, BigNumber.ROUND_HALF_UP),
-            address: ownerAddress,
-          });
-        }
+      if (isTestnet && address.toUpperCase() === polyTokenAddress.toUpperCase()) {
+        await this.addTransaction(contractWrappers.getPolyTokens, {
+          tag: PolyTransactionTag.GetTokens,
+        })({
+          amount: amount.minus(balance).decimalPlaces(0, BigNumber.ROUND_HALF_UP),
+          address: ownerAddress,
+        });
       } else {
         throw new PolymathError({
           code: ErrorCode.ProcedureValidationError,
@@ -76,7 +77,7 @@ export class Approve extends Procedure<ApproveProcedureArgs> {
     }
 
     await this.addTransaction(token.approve, {
-      tag: PolyTransactionTag.ApprovePoly,
+      tag: PolyTransactionTag.ApproveErc20,
     })({ spender, value: amount });
   }
 }
diff --git a/src/procedures/ChangeDelegatePermission.ts b/src/procedures/ChangeDelegatePermission.ts
@@ -3,13 +3,13 @@ import { Procedure } from './Procedure';
 import {
   ProcedureType,
   PolyTransactionTag,
-  ChangeDelegatePermissionArgs,
+  ChangeDelegatePermissionProcedureArgs,
   ErrorCode,
   ModuleOperation,
 } from '../types';
 import { PolymathError } from '../PolymathError';
 
-export class ChangeDelegatePermission extends Procedure<ChangeDelegatePermissionArgs> {
+export class ChangeDelegatePermission extends Procedure<ChangeDelegatePermissionProcedureArgs> {
   public type = ProcedureType.ChangeDelegatePermission;
 
   public async prepareTransactions() {
diff --git a/src/procedures/ControllerTransfer.ts b/src/procedures/ControllerTransfer.ts
@@ -1,9 +1,14 @@
 import { Procedure } from './Procedure';
-import { ProcedureType, PolyTransactionTag, ControllerTransferArgs, ErrorCode } from '../types';
+import {
+  ProcedureType,
+  PolyTransactionTag,
+  ControllerTransferProcedureArgs,
+  ErrorCode,
+} from '../types';
 import { PolymathError } from '../PolymathError';
 import { isValidAddress } from '../utils';
 
-export class ControllerTransfer extends Procedure<ControllerTransferArgs> {
+export class ControllerTransfer extends Procedure<ControllerTransferProcedureArgs> {
   public type = ProcedureType.ControllerTransfer;
 
   public async prepareTransactions() {
diff --git a/src/procedures/CreateErc20DividendDistribution.ts b/src/procedures/CreateErc20DividendDistribution.ts
@@ -10,7 +10,7 @@ import {
   PolyTransactionTag,
   ErrorCode,
 } from '../types';
-import { Approve } from '../procedures/Approve';
+import { ApproveErc20 } from './ApproveErc20';
 import { PolymathError } from '../PolymathError';
 import { findEvent } from '../utils';
 
@@ -54,7 +54,7 @@ export class CreateErc20DividendDistribution extends Procedure<
       );
     }
 
-    await this.addProcedure(Approve)({
+    await this.addProcedure(ApproveErc20)({
       amount,
       spender: await erc20Module.address(),
       tokenAddress: erc20Address,
diff --git a/src/procedures/CreateSecurityToken.ts b/src/procedures/CreateSecurityToken.ts
@@ -1,5 +1,5 @@
 import { Procedure } from './Procedure';
-import { Approve } from '../procedures/Approve';
+import { ApproveErc20 } from './ApproveErc20';
 import { CreateSecurityTokenProcedureArgs, ProcedureType, PolyTransactionTag } from '../types';
 
 export class CreateSecurityToken extends Procedure<CreateSecurityTokenProcedureArgs> {
@@ -12,7 +12,7 @@ export class CreateSecurityToken extends Procedure<CreateSecurityTokenProcedureA
     } = this.context;
     const fee = await securityTokenRegistry.getSecurityTokenLaunchFee();
 
-    await this.addProcedure(Approve)({
+    await this.addProcedure(ApproveErc20)({
       amount: fee,
       spender: await securityTokenRegistry.address(),
     });
diff --git a/src/procedures/LaunchCappedSto.ts b/src/procedures/LaunchCappedSto.ts
@@ -7,6 +7,7 @@ import {
   LaunchCappedStoProcedureArgs,
 } from '../types';
 import { PolymathError } from '../PolymathError';
+import { TransferErc20 } from './TransferErc20';
 
 interface AddCappedSTOParams {
   moduleName: ModuleName.CappedSTO;
@@ -43,22 +44,20 @@ export class LaunchCappedSto extends Procedure<LaunchCappedStoProcedureArgs> {
       });
     }
 
-    const tokenAddress = await securityToken.address();
+    const securityTokenAddress = await securityToken.address();
     const moduleName = ModuleName.CappedSTO;
 
     const factoryAddress = await contractWrappers.getModuleFactoryAddress({
-      tokenAddress,
+      tokenAddress: securityTokenAddress,
       moduleName,
     });
 
     const moduleFactory = await contractWrappers.moduleFactory.getModuleFactory(factoryAddress);
     const cost = await moduleFactory.setupCostInPoly();
 
-    await this.addTransaction(contractWrappers.polyToken.transfer, {
-      tag: PolyTransactionTag.TransferPoly,
-    })({
-      to: tokenAddress,
-      value: cost,
+    await this.addProcedure(TransferErc20)({
+      receiver: securityTokenAddress,
+      amount: cost,
     });
 
     await this.addTransaction<AddCappedSTOParams>(securityToken.addModuleWithLabel, {
diff --git a/src/procedures/LaunchUsdTieredSto.ts b/src/procedures/LaunchUsdTieredSto.ts
@@ -7,6 +7,7 @@ import {
   LaunchUsdTieredStoProcedureArgs,
 } from '../types';
 import { PolymathError } from '../PolymathError';
+import { TransferErc20 } from './TransferErc20';
 
 interface AddUSDTieredSTOParams {
   moduleName: ModuleName.UsdTieredSTO;
@@ -60,22 +61,20 @@ export class LaunchUsdTieredSto extends Procedure<LaunchUsdTieredStoProcedureArg
       });
     }
 
-    const tokenAddress = await securityToken.address();
+    const securityTokenAddress = await securityToken.address();
     const moduleName = ModuleName.UsdTieredSTO;
 
     const factoryAddress = await contractWrappers.getModuleFactoryAddress({
-      tokenAddress,
+      tokenAddress: securityTokenAddress,
       moduleName,
     });
 
     const moduleFactory = await contractWrappers.moduleFactory.getModuleFactory(factoryAddress);
     const cost = await moduleFactory.setupCostInPoly();
 
-    await this.addTransaction(contractWrappers.polyToken.transfer, {
-      tag: PolyTransactionTag.TransferPoly,
-    })({
-      to: tokenAddress,
-      value: cost,
+    await this.addProcedure(TransferErc20)({
+      receiver: securityTokenAddress,
+      amount: cost,
     });
 
     const ratePerTier: BigNumber[] = [];
diff --git a/src/procedures/ModifyWhitelist.ts b/src/procedures/ModifyWhitelist.ts
diff --git a/src/procedures/PauseSto.ts b/src/procedures/PauseSto.ts
@@ -1,10 +1,10 @@
 import { ModuleName } from '@polymathnetwork/contract-wrappers';
 import { Procedure } from './Procedure';
-import { ProcedureType, PolyTransactionTag, PauseStoArgs, ErrorCode } from '../types';
+import { ProcedureType, PolyTransactionTag, PauseStoProcedureArgs, ErrorCode } from '../types';
 import { PolymathError } from '../PolymathError';
 import { isValidAddress } from '../utils';
 
-export class PauseSto extends Procedure<PauseStoArgs> {
+export class PauseSto extends Procedure<PauseStoProcedureArgs> {
   public type = ProcedureType.PauseSto;
 
   public async prepareTransactions() {
diff --git a/src/procedures/ReserveSecurityToken.ts b/src/procedures/ReserveSecurityToken.ts
@@ -1,5 +1,5 @@
 import { Procedure } from './Procedure';
-import { Approve } from './Approve';
+import { ApproveErc20 } from './ApproveErc20';
 import {
   ReserveSecurityTokenProcedureArgs,
   ProcedureType,
@@ -42,7 +42,7 @@ export class ReserveSecurityToken extends Procedure<ReserveSecurityTokenProcedur
     }
 
     const fee = await securityTokenRegistry.getTickerRegistrationFee();
-    await this.addProcedure(Approve)({
+    await this.addProcedure(ApproveErc20)({
       amount: fee,
       spender: await securityTokenRegistry.address(),
       owner: ownerAddress,
diff --git a/src/procedures/SetController.ts b/src/procedures/SetController.ts
@@ -1,9 +1,9 @@
 import { Procedure } from './Procedure';
-import { ProcedureType, PolyTransactionTag, SetControllerArgs, ErrorCode } from '../types';
+import { ProcedureType, PolyTransactionTag, SetControllerProcedureArgs, ErrorCode } from '../types';
 import { PolymathError } from '../PolymathError';
 import { isValidAddress } from '../utils';
 
-export class SetController extends Procedure<SetControllerArgs> {
+export class SetController extends Procedure<SetControllerProcedureArgs> {
   public type = ProcedureType.SetController;
 
   public async prepareTransactions() {
diff --git a/src/procedures/TransferErc20.ts b/src/procedures/TransferErc20.ts
@@ -0,0 +1,73 @@
+import { BigNumber } from '@polymathnetwork/contract-wrappers';
+import { Procedure } from './Procedure';
+import { TransferErc20ProcedureArgs, ErrorCode, ProcedureType, PolyTransactionTag } from '../types';
+import { PolymathError } from '../PolymathError';
+
+/**
+ * Procedure to transfer funds of an ERC20 token. If no token address is specified, it defaults to POLY
+ */
+export class TransferErc20 extends Procedure<TransferErc20ProcedureArgs> {
+  public type = ProcedureType.TransferErc20;
+
+  public async prepareTransactions() {
+    const { amount, receiver, tokenAddress, owner } = this.args;
+    const { contractWrappers, currentWallet } = this.context;
+
+    let ownerAddress: string;
+
+    if (owner) {
+      ownerAddress = owner;
+    } else if (currentWallet) {
+      ({ address: ownerAddress } = currentWallet);
+    } else {
+      throw new PolymathError({
+        message: "No default account set. You must pass the owner's address as a parameter",
+        code: ErrorCode.ProcedureValidationError,
+      });
+    }
+
+    const { polyToken } = contractWrappers;
+
+    let token;
+
+    if (tokenAddress) {
+      try {
+        token = await contractWrappers.getERC20TokenWrapper({ address: tokenAddress });
+      } catch (err) {
+        throw new PolymathError({
+          code: ErrorCode.ProcedureValidationError,
+          message: 'The supplied address does not correspond to an ERC20 token',
+        });
+      }
+    } else {
+      token = polyToken;
+    }
+
+    const balance = await token.balanceOf({ owner: ownerAddress });
+
+    const address = await token.address();
+    const polyTokenAddress = await polyToken.address();
+
+    const isTestnet = await contractWrappers.isTestnet();
+
+    if (balance.lt(amount)) {
+      if (isTestnet && address.toUpperCase() === polyTokenAddress.toUpperCase()) {
+        await this.addTransaction(contractWrappers.getPolyTokens, {
+          tag: PolyTransactionTag.GetTokens,
+        })({
+          amount: amount.minus(balance).decimalPlaces(0, BigNumber.ROUND_HALF_UP),
+          address: ownerAddress,
+        });
+      } else {
+        throw new PolymathError({
+          code: ErrorCode.ProcedureValidationError,
+          message: 'Not enough funds',
+        });
+      }
+    }
+
+    await this.addTransaction(token.transfer, {
+      tag: PolyTransactionTag.TransferErc20,
+    })({ to: receiver, value: amount });
+  }
+}
diff --git a/src/procedures/index.ts b/src/procedures/index.ts
@@ -1,4 +1,5 @@
-export { Approve } from './Approve';
+export { ApproveErc20 } from './ApproveErc20';
+export { TransferErc20 } from './TransferErc20';
 export { ReserveSecurityToken } from './ReserveSecurityToken';
 export { CreateSecurityToken } from './CreateSecurityToken';
 export { EnableDividendModules } from './EnableDividendModules';
diff --git a/src/types/index.ts b/src/types/index.ts
diff --git a/yarn.lock b/yarn.lock
