feat: expose reward pool clawbak (#346)

Author: Yolley

lerna.json

@@ -1,6 +1,8 @@
 {
-  "packages": ["packages/*"],
-  "version": "11.2.2",
+  "packages": [
+    "packages/*"
+  ],
+  "version": "11.3.0",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "command": {
     "run": {

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "type": "module",

packages/distributor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/distributor",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "JavaScript SDK to interact with Streamflow Airdrop protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",

packages/eslint-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/eslint-config",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "ESLint configuration for Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "engines": {

packages/launchpad/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/launchpad",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "JavaScript SDK to interact with Streamflow Launchpad protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",

packages/staking/README.md

@@ -8,6 +8,7 @@ This package allows you to
 - `stake`; 
 - `unstake`; 
 - `fund rewards pools`;
+- `claw back unclaimed tokens from expired fixed reward pools`;
 
 with the Streamflow Staking protocol.
 
@@ -66,6 +67,7 @@ const client = new SolanaStakingClient({
 > - Withdraw/Unstake - staker's ATAs for stake mint and stake mint (see deriveStakeMintPDA fn) 
 > - Claim rewards - staker's ATAs for reward mint
 > - Fund Reward Pool - signer creates Streamflow Treasury's ATA for holding fee if defined
+> - Clawback - authority's ATA for reward mint
 
 #### Read operations
 ```typescript
@@ -377,6 +379,26 @@ const { tokenAccount } = await client.createFundDelegate({
 
 After creating the delegate, transfer reward tokens to the `tokenAccount`, which is an ATA for the fund delegate PDA address. The worker will periodically fund the reward pool from these tokens according to the schedule.
 
+### Clawback fixed reward pool funds
+
+`clawback` lets the reward pool authority recover any tokens still left in the reward pool vault after the stake pool has expired and the cooldown has passed.
+
+- It is available only for the fixed reward pool program.
+- Dynamic reward pools do not support clawback.
+- The program enforces a 7 day delay after `stakePool.expiryTs` before clawback is allowed.
+- When it succeeds, the remaining reward tokens are transferred to the authority's ATA for the reward mint and the reward vault is closed.
+
+```typescript
+await client.clawback({
+  stakePool,
+  stakePoolMint: mint,
+  nonce: rewardPoolNonce,
+  rewardMint,
+}, extParams);
+```
+
+Use `prepareClawbackInstructions` if you want to include the clawback instruction in a larger custom transaction.
+
 ### Set Token Metadata
 
 SolanaStakingClient also exposes original IDL of all programs, so you can use some additional instructions, that are not wrapped by the client. Currently there is no method to update Token Metadata of the Staking Mint that stakers get in return for their stake, but you can call the instructions from the original IDL like so:

packages/staking/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/staking",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "JavaScript SDK to interact with Streamflow Staking protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",

packages/staking/solana/client.ts

@@ -54,6 +54,7 @@ import {
 } from "./lib/derive-accounts.js";
 import type {
   ClaimRewardPoolArgs,
+  ClawbackRewardPoolArgs,
   CloseRewardEntryArgs,
   CloseStakeEntryArgs,
   CreateFundDelegateArgs,
@@ -682,6 +683,39 @@ export class SolanaStakingClient {
     return { ixs: treasuryATA ? treasuryATA.concat([instruction]) : [instruction] };
   }
 
+  async clawback(data: ClawbackRewardPoolArgs, extParams: IInteractExt): Promise<ITransactionResult> {
+    const { ixs } = await this.prepareClawbackInstructions(data, extParams);
+    const { signature } = await this.execute(ixs, extParams);
+
+    return {
+      ixs,
+      txId: signature,
+    };
+  }
+
+  async prepareClawbackInstructions(
+    { nonce, rewardMint, stakePool, tokenProgramId = TOKEN_PROGRAM_ID }: ClawbackRewardPoolArgs,
+    extParams: IInteractExt,
+  ) {
+    const { rewardPoolProgram } = this.programs;
+    const authority = extParams.invoker.publicKey;
+    invariant(authority, "Undefined invoker publicKey");
+    const rewardMintPk = pk(rewardMint);
+    const tokenProgramPk = pk(tokenProgramId);
+    const rewardPoolPda = deriveRewardPoolPDA(rewardPoolProgram.programId, pk(stakePool), rewardMintPk, nonce);
+    const instruction = await rewardPoolProgram.methods
+      .clawback()
+      .accountsPartial({
+        rewardPool: rewardPoolPda,
+        authority,
+        tokenProgram: tokenProgramId,
+        to: getAssociatedTokenAddressSync(rewardMintPk, authority, true, tokenProgramPk),
+      })
+      .instruction();
+
+    return { ixs: [instruction] };
+  }
+
   async createRewardEntry(data: CreateRewardEntryArgs, extParams: IInteractExt): Promise<ITransactionResult> {
     const { ixs } = await this.prepareCreateRewardEntryInstructions(data, extParams);
     const { signature } = await this.execute(ixs, extParams);

packages/staking/solana/types.ts

@@ -79,6 +79,11 @@ export interface FundPoolArgs extends BaseStakePoolArgs, TokenProgram, RewardPoo
   feeValue: Address | null;
 }
 
+export interface ClawbackRewardPoolArgs extends BaseStakePoolArgs, TokenProgram {
+  nonce: number;
+  rewardMint: Address;
+}
+
 export interface CreateRewardEntryArgs extends BaseStakePoolArgs, TokenProgram, RewardPoolProgram {
   depositNonce: number;
   rewardPoolNonce: number;

packages/stream/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/stream",
-  "version": "11.2.2",
+  "version": "11.3.0",
   "description": "JavaScript SDK to interact with Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",