Bump set-protocol-v2 package and run unit tests

Author: williamsfu99

package.json

@@ -58,7 +58,7 @@
         "@0xproject/types": "^1.1.4",
         "@0xproject/typescript-typings": "^3.0.2",
         "@0xproject/utils": "^2.0.2",
-        "@setprotocol/set-protocol-v2": "^0.1.9",
+        "@setprotocol/set-protocol-v2": "^0.1.10",
         "@types/chai-as-promised": "^7.1.3",
         "@types/jest": "^26.0.5",
         "@types/web3": "^1.2.2",

src/api/PerpV2LeverageViewerAPI.ts

@@ -16,10 +16,8 @@
 
 'use strict';
 
-import { ContractTransaction } from 'ethers';
 import { Provider } from '@ethersproject/providers';
 import { Address } from '@setprotocol/set-protocol-v2/utils/types';
-import { TransactionOverrides } from '@setprotocol/set-protocol-v2/dist/typechain';
 import { BigNumber } from 'ethers/lib/ethers';
 import { VAssetDisplayInfo } from '../types';
 
@@ -49,29 +47,6 @@ export default class PerpV2LeverageViewerAPI {
     this.assert = assertions || new Assertions();
   }
 
-  /**
-   * Initializes the PerpV2LeverageModuleViewer to the SetToken. Only callable by the SetToken's manager.
-   *
-   * @param setTokenAddress             Address of the SetToken to initialize
-   * @param callerAddress               The address of user transferring from (optional)
-   * @param txOpts                      Overrides for transaction (optional)
-   *
-   * @return                            Transaction hash of the initialize transaction
-   */
-  public async initializeAsync(
-    setTokenAddress: Address,
-    callerAddress: Address = undefined,
-    txOpts: TransactionOverrides = {}
-  ): Promise<ContractTransaction> {
-    this.assert.schema.isValidAddress('setTokenAddress', setTokenAddress);
-
-    return await this.perpV2LeverageModuleViewerWrapper.initialize(
-      setTokenAddress,
-      callerAddress,
-      txOpts,
-    );
-  }
-
   /**
    * Gets the address of the collateral token
    *

src/types/common.ts

@@ -94,8 +94,8 @@ export enum ModuleState {
 // For PerpV2LeverageModuleViewerWrapper
 export type VAssetDisplayInfo = {
   symbol: string;
-  address: Address;
-  positionUnit: BigNumber;
-  indexPrice: BigNumber;
-  currentLeverageRatio: BigNumber;
+  vAssetAddress: Address;
+  positionUnit: BigNumber; // 10^18 decimals
+  indexPrice: BigNumber; // 10^18 decimals
+  currentLeverageRatio: BigNumber; // 10^18 decimals
 };

src/wrappers/set-protocol-v2/PerpV2LeverageModuleViewerWrapper.ts

@@ -14,10 +14,8 @@
 'use strict';
 
 import { Address } from '@setprotocol/set-protocol-v2/utils/types';
-import { BigNumber, ContractTransaction } from 'ethers';
-import { TransactionOverrides } from '@setprotocol/set-protocol-v2/dist/typechain';
+import { BigNumber } from 'ethers';
 import { Provider } from '@ethersproject/providers';
-import { generateTxOpts } from '../../utils/transactions';
 import { VAssetDisplayInfo } from '../../types';
 
 import ContractWrapper from './ContractWrapper';
@@ -41,30 +39,6 @@ export default class PerpV2LeverageModuleViewerWrapper {
     this.perpV2LeverageModuleViewerAddress = perpV2LeverageModuleViewerAddress;
   }
 
-  /**
-   * Initializes this module to the SetToken. Only callable by the SetToken's manager.
-   *
-   * @param setTokenAddress             Address of the SetToken to initialize
-   * @param callerAddress               Address of caller (optional)
-   * @param txOpts                      Overrides for transaction (optional)
-   */
-  public async initialize(
-    setTokenAddress: Address,
-    callerAddress: Address = undefined,
-    txOpts: TransactionOverrides = {}
-  ): Promise<ContractTransaction> {
-    const txOptions = await generateTxOpts(txOpts);
-    const perpV2LeverageModuleViewerInstance = await this.contracts.loadPerpV2LeverageModuleViewerAsync(
-      this.perpV2LeverageModuleViewerAddress,
-      callerAddress
-    );
-
-    return await perpV2LeverageModuleViewerInstance.initialize(
-      setTokenAddress,
-      txOptions,
-    );
-  }
-
   /**
    * Gets the address of the collateral token
    *
@@ -94,7 +68,7 @@ export default class PerpV2LeverageModuleViewerWrapper {
    * @param slippage                  Expected slippage from entering position in precise units (1% = 10^16)
    * @param callerAddress             Address of the method caller
    *
-   * @return                          Maximum amount of Sets that can be issued
+   * @return                          Maximum amount of Sets that can be issued (10^18 decimals)
    */
   public async getMaximumSetTokenIssueAmount(
     setTokenAddress: Address,
@@ -119,7 +93,7 @@ export default class PerpV2LeverageModuleViewerWrapper {
    * @param callerAddress             Address of the method caller
    *
    * @return                          Collateral token address
-   * @return                          Total collateral value position unit
+   * @return                          Total collateral value position unit (10^18 decimals)
    */
   public async getTotalCollateralUnit(
     setTokenAddress: Address,
@@ -143,7 +117,7 @@ export default class PerpV2LeverageModuleViewerWrapper {
    * @param setTokenAddress           Instance of the SetToken
    * @param callerAddress             Address of the method caller
    *
-   * @return                          Array of info concerning size and leverage of current vAsset positions
+   * @return                          VAssetDisplayInfo array containing size/leverage of current vAsset positions
    */
   public async getVirtualAssetsDisplayInfo(
     setTokenAddress: Address,

test/api/PerpV2LeverageViewerAPI.spec.ts

@@ -15,7 +15,7 @@
 */
 
 import { ethers } from 'ethers';
-import { BigNumber, ContractTransaction } from 'ethers/lib/ethers';
+import { BigNumber } from 'ethers/lib/ethers';
 import { Address } from '@setprotocol/set-protocol-v2/utils/types';
 import { ether } from '@setprotocol/set-protocol-v2/dist/utils/common';
 import { VAssetDisplayInfo } from '@src/types';
@@ -30,17 +30,13 @@ jest.mock('@src/wrappers/set-protocol-v2/PerpV2LeverageModuleViewerWrapper');
 
 describe('PerpV2LeverageViewerAPI', () => {
   let perpV2LeverageModuleViewerAddress: Address;
-  let setTokenAddress: Address;
-  let owner: Address;
 
   let perpV2LeverageViewerAPI: PerpV2LeverageViewerAPI;
   let perpV2LeverageModuleViewerWrapper: PerpV2LeverageModuleViewerWrapper;
 
   beforeEach(async () => {
     [
-      owner,
       perpV2LeverageModuleViewerAddress,
-      setTokenAddress,
     ] = await provider.listAccounts();
 
     perpV2LeverageViewerAPI = new PerpV2LeverageViewerAPI(provider, perpV2LeverageModuleViewerAddress);
@@ -51,37 +47,6 @@ describe('PerpV2LeverageViewerAPI', () => {
     (PerpV2LeverageModuleViewerWrapper as any).mockClear();
   });
 
-  describe('#initializeAsync', () => {
-    let subjectSetTokenAddress: Address;
-    let subjectCallerAddress: Address;
-
-    let subjectTransactionOptions: any;
-
-    beforeEach(async () => {
-      subjectSetTokenAddress = setTokenAddress;
-      subjectCallerAddress = owner;
-      subjectTransactionOptions = {};
-    });
-
-    async function subject(): Promise<ContractTransaction> {
-      return perpV2LeverageViewerAPI.initializeAsync(
-        subjectSetTokenAddress,
-        subjectCallerAddress,
-        subjectTransactionOptions,
-      );
-    }
-
-    it('should call initialize on the PerpV2LeverageModuleViewerWrapper', async () => {
-      await subject();
-
-      expect(perpV2LeverageModuleViewerWrapper.initialize).to.have.beenCalledWith(
-        subjectSetTokenAddress,
-        subjectCallerAddress,
-        subjectTransactionOptions,
-      );
-    });
-  });
-
   describe('#getCollateralTokenAsync', () => {
     let nullCallerAddress: Address;
 
@@ -126,6 +91,7 @@ describe('PerpV2LeverageViewerAPI', () => {
 
       expect(perpV2LeverageModuleViewerWrapper.getMaximumSetTokenIssueAmount).to.have.beenCalledWith(
         subjectTokenAddress,
+        slippage,
         nullCallerAddress,
       );
     });

yarn.lock

@@ -1016,10 +1016,10 @@
   resolved "https://registry.yarnpkg.com/@openzeppelin/contracts/-/contracts-3.4.1-solc-0.7-2.tgz#371c67ebffe50f551c3146a9eec5fe6ffe862e92"
   integrity sha512-tAG9LWg8+M2CMu7hIsqHPaTyG4uDzjr6mhvH96LvOpLZZj6tgzTluBt+LsCf1/QaYrlis6pITvpIaIhE+iZB+Q==
 
-"@setprotocol/set-protocol-v2@^0.1.9":
-  version "0.1.9"
-  resolved "https://registry.yarnpkg.com/@setprotocol/set-protocol-v2/-/set-protocol-v2-0.1.9.tgz#1b0eef8667d01405f0b259bc5129986e5db7b53b"
-  integrity sha512-sPbCD6ngw4yIosXyOT+ytFZbFeMyHNOgDA6hdhrXkllsSKoJ2thc9Y6SqzF5kCPkK+bKmVhNF+cMTDMX0lemZg==
+"@setprotocol/set-protocol-v2@^0.1.10":
+  version "0.1.10"
+  resolved "https://registry.yarnpkg.com/@setprotocol/set-protocol-v2/-/set-protocol-v2-0.1.10.tgz#a8135e3e57cbdb857392bcf3cfe98d23bdc91333"
+  integrity sha512-PoDRg+ZeNk7eATvfqPxe1yMLTFoIgAfGA8oUmC8FTIM7F5Ya6wJCpzoJFaLcbd3lWK9+GUkoh6D1onLCatU5hw==
   dependencies:
     "@uniswap/v3-sdk" "^3.5.1"
     ethers "^5.5.2"