feat(staking): add reward expiry (#1915)

Author: keyvankhademi

apps/staking/src/api.ts

@@ -33,12 +33,7 @@ type Data = {
         date: Date;
       }
     | undefined;
-  expiringRewards:
-    | {
-        amount: bigint;
-        expiry: Date;
-      }
-    | undefined;
+  expiringRewards: Date | undefined;
   unlockSchedule: {
     date: Date;
     amount: bigint;
@@ -235,8 +230,8 @@ const loadDataForStakeAccount = async (
   return {
     ...baseInfo,
     lastSlash: undefined, // TODO
-    availableRewards: claimableRewards,
-    expiringRewards: undefined, // TODO
+    availableRewards: claimableRewards.totalRewards,
+    expiringRewards: claimableRewards.expiry,
     total: stakeAccountCustody.amount,
     governance: {
       warmup: filterGovernancePositions(PositionState.LOCKING),

apps/staking/src/components/AccountSummary/index.tsx

@@ -29,12 +29,7 @@ type Props = {
     | undefined;
   walletAmount: bigint;
   availableRewards: bigint;
-  expiringRewards:
-    | {
-        amount: bigint;
-        expiry: Date;
-      }
-    | undefined;
+  expiringRewards: Date | undefined;
   availableToWithdraw: bigint;
 };
 
@@ -153,11 +148,12 @@ export const AccountSummary = ({
             )
           }
           {...(expiringRewards !== undefined &&
-            expiringRewards.amount > 0n && {
+            availableRewards > 0n && {
               warning: (
                 <>
-                  <Tokens>{expiringRewards.amount}</Tokens> will expire on{" "}
-                  {expiringRewards.expiry.toLocaleDateString()}
+                  Rewards expire one year from the epoch in which they were
+                  earned. You have rewards expiring on{" "}
+                  {expiringRewards.toLocaleDateString()}.
                 </>
               ),
             })}

apps/staking/src/components/Dashboard/index.tsx

@@ -19,12 +19,7 @@ type Props = {
     | undefined;
   walletAmount: bigint;
   availableRewards: bigint;
-  expiringRewards:
-    | {
-        amount: bigint;
-        expiry: Date;
-      }
-    | undefined;
+  expiringRewards: Date | undefined;
   unlockSchedule: {
     amount: bigint;
     date: Date;

governance/pyth_staking_sdk/src/pdas.ts

@@ -36,3 +36,17 @@ export const getPoolConfigAddress = () => {
     INTEGRITY_POOL_PROGRAM_ADDRESS,
   )[0];
 };
+
+export const getDelegationRecordAddress = (
+  stakeAccountPositions: PublicKey,
+  publisher: PublicKey,
+) => {
+  return PublicKey.findProgramAddressSync(
+    [
+      Buffer.from("delegation_record"),
+      publisher.toBuffer(),
+      stakeAccountPositions.toBuffer(),
+    ],
+    INTEGRITY_POOL_PROGRAM_ADDRESS,
+  )[0];
+};

governance/pyth_staking_sdk/src/pyth-staking-client.ts

@@ -24,6 +24,7 @@ import {
 import { GOVERNANCE_ADDRESS, POSITIONS_ACCOUNT_SIZE } from "./constants";
 import {
   getConfigAddress,
+  getDelegationRecordAddress,
   getPoolConfigAddress,
   getStakeAccountCustodyAddress,
   getStakeAccountMetadataAddress,
@@ -36,7 +37,7 @@ import {
   type StakeAccountPositions,
 } from "./types";
 import { convertBigIntToBN, convertBNToBigInt } from "./utils/bn";
-import { getCurrentEpoch } from "./utils/clock";
+import { epochToDate, getCurrentEpoch } from "./utils/clock";
 import { extractPublisherData } from "./utils/pool";
 import {
   deserializeStakeAccountPositions,
@@ -148,6 +149,17 @@ export class PythStakingClient {
     );
   }
 
+  public async getDelegationRecord(
+    stakeAccountPositions: PublicKey,
+    publisher: PublicKey,
+  ) {
+    const delegationRecord =
+      await this.integrityPoolProgram.account.delegationRecord.fetch(
+        getDelegationRecordAddress(stakeAccountPositions, publisher),
+      );
+    return convertBNToBigInt(delegationRecord);
+  }
+
   public async getStakeAccountCustody(
     stakeAccountPositions: PublicKey,
   ): Promise<Account> {
@@ -573,6 +585,7 @@ export class PythStakingClient {
     return {
       advanceDelegationRecordInstructions,
       mergePositionsInstruction,
+      publishers,
     };
   }
 
@@ -609,6 +622,24 @@ export class PythStakingClient {
       const buffer = Buffer.from(val, "base64").reverse();
       totalRewards += BigInt("0x" + buffer.toString("hex"));
     }
-    return totalRewards;
+
+    const delegationRecords = await Promise.all(
+      instructions.publishers.map(({ pubkey }) =>
+        this.getDelegationRecord(stakeAccountPositions, pubkey),
+      ),
+    );
+
+    let lowestEpoch: bigint | undefined;
+    for (const record of delegationRecords) {
+      if (lowestEpoch === undefined || record.lastEpoch < lowestEpoch) {
+        lowestEpoch = record.lastEpoch;
+      }
+    }
+
+    return {
+      totalRewards,
+      expiry:
+        lowestEpoch === undefined ? undefined : epochToDate(lowestEpoch + 52n),
+    };
   }
 }