@atomiqlabs/chain-evm 1.0.0-dev.38 → 1.0.0-dev.40

package/src/chains/citrea/CitreaBtcRelay.ts

@@ -1,58 +1,58 @@
-import {EVMBtcRelay} from "../../evm/btcrelay/EVMBtcRelay";
-import {BtcBlock} from "@atomiqlabs/base";
-import {getLogger} from "../../utils/Utils";
-import {CitreaFees} from "./CitreaFees";
-
-const logger = getLogger("CitreaBtcRelay: ");
-
-export class CitreaBtcRelay<B extends BtcBlock> extends EVMBtcRelay<B> {
-
-    public static StateDiffSize = {
-        STATE_DIFF_PER_BLOCKHEADER: 22,
-        STATE_DIFF_BASE: 30
-    }
-
-    /**
-     * Estimate required synchronization fee (worst case) to synchronize btc relay to the required blockheight
-     *
-     * @param requiredBlockheight
-     * @param feeRate
-     */
-    public async estimateSynchronizeFee(requiredBlockheight: number, feeRate?: string): Promise<bigint> {
-        feeRate ??= await this.Chain.Fees.getFeeRate();
-        const tipData = await this.getTipData();
-        const currBlockheight = tipData.blockheight;
-
-        const blockheightDelta = requiredBlockheight-currBlockheight;
-
-        if(blockheightDelta<=0) return 0n;
-
-        const numTxs = Math.ceil(blockheightDelta / this.maxHeadersPerTx);
-
-        const synchronizationFee = (BigInt(blockheightDelta) * await this.getFeePerBlock(feeRate))
-            + CitreaFees.getGasFee(
-                EVMBtcRelay.GasCosts.GAS_BASE_MAIN * numTxs,
-                feeRate,
-                CitreaBtcRelay.StateDiffSize.STATE_DIFF_BASE * numTxs
-            );
-        logger.debug("estimateSynchronizeFee(): required blockheight: "+requiredBlockheight+
-            " blockheight delta: "+blockheightDelta+" fee: "+synchronizationFee.toString(10));
-
-        return synchronizationFee;
-    }
-
-    /**
-     * Returns fee required (in native token) to synchronize a single block to btc relay
-     *
-     * @param feeRate
-     */
-    public async getFeePerBlock(feeRate?: string): Promise<bigint> {
-        feeRate ??= await this.Chain.Fees.getFeeRate();
-        return CitreaFees.getGasFee(
-            EVMBtcRelay.GasCosts.GAS_PER_BLOCKHEADER,
-            feeRate,
-            CitreaBtcRelay.StateDiffSize.STATE_DIFF_PER_BLOCKHEADER
-        );
-    }
-
+import {EVMBtcRelay} from "../../evm/btcrelay/EVMBtcRelay";
+import {BtcBlock} from "@atomiqlabs/base";
+import {getLogger} from "../../utils/Utils";
+import {CitreaFees} from "./CitreaFees";
+
+const logger = getLogger("CitreaBtcRelay: ");
+
+export class CitreaBtcRelay<B extends BtcBlock> extends EVMBtcRelay<B> {
+
+    public static StateDiffSize = {
+        STATE_DIFF_PER_BLOCKHEADER: 22,
+        STATE_DIFF_BASE: 30
+    }
+
+    /**
+     * Estimate required synchronization fee (worst case) to synchronize btc relay to the required blockheight
+     *
+     * @param requiredBlockheight
+     * @param feeRate
+     */
+    public async estimateSynchronizeFee(requiredBlockheight: number, feeRate?: string): Promise<bigint> {
+        feeRate ??= await this.Chain.Fees.getFeeRate();
+        const tipData = await this.getTipData();
+        const currBlockheight = tipData.blockheight;
+
+        const blockheightDelta = requiredBlockheight-currBlockheight;
+
+        if(blockheightDelta<=0) return 0n;
+
+        const numTxs = Math.ceil(blockheightDelta / this.maxHeadersPerTx);
+
+        const synchronizationFee = (BigInt(blockheightDelta) * await this.getFeePerBlock(feeRate))
+            + CitreaFees.getGasFee(
+                EVMBtcRelay.GasCosts.GAS_BASE_MAIN * numTxs,
+                feeRate,
+                CitreaBtcRelay.StateDiffSize.STATE_DIFF_BASE * numTxs
+            );
+        logger.debug("estimateSynchronizeFee(): required blockheight: "+requiredBlockheight+
+            " blockheight delta: "+blockheightDelta+" fee: "+synchronizationFee.toString(10));
+
+        return synchronizationFee;
+    }
+
+    /**
+     * Returns fee required (in native token) to synchronize a single block to btc relay
+     *
+     * @param feeRate
+     */
+    public async getFeePerBlock(feeRate?: string): Promise<bigint> {
+        feeRate ??= await this.Chain.Fees.getFeeRate();
+        return CitreaFees.getGasFee(
+            EVMBtcRelay.GasCosts.GAS_PER_BLOCKHEADER,
+            feeRate,
+            CitreaBtcRelay.StateDiffSize.STATE_DIFF_PER_BLOCKHEADER
+        );
+    }
+
 }

package/src/chains/citrea/CitreaChainType.ts

@@ -1,28 +1,28 @@
-import {ChainType} from "@atomiqlabs/base";
-import {EVMPreFetchVerification} from "../../evm/swaps/modules/EVMSwapInit";
-import {EVMTx} from "../../evm/chain/modules/EVMTransactions";
-import {EVMSigner} from "../../evm/wallet/EVMSigner";
-import {EVMSwapData} from "../../evm/swaps/EVMSwapData";
-import {EVMChainInterface} from "../../evm/chain/EVMChainInterface";
-import {EVMChainEventsBrowser} from "../../evm/events/EVMChainEventsBrowser";
-import { EVMSpvVaultData } from "../../evm/spv_swap/EVMSpvVaultData";
-import { EVMSpvWithdrawalData } from "../../evm/spv_swap/EVMSpvWithdrawalData";
-import {CitreaSwapContract} from "./CitreaSwapContract";
-import {CitreaBtcRelay} from "./CitreaBtcRelay";
-import {CitreaSpvVaultContract} from "./CitreaSpvVaultContract";
-
-export type CitreaChainType = ChainType<
-    "CITREA",
-    never,
-    EVMPreFetchVerification,
-    EVMTx,
-    EVMSigner,
-    EVMSwapData,
-    CitreaSwapContract,
-    EVMChainInterface<"CITREA", 5115>,
-    EVMChainEventsBrowser,
-    CitreaBtcRelay<any>,
-    EVMSpvVaultData,
-    EVMSpvWithdrawalData,
-    CitreaSpvVaultContract
->;
+import {ChainType} from "@atomiqlabs/base";
+import {EVMPreFetchVerification} from "../../evm/swaps/modules/EVMSwapInit";
+import {EVMTx} from "../../evm/chain/modules/EVMTransactions";
+import {EVMSigner} from "../../evm/wallet/EVMSigner";
+import {EVMSwapData} from "../../evm/swaps/EVMSwapData";
+import {EVMChainInterface} from "../../evm/chain/EVMChainInterface";
+import {EVMChainEventsBrowser} from "../../evm/events/EVMChainEventsBrowser";
+import { EVMSpvVaultData } from "../../evm/spv_swap/EVMSpvVaultData";
+import { EVMSpvWithdrawalData } from "../../evm/spv_swap/EVMSpvWithdrawalData";
+import {CitreaSwapContract} from "./CitreaSwapContract";
+import {CitreaBtcRelay} from "./CitreaBtcRelay";
+import {CitreaSpvVaultContract} from "./CitreaSpvVaultContract";
+
+export type CitreaChainType = ChainType<
+    "CITREA",
+    never,
+    EVMPreFetchVerification,
+    EVMTx,
+    EVMSigner,
+    EVMSwapData,
+    CitreaSwapContract,
+    EVMChainInterface<"CITREA", 5115>,
+    EVMChainEventsBrowser,
+    CitreaBtcRelay<any>,
+    EVMSpvVaultData,
+    EVMSpvWithdrawalData,
+    CitreaSpvVaultContract
+>;

package/src/chains/citrea/CitreaFees.ts

@@ -1,77 +1,77 @@
-import {EVMFees} from "../../evm/chain/modules/EVMFees";
-import {getLogger} from "../../utils/Utils";
-
-export class CitreaFees extends EVMFees {
-
-    public static readonly StateDiffSize = {
-        APPROVE_DIFF_SIZE: 40,
-    };
-
-    protected readonly logger = getLogger("CitreaFees: ");
-
-    private _blockFeeCache: {
-        timestamp: number,
-        feeRate: Promise<{baseFee: bigint, l1Fee: bigint}>
-    } = null;
-
-    /**
-     * Gets evm fee rate
-     *
-     * @private
-     * @returns {Promise<bigint>} L1 gas price denominated in Wei
-     */
-    private async __getFeeRate(): Promise<{baseFee: bigint, l1Fee: bigint}> {
-        const res = await this.provider.send("eth_getBlockByNumber", ["latest", false]);
-        const l1Fee = BigInt(res.l1FeeRate);
-        const baseFee = BigInt(res.baseFeePerGas) * this.feeMultiplierPPM / 1_000_000n;
-
-        this.logger.debug("__getFeeRate(): Base fee rate: "+baseFee.toString(10)+", l1 fee rate: "+l1Fee.toString(10));
-
-        return {baseFee, l1Fee};
-    }
-
-    /**
-     * Gets the gas price with caching, format: <gas price in Wei>;<transaction version: v1/v3>
-     *
-     * @private
-     */
-    public async getFeeRate(): Promise<string> {
-        if(this._blockFeeCache==null || Date.now() - this._blockFeeCache.timestamp > this.MAX_FEE_AGE) {
-            let obj = {
-                timestamp: Date.now(),
-                feeRate: null
-            };
-            obj.feeRate = this.__getFeeRate().catch(e => {
-                if(this._blockFeeCache===obj) this._blockFeeCache=null;
-                throw e;
-            });
-            this._blockFeeCache = obj;
-        }
-
-        let {baseFee, l1Fee} = await this._blockFeeCache.feeRate;
-        if(baseFee>this.maxFeeRatePerGas) baseFee = this.maxFeeRatePerGas;
-
-        const fee = baseFee.toString(10)+","+this.priorityFee.toString(10)+","+l1Fee.toString(10);
-
-        this.logger.debug("getFeeRate(): calculated fee: "+fee);
-
-        return fee;
-    }
-
-
-    /**
-     * Calculates the total gas fee paid for a given gas limit and state diff size at a given fee rate
-     *
-     * @param gas
-     * @param stateDiffSize
-     * @param feeRate
-     */
-    public static getGasFee(gas: number, feeRate: string, stateDiffSize: number = 0): bigint {
-        if(feeRate==null) return 0n;
-
-        const [maxFee, priorityFee, l1StateDiffFee] = feeRate.split(",");
-
-        return (BigInt(gas) * BigInt(maxFee)) + (BigInt(stateDiffSize) * BigInt(l1StateDiffFee ?? 0n));
-    }
-
-}
+import {EVMFees} from "../../evm/chain/modules/EVMFees";
+import {getLogger} from "../../utils/Utils";
+
+export class CitreaFees extends EVMFees {
+
+    public static readonly StateDiffSize = {
+        APPROVE_DIFF_SIZE: 40,
+    };
+
+    protected readonly logger = getLogger("CitreaFees: ");
+
+    private _blockFeeCache: {
+        timestamp: number,
+        feeRate: Promise<{baseFee: bigint, l1Fee: bigint}>
+    } = null;
+
+    /**
+     * Gets evm fee rate
+     *
+     * @private
+     * @returns {Promise<bigint>} L1 gas price denominated in Wei
+     */
+    private async __getFeeRate(): Promise<{baseFee: bigint, l1Fee: bigint}> {
+        const res = await this.provider.send("eth_getBlockByNumber", ["latest", false]);
+        const l1Fee = BigInt(res.l1FeeRate);
+        const baseFee = BigInt(res.baseFeePerGas) * this.feeMultiplierPPM / 1_000_000n;
+
+        this.logger.debug("__getFeeRate(): Base fee rate: "+baseFee.toString(10)+", l1 fee rate: "+l1Fee.toString(10));
+
+        return {baseFee, l1Fee};
+    }
+
+    /**
+     * Gets the gas price with caching, format: <gas price in Wei>;<transaction version: v1/v3>
+     *
+     * @private
+     */
+    public async getFeeRate(): Promise<string> {
+        if(this._blockFeeCache==null || Date.now() - this._blockFeeCache.timestamp > this.MAX_FEE_AGE) {
+            let obj = {
+                timestamp: Date.now(),
+                feeRate: null
+            };
+            obj.feeRate = this.__getFeeRate().catch(e => {
+                if(this._blockFeeCache===obj) this._blockFeeCache=null;
+                throw e;
+            });
+            this._blockFeeCache = obj;
+        }
+
+        let {baseFee, l1Fee} = await this._blockFeeCache.feeRate;
+        if(baseFee>this.maxFeeRatePerGas) baseFee = this.maxFeeRatePerGas;
+
+        const fee = baseFee.toString(10)+","+this.priorityFee.toString(10)+","+l1Fee.toString(10);
+
+        this.logger.debug("getFeeRate(): calculated fee: "+fee);
+
+        return fee;
+    }
+
+
+    /**
+     * Calculates the total gas fee paid for a given gas limit and state diff size at a given fee rate
+     *
+     * @param gas
+     * @param stateDiffSize
+     * @param feeRate
+     */
+    public static getGasFee(gas: number, feeRate: string, stateDiffSize: number = 0): bigint {
+        if(feeRate==null) return 0n;
+
+        const [maxFee, priorityFee, l1StateDiffFee] = feeRate.split(",");
+
+        return (BigInt(gas) * BigInt(maxFee)) + (BigInt(stateDiffSize) * BigInt(l1StateDiffFee ?? 0n));
+    }
+
+}