@wireio/stake 2.3.0 → 2.3.1

package/lib/stake.d.ts

@@ -41,6 +41,8 @@ interface IStakingClient {
     buy(amount: bigint): Promise<string>;
     /** Claim a withdrawal receipt (burn NFT + receive ETH/SOL) via claim_withdraw. */
     claimWithdraw(tokenId: bigint): Promise<string>;
+    /** Solana only: claim accrued liqSOL distribution rewards. */
+    claimLiqsolRewards?(): Promise<string>;
     /** Enumerate withdrawal receipt NFTs held by the user (queued/ready/claimed). */
     getPendingWithdraws(): Promise<WithdrawReceipt$1[]>;
     /** Fetch the complete user portfolio */
@@ -91,6 +93,11 @@ interface Portfolio {
     native: BalanceView;
     /** Liquid staking token balance (LiqETH, LiqSOL, etc.). */
     liq: BalanceView;
+    /**
+     * Solana-only liqSOL rewards currently claimable from the distribution bucket.
+     * Not populated on Ethereum.
+     */
+    claimable?: BalanceView;
     /**
      * Outpost-staked balance:
      *  - On Solana: liqSOL staked via `synd` (stakedLiqsol, in lamports).
@@ -445,6 +452,7 @@ declare class EthereumStakingClient implements IStakingClient {
         MockAggregator: ethers.Contract;
     };
     get network(): _wireio_core.ExternalNetwork;
+    get address(): Promise<string> | undefined;
     constructor(config: StakerConfig);
     /**
      * Deposit native ETH into the liqETH protocol via DepositManager.
@@ -15494,6 +15502,7 @@ declare class DistributionClient {
     private program;
     constructor(provider: AnchorProvider, pgs: SolanaProgramService);
     get connection(): _solana_web3_js.Connection;
+    private getTokenBalance;
     /**
      * Fetch the global distribution state account.
      *
@@ -15536,6 +15545,19 @@ declare class DistributionClient {
         totalShares: BN;
         ratio: number;
     }>;
+    /**
+     * Compute claimable liqSOL for a wallet:
+     * claimable = max(0, entitled - actual)
+     * entitled = floor(shares * syncedIndex / 1e12)
+     *
+     * `syncedIndex` mirrors on-chain `sync_index` behavior by incorporating any
+     * unsynced bucket delta (bucket_balance - last_bucket_balance).
+     */
+    getClaimableLiqsol(user: PublicKey$1): Promise<BN>;
+    /**
+     * Build claim_rewards instruction for a wallet.
+     */
+    buildClaimRewardsIx(user: PublicKey$1): Promise<TransactionInstruction>;
     /**
      * Compute an average scaled pay rate over the most recent `windowSize`
      * valid entries in the pay-rate history circular buffer.
@@ -15857,6 +15879,10 @@ declare class SolanaStakingClient implements IStakingClient {
      * Claim a withdrawal receipt (burn NFT + receive SOL) via claim_withdraw.
      */
     claimWithdraw(tokenId: bigint): Promise<string>;
+    /**
+     * Claim accrued liqSOL distribution rewards (liqsol_core::claim_rewards).
+     */
+    claimLiqsolRewards(): Promise<string>;
     /**
      * Stake liqSOL into Outpost (liqSOL → pool) via liqsol_core::synd.
      */

package/lib/stake.js

@@ -15168,6 +15168,7 @@ var __async$e = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
+const INDEX_SCALE_BN = new anchor.BN("1000000000000");
 class DistributionClient {
   constructor(provider, pgs) {
     this.provider = provider;
@@ -15177,6 +15178,16 @@ class DistributionClient {
   get connection() {
     return this.provider.connection;
   }
+  getTokenBalance(ata) {
+    return __async$e(this, null, function* () {
+      try {
+        const bal = yield this.connection.getTokenAccountBalance(ata);
+        return new anchor.BN(bal.value.amount);
+      } catch (e) {
+        return new anchor.BN(0);
+      }
+    });
+  }
   getDistributionState() {
     return __async$e(this, null, function* () {
       const pda = this.pgs.deriveDistributionStatePda();
@@ -15256,6 +15267,85 @@ class DistributionClient {
       return { shares: userShares, totalShares, ratio };
     });
   }
+  getClaimableLiqsol(user) {
+    return __async$e(this, null, function* () {
+      const liqsolMint = this.pgs.deriveLiqsolMintPda();
+      const bucketAuthority = this.pgs.deriveBucketAuthorityPda();
+      const userAta = splToken.getAssociatedTokenAddressSync(
+        liqsolMint,
+        user,
+        true,
+        splToken.TOKEN_2022_PROGRAM_ID
+      );
+      const bucketTokenAccount = splToken.getAssociatedTokenAddressSync(
+        liqsolMint,
+        bucketAuthority,
+        true,
+        splToken.TOKEN_2022_PROGRAM_ID
+      );
+      const [distributionState, userRecord, actualBalance, bucketBalance] = yield Promise.all([
+        this.getDistributionState(),
+        this.getUserRecord(user),
+        this.getTokenBalance(userAta),
+        this.getTokenBalance(bucketTokenAccount)
+      ]);
+      if (!distributionState || !userRecord) {
+        return new anchor.BN(0);
+      }
+      let syncedIndex = new anchor.BN(distributionState.currentIndex.toString());
+      const totalShares = new anchor.BN(distributionState.totalShares.toString());
+      const lastBucketBalance = new anchor.BN(distributionState.lastBucketBalance.toString());
+      if (totalShares.gt(new anchor.BN(0)) && bucketBalance.gt(lastBucketBalance)) {
+        const delta = bucketBalance.sub(lastBucketBalance);
+        const indexDelta = delta.mul(INDEX_SCALE_BN).div(totalShares);
+        if (indexDelta.gt(new anchor.BN(0))) {
+          syncedIndex = syncedIndex.add(indexDelta);
+        }
+      }
+      const shares = new anchor.BN(userRecord.shares.toString());
+      const entitled = shares.mul(syncedIndex).div(INDEX_SCALE_BN);
+      if (entitled.lte(actualBalance)) {
+        return new anchor.BN(0);
+      }
+      return entitled.sub(actualBalance);
+    });
+  }
+  buildClaimRewardsIx(user) {
+    return __async$e(this, null, function* () {
+      const liqsolMint = this.pgs.deriveLiqsolMintPda();
+      const distributionState = this.pgs.deriveDistributionStatePda();
+      const bucketAuthority = this.pgs.deriveBucketAuthorityPda();
+      const userAta = splToken.getAssociatedTokenAddressSync(
+        liqsolMint,
+        user,
+        true,
+        splToken.TOKEN_2022_PROGRAM_ID
+      );
+      const bucketTokenAccount = splToken.getAssociatedTokenAddressSync(
+        liqsolMint,
+        bucketAuthority,
+        true,
+        splToken.TOKEN_2022_PROGRAM_ID
+      );
+      const userRecord = this.pgs.deriveUserRecordPda(userAta);
+      const bucketUserRecord = this.pgs.deriveUserRecordPda(bucketTokenAccount);
+      const extraAccountMetaList = this.pgs.deriveExtraAccountMetaListPda(liqsolMint);
+      return this.program.methods.claimRewards().accounts({
+        user,
+        userAta,
+        userRecord,
+        bucketUserRecord,
+        distributionState,
+        extraAccountMetaList,
+        liqsolCoreProgram: this.pgs.PROGRAM_IDS.LIQSOL_CORE,
+        transferHookProgram: this.pgs.PROGRAM_IDS.TRANSFER_HOOK,
+        liqsolMint,
+        bucketAuthority,
+        bucketTokenAccount,
+        tokenProgram: splToken.TOKEN_2022_PROGRAM_ID
+      }).instruction();
+    });
+  }
   getAverageScaledPayRate(windowSize = 5) {
     return __async$e(this, null, function* () {
       var _a, _b, _c, _d, _e;
@@ -16188,6 +16278,20 @@ const _SolanaStakingClient = class _SolanaStakingClient {
       }
     });
   }
+  claimLiqsolRewards() {
+    return __async$9(this, null, function* () {
+      var _a;
+      this.ensureUser();
+      const owner = (_a = this.squadsVaultPDA) != null ? _a : this.anchor.wallet.publicKey;
+      try {
+        const ix = yield this.distributionClient.buildClaimRewardsIx(owner);
+        return !!this.squadsX ? yield this.sendSquadsIxs(ix) : yield this.buildAndSendIx(ix);
+      } catch (err) {
+        console.log(`Failed to claim liqSOL rewards on Solana: ${err}`);
+        throw err;
+      }
+    });
+  }
   stake(amountLamports) {
     return __async$9(this, null, function* () {
       this.ensureUser();
@@ -16245,10 +16349,11 @@ const _SolanaStakingClient = class _SolanaStakingClient {
           splToken.TOKEN_2022_PROGRAM_ID,
           splToken.ASSOCIATED_TOKEN_PROGRAM_ID
         );
-        const [nativeLamports, actualBalResp, snapshot] = yield Promise.all([
+        const [nativeLamports, actualBalResp, snapshot, claimableLamports] = yield Promise.all([
           this.connection.getBalance(user, "confirmed"),
           this.connection.getTokenAccountBalance(userLiqsolAta, "confirmed").catch(() => null),
-          this.outpostClient.fetchWireState(user).catch(() => null)
+          this.outpostClient.fetchWireState(user).catch(() => null),
+          this.distributionClient.getClaimableLiqsol(user).catch(() => new anchor.BN(0))
         ]);
         const LIQSOL_DECIMALS = 9;
         const actualAmountStr = (_b = (_a = actualBalResp == null ? void 0 : actualBalResp.value) == null ? void 0 : _a.amount) != null ? _b : "0";
@@ -16285,6 +16390,12 @@ const _SolanaStakingClient = class _SolanaStakingClient {
             decimals: LIQSOL_DECIMALS,
             ata: userLiqsolAta
           },
+          claimable: {
+            amount: BigInt(claimableLamports.toString()),
+            symbol: "LiqSOL",
+            decimals: LIQSOL_DECIMALS,
+            ata: userLiqsolAta
+          },
           staked: {
             amount: stakedLiqsol,
             symbol: "LiqSOL",
@@ -42132,6 +42243,10 @@ class EthereumStakingClient {
   get network() {
     return this.config.network;
   }
+  get address() {
+    var _a;
+    return (_a = this.signer) == null ? void 0 : _a.getAddress();
+  }
   deposit(amount) {
     return __async(this, null, function* () {
       this.ensureUser();
@@ -42143,7 +42258,7 @@ class EthereumStakingClient {
   withdraw(amount) {
     return __async(this, null, function* () {
       this.ensureUser();
-      const address = yield this.signer.getAddress();
+      const address = yield this.address;
       const amountWei = ethers.BigNumber.from(amount);
       const result = yield this.convertClient.performWithdraw(address, amountWei);
       return result.txHash;
@@ -42152,7 +42267,7 @@ class EthereumStakingClient {
   getPendingWithdraws() {
     return __async(this, null, function* () {
       this.ensureUser();
-      const address = yield this.signer.getAddress();
+      const address = yield this.address;
       return yield this.receiptClient.fetchWithdrawReceipts(address);
     });
   }
@@ -42167,7 +42282,7 @@ class EthereumStakingClient {
   stake(amount) {
     return __async(this, null, function* () {
       this.ensureUser();
-      const walletAddress = yield this.signer.getAddress();
+      const walletAddress = yield this.address;
       const amountWei = ethers.BigNumber.from(amount);
       const result = yield this.stakeClient.performStake(amountWei, walletAddress);
       return result.txHash;
@@ -42189,7 +42304,7 @@ class EthereumStakingClient {
   buy(amount) {
     return __async(this, null, function* () {
       this.ensureUser();
-      const buyer = yield this.signer.getAddress();
+      const buyer = yield this.address;
       let result = yield this.pretokenClient.purchasePretokensWithLiqETH(amount, buyer);
       return result && result.txHash ? result.txHash : "Error - no resulting txHash";
     });
@@ -42206,7 +42321,7 @@ class EthereumStakingClient {
       var _a, _b, _c, _d, _e, _f, _g, _h, _i;
       try {
         if (!this.signer) return Promise.resolve(null);
-        const walletAddress = yield this.signer.getAddress();
+        const walletAddress = yield this.address;
         const nativeBalance = yield this.provider.getBalance(walletAddress);
         const nativeDecimals = (_c = (_b = (_a = this.network) == null ? void 0 : _a.nativeCurrency) == null ? void 0 : _b.decimals) != null ? _c : 18;
         const nativeSymbol = (_f = (_e = (_d = this.network) == null ? void 0 : _d.nativeCurrency) == null ? void 0 : _e.symbol) != null ? _f : "ETH";
@@ -42286,14 +42401,14 @@ class EthereumStakingClient {
   fetchPrelaunchReceipts(address) {
     return __async(this, null, function* () {
       this.ensureUser();
-      if (address === void 0) address = yield this.signer.getAddress();
+      if (address === void 0) address = yield this.address;
       return yield this.receiptClient.stakeReceipts(address);
     });
   }
   getOPPMessages(address) {
     return __async(this, null, function* () {
       this.ensureUser();
-      if (!address) address = yield this.signer.getAddress();
+      if (!address) address = yield this.address;
       return yield this.oppClient.getMessages(address);
     });
   }
@@ -42381,7 +42496,7 @@ class EthereumStakingClient {
     return __async(this, null, function* () {
       var _a, _b, _c, _d, _e;
       this.ensureUser();
-      const walletAddress = yield this.signer.getAddress();
+      const walletAddress = yield this.address;
       const baseGas = yield this.provider.estimateGas({
         from: walletAddress,
         to: walletAddress,