@atomiqlabs/chain-evm 1.0.0-dev.50 → 1.0.0-dev.52

package/dist/evm/events/EVMChainEventsBrowserWS.d.ts

@@ -1,66 +0,0 @@
-import { ChainEvents, ClaimEvent, EventListener, InitializeEvent, RefundEvent, SpvVaultClaimEvent, SpvVaultCloseEvent, SpvVaultDepositEvent, SpvVaultFrontEvent, SpvVaultOpenEvent } from "@atomiqlabs/base";
-import { IClaimHandler } from "../swaps/handlers/claim/ClaimHandlers";
-import { EVMSwapData } from "../swaps/EVMSwapData";
-import { Block, EventFilter, Log, WebSocketProvider } from "ethers";
-import { EVMSwapContract } from "../swaps/EVMSwapContract";
-import { EVMSpvVaultContract } from "../spv_swap/EVMSpvVaultContract";
-import { EVMChainInterface } from "../chain/EVMChainInterface";
-import { TypedEventLog } from "../typechain/common";
-import { EscrowManager } from "../swaps/EscrowManagerTypechain";
-import { SpvVaultManager } from "../spv_swap/SpvVaultContractTypechain";
-import { EVMTxTrace } from "../chain/modules/EVMTransactions";
-type AtomiqTypedEvent = (TypedEventLog<EscrowManager["filters"]["Initialize" | "Refund" | "Claim"]> | TypedEventLog<SpvVaultManager["filters"]["Opened" | "Deposited" | "Fronted" | "Claimed" | "Closed"]>);
-/**
- * EVM on-chain event handler for front-end systems without access to fs, uses WS or long-polling to subscribe, might lose
- *  out on some events if the network is unreliable, front-end systems should take this into consideration and not
- *  rely purely on events
- */
-export declare class EVMChainEventsBrowserWS implements ChainEvents<EVMSwapData> {
-    protected readonly listeners: EventListener<EVMSwapData>[];
-    protected readonly provider: WebSocketProvider;
-    protected readonly chainInterface: EVMChainInterface;
-    protected readonly evmSwapContract: EVMSwapContract;
-    protected readonly evmSpvVaultContract: EVMSpvVaultContract<any>;
-    protected readonly logger: import("../../utils/Utils").LoggerType;
-    protected readonly spvVaultContractLogFilter: EventFilter;
-    protected readonly swapContractLogFilter: EventFilter;
-    protected unconfirmedEventQueue: AtomiqTypedEvent[];
-    protected stopped: boolean;
-    constructor(chainInterface: EVMChainInterface, evmSwapContract: EVMSwapContract, evmSpvVaultContract: EVMSpvVaultContract<any>);
-    findInitSwapData(call: EVMTxTrace, escrowHash: string, claimHandler: IClaimHandler<any, any>): EVMSwapData;
-    /**
-     * Returns async getter for fetching on-demand initialize event swap data
-     *
-     * @param event
-     * @param claimHandler
-     * @private
-     * @returns {() => Promise<EVMSwapData>} getter to be passed to InitializeEvent constructor
-     */
-    private getSwapDataGetter;
-    protected parseInitializeEvent(event: TypedEventLog<EscrowManager["filters"]["Initialize"]>): InitializeEvent<EVMSwapData>;
-    protected parseRefundEvent(event: TypedEventLog<EscrowManager["filters"]["Refund"]>): RefundEvent<EVMSwapData>;
-    protected parseClaimEvent(event: TypedEventLog<EscrowManager["filters"]["Claim"]>): ClaimEvent<EVMSwapData>;
-    protected parseSpvOpenEvent(event: TypedEventLog<SpvVaultManager["filters"]["Opened"]>): SpvVaultOpenEvent;
-    protected parseSpvDepositEvent(event: TypedEventLog<SpvVaultManager["filters"]["Deposited"]>): SpvVaultDepositEvent;
-    protected parseSpvFrontEvent(event: TypedEventLog<SpvVaultManager["filters"]["Fronted"]>): SpvVaultFrontEvent;
-    protected parseSpvClaimEvent(event: TypedEventLog<SpvVaultManager["filters"]["Claimed"]>): SpvVaultClaimEvent;
-    protected parseSpvCloseEvent(event: TypedEventLog<SpvVaultManager["filters"]["Closed"]>): SpvVaultCloseEvent;
-    /**
-     * Processes event as received from the chain, parses it & calls event listeners
-     *
-     * @param events
-     * @param currentBlock
-     * @protected
-     */
-    protected processEvents(events: AtomiqTypedEvent[], currentBlock?: Block): Promise<void>;
-    protected handleEvents(events: AtomiqTypedEvent[]): Promise<void>;
-    protected spvVaultContractListener: (log: Log) => void;
-    protected swapContractListener: (log: Log) => void;
-    protected blockListener: (blockNumber: number) => Promise<void>;
-    protected setupWebsocket(): Promise<void>;
-    init(): Promise<void>;
-    stop(): Promise<void>;
-    registerListener(cbk: EventListener<EVMSwapData>): void;
-    unregisterListener(cbk: EventListener<EVMSwapData>): boolean;
-}
-export {};

package/dist/evm/events/EVMChainEventsBrowserWS.js

@@ -1,264 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVMChainEventsBrowserWS = void 0;
-const base_1 = require("@atomiqlabs/base");
-const EVMSwapData_1 = require("../swaps/EVMSwapData");
-const ethers_1 = require("ethers");
-const Utils_1 = require("../../utils/Utils");
-const EVMSpvVaultContract_1 = require("../spv_swap/EVMSpvVaultContract");
-/**
- * EVM on-chain event handler for front-end systems without access to fs, uses WS or long-polling to subscribe, might lose
- *  out on some events if the network is unreliable, front-end systems should take this into consideration and not
- *  rely purely on events
- */
-class EVMChainEventsBrowserWS {
-    constructor(chainInterface, evmSwapContract, evmSpvVaultContract) {
-        this.listeners = [];
-        this.logger = (0, Utils_1.getLogger)("EVMChainEventsBrowser: ");
-        this.unconfirmedEventQueue = [];
-        this.chainInterface = chainInterface;
-        this.provider = chainInterface.provider;
-        this.evmSwapContract = evmSwapContract;
-        this.evmSpvVaultContract = evmSpvVaultContract;
-        this.spvVaultContractLogFilter = {
-            address: this.evmSpvVaultContract.contractAddress
-        };
-        this.swapContractLogFilter = {
-            address: this.evmSwapContract.contractAddress
-        };
-    }
-    findInitSwapData(call, escrowHash, claimHandler) {
-        if (call.to.toLowerCase() === this.evmSwapContract.contractAddress.toLowerCase()) {
-            const result = this.evmSwapContract.parseCalldata(call.input);
-            if (result != null && result.name === "initialize") {
-                //Found, check correct escrow hash
-                const [escrowData, signature, timeout, extraData] = result.args;
-                const escrow = EVMSwapData_1.EVMSwapData.deserializeFromStruct(escrowData, claimHandler);
-                if ("0x" + escrow.getEscrowHash() === escrowHash) {
-                    const extraDataHex = (0, ethers_1.hexlify)(extraData);
-                    if (extraDataHex.length > 2) {
-                        escrow.setExtraData(extraDataHex.substring(2));
-                    }
-                    return escrow;
-                }
-            }
-        }
-        for (let _call of call.calls) {
-            const found = this.findInitSwapData(_call, escrowHash, claimHandler);
-            if (found != null)
-                return found;
-        }
-        return null;
-    }
-    /**
-     * Returns async getter for fetching on-demand initialize event swap data
-     *
-     * @param event
-     * @param claimHandler
-     * @private
-     * @returns {() => Promise<EVMSwapData>} getter to be passed to InitializeEvent constructor
-     */
-    getSwapDataGetter(event, claimHandler) {
-        return async () => {
-            const trace = await this.chainInterface.Transactions.traceTransaction(event.transactionHash);
-            if (trace == null)
-                return null;
-            return this.findInitSwapData(trace, event.args.escrowHash, claimHandler);
-        };
-    }
-    parseInitializeEvent(event) {
-        const escrowHash = event.args.escrowHash.substring(2);
-        const claimHandlerHex = event.args.claimHandler;
-        const claimHandler = this.evmSwapContract.claimHandlersByAddress[claimHandlerHex.toLowerCase()];
-        if (claimHandler == null) {
-            this.logger.warn("parseInitializeEvent(" + escrowHash + "): Unknown claim handler with claim: " + claimHandlerHex);
-            return null;
-        }
-        const swapType = claimHandler.getType();
-        this.logger.debug("InitializeEvent escrowHash: " + escrowHash);
-        return new base_1.InitializeEvent(escrowHash, swapType, (0, Utils_1.onceAsync)(this.getSwapDataGetter(event, claimHandler)));
-    }
-    parseRefundEvent(event) {
-        const escrowHash = event.args.escrowHash.substring(2);
-        this.logger.debug("RefundEvent escrowHash: " + escrowHash);
-        return new base_1.RefundEvent(escrowHash);
-    }
-    parseClaimEvent(event) {
-        const escrowHash = event.args.escrowHash.substring(2);
-        const claimHandlerHex = event.args.claimHandler;
-        const claimHandler = this.evmSwapContract.claimHandlersByAddress[claimHandlerHex.toLowerCase()];
-        if (claimHandler == null) {
-            this.logger.warn("parseClaimEvent(" + escrowHash + "): Unknown claim handler with claim: " + claimHandlerHex);
-            return null;
-        }
-        const witnessResult = event.args.witnessResult.substring(2);
-        this.logger.debug("ClaimEvent witnessResult: " + witnessResult + " escrowHash: " + escrowHash);
-        return new base_1.ClaimEvent(escrowHash, witnessResult);
-    }
-    parseSpvOpenEvent(event) {
-        const owner = event.args.owner;
-        const vaultId = event.args.vaultId;
-        const btcTxId = Buffer.from(event.args.btcTxHash.substring(2), "hex").reverse().toString("hex");
-        const vout = Number(event.args.vout);
-        this.logger.debug("SpvOpenEvent owner: " + owner + " vaultId: " + vaultId + " utxo: " + btcTxId + ":" + vout);
-        return new base_1.SpvVaultOpenEvent(owner, vaultId, btcTxId, vout);
-    }
-    parseSpvDepositEvent(event) {
-        const [owner, vaultId] = (0, EVMSpvVaultContract_1.unpackOwnerAndVaultId)(event.args.ownerAndVaultId);
-        const amounts = [event.args.amount0, event.args.amount1];
-        const depositCount = Number(event.args.depositCount);
-        this.logger.debug("SpvDepositEvent owner: " + owner + " vaultId: " + vaultId + " depositCount: " + depositCount + " amounts: ", amounts);
-        return new base_1.SpvVaultDepositEvent(owner, vaultId, amounts, depositCount);
-    }
-    parseSpvFrontEvent(event) {
-        const [owner, vaultId] = (0, EVMSpvVaultContract_1.unpackOwnerAndVaultId)(event.args.ownerAndVaultId);
-        const btcTxId = Buffer.from(event.args.btcTxHash.substring(2), "hex").reverse().toString("hex");
-        const recipient = event.args.recipient;
-        const executionHash = event.args.executionHash;
-        const amounts = [event.args.amount0, event.args.amount1];
-        const frontingAddress = event.args.caller;
-        this.logger.debug("SpvFrontEvent owner: " + owner + " vaultId: " + vaultId + " btcTxId: " + btcTxId +
-            " recipient: " + recipient + " frontedBy: " + frontingAddress + " amounts: ", amounts);
-        return new base_1.SpvVaultFrontEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, frontingAddress);
-    }
-    parseSpvClaimEvent(event) {
-        const [owner, vaultId] = (0, EVMSpvVaultContract_1.unpackOwnerAndVaultId)(event.args.ownerAndVaultId);
-        const btcTxId = Buffer.from(event.args.btcTxHash.substring(2), "hex").reverse().toString("hex");
-        const recipient = event.args.recipient;
-        const executionHash = event.args.executionHash;
-        const amounts = [event.args.amount0, event.args.amount1];
-        const caller = event.args.caller;
-        const frontingAddress = event.args.frontingAddress;
-        const withdrawCount = Number(event.args.withdrawCount);
-        this.logger.debug("SpvClaimEvent owner: " + owner + " vaultId: " + vaultId + " btcTxId: " + btcTxId + " withdrawCount: " + withdrawCount +
-            " recipient: " + recipient + " frontedBy: " + frontingAddress + " claimedBy: " + caller + " amounts: ", amounts);
-        return new base_1.SpvVaultClaimEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, caller, frontingAddress, withdrawCount);
-    }
-    parseSpvCloseEvent(event) {
-        const btcTxId = Buffer.from(event.args.btcTxHash.substring(2), "hex").reverse().toString("hex");
-        return new base_1.SpvVaultCloseEvent(event.args.owner, event.args.vaultId, btcTxId, event.args.error);
-    }
-    /**
-     * Processes event as received from the chain, parses it & calls event listeners
-     *
-     * @param events
-     * @param currentBlock
-     * @protected
-     */
-    async processEvents(events, currentBlock) {
-        const parsedEvents = [];
-        for (let event of events) {
-            let parsedEvent;
-            switch (event.eventName) {
-                case "Claim":
-                    parsedEvent = this.parseClaimEvent(event);
-                    break;
-                case "Refund":
-                    parsedEvent = this.parseRefundEvent(event);
-                    break;
-                case "Initialize":
-                    parsedEvent = this.parseInitializeEvent(event);
-                    break;
-                case "Opened":
-                    parsedEvent = this.parseSpvOpenEvent(event);
-                    break;
-                case "Deposited":
-                    parsedEvent = this.parseSpvDepositEvent(event);
-                    break;
-                case "Fronted":
-                    parsedEvent = this.parseSpvFrontEvent(event);
-                    break;
-                case "Claimed":
-                    parsedEvent = this.parseSpvClaimEvent(event);
-                    break;
-                case "Closed":
-                    parsedEvent = this.parseSpvCloseEvent(event);
-                    break;
-            }
-            const timestamp = event.blockNumber === currentBlock?.number ? currentBlock.timestamp : await this.chainInterface.Blocks.getBlockTime(event.blockNumber);
-            parsedEvent.meta = {
-                blockTime: timestamp,
-                txId: event.transactionHash,
-                timestamp //Maybe deprecated
-            };
-            parsedEvents.push(parsedEvent);
-        }
-        for (let listener of this.listeners) {
-            await listener(parsedEvents);
-        }
-    }
-    handleEvents(events) {
-        if (this.chainInterface.config.safeBlockTag === "latest" || this.chainInterface.config.safeBlockTag === "pending") {
-            return this.processEvents(events);
-        }
-        this.unconfirmedEventQueue.push(...events);
-    }
-    async setupWebsocket() {
-        await this.provider.on(this.spvVaultContractLogFilter, this.spvVaultContractListener = (log) => {
-            let events = this.evmSpvVaultContract.Events.toTypedEvents([log]);
-            events = events.filter(val => !val.removed);
-            this.handleEvents(events);
-        });
-        await this.provider.on(this.swapContractLogFilter, this.swapContractListener = (log) => {
-            let events = this.evmSwapContract.Events.toTypedEvents([log]);
-            events = events.filter(val => !val.removed && (val.eventName === "Initialize" || val.eventName === "Refund" || val.eventName === "Claim"));
-            this.handleEvents(events);
-        });
-        const safeBlockTag = this.chainInterface.config.safeBlockTag;
-        let processing = false;
-        if (safeBlockTag !== "latest" && safeBlockTag !== "pending")
-            await this.provider.on("block", this.blockListener = async (blockNumber) => {
-                if (processing)
-                    return;
-                processing = true;
-                try {
-                    const latestSafeBlock = await this.provider.getBlock(this.chainInterface.config.safeBlockTag);
-                    const events = [];
-                    this.unconfirmedEventQueue = this.unconfirmedEventQueue.filter(event => {
-                        if (event.blockNumber <= latestSafeBlock.number) {
-                            events.push(event);
-                            return false;
-                        }
-                        return true;
-                    });
-                    const blocks = {};
-                    for (let event of events) {
-                        const block = blocks[event.blockNumber] ?? (blocks[event.blockNumber] = await this.provider.getBlock(event.blockNumber));
-                        if (block.hash === event.blockHash) {
-                            //Valid event
-                            await this.processEvents([event], block);
-                        }
-                        else {
-                            //Block hash doesn't match
-                        }
-                    }
-                }
-                catch (e) {
-                    this.logger.error(`on('block'): Error when processing new block ${blockNumber}:`, e);
-                }
-                processing = false;
-            });
-    }
-    async init() {
-        await this.setupWebsocket();
-        this.stopped = false;
-    }
-    async stop() {
-        this.stopped = true;
-        await this.provider.off(this.spvVaultContractLogFilter, this.spvVaultContractListener);
-        await this.provider.off(this.swapContractLogFilter, this.swapContractListener);
-        await this.provider.off("block", this.blockListener);
-    }
-    registerListener(cbk) {
-        this.listeners.push(cbk);
-    }
-    unregisterListener(cbk) {
-        const index = this.listeners.indexOf(cbk);
-        if (index >= 0) {
-            this.listeners.splice(index, 1);
-            return true;
-        }
-        return false;
-    }
-}
-exports.EVMChainEventsBrowserWS = EVMChainEventsBrowserWS;