Add start time to params (#263)

foilxyz · Jan 21, 2025 · d4d323f · d4d323f
2 parents b628485 + 518a1d5
commit d4d323f
Show file tree

Hide file tree

Showing 17 changed files with 47 additions and 30 deletions.
diff --git a/packages/protocol/cannonfile.base-beta.toml b/packages/protocol/cannonfile.base-beta.toml
@@ -26,6 +26,7 @@ lowerBoundMultiplier = "0.5773502691896257" # sqrt(1/3)
 upperBoundMultiplier = "1.7320508075688772" # sqrt(3)
 duration = "2419200" # 28 day in seconds
 totalVaults = "2"
+startTime = "0"
 # tokens
 wstETH = "0xc1CBa3fCea344f92D9239c08C0568f6F2F0ee452"
 USDC = "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
@@ -133,7 +134,8 @@ target="VaultYin"
 from = "<%= settings.deployer %>"
 func="initializeFirstEpoch"
 args=[
-  "<%= settings.startingSqrtPriceX96 %>"
+  "<%= settings.startingSqrtPriceX96 %>",
+  "<%= settings.startTime %>"
 ]
 depends=["invoke.initializeMarketForVaultYin"]
 
@@ -142,6 +144,7 @@ target="VaultYang"
 from = "<%= settings.deployer %>"
 func="initializeFirstEpoch"
 args=[
-  "<%= settings.startingSqrtPriceX96 %>"
+  "<%= settings.startingSqrtPriceX96 %>",
+  "<%= settings.startTime %>"
 ]
 depends=["invoke.initializeMarketForVaultYang"]
diff --git a/packages/protocol/cannonfile.sepolia.toml b/packages/protocol/cannonfile.sepolia.toml
@@ -134,7 +134,8 @@ target="VaultYin"
 from = "<%= settings.owner %>"
 func="initializeFirstEpoch"
 args=[
-  "<%= settings.startingSqrtPriceX96 %>"
+  "<%= settings.startingSqrtPriceX96 %>",
+  "0"
 ]
 depends=["invoke.initializeMarketForVaultYin"]
 
@@ -143,6 +144,7 @@ target="VaultYang"
 from = "<%= settings.owner %>"
 func="initializeFirstEpoch"
 args=[
-  "<%= settings.startingSqrtPriceX96 %>"
+  "<%= settings.startingSqrtPriceX96 %>",
+  "0"
 ]
 depends=["invoke.initializeMarketForVaultYang"]
diff --git a/packages/protocol/cannonfile.toml b/packages/protocol/cannonfile.toml
@@ -145,7 +145,8 @@ target="VaultYin"
 from = "<%= settings.owner %>"
 func="initializeFirstEpoch"
 args=[
-  "<%= settings.startingSqrtPriceX96 %>"
+  "<%= settings.startingSqrtPriceX96 %>",
+  "0"
 ]
 depends=["invoke.initializeMarketForVault1"]
 
@@ -154,7 +155,8 @@ target="VaultYang"
 from = "<%= settings.owner %>"
 func="initializeFirstEpoch"
 args=[
-  "<%= settings.startingSqrtPriceX96 %>"
+  "<%= settings.startingSqrtPriceX96 %>",
+  "0"
 ]
 depends=["invoke.initializeMarketForVault2"]
 

diff --git a/packages/protocol/src/vault/Vault.sol b/packages/protocol/src/vault/Vault.sol
@@ -122,12 +122,17 @@ contract Vault is IVault, ERC20, ERC165, ReentrancyGuardUpgradeable {
     /// @dev price is set to 1e18
     /// @dev any pending deposits prior to the first epoch are used to create the initial liquidity position
     function initializeFirstEpoch(
-        uint160 initialSqrtPriceX96
+        uint160 initialSqrtPriceX96,
+        uint256 initialStartTime
     ) external onlyInitializer {
         require(!initialized, "Already Initialized");
         require(address(market) != address(0), "Market address not set");
 
-        uint256 initialStartTime = block.timestamp + (vaultIndex * duration);
+        uint256 startTime = initialStartTime == 0
+            ? block.timestamp
+            : initialStartTime;
+
+        uint256 epochStartTime = startTime + (vaultIndex * duration);
         // set tick spacing in storage once to reuse
         // for future epoch creations
         tickSpacing = market.getMarketTickSpacing();
@@ -136,7 +141,7 @@ contract Vault is IVault, ERC20, ERC165, ReentrancyGuardUpgradeable {
         epochSharePrices[0] = startingSharePrice;
 
         _createEpochAndPosition(
-            initialStartTime,
+            epochStartTime,
             initialSqrtPriceX96,
             0 // collateral received, should be 0 for first epoch
         );

diff --git a/packages/protocol/src/vault/interfaces/IVault.sol b/packages/protocol/src/vault/interfaces/IVault.sol
@@ -248,8 +248,12 @@ interface IVault is
     /**
      * @notice Initialize the first epoch of the vault
      * @param initialSqrtPriceX96 The initial sqrt price
+     * @param initialStartTime The initial start time of the epoch from which
      */
-    function initializeFirstEpoch(uint160 initialSqrtPriceX96) external;
+    function initializeFirstEpoch(
+        uint160 initialSqrtPriceX96,
+        uint256 initialStartTime
+    ) external;
 
     /**
      * @notice Submit the market settlement price for an epoch

diff --git a/packages/protocol/test/Vault/Vault.deposit.t.sol b/packages/protocol/test/Vault/Vault.deposit.t.sol
@@ -163,7 +163,7 @@ contract VaultDepositTest is TestVault {
 
     function test_depositReverts_whenDepositNotCollected() public {
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vm.startPrank(lp1);
         vm.expectRevert("Previous deposit request is not in the same epoch");
@@ -176,7 +176,7 @@ contract VaultDepositTest is TestVault {
         public
     {
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vm.startPrank(lp1);
         vm.expectRevert("Previous deposit request is not in the same epoch");
@@ -187,7 +187,7 @@ contract VaultDepositTest is TestVault {
 
     function test_claimDeposit_whenEpochEnded() public {
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         uint256 claimable = vault.claimableDepositRequest(lp1);
         assertEq(
@@ -213,7 +213,7 @@ contract VaultDepositTest is TestVault {
 
     function test_depositWorks_whenRequestPending() public {
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vm.prank(lp1);
         vault.deposit(0, lp1);
@@ -227,7 +227,7 @@ contract VaultDepositTest is TestVault {
 
     function test_requestDepositReverts_whenRedeemPending() public {
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vm.prank(lp1);
         vault.deposit(0, lp1);

diff --git a/packages/protocol/test/Vault/Vault.duration.t.sol b/packages/protocol/test/Vault/Vault.duration.t.sol
@@ -74,10 +74,10 @@ contract VaultDurationTest is TestVault {
 
         vm.startPrank(vaultOwner);
         vm.warp(block.timestamp);
-        initialStartTime = block.timestamp;
-        vault1.initializeFirstEpoch(initialSqrtPriceX96);
-        vault2.initializeFirstEpoch(initialSqrtPriceX96);
-        vault3.initializeFirstEpoch(initialSqrtPriceX96);
+        initialStartTime = block.timestamp + 1 days;
+        vault1.initializeFirstEpoch(initialSqrtPriceX96, initialStartTime);
+        vault2.initializeFirstEpoch(initialSqrtPriceX96, initialStartTime);
+        vault3.initializeFirstEpoch(initialSqrtPriceX96, initialStartTime);
         vm.stopPrank();
     }
 

diff --git a/packages/protocol/test/Vault/Vault.halted.pendingShares.t.sol b/packages/protocol/test/Vault/Vault.halted.pendingShares.t.sol
@@ -40,7 +40,7 @@ contract VaultFailureTest is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vault.deposit(0, lp1);
         vault.deposit(0, lp2);

diff --git a/packages/protocol/test/Vault/Vault.halted.t.sol b/packages/protocol/test/Vault/Vault.halted.t.sol
@@ -46,7 +46,7 @@ contract VaultFailureTest is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vault.deposit(0, lp1);
 

diff --git a/packages/protocol/test/Vault/Vault.integration.manualSettle.t.sol b/packages/protocol/test/Vault/Vault.integration.manualSettle.t.sol
@@ -77,7 +77,7 @@ contract VaultIntegrationTest is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         // collect deposits
         vm.prank(lp1);

diff --git a/packages/protocol/test/Vault/Vault.integration.t.sol b/packages/protocol/test/Vault/Vault.integration.t.sol
@@ -76,7 +76,7 @@ contract VaultIntegrationTest is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         // collect deposits
         vm.prank(lp1);

diff --git a/packages/protocol/test/Vault/Vault.minCollReceived.t.sol b/packages/protocol/test/Vault/Vault.minCollReceived.t.sol
@@ -46,7 +46,7 @@ contract VaultMinimumCollateralReceived is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vault.deposit(0, lp1);
 

diff --git a/packages/protocol/test/Vault/Vault.priceSubmitter.t.sol b/packages/protocol/test/Vault/Vault.priceSubmitter.t.sol
@@ -41,7 +41,7 @@ contract VaultPriceSubmitterTest is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vault.deposit(0, lp1);
         vault.deposit(0, lp2);

diff --git a/packages/protocol/test/Vault/Vault.redeem.t.sol b/packages/protocol/test/Vault/Vault.redeem.t.sol
@@ -51,7 +51,7 @@ contract VaultRedeemTest is TestVault {
 
         // Initialize first epoch and mint shares
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vm.prank(lp1);
         vault.deposit(0, lp1);

diff --git a/packages/protocol/test/Vault/Vault.sharePriceZero.t.sol b/packages/protocol/test/Vault/Vault.sharePriceZero.t.sol
@@ -46,7 +46,7 @@ contract VaultSharePriceZero is TestVault {
 
         epochStartTime = block.timestamp + 60;
         vm.prank(vaultOwner);
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vault.deposit(0, lp1);
         vault.deposit(0, lp2);

diff --git a/packages/protocol/test/Vault/Vault.t.sol b/packages/protocol/test/Vault/Vault.t.sol
@@ -60,7 +60,7 @@ contract VaultTest is TestVault {
 
     function test_revertsWhenInitializeNonOwner() public {
         vm.expectRevert("Only vaultInitializer can call this function");
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
     }
 
     function test_revertsWhenInitializeFirstEpochAgain() public {
@@ -69,7 +69,7 @@ contract VaultTest is TestVault {
         vm.startPrank(vaultOwner);
 
         vm.expectRevert("Already Initialized");
-        vault.initializeFirstEpoch(initialSqrtPriceX96);
+        vault.initializeFirstEpoch(initialSqrtPriceX96, block.timestamp);
 
         vm.stopPrank();
     }

diff --git a/packages/protocol/test/helpers/TestVault.sol b/packages/protocol/test/helpers/TestVault.sol
@@ -79,7 +79,8 @@ contract TestVault is TestTrade {
 
         // Initialize Epoch (by owner, kicks the ball with the first epoch)
         IVault(vm.getAddress("Vault")).initializeFirstEpoch(
-            _initialSqrtPriceX96
+            _initialSqrtPriceX96,
+            0
         );
 
         vm.stopPrank();