@wireio/stake 0.4.1 → 0.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wireio/stake",
-    "version": "0.4.1",
+    "version": "0.4.2",
     "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

@@ -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);
@@ -206,7 +175,6 @@ export class EthereumStakingClient implements IStakingClient {
             stakeBalanceBN = stakeBalanceBN.add(BigNumber.from(r.receipt.principal.amount));
         }
 
-
         // 4) WIRE pretoken balance
         const wireBalance: ethers.BigNumber = await this.contract.Pretoken.balanceOf(walletAddress);
 
@@ -236,9 +204,74 @@ export class EthereumStakingClient implements IStakingClient {
         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
+    getSystemAPY(): Promise<number> {
+        // TODO
+        return Promise.resolve(0);
+    }
+
+    // Protocol fee charged for deposit from Native to LIQ
+    getDepositFee(amount: bigint): Promise<bigint> {
+        // TODO
+        return Promise.resolve(BigInt(0));
+    }
+
+    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 +308,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 +336,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 +355,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 +386,4 @@ export class EthereumStakingClient implements IStakingClient {
             console.log(`MockAggregator updated ${ageSec}s ago — no update needed`);
         }
     }
-
-
-
-
-
-    // TODO: implement claimRewards, etc.
 }

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.');
@@ -261,7 +261,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.');
@@ -287,7 +287,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.');
         }
@@ -453,6 +453,32 @@ 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> {
+        // TODO
+        return Promise.resolve(BigInt(0));
+    }
+
     /**
      * Unified, chain-agnostic tranche snapshot for Solana.
      *
@@ -493,15 +519,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 +531,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 +566,7 @@ export class SolanaStakingClient implements IStakingClient {
     async signTransaction(
         tx: SolanaTransaction,
     ): Promise<SolanaTransaction> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         return this.anchor.wallet.signTransaction(tx);
     }
 
@@ -560,7 +577,7 @@ export class SolanaStakingClient implements IStakingClient {
     async sendTransaction(
         signed: SolanaTransaction,
     ): Promise<TransactionSignature> {
-        this.ensureWriteAccess();
+        this.ensureUser();
         return this.anchor.sendAndConfirm(signed);
     }
 
@@ -586,7 +603,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.
      *