@wireio/stake 2.3.0 → 2.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wireio/stake",
-    "version": "2.3.0",
+    "version": "2.3.1",
     "description": "LIQ Staking Module for Wire Network",
     "homepage": "https://gitea.gitgo.app/Wire/sdk-stake",
     "license": "FSL-1.1-Apache-2.0",

package/src/networks/ethereum/ethereum.ts

@@ -32,9 +32,9 @@ export class EthereumStakingClient implements IStakingClient {
     private receiptClient: ReceiptClient;
     private validatorClient: ValidatorClient;
 
-
     get contract() { return this.contractService.contract; }
     get network() { return this.config.network; }
+    get address() { return this.signer?.getAddress(); }
 
     constructor(private config: StakerConfig) {
         try {
@@ -95,7 +95,7 @@ export class EthereumStakingClient implements IStakingClient {
     async withdraw(amount: bigint): Promise<string> {
         this.ensureUser();
 
-        const address = await this.signer!.getAddress();
+        const address = await this.address!;
         const amountWei = BigNumber.from(amount);
 
         const result = await this.convertClient.performWithdraw(address, amountWei)
@@ -109,7 +109,7 @@ export class EthereumStakingClient implements IStakingClient {
      */
     async getPendingWithdraws(): Promise<WithdrawReceipt[]> {
         this.ensureUser();
-        const address = await this.signer!.getAddress();
+        const address = await this.address!;
 
         return await this.receiptClient.fetchWithdrawReceipts(address);
     }
@@ -136,7 +136,7 @@ export class EthereumStakingClient implements IStakingClient {
     async stake(amount: bigint): Promise<string> {
         this.ensureUser();
 
-        const walletAddress = await this.signer!.getAddress();
+        const walletAddress = await this.address!;
         const amountWei = BigNumber.from(amount);
 
         const result = await this.stakeClient.performStake(amountWei, walletAddress);
@@ -168,7 +168,7 @@ export class EthereumStakingClient implements IStakingClient {
     async buy(amount: bigint): Promise<string> {
         this.ensureUser();
 
-        const buyer = await this.signer!.getAddress();
+        const buyer = await this.address!;
 
         // ! Hoodi only - check if the mock aggregator price is stale, and if so, update it before submitting the buy request
         // const network = await this.provider.getNetwork();
@@ -208,7 +208,7 @@ export class EthereumStakingClient implements IStakingClient {
         try {
             if (!this.signer) return Promise.resolve(null);
 
-            const walletAddress = await this.signer!.getAddress();
+            const walletAddress = await this.address!;
 
             // 1) Native ETH balance
             const nativeBalance = await this.provider.getBalance(walletAddress);
@@ -314,7 +314,7 @@ export class EthereumStakingClient implements IStakingClient {
     async fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]> {
         this.ensureUser();
 
-        if (address === undefined) address = await this.signer!.getAddress();
+        if (address === undefined) address = await this.address!;
 
         //default to stake receipts
         return await this.receiptClient.stakeReceipts(address);
@@ -323,7 +323,7 @@ export class EthereumStakingClient implements IStakingClient {
     async getOPPMessages(address?: string): Promise<OPPAssertion[]> {
         this.ensureUser();
 
-        if (!address) address = await this.signer!.getAddress();
+        if (!address) address = await this.address!;
 
         return await this.oppClient.getMessages(address);
     }
@@ -460,7 +460,7 @@ export class EthereumStakingClient implements IStakingClient {
     }): Promise<bigint> {
         this.ensureUser();
 
-        const walletAddress = await this.signer!.getAddress();
+        const walletAddress = await this.address!;
 
         // 1) Estimate a baseline gas usage using a simple self-transfer.
         //    This is cheap and doesn't depend on your contract ABI at all.

package/src/networks/solana/clients/distribution.client.ts

@@ -1,5 +1,5 @@
 import { AnchorProvider, Program, BN } from '@coral-xyz/anchor';
-import { PublicKey } from '@solana/web3.js';
+import { PublicKey, TransactionInstruction } from '@solana/web3.js';
 
 import { LiqsolCoreClientIdl, SolanaProgramService } from '../program';
 import type { LiqsolCore } from '../../../assets/solana/devnet/types/liqsol_core';
@@ -7,6 +7,8 @@ import type { DistributionState, DistributionUserRecord, GlobalConfig, PayRateEn
 import { getAssociatedTokenAddressSync, TOKEN_2022_PROGRAM_ID } from '@solana/spl-token';
 import { ceilDiv } from '../utils';
 
+const INDEX_SCALE_BN = new BN('1000000000000');
+
 /**
  * Distribution client – wraps the distribution portion of the liqsol_core
  * program in the *new* shares-only model.
@@ -39,6 +41,15 @@ export class DistributionClient {
         return this.provider.connection;
     }
 
+    private async getTokenBalance(ata: PublicKey): Promise<BN> {
+        try {
+            const bal = await this.connection.getTokenAccountBalance(ata);
+            return new BN(bal.value.amount);
+        } catch {
+            return new BN(0);
+        }
+    }
+
     /**
      * Fetch the global distribution state account.
      *
@@ -162,6 +173,107 @@ export class DistributionClient {
         return { shares: userShares, totalShares, ratio };
     }
 
+    /**
+     * 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).
+     */
+    async getClaimableLiqsol(user: PublicKey): Promise<BN> {
+        const liqsolMint = this.pgs.deriveLiqsolMintPda();
+        const bucketAuthority = this.pgs.deriveBucketAuthorityPda();
+
+        const userAta = getAssociatedTokenAddressSync(
+            liqsolMint,
+            user,
+            true,
+            TOKEN_2022_PROGRAM_ID,
+        );
+        const bucketTokenAccount = getAssociatedTokenAddressSync(
+            liqsolMint,
+            bucketAuthority,
+            true,
+            TOKEN_2022_PROGRAM_ID,
+        );
+
+        const [distributionState, userRecord, actualBalance, bucketBalance] = await Promise.all([
+            this.getDistributionState(),
+            this.getUserRecord(user),
+            this.getTokenBalance(userAta),
+            this.getTokenBalance(bucketTokenAccount),
+        ]);
+
+        if (!distributionState || !userRecord) {
+            return new BN(0);
+        }
+
+        let syncedIndex = new BN(distributionState.currentIndex.toString());
+        const totalShares = new BN(distributionState.totalShares.toString());
+        const lastBucketBalance = new BN(distributionState.lastBucketBalance.toString());
+
+        if (totalShares.gt(new BN(0)) && bucketBalance.gt(lastBucketBalance)) {
+            const delta = bucketBalance.sub(lastBucketBalance);
+            const indexDelta = delta.mul(INDEX_SCALE_BN).div(totalShares);
+            if (indexDelta.gt(new BN(0))) {
+                syncedIndex = syncedIndex.add(indexDelta);
+            }
+        }
+
+        const shares = new BN(userRecord.shares.toString());
+        const entitled = shares.mul(syncedIndex).div(INDEX_SCALE_BN);
+
+        if (entitled.lte(actualBalance)) {
+            return new BN(0);
+        }
+        return entitled.sub(actualBalance);
+    }
+
+    /**
+     * Build claim_rewards instruction for a wallet.
+     */
+    async buildClaimRewardsIx(user: PublicKey): Promise<TransactionInstruction> {
+        const liqsolMint = this.pgs.deriveLiqsolMintPda();
+        const distributionState = this.pgs.deriveDistributionStatePda();
+        const bucketAuthority = this.pgs.deriveBucketAuthorityPda();
+
+        const userAta = getAssociatedTokenAddressSync(
+            liqsolMint,
+            user,
+            true,
+            TOKEN_2022_PROGRAM_ID,
+        );
+        const bucketTokenAccount = getAssociatedTokenAddressSync(
+            liqsolMint,
+            bucketAuthority,
+            true,
+            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: TOKEN_2022_PROGRAM_ID,
+            })
+            .instruction();
+    }
+
     /**
      * Compute an average scaled pay rate over the most recent `windowSize`
      * valid entries in the pay-rate history circular buffer.
@@ -243,4 +355,4 @@ export class DistributionClient {
         // Same behavior as the dashboard: use a ceiling-like average
         return ceilDiv(sum, new BN(valid));
     }
-}
+}

package/src/networks/solana/solana.ts

@@ -298,6 +298,24 @@ export class SolanaStakingClient implements IStakingClient {
         }
     }
 
+    /**
+     * Claim accrued liqSOL distribution rewards (liqsol_core::claim_rewards).
+     */
+    async claimLiqsolRewards(): Promise<string> {
+        this.ensureUser();
+        const owner = this.squadsVaultPDA ?? this.anchor.wallet.publicKey;
+
+        try {
+            const ix = await this.distributionClient.buildClaimRewardsIx(owner);
+            return !!this.squadsX
+                ? await this.sendSquadsIxs(ix)
+                : await this.buildAndSendIx(ix);
+        } catch (err) {
+            console.log(`Failed to claim liqSOL rewards on Solana: ${err}`);
+            throw err;
+        }
+    }
+
     /**
      * Stake liqSOL into Outpost (liqSOL → pool) via liqsol_core::synd.
      */
@@ -391,12 +409,13 @@ export class SolanaStakingClient implements IStakingClient {
             //  - nativeLamports: wallet SOL
             //  - actualBalResp: liqSOL balance in user ATA
             //  - snapshot: Outpost + pretokens + global index/shares
-            const [nativeLamports, actualBalResp, snapshot] = await Promise.all([
+            const [nativeLamports, actualBalResp, snapshot, claimableLamports] = await Promise.all([
                 this.connection.getBalance(user, 'confirmed'),
                 this.connection
                     .getTokenAccountBalance(userLiqsolAta, 'confirmed')
                     .catch(() => null),
                 this.outpostClient.fetchWireState(user).catch(() => null),
+                this.distributionClient.getClaimableLiqsol(user).catch(() => new BN(0)),
             ]);
 
             const LIQSOL_DECIMALS = 9;
@@ -472,6 +491,12 @@ export class SolanaStakingClient implements IStakingClient {
                     decimals: LIQSOL_DECIMALS,
                     ata: userLiqsolAta,
                 },
+                claimable: {
+                    amount: BigInt(claimableLamports.toString()),
+                    symbol: 'LiqSOL',
+                    decimals: LIQSOL_DECIMALS,
+                    ata: userLiqsolAta,
+                },
                 staked: {
                     // liqSOL staked in Outpost via `synd`
                     amount: stakedLiqsol,

package/src/types.ts

@@ -42,6 +42,9 @@ export interface IStakingClient {
     
     /** 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[]>
@@ -105,6 +108,12 @@ export interface Portfolio {
     /** 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).
@@ -341,4 +350,4 @@ export interface WithdrawReceipt {
         /** Optional explicit contract address for ETH queue NFT. */
         contractAddress?: string;
     };
-}
+}