feat: support create v2, update idls to support stake boundaries, expose governor (#305)

* feat: support create v2, update idls to support stake boundaries, expose governor

Author: Yolley

lerna.json

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

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "8.7.0",
+  "version": "8.8.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": "8.7.0",
+  "version": "8.8.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": "8.7.0",
+  "version": "8.8.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": "8.7.0",
+  "version": "8.8.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/staking",
-  "version": "8.7.0",
+  "version": "8.8.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

@@ -21,6 +21,7 @@ import {
   unwrapExecutionParams,
 } from "@streamflow/common/solana";
 import type PQueue from "p-queue";
+import BN from "bn.js";
 
 import {
   REWARD_ENTRY_BYTE_OFFSETS,
@@ -33,10 +34,12 @@ import {
   STREAMFLOW_TREASURY_PUBLIC_KEY,
 } from "./constants.js";
 import { type FeeManager as FeeManagerProgramType } from "./descriptor/fee_manager.js";
+import GovernorIDL from "./descriptor/idl/governor.json";
 import FeeManagerIDL from "./descriptor/idl/fee_manager.json";
 import RewardPoolIDL from "./descriptor/idl/reward_pool.json";
 import RewardPoolDynamicIDL from "./descriptor/idl/reward_pool_dynamic.json";
 import StakePoolIDL from "./descriptor/idl/stake_pool.json";
+import { type Governor as GovernorProgramType } from "./descriptor/governor.js";
 import { type RewardPool as RewardPoolProgramType } from "./descriptor/reward_pool.js";
 import { type RewardPoolDynamic as RewardPoolDynamicProgramType } from "./descriptor/reward_pool_dynamic.js";
 import { type StakePool as StakePoolProgramType } from "./descriptor/stake_pool.js";
@@ -46,7 +49,6 @@ import {
   deriveRewardPoolPDA,
   deriveRewardVaultPDA,
   deriveStakeEntryPDA,
-  deriveStakeMintPDA,
   deriveStakePoolPDA,
 } from "./lib/derive-accounts.js";
 import type {
@@ -77,6 +79,7 @@ interface Programs {
   rewardPoolProgram: Program<RewardPoolProgramType>;
   rewardPoolDynamicProgram: Program<RewardPoolDynamicProgramType>;
   feeManagerProgram: Program<FeeManagerProgramType>;
+  governor: Program<GovernorProgramType>;
 }
 
 type CreationResult = ITransactionResult & { metadataId: PublicKey };
@@ -90,6 +93,7 @@ interface IInitOptions {
     rewardPool?: string;
     rewardPoolDynamic?: string;
     feeManager?: string;
+    governor?: string;
   };
   sendRate?: number;
   sendThrottler?: PQueue;
@@ -134,6 +138,10 @@ export class SolanaStakingClient {
       ...FeeManagerIDL,
       address: programIds?.feeManager ?? FeeManagerIDL.address,
     } as FeeManagerProgramType;
+    const governorIdl = {
+      ...GovernorIDL,
+      address: programIds?.governor ?? GovernorIDL.address,
+    };
     this.programs = {
       stakePoolProgram: new Program(stakePoolIdl, {
         connection: this.connection,
@@ -147,6 +155,9 @@ export class SolanaStakingClient {
       feeManagerProgram: new Program(feeManagerIdl, {
         connection: this.connection,
       }) as Program<FeeManagerProgramType>,
+      governor: new Program(governorIdl, {
+        connection: this.connection,
+      }) as Program<GovernorProgramType>,
     };
   }
 
@@ -238,16 +249,42 @@ export class SolanaStakingClient {
       permissionless = false,
       freezeStakeMint = null,
       unstakePeriod = null,
+      maxTotalStakeCumulative,
+      expiryTs,
+      autoUnstake,
       nonce,
       tokenProgramId = TOKEN_PROGRAM_ID,
     }: CreateStakePoolArgs,
     extParams: IInteractSolanaExt,
   ) {
     const { stakePoolProgram } = this.programs;
     const creator = extParams.invoker.publicKey;
+    const v2ParamsSet = maxTotalStakeCumulative !== undefined || expiryTs !== undefined || autoUnstake !== undefined;
     invariant(creator, "Undefined invoker publicKey");
-    const createInstruction = await stakePoolProgram.methods
-      .createPool(nonce, maxWeight, minDuration, maxDuration, permissionless, freezeStakeMint, unstakePeriod)
+    const createInstruction = await (
+      v2ParamsSet
+        ? stakePoolProgram.methods.createPoolV2(
+            nonce,
+            maxWeight,
+            minDuration,
+            maxDuration,
+            permissionless,
+            freezeStakeMint ?? false,
+            unstakePeriod ?? new BN(0),
+            maxTotalStakeCumulative ?? new BN(0),
+            expiryTs ?? new BN(0),
+            autoUnstake ?? false,
+          )
+        : stakePoolProgram.methods.createPool(
+            nonce,
+            maxWeight,
+            minDuration,
+            maxDuration,
+            permissionless,
+            freezeStakeMint,
+            unstakePeriod,
+          )
+    )
       .accounts({
         creator,
         mint,
@@ -327,16 +364,13 @@ export class SolanaStakingClient {
     const { stakePoolProgram } = this.programs;
     const staker = extParams.invoker.publicKey;
     invariant(staker, "Undefined invoker publicKey");
-    const mint = deriveStakeMintPDA(stakePoolProgram.programId, pk(stakePool));
-    const stakeMintAccountKey = getAssociatedTokenAddressSync(mint, staker, true, pk(tokenProgramId));
     const poolMintAccountKey = getAssociatedTokenAddressSync(pk(stakePoolMint), staker, true, pk(tokenProgramId));
     const instruction = await stakePoolProgram.methods
       .stake(nonce, amount, duration)
       .accounts({
         stakePool: stakePool,
         tokenProgram: tokenProgramId,
         from: poolMintAccountKey,
-        to: stakeMintAccountKey,
         authority: staker,
         payer: staker,
       })
@@ -458,16 +492,13 @@ export class SolanaStakingClient {
     const { stakePoolProgram } = this.programs;
     const staker = extParams.invoker.publicKey;
     invariant(staker, "Undefined invoker publicKey");
-    const stakeMintKey = deriveStakeMintPDA(stakePoolProgram.programId, pk(stakePool));
     const stakeEntryKey = deriveStakeEntryPDA(stakePoolProgram.programId, pk(stakePool), staker, nonce);
     const poolMintAccountKey = getAssociatedTokenAddressSync(pk(stakePoolMint), staker, true, pk(tokenProgramId));
-    const stakeMintAccountKey = getAssociatedTokenAddressSync(stakeMintKey, staker, true, pk(tokenProgramId));
     const instruction = await stakePoolProgram.methods
       .unstake(shouldClose)
       .accounts({
         stakeEntry: stakeEntryKey,
         to: poolMintAccountKey,
-        from: stakeMintAccountKey,
         authority: staker,
         tokenProgram: tokenProgramId,
       })

packages/staking/solana/descriptor/fee_manager.ts

@@ -8,7 +8,7 @@ export type FeeManager = {
   "address": "FEELzfBhsWXTNJX53zZcDVfRNoFYZQ6cZA3jLiGVL16V",
   "metadata": {
     "name": "feeManager",
-    "version": "2.2.0",
+    "version": "2.4.0",
     "spec": "0.1.0",
     "description": "Stores Fees and other admin configuration for the Staking protocol"
   },