@wireio/stake 0.4.0 → 0.4.2

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

@@ -0,0 +1,129 @@
+import { BigNumber } from "ethers";
+import { preLaunchReceipt } from "../types";
+import { EthereumContractService } from "../contract";
+import { ReceiptNFTKind } from "../../../types";
+
+export class ReceiptClient {
+
+    private readonly contractService: EthereumContractService;
+    
+    get contract() { return this.contractService.contract; }
+
+    constructor(contract: EthereumContractService) {
+        this.contractService = contract;
+    }
+
+
+
+    async allReceipts(address: string): Promise<preLaunchReceipt[]> {
+        return this.fetchPreLaunchReceipts(address);
+    }
+
+    async stakeReceipts(address: string): Promise<preLaunchReceipt[]> {
+        return this.fetchPreLaunchReceipts(address, ReceiptNFTKind.STAKE);
+    }
+    
+    async pretokenReceipts(address: string): Promise<preLaunchReceipt[]> {
+        return this.fetchPreLaunchReceipts(address, ReceiptNFTKind.PRETOKEN_PURCHASE);
+    }
+
+
+
+    /**
+     * 
+     * @param address (string) to fetch receipts for
+     * @returns preLaunchReceipt[]
+     */
+    async fetchPreLaunchReceipts(address: string, type?: ReceiptNFTKind): 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);
+
+                //skip any receipt not of the requested type
+                if(type !== undefined && receiptData.kind !== type) continue;
+
+                results.push({ 
+                    tokenId: idBN.toBigInt(), 
+                    receipt: {
+                        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(),
+                    }
+                });
+            } 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;
+    }
+
+
+
+
+    private async getOwnedTokenIdsFor(
+        owner: string,
+        fromBlock = 0,
+        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));
+    }
+
+
+
+}

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

@@ -1,5 +1,5 @@
 import { BigNumber, ethers } from "ethers";
-import { preLaunchReceipt, StakedEvent, WithdrawnStakeEvent, WithdrawnStakeResult } from "../types";
+import { StakedEvent, WithdrawnStakeEvent, WithdrawnStakeResult } from "../types";
 import { EthereumContractService } from "../contract";
 import { formatContractErrors } from "../utils";
 
@@ -28,62 +28,6 @@ export class StakeClient {
     }
 
 
-    /**
-     * 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,
-            },
-        };
-    }
-
 
     /**
      * 
@@ -153,97 +97,6 @@ export class StakeClient {
 
 
 
-    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(),
-                }
-
-                // 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);
-                continue;
-            }
-        }
-
-        console.log('results of prelaunch receipts', results)
-        return results;
-    }
-
-
     /**
      * 
      * @param amountWei an amount of liqETH (in WEI) to stake to the Outpost

package/src/networks/ethereum/contract.ts

@@ -21,6 +21,7 @@ import OPPInboundArtifact from '../../assets/ethereum/ABI/outpost/OPPInbound.sol
 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 PoolArtifact from '../../assets/ethereum/ABI/outpost/Pool.sol/Pool.json';
 
 import ERC20Artifact from '../../assets/ethereum/ABI/token/ERC20Token.sol/ERC20Token.json';
 import ERC721Artifact from '../../assets/ethereum/ABI/token/ERC721Token.sol/ERC721Token.json';
@@ -41,6 +42,7 @@ export const ERC1155Abi = ERC1155Artifact.abi;
 
 // Make sure ContractName in ./types includes all of these keys.
 export const ADDRESSES: AddressBook = {
+    // LiqETH contracts
     Accounting: "0xd333A03a44D5d602A98c1B7bcd7ED1f042DD0dEd",
     DepositManager: "0x601eaA31e8d33D8725786f1733f4cE6cCEf740D4",
     LiqEth: "0x08252e1Dcbaa86A2887927b02536CD3E67a802c8", // AKA LiqEthToken
@@ -48,10 +50,6 @@ export const ADDRESSES: AddressBook = {
     WithdrawalQueue: "0x951E413FC81a2CE133078ABE8B88677F5296abE7",
     WithdrawalVault: "0x0D2bf834DD560839e986d42D06DeE268A17c2d13",
 
-    // LiqEthAuthority: "0x7A9cf59EC53F32577Cc8200466Cc7693713129D5",
-    // BeaconState: "0xD3860E5977C94b343341635a2dEEBD20B651c48f",
-    // YieldOracle: "0x307b35816674913cf122975B3CF912b5709653F3",
-    
     //Outpost contracts
     Depositor: "0x69Aa53Ef02F124dB421AeDda509d6912341299Cc",
     ReceiptNFT: "0x13588fF41E2f47D047874162B1eD15AaF6818f5a",
@@ -63,6 +61,7 @@ export const ADDRESSES: AddressBook = {
     Pretoken: "0xcf6A1209A7A391cc576174204386F4e5462323dC",
     EthUsdPriceConsumer: "0x1Ef180FF49313fCB8B5c0470268295d0d24CDE69",
     Aggregator: "0xFCfc3ddd4CBd9Ad3b3af3A374B8bdA1b66eE6FFF",
+    Pool: "0x29DEf0fA009e02d108d9505018EAe0168F233e03",
 };
 
 export type Contracts<T extends string = ContractName> = Record<T, ContractConfig>;
@@ -142,6 +141,10 @@ export const CONTRACTS: Contracts<ContractName> = {
     EthUsdPriceConsumer: {
         address: ADDRESSES.EthUsdPriceConsumer,
         abi: EthUsdPriceConsumerArtifact.abi as JsonFragment[],
+    },
+    Pool: {
+        address: ADDRESSES.Pool,
+        abi: PoolArtifact.abi as JsonFragment[],
     }
 };