fix(3162): improved 'getOverstakingPenalty' function and the full removal of overstaking amounts

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

apps/governance/src/routes/staking/PreviousEpoch.graphql

@@ -7,9 +7,10 @@ query PreviousEpoch($epochId: ID) {
           id
           rewardScore {
             rawValidatorScore
+            performanceScore
           }
           rankingScore {
-            performanceScore
+            stakeScore
           }
         }
       }

apps/governance/src/routes/staking/__generated__/PreviousEpoch.ts

@@ -8,7 +8,7 @@ export type PreviousEpochQueryVariables = Types.Exact<{
 }>;
 
 
-export type PreviousEpochQuery = { __typename?: 'Query', epoch: { __typename?: 'Epoch', id: string, validatorsConnection?: { __typename?: 'NodesConnection', edges?: Array<{ __typename?: 'NodeEdge', node: { __typename?: 'Node', id: string, rewardScore?: { __typename?: 'RewardScore', rawValidatorScore: string } | null, rankingScore: { __typename?: 'RankingScore', performanceScore: string } } } | null> | null } | null } };
+export type PreviousEpochQuery = { __typename?: 'Query', epoch: { __typename?: 'Epoch', id: string, validatorsConnection?: { __typename?: 'NodesConnection', edges?: Array<{ __typename?: 'NodeEdge', node: { __typename?: 'Node', id: string, rewardScore?: { __typename?: 'RewardScore', rawValidatorScore: string, performanceScore: string } | null, rankingScore: { __typename?: 'RankingScore', stakeScore: string } } } | null> | null } | null } };
 
 
 export const PreviousEpochDocument = gql`
@@ -21,9 +21,10 @@ export const PreviousEpochDocument = gql`
           id
           rewardScore {
             rawValidatorScore
+            performanceScore
           }
           rankingScore {
-            performanceScore
+            stakeScore
           }
         }
       }

apps/governance/src/routes/staking/home/validator-tables/consensus-validators-table.spec.tsx

@@ -81,9 +81,10 @@ const MOCK_PREVIOUS_EPOCH: PreviousEpochQuery = {
             id: 'ccc022b7e63a4d0a6d3a193c3940c88574060e58a184964c994998d86835a1b4',
             rewardScore: {
               rawValidatorScore: '0.25',
+              performanceScore: '0.9998677767864936',
             },
             rankingScore: {
-              performanceScore: '0.9998677767864936',
+              stakeScore: '0.2499583402766206',
             },
           },
         },
@@ -92,9 +93,10 @@ const MOCK_PREVIOUS_EPOCH: PreviousEpochQuery = {
             id: '966438c6bffac737cfb08173ffcb3f393c4692b099ad80cb45a82e2dc0a8cf99',
             rewardScore: {
               rawValidatorScore: '0.3',
+              performanceScore: '1',
             },
             rankingScore: {
-              performanceScore: '1',
+              stakeScore: '0.25',
             },
           },
         },
@@ -103,9 +105,10 @@ const MOCK_PREVIOUS_EPOCH: PreviousEpochQuery = {
             id: '12c81b738e8051152e1afe44376ec37bca9216466e6d44cdd772194bad0ada81',
             rewardScore: {
               rawValidatorScore: '0.35',
+              performanceScore: '0.999629748500531',
             },
             rankingScore: {
-              performanceScore: '0.999629748500531',
+              stakeScore: '0.2312',
             },
           },
         },

apps/governance/src/routes/staking/home/validator-tables/consensus-validators-table.tsx

@@ -10,7 +10,6 @@ import {
   getFormattedPerformanceScore,
   getLastEpochScoreAndPerformance,
   getNormalisedVotingPower,
-  getOverstakedAmount,
   getOverstakingPenalty,
   getPerformancePenalty,
   getTotalPenalties,
@@ -52,7 +51,6 @@ interface CanonisedConsensusNodeProps {
   [ValidatorFields.STAKED_BY_OPERATOR]: string;
   [ValidatorFields.PERFORMANCE_SCORE]: string;
   [ValidatorFields.PERFORMANCE_PENALTY]: string;
-  [ValidatorFields.OVERSTAKED_AMOUNT]: string;
   [ValidatorFields.OVERSTAKING_PENALTY]: string;
   [ValidatorFields.TOTAL_PENALTIES]: string;
   [ValidatorFields.PENDING_STAKE]: string;
@@ -164,14 +162,11 @@ export const ConsensusValidatorsTable = ({
           pendingUserStake,
           userStakeShare,
         }) => {
-          const { rawValidatorScore, performanceScore } =
-            getLastEpochScoreAndPerformance(previousEpochData, id);
-
-          const overstakedAmount = getOverstakedAmount(
-            rawValidatorScore,
-            stakedTotal,
-            totalStake
-          );
+          const {
+            rawValidatorScore: previousEpochValidatorScore,
+            performanceScore: previousEpochPerformanceScore,
+            stakeScore: previousEpochStakeScore,
+          } = getLastEpochScoreAndPerformance(previousEpochData, id);
 
           return {
             id,
@@ -184,7 +179,7 @@ export const ConsensusValidatorsTable = ({
             [ValidatorFields.NORMALISED_VOTING_POWER]:
               getNormalisedVotingPower(votingPower),
             [ValidatorFields.UNNORMALISED_VOTING_POWER]:
-              getUnnormalisedVotingPower(rawValidatorScore),
+              getUnnormalisedVotingPower(previousEpochValidatorScore),
             [ValidatorFields.STAKE_SHARE]: stakedTotalPercentage(stakeScore),
             [ValidatorFields.STAKED_BY_DELEGATES]: formatNumber(
               toBigNum(stakedByDelegates, decimals),
@@ -194,18 +189,19 @@ export const ConsensusValidatorsTable = ({
               toBigNum(stakedByOperator, decimals),
               2
             ),
-            [ValidatorFields.PERFORMANCE_SCORE]:
-              getFormattedPerformanceScore(performanceScore).toString(),
-            [ValidatorFields.PERFORMANCE_PENALTY]:
-              getPerformancePenalty(performanceScore),
-            [ValidatorFields.OVERSTAKED_AMOUNT]: overstakedAmount.toString(),
+            [ValidatorFields.PERFORMANCE_SCORE]: getFormattedPerformanceScore(
+              previousEpochPerformanceScore
+            ).toString(),
+            [ValidatorFields.PERFORMANCE_PENALTY]: getPerformancePenalty(
+              previousEpochPerformanceScore
+            ),
             [ValidatorFields.OVERSTAKING_PENALTY]: getOverstakingPenalty(
-              overstakedAmount,
-              totalStake
+              previousEpochValidatorScore,
+              previousEpochStakeScore
             ),
             [ValidatorFields.TOTAL_PENALTIES]: getTotalPenalties(
-              rawValidatorScore,
-              performanceScore,
+              previousEpochValidatorScore,
+              previousEpochPerformanceScore,
               stakedTotal,
               totalStake
             ),

apps/governance/src/routes/staking/home/validator-tables/standby-pending-validators-table.tsx

@@ -7,7 +7,6 @@ import { BigNumber } from '../../../../lib/bignumber';
 import {
   getFormattedPerformanceScore,
   getLastEpochScoreAndPerformance,
-  getOverstakedAmount,
   getOverstakingPenalty,
   getPerformancePenalty,
   getTotalPenalties,
@@ -82,21 +81,21 @@ export const StandbyPendingValidatorsTable = ({
           pendingUserStake,
           userStakeShare,
         }) => {
-          const { rawValidatorScore, performanceScore } =
-            getLastEpochScoreAndPerformance(previousEpochData, id);
+          const {
+            rawValidatorScore: previousEpochValidatorScore,
+            performanceScore: previousEpochPerformanceScore,
+            stakeScore: previousEpochStakeScore,
+          } = getLastEpochScoreAndPerformance(previousEpochData, id);
 
-          const overstakedAmount = getOverstakedAmount(
-            rawValidatorScore,
-            stakedTotal,
-            totalStake
-          );
           let individualStakeNeededForPromotion,
             individualStakeNeededForPromotionDescription;
 
-          if (stakeNeededForPromotion && performanceScore) {
+          if (stakeNeededForPromotion && previousEpochPerformanceScore) {
             const stakedTotalBigNum = new BigNumber(stakedTotal);
             const stakeNeededBigNum = new BigNumber(stakeNeededForPromotion);
-            const performanceScoreBigNum = new BigNumber(performanceScore);
+            const performanceScoreBigNum = new BigNumber(
+              previousEpochPerformanceScore
+            );
 
             const calc = stakeNeededBigNum
               .dividedBy(performanceScoreBigNum)
@@ -142,18 +141,19 @@ export const StandbyPendingValidatorsTable = ({
               toBigNum(stakedByOperator, decimals),
               2
             ),
-            [ValidatorFields.PERFORMANCE_SCORE]:
-              getFormattedPerformanceScore(performanceScore).toString(),
-            [ValidatorFields.PERFORMANCE_PENALTY]:
-              getPerformancePenalty(performanceScore),
-            [ValidatorFields.OVERSTAKED_AMOUNT]: overstakedAmount.toString(),
+            [ValidatorFields.PERFORMANCE_SCORE]: getFormattedPerformanceScore(
+              previousEpochPerformanceScore
+            ).toString(),
+            [ValidatorFields.PERFORMANCE_PENALTY]: getPerformancePenalty(
+              previousEpochPerformanceScore
+            ),
             [ValidatorFields.OVERSTAKING_PENALTY]: getOverstakingPenalty(
-              overstakedAmount,
-              totalStake
+              previousEpochValidatorScore,
+              previousEpochStakeScore
             ),
             [ValidatorFields.TOTAL_PENALTIES]: getTotalPenalties(
-              rawValidatorScore,
-              performanceScore,
+              previousEpochValidatorScore,
+              previousEpochPerformanceScore,
               stakedTotal,
               totalStake
             ),

apps/governance/src/routes/staking/node/validator-table.tsx

@@ -20,7 +20,6 @@ import { SubHeading } from '../../../components/heading';
 import {
   getLastEpochScoreAndPerformance,
   getNormalisedVotingPower,
-  getOverstakedAmount,
   getOverstakingPenalty,
   getPerformancePenalty,
   getTotalPenalties,
@@ -75,15 +74,9 @@ export const ValidatorTable = ({
 
   const stakedOnNode = toBigNum(node.stakedTotal, decimals);
 
-  const { rawValidatorScore, performanceScore } =
+  const { rawValidatorScore, performanceScore, stakeScore } =
     getLastEpochScoreAndPerformance(previousEpochData, node.id);
 
-  const overstakedAmount = getOverstakedAmount(
-    rawValidatorScore,
-    stakedTotal,
-    node.stakedTotal
-  );
-
   const stakePercentage = getStakePercentage(total, stakedOnNode);
 
   const totalPenaltiesAmount = getTotalPenalties(
@@ -245,7 +238,7 @@ export const ValidatorTable = ({
 
               <Tooltip description={t('OverstakedPenaltyDescription')}>
                 <span data-testid="overstaking-penalty">
-                  {getOverstakingPenalty(overstakedAmount, node.stakedTotal)}
+                  {getOverstakingPenalty(rawValidatorScore, stakeScore)}
                 </span>
               </Tooltip>
             </KeyValueTableRow>

apps/governance/src/routes/staking/shared.spec.ts

@@ -4,7 +4,6 @@ import {
   getNormalisedVotingPower,
   getUnnormalisedVotingPower,
   getOverstakingPenalty,
-  getOverstakedAmount,
   getFormattedPerformanceScore,
   getPerformancePenalty,
   getTotalPenalties,
@@ -22,9 +21,10 @@ describe('getLastEpochScoreAndPerformance', () => {
               id: '0x123',
               rewardScore: {
                 rawValidatorScore: '0.25',
+                performanceScore: '0.75',
               },
               rankingScore: {
-                performanceScore: '0.75',
+                stakeScore: '0.25',
               },
             },
           },
@@ -33,9 +33,10 @@ describe('getLastEpochScoreAndPerformance', () => {
               id: '0x234',
               rewardScore: {
                 rawValidatorScore: '0.35',
+                performanceScore: '0.85',
               },
               rankingScore: {
-                performanceScore: '0.85',
+                stakeScore: '0.25',
               },
             },
           },
@@ -50,12 +51,14 @@ describe('getLastEpochScoreAndPerformance', () => {
     ).toEqual({
       rawValidatorScore: '0.25',
       performanceScore: '0.75',
+      stakeScore: '0.25',
     });
     expect(
       getLastEpochScoreAndPerformance(mockPreviousEpochData, '0x234')
     ).toEqual({
       rawValidatorScore: '0.35',
       performanceScore: '0.85',
+      stakeScore: '0.25',
     });
   });
 });
@@ -79,40 +82,34 @@ describe('getUnnormalisedVotingPower', () => {
 });
 
 describe('getOverstakingPenalty', () => {
-  it('should return the overstaking penalty', () => {
-    expect(
-      getOverstakingPenalty(new BigNumber(100), Number(1000).toString())
-    ).toEqual('10.00%');
-    expect(
-      getOverstakingPenalty(new BigNumber(500), Number(2000).toString())
-    ).toEqual('25.00%');
-  });
-});
-
-describe('getOverstakedAmount', () => {
-  it('should return the overstaked amount', () => {
-    expect(
-      // If a validator score is 0, any amount staked on the node is considered overstaked
-      getOverstakedAmount('0', Number(100).toString(), Number(20).toString())
-    ).toEqual(new BigNumber(20));
-    expect(
-      getOverstakedAmount('0.05', Number(100).toString(), Number(20).toString())
-    ).toEqual(new BigNumber(15));
-    expect(
-      getOverstakedAmount('0.1', Number(100).toString(), Number(20).toString())
-    ).toEqual(new BigNumber(10));
-    expect(
-      getOverstakedAmount('0.15', Number(100).toString(), Number(20).toString())
-    ).toEqual(new BigNumber(5));
-    expect(
-      getOverstakedAmount('0.2', Number(100).toString(), Number(20).toString())
-    ).toEqual(new BigNumber(0));
+  it('returns "0%" when both arguments are null or undefined', () => {
+    expect(getOverstakingPenalty(null, null)).toBe('0%');
+    expect(getOverstakingPenalty(undefined, undefined)).toBe('0%');
+    expect(getOverstakingPenalty(null, undefined)).toBe('0%');
+    expect(getOverstakingPenalty(undefined, null)).toBe('0%');
   });
 
-  it('should return 0 if the overstaked amount is negative', () => {
-    expect(
-      getOverstakedAmount('0.8', Number(100).toString(), Number(20).toString())
-    ).toEqual(new BigNumber(0));
+  it('returns "0%" when one argument is null or undefined', () => {
+    expect(getOverstakingPenalty('10', null)).toBe('0%');
+    expect(getOverstakingPenalty(null, '20')).toBe('0%');
+    expect(getOverstakingPenalty('10', undefined)).toBe('0%');
+    expect(getOverstakingPenalty(undefined, '20')).toBe('0%');
+  });
+
+  it('returns "0%" when validatorScore or stakeScore is zero', () => {
+    expect(getOverstakingPenalty('0', '20')).toBe('0%');
+    expect(getOverstakingPenalty('10', '0')).toBe('0%');
+  });
+
+  it('returns the correct overstaking penalty', () => {
+    expect(getOverstakingPenalty('0.18', '0.2')).toBe('10.00%');
+    expect(getOverstakingPenalty('0.2', '0.2')).toBe('0.00%');
+    expect(getOverstakingPenalty('0.04', '0.2')).toBe('80.00%');
+  });
+
+  it('handles string numbers with decimals', () => {
+    expect(getOverstakingPenalty('7.5', '15')).toBe('50.00%');
+    expect(getOverstakingPenalty('12.5', '25')).toBe('50.00%');
   });
 });
 

apps/governance/src/routes/staking/shared.ts

@@ -15,7 +15,8 @@ export const getLastEpochScoreAndPerformance = (
 
   return {
     rawValidatorScore: validator?.rewardScore?.rawValidatorScore,
-    performanceScore: validator?.rankingScore?.performanceScore,
+    performanceScore: validator?.rewardScore?.performanceScore,
+    stakeScore: validator?.rankingScore?.stakeScore,
   };
 };
 
@@ -42,31 +43,26 @@ export const getPerformancePenalty = (performanceScore?: string) =>
     2
   );
 
-export const getOverstakedAmount = (
-  validatorScore: string | null | undefined,
-  totalStake: string,
-  stakedOnNode: string
-) => {
-  const toReturn = validatorScore
-    ? new BigNumber(stakedOnNode).minus(
-        new BigNumber(validatorScore).times(new BigNumber(totalStake))
-      )
-    : new BigNumber(0);
-
-  return toReturn.isNegative() ? new BigNumber(0) : toReturn;
-};
-
 export const getOverstakingPenalty = (
-  overstakedAmount: BigNumber,
-  stakedOnNode: string
+  validatorScore: string | null | undefined,
+  stakeScore: string | null | undefined
 ) => {
+  if (!validatorScore || !stakeScore) {
+    return '0%';
+  }
+
   // avoid division by zero
-  if (new BigNumber(stakedOnNode).isZero() || overstakedAmount.isZero()) {
-    return '0';
+  if (
+    new BigNumber(validatorScore).isZero() ||
+    new BigNumber(stakeScore).isZero()
+  ) {
+    return '0%';
   }
 
   return formatNumberPercentage(
-    overstakedAmount.dividedBy(new BigNumber(stakedOnNode)).times(100),
+    new BigNumber(1)
+      .minus(new BigNumber(validatorScore).dividedBy(new BigNumber(stakeScore)))
+      .times(100),
     2
   );
 };

apps/static/src/assets/mainnet-tranches.json

@@ -743,7 +743,7 @@
     "tranche_end": "2023-04-06T00:00:00.000Z",
     "total_added": "14099",
     "total_removed": "165.10784124668",
-    "locked_amount": "678.93022812126587656",
+    "locked_amount": "338.514968637992270967",
     "deposits": [
       {
         "amount": "30",
@@ -3531,7 +3531,7 @@
     "tranche_end": "2023-12-05T00:00:00.000Z",
     "total_added": "86666.297",
     "total_removed": "0",
-    "locked_amount": "58052.8347844548724897874",
+    "locked_amount": "57875.1133625658226291517",
     "deposits": [
       {
         "amount": "86666.297",
@@ -3597,7 +3597,7 @@
     "tranche_end": "2023-06-01T00:00:00.000Z",
     "total_added": "2500",
     "total_removed": "0",
-    "locked_amount": "789.7361174704925",
+    "locked_amount": "779.454746642246625",
     "deposits": [
       {
         "amount": "2500",
@@ -3718,7 +3718,7 @@
     "tranche_end": "2023-09-01T00:00:00.000Z",
     "total_added": "17500",
     "total_removed": "0",
-    "locked_amount": "14218.06420465982425",
+    "locked_amount": "14146.87688707729625",
     "deposits": [
       {
         "amount": "12500",
@@ -3985,7 +3985,7 @@
     "tranche_end": "2023-08-01T00:00:00.000Z",
     "total_added": "37500",
     "total_removed": "11781.2245815",
-    "locked_amount": "24549.61105356046875",
+    "locked_amount": "24394.53844383057",
     "deposits": [
       {
         "amount": "7500",
@@ -4305,7 +4305,7 @@
     "tranche_end": "2023-12-05T00:00:00.000Z",
     "total_added": "129999.45",
     "total_removed": "0",
-    "locked_amount": "57999.86887720182395889",
+    "locked_amount": "57822.30960374848094241",
     "deposits": [
       {
         "amount": "129999.45",
@@ -4338,7 +4338,7 @@
     "tranche_end": "2024-04-01T00:00:00.000Z",
     "total_added": "54144.7663",
     "total_removed": "0",
-    "locked_amount": "53625.92176199767137787447",
+    "locked_amount": "53515.19367393810504083066",
     "deposits": [
       {
         "amount": "54144.7663",
@@ -4371,7 +4371,7 @@
     "tranche_end": "2023-09-03T00:00:00.000Z",
     "total_added": "62600",
     "total_removed": "0",
-    "locked_amount": "25982.05099568747166",
+    "locked_amount": "25853.68089802130747",
     "deposits": [
       {
         "amount": "10000",
@@ -4564,7 +4564,7 @@
     "tranche_end": "2023-09-17T00:00:00.000Z",
     "total_added": "5000",
     "total_removed": "0",
-    "locked_amount": "2267.0245116692035",
+    "locked_amount": "2256.7713089802133",
     "deposits": [
       {
         "amount": "5000",
@@ -4775,7 +4775,7 @@
     "tranche_end": "2023-04-05T00:00:00.000Z",
     "total_added": "97499.58",
     "total_removed": "0",
-    "locked_amount": "114.670059269758708826712",
+    "locked_amount": "0",
     "deposits": [
       {
         "amount": "97499.58",
@@ -4808,7 +4808,7 @@
     "tranche_end": "2023-04-05T00:00:00.000Z",
     "total_added": "135173.4239508",
     "total_removed": "133818.54965292963650862",
-    "locked_amount": "156.7341740619102910317617016",
+    "locked_amount": "0",
     "deposits": [
       {
         "amount": "135173.4239508",
@@ -4865,7 +4865,7 @@
     "tranche_end": "2023-04-05T00:00:00.000Z",
     "total_added": "32499.86",
     "total_removed": "0",
-    "locked_amount": "48.239713688783163790292",
+    "locked_amount": "0",
     "deposits": [
       {
         "amount": "32499.86",
@@ -4898,7 +4898,7 @@
     "tranche_end": "2023-04-05T00:00:00.000Z",
     "total_added": "10833.29",
     "total_removed": "0",
-    "locked_amount": "15.701558698597860914475",
+    "locked_amount": "0",
     "deposits": [
       {
         "amount": "10833.29",
@@ -4931,7 +4931,7 @@
     "tranche_end": "2023-04-05T00:00:00.000Z",
     "total_added": "22749.93",
     "total_removed": "4720.860935375",
-    "locked_amount": "58.69593329515687274076",
+    "locked_amount": "0",
     "deposits": [
       {
         "amount": "6500",
@@ -5083,7 +5083,7 @@
     "tranche_end": "2023-05-01T00:00:00.000Z",
     "total_added": "22500",
     "total_removed": "6357.929999175",
-    "locked_amount": "3293.302543738489575",
+    "locked_amount": "3200.2589779005528",
     "deposits": [
       {
         "amount": "7500",
@@ -5523,7 +5523,7 @@
     "tranche_end": "2023-06-02T00:00:00.000Z",
     "total_added": "1939928.38",
     "total_removed": "928642.9598472029154",
-    "locked_amount": "310881.704353477216853244",
+    "locked_amount": "306903.608577024413946004",
     "deposits": [
       {
         "amount": "1852091.69",
@@ -39256,7 +39256,7 @@
     "tranche_end": "2023-06-05T00:00:00.000Z",
     "total_added": "3732368.4671",
     "total_removed": "700133.348465855088393",
-    "locked_amount": "502218.266807165390478061156",
+    "locked_amount": "496105.318624601551155638257",
     "deposits": [
       {
         "amount": "1998.95815",
@@ -40638,7 +40638,7 @@
     "tranche_end": "2023-12-05T00:00:00.000Z",
     "total_added": "15870102.715470999700000001",
     "total_removed": "815414.41205294384422952",
-    "locked_amount": "7080521.3142443494095869920319686650946202",
+    "locked_amount": "7058845.1924777653448375313192847387510138",
     "deposits": [
       {
         "amount": "16249.93",
@@ -46941,7 +46941,7 @@
     "tranche_end": "2023-05-05T00:00:00.000Z",
     "total_added": "14597706.0446472999",
     "total_removed": "5807463.612246947184450156",
-    "locked_amount": "815246.841464623777418025928181379",
+    "locked_amount": "795235.584253058282571973568973987",
     "deposits": [
       {
         "amount": "129284.449",
@@ -54504,8 +54504,8 @@
     "tranche_start": "2021-10-05T00:00:00.000Z",
     "tranche_end": "2023-04-05T00:00:00.000Z",
     "total_added": "5778205.3912159303",
-    "total_removed": "3392215.772266846747044578",
-    "locked_amount": "5205.55409434058117598292834049366",
+    "total_removed": "3421590.665302980803025769",
+    "locked_amount": "0",
     "deposits": [
       {
         "amount": "552496.6455",
@@ -54654,6 +54654,21 @@
         "user": "0xBc934494675a6ceB639B9EfEe5b9C0f017D35a75",
         "tx": "0x621a569bfd19dbc0a6ba78addf836a9f2f1897258a88198d994e5b18c9f4901e"
       },
+      {
+        "amount": "13312.213609122936225",
+        "user": "0xafa64cCa337eFEE0AD827F6C2684e69275226e90",
+        "tx": "0x8a1d50991be09f4adc9eba704fbbcd271e8022db56498b300f39d3111bf187ea"
+      },
+      {
+        "amount": "13385.167736021049216341",
+        "user": "0xC24da173A250e9Ca5c54870639EbE5f88be5102d",
+        "tx": "0xa6c475d9dc04d4f722ead66481243b19a2eaafac7d81b4b3bc711a8269a52259"
+      },
+      {
+        "amount": "2677.51169099007053985",
+        "user": "0x6ae83EAB68b7112BaD5AfD72d6B24546AbFF137D",
+        "tx": "0x5d28a9be9d82440733d43afac61bcf6ff79024f1f73d621aa1d3afdba072db4c"
+      },
       {
         "amount": "8511.948415174862415",
         "user": "0xafa64cCa337eFEE0AD827F6C2684e69275226e90",
@@ -55803,6 +55818,12 @@
           }
         ],
         "withdrawals": [
+          {
+            "amount": "2677.51169099007053985",
+            "user": "0x6ae83EAB68b7112BaD5AfD72d6B24546AbFF137D",
+            "tranche_id": 4,
+            "tx": "0x5d28a9be9d82440733d43afac61bcf6ff79024f1f73d621aa1d3afdba072db4c"
+          },
           {
             "amount": "3239.30329480758879835",
             "user": "0x6ae83EAB68b7112BaD5AfD72d6B24546AbFF137D",
@@ -55907,8 +55928,8 @@
           }
         ],
         "total_tokens": "92082.572555",
-        "withdrawn_tokens": "89387.21943647261010385",
-        "remaining_tokens": "2695.35311852738989615"
+        "withdrawn_tokens": "92064.7311274626806437",
+        "remaining_tokens": "17.8414275373193563"
       },
       {
         "address": "0x1dC9B91DE003fd503F25cB5d114cf0fc68F7aFe6",
@@ -55936,6 +55957,12 @@
           }
         ],
         "withdrawals": [
+          {
+            "amount": "13385.167736021049216341",
+            "user": "0xC24da173A250e9Ca5c54870639EbE5f88be5102d",
+            "tranche_id": 4,
+            "tx": "0xa6c475d9dc04d4f722ead66481243b19a2eaafac7d81b4b3bc711a8269a52259"
+          },
           {
             "amount": "16197.295646834677510988",
             "user": "0xC24da173A250e9Ca5c54870639EbE5f88be5102d",
@@ -56064,8 +56091,8 @@
           }
         ],
         "total_tokens": "460415.072915097",
-        "withdrawn_tokens": "446939.762381235099977322",
-        "remaining_tokens": "13475.310533861900022678"
+        "withdrawn_tokens": "460324.930117256149193663",
+        "remaining_tokens": "90.142797840850806337"
       },
       {
         "address": "0xd66e4853c0880df150e7329974715BFC8d2da47D",
@@ -56280,6 +56307,12 @@
           }
         ],
         "withdrawals": [
+          {
+            "amount": "13312.213609122936225",
+            "user": "0xafa64cCa337eFEE0AD827F6C2684e69275226e90",
+            "tranche_id": 4,
+            "tx": "0x8a1d50991be09f4adc9eba704fbbcd271e8022db56498b300f39d3111bf187ea"
+          },
           {
             "amount": "8511.948415174862415",
             "user": "0xafa64cCa337eFEE0AD827F6C2684e69275226e90",
@@ -56540,8 +56573,8 @@
           }
         ],
         "total_tokens": "331498.5873",
-        "withdrawn_tokens": "317966.428170547352487",
-        "remaining_tokens": "13532.159129452647513"
+        "withdrawn_tokens": "331278.641779670288712",
+        "remaining_tokens": "219.945520329711288"
       },
       {
         "address": "0x16da609341ed67750A8BCC5AAa2005471006Cd77",
@@ -56643,8 +56676,8 @@
     "tranche_start": "2022-06-05T00:00:00.000Z",
     "tranche_end": "2023-06-05T00:00:00.000Z",
     "total_added": "472355.6199999996",
-    "total_removed": "40484.5737215701949",
-    "locked_amount": "79579.355177598255869407206189732",
+    "total_removed": "41316.3370079701949",
+    "locked_amount": "78610.723594969487558672821308984",
     "deposits": [
       {
         "amount": "3000",
@@ -63328,6 +63361,11 @@
         "user": "0x5c8fadaf56946d60823Dae0526A540EEfE791c99",
         "tx": "0x67af8d72b36a27796fbe8f52ac55951d54102ac58582f848f0d21cf8ca427e77"
       },
+      {
+        "amount": "831.7632864",
+        "user": "0x9405F540EcC1204801De5C4444D06386BD6693F0",
+        "tx": "0x0df6ec04cbdda41c8649a5e360ec541d14371e3877d82e1404308180024ede02"
+      },
       {
         "amount": "154.812094114",
         "user": "0x27e2254A2A8c9c9D1321E5Fe64cAD88e7A4f0ba7",
@@ -68495,10 +68533,17 @@
             "tx": "0x1c2c084e3efafb2ffa09c0b259bd229cce0d6da04dd092d911c7e6136a7ac8a9"
           }
         ],
-        "withdrawals": [],
+        "withdrawals": [
+          {
+            "amount": "831.7632864",
+            "user": "0x9405F540EcC1204801De5C4444D06386BD6693F0",
+            "tranche_id": 5,
+            "tx": "0x0df6ec04cbdda41c8649a5e360ec541d14371e3877d82e1404308180024ede02"
+          }
+        ],
         "total_tokens": "1000",
-        "withdrawn_tokens": "0",
-        "remaining_tokens": "1000"
+        "withdrawn_tokens": "831.7632864",
+        "remaining_tokens": "168.2367136"
       },
       {
         "address": "0x99b4635De6c5c8cdbBf728d7AA0d1b9DD8Ee381F",
@@ -86193,7 +86238,7 @@
     "tranche_start": "2021-12-05T00:00:00.000Z",
     "tranche_end": "2022-06-05T00:00:00.000Z",
     "total_added": "171288.42",
-    "total_removed": "67553.5995794947989",
+    "total_removed": "68803.5995794947989",
     "locked_amount": "0",
     "deposits": [
       {
@@ -90418,6 +90463,11 @@
       }
     ],
     "withdrawals": [
+      {
+        "amount": "1250",
+        "user": "0x9405F540EcC1204801De5C4444D06386BD6693F0",
+        "tx": "0x7dbc1e3f31a7aeea4e74f2bf14137bb99045b84afe7582a9ed2bc9d63b5458a4"
+      },
       {
         "amount": "250",
         "user": "0x2dd204e9cC4D41C68f2bb7Aa3b8Ce49884e482f5",
@@ -95842,10 +95892,17 @@
             "tx": "0x1c2c084e3efafb2ffa09c0b259bd229cce0d6da04dd092d911c7e6136a7ac8a9"
           }
         ],
-        "withdrawals": [],
+        "withdrawals": [
+          {
+            "amount": "1250",
+            "user": "0x9405F540EcC1204801De5C4444D06386BD6693F0",
+            "tranche_id": 6,
+            "tx": "0x7dbc1e3f31a7aeea4e74f2bf14137bb99045b84afe7582a9ed2bc9d63b5458a4"
+          }
+        ],
         "total_tokens": "1250",
-        "withdrawn_tokens": "0",
-        "remaining_tokens": "1250"
+        "withdrawn_tokens": "1250",
+        "remaining_tokens": "0"
       },
       {
         "address": "0xf36f5369adBE86DF71f5bFfB0264fc1D99fA2935",

libs/deposits/src/lib/approve-notification.tsx

@@ -174,7 +174,7 @@ const ApprovalTxFeedback = ({
             <>
               <p>
                 {t(
-                  `Your ${selectedAsset?.symbol} is being confirmed by the Ethereum network. When this is complete, you can continue your deposit`
+                  `Your ${selectedAsset?.symbol} approval is being confirmed by the Ethereum network. When this is complete, you can continue your deposit`
                 )}{' '}
               </p>
               {txLink && <p>{txLink}</p>}

libs/smart-contracts/src/contracts/claim.ts

@@ -1,6 +1,7 @@
 import { ethers } from 'ethers';
 import { hexlify } from 'ethers/lib/utils';
 import abi from '../abis/claim_abi.json';
+import { calcGasBuffer } from '../utils';
 
 export const UNSPENT_CODE = '0x0000000000000000000000000000000000000000';
 export const SPENT_CODE = '0x0000000000000000000000000000000000000001';
@@ -42,7 +43,7 @@ export class Claim {
    * was performed and mined beforehand
    * @return {Promise<boolean>}
    */
-  public claim({
+  public async claim({
     amount,
     tranche,
     expiry,
@@ -61,20 +62,20 @@ export class Claim {
     r: string;
     s: string;
   }): Promise<ethers.ContractTransaction> {
-    return this.contract[
-      target != null ? 'claim_targeted' : 'claim_untargeted'
-    ](
-      ...[
-        { r, s, v },
-        {
-          amount,
-          tranche,
-          expiry,
-        },
-        hexlify(country),
-        target,
-      ].filter(Boolean)
-    );
+    const method = target != null ? 'claim_targeted' : 'claim_untargeted';
+    const args = [
+      { r, s, v },
+      {
+        amount,
+        tranche,
+        expiry,
+      },
+      hexlify(country),
+      target,
+    ].filter(Boolean);
+    const res = await this.contract.estimateGas[method](...args);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract[method](...args, { gasLimit });
   }
 
   /**

libs/smart-contracts/src/contracts/collateral-bridge.ts

@@ -1,6 +1,7 @@
 import type { BigNumber } from 'ethers';
 import { ethers } from 'ethers';
 import abi from '../abis/erc20_bridge_abi.json';
+import { calcGasBuffer } from '../utils';
 
 export class CollateralBridge {
   public contract: ethers.Contract;
@@ -13,8 +14,20 @@ export class CollateralBridge {
     this.contract = new ethers.Contract(address, abi, signerOrProvider);
   }
 
-  deposit_asset(assetSource: string, amount: string, vegaPublicKey: string) {
-    return this.contract.deposit_asset(assetSource, amount, vegaPublicKey);
+  async deposit_asset(
+    assetSource: string,
+    amount: string,
+    vegaPublicKey: string
+  ) {
+    const res = await this.contract.estimateGas.deposit_asset(
+      assetSource,
+      amount,
+      vegaPublicKey
+    );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.deposit_asset(assetSource, amount, vegaPublicKey, {
+      gasLimit,
+    });
   }
   get_asset_source(vegaAssetId: string) {
     return this.contract.get_asset_source(vegaAssetId);
@@ -37,7 +50,7 @@ export class CollateralBridge {
   default_withdraw_delay() {
     return this.contract.default_withdraw_delay();
   }
-  list_asset(
+  async list_asset(
     address: string,
     vegaAssetId: string,
     lifetimeLimit: string,
@@ -45,7 +58,7 @@ export class CollateralBridge {
     nonce: string,
     signatures: string
   ) {
-    return this.contract.list_asset(
+    const res = await this.contract.estimateGas.list_asset(
       address,
       vegaAssetId,
       lifetimeLimit,
@@ -53,8 +66,20 @@ export class CollateralBridge {
       nonce,
       signatures
     );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.list_asset(
+      address,
+      vegaAssetId,
+      lifetimeLimit,
+      withdraw_threshold,
+      nonce,
+      signatures,
+      {
+        gasLimit,
+      }
+    );
   }
-  withdraw_asset(
+  async withdraw_asset(
     assetSource: string,
     amount: string,
     target: string,
@@ -62,7 +87,7 @@ export class CollateralBridge {
     nonce: string,
     signatures: string
   ) {
-    return this.contract.withdraw_asset(
+    const res = await this.contract.estimateGas.withdraw_asset(
       assetSource,
       amount,
       target,
@@ -70,6 +95,18 @@ export class CollateralBridge {
       nonce,
       signatures
     );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.withdraw_asset(
+      assetSource,
+      amount,
+      target,
+      creation,
+      nonce,
+      signatures,
+      {
+        gasLimit,
+      }
+    );
   }
 
   is_stopped() {

libs/smart-contracts/src/contracts/multisig-control.ts

@@ -1,5 +1,6 @@
 import { ethers } from 'ethers';
 import abi from '../abis/multisig_abi.json';
+import { calcGasBuffer } from '../utils';
 
 export class MultisigControl {
   public contract: ethers.Contract;
@@ -13,12 +14,20 @@ export class MultisigControl {
     this.address = address;
   }
 
-  add_signer(newSigner: string, nonce: string, signatures: string) {
-    return this.contract.add_signer(newSigner, nonce, signatures);
+  async add_signer(newSigner: string, nonce: string, signatures: string) {
+    const res = await this.contract.estimateGas.add_signer(
+      newSigner,
+      nonce,
+      signatures
+    );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.add_signer(newSigner, nonce, signatures, { gasLimit });
   }
 
-  burn_nonce(nonce: string, signatures: string) {
-    return this.contract.burn_nonce(nonce, signatures);
+  async burn_nonce(nonce: string, signatures: string) {
+    const res = await this.contract.estimateGas.burn_nonce(nonce, signatures);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.burn_nonce(nonce, signatures, { gasLimit });
   }
 
   get_current_threshold() {
@@ -37,19 +46,43 @@ export class MultisigControl {
     return this.contract.is_valid_signer(signerAddress);
   }
 
-  remove_signer(oldSigner: string, nonce: string, signatures: string) {
-    return this.contract.remove_signer(oldSigner, nonce, signatures);
+  async remove_signer(oldSigner: string, nonce: string, signatures: string) {
+    const res = await this.contract.estimateGas.remove_signer(
+      oldSigner,
+      nonce,
+      signatures
+    );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.remove_signer(oldSigner, nonce, signatures, {
+      gasLimit,
+    });
   }
 
-  set_threshold(newThreshold: string, nonce: string, signatures: string) {
-    return this.contract.set_threshold(newThreshold, nonce, signatures);
+  async set_threshold(newThreshold: string, nonce: string, signatures: string) {
+    const res = await this.contract.estimateGas.set_threshold(
+      newThreshold,
+      nonce,
+      signatures
+    );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.set_threshold(newThreshold, nonce, signatures, {
+      gasLimit,
+    });
   }
 
   signers(address: string) {
     return this.contract.signers(address);
   }
 
-  verify_signatures(nonce: string, message: string, signatures: string) {
-    return this.contract.verify_signatures(nonce, message, signatures);
+  async verify_signatures(nonce: string, message: string, signatures: string) {
+    const res = await this.contract.estimateGas.verify_signatures(
+      nonce,
+      message,
+      signatures
+    );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.verify_signatures(nonce, message, signatures, {
+      gasLimit,
+    });
   }
 }

libs/smart-contracts/src/contracts/staking-bridge.ts

@@ -1,6 +1,6 @@
 import { ethers } from 'ethers';
 import abi from '../abis/staking_abi.json';
-import { prepend0x } from '../utils';
+import { calcGasBuffer, prepend0x } from '../utils';
 
 export class StakingBridge {
   public contract: ethers.Contract;
@@ -13,20 +13,41 @@ export class StakingBridge {
     this.contract = new ethers.Contract(address, abi, signerOrProvider);
     this.address = address;
   }
+  async stake(amount: string, vegaPublicKey: string) {
+    const key = prepend0x(vegaPublicKey);
+    const res = await this.contract.estimateGas.stake(amount, key);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.stake(amount, key, {
+      gasLimit,
+    });
+  }
 
-  stake(amount: string, vegaPublicKey: string) {
-    return this.contract.stake(amount, prepend0x(vegaPublicKey));
+  async remove_stake(amount: string, vegaPublicKey: string) {
+    const key = prepend0x(vegaPublicKey);
+    const res = await this.contract.estimateGas.remove_stake(amount, key);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.remove_stake(amount, key, {
+      gasLimit,
+    });
   }
-  remove_stake(amount: string, vegaPublicKey: string) {
-    return this.contract.remove_stake(amount, prepend0x(vegaPublicKey));
-  }
-  transfer_stake(amount: string, newAddress: string, vegaPublicKey: string) {
-    return this.contract.transfer_stake(
+
+  async transfer_stake(
+    amount: string,
+    newAddress: string,
+    vegaPublicKey: string
+  ) {
+    const key = prepend0x(vegaPublicKey);
+    const res = await this.contract.estimateGas.transfer_stake(
       amount,
       newAddress,
-      prepend0x(vegaPublicKey)
+      key
     );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.transfer_stake(amount, newAddress, key, {
+      gasLimit,
+    });
   }
+
   staking_token() {
     return this.contract.staking_token();
   }

libs/smart-contracts/src/contracts/token-faucetable.ts

@@ -1,6 +1,7 @@
 import type { BigNumber } from 'ethers';
 import { ethers } from 'ethers';
 import erc20AbiFaucetable from '../abis/erc20_abi_faucet.json';
+import { calcGasBuffer } from '../utils';
 
 export class TokenFaucetable {
   public contract: ethers.Contract;
@@ -27,13 +28,17 @@ export class TokenFaucetable {
   allowance(owner: string, spender: string): Promise<BigNumber> {
     return this.contract.allowance(owner, spender);
   }
-  approve(spender: string, amount: string) {
-    return this.contract.approve(spender, amount);
+  async approve(spender: string, amount: string) {
+    const res = await this.contract.estimateGas.approve(spender, amount);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.approve(spender, amount, { gasLimit });
   }
   decimals(): Promise<number> {
     return this.contract.decimals();
   }
-  faucet() {
-    return this.contract.faucet();
+  async faucet() {
+    const res = await this.contract.estimateGas.faucet();
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.faucet({ gasLimit });
   }
 }

libs/smart-contracts/src/contracts/token-vesting.ts

@@ -1,6 +1,6 @@
 import { ethers } from 'ethers';
 import abi from '../abis/vesting_abi.json';
-import { prepend0x } from '../utils';
+import { calcGasBuffer, prepend0x } from '../utils';
 
 export class TokenVesting {
   public contract: ethers.Contract;
@@ -13,12 +13,21 @@ export class TokenVesting {
     this.contract = new ethers.Contract(address, abi, signerOrProvider);
     this.address = address;
   }
-
-  stake_tokens(amount: string, vegaPublicKey: string) {
-    return this.contract.stake_tokens(amount, prepend0x(vegaPublicKey));
+  async stake_tokens(amount: string, vegaPublicKey: string) {
+    const key = prepend0x(vegaPublicKey);
+    const res = await this.contract.estimateGas.stake_tokens(amount, key);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.stake_tokens(amount, key, {
+      gasLimit,
+    });
   }
-  remove_stake(amount: string, vegaPublicKey: string) {
-    return this.contract.remove_stake(amount, prepend0x(vegaPublicKey));
+  async remove_stake(amount: string, vegaPublicKey: string) {
+    const key = prepend0x(vegaPublicKey);
+    const res = await this.contract.estimateGas.remove_stake(amount, key);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.remove_stake(amount, key, {
+      gasLimit,
+    });
   }
   stake_balance(address: string, vegaPublicKey: string) {
     return this.contract.stake_balance(address, prepend0x(vegaPublicKey));
@@ -38,7 +47,13 @@ export class TokenVesting {
   user_total_all_tranches(address: string) {
     return this.contract.user_total_all_tranches(address);
   }
-  withdraw_from_tranche(trancheId: number) {
-    return this.contract.withdraw_from_tranche(trancheId);
+  async withdraw_from_tranche(trancheId: number) {
+    const res = await this.contract.estimateGas.withdraw_from_tranche(
+      trancheId
+    );
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.withdraw_from_tranche(trancheId, {
+      gasLimit,
+    });
   }
 }

libs/smart-contracts/src/contracts/token.ts

@@ -1,6 +1,7 @@
 import type { BigNumber } from 'ethers';
 import { ethers } from 'ethers';
 import erc20Abi from '../abis/erc20_abi.json';
+import { calcGasBuffer } from '../utils';
 
 export class Token {
   public contract: ethers.Contract;
@@ -23,13 +24,15 @@ export class Token {
   allowance(owner: string, spender: string): Promise<BigNumber> {
     return this.contract.allowance(owner, spender);
   }
-  approve(spender: string, amount: string) {
-    return this.contract.approve(spender, amount);
+  async approve(spender: string, amount: string) {
+    const res = await this.contract.estimateGas.approve(spender, amount);
+    const gasLimit = calcGasBuffer(res);
+    return this.contract.approve(spender, amount, { gasLimit });
   }
   decimals(): Promise<number> {
     return this.contract.decimals();
   }
-  faucet() {
+  async faucet() {
     /* No op */
   }
 }

libs/smart-contracts/src/utils/calc-gas-buffer.ts

@@ -0,0 +1,5 @@
+import type { BigNumber as EthersBigNumber } from 'ethers';
+
+export function calcGasBuffer(value: EthersBigNumber): EthersBigNumber {
+  return value.mul(120).div(100);
+}

libs/smart-contracts/src/utils/index.ts

@@ -1 +1,2 @@
+export * from './calc-gas-buffer';
 export * from './prepend-0x';