fix: polymathbase manual merge

shuffledex · shuffledex · commit 1be587c9ff52 · 2020-01-02T14:53:18.000-03:00
diff --git a/release.config.js b/release.config.js
@@ -9,7 +9,7 @@ module.exports = {
       prerelease: true,
     },
   ],
-  /**
+  /*
    * In this order the **prepare** step of @semantic-release/npm will run first
    * followed by @semantic-release/git:
    *  - Update the package.json version and create the npm package tarball
diff --git a/src/PolymathBase.ts b/src/PolymathBase.ts
@@ -31,12 +31,13 @@ import {
   isPercentageTransferManager,
   isVolumeRestrictionTransferManager,
   isRestrictedPartialSaleTransferManager,
+  EtherDividendCheckpoint,
 } from '@polymathnetwork/contract-wrappers';
 import { range, flatten } from 'lodash';
 import P from 'bluebird';
 import semver from 'semver';
 import { PolymathError } from './PolymathError';
-import { ErrorCode, Module, SecurityTokenRole, ShareholderBalance } from './types';
+import { ErrorCode, SecurityTokenRole, ShareholderBalance } from './types';
 import { ZERO_ADDRESS } from './utils/constants';
 
 interface GetModuleAddressesByNameParams {
@@ -192,6 +193,22 @@ export interface BaseDividend {
   shareholders: DividendShareholderStatus[];
 }
 
+export type Module =
+  | GeneralPermissionManager
+  | GeneralTransferManager
+  | BlacklistTransferManager
+  | LockUpTransferManager
+  | CountTransferManager
+  | ManualApprovalTransferManager
+  | PercentageTransferManager
+  | VolumeRestrictionTransferManager
+  | RestrictedPartialSaleTransferManager
+  | CappedSTO
+  | USDTieredSTO
+  | ERC20DividendCheckpoint
+  | EtherDividendCheckpoint
+  | VestingEscrowWallet;
+
 export class PolymathBase extends PolymathAPI {
   public getModuleFactoryAddress = async ({
     moduleName,
diff --git a/src/entities/SecurityToken/Documents.ts b/src/entities/SecurityToken/Documents.ts
@@ -70,9 +70,11 @@ export class Documents extends SubModule {
     let securityTokenInstance;
 
     try {
-      securityTokenInstance = await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
-        symbol
-      );
+      // prettier-ignore
+      securityTokenInstance =
+        await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
+          symbol
+        );
     } catch (err) {
       throw new PolymathError({
         code: ErrorCode.FetcherValidationError,
@@ -97,9 +99,11 @@ export class Documents extends SubModule {
     let securityTokenInstance;
 
     try {
-      securityTokenInstance = await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
-        symbol
-      );
+      // prettier-ignore
+      securityTokenInstance =
+        await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
+          symbol
+        );
     } catch (err) {
       throw new PolymathError({
         code: ErrorCode.FetcherValidationError,
diff --git a/src/entities/SecurityToken/Shareholders.ts b/src/entities/SecurityToken/Shareholders.ts
@@ -227,9 +227,11 @@ export class Shareholders extends SubModule {
     let securityTokenInstance;
 
     try {
-      securityTokenInstance = await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
-        symbol
-      );
+      // prettier-ignore
+      securityTokenInstance =
+        await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
+          symbol
+        );
     } catch (err) {
       throw new PolymathError({
         code: ErrorCode.FetcherValidationError,
@@ -251,9 +253,11 @@ export class Shareholders extends SubModule {
     let securityTokenInstance;
 
     try {
-      securityTokenInstance = await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
-        symbol
-      );
+      // prettier-ignore
+      securityTokenInstance =
+        await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(
+          symbol
+        );
     } catch (err) {
       throw new PolymathError({
         code: ErrorCode.FetcherValidationError,
diff --git a/src/procedures/AssignSecurityTokenRole.ts b/src/procedures/AssignSecurityTokenRole.ts
@@ -66,7 +66,7 @@ export class AssignSecurityTokenRole extends Procedure<AssignSecurityTokenRolePr
     const exists =
       delegates.filter(element => element.toUpperCase() === delegate.toUpperCase()).length > 0;
 
-    /**
+    /*
      * In the following block we attempt to:
      * - Find whether the delegate address is already present. Otherwise add them
      * - Find whether the current delegate permission is equal to the provided one. Otherwise change permissions
diff --git a/src/procedures/AssignStoRole.ts b/src/procedures/AssignStoRole.ts
@@ -43,7 +43,7 @@ export class AssignStoRole extends Procedure<AssignStoRoleProcedureArgs> {
     const delegates = await permissionModule.getAllDelegates();
     const exists = delegates.filter(element => element === delegate).length > 0;
 
-    /**
+    /*
      * In the following block we attempt to:
      * - Find whether the delegate address is already present. Otherwise add them
      * - Find whether the current delegate permission is equal to the provided one. Otherwise change permissions
diff --git a/src/procedures/ControllerRedeem.ts b/src/procedures/ControllerRedeem.ts
@@ -37,10 +37,9 @@ export class ControllerRedeem extends Procedure<ControllerRedeemProcedureArgs> {
     const { symbol, amount, from, reason = '', data = '' } = this.args;
     const { contractWrappers, currentWallet, factories } = this.context;
 
-    /**
+    /*
      * Validation
      */
-
     if (!isValidAddress(from)) {
       throw new PolymathError({
         code: ErrorCode.InvalidAddress,
@@ -82,7 +81,7 @@ export class ControllerRedeem extends Procedure<ControllerRedeemProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
     await this.addTransaction(securityToken.controllerRedeem, {
diff --git a/src/procedures/ControllerTransfer.ts b/src/procedures/ControllerTransfer.ts
@@ -41,10 +41,9 @@ export class ControllerTransfer extends Procedure<ControllerTransferProcedureArg
     const { contractWrappers, currentWallet, factories } = this.context;
     const addresses: { [key: string]: string } = { from, to };
 
-    /**
+    /*
      * Validation
      */
-
     Object.keys(addresses).forEach(key => {
       if (!isValidAddress(addresses[key])) {
         throw new PolymathError({
@@ -88,10 +87,9 @@ export class ControllerTransfer extends Procedure<ControllerTransferProcedureArg
       });
     }
 
-    /**
+    /*
      * Transactions
      */
-
     await this.addTransaction(securityToken.controllerTransfer, {
       tag: PolyTransactionTag.ControllerTransfer,
       resolvers: [createControllerTransferResolver(factories, symbol, from, to)],
diff --git a/src/procedures/DisableController.ts b/src/procedures/DisableController.ts
@@ -51,7 +51,7 @@ export class DisableController extends Procedure<DisableControllerProcedureArgs>
     const requestedSignature =
       signature || (await this.addSignatureRequest(securityToken.signDisableControllerAck)({}));
 
-    /**
+    /*
      * Transactions
      */
     await this.addTransaction(securityToken.disableController, {
diff --git a/src/procedures/FinalizeSto.ts b/src/procedures/FinalizeSto.ts
@@ -18,10 +18,9 @@ export class FinalizeSto extends Procedure<FinalizeStoProcedureArgs> {
     const { stoAddress, stoType, symbol } = this.args;
     const { contractWrappers, factories } = this.context;
 
-    /**
+    /*
      * Validation
      */
-
     let securityToken;
 
     try {
@@ -115,10 +114,9 @@ export class FinalizeSto extends Procedure<FinalizeStoProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
-
     await this.addTransaction(stoModule.finalize, {
       tag: PolyTransactionTag.FinalizeSto,
       resolvers: [
diff --git a/src/procedures/FreezeIssuance.ts b/src/procedures/FreezeIssuance.ts
@@ -50,7 +50,7 @@ export class FreezeIssuance extends Procedure<FreezeIssuanceProcedureArgs> {
     const requestedSignature =
       signature || (await this.addSignatureRequest(securityToken.signFreezeIssuanceAck)({}));
 
-    /**
+    /*
      * Transactions
      */
     await this.addTransaction(securityToken.freezeIssuance, {
diff --git a/src/procedures/InvestInSimpleSto.ts b/src/procedures/InvestInSimpleSto.ts
@@ -31,10 +31,9 @@ export class InvestInSimpleSto extends Procedure<InvestInSimpleStoProcedureArgs>
 
     const { contractWrappers, factories } = context;
 
-    /**
+    /*
      * Validation
      */
-
     try {
       await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(symbol);
     } catch (err) {
diff --git a/src/procedures/InvestInTieredSto.ts b/src/procedures/InvestInTieredSto.ts
@@ -32,10 +32,9 @@ export class InvestInTieredSto extends Procedure<InvestInTieredStoProcedureArgs>
 
     const { contractWrappers, factories } = context;
 
-    /**
+    /*
      * Validation
      */
-
     try {
       await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(symbol);
     } catch (err) {
diff --git a/src/procedures/ModifyBeneficialInvestments.ts b/src/procedures/ModifyBeneficialInvestments.ts
@@ -20,10 +20,9 @@ export class ModifyBeneficialInvestments extends Procedure<
     const { stoAddress, stoType, symbol, allowBeneficialInvestments } = this.args;
     const { contractWrappers, factories } = this.context;
 
-    /**
+    /*
      * Validation
      */
-
     if (!isValidAddress(stoAddress)) {
       throw new PolymathError({
         code: ErrorCode.InvalidAddress,
@@ -76,10 +75,9 @@ export class ModifyBeneficialInvestments extends Procedure<
       });
     }
 
-    /**
+    /*
      * Transactions
      */
-
     await this.addTransaction(stoModule.changeAllowBeneficialInvestments, {
       tag: PolyTransactionTag.ChangeAllowBeneficialInvestments,
       resolvers: [
diff --git a/src/procedures/ModifyPreIssuing.ts b/src/procedures/ModifyPreIssuing.ts
@@ -22,10 +22,9 @@ export class ModifyPreIssuing extends Procedure<ModifyPreIssuingProcedureArgs> {
     const { stoAddress, stoType, symbol, allowPreIssuing } = this.args;
     const { contractWrappers, factories } = this.context;
 
-    /**
+    /*
      * Validation
      */
-
     if (!isValidAddress(stoAddress)) {
       throw new PolymathError({
         code: ErrorCode.InvalidAddress,
@@ -88,10 +87,9 @@ export class ModifyPreIssuing extends Procedure<ModifyPreIssuingProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
-
     await this.addTransaction(
       allowPreIssuing ? stoModule.allowPreMinting : stoModule.revokePreMintFlag,
       {
diff --git a/src/procedures/Procedure.ts b/src/procedures/Procedure.ts
@@ -109,7 +109,7 @@ export abstract class Procedure<Args, ReturnType = void> {
     };
   };
 
-  /**
+  /*
    * TODO @monitz87: add an array of PostTransactionResolvers whose resolved values get passed
    * as an optional parameter to the resolver functions (same concept as futureValue but for resolver functions)
    */
diff --git a/src/procedures/RemoveDocument.ts b/src/procedures/RemoveDocument.ts
@@ -54,7 +54,7 @@ export class RemoveDocument extends Procedure<RemoveDocumentProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
     await this.addTransaction(securityToken.removeDocument, {
diff --git a/src/procedures/SetController.ts b/src/procedures/SetController.ts
@@ -40,10 +40,9 @@ export class SetController extends Procedure<SetControllerProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
-
     await this.addTransaction(securityToken.setController, {
       tag: PolyTransactionTag.SetController,
     })({ controller });
diff --git a/src/procedures/SetDocument.ts b/src/procedures/SetDocument.ts
@@ -45,7 +45,7 @@ export class SetDocument extends Procedure<SetDocumentProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
     await this.addTransaction(securityToken.setDocument, {
diff --git a/src/procedures/TogglePauseSto.ts b/src/procedures/TogglePauseSto.ts
@@ -52,7 +52,7 @@ export class TogglePauseSto extends Procedure<TogglePauseStoProcedureArgs> {
     const { stoAddress, stoType, symbol, pause } = this.args;
     const { contractWrappers, factories } = this.context;
 
-    /**
+    /*
      * Validation
      */
 
@@ -95,7 +95,7 @@ export class TogglePauseSto extends Procedure<TogglePauseStoProcedureArgs> {
       });
     }
 
-    /**
+    /*
      * Transactions
      */
     await this.addTransaction(pause ? stoModule.pause : stoModule.unpause, {
diff --git a/src/procedures/TransferReservationOwnership.ts b/src/procedures/TransferReservationOwnership.ts
@@ -9,6 +9,15 @@ import { PolymathError } from '../PolymathError';
 import { SecurityTokenReservation } from '../entities';
 import { Factories } from '../Context';
 
+export const createTransferReservationOwnershipResolver = (
+  factories: Factories,
+  symbol: string
+) => async () => {
+  return factories.securityTokenReservationFactory.refresh(
+    SecurityTokenReservation.generateId({ symbol })
+  );
+};
+
 export class TransferReservationOwnership extends Procedure<
   TransferReservationOwnershipProcedureArgs
 > {
@@ -55,12 +64,3 @@ export class TransferReservationOwnership extends Procedure<
     })({ newOwner, ticker: symbol });
   }
 }
-
-export const createTransferReservationOwnershipResolver = (
-  factories: Factories,
-  symbol: string
-) => async () => {
-  return factories.securityTokenReservationFactory.refresh(
-    SecurityTokenReservation.generateId({ symbol })
-  );
-};
diff --git a/src/procedures/__tests__/SignDIsableControllerAck.ts b/src/procedures/__tests__/SignDIsableControllerAck.ts
@@ -1,3 +1,4 @@
+/* eslint-disable import/no-duplicates */
 import { ImportMock, MockManager } from 'ts-mock-imports';
 import { spy, restore } from 'sinon';
 import * as contractWrappersModule from '@polymathnetwork/contract-wrappers';
diff --git a/src/procedures/__tests__/SignFreezeIssuanceAck.ts b/src/procedures/__tests__/SignFreezeIssuanceAck.ts
@@ -1,3 +1,4 @@
+/* eslint-disable import/no-duplicates */
 import { ImportMock, MockManager } from 'ts-mock-imports';
 import { spy, restore } from 'sinon';
 import * as contractWrappersModule from '@polymathnetwork/contract-wrappers';
diff --git a/src/procedures/__tests__/SignTransferData.ts b/src/procedures/__tests__/SignTransferData.ts
@@ -1,3 +1,4 @@
+/* eslint-disable import/no-duplicates */
 import { ImportMock, MockManager } from 'ts-mock-imports';
 import { spy, restore } from 'sinon';
 import * as contractWrappersModule from '@polymathnetwork/contract-wrappers';
diff --git a/src/procedures/__tests__/TransferReservationOwnership.ts b/src/procedures/__tests__/TransferReservationOwnership.ts
diff --git a/src/types/index.ts b/src/types/index.ts
