Upgrade ethers to 5.4.6 / set-protocol-v2@0.1.0 (#76)

* Upgrade ethers to 5.4.6, set-protocol-v2 to 0.1.0 Co-authored-by: Rootul Patel <rootulp@gmail.com>
SetProtocol · Sep 15, 2021 · 181ccc6 · 181ccc6
1 parent 0bc80e8
commit 181ccc6
Show file tree

Hide file tree

Showing 14 changed files with 313 additions and 958 deletions.
diff --git a/package.json b/package.json
@@ -39,12 +39,11 @@
         "node": ">=10.16.0"
     },
     "devDependencies": {
-        "@ethersproject/providers": "^5.0.18",
         "@types/node": "^14.0.23",
         "chai": "^4.2.0",
         "chai-as-promised": "^7.1.1",
         "chai-jest-mocks": "^1.2.4",
-        "ganache-cli": "^6.9.1",
+        "ganache-cli": "^6.12.2",
         "husky": "^4.2.5",
         "jest": "^26.1.0",
         "lint-staged": "^10.2.11",
@@ -53,13 +52,13 @@
         "tslint-eslint-rules": "^5.4.0",
         "typedoc": "^0.17.8",
         "typedoc-plugin-markdown": "^2.3.1",
-        "typescript": "^3.9.7"
+        "typescript": "^4.4.2"
     },
     "dependencies": {
         "@0xproject/types": "^1.1.4",
         "@0xproject/typescript-typings": "^3.0.2",
         "@0xproject/utils": "^2.0.2",
-        "@setprotocol/set-protocol-v2": "0.0.31",
+        "@setprotocol/set-protocol-v2": "^0.1.0",
         "@types/chai-as-promised": "^7.1.3",
         "@types/jest": "^26.0.5",
         "@types/web3": "^1.2.2",
@@ -69,7 +68,7 @@
         "dotenv": "^8.2.0",
         "ethereum-types": "^3.2.0",
         "ethereumjs-util": "^7.0.3",
-        "ethers": "^5.0.3",
+        "ethers": "5.4.6",
         "graph-results-pager": "^1.0.3",
         "js-big-decimal": "^1.3.4",
         "jsonschema": "^1.2.6",
@@ -112,7 +111,8 @@
             "js",
             "jsx",
             "json",
-            "node"
+            "node",
+            "d.ts"
         ],
         "moduleNameMapper": {
             "^@src/(.*)": "<rootDir>/src/$1",

diff --git a/src/api/DebtIssuanceAPI.ts b/src/api/DebtIssuanceAPI.ts
@@ -216,7 +216,13 @@ export default class DebtIssuanceAPI {
     quantity: BigNumber,
     isIssue: boolean,
     callerAddress: Address = undefined,
-  ): Promise<(BigNumber)[][]> {
+  ): Promise<
+      [BigNumber, BigNumber, BigNumber] & {
+        totalQuantity: BigNumber;
+        managerFee: BigNumber;
+        protocolFee: BigNumber;
+      }
+    > {
     this.assert.schema.isValidAddress('setAddress', setTokenAddress);
     this.assert.common.isNotUndefined(isIssue, 'isIssue arg must be a boolean.');
 

diff --git a/src/api/ERC20API.ts b/src/api/ERC20API.ts
@@ -120,7 +120,7 @@ export default class ERC20API {
   public async getDecimalsAsync(
     tokenAddress: Address,
     callerAddress: Address = undefined
-  ): Promise<BigNumber> {
+  ): Promise<number> {
     this.assert.schema.isValidAddress('tokenAddress', tokenAddress);
 
     return this.erc20Wrapper.decimals(tokenAddress, callerAddress);

diff --git a/src/api/SetTokenAPI.ts b/src/api/SetTokenAPI.ts
@@ -87,7 +87,7 @@ export default class SetTokenAPI {
     symbol: string,
     callerAddress: Address = undefined,
     txOpts: TransactionOverrides = {}
-  ): Promise<Address[]> {
+  ): Promise<ContractTransaction> {
     this.assert.common.isNotEmptyArray(componentAddresses, 'Component addresses must contain at least one component.');
     this.assert.common.isEqualLength(componentAddresses, units, 'Component addresses and units must be equal length.');
     this.assert.schema.isValidAddressList('componentAddresses', componentAddresses);

diff --git a/src/wrappers/set-protocol-v2/ContractWrapper.ts b/src/wrappers/set-protocol-v2/ContractWrapper.ts
@@ -24,15 +24,14 @@ import {
   BasicIssuanceModule,
   DebtIssuanceModule,
   Controller,
-  ERC20,
   ProtocolViewer,
   SetToken,
   SetTokenCreator,
   StreamingFeeModule,
   TradeModule,
   NavIssuanceModule,
   PriceOracle,
-} from '@setprotocol/set-protocol-v2/dist/utils/contracts';
+} from '@setprotocol/set-protocol-v2/typechain';
 import { BasicIssuanceModule__factory } from '@setprotocol/set-protocol-v2/dist/typechain/factories/BasicIssuanceModule__factory';
 import { DebtIssuanceModule__factory } from '@setprotocol/set-protocol-v2/dist/typechain/factories/DebtIssuanceModule__factory';
 import { Controller__factory } from '@setprotocol/set-protocol-v2/dist/typechain/factories/Controller__factory';
@@ -71,7 +70,7 @@ export default class ContractWrapper {
   public async loadControllerContractAsync(
     controllerAddress: Address,
     signer: Signer,
-  ): Controller {
+  ): Promise<Controller> {
     const cacheKey = `Controller_${controllerAddress}_${await signer.getAddress()}`;
 
     if (cacheKey in this.cache) {
@@ -97,12 +96,12 @@ export default class ContractWrapper {
   public async loadERC20Async(
     tokenAddress: Address,
     callerAddress?: Address,
-  ): SetToken {
+  ): Promise<SetToken> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `ERC20_${tokenAddress}_${await signer.getAddress()}`;
 
     if (cacheKey in this.cache) {
-      return this.cache[cacheKey] as ERC20;
+      return this.cache[cacheKey] as SetToken;
     } else {
       const tokenContract = ERC20__factory.connect(
         tokenAddress,
@@ -124,7 +123,7 @@ export default class ContractWrapper {
   public async loadBasicIssuanceModuleAsync(
     basicIssuanceModuleAddress: Address,
     callerAddress?: Address,
-  ): BasicIssuanceModule {
+  ): Promise<BasicIssuanceModule> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `BasicIssuance_${basicIssuanceModuleAddress}_${await signer.getAddress()}`;
 
@@ -151,7 +150,7 @@ export default class ContractWrapper {
   public async loadTradeModuleAsync(
     tradeModuleAddress: Address,
     callerAddress?: Address,
-  ): TradeModule {
+  ): Promise<TradeModule> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `TradeModule_${tradeModuleAddress}_${await signer.getAddress()}`;
 
@@ -188,7 +187,7 @@ export default class ContractWrapper {
   public async loadNavIssuanceModuleAsync(
     navIssuanceModuleAddress: Address,
     callerAddress?: Address,
-  ): NavIssuanceModule {
+  ): Promise<NavIssuanceModule> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `NavIssuanceModule_${navIssuanceModuleAddress}_${await signer.getAddress()}`;
 
@@ -215,7 +214,7 @@ export default class ContractWrapper {
   public async loadMasterPriceOracleAsync(
     masterOracleAddress: Address,
     callerAddress?: Address,
-  ): PriceOracle {
+  ): Promise<PriceOracle> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `MasterPriceOracle_${masterOracleAddress}_${await signer.getAddress()}`;
 
@@ -242,7 +241,7 @@ export default class ContractWrapper {
   public async loadSetTokenAsync(
     setTokenAddress: Address,
     callerAddress?: Address,
-  ): SetToken {
+  ): Promise<SetToken> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `SetToken_${setTokenAddress}_${await signer.getAddress()}`;
 
@@ -269,7 +268,7 @@ export default class ContractWrapper {
   public async loadSetTokenCreatorAsync(
     setTokenCreatorAddress: Address,
     signer: Signer,
-  ): SetTokenCreator {
+  ): Promise<SetTokenCreator> {
     const cacheKey = `SetTokenCreator_${setTokenCreatorAddress}_${await signer.getAddress()}`;
 
     if (cacheKey in this.cache) {
@@ -295,7 +294,7 @@ export default class ContractWrapper {
   public async loadStreamingFeeModuleAsync(
     streamingFeeModuleAddress: Address,
     callerAddress?: Address,
-  ): StreamingFeeModule {
+  ): Promise<StreamingFeeModule> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `StreamingFeeModule_${streamingFeeModuleAddress}_${await signer.getAddress()}`;
 
@@ -322,7 +321,7 @@ export default class ContractWrapper {
   public async loadProtocolViewerContractAsync(
     protocolViewerAddress: Address,
     signer: Signer,
-  ): ProtocolViewer {
+  ): Promise<ProtocolViewer> {
     const cacheKey = `ProtocolViewer_${protocolViewerAddress}_${await signer.getAddress()}`;
 
     if (cacheKey in this.cache) {
@@ -349,7 +348,7 @@ export default class ContractWrapper {
   public async loadDebtIssuanceModuleAsync(
     debtIssuanceModuleAddress: Address,
     callerAddress?: Address,
-  ): DebtIssuanceModule {
+  ): Promise<DebtIssuanceModule> {
     const signer = (this.provider as JsonRpcProvider).getSigner(callerAddress);
     const cacheKey = `DebtIssuanceModule_${debtIssuanceModuleAddress}_${await signer.getAddress()}`;
 

diff --git a/src/wrappers/set-protocol-v2/DebtIssuanceModuleWrapper.ts b/src/wrappers/set-protocol-v2/DebtIssuanceModuleWrapper.ts
@@ -222,7 +222,13 @@ export default class DebtIssuanceModuleWrapper {
     quantity: BigNumber,
     isIssue: boolean,
     callerAddress: Address = undefined,
-  ): Promise<(BigNumber)[][]> {
+  ): Promise<
+      [BigNumber, BigNumber, BigNumber] & {
+        totalQuantity: BigNumber;
+        managerFee: BigNumber;
+        protocolFee: BigNumber;
+      }
+    > {
     const debtIssuanceModuleInstance = await this.contracts.loadDebtIssuanceModuleAsync(
       this.debtIssuanceModuleAddress,
       callerAddress

diff --git a/src/wrappers/set-protocol-v2/ERC20Wrapper.ts b/src/wrappers/set-protocol-v2/ERC20Wrapper.ts
@@ -128,7 +128,7 @@ export default class ERC20Wrapper {
   public async decimals(
     tokenAddress: Address,
     callerAddress: Address = undefined
-  ): Promise<BigNumber> {
+  ): Promise<number> {
     const tokenInstance = await this.contracts.loadERC20Async(
       tokenAddress,
       callerAddress

diff --git a/src/wrappers/set-protocol-v2/SetTokenCreatorWrapper.ts b/src/wrappers/set-protocol-v2/SetTokenCreatorWrapper.ts
@@ -18,6 +18,7 @@
 
 import { Provider, JsonRpcProvider } from '@ethersproject/providers';
 import { BigNumber } from 'ethers/lib/ethers';
+import { ContractTransaction } from 'ethers';
 import { Address } from '@setprotocol/set-protocol-v2/utils/types';
 import { TransactionOverrides } from '@setprotocol/set-protocol-v2/dist/typechain';
 
@@ -64,7 +65,7 @@ export default class SetTokenCreatorWrapper {
     symbol: string,
     callerAddress?: Address,
     txOpts: TransactionOverrides = {}
-  ): Promise<Address[]> {
+  ): Promise<ContractTransaction> {
     const setTokenCreator = await this.contracts.loadSetTokenCreatorAsync(
       this.setTokenCreatorAddress,
       (this.provider as JsonRpcProvider).getSigner(callerAddress)

diff --git a/test/api/DebtIssuanceAPI.spec.ts b/test/api/DebtIssuanceAPI.spec.ts
@@ -312,7 +312,13 @@ describe('DebtIssuanceAPI', () => {
       subjectCallerAddress = '0x0e2298E3B3390e3b945a5456fBf59eCc3f55DA16';
     });
 
-    async function subject(): Promise<(Address|BigNumber)[][]> {
+    async function subject(): Promise<
+      [BigNumber, BigNumber, BigNumber] & {
+        totalQuantity: BigNumber;
+        managerFee: BigNumber;
+        protocolFee: BigNumber;
+      }
+    > {
       return await debtIssuanceAPI.calculateTotalFeesAsync(
         subjectSetTokenAddress,
         subjectQuantity,

diff --git a/test/api/ERC20API.spec.ts b/test/api/ERC20API.spec.ts
@@ -188,7 +188,7 @@ describe('ERC20API', () => {
       nullCallerAddress = '0x0000000000000000000000000000000000000000';
     });
 
-    async function subject(): Promise<BigNumber> {
+    async function subject(): Promise<number> {
       return await erc20API.getDecimalsAsync(
         subjectTokenAddress,
         nullCallerAddress,

diff --git a/test/api/SetTokenAPI.spec.ts b/test/api/SetTokenAPI.spec.ts
@@ -121,7 +121,7 @@ describe('SetTokenAPI', () => {
       subjectTransactionOptions = {};
     });
 
-    async function subject(): Promise<Address[]> {
+    async function subject(): Promise<ContractTransaction> {
       return await setTokenAPI.createAsync(
         subjectComponentAddresses,
         subjectUnits,

diff --git a/test/wrappers/set-protocol-v2/DebtIssuanceModuleWrapper.spec.ts b/test/wrappers/set-protocol-v2/DebtIssuanceModuleWrapper.spec.ts
@@ -525,7 +525,13 @@ describe('DebtIssuanceModuleWrapper', () => {
       subjectCaller = functionCaller;
     });
 
-    async function subject(): Promise<(BigNumber)[][]> {
+    async function subject(): Promise<
+      [BigNumber, BigNumber, BigNumber] & {
+        totalQuantity: BigNumber;
+        managerFee: BigNumber;
+        protocolFee: BigNumber;
+      }
+    > {
       await debtIssuanceModule.initialize(
         subjectSetTokenAddress,
         subjectMaxManagerFee,

diff --git a/test/wrappers/set-protocol-v2/ERC20Wrapper.spec.ts b/test/wrappers/set-protocol-v2/ERC20Wrapper.spec.ts
@@ -58,7 +58,7 @@ describe('ERC20Wrapper', () => {
     const tokenSupply: BigNumber = ether(1000000000);
     const tokenName: string = 'Token';
     const tokenSymbol: string = 'Symbol';
-    const tokenDecimals: BigNumber = BigNumber.from(18);
+    const tokenDecimals: number = 18;
 
     let subjectTokenAddress: Address;
 
@@ -71,7 +71,7 @@ describe('ERC20Wrapper', () => {
       name: string,
       symbol: string,
       supply: BigNumber,
-      decimals: BigNumber,
+      decimals: number,
     }> {
       const name = await erc20Wrapper.name(subjectTokenAddress);
       const symbol = await erc20Wrapper.symbol(subjectTokenAddress);
@@ -87,7 +87,7 @@ describe('ERC20Wrapper', () => {
       expect(name).to.eql(tokenName);
       expect(symbol).to.eql(tokenSymbol);
       expect(supply.toString()).to.eql(tokenSupply.toString());
-      expect(decimals.toString()).to.eql(tokenDecimals.toString());
+      expect(decimals).to.eql(tokenDecimals);
     });
   });