@enzymefinance/testutils 4.0.0-next.1 → 4.0.0-next.6

package/src/scaffolding/extensions/external-positions/actions.ts

@@ -1,15 +1,42 @@
-import { AddressLike, extractEvent } from '@enzymefinance/ethers';
-import { SignerWithAddress } from '@enzymefinance/hardhat';
+import type { AddressLike } from '@enzymefinance/ethers';
+import { extractEvent } from '@enzymefinance/ethers';
+import type { SignerWithAddress } from '@enzymefinance/hardhat';
+import type { ComptrollerLib, ExternalPositionManager } from '@enzymefinance/protocol';
 import {
-  ComptrollerLib,
+  callOnExternalPositionArgs,
   encodeArgs,
-  ExternalPositionManager,
   ExternalPositionManagerActionId,
   externalPositionReactivateArgs,
   externalPositionRemoveArgs,
   IExternalPositionProxy,
 } from '@enzymefinance/protocol';
-import { BigNumberish, BytesLike } from 'ethers';
+import type { BigNumberish, BytesLike } from 'ethers';
+
+export async function callOnExternalPosition({
+  signer,
+  comptrollerProxy,
+  externalPositionManager,
+  externalPositionProxy,
+  actionId,
+  actionArgs,
+}: {
+  signer: SignerWithAddress;
+  comptrollerProxy: ComptrollerLib;
+  externalPositionManager: ExternalPositionManager;
+  externalPositionProxy: AddressLike;
+  actionId: BigNumberish;
+  actionArgs: BytesLike;
+}) {
+  const callArgs = callOnExternalPositionArgs({
+    actionArgs,
+    actionId,
+    externalPositionProxy,
+  });
+
+  return comptrollerProxy
+    .connect(signer)
+    .callOnExtension(externalPositionManager, ExternalPositionManagerActionId.CallOnExternalPosition, callArgs);
+}
 
 export async function createExternalPosition({
   signer,
@@ -36,7 +63,7 @@ export async function createExternalPosition({
 
   const externalPositionProxy = new IExternalPositionProxy(event[0].args.externalPosition, signer);
 
-  return { receipt, externalPositionProxy };
+  return { externalPositionProxy, receipt };
 }
 
 export async function reactivateExternalPosition({

package/src/scaffolding/extensions/external-positions/compound.ts

@@ -1,39 +1,17 @@
-import { AddressLike } from '@enzymefinance/ethers';
-import { SignerWithAddress } from '@enzymefinance/hardhat';
+import type { AddressLike } from '@enzymefinance/ethers';
+import type { SignerWithAddress } from '@enzymefinance/hardhat';
+import type { ComptrollerLib, ExternalPositionManager, VaultLib } from '@enzymefinance/protocol';
 import {
-  ComptrollerLib,
-  encodeArgs,
-  ExternalPositionManager,
-  VaultLib,
-  callOnExternalPositionArgs,
-  compoundExternalPositionActionArgs,
-  ExternalPositionManagerActionId,
   CompoundDebtPositionActionId,
+  compoundExternalPositionActionArgs,
+  encodeArgs,
   ExternalPositionType,
 } from '@enzymefinance/protocol';
-import { BigNumberish } from 'ethers';
-import { createExternalPosition } from './actions';
+import type { BigNumberish } from 'ethers';
 
-// TODO: re-namespace all functions with `CompoundDebtPosition`
-
-export async function createCompoundDebtPosition({
-  signer,
-  comptrollerProxy,
-  externalPositionManager,
-}: {
-  signer: SignerWithAddress;
-  comptrollerProxy: ComptrollerLib;
-  externalPositionManager: ExternalPositionManager;
-}) {
-  return createExternalPosition({
-    signer,
-    comptrollerProxy,
-    externalPositionManager,
-    externalPositionTypeId: ExternalPositionType.CompoundDebtPosition,
-  });
-}
+import { callOnExternalPosition, createExternalPosition } from './actions';
 
-export async function addCollateral({
+export async function compoundDebtPositionAddCollateral({
   comptrollerProxy,
   externalPositionManager,
   fundOwner,
@@ -51,129 +29,117 @@ export async function addCollateral({
   externalPositionProxy: AddressLike;
 }) {
   const actionArgs = compoundExternalPositionActionArgs({
-    assets,
     amounts,
+    assets,
     data: encodeArgs(['address[]'], [cTokens]),
   });
 
-  const callArgs = callOnExternalPositionArgs({
-    externalPositionProxy,
+  return callOnExternalPosition({
+    actionArgs,
     actionId: CompoundDebtPositionActionId.AddCollateralAssets,
-    encodedCallArgs: actionArgs,
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionProxy,
+    signer: fundOwner,
   });
-
-  const addCollateralTx = comptrollerProxy
-    .connect(fundOwner)
-    .callOnExtension(externalPositionManager, ExternalPositionManagerActionId.CallOnExternalPosition, callArgs);
-
-  return addCollateralTx;
 }
 
-export async function removeCollateral({
+export async function compoundDebtPositionBorrow({
   comptrollerProxy,
   externalPositionManager,
   fundOwner,
+  externalPositionProxy,
   assets,
   amounts,
-  externalPositionProxy,
   cTokens,
 }: {
   comptrollerProxy: ComptrollerLib;
+  vaultProxy: VaultLib;
   externalPositionManager: ExternalPositionManager;
   fundOwner: SignerWithAddress;
+  externalPositionProxy: AddressLike;
   assets: AddressLike[];
   amounts: BigNumberish[];
-  externalPositionProxy: AddressLike;
   cTokens: AddressLike[];
 }) {
   const actionArgs = compoundExternalPositionActionArgs({
-    assets,
     amounts,
+    assets,
     data: encodeArgs(['address[]'], [cTokens]),
   });
 
-  const callArgs = callOnExternalPositionArgs({
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: CompoundDebtPositionActionId.BorrowAsset,
+    comptrollerProxy,
+    externalPositionManager,
     externalPositionProxy,
-    actionId: CompoundDebtPositionActionId.RemoveCollateralAssets,
-    encodedCallArgs: actionArgs,
+    signer: fundOwner,
   });
-
-  const removeCollateralTx = comptrollerProxy
-    .connect(fundOwner)
-    .callOnExtension(externalPositionManager, ExternalPositionManagerActionId.CallOnExternalPosition, callArgs);
-
-  return removeCollateralTx;
 }
 
-export async function borrow({
+export async function compoundDebtPositionClaimComp({
   comptrollerProxy,
   externalPositionManager,
   fundOwner,
   externalPositionProxy,
-  assets,
-  amounts,
-  cTokens,
 }: {
   comptrollerProxy: ComptrollerLib;
   vaultProxy: VaultLib;
   externalPositionManager: ExternalPositionManager;
   fundOwner: SignerWithAddress;
   externalPositionProxy: AddressLike;
-  assets: AddressLike[];
-  amounts: BigNumberish[];
-  cTokens: AddressLike[];
 }) {
   const actionArgs = compoundExternalPositionActionArgs({
-    assets,
-    amounts,
-    data: encodeArgs(['address[]'], [cTokens]),
+    amounts: [],
+    assets: [],
+    data: '0x',
   });
 
-  const callArgs = callOnExternalPositionArgs({
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: CompoundDebtPositionActionId.ClaimComp,
+    comptrollerProxy,
+    externalPositionManager,
     externalPositionProxy,
-    actionId: CompoundDebtPositionActionId.BorrowAsset,
-    encodedCallArgs: actionArgs,
+    signer: fundOwner,
   });
-
-  const borrowTx = comptrollerProxy
-    .connect(fundOwner)
-    .callOnExtension(externalPositionManager, ExternalPositionManagerActionId.CallOnExternalPosition, callArgs);
-
-  return borrowTx;
 }
 
-export async function claimComp({
+export async function compoundDebtPositionRemoveCollateral({
   comptrollerProxy,
   externalPositionManager,
   fundOwner,
+  assets,
+  amounts,
   externalPositionProxy,
+  cTokens,
 }: {
   comptrollerProxy: ComptrollerLib;
-  vaultProxy: VaultLib;
   externalPositionManager: ExternalPositionManager;
   fundOwner: SignerWithAddress;
+  assets: AddressLike[];
+  amounts: BigNumberish[];
   externalPositionProxy: AddressLike;
+  cTokens: AddressLike[];
 }) {
   const actionArgs = compoundExternalPositionActionArgs({
-    assets: [],
-    amounts: [],
-    data: '0x',
+    amounts,
+    assets,
+    data: encodeArgs(['address[]'], [cTokens]),
   });
 
-  const callArgs = callOnExternalPositionArgs({
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: CompoundDebtPositionActionId.RemoveCollateralAssets,
+    comptrollerProxy,
+    externalPositionManager,
     externalPositionProxy,
-    actionId: CompoundDebtPositionActionId.ClaimComp,
-    encodedCallArgs: actionArgs,
+    signer: fundOwner,
   });
-
-  const claimCompTx = comptrollerProxy
-    .connect(fundOwner)
-    .callOnExtension(externalPositionManager, ExternalPositionManagerActionId.CallOnExternalPosition, callArgs);
-
-  return claimCompTx;
 }
 
-export async function repayBorrow({
+export async function compoundDebtPositionRepayBorrow({
   comptrollerProxy,
   externalPositionManager,
   fundOwner,
@@ -191,20 +157,34 @@ export async function repayBorrow({
   cTokens: AddressLike[];
 }) {
   const actionArgs = compoundExternalPositionActionArgs({
-    assets,
     amounts,
+    assets,
     data: encodeArgs(['address[]'], [cTokens]),
   });
 
-  const callArgs = callOnExternalPositionArgs({
-    externalPositionProxy,
+  return callOnExternalPosition({
+    actionArgs,
     actionId: CompoundDebtPositionActionId.RepayBorrowedAssets,
-    encodedCallArgs: actionArgs,
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionProxy,
+    signer: fundOwner,
   });
+}
 
-  const repayTx = comptrollerProxy
-    .connect(fundOwner)
-    .callOnExtension(externalPositionManager, ExternalPositionManagerActionId.CallOnExternalPosition, callArgs);
-
-  return repayTx;
+export async function createCompoundDebtPosition({
+  signer,
+  comptrollerProxy,
+  externalPositionManager,
+}: {
+  signer: SignerWithAddress;
+  comptrollerProxy: ComptrollerLib;
+  externalPositionManager: ExternalPositionManager;
+}) {
+  return createExternalPosition({
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionTypeId: ExternalPositionType.CompoundDebtPosition,
+    signer,
+  });
 }

package/src/scaffolding/extensions/external-positions/index.ts

@@ -1,3 +1,4 @@
 export * from './actions';
 export * from './compound';
 export * from './mocks';
+export * from './uniswap-v3-liquidity';

package/src/scaffolding/extensions/external-positions/mocks.ts

@@ -1,16 +1,18 @@
+import type { AddressLike } from '@enzymefinance/ethers';
+import type { SignerWithAddress } from '@enzymefinance/hardhat';
+import type { ComptrollerLib, ExternalPositionFactory, ExternalPositionManager } from '@enzymefinance/protocol';
 import {
-  ComptrollerLib,
   encodeArgs,
   ExternalPositionManagerActionId,
-  ExternalPositionFactory,
-  ExternalPositionManager,
+  mockGenericExternalPositionActionArgs,
+  MockGenericExternalPositionActionId,
   MockGenericExternalPositionLib,
   MockGenericExternalPositionParser,
   VaultLib,
-} from '@enzymefinance/protocol/src';
-import { SignerWithAddress } from '@enzymefinance/hardhat';
-import { AddressLike } from '@enzymefinance/ethers';
-import { BigNumberish } from 'ethers';
+} from '@enzymefinance/protocol';
+import type { BigNumberish } from 'ethers';
+
+import { callOnExternalPosition } from './actions';
 
 export async function createMockExternalPosition({
   comptrollerProxy,
@@ -63,10 +65,130 @@ export async function createMockExternalPosition({
   const externalPositionProxy = (await vaultProxy.getActiveExternalPositions())[0];
 
   return {
-    typeId,
-    mockGenericExternalPositionLib,
-    mockExternalPositionParser,
     externalPositionProxy,
+    mockExternalPositionParser,
+    mockGenericExternalPositionLib,
     receipt,
+    typeId,
   };
 }
+
+export async function mockExternalPositionAddDebtAssets({
+  signer,
+  comptrollerProxy,
+  externalPositionManager,
+  externalPositionProxy,
+  assets,
+  amounts,
+}: {
+  signer: SignerWithAddress;
+  comptrollerProxy: ComptrollerLib;
+  externalPositionManager: ExternalPositionManager;
+  externalPositionProxy: AddressLike;
+  assets: AddressLike[];
+  amounts: BigNumberish[];
+}) {
+  const actionArgs = mockGenericExternalPositionActionArgs({
+    amounts,
+    assets,
+  });
+
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: MockGenericExternalPositionActionId.AddDebtAssets,
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionProxy,
+    signer,
+  });
+}
+
+export async function mockExternalPositionAddManagedAssets({
+  signer,
+  comptrollerProxy,
+  externalPositionManager,
+  externalPositionProxy,
+  assets,
+  amounts,
+}: {
+  signer: SignerWithAddress;
+  comptrollerProxy: ComptrollerLib;
+  externalPositionManager: ExternalPositionManager;
+  externalPositionProxy: AddressLike;
+  assets: AddressLike[];
+  amounts: BigNumberish[];
+}) {
+  const actionArgs = mockGenericExternalPositionActionArgs({
+    amounts,
+    assets,
+  });
+
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: MockGenericExternalPositionActionId.AddManagedAssets,
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionProxy,
+    signer,
+  });
+}
+
+export async function mockExternalPositionRemoveDebtAssets({
+  signer,
+  comptrollerProxy,
+  externalPositionManager,
+  externalPositionProxy,
+  assets,
+  amounts,
+}: {
+  signer: SignerWithAddress;
+  comptrollerProxy: ComptrollerLib;
+  externalPositionManager: ExternalPositionManager;
+  externalPositionProxy: AddressLike;
+  assets: AddressLike[];
+  amounts: BigNumberish[];
+}) {
+  const actionArgs = mockGenericExternalPositionActionArgs({
+    amounts,
+    assets,
+  });
+
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: MockGenericExternalPositionActionId.RemoveDebtAssets,
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionProxy,
+    signer,
+  });
+}
+
+export async function mockExternalPositionRemoveManagedAssets({
+  signer,
+  comptrollerProxy,
+  externalPositionManager,
+  externalPositionProxy,
+  assets,
+  amounts,
+}: {
+  signer: SignerWithAddress;
+  comptrollerProxy: ComptrollerLib;
+  externalPositionManager: ExternalPositionManager;
+  externalPositionProxy: AddressLike;
+  assets: AddressLike[];
+  amounts: BigNumberish[];
+}) {
+  const actionArgs = mockGenericExternalPositionActionArgs({
+    amounts,
+    assets,
+  });
+
+  return callOnExternalPosition({
+    actionArgs,
+    actionId: MockGenericExternalPositionActionId.RemoveManagedAssets,
+    comptrollerProxy,
+    externalPositionManager,
+    externalPositionProxy,
+    signer,
+  });
+}