@wireio/stake 0.1.3 → 0.2.1

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": "AY6sWK1dt23rkAiqiETwaEcbjhJCwb5cNC6hVWadZLFf",
+  "address": "HEAKvfg2X7K4zbGDiAbfuu5abxQyk1HbKVgskZZFXrUx",
   "metadata": {
     "name": "liqsolToken",
     "version": "0.1.0",

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": "5Nf6jL5B2qkMbnLoN3RTT1sKcBKrrsRnovTBDZXcQnfo",
+  "address": "BcMW7wN54FexYaB7Xujvag5uUQ1WoDoGbzVg1VEXPBhV",
   "metadata": {
     "name": "validatorLeaderboard",
     "version": "0.1.0",

package/src/index.ts

@@ -15,4 +15,5 @@ export * from './networks/solana/utils';
 // CLIENTS
 export * from './networks/solana/clients/deposit.client';
 export * from './networks/solana/clients/distribution.client';
-export * from './networks/solana/clients/leaderboard.client';
+export * from './networks/solana/clients/leaderboard.client';
+export * from './networks/solana/clients/outpost.client';

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

@@ -0,0 +1,82 @@
+import { BigNumber, ethers } from "ethers";
+import { DepositEvent, DepositResult } from "../types";
+import { EthereumContractService } from "../contract";
+
+export class DepositClient {
+
+    private readonly contractService: EthereumContractService;
+    
+    get contract() { return this.contractService.contract; }
+
+    constructor(contract: EthereumContractService) {
+        this.contractService = contract;
+    }
+    
+
+    /**
+     * Simulate a deposit via callStatic.
+     *
+     * Useful for pre-flight checks; will throw with the same revert
+     * reason as a real tx if it would fail.
+     */
+    async simulateDeposit(amount: number | string | bigint | BigNumber): Promise<void> {
+        const amountWei = BigNumber.isBigNumber(amount)
+            ? amount
+            : BigNumber.from(amount);
+
+        // callStatic executes the function locally without sending a tx.
+        // deposit() doesn't return anything, so we only care if it reverts.
+        await this.contract.DepositManager.callStatic.deposit({
+            value: amountWei,
+        });
+    }
+
+
+
+    /**
+     * 
+     * @param amountWei an amount of WEI to deposit in exchange for liqETH
+     * @returns the hash of the transaction
+     */
+    async performDeposit(amountWei: BigNumber): Promise<DepositResult> {
+        // Pre-check minDeposit
+        const minDeposit: BigNumber = await this.contract.DepositManager.minDeposit();
+        if (amountWei.lt(minDeposit)) {
+            throw new Error(
+                `Deposit amount below minDeposit: ` +
+                `amount=${ethers.utils.formatEther(amountWei)} ETH, ` +
+                `min=${ethers.utils.formatEther(minDeposit)} ETH`
+            );
+        }
+
+        // Send the payable tx
+        const tx = await this.contract.DepositManager.deposit({
+            value: amountWei,
+        });
+
+        // Wait for 1 confirmation 
+        const receipt = await tx.wait(1);
+
+        // Parse Deposited event if present
+        let deposited: DepositEvent | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'Deposited');
+
+        if (ev && ev.args) {
+            const { user, netEth, fee, shares } = ev.args;
+            deposited = {
+                user,
+                netEth: BigNumber.from(netEth),
+                fee: BigNumber.from(fee),
+                shares: BigNumber.from(shares),
+            };
+        }
+
+        return {
+            txHash: tx.hash,
+            receipt,
+            deposited,
+        };
+    }
+
+
+}

package/src/networks/ethereum/clients/stake.client.ts

@@ -0,0 +1,215 @@
+import { BigNumber, ethers } from "ethers";
+import { preLaunchReceipt, StakedEvent, StakedResult, WithdrawnStakeEvent, WithdrawnStakeResult } from "../types";
+import { EthereumContractService } from "../contract";
+
+export class StakeClient {
+
+    private readonly contractService: EthereumContractService;
+    
+    get contract() { return this.contractService.contract; }
+
+    constructor(contract: EthereumContractService) {
+        this.contractService = contract;
+    }
+    
+
+
+    /**
+     * Simulate a stake via callStatic.
+     *
+     * Useful for pre-flight checks; will throw with the same revert
+     * reason as a real tx if it would fail.
+     */
+    async simulateStake(amount: number | string | bigint | BigNumber): Promise<void> {
+        const amountWei = BigNumber.isBigNumber(amount)
+            ? amount
+            : BigNumber.from(amount);
+
+        // callStatic executes the function locally without sending a tx.
+        // stakeLiqEth() doesn't return anything, so we only care if it reverts.
+        await this.contract.Depositor.callStatic.stakeLiqETH(amountWei);
+    }
+
+
+    /**
+     * 
+     * @param amountWei an amount of liqETH (in WEI) to stake to the Outpost
+     * @returns txHash (hash of the transaction), receipt, Staked event
+     */
+    async performStake(amountWei: BigNumber, signerAddress: string): Promise<StakedResult> {
+        const liq = this.contract.LiqEth;
+        const depositorAddress = this.contract.Depositor.address;
+        
+        // check allowance
+        const allowance = await liq.allowance(signerAddress, depositorAddress);
+
+        // if allowance is less than the requested stake amount, request permission to spend LiqEth
+        if (allowance.lt(amountWei)) {
+            const liqWrite = this.contractService.getWrite('LiqEth');
+
+            // currently requested unlimited amount - potentially change to only request up to the current amount?
+            const approveAmount = ethers.constants.MaxUint256;
+
+            console.warn(`allowance insufficient (${allowance.toString()} < ${amountWei.toString()}); sending approve(${depositorAddress}, ${approveAmount.toString()})`);
+            const approveTx = await liqWrite.approve(depositorAddress, approveAmount);
+            await approveTx.wait(1);
+
+            // re-read allowance to ensure approval succeeded
+            const newAllowance = await liq.allowance(signerAddress, depositorAddress);
+            if (newAllowance.lt(amountWei)) {
+                throw new Error('Approval failed or allowance still insufficient after approve');
+            }
+        }
+        
+
+        // send the tx to stake liqeth
+        const tx = await this.contract.Depositor.stakeLiqETH(amountWei);
+
+        // Wait for 1 confirmation 
+        const receipt = await tx.wait(1);
+
+        // Parse Staked event if present
+        let staked: StakedEvent | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'Staked');
+
+        if (ev && ev.args) {
+            const { user, amountLiq, shares, tokenId } = ev.args;
+            staked = {
+                user,
+                amountLiq: BigNumber.from(amountLiq),
+                shares: BigNumber.from(shares),
+                tokenId: BigNumber.from(tokenId)
+            };
+        }
+
+        return {
+            txHash: tx.hash,
+            receipt,
+            staked,
+        };
+    }
+
+
+
+    async getOwnedTokenIdsFor(
+        owner: string,
+        fromBlock = 1850820,
+        toBlock: number | string = "latest"
+    ): Promise<BigNumber[]> {
+        const receiptContract = this.contract.ReceiptNFT;
+
+        // Logs where address received tokens
+        const toLogs = await receiptContract.queryFilter(
+            receiptContract.filters.Transfer(null, owner),
+            fromBlock,
+            toBlock
+        );
+
+        // Logs where address sent tokens (including burns from owner → 0)
+        const fromLogs = await receiptContract.queryFilter(
+            receiptContract.filters.Transfer(owner, null),
+            fromBlock,
+            toBlock
+        );
+
+        const owned = new Set<string>();
+
+        // Add all received tokenIds
+        for (const e of toLogs) {
+            const tokenId = e.args?.tokenId;
+            if (!tokenId) continue;
+            owned.add(tokenId.toString());
+        }
+
+        // Remove all sent tokenIds
+        for (const e of fromLogs) {
+            const tokenId = e.args?.tokenId;
+            if (!tokenId) continue;
+            owned.delete(tokenId.toString());
+        }
+
+        // Convert to BigNumbers
+        return Array.from(owned).map((id) => BigNumber.from(id));
+    }
+
+
+    /**
+     * 
+     * @param amountWei an amount of liqETH (in WEI) to stake to the Outpost
+     * @returns txHash (hash of the transaction), receipt, WithdrawnStake event
+     */
+    async fetchPreLaunchReceipts(address: string): Promise<preLaunchReceipt[]> {
+        const receiptContract = this.contract.ReceiptNFT;
+
+        // first figure out which tokenIds this address owns, from events
+        const tokenIds = await this.getOwnedTokenIdsFor(address);
+
+        const results: preLaunchReceipt[] = [];
+
+        // next fetch on-chain receipt data just for those ids
+        for (const idBN of tokenIds) {
+            try {
+                const receiptData = await receiptContract.getReceipt(idBN);
+
+                const formattedReceipt = {
+                    account: receiptData.account,
+                    currency: receiptData.currency,
+                    kind: receiptData.kind,
+                    indexAtMint: receiptData.indexAtMint.toBigInt(),
+                    principal: {
+                        amount: receiptData.principal.toBigInt(),
+                        decimals: 18,
+                        symbol: "LiqETH"
+                    },
+                    shares: {
+                        amount: receiptData.shares.toBigInt(),
+                        decimals: 18,
+                        symbol: "LiqETH"
+                    },
+                    timestamp: new Date(Number(receiptData.timestamp.toString()) * 1000).toLocaleString(),
+                }
+
+                results.push({ tokenId: idBN.toBigInt(), receipt: formattedReceipt } as any);
+            } catch (err) {
+                // in case of any mismatch or race, just skip this id
+                console.warn(`Failed to load receipt for tokenId=${idBN.toString()}`, err);
+                continue;
+            }
+        }
+
+        return results;
+    }
+
+
+    /**
+     * 
+     * @param amountWei an amount of liqETH (in WEI) to stake to the Outpost
+     * @returns txHash (hash of the transaction), receipt, WithdrawnStake event
+     */
+    async performWithdrawStake(tokenId: BigNumber, recipient: string): Promise<WithdrawnStakeResult> {
+        // Send the payable tx
+        const tx = await this.contract.Depositor.withdrawStake(tokenId, recipient);
+
+        // Wait for 1 confirmation 
+        const receipt = await tx.wait(1);
+
+        // Parse Staked event if present
+        let withdrawnstake: WithdrawnStakeEvent | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'WithdrawnStake');
+
+        if (ev && ev.args) {
+            const { user, tokenOut, tokenId } = ev.args;
+            withdrawnstake = {
+                user: user,
+                tokenOut: BigNumber.from(tokenOut),
+                tokenId: BigNumber.from(tokenId)
+            };
+        }
+
+        return {
+            txHash: tx.hash,
+            receipt,
+            withdrawnstake,
+        };
+    }
+}

package/src/networks/ethereum/contract.ts

@@ -6,14 +6,26 @@
 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 LiqEthBurnArtifact from '../../assets/ethereum/ABI/liqEth/liqEthBurn.sol/LiqEthBurn.json';
+// import LiqEthMintArtifact from '../../assets/ethereum/ABI/liqEth/liqEthMint.sol/LiqEthMint.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';
+
+// Outpost Artifacts
+import DepositorArtifact from '../../assets/ethereum/ABI/outpost/Depositor.sol/Depositor.json';
+import ReceiptNFTArtifact from '../../assets/ethereum/ABI/outpost/ReceiptNFT.sol/ReceiptNFT.json';
+import OutpostManagerArtifact from '../../assets/ethereum/ABI/outpost/OutpostManager.sol/OutpostManager.json';
+import BARArtifact from '../../assets/ethereum/ABI/outpost/BAR.sol/BAR.json';
+import OPPArtifact from '../../assets/ethereum/ABI/outpost/OPP.sol/OPP.json';
+import OPPCommonArtifact from '../../assets/ethereum/ABI/outpost/OPPCommon.sol/OPPCommon.json';
+import OPPInboundArtifact from '../../assets/ethereum/ABI/outpost/OPPInbound.sol/OPPInbound.json';
+import WarrantArtifact from '../../assets/ethereum/ABI/outpost/Warrant.sol/Warrant.json';
+
+// Currently Unused Artifacts
+// import LiqEthCommonArtifact from '../../assets/ethereum/ABI/liqEth/liqEthCommon.sol/liqEthCommon.json';
+// import RewardsERC20Artifact from '../../assets/ethereum/ABI/liqEth/RewardsERC20.sol/RewardsERC20.json';
+// import ValidatorBalanceArtifact from '../../assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/ValidatorBalanceVerifier.json';
 // import YieldArtifact from '../../assets/ethereum/ABI/liqEth/Yield.sol/YieldOracle.json';
 
 import ERC20Artifact from '../../assets/ethereum/ABI/token/ERC20Token.sol/ERC20Token.json';
@@ -35,14 +47,26 @@ export const ERC1155Abi = ERC1155Artifact.abi;
 
 // Make sure ContractName in ./types includes all of these keys.
 export const ADDRESSES: AddressBook = {
-    Accounting: "0xd51CC479c25dc7Cd23f568Ef5c1AdE1671a4D15b",
-    DepositManager: "0x2249D309f086363ABF5057Ae7f8057279162786B",
-    LiqEth: "0xd5bd3DC2fD86e917A46f7571708aBB88CbfCc197",
-    LiqEthMint: "0xdBAa1539eB7b80C29d825FCda76c0d7F8F0E6cFB",
-    LiqEthBurn: "0x02e0A02fE2311FAd661677B7117FDdc801c1216b",
-    StakingModule: "0x87047291c3b0D55A551C97B9194A02E1D84e06A9",
-    WithdrawalQueue: "0x7781368720294fE0bB6D97F14fE2E9275fFED071",
-    WithdrawalVault: "0x24457626938d4132556005ecA4d9e6F24F85297E",
+    Accounting: "0xDf9da63E9CD14c79bD9f0E8F2E797096A40B6031",
+    DepositManager: "0x3fEd507e554cd0e973CeCAf2168526b1617418d3",
+    LiqEth: "0x1dA6aB23c2E2fA0a52C74F7f4189F770ED1eF9B3",
+    StakingModule: "0xBd13C85fdefBBc63904e7301aCdeFE87c9C93234",
+    WithdrawalQueue: "0xD9A1D38ae4A636DEf20B02F35387a6b126D73fAe", //aka "queue"
+    WithdrawalVault: "0x150334D09a1d3d30EE93d5e6009EB897B5dDF5b2", //aka withdrawVault
+
+    //not in last set of deployments 12/18/25
+    // LiqEthMint: "0xdBAa1539eB7b80C29d825FCda76c0d7F8F0E6cFB",
+    // LiqEthBurn: "0x02e0A02fE2311FAd661677B7117FDdc801c1216b",
+
+    //Outpost contracts
+    Depositor: "0x0876f5f411651dFc67386Bc3D36315a3B2249F2e",
+    ReceiptNFT: "0x726c91fB3218A745Bfec0302B4cBaeBeaA023a6d",
+    OutpostManager: "0xB6Eb20f7916295853a318581eCB51Be4eeb107Fe",
+    BAR: "0x1936EB941361da83EE0E68FB7Bd0DF210f090B5C",
+    OPP: "0x2e4cc69D6F8CEC3eEec81F3051AD90fEa71e5D57",
+    OPPCommon: "0xA79fB9e563cF70190346D66eA20A1F2E09e0f732",
+    OPPInbound: "0xd63644d0e8c3610eEf9f0Fd5Ea884b962762c469",
+    Warrant: "0x8613F6Bb9ad883e81338EF97A06c53459250c625",
 };
 
 export type Contracts<T extends string = ContractName> = Record<T, ContractConfig>;
@@ -69,14 +93,14 @@ export const CONTRACTS: Contracts<ContractName> = {
         address: ADDRESSES.DepositManager,
         abi: DepositManagerArtifact.abi as JsonFragment[],
     },
-    LiqEthMint: {
-        address: ADDRESSES.LiqEthMint,
-        abi: LiqEthMintArtifact.abi as JsonFragment[],
-    },
-    LiqEthBurn: {
-        address: ADDRESSES.LiqEthBurn,
-        abi: LiqEthBurnArtifact.abi as JsonFragment[],
-    },
+    // LiqEthMint: {
+    //     address: ADDRESSES.LiqEthMint,
+    //     abi: LiqEthMintArtifact.abi as JsonFragment[],
+    // },
+    // LiqEthBurn: {
+    //     address: ADDRESSES.LiqEthBurn,
+    //     abi: LiqEthBurnArtifact.abi as JsonFragment[],
+    // },
     // RewardsERC20: {
     //     address: ADDRESSES.RewardsERC20,
     //     abi: RewardsERC20Artifact.abi as JsonFragment[],
@@ -101,6 +125,41 @@ export const CONTRACTS: Contracts<ContractName> = {
     //     address: ADDRESSES.Yield,
     //     abi: YieldArtifact.abi as JsonFragment[],
     // },
+
+
+    // Outpost Contracts
+    Depositor: {
+        address: ADDRESSES.Depositor,
+        abi: DepositorArtifact.abi as JsonFragment[],
+    },
+    ReceiptNFT: {
+        address: ADDRESSES.ReceiptNFT,
+        abi: ReceiptNFTArtifact.abi as JsonFragment[],
+    },
+    OutpostManager: {
+        address: ADDRESSES.OutpostManager,
+        abi: OutpostManagerArtifact.abi as JsonFragment[],
+    },
+    BAR: {
+        address: ADDRESSES.BAR,
+        abi: BARArtifact.abi as JsonFragment[],
+    },
+    OPP: {
+        address: ADDRESSES.OPP,
+        abi: OPPArtifact.abi as JsonFragment[],
+    },
+    OPPCommon: {
+        address: ADDRESSES.OPPCommon,
+        abi: OPPCommonArtifact.abi as JsonFragment[],
+    },
+    OPPInbound: {
+        address: ADDRESSES.OPPInbound,
+        abi: OPPInboundArtifact.abi as JsonFragment[],
+    },
+    Warrant: {
+        address: ADDRESSES.Warrant,
+        abi: WarrantArtifact.abi as JsonFragment[],
+    }
 };
 
 export interface ContractOptions {
@@ -187,8 +246,8 @@ export class EthereumContractService {
             AccountingArtifact,
             DepositManagerArtifact,
             LiqEthArtifact,
-            LiqEthBurnArtifact,
-            LiqEthMintArtifact,
+            // LiqEthBurnArtifact,
+            // LiqEthMintArtifact,
             // RewardsERC20Artifact,
             StakingModuleArtifact,
             // ValidatorBalanceArtifact,