feat: apply SecurityToken 3.0 changes

Author: remon-nashid

src/LowLevel/ContractWrapperFactory/ContractWrapperFactory.ts

@@ -0,0 +1,34 @@
+import { Context } from '../LowLevel';
+import { SecurityToken } from '../SecurityToken';
+
+export default class ContractWrapperFactory {
+  static packVersion(versions: number[]) {
+    return versions.join('.');
+  }
+
+  /**
+   * Given contract's address, this function will return a version agnostic contract wrapper.
+   */
+  static wrapContract = async (contractName: string, address: string, context: Context) => {
+    // First, wrap this address with a 'stub' wrapper in order to get deployed contract's version.
+    const stubAbi = (await import(`../${contractName}/stub.abi`)).default;
+    const stubClass = (await import(`../${contractName}/stub`)).default;
+    const stubLowLevelContract = new stubClass({ address, abi: stubAbi, context });
+
+    const versionArray = await stubLowLevelContract.getVersion();
+    const packedVersion = ContractWrapperFactory.packVersion(versionArray);
+
+    // Now that we know deployed contract version, we'll wrap it with a version specific contract wrapper.
+    const ContractWrapper = (await import(`../${contractName}/${packedVersion}`)).default;
+    const wrappedContract = new ContractWrapper({ address, context });
+    return wrappedContract;
+  };
+
+  static getSecurityToken = async (address: string, context: Context) => {
+    return (await ContractWrapperFactory.wrapContract(
+      'SecurityToken',
+      address,
+      context
+    )) as SecurityToken;
+  };
+}

src/LowLevel/ContractWrapperFactory/index.ts

@@ -0,0 +1,3 @@
+import ContractWrapperFactory from './ContractWrapperFactory';
+
+export default ContractWrapperFactory;

src/LowLevel/DividendCheckpoint.ts

@@ -16,9 +16,11 @@ import {
   GetDividendsByCheckpointArgs,
   GetDividendArgs,
   SetDividendsWalletArgs,
- TaxWithholding, DividendModuleTypes } from './types';
+  TaxWithholding,
+  DividendModuleTypes,
+} from './types';
 import { fromUnixTimestamp, fromWei, toWei, fromDivisible, toAscii, getOptions } from './utils';
-
+import ContractWrapperFactory from './ContractWrapperFactory';
 
 interface InternalDividend {
   checkpointId: string;
@@ -144,10 +146,7 @@ export abstract class DividendCheckpoint<
 
   public async getDividends() {
     const stAddress = await this.securityTokenAddress();
-    const securityToken = new SecurityToken({
-      address: stAddress,
-      context: this.context,
-    });
+    const securityToken = await ContractWrapperFactory.getSecurityToken(stAddress, this.context);
 
     const currentCheckpointIndex = await securityToken.currentCheckpointId();
     const checkpointIndexes = range(1, currentCheckpointIndex + 1);