merge with main

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "wake.compiler.solc.remappings": [
+        "@openzeppelin/contracts-upgradeable/=contracts/lib/openzeppelin-contracts-upgradeable/contracts/",
+        "@openzeppelin/contracts/=contracts/lib/openzeppelin-contracts/contracts/",
+        "bn254/=contracts/lib/bn254/src/",
+        "ds-test/=contracts/lib/solmate/lib/ds-test/src/",
+        "erc4626-tests/=contracts/lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests/",
+        "forge-std/=contracts/lib/forge-std/src/",
+        "foundry-devops/=contracts/lib/foundry-devops/",
+        "openzeppelin-contracts-upgradeable/=contracts/lib/openzeppelin-contracts-upgradeable/",
+        "openzeppelin-contracts/=contracts/lib/openzeppelin-contracts/",
+        "openzeppelin-foundry-upgrades/=contracts/lib/openzeppelin-foundry-upgrades/src/",
+        "solidity-bytes-utils/=contracts/lib/solidity-bytes-utils/contracts/",
+        "solidity-stringutils/=contracts/lib/openzeppelin-foundry-upgrades/lib/solidity-stringutils/",
+        "solmate/=contracts/lib/solmate/src/"
+    ]
+}

contracts/src/StakeTable.sol

@@ -113,10 +113,9 @@ contract StakeTable is AbstractStakeTable {
         return 0;
     }
 
-    /// @notice Look up the balance of `blsVK`
+    /// @notice Look up the balance of `blsVK`g
     /// @param blsVK BLS public key controlled by the user.
     /// @return Current balance owned by the user.
-    /// TODO modify this according to the current spec
     function lookupStake(BN254.G2Point memory blsVK) external view override returns (uint256) {
         Node memory node = this.lookupNode(blsVK);
         return node.balance;
@@ -133,6 +132,7 @@ contract StakeTable is AbstractStakeTable {
 
     /// @notice Get the next available epoch and queue size in that epoch
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function nextRegistrationEpoch() external view override returns (uint64, uint64) {
         uint64 epoch;
         uint64 queueSize;
@@ -155,19 +155,22 @@ contract StakeTable is AbstractStakeTable {
     // @param queueSize current size of the registration queue (after insertion of new element in
     // the queue)
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function appendRegistrationQueue(uint64 epoch, uint64 queueSize) private {
         firstAvailableRegistrationEpoch = epoch;
         _numPendingRegistrations = queueSize + 1;
     }
 
     /// @notice Get the number of pending registration requests in the waiting queue
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function numPendingRegistrations() external view override returns (uint64) {
         return _numPendingRegistrations;
     }
 
     /// @notice Get the next available epoch for exit and queue size in that epoch
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function nextExitEpoch() external view override returns (uint64, uint64) {
         uint64 epoch;
         uint64 queueSize;
@@ -189,13 +192,15 @@ contract StakeTable is AbstractStakeTable {
     // @param epoch next available exit epoch
     // @param queueSize current size of the exit queue (after insertion of new element in the queue)
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function appendExitQueue(uint64 epoch, uint64 queueSize) private {
         firstAvailableExitEpoch = epoch;
         _numPendingExits = queueSize + 1;
     }
 
     /// @notice Get the number of pending exit requests in the waiting queue
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function numPendingExits() external view override returns (uint64) {
         return _numPendingExits;
     }
@@ -215,6 +220,7 @@ contract StakeTable is AbstractStakeTable {
     /// @param node node which is assigned an exit escrow period.
     /// @return Number of epochs post exit after which funds can be withdrawn.
     /// TODO modify this according to the current spec
+    /// TODO modify this according to the current spec
     function exitEscrowPeriod(Node memory node) public pure returns (uint64) {
         if (node.balance > 100) {
             return 10;
@@ -303,7 +309,6 @@ contract StakeTable is AbstractStakeTable {
         node.account = msg.sender;
         node.balance = fixedStakeAmount;
         node.schnorrVK = schnorrVK;
-        node.blsVK = blsVK;
         node.registerEpoch = registerEpoch;
 
         nodes[key] = node;
@@ -355,6 +360,7 @@ contract StakeTable is AbstractStakeTable {
     /// @notice Request to exit from the stake table, not immediately withdrawable!
     ///
     /// @dev TODO modify this according to the current spec
+    /// @dev TODO modify this according to the current spec
     /// @param blsVK The BLS verification key to exit
     function requestExit(BN254.G2Point memory blsVK) external override {
         bytes32 key = _hashBlsKey(blsVK);
@@ -389,12 +395,7 @@ contract StakeTable is AbstractStakeTable {
     /// withdraw past their `exitEpoch`.
     ///
     /// @param blsVK The BLS verification key to withdraw
-    /// @param blsSig The BLS signature that authenticates the ethereum account this function is
-    /// called from the caller
     /// @return The total amount withdrawn, equal to `Node.balance` associated with `blsVK`
-    /// TODO: This function should be tested
-    /// TODO modify this according to the current spec
-
     function withdrawFunds(BN254.G2Point memory blsVK) external override returns (uint256) {
         bytes32 key = _hashBlsKey(blsVK);
         Node memory node = nodes[key];
@@ -415,6 +416,8 @@ contract StakeTable is AbstractStakeTable {
             revert PrematureWithdrawal();
         }
 
+        // Delete the node from the stake table.
+
         // Delete the node from the stake table.
         delete nodes[key];
 

contracts/src/interfaces/AbstractStakeTable.sol

@@ -75,6 +75,7 @@ abstract contract AbstractStakeTable {
 
     /// @notice Look up the balance of `blsVK`
     function lookupStake(BN254.G2Point memory blsVK) external view virtual returns (uint256);
+
     /// @notice Look up the full `Node` state associated with `blsVK`
     function lookupNode(BN254.G2Point memory blsVK) external view virtual returns (Node memory);
 
@@ -96,8 +97,7 @@ abstract contract AbstractStakeTable {
     /// @param blsVK The BLS verification key
     /// @param schnorrVK The Schnorr verification key (as the auxiliary info)
     /// @param amount The amount to register
-    /// @param blsSig The BLS signature that authenticates the ethereum account this function is
-    /// called from
+    /// @param blsSig The BLS signature that the caller owns the `blsVK`
     /// @param validUntilEpoch The maximum epoch the sender is willing to wait to be included
     /// (cannot be smaller than the current epoch)
     /// @dev No validity check on `schnorrVK`, as it's assumed to be sender's responsibility,
@@ -132,8 +132,6 @@ abstract contract AbstractStakeTable {
     /// withdraw past their `exitEpoch`.
     ///
     /// @param blsVK The BLS verification key to withdraw
-    /// @param blsSig The BLS signature that authenticates the ethereum account this function is
-    /// called from the caller
     /// @return The total amount withdrawn, equal to `Node.balance` associated with `blsVK`
     function withdrawFunds(BN254.G2Point memory blsVK) external virtual returns (uint256);