@streamflow/staking 7.0.0-alpha.7 → 7.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Streamflow Staking
 
-## JS SDK to interact with Streamflow Staking.
+## JS SDK to interact with Streamflow Staking protocol.
 
 This package allows you to 
 - `create staking pools and rewards pools`;
@@ -11,12 +11,12 @@ This package allows you to
 
 with the Streamflow Staking protocol.
 
-This protocol is the complex of several programs which ensures flexibility and accountability for stakers and respective incentives for them.
+This protocol is the complex of several programs that ensure flexibility and accountability for stakers and respective incentives for them.
 
-aforementioned programs are: 
+aforementioned programs are:
 - Stake Pools Program
 - Reward Pools Program
-- Fee Management Program (for streamflow usage, non-required and ommited from further docs)
+- Fee Management Program (for streamflow usage, non-required and omitted from further docs)
 
 
 ## API Reference
@@ -106,7 +106,7 @@ const maxDuration = new BN(86400);
 const permissionless = false;
 /*
   [0;256) derive stake pool PDA account address. 
-  If stake pool with the same mint already exists, it is required to pick a vacant nonce 
+  If stake pool with the same mint and creator/authority already exists, it is required to pick a vacant nonce 
 */
 const nonce = 0;
 
@@ -123,6 +123,8 @@ const { metadataId: stakePoolPda } = await client.createStakePool({
 
 #### Create a rewardPool pool
 ```typescript
+import { calculateRewardAmountFromRate } from "@streamflow/staking";
+
 /*
   [0;256) derive reward pool PDA account address.  
   If reward pool with the same mint already exists, it is required to pick a vacant nonce 
@@ -132,6 +134,14 @@ const nonce = 0;
  Amount of rewarding tokens stakers get in return for staking exactly 1 token to the staking pool
 */
 const rewardAmount = new BN(100);
+/*
+  Alternatively you may want to calculate the correct reward amount from desired reward rate taking into account stake pool and reward pools tokes decimals
+*/
+const rewardRate = 0.0025;
+const stakeTokenDecimals = 9;
+const rewardTokenDecimals = 6;
+// For every effectively Staked 1 WHOLE token 0.0025 of Reward Token will be distributed
+const rewardAmount = calculateRewardAmountFromRate(rewardRate, stakeTokenDecimals, rewardTokenDecimals);
 /*
  1 day - Unix time in seconds. Period for rewarding stakers. Period starts counting from the moment of staking
 */
@@ -154,6 +164,42 @@ client.createRewardPool({
 ```
 
 
+#### Reward Amount configuration (in-depth)
+
+`rewardAmount` represents a 10^9 fraction of a raw token distributed for every **effective staked raw token** - it's important to account for both reward and stake token decimals when creating staking pool because of that.
+
+Example with only raw tokens: if `rewardAmount` is configured to be `1_000` and user staked `1_000_000_000` Raw Tokens with a weight of `2` (in the actual protocol this number will be represented as `2_000_000_000`), it means that the effective number of raw tokens staked is `2_000_000_000` and on every reward distribution user will get `2_000_000_000 * 1_000 / 10^9 = 200` Raw Tokens;
+
+Examples with decimals:
+
+RT - Reward Token
+ST - Stake Pool Token
+P - fixed `rewardAmount` precision of 9
+
+User wants to set reward amount of `0.003` for every effective staked whole token, depending on number of decimals RT and ST have configuration may look different:
+
+1. RT with 6 decimals, ST with 6 decimals.
+    - `0.003` of RT is `3_000` raw tokens;
+    - ST has 6 decimals while P is 9, therefore `9 - 6 = 3`;
+    - We need to add 3 decimals to the `rewardAmount` for proper distribution making it `3_000_000`;
+2. RT with 12 decimals, ST with 12 decimals.
+    - `0.003` of RT is `3_000_000_000` raw tokens;
+    - ST has 12 decimals while P is 9, therefore `9 - 12 = -3`;
+    - We need to remove decimals from the raw token to be distributed making `rewardAmount` = `3_000_000`;
+3. RT with 5 decimals, ST with 7 decimals.
+    - `0.003` of RT is `300` raw tokens;
+    - ST has 7 decimals while P is 9, therefore `9 - 7 = 2`;
+    - We need to add 2 decimals making `rewardAmount` = `30_000`;
+4. RT with 9 decimals, ST with 3 decimals.
+    - `0.003` of RT is `3_000_000` raw tokens;
+    - the difference between RT and ST decimals is `9 - 3 = 6`;
+    - ST has 3 decimals while P is 9, therefore `9 - 3 = 6`;
+    - We need to add 6 decimals making `rewardAmount` = `3_000_000_000_000`;
+
+We recommend to use the `calculateRewardAmountFromRate` function exposed by the sdk for the correct reward amount configuration. 
+
+**Also, some configurations where there is big difference between Stake Pool and Reward Pool token decimals may be unsupported, in this case the function will return 0, so be aware.**
+
 #### Deposit/Stake to a stake pool
 ```typescript
 /*
@@ -213,4 +259,4 @@ Streamflow Staking protocol program IDs
 
 ### IDLs
 For further details you can consult with IDLs of protocols available at:
-`@streamflow/staking/dist/esm/solana/descriptor`
+`@streamflow/staking/dist/esm/solana/descriptor`

package/dist/cjs/__tests__/solana/rewards.spec.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@streamflow/common");
+const web3_js_1 = require("@solana/web3.js");
+// eslint-disable-next-line no-restricted-imports
+const bn_js_1 = __importDefault(require("bn.js"));
+const vitest_1 = require("vitest");
+const rewards_js_1 = require("../../solana/lib/rewards.js");
+const constants_js_1 = require("../../solana/constants.js");
+const populateRewardEntry = (effectiveStakedAmount, rewardAmount, rewardPeriod, periods) => {
+    const rewardEntry = new rewards_js_1.RewardEntryAccumulator(new bn_js_1.default(0), new bn_js_1.default(0), new bn_js_1.default(0), web3_js_1.PublicKey.default, web3_js_1.PublicKey.default, new bn_js_1.default(0), new bn_js_1.default(0), new bn_js_1.default(0), []);
+    if (effectiveStakedAmount && rewardAmount && rewardPeriod) {
+        rewardEntry.accountedAmount = rewardEntry.getAccountableAmount(new bn_js_1.default(0), rewardPeriod.muln(periods || 1), effectiveStakedAmount, rewardAmount, rewardPeriod);
+    }
+    return rewardEntry;
+};
+(0, vitest_1.describe)("RewardEntryAccumulator", () => {
+    (0, vitest_1.describe)("getClaimableAmount", () => {
+        const testCases = [
+            [9, 9, 1, 0.0025, new bn_js_1.default(2500000)],
+            [6, 9, 1, 0.0025, new bn_js_1.default(2500000000)],
+            [9, 6, 1, 0.0025, new bn_js_1.default(2500)],
+            [1, 8, 1, 0.0025, new bn_js_1.default(25000000000000)],
+        ];
+        testCases.forEach(([stakeTokenDecimals, rewardTokenDecimals, periods, rewardRate, expectedRewardAmount]) => {
+            (0, vitest_1.test)(`test decimals - ${stakeTokenDecimals}/${rewardTokenDecimals}/${periods}/${rewardRate}`, () => {
+                const stakedAmount = (0, common_1.getBN)(1, stakeTokenDecimals);
+                const effectiveStakedAmount = stakedAmount.mul(constants_js_1.SCALE_PRECISION_FACTOR_BN);
+                const rewardPeriod = new bn_js_1.default(1);
+                const rewardAmount = (0, rewards_js_1.calculateRewardAmountFromRate)(rewardRate, stakeTokenDecimals, rewardTokenDecimals);
+                const rewardEntry = populateRewardEntry(effectiveStakedAmount, rewardAmount, rewardPeriod, periods);
+                const claimableAmount = rewardEntry.getClaimableAmount();
+                (0, vitest_1.expect)(rewardAmount.toString()).toEqual(expectedRewardAmount.toString());
+                (0, vitest_1.expect)(claimableAmount.toString()).toEqual((0, common_1.getBN)(rewardRate, rewardTokenDecimals).muln(periods).toString());
+                (0, vitest_1.expect)((0, rewards_js_1.calculateRewardRateFromAmount)(rewardAmount, stakeTokenDecimals, rewardTokenDecimals)).toEqual(rewardRate);
+            });
+        });
+        (0, vitest_1.test)(`test decimals - negative difference`, () => {
+            let rewardAmount = (0, rewards_js_1.calculateRewardAmountFromRate)(0.0025, 18, 1);
+            (0, vitest_1.expect)(rewardAmount.toString()).toEqual(new bn_js_1.default(0).toString());
+            rewardAmount = (0, rewards_js_1.calculateRewardAmountFromRate)(0.0025, 12, 4);
+            (0, vitest_1.expect)(rewardAmount.toString()).toEqual(new bn_js_1.default(0).toString());
+        });
+        (0, vitest_1.test)(`test decimals - precision loss`, () => {
+            const stakeTokenDecimals = 12;
+            const rewardTokenDecimals = 6;
+            const stakedAmount = (0, common_1.getBN)(1, stakeTokenDecimals);
+            const effectiveStakedAmount = stakedAmount.mul(constants_js_1.SCALE_PRECISION_FACTOR_BN);
+            const rewardPeriod = new bn_js_1.default(1);
+            const rewardAmount = (0, rewards_js_1.calculateRewardAmountFromRate)(0.0025, stakeTokenDecimals, rewardTokenDecimals);
+            const rewardEntry = populateRewardEntry(effectiveStakedAmount, rewardAmount, rewardPeriod);
+            const claimableAmount = rewardEntry.getClaimableAmount();
+            (0, vitest_1.expect)(rewardAmount.toString()).toEqual(new bn_js_1.default(2).toString());
+            (0, vitest_1.expect)(claimableAmount.toString()).toEqual((0, common_1.getBN)(0.002, rewardTokenDecimals).toString());
+            (0, vitest_1.expect)((0, rewards_js_1.calculateRewardRateFromAmount)(rewardAmount, stakeTokenDecimals, rewardTokenDecimals)).toEqual(0.002);
+        });
+    });
+});

package/dist/cjs/index.js

@@ -25,15 +25,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.constants = exports.SolanaStakingClient = void 0;
 var client_js_1 = require("./solana/client.js");
-Object.defineProperty(exports, "SolanaStakingClient", { enumerable: true, get: function () { return __importDefault(client_js_1).default; } });
-__exportStar(require("./solana/utils.js"), exports);
+Object.defineProperty(exports, "SolanaStakingClient", { enumerable: true, get: function () { return client_js_1.SolanaStakingClient; } });
 __exportStar(require("./solana/types.js"), exports);
 __exportStar(require("./solana/lib/derive-accounts.js"), exports);
 __exportStar(require("./solana/lib/rewards.js"), exports);
+__exportStar(require("./solana/lib/fee-amounts.js"), exports);
+__exportStar(require("./solana/lib/stake-weight.js"), exports);
 exports.constants = __importStar(require("./solana/constants.js"));

package/dist/cjs/solana/client.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SolanaStakingClient = void 0;
 const anchor_1 = require("@coral-xyz/anchor");
 const spl_token_1 = require("@solana/spl-token");
 const web3_js_1 = require("@solana/web3.js");
@@ -44,7 +45,7 @@ class SolanaStakingClient {
     }
     getCurrentProgramId(programKey) {
         const program = this.programs[programKey];
-        invariant(program, `Program ${programKey} is not found`);
+        (0, common_1.invariant)(program, `Program ${programKey} is not found`);
         return program.programId;
     }
     getCommitment() {
@@ -56,7 +57,7 @@ class SolanaStakingClient {
     }
     async searchStakePools(criteria = {}) {
         const { stakePoolProgram } = this.programs;
-        return stakePoolProgram.account.stakePool.all(getFilters(criteria, constants_js_1.STAKE_POOL_BYTE_OFFSETS));
+        return stakePoolProgram.account.stakePool.all((0, solana_1.getFilters)(criteria, constants_js_1.STAKE_POOL_BYTE_OFFSETS));
     }
     async getStakeEntry(id) {
         const { stakePoolProgram } = this.programs;
@@ -64,15 +65,27 @@ class SolanaStakingClient {
     }
     async searchStakeEntries(criteria = {}) {
         const { stakePoolProgram } = this.programs;
-        return stakePoolProgram.account.stakeEntry.all(getFilters(criteria, constants_js_1.STAKE_ENTRY_BYTE_OFFSETS));
+        return stakePoolProgram.account.stakeEntry.all((0, solana_1.getFilters)(criteria, constants_js_1.STAKE_ENTRY_BYTE_OFFSETS));
     }
     async searchRewardPools(criteria = {}) {
         const { rewardPoolProgram } = this.programs;
-        return rewardPoolProgram.account.rewardPool.all(getFilters(criteria, constants_js_1.REWARD_POOL_BYTE_OFFSETS));
+        return rewardPoolProgram.account.rewardPool.all((0, solana_1.getFilters)(criteria, constants_js_1.REWARD_POOL_BYTE_OFFSETS));
     }
     async searchRewardEntries(criteria) {
         const { rewardPoolProgram } = this.programs;
-        return rewardPoolProgram.account.rewardEntry.all(getFilters(criteria, constants_js_1.REWARD_ENTRY_BYTE_OFFSETS));
+        return rewardPoolProgram.account.rewardEntry.all((0, solana_1.getFilters)(criteria, constants_js_1.REWARD_ENTRY_BYTE_OFFSETS));
+    }
+    async getFee(target) {
+        const perTargetFee = await this.getFeeValueIfExists(target);
+        if (perTargetFee) {
+            return perTargetFee;
+        }
+        return this.getDefaultFeeValue();
+    }
+    getDefaultFeeValue() {
+        const { feeManagerProgram } = this.programs;
+        const feeValueKey = (0, derive_accounts_js_1.deriveConfigPDA)(feeManagerProgram.programId);
+        return feeManagerProgram.account.config.fetch(feeValueKey);
     }
     getFeeValueIfExists(target) {
         const { feeManagerProgram } = this.programs;
@@ -91,7 +104,7 @@ class SolanaStakingClient {
     async prepareCreateStakePoolInstructions({ maxWeight, maxDuration, minDuration, mint, permissionless = false, nonce, tokenProgramId = spl_token_1.TOKEN_PROGRAM_ID, }, extParams) {
         const { stakePoolProgram } = this.programs;
         const creator = extParams.invoker.publicKey;
-        invariant(creator, "Undefined invoker publicKey");
+        (0, common_1.invariant)(creator, "Undefined invoker publicKey");
         const createInstruction = await stakePoolProgram.methods
             .createPool(nonce, maxWeight, minDuration, maxDuration, permissionless)
             .accounts({
@@ -100,7 +113,7 @@ class SolanaStakingClient {
             tokenProgram: tokenProgramId,
         })
             .instruction();
-        const stakePoolPDA = (0, derive_accounts_js_1.deriveStakePoolPDA)(stakePoolProgram.programId, pk(mint), creator, nonce);
+        const stakePoolPDA = (0, derive_accounts_js_1.deriveStakePoolPDA)(stakePoolProgram.programId, (0, solana_1.pk)(mint), creator, nonce);
         return { ixs: [createInstruction], publicKey: stakePoolPDA };
     }
     async stake(data, extParams) {
@@ -114,10 +127,10 @@ class SolanaStakingClient {
     async prepareStakeInstructions({ nonce, amount, duration, stakePool, stakePoolMint, tokenProgramId = spl_token_1.TOKEN_PROGRAM_ID }, extParams) {
         const { stakePoolProgram } = this.programs;
         const staker = extParams.invoker.publicKey;
-        invariant(staker, "Undefined invoker publicKey");
-        const mint = (0, derive_accounts_js_1.deriveStakeMintPDA)(stakePoolProgram.programId, pk(stakePool));
-        const stakeMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)(mint, staker, false, pk(tokenProgramId));
-        const poolMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)(pk(stakePoolMint), staker, false, pk(tokenProgramId));
+        (0, common_1.invariant)(staker, "Undefined invoker publicKey");
+        const mint = (0, derive_accounts_js_1.deriveStakeMintPDA)(stakePoolProgram.programId, (0, solana_1.pk)(stakePool));
+        const stakeMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)(mint, staker, false, (0, solana_1.pk)(tokenProgramId));
+        const poolMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)((0, solana_1.pk)(stakePoolMint), staker, false, (0, solana_1.pk)(tokenProgramId));
         const instruction = await stakePoolProgram.methods
             .stake(nonce, amount, duration)
             .accounts({
@@ -142,11 +155,11 @@ class SolanaStakingClient {
     async prepareUnstakeInstructions({ stakePool, stakePoolMint, nonce, tokenProgramId = spl_token_1.TOKEN_PROGRAM_ID }, extParams) {
         const { stakePoolProgram } = this.programs;
         const staker = extParams.invoker.publicKey;
-        invariant(staker, "Undefined invoker publicKey");
-        const stakeMintKey = (0, derive_accounts_js_1.deriveStakeMintPDA)(stakePoolProgram.programId, pk(stakePool));
-        const stakeEntryKey = (0, derive_accounts_js_1.deriveStakeEntryPDA)(stakePoolProgram.programId, pk(stakePool), staker, nonce);
-        const poolMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)(pk(stakePoolMint), staker, false, pk(tokenProgramId));
-        const stakeMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)(stakeMintKey, staker, false, pk(tokenProgramId));
+        (0, common_1.invariant)(staker, "Undefined invoker publicKey");
+        const stakeMintKey = (0, derive_accounts_js_1.deriveStakeMintPDA)(stakePoolProgram.programId, (0, solana_1.pk)(stakePool));
+        const stakeEntryKey = (0, derive_accounts_js_1.deriveStakeEntryPDA)(stakePoolProgram.programId, (0, solana_1.pk)(stakePool), staker, nonce);
+        const poolMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)((0, solana_1.pk)(stakePoolMint), staker, false, (0, solana_1.pk)(tokenProgramId));
+        const stakeMintAccountKey = (0, spl_token_1.getAssociatedTokenAddressSync)(stakeMintKey, staker, false, (0, solana_1.pk)(tokenProgramId));
         const instruction = await stakePoolProgram.methods
             .unstake()
             .accounts({
@@ -171,7 +184,7 @@ class SolanaStakingClient {
     async prepareCreateRewardPoolInstructions({ nonce, rewardAmount, rewardPeriod, rewardMint, permissionless = false, stakePool, tokenProgramId = spl_token_1.TOKEN_PROGRAM_ID, }, extParams) {
         const { rewardPoolProgram } = this.programs;
         const creator = extParams.invoker.publicKey;
-        invariant(creator, "Undefined invoker publicKey");
+        (0, common_1.invariant)(creator, "Undefined invoker publicKey");
         const instruction = await rewardPoolProgram.methods
             .createPool(nonce, rewardAmount, rewardPeriod, permissionless)
             .accounts({
@@ -181,7 +194,7 @@ class SolanaStakingClient {
             tokenProgram: tokenProgramId,
         })
             .instruction();
-        const rewardPoolKey = (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, pk(stakePool), pk(rewardMint), nonce);
+        const rewardPoolKey = (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, (0, solana_1.pk)(stakePool), (0, solana_1.pk)(rewardMint), nonce);
         return { publicKey: rewardPoolKey, ixs: [instruction] };
     }
     async claimRewards(data, extParams) {
@@ -195,15 +208,15 @@ class SolanaStakingClient {
     async prepareClaimRewardsInstructions({ rewardPoolNonce, depositNonce, stakePool, tokenProgramId = spl_token_1.TOKEN_PROGRAM_ID, rewardMint }, extParams) {
         const { stakePoolProgram, rewardPoolProgram } = this.programs;
         const staker = extParams.invoker.publicKey;
-        invariant(staker, "Undefined invoker publicKey");
+        (0, common_1.invariant)(staker, "Undefined invoker publicKey");
         const instruction = await rewardPoolProgram.methods
             .claimRewards()
             .accounts({
-            stakeEntry: (0, derive_accounts_js_1.deriveStakeEntryPDA)(stakePoolProgram.programId, pk(stakePool), staker, depositNonce),
-            rewardPool: (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, pk(stakePool), pk(rewardMint), rewardPoolNonce),
+            stakeEntry: (0, derive_accounts_js_1.deriveStakeEntryPDA)(stakePoolProgram.programId, (0, solana_1.pk)(stakePool), staker, depositNonce),
+            rewardPool: (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, (0, solana_1.pk)(stakePool), (0, solana_1.pk)(rewardMint), rewardPoolNonce),
             claimant: staker,
             tokenProgram: tokenProgramId,
-            to: (0, spl_token_1.getAssociatedTokenAddressSync)(pk(rewardMint), staker, false, pk(tokenProgramId)),
+            to: (0, spl_token_1.getAssociatedTokenAddressSync)((0, solana_1.pk)(rewardMint), staker, false, (0, solana_1.pk)(tokenProgramId)),
         })
             .instruction();
         return { ixs: [instruction] };
@@ -219,14 +232,14 @@ class SolanaStakingClient {
     async prepareFundPoolInstructions({ amount, tokenProgramId = spl_token_1.TOKEN_PROGRAM_ID, rewardMint, stakePool, feeValue, nonce }, extParams) {
         const { rewardPoolProgram } = this.programs;
         const staker = extParams.invoker.publicKey;
-        invariant(staker, "Undefined invoker publicKey");
+        (0, common_1.invariant)(staker, "Undefined invoker publicKey");
         const existingFee = await this.getFeeValueIfExists(staker);
-        const rewardMintPk = pk(rewardMint);
-        const tokenProgramPk = pk(tokenProgramId);
+        const rewardMintPk = (0, solana_1.pk)(rewardMint);
+        const tokenProgramPk = (0, solana_1.pk)(tokenProgramId);
         const treasuryATA = !existingFee || existingFee.streamflowFee.gtn(0)
             ? await (0, solana_1.checkOrCreateAtaBatch)(this.connection, [constants_js_1.STREAMFLOW_TREASURY_PUBLIC_KEY], rewardMintPk, extParams.invoker, tokenProgramPk)
             : null;
-        const rewardPoolPda = (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, pk(stakePool), rewardMintPk, nonce);
+        const rewardPoolPda = (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, (0, solana_1.pk)(stakePool), rewardMintPk, nonce);
         const instruction = await rewardPoolProgram.methods
             .fundPool(amount)
             .accountsPartial({
@@ -252,18 +265,51 @@ class SolanaStakingClient {
     async prepareCreateRewardEntryInstructions({ stakePoolMint, stakePool, rewardPoolNonce, depositNonce }, extParams) {
         const { stakePoolProgram, rewardPoolProgram } = this.programs;
         const staker = extParams.invoker.publicKey;
-        invariant(staker, "Undefined invoker publicKey");
+        (0, common_1.invariant)(staker, "Undefined invoker publicKey");
         const instruction = await rewardPoolProgram.methods
             .createEntry()
             .accounts({
             payer: staker,
             authority: staker,
-            stakeEntry: (0, derive_accounts_js_1.deriveStakeEntryPDA)(stakePoolProgram.programId, pk(stakePool), staker, depositNonce),
-            rewardPool: (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, pk(stakePool), pk(stakePoolMint), rewardPoolNonce),
+            stakeEntry: (0, derive_accounts_js_1.deriveStakeEntryPDA)(stakePoolProgram.programId, (0, solana_1.pk)(stakePool), staker, depositNonce),
+            rewardPool: (0, derive_accounts_js_1.deriveRewardPoolPDA)(rewardPoolProgram.programId, (0, solana_1.pk)(stakePool), (0, solana_1.pk)(stakePoolMint), rewardPoolNonce),
+        })
+            .instruction();
+        return { ixs: [instruction] };
+    }
+    async updateRewardPool(data, extParams) {
+        const { ixs } = await this.prepareUpdateRewardPoolInstructions(data, extParams);
+        const { signature } = await this.execute(ixs, extParams);
+        return {
+            ixs,
+            txId: signature,
+        };
+    }
+    async prepareUpdateRewardPoolInstructions({ rewardPool, rewardAmount, rewardPeriod }, extParams) {
+        const { rewardPoolProgram } = this.programs;
+        const invoker = extParams.invoker.publicKey;
+        (0, common_1.invariant)(invoker, "Undefined invoker publicKey");
+        const instruction = await rewardPoolProgram.methods
+            .updatePool(rewardAmount, rewardPeriod)
+            .accountsPartial({
+            authority: invoker,
+            rewardPool,
         })
             .instruction();
         return { ixs: [instruction] };
     }
+    decode(programKey, accountName, accInfo) {
+        const decodingProgram = this.programs[programKey];
+        (0, common_1.invariant)(decodingProgram, `Decoding program with key ${programKey} is not available`);
+        return decodingProgram.coder.accounts.decode(accountName.toString(), accInfo);
+    }
+    getDiscriminator(programKey, accountName) {
+        const decodingProgram = this.programs[programKey];
+        (0, common_1.invariant)(decodingProgram, `Decoding program with key ${programKey} is not available`);
+        const accountEntity = decodingProgram.idl.accounts.find((acc) => acc.name === accountName);
+        (0, common_1.invariant)(accountEntity, `Decoding program with key ${programKey} doesn't specify account with name ${accountName.toString()}`);
+        return accountEntity.discriminator;
+    }
     async execute(ixs, extParams) {
         const { tx, hash, context } = await (0, solana_1.prepareTransaction)(this.connection, ixs, extParams.invoker.publicKey);
         try {
@@ -285,31 +331,4 @@ class SolanaStakingClient {
         }
     }
 }
-exports.default = SolanaStakingClient;
-function pk(address) {
-    return typeof address === "string" ? new web3_js_1.PublicKey(address) : address;
-}
-const prefix = "Assertion failed";
-function invariant(condition, message) {
-    if (condition) {
-        return;
-    }
-    const provided = typeof message === "function" ? message() : message;
-    const value = provided ? `${prefix}: ${provided}` : prefix;
-    throw new Error(value);
-}
-function getFilters(criteria, byteOffsets) {
-    return Object.entries(criteria).reduce((acc, [key, value]) => {
-        const criteriaKey = key;
-        const effectiveByteOffset = byteOffsets[criteriaKey];
-        if (criteria[criteriaKey] && effectiveByteOffset) {
-            acc.push({
-                memcmp: {
-                    offset: effectiveByteOffset,
-                    bytes: value.toString(),
-                },
-            });
-        }
-        return acc;
-    }, []);
-}
+exports.SolanaStakingClient = SolanaStakingClient;

package/dist/cjs/solana/constants.js

@@ -1,15 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REWARD_POOL_PROGRAM_ID = exports.STAKE_POOL_PROGRAM_ID = exports.REWARD_ENTRY_BYTE_OFFSETS = exports.REWARD_ENTRY_STAKE_ENTRY_OFFSET = exports.REWARD_ENTRY_REWARD_POOL_OFFSET = exports.REWARD_POOL_BYTE_OFFSETS = exports.REWARD_POOL_MINT_OFFSET = exports.REWARD_POOL_STAKE_POOL_OFFSET = exports.STAKE_POOL_BYTE_OFFSETS = exports.STAKE_POOL_CREATOR_OFFSET = exports.STAKE_POOL_MINT_OFFSET = exports.STAKE_ENTRY_BYTE_OFFSETS = exports.STAKE_ENTRY_OWNER_OFFSET = exports.STAKE_ENTRY_STAKE_POOL_OFFSET = exports.ANCHOR_DISCRIMINATOR_OFFSET = exports.STREAMFLOW_TREASURY_PUBLIC_KEY = exports.FEE_VALUE_PREFIX = exports.CONFIG_PREFIX = exports.REWARD_ENTRY_PREFIX = exports.REWARD_VAULT_PREFIX = exports.REWARD_POOL_PREFIX = exports.STAKE_VAULT_PREFIX = exports.STAKE_MINT_PREFIX = exports.STAKE_POOL_PREFIX = exports.STAKE_ENTRY_PREFIX = exports.STAKE_ENTRY_DISCRIMINATOR = exports.U64_MAX = exports.SCALE_PRECISION_FACTOR_BN = exports.SCALE_PRECISION_FACTOR = exports.DEFAULT_FEE_BN = exports.DEFAULT_FEE = exports.FEE_PRECISION_FACTOR_BN = exports.FEE_PRECISION_FACTOR = void 0;
+exports.FEE_PROGRAM_ID = exports.REWARD_POOL_PROGRAM_ID = exports.STAKE_POOL_PROGRAM_ID = exports.REWARD_ENTRY_BYTE_OFFSETS = exports.REWARD_ENTRY_STAKE_ENTRY_OFFSET = exports.REWARD_ENTRY_REWARD_POOL_OFFSET = exports.REWARD_POOL_BYTE_OFFSETS = exports.REWARD_POOL_MINT_OFFSET = exports.REWARD_POOL_STAKE_POOL_OFFSET = exports.STAKE_POOL_BYTE_OFFSETS = exports.STAKE_POOL_CREATOR_OFFSET = exports.STAKE_POOL_MINT_OFFSET = exports.STAKE_ENTRY_BYTE_OFFSETS = exports.STAKE_ENTRY_OWNER_OFFSET = exports.STAKE_ENTRY_STAKE_POOL_OFFSET = exports.ANCHOR_DISCRIMINATOR_OFFSET = exports.STREAMFLOW_TREASURY_PUBLIC_KEY = exports.FEE_VALUE_PREFIX = exports.CONFIG_PREFIX = exports.REWARD_ENTRY_PREFIX = exports.REWARD_VAULT_PREFIX = exports.REWARD_POOL_PREFIX = exports.STAKE_VAULT_PREFIX = exports.STAKE_MINT_PREFIX = exports.STAKE_POOL_PREFIX = exports.STAKE_ENTRY_PREFIX = exports.STAKE_ENTRY_DISCRIMINATOR = exports.U64_MAX = exports.REWARD_AMOUNT_PRECISION_FACTOR_BN = exports.REWARD_AMOUNT_PRECISION_FACTOR = exports.REWARD_AMOUNT_DECIMALS = exports.SCALE_PRECISION_FACTOR_BN = exports.SCALE_PRECISION_FACTOR = exports.DEFAULT_FEE_BN = exports.DEFAULT_FEE = exports.FEE_PRECISION_FACTOR_BN = exports.FEE_PRECISION_FACTOR = void 0;
 const anchor_1 = require("@coral-xyz/anchor");
 const common_1 = require("@streamflow/common");
 const web3_js_1 = require("@solana/web3.js");
 exports.FEE_PRECISION_FACTOR = 10000;
 exports.FEE_PRECISION_FACTOR_BN = new anchor_1.BN(exports.FEE_PRECISION_FACTOR);
-exports.DEFAULT_FEE = 99;
+exports.DEFAULT_FEE = 19;
 exports.DEFAULT_FEE_BN = new anchor_1.BN(exports.DEFAULT_FEE);
 exports.SCALE_PRECISION_FACTOR = 1000000000;
 exports.SCALE_PRECISION_FACTOR_BN = new anchor_1.BN(exports.SCALE_PRECISION_FACTOR);
+exports.REWARD_AMOUNT_DECIMALS = 9;
+exports.REWARD_AMOUNT_PRECISION_FACTOR = 1000000000;
+exports.REWARD_AMOUNT_PRECISION_FACTOR_BN = new anchor_1.BN(exports.REWARD_AMOUNT_PRECISION_FACTOR);
 exports.U64_MAX = 18446744073709551615n;
 exports.STAKE_ENTRY_DISCRIMINATOR = [187, 127, 9, 35, 155, 68, 86, 40];
 exports.STAKE_ENTRY_PREFIX = Buffer.from("stake-entry", "utf-8");
@@ -29,7 +32,7 @@ exports.STAKE_ENTRY_BYTE_OFFSETS = {
     payer: exports.STAKE_ENTRY_OWNER_OFFSET,
     stakePool: exports.STAKE_ENTRY_STAKE_POOL_OFFSET,
 };
-exports.STAKE_POOL_MINT_OFFSET = exports.ANCHOR_DISCRIMINATOR_OFFSET + 8;
+exports.STAKE_POOL_MINT_OFFSET = exports.ANCHOR_DISCRIMINATOR_OFFSET + 2;
 exports.STAKE_POOL_CREATOR_OFFSET = exports.STAKE_POOL_MINT_OFFSET + 32;
 exports.STAKE_POOL_BYTE_OFFSETS = {
     mint: exports.STAKE_POOL_MINT_OFFSET,
@@ -59,3 +62,9 @@ exports.REWARD_POOL_PROGRAM_ID = {
     [common_1.ICluster.Testnet]: "RWRDdfRbi3339VgKxTAXg4cjyniF7cbhNbMxZWiSKmj",
     [common_1.ICluster.Local]: "RWRDdfRbi3339VgKxTAXg4cjyniF7cbhNbMxZWiSKmj",
 };
+exports.FEE_PROGRAM_ID = {
+    [common_1.ICluster.Mainnet]: "FEELzfBhsWXTNJX53zZcDVfRNoFYZQ6cZA3jLiGVL16V",
+    [common_1.ICluster.Devnet]: "FEELzfBhsWXTNJX53zZcDVfRNoFYZQ6cZA3jLiGVL16V",
+    [common_1.ICluster.Testnet]: "FEELzfBhsWXTNJX53zZcDVfRNoFYZQ6cZA3jLiGVL16V",
+    [common_1.ICluster.Local]: "FEELzfBhsWXTNJX53zZcDVfRNoFYZQ6cZA3jLiGVL16V",
+};

package/dist/cjs/solana/descriptor/idl/reward_pool.json

@@ -338,8 +338,8 @@
                         "program": {
                             "kind": "const",
                             "value": [
-                                140, 151, 37, 143, 78, 36, 137, 241, 187, 61, 16, 41, 20, 142, 13, 131, 11, 90, 19, 153, 218,
-                                255, 16, 132, 4, 142, 123, 216, 219, 233, 248, 89
+                                140, 151, 37, 143, 78, 36, 137, 241, 187, 61, 16, 41, 20, 142, 13, 131, 11, 90, 19, 153, 218, 255, 16,
+                                132, 4, 142, 123, 216, 219, 233, 248, 89
                             ]
                         }
                     }
@@ -778,9 +778,7 @@
                     },
                     {
                         "name": "effective_amount",
-                        "docs": [
-                            "Effective Amount staked, does not equal to deposited amount, accounts for Stake Weight"
-                        ],
+                        "docs": ["Effective Amount staked, does not equal to deposited amount, accounts for Stake Weight"],
                         "type": "u128"
                     },
                     {