feat: add shareholders.revokeKyc to the Security Token Entity

revokeKyc receives an array of shareholder addresses and forcibly expires their KYC

Author: monitz87

package.json

@@ -49,7 +49,7 @@
     "@0x/subproviders": "^3.0.2",
     "@babel/polyfill": "^7.0.0",
     "@babel/runtime": "^7.2.0",
-    "@polymathnetwork/contract-wrappers": "2.0.0-beta.32",
+    "@polymathnetwork/contract-wrappers": "2.0.0-beta.35",
     "bluebird": "^3.5.5",
     "ethereum-address": "^0.0.4",
     "json-stable-stringify": "^1.0.1",

src/Polymath.ts

@@ -54,8 +54,6 @@ interface GetSecurityToken {
 }
 
 export class Polymath {
-  public networkId: number = -1;
-
   public isUnsupported: boolean = false;
 
   public isConnected: boolean = false;

src/entities/SecurityToken/Shareholders.ts

@@ -2,8 +2,8 @@ import {
   ModuleName,
   SecurityToken as SecurityTokenWrapper,
 } from '@polymathnetwork/contract-wrappers';
-import { ShareholderDataEntry, DividendType, ErrorCode } from '../../types';
-import { ModifyShareholderData, CreateCheckpoint } from '../../procedures';
+import { ShareholderDataEntry, ErrorCode } from '../../types';
+import { ModifyShareholderData, CreateCheckpoint, RevokeKyc } from '../../procedures';
 import { SubModule } from './SubModule';
 import { Checkpoint } from '../Checkpoint';
 import { PolymathError } from '../../PolymathError';
@@ -35,6 +35,22 @@ export class Shareholders extends SubModule {
     return procedure.prepare();
   };
 
+  /**
+   * Revokes KYC for a group of shareholder addresses. Supplied addresses must have valid KYC
+   *
+   * @param shareholderAddresses array of shareholder addresses
+   */
+  public revokeKyc = async (args: { shareholderAddresses: string[] }) => {
+    const procedure = new RevokeKyc(
+      {
+        symbol: this.securityToken.symbol,
+        ...args,
+      },
+      this.context
+    );
+    return procedure.prepare();
+  };
+
   /**
    * Create a snapshot of the balances of every shareholder at the current date
    */

src/procedures/CreateSecurityToken.ts

@@ -64,7 +64,7 @@ export class CreateSecurityToken extends Procedure<
       });
     }
 
-    const [usdFee, polyFee] = await securityTokenRegistry.getFees({ feeType: FeeType.stLaunchFee });
+    const [usdFee, polyFee] = await securityTokenRegistry.getFees({ feeType: FeeType.StLaunchFee });
 
     await this.addProcedure(ApproveErc20)({
       amount: polyFee,

src/procedures/ReserveSecurityToken.ts

@@ -52,7 +52,7 @@ export class ReserveSecurityToken extends Procedure<
     }
 
     const [usdFee, polyFee] = await securityTokenRegistry.getFees({
-      feeType: FeeType.tickerRegFee,
+      feeType: FeeType.TickerRegFee,
     });
     await addProcedure(ApproveErc20)({
       amount: polyFee,

src/procedures/RevokeKyc.ts

@@ -0,0 +1,113 @@
+import { ModuleName } from '@polymathnetwork/contract-wrappers';
+import { difference } from 'lodash';
+import { Procedure } from './Procedure';
+import { ProcedureType, PolyTransactionTag, ErrorCode, RevokeKycProcedureArgs } from '../types';
+import { PolymathError } from '../PolymathError';
+import { Shareholder, SecurityToken } from '../entities';
+
+export class RevokeKyc extends Procedure<RevokeKycProcedureArgs, Shareholder[]> {
+  public type = ProcedureType.CreateErc20DividendDistribution;
+
+  public async prepareTransactions() {
+    const { symbol, shareholderAddresses } = this.args;
+    const { contractWrappers, factories } = this.context;
+
+    if (shareholderAddresses.length === 0) {
+      throw new PolymathError({
+        code: ErrorCode.ProcedureValidationError,
+        message: 'You must provide at least one shareholder address to revoke KYC for',
+      });
+    }
+
+    try {
+      await contractWrappers.tokenFactory.getSecurityTokenInstanceFromTicker(symbol);
+    } catch (err) {
+      throw new PolymathError({
+        code: ErrorCode.ProcedureValidationError,
+        message: `There is no Security Token with symbol ${symbol}`,
+      });
+    }
+
+    const securityToken = await factories.securityTokenFactory.fetch(
+      SecurityToken.generateId({ symbol })
+    );
+
+    const shareholders = await securityToken.shareholders.getShareholders();
+    const now = new Date();
+
+    const currentNonExpiredShareholderAddresses = shareholders
+      .filter(({ kycExpiry }) => kycExpiry > now)
+      .map(({ address }) => address);
+    const diff = difference(shareholderAddresses, currentNonExpiredShareholderAddresses);
+
+    if (diff.length) {
+      throw new PolymathError({
+        code: ErrorCode.ProcedureValidationError,
+        message: `KYC for "${diff.join(', ')}" has already expired`,
+      });
+    }
+
+    const gtmModule = (await contractWrappers.getAttachedModules(
+      {
+        moduleName: ModuleName.GeneralTransferManager,
+        symbol,
+      },
+      { unarchived: true }
+    ))[0];
+
+    if (!gtmModule) {
+      throw new PolymathError({
+        code: ErrorCode.FatalError,
+        message: `General Transfer Manager for token "${symbol}" isn't enabled. Please report this issue to the Polymath team`,
+      });
+    }
+
+    const canSendAfter: Date[] = [];
+    const canReceiveAfter: Date[] = [];
+    const expiryTime: Date[] = [];
+
+    shareholderAddresses.forEach(_address => {
+      canSendAfter.push(new Date(0));
+      canReceiveAfter.push(new Date(0));
+      expiryTime.push(new Date(0));
+    });
+
+    const securityTokenId = SecurityToken.generateId({ symbol });
+
+    let revokedShareholders;
+
+    revokedShareholders = await this.addTransaction(gtmModule.modifyKYCDataMulti, {
+      tag: PolyTransactionTag.ModifyKycDataMulti,
+      resolver: async () => {
+        const refreshingShareholders = shareholderAddresses.map(shareholder => {
+          return factories.shareholderFactory.refresh(
+            Shareholder.generateId({
+              securityTokenId,
+              address: shareholder,
+            })
+          );
+        });
+
+        await Promise.all(refreshingShareholders);
+
+        const fetchingShareholders = shareholderAddresses.map(shareholder => {
+          return factories.shareholderFactory.fetch(
+            Shareholder.generateId({
+              securityTokenId,
+              address: shareholder,
+            })
+          );
+        });
+
+        return Promise.all(fetchingShareholders);
+      },
+    })({
+      investors: shareholderAddresses,
+      canSendAfter,
+      canReceiveAfter,
+      expiryTime,
+    });
+
+    return revokedShareholders;
+  }
+}

src/procedures/index.ts

@@ -19,3 +19,4 @@ export { SetController } from './SetController';
 export { LaunchCappedSto } from './LaunchCappedSto';
 export { LaunchUsdTieredSto } from './LaunchUsdTieredSto';
 export { ModifyShareholderData } from './ModifyShareholderData';
+export { RevokeKyc } from './RevokeKyc';

src/types/index.ts

@@ -97,6 +97,7 @@ export enum ProcedureType {
   PauseSto = 'PauseSto',
   SetController = 'SetController',
   ModifyShareholderData = 'ModifyShareholderData',
+  RevokeKyc = 'RevokeKyc',
 }
 
 export enum PolyTransactionTag {
@@ -349,6 +350,11 @@ export interface ModifyShareholderDataProcedureArgs {
   shareholderData: ShareholderDataEntry[];
 }
 
+export interface RevokeKycProcedureArgs {
+  symbol: string;
+  shareholderAddresses: string[];
+}
+
 export interface ProcedureArguments {
   [ProcedureType.ApproveErc20]: ApproveErc20ProcedureArgs;
   [ProcedureType.TransferErc20]: TransferErc20ProcedureArgs;
@@ -370,6 +376,7 @@ export interface ProcedureArguments {
   [ProcedureType.SetController]: SetControllerProcedureArgs;
   [ProcedureType.ChangeDelegatePermission]: ChangeDelegatePermissionProcedureArgs;
   [ProcedureType.ModifyShareholderData]: ModifyShareholderDataProcedureArgs;
+  [ProcedureType.RevokeKyc]: RevokeKycProcedureArgs;
   [ProcedureType.UnnamedProcedure]: {};
 }
 

yarn.lock

@@ -1337,10 +1337,10 @@
   resolved "https://registry.yarnpkg.com/@polymathnetwork/contract-artifacts/-/contract-artifacts-3.0.0-beta.5.tgz#b3bf6c7f40eb036402237d08d98f4f11cc230c87"
   integrity sha512-YS6VXPqEgv69SEUJHArNLrN93psfPZSRFBxX0TnLPiNC/9wsvdDUXhE0a3RhokEMjYBmD4Yi+CDB71Faxg3jpQ==
 
-"@polymathnetwork/contract-wrappers@2.0.0-beta.32":
-  version "2.0.0-beta.32"
-  resolved "https://registry.yarnpkg.com/@polymathnetwork/contract-wrappers/-/contract-wrappers-2.0.0-beta.32.tgz#0a7ec1570e538702c551e0ad5df6b6689277e717"
-  integrity sha512-gqKNfna7RgMH7DOrfxnWW1GwspAnm9tIRsjpAZ3CLP/02PmYdK8pZP2XN19SdhmQ6JKWAGA3zi4cqfT5dw4a4w==
+"@polymathnetwork/contract-wrappers@2.0.0-beta.35":
+  version "2.0.0-beta.35"
+  resolved "https://registry.yarnpkg.com/@polymathnetwork/contract-wrappers/-/contract-wrappers-2.0.0-beta.35.tgz#fe5e8604e86570099e39476f746ce48233921d19"
+  integrity sha512-OgoSjqmnWM8F6OUFzWLyFvGrWtizZogewTL3uwRLkIBoXePrj14esm/3O+Y3Kho2ha4+YuOjoLpdsy0DmTqWtw==
   dependencies:
     "@0x/assert" "^2.1.0"
     "@0x/json-schemas" "^3.0.11"