Merge remote-tracking branch 'origin/beta' into docs/types-interfaces

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polymathnetwork/sdk",
-  "version": "2.0.1-beta.113",
+  "version": "2.0.1-beta.114",
   "description": "A Javascript SDK for interacting with the Polymath network for the browser and Node.js",
   "bugs": {
     "url": "https://github.com/PolymathNetwork/polymath-sdk/issues"

src/procedures/RevokeKyc.ts

@@ -5,9 +5,21 @@ import { ProcedureType, PolyTransactionTag, ErrorCode, RevokeKycProcedureArgs }
 import { PolymathError } from '../PolymathError';
 import { Shareholder, SecurityToken } from '../entities';
 
+/**
+ * Procedure that revokes KYC for a list of investors
+ */
 export class RevokeKyc extends Procedure<RevokeKycProcedureArgs, Shareholder[]> {
   public type = ProcedureType.RevokeKyc;
 
+  /**
+   * Sets all KYC dates for a shareholder to epoch. This effectively makes them unable to send or receive Security Tokens
+   *
+   * Note that this procedure will fail if:
+   * - The shareholder address array is empty
+   * - The Security Token doesn't exist
+   * - KYC is already revoked for at least one of the addresses in the list
+   * - Shareholders Feature isn't enabled
+   */
   public async prepareTransactions() {
     const { symbol, shareholderAddresses } = this.args;
     const { contractWrappers, factories } = this.context;