@wireio/stake 0.1.1 → 0.1.2

package/src/networks/ethereum/contract.ts

@@ -3,24 +3,23 @@
  *
  * Provides a unified service for interacting with Ethereum smart contracts using ethers.js.
  */
-// TODO: adjust these import paths to your actual artifact layout
-// import DepositManagerArtifact from '../../assets/ethereum/ABI/liqeth/DepositManager.sol/DepositManager.json';
-// import LiqEthArtifact from '../../assets/ethereum/ABI/liqeth/liqEth.sol/liqEth.json';
-// import LiqEthMintArtifact from '../../assets/ethereum/ABI/liqeth/liqEthMint.sol/liqEthMint.json';
-// import LiqEthBurnArtifact from '../../assets/ethereum/ABI/liqeth/liqEthBurn.sol/liqEthBurn.json';
-// import LiqEthTreasuryArtifact from '../../assets/ethereum/ABI/liqeth/liqEthTreasury.sol/liqEthTreasury.json';
-// import LiqEthCommonArtifact from '../../assets/ethereum/ABI/liqeth/LiqEthCommon.sol/LiqEthCommon.json';
-// import RewardsERC20Artifact from '../../assets/ethereum/ABI/liqeth/RewardsERC20.sol/RewardsERC20.json';
-// import ValidatorBalanceVerifierArtifact from '../../assets/ethereum/ABI/liqeth/ValidatorBalanceVerifier.sol/ValidatorBalanceVerifier.json';
-// import YieldArtifact from '../../assets/ethereum/ABI/liqeth/Yield.sol/Yield.json';
-// import AccountingArtifact from '../../assets/ethereum/ABI/liqeth/accounting.sol/accounting.json';
-// import StakingModuleArtifact from '../../assets/ethereum/ABI/liqeth/stakingModule.sol/stakingModule.json';
-// import WithdrawalQueueArtifact from '../../assets/ethereum/ABI/liqeth/withdrawalQueue.sol/withdrawalQueue.json';
-// import WithdrawalVaultArtifact from '../../assets/ethereum/ABI/liqeth/withdrawalVault.sol/withdrawalVault.json';
+import AccountingArtifact from '../../assets/ethereum/ABI/liqEth/accounting.sol/Accounting.json';
+import DepositManagerArtifact from '../../assets/ethereum/ABI/liqEth/DepositManager.sol/DepositManager.json';
+import LiqEthArtifact from '../../assets/ethereum/ABI/liqEth/liqEth.sol/LiqEthToken.json';
+import LiqEthBurnArtifact from '../../assets/ethereum/ABI/liqEth/liqEthBurn.sol/LiqEthBurn.json';
+// import LiqEthCommonArtifact from '../../assets/ethereum/ABI/liqEth/liqEthCommon.sol/liqEthCommon.json';
+import LiqEthMintArtifact from '../../assets/ethereum/ABI/liqEth/liqEthMint.sol/LiqEthMint.json';
+// import RewardsERC20Artifact from '../../assets/ethereum/ABI/liqEth/RewardsERC20.sol/RewardsERC20.json';
+import StakingModuleArtifact from '../../assets/ethereum/ABI/liqEth/stakingModule.sol/StakingModule.json';
+// import ValidatorBalanceArtifact from '../../assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/ValidatorBalanceVerifier.json';
+import WithdrawalQueueArtifact from '../../assets/ethereum/ABI/liqEth/withdrawalQueue.sol/WithdrawalQueue.json';
+import WithdrawalVaultArtifact from '../../assets/ethereum/ABI/liqEth/withdrawalVault.sol/WithdrawalVault.json';
+// import YieldArtifact from '../../assets/ethereum/ABI/liqEth/Yield.sol/YieldOracle.json';
 
 import ERC20Artifact from '../../assets/ethereum/ABI/token/ERC20Token.sol/ERC20Token.json';
 import ERC721Artifact from '../../assets/ethereum/ABI/token/ERC721Token.sol/ERC721Token.json';
 import ERC1155Artifact from '../../assets/ethereum/ABI/token/ERC1155Token.sol/ERC1155Token.json';
+
 import { AddressBook, ContractName } from './types';
 import { Contract, ethers, providers, Signer } from 'ethers';
 import { JsonFragment } from '@ethersproject/abi';
@@ -36,23 +35,14 @@ export const ERC1155Abi = ERC1155Artifact.abi;
 
 // Make sure ContractName in ./types includes all of these keys.
 export const ADDRESSES: AddressBook = {
-    // Outpost/Stake entrypoint
-    Stake: '0xEeaCBa95852324eAc63fE2711aFe0283adf3bC93', // TODO
-
-    // liqETH protocol suite
-    DepositManager: '0xDepositManagerAddress',
-    LiqEth: '0xLiqEthTokenAddress',
-    LiqEthMint: '0xLiqEthMintAddress',
-    LiqEthBurn: '0xLiqEthBurnAddress',
-    LiqEthTreasury: '0xLiqEthTreasuryAddress',
-    LiqEthCommon: '0xLiqEthCommonAddress',
-    RewardsERC20: '0xRewardsErc20Address',
-    ValidatorBalanceVerifier: '0xValidatorBalanceVerifierAddress',
-    Yield: '0xYieldAddress',
-    Accounting: '0xAccountingAddress',
-    StakingModule: '0xStakingModuleAddress',
-    WithdrawalQueue: '0xWithdrawalQueueAddress',
-    WithdrawalVault: '0xWithdrawalVaultAddress',
+    Accounting: "0xd51CC479c25dc7Cd23f568Ef5c1AdE1671a4D15b",
+    DepositManager: "0x2249D309f086363ABF5057Ae7f8057279162786B",
+    LiqEth: "0xd5bd3DC2fD86e917A46f7571708aBB88CbfCc197",
+    LiqEthMint: "0xdBAa1539eB7b80C29d825FCda76c0d7F8F0E6cFB",
+    LiqEthBurn: "0x02e0A02fE2311FAd661677B7117FDdc801c1216b",
+    StakingModule: "0x87047291c3b0D55A551C97B9194A02E1D84e06A9",
+    WithdrawalQueue: "0x7781368720294fE0bB6D97F14fE2E9275fFED071",
+    WithdrawalVault: "0x24457626938d4132556005ecA4d9e6F24F85297E",
 };
 
 export type Contracts<T extends string = ContractName> = Record<T, ContractConfig>;
@@ -67,75 +57,50 @@ export type ContractConfig = {
 // -----------------------------------------------------------------------------
 
 export const CONTRACTS: Contracts<ContractName> = {
-    // Outpost/Stake (wire ABI when available)
-    Stake: { address: ADDRESSES.Stake, abi: undefined as any }, // TODO: Stake artifact
-
-    // liqETH suite
+    Accounting: {
+        address: ADDRESSES.Accounting,
+        abi: AccountingArtifact.abi as JsonFragment[],
+    },
     LiqEth: {
         address: ADDRESSES.LiqEth,
-        abi: undefined as any,
-        // abi: LiqEthArtifact.abi as JsonFragment[],
+        abi: LiqEthArtifact.abi as JsonFragment[],
     },
     DepositManager: {
         address: ADDRESSES.DepositManager,
-        abi: undefined as any,
-        // abi: DepositManagerArtifact.abi as JsonFragment[],
+        abi: DepositManagerArtifact.abi as JsonFragment[],
     },
     LiqEthMint: {
         address: ADDRESSES.LiqEthMint,
-        abi: undefined as any,
-        // abi: LiqEthMintArtifact.abi as JsonFragment[],
+        abi: LiqEthMintArtifact.abi as JsonFragment[],
     },
     LiqEthBurn: {
         address: ADDRESSES.LiqEthBurn,
-        abi: undefined as any,
-        // abi: LiqEthBurnArtifact.abi as JsonFragment[],
-    },
-    LiqEthTreasury: {
-        address: ADDRESSES.LiqEthTreasury,
-        abi: undefined as any,
-        // abi: LiqEthTreasuryArtifact.abi as JsonFragment[],
-    },
-    LiqEthCommon: {
-        address: ADDRESSES.LiqEthCommon,
-        abi: undefined as any,
-        // abi: LiqEthCommonArtifact.abi as JsonFragment[],
-    },
-    RewardsERC20: {
-        address: ADDRESSES.RewardsERC20,
-        abi: undefined as any,
-        // abi: RewardsERC20Artifact.abi as JsonFragment[],
-    },
-    ValidatorBalanceVerifier: {
-        address: ADDRESSES.ValidatorBalanceVerifier,
-        abi: undefined as any,
-        // abi: ValidatorBalanceVerifierArtifact.abi as JsonFragment[],
-    },
-    Yield: {
-        address: ADDRESSES.Yield,
-        abi: undefined as any,
-        // abi: YieldArtifact.abi as JsonFragment[],
-    },
-    Accounting: {
-        address: ADDRESSES.Accounting,
-        abi: undefined as any,
-        // abi: AccountingArtifact.abi as JsonFragment[],
+        abi: LiqEthBurnArtifact.abi as JsonFragment[],
     },
+    // RewardsERC20: {
+    //     address: ADDRESSES.RewardsERC20,
+    //     abi: RewardsERC20Artifact.abi as JsonFragment[],
+    // },
     StakingModule: {
         address: ADDRESSES.StakingModule,
-        abi: undefined as any,
-        // abi: StakingModuleArtifact.abi as JsonFragment[],
+        abi: StakingModuleArtifact.abi as JsonFragment[],
     },
+    // ValidatorBalance: {
+    //     address: ADDRESSES.ValidatorBalance,
+    //     abi: ValidatorBalanceArtifact.abi as JsonFragment[],
+    // },
     WithdrawalQueue: {
         address: ADDRESSES.WithdrawalQueue,
-        abi: undefined as any,
-        // abi: WithdrawalQueueArtifact.abi as JsonFragment[],
+        abi: WithdrawalQueueArtifact.abi as JsonFragment[],
     },
     WithdrawalVault: {
         address: ADDRESSES.WithdrawalVault,
-        abi: undefined as any,
-        // abi: WithdrawalVaultArtifact.abi as JsonFragment[],
+        abi: WithdrawalVaultArtifact.abi as JsonFragment[],
     },
+    // Yield: {
+    //     address: ADDRESSES.Yield,
+    //     abi: YieldArtifact.abi as JsonFragment[],
+    // },
 };
 
 export interface ContractOptions {
@@ -219,19 +184,17 @@ export class EthereumContractService {
             ERC1155Artifact,
 
             // liqETH suite
-            // DepositManagerArtifact,
-            // LiqEthArtifact,
-            // LiqEthMintArtifact,
-            // LiqEthBurnArtifact,
-            // LiqEthTreasuryArtifact,
-            // LiqEthCommonArtifact,
+            AccountingArtifact,
+            DepositManagerArtifact,
+            LiqEthArtifact,
+            LiqEthBurnArtifact,
+            LiqEthMintArtifact,
             // RewardsERC20Artifact,
-            // ValidatorBalanceVerifierArtifact,
+            StakingModuleArtifact,
+            // ValidatorBalanceArtifact,
+            WithdrawalQueueArtifact,
+            WithdrawalVaultArtifact,
             // YieldArtifact,
-            // AccountingArtifact,
-            // StakingModuleArtifact,
-            // WithdrawalQueueArtifact,
-            // WithdrawalVaultArtifact,
         ];
 
         allArtifacts.forEach(artifact => {

package/src/networks/ethereum/ethereum.ts

@@ -17,17 +17,20 @@ export class EthereumStakingClient implements IStakingClient {
     get network() { return this.config.network; }
 
     constructor(private config: StakerConfig) {
-        if (!ethers.providers.Web3Provider.isProvider(config.provider)) {
-            throw new Error('Expected a Web3Provider for Ethereum');
-        }
-        this.provider = config.provider as ethers.providers.Web3Provider;
-        this.signer = this.provider.getSigner();
-        this.pubKey = config.pubKey as WirePubKey;
-
-        this.contractService = new EthereumContractService({
-            provider: this.provider,
-            signer: this.signer,
-        });
+        try {
+            this.provider = config.provider as ethers.providers.Web3Provider;
+            this.signer = this.provider.getSigner();
+            this.pubKey = config.pubKey as WirePubKey;
+            
+            this.contractService = new EthereumContractService({
+                provider: this.provider,
+                signer: this.signer,
+            });
+        }   
+        catch (error) {
+            // console.error('Error initializing EthereumStakingClient:', error);
+            throw error;
+        }     
     }
 
     // ---------------------------------------------------------------------
@@ -108,23 +111,6 @@ export class EthereumStakingClient implements IStakingClient {
         };
     }
 
-    /**
-     * Build, sign, and submit a single transaction that:
-     *  - Corrects other users (if needed) to free available balance, then
-     *  - Registers the caller’s untracked liqSOL.
-     *
-     * @param amount  Optional: register a smaller amount than your full untracked balance.
-     * @returns signature string
-     */
-    async register(amount?: bigint): Promise<string> {
-        try {
-            return 'Not implemented yet for Ethereum';
-        } catch (error) {
-            console.error('Error in register:', error);
-            throw error;
-        }
-    }
-
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -137,56 +123,37 @@ export class EthereumStakingClient implements IStakingClient {
 
         // 1) Native ETH balance
         const nativeBalance = await this.provider.getBalance(walletAddress);
-        const nativeDecimals =
-            this.network?.nativeCurrency?.decimals ?? 18;
-        const nativeSymbol =
-            this.network?.nativeCurrency?.symbol ?? 'ETH';
+        // console.log('nativeBalance', nativeBalance);
+        const nativeDecimals = this.network?.nativeCurrency?.decimals ?? 18;
+        const nativeSymbol = this.network?.nativeCurrency?.symbol ?? 'ETH';
 
         // 2) liqETH ERC-20 balance (actual)
-        const actualBalance: ethers.BigNumber = await this.contract.LiqEth.balanceOf(walletAddress);
-        const liqDecimals = 18;   // if you want, read decimals() once and cache
-        const liqSymbol = 'liqETH';
-
-        // 3) Protocol "tracked" balance (Accounting)
-        let trackedBalance: ethers.BigNumber = actualBalance;
-
-        try {
-            // Adjust this to your real view method:
-            // e.g. function getUserBalance(address user)
-            const result = await this.contract.Accounting.getUserBalance(walletAddress);
-
-            // Support either struct or plain uint256
-            if (result && typeof result === 'object' && 'amount' in result) {
-                trackedBalance = result.amount;
-                // if result.decimals exists and differs, override liqDecimals if desired
-            } else if (result != null) {
-                trackedBalance = result;
-            }
-        } catch (err) {
-            console.warn(
-                '[EthereumStakingClient] getPortfolio: Accounting view unavailable, using actual balance as tracked.',
-                err
-            );
-            trackedBalance = actualBalance;
-        }
+        const liqBalance: ethers.BigNumber = await this.contract.LiqEth.balanceOf(walletAddress);
+        // console.log('liqBalance', liqBalance);
+        
+        const liqDecimals = this.network?.nativeCurrency?.decimals ?? 18;
+        const liqSymbol = 'Liq' + (this.network?.nativeCurrency?.symbol ?? 'ETH');
 
-        return {
+        const portfolio: Portfolio = {
             native: {
                 amount: nativeBalance,
                 decimals: nativeDecimals,
                 symbol: nativeSymbol,
             },
-            actual: {
-                amount: actualBalance,
+            liq: {
+                amount: liqBalance,
                 decimals: liqDecimals,
                 symbol: liqSymbol,
             },
-            tracked: {
-                amount: trackedBalance,
+            staked: { // TODO fetch staked balance from outpost
+                amount: BigNumber.from(0),
                 decimals: liqDecimals,
                 symbol: liqSymbol,
             },
-        };
+            chainID: this.network.chainId
+        }
+        // console.log('ETH PORTFOLIO', portfolio);
+        return portfolio;
     }
 
     // TODO: implement withdraw, claimRewards, etc.

package/src/networks/ethereum/types.ts

@@ -1,20 +1,17 @@
 import { BigNumber, ethers } from 'ethers';
 
 export const CONTRACT_NAMES = [
-    'Stake',
-    'LiqEth',
+    'Accounting',
     'DepositManager',
-    'LiqEthMint',
+    'LiqEth',
     'LiqEthBurn',
-    'LiqEthTreasury',
-    'LiqEthCommon',
-    'RewardsERC20',
-    'ValidatorBalanceVerifier',
-    'Yield',
-    'Accounting',
+    'LiqEthMint',
+    // 'RewardsERC20',
     'StakingModule',
+    // 'ValidatorBalance',
     'WithdrawalQueue',
     'WithdrawalVault',
+    // 'Yield',
 ] as const;
 
 export type ContractName = typeof CONTRACT_NAMES[number];

package/src/networks/solana/solana.ts

@@ -34,13 +34,8 @@ export class SolanaStakingClient implements IStakingClient {
     private distributionClient: DistributionClient;
     private leaderboardClient: LeaderboardClient;
 
-    get solPubKey(): SolPubKey {
-        return new SolPubKey(this.pubKey.data.array);
-    }
-
-    get network() {
-        return this.config.network;
-    }
+    get solPubKey(): SolPubKey { return new SolPubKey(this.pubKey.data.array); }
+    get network() { return this.config.network; }
 
     constructor(private config: StakerConfig) {
         const adapter = config.provider as BaseSignerWalletAdapter;
@@ -101,6 +96,7 @@ export class SolanaStakingClient implements IStakingClient {
                 TOKEN_2022_PROGRAM_ID,
             );
 
+            // Fetch balances and user record in parallel
             const [nativeLamports, actualBalResp, userRecord] = await Promise.all([
                 this.connection.getBalance(user),
                 this.connection.getTokenAccountBalance(userLiqsolAta).catch(() => null),
@@ -110,34 +106,42 @@ export class SolanaStakingClient implements IStakingClient {
             const actualAmountStr = actualBalResp?.value?.amount ?? '0';
             const actualDecimals = actualBalResp?.value?.decimals ?? 9;
 
-            const trackedAmountStr = userRecord?.trackedBalance
-                ? userRecord.trackedBalance.toString()
-                : '0';
+            const trackedAmountStr = userRecord?.trackedBalance ? userRecord.trackedBalance.toString() : '0';
             const trackedDecimals = actualDecimals;
 
+            const nativeSymbol = 'SOL';
+            const liqSymbol = 'LiqSOL';
+
             const portfolio: Portfolio = {
                 native: {
-                    symbol: 'SOL',
-                    decimals: 9,
                     amount: BigInt(nativeLamports),
+                    symbol: nativeSymbol,
+                    decimals: 9,
                 },
-                actual: {
-                    symbol: 'LiqSOL',
-                    decimals: actualDecimals,
+                liq: {
                     amount: BigInt(actualAmountStr),
+                    symbol: liqSymbol,
+                    decimals: actualDecimals,
                 },
-                tracked: {
-                    symbol: 'LiqSOL',
-                    decimals: trackedDecimals,
+                staked: { // TODO: fetch staked balance from outpost
+                    amount: BigInt(0),
+                    symbol: liqSymbol,
+                    decimals: actualDecimals,
+                },
+                tracked: { // SOL ONLY
                     amount: BigInt(trackedAmountStr),
+                    symbol: liqSymbol,
+                    decimals: trackedDecimals,
                 },
                 extras: {
                     userLiqsolAta: userLiqsolAta.toBase58(),
                     reservePoolPDA: reservePoolPDA.toBase58(),
                     vaultPDA: vaultPDA.toBase58(),
                 },
+                chainID: this.network.chainId
             };
 
+            // console.log('SOL PORTFOLIO', portfolio);
             return portfolio;
         }
         catch (error) {
@@ -159,6 +163,19 @@ export class SolanaStakingClient implements IStakingClient {
         // TODO: wire to pay-rate math once we finalize protocol fee API
     }
 
+    /**
+     * Deposit funds into the staking pool.
+     * @param lamports The amount to deposit (in lamports).
+     * @returns The transaction signature.
+     */
+    async deposit(lamports: number): Promise<string> {
+        const { transaction } = await this.depositClient.buildDepositTx(this.solPubKey, lamports);
+        const { tx, blockhash, lastValidBlockHeight } = await this.prepareTx(transaction);
+        const signed = await this.signTransaction(tx);
+        const result = await this.sendAndConfirmHttp(signed, { blockhash, lastValidBlockHeight });
+        return result.signature;
+    }
+
     /**
      * Build, sign, and submit a single transaction that:
      *  - Corrects other users (if needed) to free available balance, then
@@ -167,7 +184,7 @@ export class SolanaStakingClient implements IStakingClient {
      * @param amount  Optional: register a smaller amount than your full untracked balance.
      * @returns signature string
      */
-    async register(amount?: bigint): Promise<string> {
+    async correctBalance(amount?: bigint): Promise<string> {
         try {
             const build = await this.distributionClient.buildCorrectRegisterTx({ amount });
             if (!build.canSucceed || !build.transaction) {
@@ -194,19 +211,6 @@ export class SolanaStakingClient implements IStakingClient {
         }
     }
 
-    /**
-     * Deposit funds into the staking pool.
-     * @param lamports The amount to deposit (in lamports).
-     * @returns The transaction signature.
-     */
-    async deposit(lamports: number): Promise<string> {
-        const { transaction } = await this.depositClient.buildDepositTx(this.solPubKey, lamports);
-        const { tx, blockhash, lastValidBlockHeight } = await this.prepareTx(transaction);
-        const signed = await this.signTransaction(tx);
-        const result = await this.sendAndConfirmHttp(signed, { blockhash, lastValidBlockHeight });
-        return result.signature;
-    }
-
     private async sendAndConfirmHttp(
         signed: SolanaTransaction,
         ctx: { blockhash: string; lastValidBlockHeight: number },

package/src/staker/staker.ts

@@ -32,6 +32,8 @@ export class Staker {
         if (!config) throw new Error('StakerConfig is required');
         if (!Array.isArray(config)) config = [config];
 
+        // console.log('STAKER INIT', config);
+
         config.forEach((cfg) => {
             switch (cfg.network.chainId) {
                 case SolChainID.WireTestnet:
@@ -41,9 +43,10 @@ export class Staker {
                 case EvmChainID.Hoodi:
                     this.clients.set(EvmChainID.Hoodi, new EthereumStakingClient(cfg));
                     break;
+
                 default:
-                    // console.log(`No staking client available for chain ${cfg.network.chainId}`);
-                    // throw new Error(`Unsupported network curve: ${cfg.network.name}`);
+                    console.log(`No staking client available for chain ${cfg.network.chainId}`);
+                    throw new Error(`Unsupported network curve: ${cfg.network.name}`);
             }
         });
 

package/src/staker/types.ts

@@ -2,7 +2,7 @@
 
 import { BaseSignerWalletAdapter } from '@solana/wallet-adapter-base';
 import { PublicKey as SolPubKey } from '@solana/web3.js';
-import { ExternalNetwork, PublicKey } from '@wireio/core';
+import { ChainID, ExternalNetwork, PublicKey } from '@wireio/core';
 import { BigNumberish, ethers } from 'ethers';
 
 export interface IStakingClient {
@@ -13,7 +13,7 @@ export interface IStakingClient {
     deposit(amount: number): Promise<string>;
 
     /** Register any untracked LIQ staked tokens */
-    register(): Promise<string>;
+    // register(): Promise<string>;
 
     /** Fetch the portfolio for the LIQ stake user */
     getPortfolio(): Promise<Portfolio>;
@@ -26,14 +26,19 @@ export type StakerConfig = {
 }
 
 export interface Portfolio {
-    /** Native SOL balance on chain */
+    /** Native balance on chain: ETH, SOL */
     native: BalanceView;
-    /** Actual liquid SOL balance from ATA */
-    actual: BalanceView;
-    /** Tracked liquid SOL balance from distribution program */
-    tracked: BalanceView;
+    /** Actual Liquid  balance of LiqETH, LiqSOL*/
+    liq: BalanceView;
+    /** Outpost Staked balance */
+    staked: BalanceView
+    /** SOL ONLY!
+     * Tracked liqSOL balance from distribution program */
+    tracked?: BalanceView;
     /** Extra PDAs and account addresses */
     extras?: Record<string, any>;
+    /** Chain ID of the network for which this portfolio is from */
+    chainID: ChainID; 
 }
 
 export type BalanceView = {