Improve Staking and Escrow contracts

Author: flopez7

packages/apps/dashboard/ui-2024/src/pages/SearchResults/RoleDetails/RoleDetails.tsx

@@ -171,7 +171,6 @@ const RoleDetails = ({
 		reputation,
 		amountJobsProcessed,
 		amountStaked,
-		amountAllocated,
 		amountLocked,
 	},
 }: {
@@ -351,36 +350,6 @@ const RoleDetails = ({
 							</Stack>
 						</Stack>
 					) : null}
-					{amountAllocated !== undefined && amountAllocated !== null ? (
-						<Stack
-							gap={{ xs: 1, md: 0 }}
-							direction={{ sm: 'column', md: 'row' }}
-						>
-							<Typography
-								sx={{
-									width: 300,
-								}}
-								variant="subtitle2"
-							>
-								Tokens Allocated
-							</Typography>
-							<Stack sx={{ whiteSpace: 'nowrap', flexDirection: 'row' }}>
-								<Typography variant="body2">
-									<FormatNumberWithDecimals value={amountAllocated} />
-								</Typography>
-								<Typography
-									sx={{
-										marginLeft: 0.5,
-									}}
-									variant="body2"
-									color={colorPalette.fog.main}
-									component="span"
-								>
-									HMT
-								</Typography>
-							</Stack>
-						</Stack>
-					) : null}
 					{amountLocked !== undefined && amountLocked !== null ? (
 						<Stack
 							gap={{ xs: 1, md: 0 }}

packages/apps/dashboard/ui-2024/src/services/api/use-address-details.tsx

@@ -77,10 +77,6 @@ const leaderSchema = z.object({
 	balance: z.string().transform(transformOptionalTokenAmount),
 	role: z.nativeEnum(Roles).nullable(),
 	amountStaked: z.string().optional().transform(transformOptionalTokenAmount),
-	amountAllocated: z
-		.string()
-		.optional()
-		.transform(transformOptionalTokenAmount),
 	amountLocked: z.string().optional().transform(transformOptionalTokenAmount),
 	lockedUntilTimestamp: z.string().optional(),
 	reputation: reputationSchema,

packages/apps/dashboard/ui/src/state/leader/types.ts

@@ -5,7 +5,6 @@ export type LeaderData = {
   address: string;
   role?: string;
   amountStaked: number;
-  amountAllocated: number;
   amountLocked: number;
   amountSlashed: number;
   amountWithdrawn: number;
@@ -17,7 +16,6 @@ export type LeaderData = {
 
 export type LeaderEscrowData = {
   address: string;
-  amountAllocated: number;
   amountPayout: number;
   status: string;
 };

packages/apps/reputation-oracle/server/src/modules/payout/payout.service.ts

@@ -69,6 +69,7 @@ export class PayoutService {
       results.amounts,
       results.url,
       results.hash,
+      true,
       {
         gasPrice: await this.web3Service.calculateGasPrice(chainId),
       },

packages/core/contracts/Escrow.sol

@@ -189,7 +189,6 @@ contract Escrow is IEscrow, ReentrancyGuard {
         trusted
         notBroke
         notComplete
-        notPaid
         nonReentrant
         returns (bool)
     {
@@ -218,6 +217,8 @@ contract Escrow is IEscrow, ReentrancyGuard {
         return true;
     }
 
+    // For backward compatibility: this function can only be called on existing escrows,
+    // as the "Paid" status is not set anywhere for new escrows.
     function complete() external override notExpired trustedOrReputationOracle {
         require(status == EscrowStatuses.Paid, 'Escrow not in Paid state');
         status = EscrowStatuses.Complete;
@@ -243,7 +244,7 @@ contract Escrow is IEscrow, ReentrancyGuard {
 
     /**
      * @dev Performs bulk payout to multiple workers
-     * Escrow needs to be complted / cancelled, so that it can be paid out.
+     * Escrow needs to be completed / cancelled, so that it can be paid out.
      * Every recipient is paid with the amount after reputation and recording oracle fees taken out.
      * If the amount is less than the fee, the recipient is not paid.
      * If the fee is zero, reputation, and recording oracle are not paid.
@@ -257,20 +258,21 @@ contract Escrow is IEscrow, ReentrancyGuard {
      * @param _url URL storing results as transaction details
      * @param _hash Hash of the results
      * @param _txId Transaction ID
+     * @param forceComplete Boolean parameter indicating if remaining balance should be transferred to the escrow creator
      */
     function bulkPayOut(
         address[] memory _recipients,
         uint256[] memory _amounts,
         string memory _url,
         string memory _hash,
-        uint256 _txId
+        uint256 _txId,
+        bool forceComplete
     )
-        external
+        public
         override
         trustedOrReputationOracle
         notBroke
         notLaunched
-        notPaid
         notExpired
         nonReentrant
     {
@@ -343,15 +345,22 @@ contract Escrow is IEscrow, ReentrancyGuard {
 
         remainingFunds = cachedRemainingFunds;
 
+        // Check the forceComplete flag and transfer remaining funds if true
+        if (forceComplete && cachedRemainingFunds > 0) {
+            _safeTransfer(token, launcher, cachedRemainingFunds);
+            cachedRemainingFunds = 0;
+        }
+
         if (cachedRemainingFunds == 0) {
-            status = EscrowStatuses.Paid;
+            status = EscrowStatuses.Complete;
             emit BulkTransferV2(
                 _txId,
                 _recipients,
                 _amounts,
                 false,
                 finalResultsUrl
             );
+            emit Completed();
         } else {
             status = EscrowStatuses.Partial;
             emit BulkTransferV2(
@@ -364,6 +373,26 @@ contract Escrow is IEscrow, ReentrancyGuard {
         }
     }
 
+    /**
+     * @dev Overloaded function to perform bulk payout with default forceComplete set to false.
+     * Calls the main bulkPayout function with forceComplete as false.
+     *
+     * @param _recipients Array of recipients
+     * @param _amounts Array of amounts to be paid to each recipient.
+     * @param _url URL storing results as transaction details
+     * @param _hash Hash of the results
+     * @param _txId Transaction ID
+     */
+    function bulkPayOut(
+        address[] memory _recipients,
+        uint256[] memory _amounts,
+        string memory _url,
+        string memory _hash,
+        uint256 _txId
+    ) external {
+        bulkPayOut(_recipients, _amounts, _url, _hash, _txId, false);
+    }
+
     function _safeTransfer(address _token, address to, uint256 value) internal {
         SafeERC20.safeTransfer(IERC20(_token), to, value);
     }

packages/core/contracts/Staking.sol

@@ -220,8 +220,12 @@ contract Staking is
      * @param _tokens Amount of tokens to unstake
      */
     function unstake(uint256 _tokens) external override {
-        Stakes.Staker storage staker = stakes[msg.sender];
         require(_tokens > 0, 'Must be a positive number');
+        Stakes.Staker storage staker = stakes[msg.sender];
+        require(
+            staker.tokensLocked == 0,
+            'Unstake in progress, complete it first'
+        );
         uint256 stakeAvailable = staker.tokensAvailable();
         require(stakeAvailable >= _tokens, 'Insufficient amount to unstake');
 

packages/core/contracts/interfaces/IEscrow.sol

@@ -35,6 +35,15 @@ interface IEscrow {
 
     function storeResults(string memory _url, string memory _hash) external;
 
+    function bulkPayOut(
+        address[] memory _recipients,
+        uint256[] memory _amounts,
+        string memory _url,
+        string memory _hash,
+        uint256 _txId,
+        bool forceComplete
+    ) external;
+
     function bulkPayOut(
         address[] memory _recipients,
         uint256[] memory _amounts,

packages/core/contracts/libs/Stakes.sol

@@ -2,8 +2,6 @@
 
 pragma solidity ^0.8.0;
 
-import '../utils/Math.sol';
-
 /**
  * @title Structures, methods and data are available to manage the staker state.
  */
@@ -43,19 +41,8 @@ library Stakes {
         uint256 _tokens,
         uint256 _period
     ) internal {
-        uint256 lockingPeriod = _period;
-
-        if (stake.tokensLocked > 0) {
-            lockingPeriod = Math.weightedAverage(
-                Math.diffOrZero(stake.tokensLockedUntil, block.number), // Remaining lock period
-                stake.tokensLocked,
-                _period,
-                _tokens
-            );
-        }
-
         stake.tokensLocked += _tokens;
-        stake.tokensLockedUntil = block.number + lockingPeriod;
+        stake.tokensLockedUntil = block.number + _period;
     }
 
     /**