@atomiqlabs/chain-evm 2.3.0 → 2.4.1

package/dist/chains/alpen/AlpenInitializer.js

@@ -120,7 +120,7 @@ function initializeAlpen(options, bitcoinRpc, network) {
         maxParallelCalls: options?.evmConfig?.maxParallelCalls ?? 5,
         useAccessLists: options?.evmConfig?.useAccessLists,
         defaultAccessListAddresses: options?.evmConfig?.defaultAccessListAddresses
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
     const btcRelay = new EVMBtcRelay_1.EVMBtcRelay(chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract, options.btcRelayDeploymentHeight ?? defaultContractAddresses.btcRelayDeploymentHeight);
     const swapContract = new EVMSwapContract_1.EVMSwapContract(chainInterface, btcRelay, options.swapContract ?? defaultContractAddresses.swapContract, {
         refund: {

package/dist/chains/botanix/BotanixInitializer.js

@@ -102,7 +102,7 @@ function initializeBotanix(options, bitcoinRpc, network) {
             type: "timer",
             delayMs: 1000
         }
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
     const btcRelay = new EVMBtcRelay_1.EVMBtcRelay(chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract, options.btcRelayDeploymentHeight ?? defaultContractAddresses.btcRelayDeploymentHeight);
     const swapContract = new EVMSwapContract_1.EVMSwapContract(chainInterface, btcRelay, options.swapContract ?? defaultContractAddresses.swapContract, {
         refund: {

package/dist/chains/citrea/CitreaInitializer.js

@@ -111,7 +111,7 @@ function initializeCitrea(options, bitcoinRpc, network) {
         maxParallelCalls: options?.evmConfig?.maxParallelCalls ?? 5,
         useAccessLists: options?.evmConfig?.useAccessLists,
         defaultAccessListAddresses: options?.evmConfig?.defaultAccessListAddresses
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
     chainInterface.Tokens = new CitreaTokens_1.CitreaTokens(chainInterface); //Override with custom token module allowing l1 state diff based fee calculation
     const btcRelay = new CitreaBtcRelay_1.CitreaBtcRelay(chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract, options.btcRelayDeploymentHeight ?? defaultContractAddresses.btcRelayDeploymentHeight);
     const swapContract = new CitreaSwapContract_1.CitreaSwapContract(chainInterface, btcRelay, options.swapContract ?? defaultContractAddresses.swapContract, {

package/dist/chains/goat/GoatInitializer.js

@@ -130,7 +130,7 @@ function initializeGoat(options, bitcoinRpc, network) {
         maxParallelCalls: options?.evmConfig?.maxParallelCalls ?? 5,
         useAccessLists: options?.evmConfig?.useAccessLists,
         defaultAccessListAddresses: options?.evmConfig?.defaultAccessListAddresses
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
     const btcRelay = new EVMBtcRelay_1.EVMBtcRelay(chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract, options.btcRelayDeploymentHeight ?? defaultContractAddresses.btcRelayDeploymentHeight);
     const swapContract = new EVMSwapContract_1.EVMSwapContract(chainInterface, btcRelay, options.swapContract ?? defaultContractAddresses.swapContract, {
         refund: {

package/dist/evm/chain/EVMChainInterface.d.ts

@@ -1,4 +1,4 @@
-import { ChainInterface, TransactionConfirmationOptions } from "@atomiqlabs/base";
+import { BitcoinNetwork, ChainInterface, TransactionConfirmationOptions } from "@atomiqlabs/base";
 import { LoggerType } from "../../utils/Utils";
 import { JsonRpcApiProvider, Signer, Transaction, TransactionRequest } from "ethers";
 import { EVMBlocks, EVMBlockTag } from "./modules/EVMBlocks";
@@ -107,7 +107,8 @@ export declare class EVMChainInterface<ChainId extends string = string> implemen
      * @internal
      */
     protected logger: LoggerType;
-    constructor(chainId: ChainId, evmChainId: number, provider: JsonRpcApiProvider, config: EVMConfiguration, retryPolicy?: EVMRetryPolicy, evmFeeEstimator?: EVMFees);
+    private readonly bitcoinNetwork?;
+    constructor(chainId: ChainId, evmChainId: number, provider: JsonRpcApiProvider, config: EVMConfiguration, retryPolicy?: EVMRetryPolicy, evmFeeEstimator?: EVMFees, bitcoinNetwork?: BitcoinNetwork);
     /**
      * @inheritDoc
      */
@@ -184,6 +185,10 @@ export declare class EVMChainInterface<ChainId extends string = string> implemen
      * @inheritDoc
      */
     getTxIdStatus(txId: string): Promise<"not_found" | "pending" | "success" | "reverted">;
+    /**
+     * @inheritDoc
+     */
+    getTxId(signedTX: Transaction): Promise<string>;
     /**
      * @inheritDoc
      */
@@ -207,4 +212,5 @@ export declare class EVMChainInterface<ChainId extends string = string> implemen
      * @inheritDoc
      */
     wrapSigner(signer: Signer): Promise<EVMSigner>;
+    verifyNetwork(bitcoinNetwork: BitcoinNetwork): Promise<void>;
 }

package/dist/evm/chain/EVMChainInterface.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EVMChainInterface = void 0;
+const base_1 = require("@atomiqlabs/base");
 const Utils_1 = require("../../utils/Utils");
 const ethers_1 = require("ethers");
 const EVMBlocks_1 = require("./modules/EVMBlocks");
@@ -17,7 +18,7 @@ const EVMBrowserSigner_1 = require("../wallet/EVMBrowserSigner");
  * @category Chain Interface
  */
 class EVMChainInterface {
-    constructor(chainId, evmChainId, provider, config, retryPolicy, evmFeeEstimator = new EVMFees_1.EVMFees(provider)) {
+    constructor(chainId, evmChainId, provider, config, retryPolicy, evmFeeEstimator = new EVMFees_1.EVMFees(provider), bitcoinNetwork) {
         var _a, _b, _c, _d;
         this.chainId = chainId;
         this.evmChainId = evmChainId;
@@ -28,6 +29,7 @@ class EVMChainInterface {
         (_b = this._config).finalizedBlockTag ?? (_b.finalizedBlockTag = "finalized");
         (_c = this._config).finalityCheckStrategy ?? (_c.finalityCheckStrategy = { type: "timer" });
         (_d = this._config.finalityCheckStrategy).delayMs ?? (_d.delayMs = 1000);
+        this.bitcoinNetwork = bitcoinNetwork;
         this.logger = (0, Utils_1.getLogger)("EVMChainInterface(" + this.evmChainId + "): ");
         this.Fees = evmFeeEstimator;
         this.Tokens = new EVMTokens_1.EVMTokens(this);
@@ -155,6 +157,15 @@ class EVMChainInterface {
     getTxIdStatus(txId) {
         return this.Transactions.getTxIdStatus(txId);
     }
+    /**
+     * @inheritDoc
+     */
+    getTxId(signedTX) {
+        const txId = signedTX.hash;
+        if (txId == null)
+            throw new Error("Passed transaction is not signed!");
+        return Promise.resolve(txId);
+    }
     /**
      * @inheritDoc
      */
@@ -195,5 +206,12 @@ class EVMChainInterface {
         }
         return new EVMSigner_1.EVMSigner(signer, address);
     }
+    async verifyNetwork(bitcoinNetwork) {
+        if (this.bitcoinNetwork != null && bitcoinNetwork !== this.bitcoinNetwork)
+            throw new Error(`Network mismatch, the chain interface was not setup for ${base_1.BitcoinNetwork[bitcoinNetwork]}, chain interface network: ${base_1.BitcoinNetwork[this.bitcoinNetwork]}`);
+        const network = await this.provider.getNetwork();
+        if (network.chainId !== BigInt(this.evmChainId))
+            throw new Error(`Network mismatch, the underlying RPC provider isn't using the correct chainId, expected: ${this.evmChainId}, provider returned: ${network.chainId.toString(10)}`);
+    }
 }
 exports.EVMChainInterface = EVMChainInterface;

package/dist/evm/swaps/EVMSwapContract.js

@@ -247,15 +247,30 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
         const escrowHash = data.getEscrowHash();
         const stateData = await this.contract.getHashState("0x" + escrowHash);
         const state = Number(stateData.state);
+        const initBlockHeight = Number(stateData.initBlockheight);
         const blockHeight = Number(stateData.finishBlockheight);
+        const getInitTxId = async () => {
+            const events = await this._Events.getContractBlockEvents(["Initialize"], [null, null, "0x" + escrowHash], initBlockHeight, initBlockHeight);
+            if (events.length === 0)
+                throw new Error("Initialize event not found!");
+            return events[0].transactionHash;
+        };
         switch (state) {
             case ESCROW_STATE_COMMITTED:
-                if (data.isOfferer(signer) && await this.isExpired(signer, data))
-                    return { type: base_1.SwapCommitStateType.REFUNDABLE };
-                return { type: base_1.SwapCommitStateType.COMMITED };
+                if (data.isOfferer(signer) && await this.isExpired(signer, data)) {
+                    return {
+                        type: base_1.SwapCommitStateType.REFUNDABLE,
+                        getInitTxId
+                    };
+                }
+                return {
+                    type: base_1.SwapCommitStateType.COMMITED,
+                    getInitTxId
+                };
             case ESCROW_STATE_CLAIMED:
                 return {
                     type: base_1.SwapCommitStateType.PAID,
+                    getInitTxId,
                     getTxBlock: async () => {
                         return {
                             blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
@@ -278,6 +293,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
             case ESCROW_STATE_REFUNDED:
                 return {
                     type: await this.isExpired(signer, data) ? base_1.SwapCommitStateType.EXPIRED : base_1.SwapCommitStateType.NOT_COMMITED,
+                    getInitTxId,
                     getTxBlock: async () => {
                         return {
                             blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
@@ -358,6 +374,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
                     init: foundSwapData,
                     state: {
                         type: base_1.SwapCommitStateType.PAID,
+                        getInitTxId: foundSwapData?.getInitTxId,
                         getClaimTxId: () => Promise.resolve(event.transactionHash),
                         getClaimResult: () => Promise.resolve(event.args.witnessResult.substring(2)),
                         getTxBlock: async () => {
@@ -378,6 +395,7 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
                     init: foundSwapData,
                     state: {
                         type: isExpired ? base_1.SwapCommitStateType.EXPIRED : base_1.SwapCommitStateType.NOT_COMMITED,
+                        getInitTxId: foundSwapData?.getInitTxId,
                         getRefundTxId: () => Promise.resolve(event.transactionHash),
                         getTxBlock: async () => {
                             return {
@@ -399,8 +417,8 @@ class EVMSwapContract extends EVMContractBase_1.EVMContractBase {
             resultingSwaps[escrowHash] = {
                 init: foundSwapData,
                 state: foundSwapData.data.isOfferer(signer) && await this.isExpired(signer, foundSwapData.data)
-                    ? { type: base_1.SwapCommitStateType.REFUNDABLE }
-                    : { type: base_1.SwapCommitStateType.COMMITED }
+                    ? { type: base_1.SwapCommitStateType.REFUNDABLE, getInitTxId: foundSwapData.getInitTxId }
+                    : { type: base_1.SwapCommitStateType.COMMITED, getInitTxId: foundSwapData.getInitTxId }
             };
         }
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/chain-evm",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "EVM specific base implementation",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",
@@ -27,7 +27,7 @@
   "author": "adambor",
   "license": "Apache-2.0",
   "dependencies": {
-    "@atomiqlabs/base": "^13.3.0",
+    "@atomiqlabs/base": "^13.4.2",
     "@noble/hashes": "^1.8.0",
     "@scure/btc-signer": "^1.6.0",
     "buffer": "6.0.3",

package/src/chains/alpen/AlpenInitializer.ts

@@ -145,7 +145,7 @@ export function initializeAlpen(
         maxParallelCalls: options?.evmConfig?.maxParallelCalls ?? 5,
         useAccessLists: options?.evmConfig?.useAccessLists,
         defaultAccessListAddresses: options?.evmConfig?.defaultAccessListAddresses
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
 
     const btcRelay = new EVMBtcRelay(
         chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract,

package/src/chains/botanix/BotanixInitializer.ts

@@ -127,7 +127,7 @@ export function initializeBotanix(
             type: "timer",
             delayMs: 1000
         }
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
 
     const btcRelay = new EVMBtcRelay(
         chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract,

package/src/chains/citrea/CitreaInitializer.ts

@@ -135,7 +135,7 @@ export function initializeCitrea(
         maxParallelCalls: options?.evmConfig?.maxParallelCalls ?? 5,
         useAccessLists: options?.evmConfig?.useAccessLists,
         defaultAccessListAddresses: options?.evmConfig?.defaultAccessListAddresses
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
     chainInterface.Tokens = new CitreaTokens(chainInterface); //Override with custom token module allowing l1 state diff based fee calculation
 
     const btcRelay = new CitreaBtcRelay(

package/src/chains/goat/GoatInitializer.ts

@@ -155,7 +155,7 @@ export function initializeGoat(
         maxParallelCalls: options?.evmConfig?.maxParallelCalls ?? 5,
         useAccessLists: options?.evmConfig?.useAccessLists,
         defaultAccessListAddresses: options?.evmConfig?.defaultAccessListAddresses
-    }, options.retryPolicy, Fees);
+    }, options.retryPolicy, Fees, network);
 
     const btcRelay = new EVMBtcRelay(
         chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract,

package/src/evm/chain/EVMChainInterface.ts

@@ -1,4 +1,4 @@
-import {ChainInterface, TransactionConfirmationOptions} from "@atomiqlabs/base";
+import {BitcoinNetwork, ChainInterface, TransactionConfirmationOptions} from "@atomiqlabs/base";
 import {getLogger, LoggerType} from "../../utils/Utils";
 import {
     BrowserProvider,
@@ -128,13 +128,16 @@ export class EVMChainInterface<ChainId extends string = string> implements Chain
      */
     protected logger: LoggerType;
 
+    private readonly bitcoinNetwork?: BitcoinNetwork;
+
     constructor(
         chainId: ChainId,
         evmChainId: number,
         provider: JsonRpcApiProvider,
         config: EVMConfiguration,
         retryPolicy?: EVMRetryPolicy,
-        evmFeeEstimator: EVMFees = new EVMFees(provider)
+        evmFeeEstimator: EVMFees = new EVMFees(provider),
+        bitcoinNetwork?: BitcoinNetwork
     ) {
         this.chainId = chainId;
         this.evmChainId = evmChainId;
@@ -146,6 +149,8 @@ export class EVMChainInterface<ChainId extends string = string> implements Chain
         this._config.finalityCheckStrategy ??= {type: "timer"};
         this._config.finalityCheckStrategy.delayMs ??= 1000;
 
+        this.bitcoinNetwork = bitcoinNetwork;
+
         this.logger = getLogger("EVMChainInterface("+this.evmChainId+"): ");
 
         this.Fees = evmFeeEstimator;
@@ -307,6 +312,15 @@ export class EVMChainInterface<ChainId extends string = string> implements Chain
         return this.Transactions.getTxIdStatus(txId);
     }
 
+    /**
+     * @inheritDoc
+     */
+    getTxId(signedTX: Transaction): Promise<string> {
+        const txId = signedTX.hash;
+        if(txId==null) throw new Error("Passed transaction is not signed!");
+        return Promise.resolve(txId);
+    }
+
     /**
      * @inheritDoc
      */
@@ -358,4 +372,13 @@ export class EVMChainInterface<ChainId extends string = string> implements Chain
         return new EVMSigner(signer, address);
     }
 
+    async verifyNetwork(bitcoinNetwork: BitcoinNetwork): Promise<void> {
+        if(this.bitcoinNetwork!=null && bitcoinNetwork!==this.bitcoinNetwork)
+            throw new Error(`Network mismatch, the chain interface was not setup for ${BitcoinNetwork[bitcoinNetwork]}, chain interface network: ${BitcoinNetwork[this.bitcoinNetwork]}`);
+
+        const network = await this.provider.getNetwork();
+        if(network.chainId!==BigInt(this.evmChainId))
+            throw new Error(`Network mismatch, the underlying RPC provider isn't using the correct chainId, expected: ${this.evmChainId}, provider returned: ${network.chainId.toString(10)}`);
+    }
+
 }

package/src/evm/swaps/EVMSwapContract.ts

@@ -333,14 +333,35 @@ export class EVMSwapContract<ChainId extends string = string>
         const escrowHash = data.getEscrowHash();
         const stateData = await this.contract.getHashState("0x"+escrowHash);
         const state = Number(stateData.state);
+        const initBlockHeight = Number(stateData.initBlockheight);
         const blockHeight = Number(stateData.finishBlockheight);
+
+        const getInitTxId = async () => {
+            const events = await this._Events.getContractBlockEvents(
+                ["Initialize"],
+                [null, null, "0x"+escrowHash],
+                initBlockHeight, initBlockHeight
+            );
+            if(events.length===0) throw new Error("Initialize event not found!");
+            return events[0].transactionHash;
+        }
+
         switch(state) {
             case ESCROW_STATE_COMMITTED:
-                if(data.isOfferer(signer) && await this.isExpired(signer,data)) return {type: SwapCommitStateType.REFUNDABLE};
-                return {type: SwapCommitStateType.COMMITED};
+                if(data.isOfferer(signer) && await this.isExpired(signer,data)) {
+                    return {
+                        type: SwapCommitStateType.REFUNDABLE,
+                        getInitTxId
+                    };
+                }
+                return {
+                    type: SwapCommitStateType.COMMITED,
+                    getInitTxId
+                };
             case ESCROW_STATE_CLAIMED:
                 return {
                     type: SwapCommitStateType.PAID,
+                    getInitTxId,
                     getTxBlock: async () => {
                         return {
                             blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
@@ -369,6 +390,7 @@ export class EVMSwapContract<ChainId extends string = string>
             case ESCROW_STATE_REFUNDED:
                 return {
                     type: await this.isExpired(signer, data) ? SwapCommitStateType.EXPIRED : SwapCommitStateType.NOT_COMMITED,
+                    getInitTxId,
                     getTxBlock: async () => {
                         return {
                             blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
@@ -493,6 +515,7 @@ export class EVMSwapContract<ChainId extends string = string>
                     init: foundSwapData,
                     state: {
                         type: SwapCommitStateType.PAID,
+                        getInitTxId: foundSwapData?.getInitTxId,
                         getClaimTxId: () => Promise.resolve(event.transactionHash),
                         getClaimResult: () => Promise.resolve(event.args.witnessResult.substring(2)),
                         getTxBlock: async () => {
@@ -513,6 +536,7 @@ export class EVMSwapContract<ChainId extends string = string>
                     init: foundSwapData,
                     state: {
                         type: isExpired ? SwapCommitStateType.EXPIRED : SwapCommitStateType.NOT_COMMITED,
+                        getInitTxId: foundSwapData?.getInitTxId,
                         getRefundTxId: () => Promise.resolve(event.transactionHash),
                         getTxBlock: async () => {
                             return {
@@ -547,8 +571,8 @@ export class EVMSwapContract<ChainId extends string = string>
             resultingSwaps[escrowHash] = {
                 init: foundSwapData,
                 state: foundSwapData.data.isOfferer(signer) && await this.isExpired(signer, foundSwapData.data)
-                    ? {type: SwapCommitStateType.REFUNDABLE}
-                    : {type: SwapCommitStateType.COMMITED}
+                    ? {type: SwapCommitStateType.REFUNDABLE, getInitTxId: foundSwapData.getInitTxId}
+                    : {type: SwapCommitStateType.COMMITED, getInitTxId: foundSwapData.getInitTxId}
             }
         }