@wireio/stake 0.4.1 → 0.4.3

package/src/networks/solana/solana.ts

@@ -193,7 +193,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Handles tx build, sign, send, and confirmation.
      */
     async deposit(amountLamports: bigint): Promise<string> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         if (amountLamports <= BigInt(0)) {
             throw new Error('Deposit amount must be greater than zero.');
         }
@@ -219,7 +219,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Actual SOL payout happens later via the operator-side flow.
      */
     async withdraw(amountLamports: bigint): Promise<string> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         if (amountLamports <= BigInt(0)) {
             throw new Error('Withdraw amount must be greater than zero.');
         }
@@ -238,7 +238,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Stake liqSOL into Outpost (liqSOL → pool) via liqsol_core::synd.
      */
     async stake(amountLamports: bigint): Promise<string> {
-        this.ensureWriteAccess();
+        this.ensureUser();
 
         if (!amountLamports || amountLamports <= BigInt(0)) {
             throw new Error('Stake amount must be greater than zero.');
@@ -246,11 +246,14 @@ export class SolanaStakingClient implements IStakingClient {
 
         const user = this.solPubKey;
 
+        // Build compute budget increase instruction
+        const cuIx = ComputeBudgetProgram.setComputeUnitLimit({ units: 400_000 });
+
         // Build the Outpost synd instruction
         const ix = await this.outpostClient.buildStakeIx(amountLamports, user);
 
         // Wrap in a transaction and send
-        const tx = new Transaction().add(ix);
+        const tx = new Transaction().add(cuIx, ix);
         const prepared = await this.prepareTx(tx);
         const signed = await this.signTransaction(prepared.tx);
 
@@ -261,7 +264,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Unstake liqSOL from Outpost (pool → liqSOL) via liqsol_core::desynd.
      */
     async unstake(amountLamports: bigint): Promise<string> {
-        this.ensureWriteAccess();
+        this.ensureUser();
 
         if (!amountLamports || amountLamports <= BigInt(0)) {
             throw new Error('Unstake amount must be greater than zero.');
@@ -269,11 +272,14 @@ export class SolanaStakingClient implements IStakingClient {
 
         const user = this.solPubKey;
 
+        // Build compute budget increase instruction
+        const cuIx = ComputeBudgetProgram.setComputeUnitLimit({ units: 400_000 });
+
         // Build the Outpost desynd instruction
         const ix = await this.outpostClient.buildUnstakeIx(amountLamports, user);
 
         // Wrap in a transaction and send
-        const tx = new Transaction().add(ix);
+        const tx = new Transaction().add(cuIx, ix);
         const prepared = await this.prepareTx(tx);
         const signed = await this.signTransaction(prepared.tx);
 
@@ -287,7 +293,7 @@ export class SolanaStakingClient implements IStakingClient {
      * instruction under the new IDL (no more native-SOL purchase).
      */
     async buy(amountLamports: bigint): Promise<string> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         if (!amountLamports || amountLamports <= BigInt(0)) {
             throw new Error('liqSOL pretoken purchase requires a positive amount.');
         }
@@ -376,7 +382,7 @@ export class SolanaStakingClient implements IStakingClient {
         //  - totalShares:  globalState.totalShares
         //  - userShares:   outpostAccount.stakedShares
         //  - estimatedClaimLiqsol: floor(userShares * index / INDEX_SCALE)
-        //  - estimatedYieldLiqsol: max(0, estimatedClaim - stakedLiqsol)
+        //  - estimatedYield: max(0, estimatedClaim - stakedLiqsol)
         //
         // This matches the capital-staking math:
         //   sharesToTokens(shares, index) = shares * index / INDEX_SCALE
@@ -392,15 +398,15 @@ export class SolanaStakingClient implements IStakingClient {
         const totalShares = BigInt(totalSharesStr);
         const userShares = BigInt(userSharesStr);
 
-        let estimatedClaimLiqsol = BigInt(0);
-        let estimatedYieldLiqsol = BigInt(0);
+        let estimatedClaim = BigInt(0);
+        let estimatedYield = BigInt(0);
 
         if (userShares > BigInt(0) && currentIndex > BigInt(0)) {
             // sharesToTokens(userShares, currentIndex)
-            estimatedClaimLiqsol = (userShares * currentIndex) / INDEX_SCALE;
+            estimatedClaim = (userShares * currentIndex) / INDEX_SCALE;
 
-            if (estimatedClaimLiqsol > stakedLiqsol) {
-                estimatedYieldLiqsol = estimatedClaimLiqsol - stakedLiqsol;
+            if (estimatedClaim > stakedLiqsol) {
+                estimatedYield = estimatedClaim - stakedLiqsol;
             }
         }
 
@@ -435,8 +441,8 @@ export class SolanaStakingClient implements IStakingClient {
                 totalShares,
                 userShares,
                 // liqSOL amounts (lamports) implied by index/shares
-                estimatedClaimLiqsol,
-                estimatedYieldLiqsol,
+                estimatedClaim,
+                estimatedYield,
             },
             extras: {
                 userLiqsolAta: userLiqsolAta.toBase58(),
@@ -453,6 +459,33 @@ export class SolanaStakingClient implements IStakingClient {
         };
     }
 
+    /**
+     * Convenience helper to fetch the distribution userRecord for the current user.
+     * Used by balance-correction flows and debugging.
+     */
+    async getUserRecord() {
+        if (!this.pubKey) throw new Error('User pubKey is undefined');
+        return this.distributionClient.getUserRecord(this.solPubKey);
+    }
+
+
+    // ---------------------------------------------------------------------
+    // READ-ONLY Public Methods
+    // ---------------------------------------------------------------------
+
+    // Estimated total APY for staking yeild
+    getSystemAPY(): Promise<number> {
+        // TODO
+        return Promise.resolve(0);
+    }
+
+    // Protocol fee charged for deposit from Native to LIQ
+    getDepositFee(amount: bigint): Promise<bigint> {
+        // Returning 1% for now, 
+        // TODO: fetch real fee from on-chain config
+        return Promise.resolve((amount * BigInt(1)) / BigInt(100));
+    }
+
     /**
      * Unified, chain-agnostic tranche snapshot for Solana.
      *
@@ -493,15 +526,6 @@ export class SolanaStakingClient implements IStakingClient {
         });
     }
 
-    /**
-     * Convenience helper to fetch the distribution userRecord for the current user.
-     * Used by balance-correction flows and debugging.
-     */
-    async getUserRecord() {
-        if (!this.pubKey) throw new Error('User pubKey is undefined');
-        return this.distributionClient.getUserRecord(this.solPubKey);
-    }
-
     // ---------------------------------------------------------------------
     // Tx helpers
     // ---------------------------------------------------------------------
@@ -514,7 +538,7 @@ export class SolanaStakingClient implements IStakingClient {
         signed: SolanaTransaction,
         ctx: { blockhash: string; lastValidBlockHeight: number },
     ): Promise<string> {
-        this.ensureWriteAccess();
+        this.ensureUser();
 
         const signature = await this.connection.sendRawTransaction(
             signed.serialize(),
@@ -549,7 +573,7 @@ export class SolanaStakingClient implements IStakingClient {
     async signTransaction(
         tx: SolanaTransaction,
     ): Promise<SolanaTransaction> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         return this.anchor.wallet.signTransaction(tx);
     }
 
@@ -560,7 +584,7 @@ export class SolanaStakingClient implements IStakingClient {
     async sendTransaction(
         signed: SolanaTransaction,
     ): Promise<TransactionSignature> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         return this.anchor.sendAndConfirm(signed);
     }
 
@@ -586,7 +610,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Guard for all write operations (deposit/withdraw/stake/unstake/buy).
      * Ensures we have a Wire pubKey and an Anchor wallet pubKey, and that they match.
      */
-    ensureWriteAccess() {
+    ensureUser() {
         if (!this.pubKey || !this.anchor.wallet.publicKey) {
             throw new Error('User Authorization required: pubKey is undefined');
         }

package/src/types.ts

@@ -5,7 +5,7 @@ import { ethers } from 'ethers';
 
 export type StakerConfig = {
     network: ExternalNetwork;
-    provider: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
+    provider?: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
     pubKey?: PublicKey;
 }
 
@@ -23,6 +23,12 @@ export interface IStakingClient {
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio>;
 
+    // Estimated total APY for staking yeild
+    getSystemAPY(): Promise<number>;
+
+    // Protocol fee charged for deposit from Native to LIQ
+    getDepositFee(amount: bigint): Promise<bigint>;
+
     /**
      * Program-level prelaunch WIRE/tranche snapshot for this chain.
      *
@@ -35,6 +41,12 @@ export interface IStakingClient {
         windowBefore?: number;
         windowAfter?: number;
     }): Promise<TrancheSnapshot | null>;
+    
+    // Estimated total APY for staking yeild
+    getSystemAPY(): Promise<number>;
+
+    // Protocol fee charged for deposit from Native to LIQ
+    getDepositFee(amount: bigint): Promise<bigint>;
 }
 
 /**
@@ -106,9 +118,9 @@ export interface BalanceView {
 }
 
 /**
- * SOL / Outpost yield view.
+ * Outpost yield view.
  *
- * All amounts are integers in base units (lamports for liqSOL).
+ * All amounts are integers in base units (lamports for liqSOL, wei for liqETH).
  *
  * Math matches capital-staking:
  *   INDEX_SCALE      = 1e12
@@ -135,20 +147,20 @@ export interface YieldView {
     userShares: bigint;
 
     /**
-     * Total liqSOL (lamports) the user could claim right now if they fully
+     * Total liq (wei/lamports) the user could claim right now if they fully
      * unwound their stake:
-     *   estimatedClaimLiqsol = userShares * currentIndex / indexScale
+     *   estimatedClaim = userShares * currentIndex / indexScale
      */
-    estimatedClaimLiqsol: bigint;
+    estimatedClaim?: bigint;
 
     /**
-     * Portion of estimatedClaimLiqsol that is “yield” above principal:
-     *   estimatedYieldLiqsol = max(0, estimatedClaimLiqsol - stakedLiqsol)
+     * Portion of estimatedClaim that is “yield” above principal:
+     *   estimatedYield = max(0, estimatedClaim - staked)
      *
-     * NOTE: stakedLiqsol principal itself is surfaced separately as
+     * NOTE: staked principal itself is surfaced separately as
      *       Portfolio.staked.amount.
      */
-    estimatedYieldLiqsol: bigint;
+    estimatedYield?: bigint;
 }
 
 export interface TrancheLadderItem {