@wireio/stake 0.4.2 → 0.4.3

package/src/assets/solana/types/liqsol_token.ts

@@ -5,7 +5,7 @@
  * IDL can be found at `target/idl/liqsol_token.json`.
  */
 export type LiqsolToken = {
-  "address": "6hiJ8PrSyYLr7H9MA9VYh9fvGoHxZ2TXdDAMzjeUVSXZ",
+  "address": "5MRFSLCkXPEzfR6gkcZCVttq9g83mMUHyTZ85Z3TSpvU",
   "metadata": {
     "name": "liqsolToken",
     "version": "0.1.0",

package/src/assets/solana/types/transfer_hook.ts

@@ -5,7 +5,7 @@
  * IDL can be found at `target/idl/transfer_hook.json`.
  */
 export type TransferHook = {
-  "address": "EtqCLddkPNGjkgiH9rVUmK3M5X2FKFprQvgscBJ8g6hX",
+  "address": "HbBpH9opFW9gcYVanHLweKuHhWQ8P3Kcc1mbpAx1vojz",
   "metadata": {
     "name": "transferHook",
     "version": "0.1.0",
@@ -129,6 +129,11 @@ export type TransferHook = {
     {
       "code": 6002,
       "name": "tlvAccountResolutionError"
+    },
+    {
+      "code": 6003,
+      "name": "cannotTransferToBucket",
+      "msg": "Cannot transfer liqSOL directly to bucket - only protocol minting is allowed"
     }
   ],
   "types": [

package/src/assets/solana/types/validator_leaderboard.ts

@@ -5,7 +5,7 @@
  * IDL can be found at `target/idl/validator_leaderboard.json`.
  */
 export type ValidatorLeaderboard = {
-  "address": "H6CWj2PgxCE9Z5dPi9nMrR2VxT1C4DQcqR1QjmLeon47",
+  "address": "5v7mWL1735qp2Th9B5WNf7spGynR5ZaxwyCYoQw13DP2",
   "metadata": {
     "name": "validatorLeaderboard",
     "version": "0.1.0",
@@ -124,6 +124,9 @@ export type ValidatorLeaderboard = {
         },
         {
           "name": "systemProgram"
+        },
+        {
+          "name": "clock"
         }
       ],
       "args": [

package/src/networks/ethereum/ethereum.ts

@@ -174,10 +174,48 @@ export class EthereumStakingClient implements IStakingClient {
         for (let r of stakeReceipts) {
             stakeBalanceBN = stakeBalanceBN.add(BigNumber.from(r.receipt.principal.amount));
         }
+        let stakeSharesBN = BigNumber.from(0);
+        for (let r of stakeReceipts) {
+            stakeSharesBN = stakeSharesBN.add(BigNumber.from(r.receipt.shares.amount));
+        }
 
         // 4) WIRE pretoken balance
         const wireBalance: ethers.BigNumber = await this.contract.Pretoken.balanceOf(walletAddress);
 
+
+        // 5) Calculate staking yield 
+        let currentIndex = BigInt(0);
+        let totalShares = BigInt(0);
+        let userShares = BigInt(0);
+        const indexScale = BigInt(1e27);
+        try {
+            // These may throw if not implemented on contract
+            const [indexBn, totalSharesBn] = await Promise.all([
+                this.contract.Depositor.index().catch(() => BigNumber.from(0)),
+                this.contract.Depositor.totalShares().catch(() => BigNumber.from(0)),
+            ]);
+
+            const userSharesBn = stakeSharesBN;
+            currentIndex = BigInt(indexBn.toString());
+            totalShares = BigInt(totalSharesBn.toString());
+            userShares = BigInt(userSharesBn.toString());
+        } catch {}
+
+        // sharesToTokens(userShares, currentIndex) = userShares * currentIndex / indexScale
+        let estimatedClaim = BigInt(0);
+        let estimatedYield = BigInt(0);
+
+        // started work on estimating the user's personal APY - not necessary at the moment
+        // let estimatedAPY: number | null = null;
+        // if (userShares > BigInt(0) && currentIndex > BigInt(0)) {
+        //     estimatedClaim = (userShares * currentIndex) / indexScale;
+        //     if (estimatedClaim > stakeBalanceBN.toBigInt()) {
+        //         estimatedYield = estimatedClaim - stakeBalanceBN.toBigInt();
+        //     }
+
+        //     estimatedAPY = null;
+        // }
+
         const portfolio: Portfolio = {
             native: {
                 amount: nativeBalance.toBigInt(),
@@ -199,6 +237,15 @@ export class EthereumStakingClient implements IStakingClient {
                 decimals: 18,
                 symbol: '$WIRE',
             },
+
+            yield: {
+                currentIndex,
+                indexScale,
+                totalShares,
+                userShares,
+                estimatedClaim,
+                estimatedYield,
+            },
             chainID: this.network.chainId
         }
         return portfolio;
@@ -241,15 +288,15 @@ export class EthereumStakingClient implements IStakingClient {
     // ---------------------------------------------------------------------
 
     // Estimated total APY for staking yeild
-    getSystemAPY(): Promise<number> {
-        // TODO
-        return Promise.resolve(0);
+    async getSystemAPY(): Promise<number> {
+        const annualBpsBn = await this.contract.DepositManager.dailyRateBPS();
+        return annualBpsBn.toNumber() / 10000; // 0.04 for 4%
     }
 
     // Protocol fee charged for deposit from Native to LIQ
-    getDepositFee(amount: bigint): Promise<bigint> {
-        // TODO
-        return Promise.resolve(BigInt(0));
+    async getDepositFee(amountWei: bigint): Promise<bigint> {
+        const feeBn: BigNumber = await this.contract.DepositManager.procFee(amountWei);
+        return BigInt(feeBn.toString());
     }
 
     async getOPPStatus(): Promise<any> {

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

@@ -40,6 +40,7 @@ import {
     deriveWithdrawMintMetadataPda,
     deriveWithdrawNftMintPda,
     deriveLiqReceiptDataPda,
+    deriveGlobalConfigPda,
 } from '../constants';
 import { WalletLike } from '../types';
 
@@ -86,6 +87,7 @@ export class DepositClient {
         const payoutState = derivePayoutStatePda();
         const bucketAuthority = deriveBucketAuthorityPda();
         const payRateHistory = derivePayRateHistoryPda();
+        const globalConfig = deriveGlobalConfigPda();
 
         // -------------------------------------------------------------
         // Token-2022 ATAs
@@ -129,27 +131,24 @@ export class DepositClient {
                 associatedTokenProgram: ASSOCIATED_TOKEN_PROGRAM_ID,
                 liqsolProgram: PROGRAM_IDS.LIQSOL_TOKEN,
                 stakeProgram: StakeProgram.programId,
-
                 liqsolMint,
                 userAta,
                 liqsolMintAuthority,
                 reservePool,
                 vault,
                 ephemeralStake,
-
                 controllerState,
                 payoutState,
                 bucketAuthority,
                 bucketTokenAccount,
-
                 userRecord,
                 distributionState,
                 payRateHistory,
-
                 instructionsSysvar: SYSVAR_INSTRUCTIONS_PUBKEY,
                 clock: SYSVAR_CLOCK_PUBKEY,
                 stakeHistory: SYSVAR_STAKE_HISTORY_PUBKEY,
                 rent: SYSVAR_RENT_PUBKEY,
+                globalConfig
             })
             .instruction();
 
@@ -203,6 +202,7 @@ export class DepositClient {
         const stakeAllocationState = deriveStakeAllocationStatePda();
         const stakeMetrics = deriveStakeMetricsPda();
         const maintenanceLedger = deriveMaintenanceLedgerPda();
+        const globalConfig = deriveGlobalConfigPda();
 
         // -------------------------------------------------------------
         // Need nextReceiptId from withdraw global state
@@ -265,6 +265,7 @@ export class DepositClient {
                 associatedTokenProgram: ASSOCIATED_TOKEN_PROGRAM_ID,
                 systemProgram: SystemProgram.programId,
                 rent: SYSVAR_RENT_PUBKEY,
+                globalConfig
             })
             .instruction();
 

package/src/networks/solana/constants.ts

@@ -36,6 +36,9 @@ export const {
  */
 
 export const PDA_SEEDS = {
+    // GLOBAL CONFIG
+    GLOBAL_CONFIG: 'global_config',
+
     // liqsol_core: deposit / stake controller
     DEPOSIT_AUTHORITY: 'deposit_authority',
     VAULT: 'vault',
@@ -86,8 +89,19 @@ export const PDA_SEEDS = {
     MINT_METADATA: 'mint_metadata',
     LIQ_RECEIPT_DATA: 'liq_receipt_data',
     WITHDRAW_MINT: 'mint',
+
+
+
 } as const;
 
+// Global Config PDA
+export const deriveGlobalConfigPda = () =>
+    PublicKey.findProgramAddressSync(
+        [Buffer.from(PDA_SEEDS.GLOBAL_CONFIG)],
+        LIQSOL_CORE,
+    )[0];
+
+
 /**
  * ---------------------------------------------------------------------------
  *  CORE / DISTRIBUTION / DEPOSIT PDAS

package/src/networks/solana/solana.ts

@@ -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);
 
@@ -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);
 
@@ -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(),
@@ -462,7 +468,7 @@ export class SolanaStakingClient implements IStakingClient {
         return this.distributionClient.getUserRecord(this.solPubKey);
     }
 
-    
+
     // ---------------------------------------------------------------------
     // READ-ONLY Public Methods
     // ---------------------------------------------------------------------
@@ -475,8 +481,9 @@ export class SolanaStakingClient implements IStakingClient {
 
     // Protocol fee charged for deposit from Native to LIQ
     getDepositFee(amount: bigint): Promise<bigint> {
-        // TODO
-        return Promise.resolve(BigInt(0));
+        // Returning 1% for now, 
+        // TODO: fetch real fee from on-chain config
+        return Promise.resolve((amount * BigInt(1)) / BigInt(100));
     }
 
     /**

package/src/types.ts

@@ -41,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>;
 }
 
 /**
@@ -112,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
@@ -141,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 {