Merge pull request #306 from api3dao/add-totalstake-to-logs

Add totalStake to Staked and Unstaked events

Author: bbenligiray

packages/pool/contracts/StakeUtils.sol

@@ -18,7 +18,8 @@ abstract contract StakeUtils is TransferUtils, IStakeUtils {
             user.unstaked >= amount,
             "Pool: Amount exceeds unstaked"
             );
-        user.unstaked -= amount;
+        uint256 userUnstakedUpdate = user.unstaked - amount;
+        user.unstaked = userUnstakedUpdate;
         uint256 totalSharesNow = totalShares();
         uint256 sharesToMint = amount * totalSharesNow / totalStake;
         uint256 userSharesUpdate = userShares(msg.sender) + sharesToMint;
@@ -37,8 +38,10 @@ abstract contract StakeUtils is TransferUtils, IStakeUtils {
             msg.sender,
             amount,
             sharesToMint,
+            userUnstakedUpdate,
             userSharesUpdate,
-            totalSharesUpdate
+            totalSharesUpdate,
+            totalStake
             );
     }
 
@@ -139,7 +142,8 @@ abstract contract StakeUtils is TransferUtils, IStakeUtils {
         {
             unstakeAmount = unstakeAmountByShares;
         }
-        user.unstaked += unstakeAmount;
+        uint256 userUnstakedUpdate = user.unstaked + unstakeAmount;
+        user.unstaked = userUnstakedUpdate;
 
         uint256 totalSharesUpdate = totalShares - user.unstakeShares;
         updateCheckpointArray(
@@ -154,7 +158,9 @@ abstract contract StakeUtils is TransferUtils, IStakeUtils {
         emit Unstaked(
             userAddress,
             unstakeAmount,
-            totalSharesUpdate
+            userUnstakedUpdate,
+            totalSharesUpdate,
+            totalStake
             );
         return unstakeAmount;
     }

packages/pool/contracts/interfaces/IStakeUtils.sol

@@ -8,8 +8,10 @@ interface IStakeUtils is ITransferUtils{
         address indexed user,
         uint256 amount,
         uint256 mintedShares,
+        uint256 userUnstaked,
         uint256 userShares,
-        uint256 totalShares
+        uint256 totalShares,
+        uint256 totalStake
         );
 
     event ScheduledUnstake(
@@ -23,7 +25,9 @@ interface IStakeUtils is ITransferUtils{
     event Unstaked(
         address indexed user,
         uint256 amount,
-        uint256 totalShares
+        uint256 userUnstaked,
+        uint256 totalShares,
+        uint256 totalStake
         );
 
     function stake(uint256 amount)

packages/pool/test/StakeUtils.sol.js

@@ -76,7 +76,9 @@ describe("stake", function () {
             roles.user1.address,
             user1Stake.div(2),
             user1Stake.div(2),
+            0,
             user1Stake,
+            user1Stake.add(1),
             user1Stake.add(1)
           );
         expect(await api3Pool.userStake(roles.user1.address)).to.equal(
@@ -111,7 +113,9 @@ describe("stake", function () {
             roles.user1.address,
             user1Stake,
             user1Stake,
+            0,
             user1Stake,
+            user1Stake.add(1),
             user1Stake.add(1)
           );
         expect(await api3Pool.userStake(roles.user1.address)).to.equal(
@@ -147,7 +151,9 @@ describe("depositAndStake", function () {
         roles.user1.address,
         user1Stake,
         user1Stake,
+        0,
         user1Stake,
+        user1Stake.add(1),
         user1Stake.add(1)
       );
   });
@@ -334,11 +340,18 @@ describe("unstake", function () {
           ]);
           // Unstake
           await api3Pool.mintReward();
+          const totalStake = await api3Pool.totalStake();
           await expect(
             api3Pool.connect(roles.randomPerson).unstake(roles.user1.address)
           )
             .to.emit(api3Pool, "Unstaked")
-            .withArgs(roles.user1.address, user1Stake, 1);
+            .withArgs(
+              roles.user1.address,
+              user1Stake,
+              user1Stake,
+              1,
+              totalStake.sub(user1Stake)
+            );
           const user = await api3Pool.users(roles.user1.address);
           expect(user.unstaked).to.equal(user1Stake);
         });
@@ -395,14 +408,17 @@ describe("unstake", function () {
           const actualUnstakeAmount = unstakeShares
             .mul(await api3Pool.totalStake())
             .div(await api3Pool.totalShares());
+          const totalStake = await api3Pool.totalStake();
           await expect(
             api3Pool.connect(roles.randomPerson).unstake(roles.user1.address)
           )
             .to.emit(api3Pool, "Unstaked")
             .withArgs(
               roles.user1.address,
               actualUnstakeAmount,
-              user1Stake.div(2).add(1)
+              actualUnstakeAmount,
+              user1Stake.div(2).add(1),
+              totalStake.sub(actualUnstakeAmount)
             );
         });
       });