Merge pull request #73 from ar-io/develop

Release to production
ar-io · Aug 20, 2024 · 649dc3b · 649dc3b
2 parents 77bb8ed + e16f3f5
commit 649dc3b
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 8 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -49,3 +49,6 @@ export const EAY_TOOLTIP_TEXT =
   'EAY = Estimated yield ratio determined by projecting the current nominal reward conditions over the course of a year. Does NOT include potential observation rewards.';
 export const EAY_TOOLTIP_FORMULA =
   '\\(EAY = \\frac{RewardsSharedPerEpoch}{TotalDelegatedStake} * EpochsPerYear\\)';
+
+export const OPERATOR_EAY_TOOLTIP_FORMULA =
+  '\\(EAY = \\frac{OperatorRewardsPerEpoch}{OperatorStake} * EpochsPerYear\\)';
diff --git a/src/pages/Gateway/index.tsx b/src/pages/Gateway/index.tsx
@@ -1,6 +1,11 @@
-import { IOToken, AoUpdateGatewaySettingsParams, mIOToken } from '@ar.io/sdk/web';
+import {
+  AoUpdateGatewaySettingsParams,
+  IOToken,
+  mIOToken,
+} from '@ar.io/sdk/web';
 import Button, { ButtonType } from '@src/components/Button';
 import Placeholder from '@src/components/Placeholder';
+import Tooltip from '@src/components/Tooltip';
 import FormRow, { RowType } from '@src/components/forms/FormRow';
 import {
   FormRowDef,
@@ -15,17 +20,26 @@ import {
   validateTransactionId,
   validateWalletAddress,
 } from '@src/components/forms/validation';
-import { EditIcon, StatsArrowIcon } from '@src/components/icons';
+import { EditIcon, InfoIcon, StatsArrowIcon } from '@src/components/icons';
 import BlockingMessageModal from '@src/components/modals/BlockingMessageModal';
 import SuccessModal from '@src/components/modals/SuccessModal';
-import { WRITE_OPTIONS, log } from '@src/constants';
+import {
+  EAY_TOOLTIP_TEXT,
+  OPERATOR_EAY_TOOLTIP_FORMULA,
+  WRITE_OPTIONS,
+  log,
+} from '@src/constants';
 import useGateway from '@src/hooks/useGateway';
+import useGateways from '@src/hooks/useGateways';
 import useHealthcheck from '@src/hooks/useHealthCheck';
+import useProtocolBalance from '@src/hooks/useProtocolBalance';
 import { useGlobalState } from '@src/store';
 import { formatDate } from '@src/utils';
+import { calculateOperatorRewards } from '@src/utils/rewards';
 import { showErrorToast } from '@src/utils/toast';
 import { useQueryClient } from '@tanstack/react-query';
-import { useEffect, useState } from 'react';
+import { MathJax } from 'better-react-mathjax';
+import { ReactNode, useEffect, useState } from 'react';
 import { useParams } from 'react-router-dom';
 import GatewayHeader from './GatewayHeader';
 import PropertyDisplayPanel from './PropertyDisplayPanel';
@@ -34,7 +48,7 @@ const StatsBox = ({
   title,
   value,
 }: {
-  title: string;
+  title: string | ReactNode;
   value: string | number | undefined;
 }) => {
   return (
@@ -68,6 +82,8 @@ const Gateway = () => {
   const arIOWriteableSDK = useGlobalState((state) => state.arIOWriteableSDK);
   const balances = useGlobalState((state) => state.balances);
   const ticker = useGlobalState((state) => state.ticker);
+  const { data: protocolBalance } = useProtocolBalance();
+  const { data: gateways } = useGateways();
 
   const params = useParams();
 
@@ -104,6 +120,15 @@ const Gateway = () => {
     ? new mIOToken(gateway.operatorStake).toIO().valueOf() + (balances?.io || 0)
     : undefined;
 
+  const operatorRewards =
+    gateway?.operatorStake && protocolBalance && gateways
+      ? calculateOperatorRewards(
+          new mIOToken(protocolBalance).toIO(),
+          Object.keys(gateways).length,
+          gateway,
+        )
+      : undefined;
+
   const weightFields: Array<[string, number | undefined]> = [
     ['Stake', gateway?.weights?.stakeWeight],
     ['Tenure', gateway?.weights?.tenureWeight],
@@ -317,9 +342,9 @@ const Gateway = () => {
         label: changed.label as string,
         minDelegatedStake:
           formState.allowDelegatedStaking && changed.minDelegatedStake
-            ? new IOToken(
-                parseFloat(changed.minDelegatedStake as string),
-              ).toMIO().valueOf()
+            ? new IOToken(parseFloat(changed.minDelegatedStake as string))
+                .toMIO()
+                .valueOf()
             : undefined,
         note: changed.note as string,
         properties: changed.properties as string,
@@ -421,6 +446,30 @@ const Gateway = () => {
                   : undefined
               }
             />
+            <StatsBox
+              title={
+                <div className="flex gap-2">
+                  Operator EAY{' '}
+                  <Tooltip
+                    message={
+                      <div>
+                        <p>{EAY_TOOLTIP_TEXT}</p>
+                        <MathJax className="mt-4">
+                          {OPERATOR_EAY_TOOLTIP_FORMULA}
+                        </MathJax>
+                      </div>
+                    }
+                  >
+                    <InfoIcon className="size-4" />
+                  </Tooltip>
+                </div>
+              }
+              value={
+                operatorRewards
+                  ? `${(operatorRewards.EAY * 100).toFixed(2)}%`
+                  : undefined
+              }
+            />
             {/* <StatsBox title="Rewards Distributed" value={gateway?} /> */}
           </div>
 

diff --git a/src/utils/rewards.ts b/src/utils/rewards.ts
@@ -12,11 +12,53 @@ export interface GatewayRewards {
   EAY: number;
 }
 
+export interface OperatorRewards {
+  operatorStake: IOToken;
+  rewardsSharedPerEpoch: IOToken;
+  EEY: number;
+  EAY: number;
+}
+
+
 export interface UserRewards {
   EEY: number;
   EAY: number;
 }
 
+
+export const calculateOperatorRewards = (
+  protocolBalance: IOToken,
+  totalGateways: number,
+  gateway: AoGateway,
+): OperatorRewards => {
+  const epochRewards = protocolBalance.valueOf() * EPOCH_DISTRIBUTION_RATIO;
+  const baseGatewayReward =
+    (epochRewards * GATEWAY_REWARDS_RATIO) / totalGateways;
+
+  const gatewayRewardShareRatio =
+    gateway.settings.delegateRewardShareRatio / 100;
+  const operatorStake = new mIOToken(gateway.operatorStake).toIO();
+
+  const rewardsSharedPerEpoch = new IOToken(
+    baseGatewayReward * (1 - gatewayRewardShareRatio),
+  );
+
+  // Return -1 if totalDelegatedStake is 0. This signals 0 stake and allows calling
+  // code to use the value for sorting purposes.
+  const EEY =
+    operatorStake.valueOf() > 0
+      ? rewardsSharedPerEpoch.valueOf() / operatorStake.valueOf()
+      : -1;
+  const EAY = EEY * EPOCHS_PER_YEAR;
+
+  return {
+    operatorStake,
+    rewardsSharedPerEpoch,
+    EEY,
+    EAY,
+  };
+};
+
 export const calculateGatewayRewards = (
   protocolBalance: IOToken,
   totalGateways: number,