@atomiqlabs/chain-evm 2.2.1 → 2.4.0

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
      */
@@ -207,4 +208,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);
@@ -195,5 +197,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/EVMSwapData.d.ts

@@ -178,4 +178,8 @@ export declare class EVMSwapData extends SwapData {
      * @param claimHandlerImpl Claim handler implementation used to resolve swap type
      */
     static deserializeFromStruct(struct: EscrowDataStruct, claimHandlerImpl: IClaimHandler<any, any>): EVMSwapData;
+    /**
+     * @inheritDoc
+     */
+    getEscrowStruct(): any;
 }

package/dist/evm/swaps/EVMSwapData.js

@@ -4,6 +4,7 @@ exports.EVMSwapData = void 0;
 const base_1 = require("@atomiqlabs/base");
 const ethers_1 = require("ethers");
 const TimelockRefundHandler_1 = require("./handlers/refund/TimelockRefundHandler");
+const Utils_1 = require("../../utils/Utils");
 const FLAG_PAY_OUT = 0x01n;
 const FLAG_PAY_IN = 0x02n;
 const FLAG_REPUTATION = 0x04n;
@@ -413,6 +414,12 @@ class EVMSwapData extends base_1.SwapData {
         const { payOut, payIn, reputation, sequence } = EVMSwapData.toFlags(BigInt(struct.flags));
         return new EVMSwapData(struct.offerer, struct.claimer, struct.token, struct.refundHandler, struct.claimHandler, payOut, payIn, reputation, sequence, (0, ethers_1.hexlify)(struct.claimData), (0, ethers_1.hexlify)(struct.refundData), BigInt(struct.amount), struct.depositToken, BigInt(struct.securityDeposit), BigInt(struct.claimerBounty), claimHandlerImpl.getType(), undefined, struct.successActionCommitment);
     }
+    /**
+     * @inheritDoc
+     */
+    getEscrowStruct() {
+        return (0, Utils_1.replaceBigInts)(this.toEscrowStruct());
+    }
 }
 exports.EVMSwapData = EVMSwapData;
 base_1.SwapData.deserializers["evm"] = EVMSwapData;

package/dist/utils/Utils.d.ts

@@ -1,3 +1,6 @@
+export type ReplaceBigInt<T> = T extends bigint ? string : T extends (infer U)[] ? ReplaceBigInt<U>[] : T extends readonly (infer U)[] ? readonly ReplaceBigInt<U>[] : T extends object ? {
+    [K in keyof T]: ReplaceBigInt<T[K]>;
+} : T;
 /**
  * Logger interface used across EVM modules.
  *
@@ -67,3 +70,4 @@ export declare const allowedEthersErrorNumbers: Set<number>;
  * @category Internal/Utils
  */
 export declare const allowedEthersErrorMessages: Set<string>;
+export declare function replaceBigInts<T>(obj: T): ReplaceBigInt<T>;

package/dist/utils/Utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allowedEthersErrorMessages = exports.allowedEthersErrorNumbers = exports.allowedEthersErrorCodes = exports.bigIntMax = exports.uint32ReverseEndianness = exports.tryWithRetries = exports.getLogger = exports.onceAsync = exports.timeoutPromise = void 0;
+exports.replaceBigInts = exports.allowedEthersErrorMessages = exports.allowedEthersErrorNumbers = exports.allowedEthersErrorCodes = exports.bigIntMax = exports.uint32ReverseEndianness = exports.tryWithRetries = exports.getLogger = exports.onceAsync = exports.timeoutPromise = void 0;
 /**
  * Returns a promise that resolves after `timeoutMillis` unless aborted first.
  *
@@ -142,3 +142,21 @@ exports.allowedEthersErrorNumbers = new Set([
 exports.allowedEthersErrorMessages = new Set([
     "already known"
 ]);
+function replaceBigInts(obj) {
+    const replace = (value) => {
+        if (typeof (value) === "bigint")
+            return "0x" + value.toString(16);
+        if (value == null || typeof (value) !== "object")
+            return value;
+        if (Array.isArray(value)) {
+            return value.map(replace);
+        }
+        const mapped = {};
+        for (const key of Object.keys(value)) {
+            mapped[key] = replace(value[key]);
+        }
+        return mapped;
+    };
+    return replace(obj);
+}
+exports.replaceBigInts = replaceBigInts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/chain-evm",
-  "version": "2.2.1",
+  "version": "2.4.0",
   "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.2.0",
+    "@atomiqlabs/base": "^13.4.0",
     "@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;
@@ -358,4 +363,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/EVMSwapData.ts

@@ -3,6 +3,7 @@ import {AbiCoder, hexlify, keccak256, ZeroHash} from "ethers";
 import {EscrowDataStruct, EscrowDataStructOutput} from "./EscrowManagerTypechain";
 import {IClaimHandler} from "./handlers/claim/ClaimHandlers";
 import {TimelockRefundHandler} from "./handlers/refund/TimelockRefundHandler";
+import {replaceBigInts} from "../../utils/Utils";
 
 const FLAG_PAY_OUT: bigint = 0x01n;
 const FLAG_PAY_IN: bigint = 0x02n;
@@ -513,6 +514,13 @@ export class EVMSwapData extends SwapData {
         );
     }
 
+    /**
+     * @inheritDoc
+     */
+    getEscrowStruct(): any {
+        return replaceBigInts(this.toEscrowStruct());
+    }
+
 }
 
 SwapData.deserializers["evm"] = EVMSwapData;

package/src/utils/Utils.ts

@@ -1,4 +1,16 @@
 
+
+export type ReplaceBigInt<T> =
+    T extends bigint
+        ? string
+        : T extends (infer U)[]
+            ? ReplaceBigInt<U>[]
+            : T extends readonly (infer U)[]
+                ? readonly ReplaceBigInt<U>[]
+                : T extends object
+                    ? { [K in keyof T]: ReplaceBigInt<T[K]> }
+                    : T;
+
 /**
  * Logger interface used across EVM modules.
  *
@@ -159,3 +171,23 @@ export const allowedEthersErrorNumbers: Set<number> = new Set([
 export const allowedEthersErrorMessages: Set<string> = new Set([
     "already known"
 ]);
+
+export function replaceBigInts<T>(obj: T): ReplaceBigInt<T> {
+    const replace = (value: any): any => {
+        if(typeof(value)==="bigint") return "0x"+value.toString(16);
+        if(value==null || typeof(value)!=="object") return value;
+
+        if(Array.isArray(value)) {
+            return value.map(replace);
+        }
+
+        const mapped: any = {};
+        for(const key of Object.keys(value)) {
+            mapped[key] = replace(value[key]);
+        }
+        return mapped;
+    };
+
+    return replace(obj);
+}
+