@wireio/stake 0.4.1 → 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

@@ -1,11 +1,11 @@
 import { BigNumber, ethers } from 'ethers';
 import { ChainID, EvmChainID, PublicKey as WirePubKey } from '@wireio/core';
-import { 
+import {
     IStakingClient,
     OPPAssertion,
-    Portfolio, 
-    StakerConfig, 
-    TrancheSnapshot 
+    Portfolio,
+    StakerConfig,
+    TrancheSnapshot
 } from '../../types';
 import { EthereumContractService } from './contract';
 import { preLaunchReceipt } from './types';
@@ -16,13 +16,10 @@ import { PretokenClient } from './clients/pretoken.client';
 import { OPPClient } from './clients/opp.client';
 import { ReceiptClient } from './clients/receipt.client';
 
-
-
-
 export class EthereumStakingClient implements IStakingClient {
+    private readonly provider: ethers.providers.Web3Provider | ethers.providers.JsonRpcProvider;
     public readonly pubKey?: WirePubKey;
-    private readonly provider: ethers.providers.Web3Provider;
-    private readonly signer: ethers.Signer;
+    private readonly signer?: ethers.Signer;
     private readonly contractService: EthereumContractService;
 
     private convertClient: ConvertClient;
@@ -37,29 +34,32 @@ export class EthereumStakingClient implements IStakingClient {
 
     constructor(private config: StakerConfig) {
         try {
-            this.provider = config.provider as ethers.providers.Web3Provider;
-            this.signer = this.provider.getSigner();
+            if (config.provider) {
+                this.provider = config.provider as ethers.providers.Web3Provider;
+                this.signer = this.provider.getSigner();
+            }
+            else {
+                this.provider = new ethers.providers.JsonRpcProvider(config.network.rpcUrls[0]);
+            }
             this.pubKey = config.pubKey;
-            
+
             this.contractService = new EthereumContractService({
                 provider: this.provider,
                 signer: this.signer,
             });
-            
+
             this.convertClient = new ConvertClient(this.contractService);
             this.pretokenClient = new PretokenClient(this.contractService);
             this.stakeClient = new StakeClient(this.contractService);
             this.oppClient = new OPPClient(this.contractService);
             this.receiptClient = new ReceiptClient(this.contractService);
-        }   
+        }
         catch (error) {
             // console.error('Error initializing EthereumStakingClient:', error);
             throw error;
-        }     
+        }
     }
 
-
-
     // ---------------------------------------------------------------------
     // Public IStakingClient Interface Methods
     // ---------------------------------------------------------------------
@@ -71,6 +71,8 @@ export class EthereumStakingClient implements IStakingClient {
      * @returns transaction hash
      */
     async deposit(amount: number | string | bigint | BigNumber): Promise<string> {
+        this.ensureUser();
+
         const amountWei = BigNumber.isBigNumber(amount)
             ? amount
             : BigNumber.from(amount);
@@ -79,15 +81,15 @@ export class EthereumStakingClient implements IStakingClient {
         return result.txHash;
     }
 
-
-
     /**
      * Withdraw native ETH from the liqETH protocol via the liqeth safeBurn function, which burns the LiqETH and adds the user to the withdrawal queue.
      * @param amount  Amount in wei (or something convertible to BigNumber).
      * @returns transaction hash
      */
     async withdraw(amount: bigint): Promise<string> {
-        const address = await this.signer.getAddress();
+        this.ensureUser();
+
+        const address = await this.signer!.getAddress();
         const amountWei = BigNumber.from(amount);
 
         const result = await this.convertClient.performWithdraw(address, amountWei)
@@ -101,7 +103,9 @@ export class EthereumStakingClient implements IStakingClient {
      * @returns transaction hash
      */
     async stake(amount: bigint): Promise<string> {
-        const walletAddress = await this.signer.getAddress();
+        this.ensureUser();
+
+        const walletAddress = await this.signer!.getAddress();
         const amountWei = BigNumber.from(amount);
 
         const result = await this.stakeClient.performStake(amountWei, walletAddress);
@@ -122,15 +126,18 @@ export class EthereumStakingClient implements IStakingClient {
      * @returns the transaction hash
      */
     async unstakePrelaunch(tokenId: bigint, recipient: string): Promise<string> {
+        this.ensureUser();
+
         const tokenIdBigNum = BigNumber.from(tokenId)
         const result = await this.stakeClient.performWithdrawStake(tokenIdBigNum, recipient);
         return result.txHash;
     }
 
 
-
     async buy(amount: bigint): Promise<string> {
-        const buyer = await this.signer.getAddress();
+        this.ensureUser();
+
+        const buyer = await this.signer!.getAddress();
 
         // ! Hoodi only - check if the mock aggregator price is stale, and if so, update it before submitting the buy request
         await this.updateMockAggregatorPrice();
@@ -140,46 +147,6 @@ export class EthereumStakingClient implements IStakingClient {
     }
 
 
-    async getOPPMessages(address?: string): Promise<OPPAssertion[]> {
-        if(!address) address = await this.signer.getAddress();
-        
-        return await this.oppClient.getMessages(address);
-    }
-
-
-    async getOPPStatus(): Promise<any> {
-        return await this.oppClient.getStatus();
-    }
-
-
-    
-    /**
-     * ETH Prelaunch function to list the Stake ReceiptNFTs owned by a specific user
-     * @param address address to query the receipts for
-     * @returns array of receipts
-     */
-    async fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]> {
-        if(address === undefined) address = await this.signer.getAddress();
-        
-        //default to stake receipts
-        return await this.receiptClient.stakeReceipts(address);
-    }
-
-    
-    
-    async getEthStats(): Promise<any> {
-        let withdrawDelay = await this.contract.DepositManager.withdrawDelay();
-        let minDeposit = await this.contract.DepositManager.minDeposit();
-        let rewardCooldown = await this.contract.DepositManager.rewardCooldown();
-
-        return {
-            withdrawDelay,
-            minDeposit,
-            rewardCooldown,
-        }
-    }
-
-
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -188,7 +155,9 @@ export class EthereumStakingClient implements IStakingClient {
      * tracked = liqETH tracked balance (protocol/accounting view)
      */
     async getPortfolio(): Promise<Portfolio> {
-        const walletAddress = await this.signer.getAddress();
+        this.ensureUser();
+
+        const walletAddress = await this.signer!.getAddress();
 
         // 1) Native ETH balance
         const nativeBalance = await this.provider.getBalance(walletAddress);
@@ -205,11 +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(),
@@ -231,14 +237,88 @@ export class EthereumStakingClient implements IStakingClient {
                 decimals: 18,
                 symbol: '$WIRE',
             },
+
+            yield: {
+                currentIndex,
+                indexScale,
+                totalShares,
+                userShares,
+                estimatedClaim,
+                estimatedYield,
+            },
             chainID: this.network.chainId
         }
         return portfolio;
     }
 
+    /**
+     * ETH Prelaunch function to list the Stake ReceiptNFTs owned by a specific user
+     * @param address address to query the receipts for
+     * @returns array of receipts
+     */
+    async fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]> {
+        this.ensureUser();
+
+        if (address === undefined) address = await this.signer!.getAddress();
+
+        //default to stake receipts
+        return await this.receiptClient.stakeReceipts(address);
+    }
+
+    async getOPPMessages(address?: string): Promise<OPPAssertion[]> {
+        this.ensureUser();
+
+        if (!address) address = await this.signer!.getAddress();
+
+        return await this.oppClient.getMessages(address);
+    }
+
+    // Ensure that signer wallet is available for write operations
+    private ensureUser() {
+        if (!this.signer) {
+            throw new Error(
+                'EthereumStakingClient: write operation requires a wallet-connected Web3 provider',
+            );
+        }
+    }
+
+
+    // ---------------------------------------------------------------------
+    // READ-ONLY Public Methods
+    // ---------------------------------------------------------------------
+
+    // Estimated total APY for staking yeild
+    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
+    async getDepositFee(amountWei: bigint): Promise<bigint> {
+        const feeBn: BigNumber = await this.contract.DepositManager.procFee(amountWei);
+        return BigInt(feeBn.toString());
+    }
+
+    async getOPPStatus(): Promise<any> {
+        return await this.oppClient.getStatus();
+    }
+
+    async getEthStats(): Promise<any> {
+        let withdrawDelay = await this.contract.DepositManager.withdrawDelay();
+        let minDeposit = await this.contract.DepositManager.minDeposit();
+        let rewardCooldown = await this.contract.DepositManager.rewardCooldown();
+
+        return {
+            withdrawDelay,
+            minDeposit,
+            rewardCooldown,
+        }
+    }
 
     /**
      * Program-level prelaunch WIRE / tranche snapshot for Ethereum
+     * 
+     * SUPPORTS READ-ONLY ACcESS
      */
     async getTrancheSnapshot(options?: {
         chainID?: ChainID;
@@ -275,25 +355,25 @@ export class EthereumStakingClient implements IStakingClient {
 
 
         // fetch price and timestamp from aggregator
-        const [ roundId, answer, startedAt, updatedAt, answeredInRound ] = await this.contract.Aggregator.latestRoundData();
+        const [roundId, answer, startedAt, updatedAt, answeredInRound] = await this.contract.Aggregator.latestRoundData();
         let ethPriceUsd: bigint = BigInt(answer.toString());
         let nativePriceTimestamp: number = Number(updatedAt);
 
         // ! Placeholder from hoodi deployment - don't think this can be fetched dynamically
-        const initialTrancheSupply = BigInt(60000) * BigInt(1e8); 
+        const initialTrancheSupply = BigInt(60000) * BigInt(1e8);
 
         return buildEthereumTrancheSnapshot({
             chainID,
-            totalSharesBn, 
-            indexBn, 
+            totalSharesBn,
+            indexBn,
             trancheNumberBn,
-            currentTrancheSupply, 
-            tranchePriceWadBn, 
+            currentTrancheSupply,
+            tranchePriceWadBn,
             totalTrancheSupply,
             initialTrancheSupply,
             supplyGrowthBps,
             priceGrowthBps,
-            minPriceUsd, 
+            minPriceUsd,
             maxPriceUsd,
 
             ethPriceUsd,
@@ -303,16 +383,10 @@ export class EthereumStakingClient implements IStakingClient {
         });
     }
 
-
-
-    
     // ---------------------------------------------------------------------
     // Internal ETH Staking client helper functions
     // ---------------------------------------------------------------------
 
-
-    
-
     // ! This is a temporary measure for Hoodi testnet because there is no aggregator deployed
     private async updateMockAggregatorPrice() {
         const aggregator = this.contract.Aggregator;
@@ -328,7 +402,7 @@ export class EthereumStakingClient implements IStakingClient {
             // safety check - only run in non-production contexts
             const network = await this.provider.getNetwork();
             const chainId = network.chainId;
-            const allowedTestChains = new Set([560048]); 
+            const allowedTestChains = new Set([560048]);
             if (!allowedTestChains.has(chainId)) {
                 console.warn(`MockAggregator is stale (${ageSec}s) but chainId ${chainId} is not a test/local network — skipping update.`);
                 return;
@@ -359,10 +433,4 @@ export class EthereumStakingClient implements IStakingClient {
             console.log(`MockAggregator updated ${ageSec}s ago — no update needed`);
         }
     }
-
-
-
-
-
-    // TODO: implement claimRewards, etc.
 }

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