Add resolveAndReleaseStake method

Author: jparyani

contracts/NumeraiErasureV1.sol

@@ -47,6 +47,14 @@ contract NumeraiErasureV1 is Initializable, Pausable {
         uint256 amountReleased
     );
 
+    event ResolveAndReleaseStake(
+        address indexed agreement,
+        address indexed staker,
+        uint256 oldStakeAmount,
+        uint256 amountReleased,
+        int256 amountStakeChanged
+    );
+
     // set the address of the NMR token as a constant (stored in runtime code)
     address private constant _TOKEN = address(
         0x1776e1F26f98b1A5dF9cD347953a26dd3Cb46671
@@ -170,10 +178,33 @@ contract NumeraiErasureV1 is Initializable, Pausable {
     function releaseStake(
         address agreement, address staker, uint256 currentStake, uint256 amountToRelease
     ) public onlyManagerOrOwner whenNotPaused {
-        require(amountToRelease > 0, "Cannot punish zero NMR");
+        require(amountToRelease > 0, "Cannot release zero NMR");
 
         IErasureStake(agreement).releaseStake(currentStake, amountToRelease);
 
         emit ReleaseStake(agreement, staker, currentStake, amountToRelease);
     }
+
+    /// @notice Internal function to resolve and then release an Erasure agreement stake
+    /// @param agreement The address of the agreement contract. Must conform to IErasureStake interface
+    /// @param staker The address of the staker
+    /// @param currentStake The amount of NMR in wei already staked on the agreement
+    /// @param amountToRelease The amount of NMR in wei to release back to the staker
+    /// @param amountToChangeStake The amount of NMR to change the stake with. If negative, then call `punish`, else call `reward`. This is called before `releaseStake`
+    function resolveAndReleaseStake(
+        address agreement, address staker, uint256 currentStake, uint256 amountToRelease, int256 amountToChangeStake
+    ) public onlyManagerOrOwner whenNotPaused {
+        uint256 newStake;
+        if(amountToChangeStake > 0) {
+            reward(agreement, staker, currentStake, uint256(amountToChangeStake));
+            newStake = currentStake.add(uint256(amountToChangeStake));
+        } else {
+            punish(agreement, staker, currentStake, uint256(-amountToChangeStake), "punish before release");
+            newStake = currentStake.sub(uint256(-amountToChangeStake));
+        }
+
+        IErasureStake(agreement).releaseStake(newStake, amountToRelease);
+
+        emit ResolveAndReleaseStake(agreement, staker, currentStake, amountToRelease, amountToChangeStake);
+    }
 }

test/erasure.js

@@ -69,6 +69,8 @@ describe('Test Erasure agreements', async () => {
         assert.strictEqual(balance.toString(), utils.parseEther("90").toString(), 'balance is wrong for user');
 
         agreement = deployer.wrapDeployedContract(SimpleGriefing, agreementAddress);
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("10").toString(), 'balance is wrong for stake');
     });
 
     it('should increaseStake', async () => {
@@ -95,6 +97,8 @@ describe('Test Erasure agreements', async () => {
 
         let balance = await mockNMRContract.balanceOf(userAddress);
         assert.strictEqual(balance.toString(), utils.parseEther("75").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("25").toString(), 'balance is wrong for stake');
     });
 
     it('should reward', async () => {
@@ -122,6 +126,8 @@ describe('Test Erasure agreements', async () => {
 
         let balance = await mockNMRContract.balanceOf(userAddress);
         assert.strictEqual(balance.toString(), utils.parseEther("75").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("35").toString(), 'balance is wrong for stake');
     });
 
     it('should punish', async () => {
@@ -149,6 +155,8 @@ describe('Test Erasure agreements', async () => {
 
         let balance = await mockNMRContract.balanceOf(userAddress);
         assert.strictEqual(balance.toString(), utils.parseEther("75").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("25").toString(), 'balance is wrong for stake');
     });
 
     it('should releaseStake partial', async () => {
@@ -176,6 +184,8 @@ describe('Test Erasure agreements', async () => {
 
         let balance = await mockNMRContract.balanceOf(userAddress);
         assert.strictEqual(balance.toString(), utils.parseEther("85").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("15").toString(), 'balance is wrong for stake');
     });
 
     it('should releaseStake full', async () => {
@@ -203,5 +213,75 @@ describe('Test Erasure agreements', async () => {
 
         let balance = await mockNMRContract.balanceOf(userAddress);
         assert.strictEqual(balance.toString(), utils.parseEther("100").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("0").toString(), 'balance is wrong for stake');
+    });
+
+    it('should resolveAndRelease reward', async () => {
+        const releaseAmount = utils.parseEther("15");
+        const amountToChange = utils.parseEther("40");
+        const oldStakeAmount = utils.parseEther("0");
+
+        let txn = await numeraiErasureContract.resolveAndReleaseStake(agreement.contractAddress, userAddress, oldStakeAmount, releaseAmount, amountToChange);
+        const receipt = await numeraiErasureContract.verboseWaitForTransaction(txn);
+        const stakeEvent = receipt.events.find(
+            emittedEvent => emittedEvent.event === "ResolveAndReleaseStake",
+            "There is no such event"
+        );
+
+        assert.isDefined(stakeEvent);
+        assert.equal(stakeEvent.args.agreement, agreement.contractAddress);
+        assert.equal(stakeEvent.args.staker, userAddress);
+        assert.strictEqual(
+            stakeEvent.args.amountReleased.toString(),
+            releaseAmount.toString(),
+        );
+        assert.strictEqual(
+            stakeEvent.args.oldStakeAmount.toString(),
+            oldStakeAmount.toString(),
+        );
+        assert.strictEqual(
+            stakeEvent.args.amountStakeChanged.toString(),
+            amountToChange.toString(),
+        );
+
+        let balance = await mockNMRContract.balanceOf(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("115").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("25").toString(), 'balance is wrong for stake');
+    });
+
+    it('should resolveAndRelease punish', async () => {
+        const releaseAmount = utils.parseEther("5");
+        const amountToChange = utils.parseEther("-10");
+        const oldStakeAmount = utils.parseEther("25");
+
+        let txn = await numeraiErasureContract.resolveAndReleaseStake(agreement.contractAddress, userAddress, oldStakeAmount, releaseAmount, amountToChange);
+        const receipt = await numeraiErasureContract.verboseWaitForTransaction(txn);
+        const stakeEvent = receipt.events.find(
+            emittedEvent => emittedEvent.event === "ResolveAndReleaseStake",
+            "There is no such event"
+        );
+
+        assert.isDefined(stakeEvent);
+        assert.equal(stakeEvent.args.agreement, agreement.contractAddress);
+        assert.equal(stakeEvent.args.staker, userAddress);
+        assert.strictEqual(
+            stakeEvent.args.amountReleased.toString(),
+            releaseAmount.toString(),
+        );
+        assert.strictEqual(
+            stakeEvent.args.oldStakeAmount.toString(),
+            oldStakeAmount.toString(),
+        );
+        assert.strictEqual(
+            stakeEvent.args.amountStakeChanged.toString(),
+            amountToChange.toString(),
+        );
+
+        let balance = await mockNMRContract.balanceOf(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("120").toString(), 'balance is wrong for user');
+        balance = await agreement.getStake(userAddress);
+        assert.strictEqual(balance.toString(), utils.parseEther("10").toString(), 'balance is wrong for stake');
     });
 });