refactor: 💡 fix error if no votes cast on results

Author: sansan

src/api/entities/CorporateBallot/__tests__/index.ts

@@ -258,6 +258,52 @@ describe('CorporateBallot class', () => {
       await expect(corporateBallot.results()).rejects.toThrow('The CorporateBallot does not exist');
     });
 
+    it('should return 0 if no votes have been cast', async () => {
+      const mockRawMeta = createMockCorporateBallotMeta(mockBallotMeta);
+      const meshCorporateBallotMetaToCorporateBallotMetaSpy = jest.spyOn(
+        utilsConversionModule,
+        'meshCorporateBallotMetaToCorporateBallotMeta'
+      );
+
+      when(meshCorporateBallotMetaToCorporateBallotMetaSpy)
+        .calledWith(mockRawMeta)
+        .mockReturnValue(mockBallotMeta);
+
+      dsMockUtils.createQueryMock('corporateBallot', 'metas', {
+        returnValue: dsMockUtils.createMockOption(dsMockUtils.createMockCodec(mockRawMeta, false)),
+      });
+      dsMockUtils.createQueryMock('corporateBallot', 'results', {
+        returnValue: dsMockUtils.createMockVec(),
+      });
+
+      const results = await corporateBallot.results();
+
+      expect(results).toEqual({
+        title: mockBallotMeta.title,
+        motions: [
+          {
+            title: mockBallotMeta.motions[0].title,
+            infoLink: mockBallotMeta.motions[0].infoLink,
+            choices: [
+              {
+                choice: mockBallotMeta.motions[0].choices[0],
+                votes: new BigNumber(0),
+              },
+              {
+                choice: mockBallotMeta.motions[0].choices[1],
+                votes: new BigNumber(0),
+              },
+              {
+                choice: mockBallotMeta.motions[0].choices[2],
+                votes: new BigNumber(0),
+              },
+            ],
+            total: new BigNumber(0),
+          },
+        ],
+      });
+    });
+
     it('should return the results of the CorporateBallot', async () => {
       const mockResults = ['100', '200', '300'];
       const mockRawMeta = createMockCorporateBallotMeta(mockBallotMeta);
@@ -359,7 +405,6 @@ describe('CorporateBallot class', () => {
         },
         {
           power: mockVotePower2,
-          fallback: dsMockUtils.createMockOption(),
         },
       ];
 
@@ -396,6 +441,55 @@ describe('CorporateBallot class', () => {
         ],
       });
     });
+
+    it('should return the votes of the CorporateBallot by identity', async () => {
+      const mockRawMeta = createMockCorporateBallotMeta(mockBallotMeta);
+      dsMockUtils.createQueryMock('corporateBallot', 'metas', {
+        returnValue: dsMockUtils.createMockOption(dsMockUtils.createMockCodec(mockRawMeta, false)),
+      });
+
+      const meshCorporateBallotMetaToCorporateBallotMetaSpy = jest.spyOn(
+        utilsConversionModule,
+        'meshCorporateBallotMetaToCorporateBallotMeta'
+      );
+
+      when(meshCorporateBallotMetaToCorporateBallotMetaSpy)
+        .calledWith(mockRawMeta)
+        .mockReturnValue(mockBallotMeta);
+
+      dsMockUtils.createQueryMock('corporateBallot', 'votes', {
+        returnValue: dsMockUtils.createMockVec(),
+      });
+
+      const votes = await corporateBallot.votesByIdentity('12341234-1234-1234-1234-123412341234');
+
+      expect(votes).toEqual({
+        title: mockBallotMeta.title,
+        motions: [
+          {
+            title: mockBallotMeta.motions[0].title,
+            infoLink: mockBallotMeta.motions[0].infoLink,
+            choices: [
+              {
+                choice: mockBallotMeta.motions[0].choices[0],
+                power: new BigNumber(0),
+                fallback: undefined,
+              },
+              {
+                choice: mockBallotMeta.motions[0].choices[1],
+                power: new BigNumber(0),
+                fallback: undefined,
+              },
+              {
+                choice: mockBallotMeta.motions[0].choices[2],
+                power: new BigNumber(0),
+                fallback: undefined,
+              },
+            ],
+          },
+        ],
+      });
+    });
   });
 
   describe('method: vote', () => {

src/api/entities/CorporateBallot/index.ts

@@ -205,7 +205,10 @@ export class CorporateBallot extends CorporateActionBase {
         total: new BigNumber(0),
       };
       choices.forEach(choice => {
-        const choiceVoteTally = u128ToBigNumber(rawResults[resultIndex]);
+        // when no votes have been cast the rawResults[resultIndex] is undefined
+        const choiceVoteTally = rawResults[resultIndex]
+          ? u128ToBigNumber(rawResults[resultIndex])
+          : new BigNumber(0);
         motionWithResults.choices.push({
           choice,
           votes: choiceVoteTally,
@@ -261,11 +264,14 @@ export class CorporateBallot extends CorporateActionBase {
           title,
           infoLink,
           choices: choices.map(choice => {
-            const { power: rawPower, fallback: rawFallback } = rawDidVotes[index];
+            const { power: rawPower, fallback: rawFallback } = rawDidVotes[index] ?? {
+              power: new BigNumber(0),
+              fallback: undefined,
+            };
 
             let fallback: BigNumber | undefined;
 
-            if (rawFallback.isSome) {
+            if (rawFallback?.isSome) {
               fallback = u16ToBigNumber(rawFallback.unwrap());
             }
 

src/api/procedures/castBallotVote.ts

@@ -41,6 +41,11 @@ export function assertBallotIsActive(ballotDetails: CorporateBallotDetails): voi
     throw new PolymeshError({
       code: ErrorCode.ValidationError,
       message: 'Ballot is not active',
+      data: {
+        status,
+        startDate: ballotDetails.startDate,
+        endDate: ballotDetails.endDate,
+      },
     });
   }
 }

src/api/procedures/modifyBallot.ts

@@ -198,7 +198,7 @@ export function getAuthorization(
     transactions.push(TxTags.corporateBallot.ChangeEnd);
   }
 
-  if (rcv) {
+  if (typeof rcv !== 'undefined') {
     transactions.push(TxTags.corporateBallot.ChangeRcv);
   }
 

src/api/procedures/utils.ts

@@ -738,6 +738,10 @@ export async function assertBallotRecordDateValid(
     throw new PolymeshError({
       code: ErrorCode.ValidationError,
       message: 'The record date cannot be after the ballot start date',
+      data: {
+        checkpointDate,
+        startDate,
+      },
     });
   }
 }