@streamflow/staking 7.0.0-alpha.9 → 7.0.1

package/dist/esm/solana/lib/rewards.js

@@ -1,10 +1,9 @@
 import { PublicKey } from "@solana/web3.js";
 // eslint-disable-next-line no-restricted-imports
 import BN from "bn.js";
-import { SCALE_PRECISION_FACTOR_BN } from "../constants.js";
-export const REWARD_AMOUNT_PRECISION_FACTOR = new BN("1000000000");
+import { getBN, getNumberFromBN } from "@streamflow/common";
+import { REWARD_AMOUNT_DECIMALS, REWARD_AMOUNT_PRECISION_FACTOR_BN, SCALE_PRECISION_FACTOR_BN } from "../constants.js";
 export class RewardEntryAccumulator {
-    delegate;
     lastAccountedTs;
     claimedAmount;
     accountedAmount;
@@ -14,17 +13,19 @@ export class RewardEntryAccumulator {
     lastRewardAmount;
     lastRewardPeriod;
     buffer;
-    constructor(delegate) {
-        this.delegate = delegate;
-        this.lastAccountedTs = delegate.lastAccountedTs;
-        this.claimedAmount = delegate.claimedAmount;
-        this.accountedAmount = delegate.accountedAmount;
-        this.rewardPool = delegate.rewardPool;
-        this.stakeEntry = delegate.stakeEntry;
-        this.createdTs = delegate.createdTs;
-        this.buffer = delegate.buffer;
-        this.lastRewardAmount = delegate.lastRewardAmount;
-        this.lastRewardPeriod = delegate.lastRewardPeriod;
+    constructor(lastAccountedTs, claimedAmount, accountedAmount, rewardPool, stakeEntry, createdTs, lastRewardAmount, lastRewardPeriod, buffer) {
+        this.lastAccountedTs = lastAccountedTs;
+        this.claimedAmount = claimedAmount;
+        this.accountedAmount = accountedAmount;
+        this.rewardPool = rewardPool;
+        this.stakeEntry = stakeEntry;
+        this.createdTs = createdTs;
+        this.buffer = buffer;
+        this.lastRewardAmount = lastRewardAmount;
+        this.lastRewardPeriod = lastRewardPeriod;
+    }
+    static fromEntry(entry) {
+        return new this(entry.lastAccountedTs, entry.claimedAmount, entry.accountedAmount, entry.rewardPool, entry.stakeEntry, entry.createdTs, entry.lastRewardAmount, entry.lastRewardPeriod, entry.buffer);
     }
     // Calculate accountable amount by calculating how many seconds have passed since last claim/stake time
     getAccountableAmount(stakedTs, accountableTs, effectiveStakedAmount, rewardAmount, rewardPeriod) {
@@ -35,15 +36,13 @@ export class RewardEntryAccumulator {
         }
         const periodsPassed = secondsPassed.div(rewardPeriod);
         const claimablePerEffectiveStake = periodsPassed.mul(rewardAmount);
-        const accountableAmount = claimablePerEffectiveStake.mul(effectiveStakedAmount).div(SCALE_PRECISION_FACTOR_BN);
-        return accountableAmount;
+        return claimablePerEffectiveStake.mul(effectiveStakedAmount).div(SCALE_PRECISION_FACTOR_BN);
     }
     // Calculates claimable amount from accountable amount.
     getClaimableAmount() {
-        const claimedAmount = this.claimedAmount.mul(REWARD_AMOUNT_PRECISION_FACTOR);
+        const claimedAmount = this.claimedAmount.mul(REWARD_AMOUNT_PRECISION_FACTOR_BN);
         const nonClaimedAmount = this.accountedAmount.sub(claimedAmount);
-        const claimableAmount = nonClaimedAmount.div(REWARD_AMOUNT_PRECISION_FACTOR);
-        return claimableAmount;
+        return nonClaimedAmount.div(REWARD_AMOUNT_PRECISION_FACTOR_BN);
     }
     // Get the time of the last unlock
     getLastAccountedTs(stakedTs, claimableTs, rewardPeriod) {
@@ -51,8 +50,7 @@ export class RewardEntryAccumulator {
         const totalSecondsPassed = claimableTs.sub(lastAccountedTs);
         const periodsPassed = totalSecondsPassed.div(rewardPeriod);
         const periodsToSeconds = periodsPassed.mul(rewardPeriod);
-        const currClaimTs = lastAccountedTs.add(periodsToSeconds);
-        return currClaimTs;
+        return lastAccountedTs.add(periodsToSeconds);
     }
     // Adds accounted amount
     addAccountedAmount(accountedAmount) {
@@ -80,7 +78,7 @@ export const calcRewards = (rewardEntryAccount, stakeEntryAccount, rewardPoolAcc
     const rewardEntry = rewardEntryAccount?.account ?? createDefaultRewardEntry(stakeEntryAccount, rewardPoolAccount);
     const stakeEntry = stakeEntryAccount.account;
     const rewardPool = rewardPoolAccount.account;
-    const rewardEntryAccumulator = new RewardEntryAccumulator(rewardEntry);
+    const rewardEntryAccumulator = RewardEntryAccumulator.fromEntry(rewardEntry);
     if (rewardEntryAccumulator.createdTs.lt(stakeEntry.createdTs)) {
         throw new Error("InvalidRewardEntry");
     }
@@ -134,3 +132,21 @@ export const calcRewards = (rewardEntryAccount, stakeEntryAccount, rewardPoolAcc
     rewardEntryAccumulator.addAccountedAmount(accountableAmount);
     return rewardEntryAccumulator.getClaimableAmount();
 };
+export const calculateRewardRateFromAmount = (rewardAmount, stakeTokenDecimals, rewardTokenDecimals) => {
+    const decimals = rewardTokenDecimals + (REWARD_AMOUNT_DECIMALS - stakeTokenDecimals);
+    return getNumberFromBN(rewardAmount, decimals);
+};
+export const calculateRewardAmountFromValue = (rewardTokenValue, stakeTokenDecimals) => {
+    const decimalsDiff = REWARD_AMOUNT_DECIMALS - stakeTokenDecimals;
+    if (decimalsDiff === 0) {
+        return rewardTokenValue;
+    }
+    const diffFactor = new BN(10).pow(new BN(Math.abs(decimalsDiff)));
+    if (decimalsDiff > 0) {
+        return rewardTokenValue.mul(diffFactor);
+    }
+    return rewardTokenValue.div(diffFactor);
+};
+export const calculateRewardAmountFromRate = (rewardRate, stakeTokenDecimals, rewardTokenDecimals) => {
+    return calculateRewardAmountFromValue(getBN(rewardRate, rewardTokenDecimals), stakeTokenDecimals);
+};

package/dist/esm/solana/lib/stake-weight.d.ts

@@ -0,0 +1,2 @@
+import BN from "bn.js";
+export declare const calculateStakeWeight: (minDuration: BN, maxDuration: BN, maxWeight: BN, duration: BN) => BN;

package/dist/esm/solana/lib/stake-weight.js

@@ -0,0 +1,12 @@
+import BN from "bn.js";
+import { SCALE_PRECISION_FACTOR_BN } from "../constants.js";
+export const calculateStakeWeight = (minDuration, maxDuration, maxWeight, duration) => {
+    const durationSpan = maxDuration.sub(minDuration);
+    if (durationSpan.eq(new BN(0))) {
+        return SCALE_PRECISION_FACTOR_BN;
+    }
+    const durationExceedingMin = duration.sub(minDuration);
+    const normalizedWeight = durationExceedingMin.mul(SCALE_PRECISION_FACTOR_BN).div(durationSpan);
+    const weightDiff = maxWeight.sub(SCALE_PRECISION_FACTOR_BN);
+    return BN.max(SCALE_PRECISION_FACTOR_BN.add(normalizedWeight.mul(weightDiff).div(SCALE_PRECISION_FACTOR_BN)), SCALE_PRECISION_FACTOR_BN);
+};

package/dist/esm/solana/types.d.ts

@@ -11,12 +11,10 @@ export type StakeEntry = IdlTypes<StakePoolIDL>["stakeEntry"];
 export type RewardEntry = IdlTypes<RewardPoolIDL>["rewardEntry"];
 export type RewardPool = IdlTypes<RewardPoolIDL>["rewardPool"];
 export type FeeValue = IdlTypes<FeeManagerIDL>["feeValue"];
+export type DefaultFeeValueConfig = IdlTypes<FeeManagerIDL>["config"];
 export interface IInteractSolanaExt extends ITransactionSolanaExt {
     invoker: SignerWalletAdapter | Keypair;
 }
-export interface ICreateSolanaExt extends IInteractSolanaExt {
-    isNative?: boolean;
-}
 export interface BaseStakePoolArgs {
     stakePool: Address;
     stakePoolMint: Address;
@@ -52,6 +50,11 @@ export interface CreateRewardPoolArgs extends BaseStakePoolArgs, TokenProgram {
     rewardPeriod: BN;
     permissionless: boolean;
 }
+export interface UpdateRewardPoolArgs {
+    rewardAmount: BN | null;
+    rewardPeriod: BN | null;
+    rewardPool: Address;
+}
 export interface ClaimRewardPoolArgs extends BaseStakePoolArgs, TokenProgram {
     depositNonce: number;
     rewardMint: Address;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/staking",
-  "version": "7.0.0-alpha.9",
+  "version": "7.0.1",
   "description": "JavaScript SDK to interact with Streamflow Staking protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",
@@ -24,22 +24,23 @@
     "build": "rm -rf dist; pnpm run build:cjs && pnpm run build:esm",
     "pack": "pnpm build && pnpm pack",
     "lint": "eslint --fix .",
+    "test": "vitest",
     "prepublishOnly": "npm run lint && npm run build"
   },
-  "gitHead": "5b3f47ca167e818df9b0d9c0f0818d9a67436c55",
+  "gitHead": "1d52555f15b31f9267ab841e3238a596ca6b7e6f",
   "devDependencies": {
-    "@streamflow/eslint-config": "7.0.0-alpha.9",
+    "@streamflow/eslint-config": "7.0.1",
     "@types/bn.js": "5.1.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.6.3"
   },
   "dependencies": {
     "@coral-xyz/anchor": "^0.30.0",
     "@coral-xyz/borsh": "^0.29.0",
     "@solana/buffer-layout": "4.0.1",
-    "@solana/spl-token": "0.3.6",
+    "@solana/spl-token": "0.4.9",
     "@solana/wallet-adapter-base": "0.9.19",
-    "@solana/web3.js": "1.70.1",
-    "@streamflow/common": "7.0.0-alpha.9",
+    "@solana/web3.js": "1.95.4",
+    "@streamflow/common": "7.0.1",
     "bn.js": "5.2.1",
     "borsh": "^2.0.0",
     "bs58": "5.0.0",