fix: 🐛 add improvements requested by VW

examples/advancedPLCRVoting.ts

@@ -34,7 +34,7 @@ export const advancedPLCRVotingCheckpoint = async (polymathAPI: PolymathAPI, tic
     investors: [myAddress],
     canSendAfter: [new Date()],
     canReceiveAfter: [new Date()],
-    expiryTime: [new Date(2021, 10)],
+    expiryTime: [new Date(2030, 10)],
   };
   await addInvestorsToWhitelist(polymathAPI, ticker, kycInvestorMultiData);
 
@@ -60,7 +60,7 @@ export const advancedPLCRVotingCheckpoint = async (polymathAPI: PolymathAPI, tic
     startTime: new Date(),
     commitDuration: 20,
     revealDuration: 20,
-    proposalTitles: ['Propostal Title Example'],
+    proposalTitles: ['Proposal Title Example'],
     proposalDetails: 'Proposal Details',
     choices: ['Choice one', 'Choice two'],
     choicesCounts: 2,

src/contract_wrappers/modules/checkpoint/voting/advanced_p_l_c_r_voting_checkpoint_wrapper/__tests__/common.test.ts

@@ -648,7 +648,7 @@ describe('AdvancedPLCRVotingCheckpointWrapper', () => {
       when(mockedBallotsMethod.callAsync()).thenResolve(expectedBallotsResult);
 
       const mockedParams = {
-        name: 'nee ballot',
+        name: 'new ballot',
         startTime: new Date(2019, 10),
         commitDuration: 80000,
         revealDuration: 3000,
@@ -1353,13 +1353,13 @@ describe('AdvancedPLCRVotingCheckpointWrapper', () => {
         ),
       ).thenResolve(expectedIsVoterAllowedResult);
 
-      // pending ballots
+      // Pending ballots
       const expectedPendingBallotsResult = [[new BigNumber(1), new BigNumber(2)], [new BigNumber(3), new BigNumber(4)]];
       const mockedPendingBallotsMethod = mock(MockedCallMethod);
       when(mockedContract.pendingBallots).thenReturn(instance(mockedPendingBallotsMethod));
       when(mockedPendingBallotsMethod.callAsync(mockedParams.txData.from)).thenResolve(expectedPendingBallotsResult);
 
-      // get ballot details
+      // Get ballot details
       const expectedBallotDetailsResult = [
         'ballot name',
         new BigNumber(1000),

src/contract_wrappers/modules/checkpoint/voting/advanced_p_l_c_r_voting_checkpoint_wrapper/common.ts

@@ -184,8 +184,8 @@ interface GetAdvancedPLCRVotingCheckpointLogsAsyncParams extends GetLogs {
 /**
  * @param name Name of the ballot (Should be unique)
  * @param startTime startTime of the ballot
- * @param commitDuration Unix time period till the voters commit there vote
- * @param revealDuration Unix time period till the voters reveal there vote starts when commit duration ends
+ * @param commitDuration Unix time period till the voters commit their vote
+ * @param revealDuration Unix time period till the voters reveal their vote starts when commit duration ends
  */
 export interface BallotParams extends TxParams {
   name: string;
@@ -228,11 +228,9 @@ export interface CreateCumulativeBallotParams extends BallotParams {
 }
 
 /**
- * @param choicesCounts No. of choices (If it is 0 then it means NAY/YAY ballot type is choosen).
  * @param checkpointId Valid checkpoint Id
  */
 export interface CreateCustomCumulativeBallotParams extends CreateCumulativeBallotParams {
-  choicesCounts: number[];
   checkpointId: number;
 }
 
@@ -546,14 +544,16 @@ export default abstract class AdvancedPLCRVotingCheckpointCommon extends ModuleC
 
   /**
    * Used to get the current stage of the ballot
+   * @return ballot state
    */
   public getCurrentBallotStage = async (params: BallotIdParams): Promise<BallotStage> => {
     const result = await (await this.contract).getCurrentBallotStage.callAsync(numberToBigNumber(params.ballotId));
     return parseBallotStageValue(result);
   };
 
   /**
-   * Get the voting power for an voter in terms of the token
+   * Get the voting power for a voter in terms of the token
+   * @return voting power
    */
   public getVoteTokenCount = async (params: VoteTokenCountParams): Promise<number> => {
     const result = await (await this.contract).getVoteTokenCount.callAsync(
@@ -565,6 +565,7 @@ export default abstract class AdvancedPLCRVotingCheckpointCommon extends ModuleC
 
   /**
    * Queries the result of a given ballot
+   * @return ballot result
    */
   public getBallotResults = async (params: BallotIdParams): Promise<BallotResult> => {
     const result = await (await this.contract).getBallotResults.callAsync(numberToBigNumber(params.ballotId));
@@ -576,7 +577,8 @@ export default abstract class AdvancedPLCRVotingCheckpointCommon extends ModuleC
   };
 
   /**
-   *  Get the details of the ballot
+   * Get the details of the ballot
+   * @return ballot details
    */
   public getBallotDetails = async (params: BallotIdParams): Promise<BallotDetails> => {
     const result = await (await this.contract).getBallotDetails.callAsync(numberToBigNumber(params.ballotId));
@@ -961,7 +963,7 @@ export default abstract class AdvancedPLCRVotingCheckpointCommon extends ModuleC
   };
 
   /**
-   * Allows the token issuer to scrapped down a ballot
+   * Allows the token issuer to cancel a ballot
    */
   public cancelBallot = async (params: CancelBallotParams): Promise<PolyResponse> => {
     assert.assert(
@@ -1142,7 +1144,7 @@ export default abstract class AdvancedPLCRVotingCheckpointCommon extends ModuleC
 
   private checkIndexOutOfBound = async (ballotId: number) => {
     const allBallots: Ballot[] = await this.getAllBallots();
-    assert.assert(allBallots.length > ballotId, ErrorCode.InvalidData, 'Index out of bound');
+    assert.assert(allBallots.length > ballotId, ErrorCode.InvalidData, 'Index out of bounds');
   };
 
   private checkValidStage = async (ballot: BallotIdParams, stage: BallotStage) => {