@wireio/stake 0.2.4 → 0.3.0

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

@@ -0,0 +1,127 @@
+import { BigNumber, ethers } from "ethers";
+import { EthereumContractService } from "../contract";
+import { formatContractErrors, sendOPPFinalize } from "../utils";
+
+export class PretokenClient {
+    private readonly contractService: EthereumContractService;
+    
+    get contract() { return this.contractService.contract; }
+
+    constructor(contract: EthereumContractService) {
+        this.contractService = contract;
+    }
+    
+
+
+    /**
+     * Purchase pretokens by sending ETH to the Depositor.purchasePretokensWithETH(buyer) payable function.
+     * Returns txHash, receipt and parsed PurchasedWithETH event (if present).
+     */
+    // async purchasePretokensWithETH(amountWei: BigNumber, buyer: string): Promise<any> {
+    //     // attempt a simulation of the purchase call
+    //     try {
+    //         await this.contract.Depositor.callStatic.purchasePretokensWithETH(buyer, { value: amountWei });
+    //     } catch (err: any) {
+    //         let errorObj = formatContractErrors(err);
+    //         throw new Error(errorObj.name ?? errorObj.raw)
+    //     }
+
+    //     // attempt the real purchase call
+    //     let tx, receipt;
+    //     try {
+    //         tx = await this.contract.Depositor.purchasePretokensWithETH(buyer, { value: amountWei });
+    //         receipt = await tx.wait(1);
+    //     } catch (err: any) {
+    //         let errorObj = formatContractErrors(err);
+    //         throw new Error(errorObj.name ?? errorObj.raw)
+    //     }
+
+
+    //     // Attempt to parse PurchasedWithETH event
+    //     let purchased: any | undefined;
+    //     const ev = receipt.events?.find((e) => e.event === 'PurchasedWithETH' || e.event === 'PurchasedWithETH(address,uint256,uint256,uint256)');
+
+    //     if (ev && ev.args) {
+    //         // event signature: PurchasedWithETH(address indexed user, uint256 ethIn, uint256 shares, uint256 tokenId)
+    //         const { user, ethIn, shares, tokenId } = ev.args as any;
+
+    //         purchased = {
+    //             buyer: user,
+    //             amount: BigNumber.from(ethIn),
+    //             shares: BigNumber.from(shares),
+    //             tokenId: BigNumber.from(tokenId),
+    //         };
+    //     }
+
+    //     return {
+    //         txHash: tx.hash,
+    //         receipt,
+    //         purchased,
+    //     };
+    // }
+
+    /**
+     * Purchase pretokens by transferring liqETH into the pool (ERC-20) and calling Depositor.purchasePretokensWithLiqETH(amountLiq, buyer).
+     * Returns txHash, receipt and parsed PurchasedWithLiqETH event (if present).
+     */
+    async purchasePretokensWithLiqETH(amountLiq: BigNumber, buyer: string): Promise<any> {
+        // attempt a simulation of the purchase call
+        try {
+            await this.contract.Depositor.callStatic.purchasePretokensWithLiqETH(amountLiq, buyer);
+        } catch (err: any) {
+            let errorObj = formatContractErrors(err);
+
+            // ! TEMP for testing
+            if(errorObj.name == "OPP_PreviousEpochUnsent") {
+                console.error("OPP Previous Epoch is unsent - trigger OPP finalizeEpoch()")
+                await sendOPPFinalize(this.contract.OPP);
+                throw new Error(errorObj.name+` - triggering OPP finalizeEpoch() please try again`);
+            }
+
+            throw new Error(errorObj.name ?? errorObj.raw)
+        }
+
+        // attempt the real purchase call
+        let tx, receipt;
+        try {
+            tx = await this.contract.Depositor.purchasePretokensWithLiqETH(amountLiq, buyer);
+            receipt = await tx.wait(1);
+        } catch (err: any) {
+            let errorObj = formatContractErrors(err);
+            throw new Error(errorObj.name ?? errorObj.raw)
+        }
+
+
+        // Attempt to parse PurchasedWithLiqETH event
+        let purchased: any | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'PurchasedWithLiqETH' || (e.event && e.event.toString().startsWith('PurchasedWithLiqETH')));
+
+        if (ev && ev.args) {
+            // Event shape: PurchasedWithLiqETH(buyer, amountLiq, ethEqWei, shares, tokenId)
+            const args: any = ev.args;
+            // try named fields first, fallback to positional
+            const evtBuyer = args.buyer ?? args[0];
+            const evtAmountLiq = (args.amountLiq ?? args[1]) ? BigNumber.from(args.amountLiq ?? args[1]) : undefined;
+            const evtEthEqWei = (args.ethEqWei ?? args[2]) ? BigNumber.from(args.ethEqWei ?? args[2]) : undefined;
+            const evtShares = (args.shares ?? args[3]) ? BigNumber.from(args.shares ?? args[3]) : undefined;
+            const evtTokenId = (args.tokenId ?? args[4]) ? BigNumber.from(args.tokenId ?? args[4]) : undefined;
+
+            purchased = {
+                buyer: evtBuyer,
+                amountLiq: evtAmountLiq,
+                ethEqWei: evtEthEqWei,
+                shares: evtShares,
+                tokenId: evtTokenId,
+            };
+        }
+
+        return {
+            txHash: tx.hash,
+            receipt,
+            purchased,
+        };
+    }
+
+
+
+}

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

@@ -1,6 +1,7 @@
 import { BigNumber, ethers } from "ethers";
-import { preLaunchReceipt, StakedEvent, StakedResult, WithdrawnStakeEvent, WithdrawnStakeResult } from "../types";
+import { preLaunchReceipt, StakedEvent, WithdrawnStakeEvent, WithdrawnStakeResult } from "../types";
 import { EthereumContractService } from "../contract";
+import { formatContractErrors } from "../utils";
 
 export class StakeClient {
 
@@ -15,19 +16,72 @@ export class StakeClient {
 
 
     /**
-     * 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.
+     * Simulate a stake via callStatic
      */
-    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);
+    async simulateStake(amountWei: BigNumber): Promise<void> {
+        try {
+            await this.contract.Depositor.callStatic.stakeLiqETH(amountWei);
+        } catch (err: any) {
+            let errorObj = formatContractErrors(err);
+            throw new Error(errorObj.name ?? errorObj.raw)
+        }
+    }
+
+
+    /**
+     * Read OPP / Outpost state used by the Depositor to decide whether staking is allowed.
+     * Returns various data
+     */
+    async getOppStatus(): Promise<any> {
+        const depositor = this.contract.Depositor;
+        const opp = this.contract.OPP;
+
+        
+        const oppAddress: string = await depositor.oppAddress();
+        const oppInboundAddress: string = await depositor.oppInboundAddress();
+        const prevEpochSent = await opp.prevEpochSent();
+        
+
+        const inbound = this.contractService.getReadOnly('OPPInbound');
+
+        // Query useful getters
+        const nextEpochBN: any = await inbound.nextEpochNum();
+        const pendingEpochRaw: any = await inbound.pendingEpoch();
+        const pendingMessageCount: any = await inbound.pendingMessageCount();
+        const previousEpochHash: string = await inbound.previousEpochHash();
+        const nextEpochNum = (nextEpochBN && typeof nextEpochBN.toNumber === 'function') ? nextEpochBN.toNumber() : Number(nextEpochBN || 0);
+
+        const pendingEpoch = (pendingEpochRaw && pendingEpochRaw.epochNumber !== undefined)
+            ? {
+                epochNumber: (pendingEpochRaw.epochNumber && typeof pendingEpochRaw.epochNumber.toNumber === 'function') ? pendingEpochRaw.epochNumber.toNumber() : Number(pendingEpochRaw.epochNumber || 0),
+                timestamp: (pendingEpochRaw.timestamp && typeof pendingEpochRaw.timestamp.toNumber === 'function') ? pendingEpochRaw.timestamp.toNumber() : Number(pendingEpochRaw.timestamp || 0),
+                prevEpochHash: pendingEpochRaw.prevEpochHash,
+                merkleRoot: pendingEpochRaw.merkleRoot,
+                firstMessageID: pendingEpochRaw.firstMessageID,
+                lastMessageID: pendingEpochRaw.lastMessageID,
+            }
+            : null;
+
+        const pendingMessagesBN = pendingMessageCount;
+        const pendingMessages = (pendingMessagesBN && typeof pendingMessagesBN.toString === 'function') ? pendingMessagesBN.toString() : String(pendingMessagesBN || '0');
+
+        const hasPendingMessages = (pendingMessagesBN && typeof pendingMessagesBN.gt === 'function') ? pendingMessagesBN.gt(0) : (Number(pendingMessages) > 0);
+
+        return {
+            oppAddress,
+            prevEpochSent,
+            oppInboundAddress,
+            nextEpochNum,
+            pendingEpoch,
+            pendingMessageCount: pendingMessages,
+            previousEpochHash,
+            hasPendingMessages,
+            raw: {
+                nextEpochBN,
+                pendingEpochRaw,
+                pendingMessageCount: pendingMessagesBN,
+            },
+        };
     }
 
 
@@ -36,12 +90,17 @@ export class StakeClient {
      * @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);
+    async performStake(amountWei: BigNumber, signerAddress: string): Promise<any> {
+        const depositor = this.contract.Depositor.address;
+        const liqRead = this.contract.LiqEth;
+        const bal = await liqRead.balanceOf(signerAddress);
+        const allowance = await liqRead.allowance(signerAddress, depositor);
+
+        const paused = await this.contract.Depositor.paused();
+        if(paused) {
+            throw new Error("Error - Depositor is in a paused state");
+        }
+
 
         // if allowance is less than the requested stake amount, request permission to spend LiqEth
         if (allowance.lt(amountWei)) {
@@ -50,17 +109,20 @@ export class StakeClient {
             // 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);
+            console.warn(`allowance insufficient (${allowance.toString()} < ${amountWei.toString()}); sending approve(${depositor}, ${approveAmount.toString()})`);
+            const approveTx = await liqWrite.approve(depositor, approveAmount);
             await approveTx.wait(1);
 
             // re-read allowance to ensure approval succeeded
-            const newAllowance = await liq.allowance(signerAddress, depositorAddress);
+            const newAllowance = await liqRead.allowance(signerAddress, depositor);
             if (newAllowance.lt(amountWei)) {
                 throw new Error('Approval failed or allowance still insufficient after approve');
             }
         }
         
+        
+        await this.simulateStake(amountWei);
+
 
         // send the tx to stake liqeth
         const tx = await this.contract.Depositor.stakeLiqETH(amountWei);
@@ -150,7 +212,6 @@ export class StakeClient {
         for (const idBN of tokenIds) {
             try {
                 const receiptData = await receiptContract.getReceipt(idBN);
-
                 const formattedReceipt = {
                     account: receiptData.account,
                     currency: receiptData.currency,
@@ -169,7 +230,8 @@ export class StakeClient {
                     timestamp: new Date(Number(receiptData.timestamp.toString()) * 1000).toLocaleString(),
                 }
 
-                results.push({ tokenId: idBN.toBigInt(), receipt: formattedReceipt } as any);
+                // Only fetch staking receipts (kind 1 is a wire pretoken receipt)
+                if(receiptData.kind == 0) 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);
@@ -177,6 +239,7 @@ export class StakeClient {
             }
         }
 
+        console.log('results of prelaunch receipts', results)
         return results;
     }
 

package/src/networks/ethereum/contract.ts

@@ -6,8 +6,6 @@
 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 LiqEthMintArtifact from '../../assets/ethereum/ABI/liqEth/liqEthMint.sol/LiqEthMint.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';
@@ -20,13 +18,9 @@ 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 PretokenArtifact from '../../assets/ethereum/ABI/outpost/Pretoken.sol/Pretoken.json';
+import AggregatorArtifact from '../../assets/ethereum/ABI/outpost/Aggregator.sol/Aggregator.json';
+import EthUsdPriceConsumerArtifact from '../../assets/ethereum/ABI/outpost/EthUsdPriceConsumer.sol/EthUsdPriceConsumer.json';
 
 import ERC20Artifact from '../../assets/ethereum/ABI/token/ERC20Token.sol/ERC20Token.json';
 import ERC721Artifact from '../../assets/ethereum/ABI/token/ERC721Token.sol/ERC721Token.json';
@@ -47,23 +41,28 @@ export const ERC1155Abi = ERC1155Artifact.abi;
 
 // Make sure ContractName in ./types includes all of these keys.
 export const ADDRESSES: AddressBook = {
-    Accounting: "0xDf9da63E9CD14c79bD9f0E8F2E797096A40B6031",
-    DepositManager: "0x3fEd507e554cd0e973CeCAf2168526b1617418d3",
-    LiqEth: "0x1dA6aB23c2E2fA0a52C74F7f4189F770ED1eF9B3",
-    StakingModule: "0xBd13C85fdefBBc63904e7301aCdeFE87c9C93234",
-    WithdrawalQueue: "0xD9A1D38ae4A636DEf20B02F35387a6b126D73fAe", //aka "queue"
-    WithdrawalVault: "0x150334D09a1d3d30EE93d5e6009EB897B5dDF5b2", //aka withdrawVault
+    Accounting: "0xd333A03a44D5d602A98c1B7bcd7ED1f042DD0dEd",
+    DepositManager: "0x601eaA31e8d33D8725786f1733f4cE6cCEf740D4",
+    LiqEth: "0x08252e1Dcbaa86A2887927b02536CD3E67a802c8", // AKA LiqEthToken
+    StakingModule: "0x7Aac2fCfc83d7F2f15eA53a10C1677CA377AFcF4",
+    WithdrawalQueue: "0x951E413FC81a2CE133078ABE8B88677F5296abE7",
+    WithdrawalVault: "0x0D2bf834DD560839e986d42D06DeE268A17c2d13",
+
+    // LiqEthAuthority: "0x7A9cf59EC53F32577Cc8200466Cc7693713129D5",
+    // BeaconState: "0xD3860E5977C94b343341635a2dEEBD20B651c48f",
+    // YieldOracle: "0x307b35816674913cf122975B3CF912b5709653F3",
     
-
     //Outpost contracts
-    Depositor: "0x6aE1D7095B81970654Bd51bCAD42825C6E579088",
-    ReceiptNFT: "0x38eAEa05cB1FFD0c8426A3f9e77815a251DdC197",
-    OutpostManager: "0x6512bB8E7f8418A8e3bB73c49E33EcC30F53f221",
-    BAR: "0x00c128A37598d018Eb8ca4f516688695D83bD413",
-    OPP: "0x8C5710103Ec6a7608dAC539DC232d3822bA3d14C",
-    OPPCommon: "0x52C1d7F02B35176F79b03F6eF7E5b74b27d1dB8c",
-    OPPInbound: "0x39feC7536BaEd4E376b1B5cf2f2e8182ab203418",
-    Warrant: "0x9190bBcaB5cfeb4b7b6DE5Ae21105F3114753F10",
+    Depositor: "0x69Aa53Ef02F124dB421AeDda509d6912341299Cc",
+    ReceiptNFT: "0x13588fF41E2f47D047874162B1eD15AaF6818f5a",
+    OutpostManager: "0x187f4fEDBCAD2f3150120B743b5d568F11dD3452",
+    BAR: "0x27d4646abF638A13934c94f8bA9AC1Bda39F5dbb",
+    OPP: "0x79CA2DE915C294593edc16b32CBA8B7866159205",
+    OPPCommon: "0x8392ea945Cd8C03F5241d4964D20BB5A9c320c71",
+    OPPInbound: "0xfDA9A2C7e395a9722d9fa506f5d67aba823298dd",
+    Pretoken: "0xcf6A1209A7A391cc576174204386F4e5462323dC",
+    EthUsdPriceConsumer: "0x1Ef180FF49313fCB8B5c0470268295d0d24CDE69",
+    Aggregator: "0xFCfc3ddd4CBd9Ad3b3af3A374B8bdA1b66eE6FFF",
 };
 
 export type Contracts<T extends string = ContractName> = Record<T, ContractConfig>;
@@ -90,26 +89,10 @@ 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[],
-    // },
-    // RewardsERC20: {
-    //     address: ADDRESSES.RewardsERC20,
-    //     abi: RewardsERC20Artifact.abi as JsonFragment[],
-    // },
     StakingModule: {
         address: ADDRESSES.StakingModule,
         abi: StakingModuleArtifact.abi as JsonFragment[],
     },
-    // ValidatorBalance: {
-    //     address: ADDRESSES.ValidatorBalance,
-    //     abi: ValidatorBalanceArtifact.abi as JsonFragment[],
-    // },
     WithdrawalQueue: {
         address: ADDRESSES.WithdrawalQueue,
         abi: WithdrawalQueueArtifact.abi as JsonFragment[],
@@ -118,11 +101,6 @@ export const CONTRACTS: Contracts<ContractName> = {
         address: ADDRESSES.WithdrawalVault,
         abi: WithdrawalVaultArtifact.abi as JsonFragment[],
     },
-    // Yield: {
-    //     address: ADDRESSES.Yield,
-    //     abi: YieldArtifact.abi as JsonFragment[],
-    // },
-
 
     // Outpost Contracts
     Depositor: {
@@ -153,9 +131,17 @@ export const CONTRACTS: Contracts<ContractName> = {
         address: ADDRESSES.OPPInbound,
         abi: OPPInboundArtifact.abi as JsonFragment[],
     },
-    Warrant: {
-        address: ADDRESSES.Warrant,
-        abi: WarrantArtifact.abi as JsonFragment[],
+    Pretoken: {
+        address: ADDRESSES.Pretoken,
+        abi: PretokenArtifact.abi as JsonFragment[],
+    },
+    Aggregator: {
+        address: ADDRESSES.Aggregator,
+        abi: AggregatorArtifact.abi as JsonFragment[],
+    },
+    EthUsdPriceConsumer: {
+        address: ADDRESSES.EthUsdPriceConsumer,
+        abi: EthUsdPriceConsumerArtifact.abi as JsonFragment[],
     }
 };