Squashed commit of the following:

commit ec7ce83 Author: SnakePoison <[email protected]> Date: Wed Oct 25 14:17:38 2023 -0400 feat: GlobalAuctionRebalanceExtension contract, tests & utils (#153) * feat: GlobalAuctionRebalanceExtension contract, tests & utils * test: adds cases that increase coverage to 100% * feat: prevent intialization when not ready. * style: update constructor docs.
IndexCoop · Nov 22, 2023 · c633ed5 · c633ed5
1 parent 013ddb4
commit c633ed5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/contracts/global-extensions/GlobalAuctionRebalanceExtension.sol b/contracts/global-extensions/GlobalAuctionRebalanceExtension.sol
@@ -63,7 +63,12 @@ contract GlobalAuctionRebalanceExtension is BaseGlobalExtension {
 
 
     /* ============ Constructor ============ */
-
+    /*
+      * Instantiate with ManagerCore address and WrapModuleV2 address. 
+      * 
+      * @param _managerCore              Address of ManagerCore contract 
+      * @param _auctionModule            Address of AuctionRebalanceModuleV1 contract 
+    */ 
     constructor(IManagerCore _managerCore, IAuctionRebalanceModuleV1 _auctionModule) public BaseGlobalExtension(_managerCore) {
         auctionModule = _auctionModule;
     }
@@ -151,7 +156,6 @@ contract GlobalAuctionRebalanceExtension is BaseGlobalExtension {
     )
         external
         onlyOperator(_setToken)
-        virtual
     {
         address[] memory currentComponents = _setToken.getComponents();
 

diff --git a/contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol b/contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol
@@ -37,8 +37,8 @@ import {OptimisticOracleV3Interface} from "../interfaces/OptimisticOracleV3Inter
  * @title GlobalOptimisticAuctionRebalanceExtension
  * @author Index Coop
  *
- * @dev Extension contract for interacting with the AuctionRebalanceModuleV1. This contract acts as a pass-through and functions 
- * are only callable by operator. 
+ * @dev The contract extends `GlobalAuctionRebalanceExtension` by adding an optimistic oracle mechanism for validating rules on the proposing and executing of rebalances. 
+ * It allows setting product-specific parameters for optimistic rebalancing and includes callback functions for resolved or disputed assertions.
  */
 contract GlobalOptimisticAuctionRebalanceExtension is  GlobalAuctionRebalanceExtension {
     using AddressArrayUtils for address[];
@@ -110,7 +110,12 @@ contract GlobalOptimisticAuctionRebalanceExtension is  GlobalAuctionRebalanceExt
 
 
     /* ============ Constructor ============ */
-
+    /*
+      * Instantiate with ManagerCore address and WrapModuleV2 address. 
+      * 
+      * @param _managerCore              Address of ManagerCore contract 
+      * @param _auctionModule            Address of AuctionRebalanceModuleV1 contract 
+    */ 
     constructor(AuctionExtensionParams memory _auctionParams) public GlobalAuctionRebalanceExtension(_auctionParams.managerCore, _auctionParams.auctionModule) {
 
     }

diff --git a/utils/deploys/deployGlobalExtensions.ts b/utils/deploys/deployGlobalExtensions.ts
@@ -8,6 +8,8 @@ import {
   GlobalTradeExtension,
   GlobalWrapExtension,
   GlobalAuctionRebalanceExtension
+  GlobalWrapExtension,
+  GlobalAuctionRebalanceExtension
 } from "../contracts/index";
 
 import { GlobalBatchTradeExtension__factory } from "../../typechain/factories/GlobalBatchTradeExtension__factory";