fix: check currentCheckpoint is lower than params checkpoint, ST

Author: Victor Wiebe

src/contract_wrappers/tokens/__tests__/security_token_wrapper.test.ts

@@ -714,6 +714,14 @@ describe('SecurityTokenWrapper', () => {
         checkpointId: 1,
       };
 
+      const expectedCheckpointIdResult = new BigNumber(2);
+      // Mocked method
+      const mockedCheckpointIdMethod = mock(MockedCallMethod);
+      // Stub the method
+      when(mockedContract.currentCheckpointId).thenReturn(instance(mockedCheckpointIdMethod));
+      // Stub the request
+      when(mockedCheckpointIdMethod.callAsync()).thenResolve(expectedCheckpointIdResult);
+
       const expectedDecimalsResult = new BigNumber(18);
       const mockedDecimalsMethod = mock(MockedCallMethod);
       when(mockedContract.decimals).thenReturn(instance(mockedDecimalsMethod));
@@ -737,6 +745,8 @@ describe('SecurityTokenWrapper', () => {
       verify(mockedMethod.callAsync(objectContaining(numberToBigNumber(mockedParams.checkpointId)))).once();
       verify(mockedContract.decimals).once();
       verify(mockedDecimalsMethod.callAsync()).once();
+      verify(mockedContract.currentCheckpointId).once();
+      verify(mockedCheckpointIdMethod.callAsync()).once();
     });
   });
 
@@ -750,6 +760,14 @@ describe('SecurityTokenWrapper', () => {
         checkpointId: 1,
       };
 
+      const expectedCheckpointIdResult = new BigNumber(2);
+      // Mocked method
+      const mockedCheckpointIdMethod = mock(MockedCallMethod);
+      // Stub the method
+      when(mockedContract.currentCheckpointId).thenReturn(instance(mockedCheckpointIdMethod));
+      // Stub the request
+      when(mockedCheckpointIdMethod.callAsync()).thenResolve(expectedCheckpointIdResult);
+
       const expectedDecimalsResult = new BigNumber(18);
       const mockedDecimalsMethod = mock(MockedCallMethod);
       when(mockedContract.decimals).thenReturn(instance(mockedDecimalsMethod));
@@ -775,6 +793,8 @@ describe('SecurityTokenWrapper', () => {
       ).once();
       verify(mockedContract.decimals).once();
       verify(mockedDecimalsMethod.callAsync()).once();
+      verify(mockedContract.currentCheckpointId).once();
+      verify(mockedCheckpointIdMethod.callAsync()).once();
     });
   });
 

src/contract_wrappers/tokens/security_token_wrapper.ts

@@ -1337,6 +1337,10 @@ export default class SecurityTokenWrapper extends ERC20TokenWrapper {
   };
 
   public totalSupplyAt = async (params: CheckpointIdParams) => {
+    assert.assert(
+        (await this.currentCheckpointId()).isGreaterThanOrEqualTo(params.checkpointId),
+        'Checkpoint id must be less than or equal to currentCheckpoint',
+    );
     return weiToValue(
       await (await this.contract).totalSupplyAt.callAsync(numberToBigNumber(params.checkpointId)),
       await this.decimals(),
@@ -1345,6 +1349,10 @@ export default class SecurityTokenWrapper extends ERC20TokenWrapper {
 
   public balanceOfAt = async (params: BalanceOfAtParams) => {
     assert.isETHAddressHex('investor', params.investor);
+    assert.assert(
+      (await this.currentCheckpointId()).isGreaterThanOrEqualTo(params.checkpointId),
+      'Checkpoint id must be less than or equal to currentCheckpoint',
+    );
     return weiToValue(
       await (await this.contract).balanceOfAt.callAsync(params.investor, numberToBigNumber(params.checkpointId)),
       await this.decimals(),
@@ -1632,7 +1640,7 @@ export default class SecurityTokenWrapper extends ERC20TokenWrapper {
 
   public removeDocument = async (params: DocumentParams) => {
     await this.checkOnlyOwner(params.txData);
-    const document = await this.getDocument({name: params.name});
+    const document = await this.getDocument({ name: params.name });
     assert.assert(document.documentUri.length !== 0, 'Document does not exist');
     return (await this.contract).removeDocument.sendTransactionAsync(
       stringToBytes32(params.name),