@atomiqlabs/chain-evm 1.1.20 → 2.0.7

package/dist/chains/alpen/AlpenChainType.d.ts

@@ -1,6 +1,6 @@
 import { ChainType } from "@atomiqlabs/base";
 import { EVMPreFetchVerification } from "../../evm/swaps/modules/EVMSwapInit";
-import { EVMTx } from "../../evm/chain/modules/EVMTransactions";
+import { EVMTx, SignedEVMTx } from "../../evm/chain/modules/EVMTransactions";
 import { EVMSigner } from "../../evm/wallet/EVMSigner";
 import { EVMSwapData } from "../../evm/swaps/EVMSwapData";
 import { EVMChainInterface } from "../../evm/chain/EVMChainInterface";
@@ -11,4 +11,8 @@ import { EVMSwapContract } from "../../evm/swaps/EVMSwapContract";
 import { EVMBtcRelay } from "../../evm/btcrelay/EVMBtcRelay";
 import { EVMSpvVaultContract } from "../../evm/spv_swap/EVMSpvVaultContract";
 import { Signer } from "ethers";
-export type AlpenChainType = ChainType<"ALPEN", never, EVMPreFetchVerification, EVMTx, EVMSigner, Signer, EVMSwapData, EVMSwapContract<"ALPEN">, EVMChainInterface<"ALPEN">, EVMChainEventsBrowser, EVMBtcRelay<any>, EVMSpvVaultData, EVMSpvWithdrawalData, EVMSpvVaultContract<"ALPEN">>;
+/**
+ * Type definition for the Alpen chain implementation
+ * @category Networks/Alpen
+ */
+export type AlpenChainType = ChainType<"ALPEN", never, EVMPreFetchVerification, EVMTx, SignedEVMTx, EVMSigner, Signer, EVMSwapData, EVMSwapContract<"ALPEN">, EVMChainInterface<"ALPEN">, EVMChainEventsBrowser, EVMBtcRelay<any>, EVMSpvWithdrawalData, EVMSpvVaultData, EVMSpvVaultContract<"ALPEN">>;

package/dist/chains/alpen/AlpenInitializer.d.ts

@@ -3,8 +3,20 @@ import { JsonRpcApiProvider } from "ethers";
 import { EVMConfiguration, EVMRetryPolicy } from "../../evm/chain/EVMChainInterface";
 import { EVMFees } from "../../evm/chain/modules/EVMFees";
 import { AlpenChainType } from "./AlpenChainType";
+/**
+ * Token assets available on Alpen
+ * @category Networks/Alpen
+ */
 export type AlpenAssetsType = BaseTokenType<"BTC">;
+/**
+ * Default Alpen token assets configuration
+ * @category Networks/Alpen
+ */
 export declare const AlpenAssets: AlpenAssetsType;
+/**
+ * Configuration options for initializing Alpen chain
+ * @category Networks/Alpen
+ */
 export type AlpenOptions = {
     rpcUrl: string | JsonRpcApiProvider;
     retryPolicy?: EVMRetryPolicy;
@@ -25,6 +37,18 @@ export type AlpenOptions = {
     fees?: EVMFees;
     evmConfig?: Omit<EVMConfiguration, "safeBlockTag" | "finalizedBlockTag">;
 };
+/**
+ * Initialize Alpen chain integration
+ * @category Networks/Alpen
+ */
 export declare function initializeAlpen(options: AlpenOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork): ChainData<AlpenChainType>;
+/**
+ * Type definition for the Alpen chain initializer
+ * @category Networks/Alpen
+ */
 export type AlpenInitializerType = ChainInitializer<AlpenOptions, AlpenChainType, AlpenAssetsType>;
+/**
+ * Alpen chain initializer instance
+ * @category Networks/Alpen
+ */
 export declare const AlpenInitializer: AlpenInitializerType;

package/dist/chains/alpen/AlpenInitializer.js

@@ -13,7 +13,7 @@ const EVMSwapData_1 = require("../../evm/swaps/EVMSwapData");
 const EVMSpvVaultData_1 = require("../../evm/spv_swap/EVMSpvVaultData");
 const EVMSpvWithdrawalData_1 = require("../../evm/spv_swap/EVMSpvWithdrawalData");
 const AlpenChainIds = {
-    MAINNET: null,
+    MAINNET: -1,
     TESTNET: 8150,
     TESTNET4: 8150
 };
@@ -76,6 +76,15 @@ const AlpenContractAddresses = {
         }
     }
 };
+const chainTypeMapping = {
+    [base_1.BitcoinNetwork.MAINNET]: "MAINNET",
+    [base_1.BitcoinNetwork.TESTNET]: "TESTNET",
+    [base_1.BitcoinNetwork.TESTNET4]: "TESTNET4",
+};
+/**
+ * Default Alpen token assets configuration
+ * @category Networks/Alpen
+ */
 exports.AlpenAssets = {
     BTC: {
         address: "0x0000000000000000000000000000000000000000",
@@ -83,20 +92,14 @@ exports.AlpenAssets = {
         displayDecimals: 8
     }
 };
+/**
+ * Initialize Alpen chain integration
+ * @category Networks/Alpen
+ */
 function initializeAlpen(options, bitcoinRpc, network) {
-    if (options.chainType == null) {
-        switch (network) {
-            case base_1.BitcoinNetwork.MAINNET:
-                options.chainType = "MAINNET";
-                break;
-            case base_1.BitcoinNetwork.TESTNET:
-                options.chainType = "TESTNET";
-                break;
-            case base_1.BitcoinNetwork.TESTNET4:
-                options.chainType = "TESTNET4";
-                break;
-        }
-    }
+    options.chainType ?? (options.chainType = chainTypeMapping[network]);
+    if (options.chainType == null)
+        throw new Error("Please specify chainType in options!");
     const defaultContractAddresses = AlpenContractAddresses[options.chainType];
     const chainId = AlpenChainIds[options.chainType];
     const provider = typeof (options.rpcUrl) === "string" ?
@@ -142,6 +145,10 @@ function initializeAlpen(options, bitcoinRpc, network) {
 }
 exports.initializeAlpen = initializeAlpen;
 ;
+/**
+ * Alpen chain initializer instance
+ * @category Networks/Alpen
+ */
 exports.AlpenInitializer = {
     chainId: "ALPEN",
     chainType: null,

package/dist/chains/botanix/BotanixChainType.d.ts

@@ -1,6 +1,6 @@
 import { ChainType } from "@atomiqlabs/base";
 import { EVMPreFetchVerification } from "../../evm/swaps/modules/EVMSwapInit";
-import { EVMTx } from "../../evm/chain/modules/EVMTransactions";
+import { EVMTx, SignedEVMTx } from "../../evm/chain/modules/EVMTransactions";
 import { EVMSigner } from "../../evm/wallet/EVMSigner";
 import { EVMSwapData } from "../../evm/swaps/EVMSwapData";
 import { EVMChainInterface } from "../../evm/chain/EVMChainInterface";
@@ -11,4 +11,8 @@ import { EVMSwapContract } from "../../evm/swaps/EVMSwapContract";
 import { EVMBtcRelay } from "../../evm/btcrelay/EVMBtcRelay";
 import { EVMSpvVaultContract } from "../../evm/spv_swap/EVMSpvVaultContract";
 import { Signer } from "ethers";
-export type BotanixChainType = ChainType<"BOTANIX", never, EVMPreFetchVerification, EVMTx, EVMSigner, Signer, EVMSwapData, EVMSwapContract<"BOTANIX">, EVMChainInterface<"BOTANIX">, EVMChainEventsBrowser, EVMBtcRelay<any>, EVMSpvVaultData, EVMSpvWithdrawalData, EVMSpvVaultContract<"BOTANIX">>;
+/**
+ * Type definition for the Botanix chain implementation
+ * @category Networks/Botanix
+ */
+export type BotanixChainType = ChainType<"BOTANIX", never, EVMPreFetchVerification, EVMTx, SignedEVMTx, EVMSigner, Signer, EVMSwapData, EVMSwapContract<"BOTANIX">, EVMChainInterface<"BOTANIX">, EVMChainEventsBrowser, EVMBtcRelay<any>, EVMSpvWithdrawalData, EVMSpvVaultData, EVMSpvVaultContract<"BOTANIX">>;

package/dist/chains/botanix/BotanixInitializer.d.ts

@@ -3,8 +3,20 @@ import { JsonRpcApiProvider } from "ethers";
 import { EVMConfiguration, EVMRetryPolicy } from "../../evm/chain/EVMChainInterface";
 import { EVMFees } from "../../evm/chain/modules/EVMFees";
 import { BotanixChainType } from "./BotanixChainType";
+/**
+ * Token assets available on Botanix
+ * @category Networks/Botanix
+ */
 export type BotanixAssetsType = BaseTokenType<"BTC">;
+/**
+ * Default Botanix token assets configuration
+ * @category Networks/Botanix
+ */
 export declare const BotanixAssets: BotanixAssetsType;
+/**
+ * Configuration options for initializing Botanix chain
+ * @category Networks/Botanix
+ */
 export type BotanixOptions = {
     rpcUrl: string | JsonRpcApiProvider;
     retryPolicy?: EVMRetryPolicy;
@@ -25,6 +37,18 @@ export type BotanixOptions = {
     fees?: EVMFees;
     evmConfig?: Omit<EVMConfiguration, "safeBlockTag" | "finalizedBlockTag">;
 };
+/**
+ * Initialize Botanix chain integration
+ * @category Networks/Botanix
+ */
 export declare function initializeBotanix(options: BotanixOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork): ChainData<BotanixChainType>;
+/**
+ * Type definition for the Botanix chain initializer
+ * @category Networks/Botanix
+ */
 export type BotanixInitializerType = ChainInitializer<BotanixOptions, BotanixChainType, BotanixAssetsType>;
+/**
+ * Botanix chain initializer instance
+ * @category Networks/Botanix
+ */
 export declare const BotanixInitializer: BotanixInitializerType;

package/dist/chains/botanix/BotanixInitializer.js

@@ -56,6 +56,14 @@ const BotanixContractAddresses = {
         }
     }
 };
+const chainTypeMapping = {
+    [base_1.BitcoinNetwork.MAINNET]: "MAINNET",
+    [base_1.BitcoinNetwork.TESTNET]: "TESTNET",
+};
+/**
+ * Default Botanix token assets configuration
+ * @category Networks/Botanix
+ */
 exports.BotanixAssets = {
     BTC: {
         address: "0x0000000000000000000000000000000000000000",
@@ -63,17 +71,14 @@ exports.BotanixAssets = {
         displayDecimals: 8
     }
 };
+/**
+ * Initialize Botanix chain integration
+ * @category Networks/Botanix
+ */
 function initializeBotanix(options, bitcoinRpc, network) {
-    if (options.chainType == null) {
-        switch (network) {
-            case base_1.BitcoinNetwork.MAINNET:
-                options.chainType = "MAINNET";
-                break;
-            case base_1.BitcoinNetwork.TESTNET:
-                options.chainType = "TESTNET";
-                break;
-        }
-    }
+    options.chainType ?? (options.chainType = chainTypeMapping[network]);
+    if (options.chainType == null)
+        throw new Error("Please specify chainType in options!");
     const defaultContractAddresses = BotanixContractAddresses[options.chainType];
     const chainId = BotanixChainIds[options.chainType];
     const provider = typeof (options.rpcUrl) === "string" ?
@@ -123,6 +128,10 @@ function initializeBotanix(options, bitcoinRpc, network) {
 }
 exports.initializeBotanix = initializeBotanix;
 ;
+/**
+ * Botanix chain initializer instance
+ * @category Networks/Botanix
+ */
 exports.BotanixInitializer = {
     chainId: "BOTANIX",
     chainType: null,

package/dist/chains/citrea/CitreaBtcRelay.js

@@ -15,6 +15,8 @@ class CitreaBtcRelay extends EVMBtcRelay_1.EVMBtcRelay {
     async estimateSynchronizeFee(requiredBlockheight, feeRate) {
         feeRate ?? (feeRate = await this.Chain.Fees.getFeeRate());
         const tipData = await this.getTipData();
+        if (tipData == null)
+            throw new Error("Cannot get relay tip data, relay not initialized?");
         const currBlockheight = tipData.blockheight;
         const blockheightDelta = requiredBlockheight - currBlockheight;
         if (blockheightDelta <= 0)

package/dist/chains/citrea/CitreaChainType.d.ts

@@ -1,6 +1,6 @@
 import { ChainType } from "@atomiqlabs/base";
 import { EVMPreFetchVerification } from "../../evm/swaps/modules/EVMSwapInit";
-import { EVMTx } from "../../evm/chain/modules/EVMTransactions";
+import { EVMTx, SignedEVMTx } from "../../evm/chain/modules/EVMTransactions";
 import { EVMSigner } from "../../evm/wallet/EVMSigner";
 import { EVMSwapData } from "../../evm/swaps/EVMSwapData";
 import { EVMChainInterface } from "../../evm/chain/EVMChainInterface";
@@ -11,4 +11,8 @@ import { CitreaSwapContract } from "./CitreaSwapContract";
 import { CitreaBtcRelay } from "./CitreaBtcRelay";
 import { CitreaSpvVaultContract } from "./CitreaSpvVaultContract";
 import { Signer } from "ethers";
-export type CitreaChainType = ChainType<"CITREA", never, EVMPreFetchVerification, EVMTx, EVMSigner, Signer, EVMSwapData, CitreaSwapContract, EVMChainInterface<"CITREA">, EVMChainEventsBrowser, CitreaBtcRelay<any>, EVMSpvVaultData, EVMSpvWithdrawalData, CitreaSpvVaultContract>;
+/**
+ * Type definition for the Citrea chain implementation
+ * @category Networks/Citrea
+ */
+export type CitreaChainType = ChainType<"CITREA", never, EVMPreFetchVerification, EVMTx, SignedEVMTx, EVMSigner, Signer, EVMSwapData, CitreaSwapContract, EVMChainInterface<"CITREA">, EVMChainEventsBrowser, CitreaBtcRelay<any>, EVMSpvWithdrawalData, EVMSpvVaultData, CitreaSpvVaultContract>;

package/dist/chains/citrea/CitreaFees.d.ts

@@ -1,10 +1,13 @@
 import { EVMFees } from "../../evm/chain/modules/EVMFees";
+/**
+ * @category Networks/Citrea
+ */
 export declare class CitreaFees extends EVMFees {
     static readonly StateDiffSize: {
         APPROVE_DIFF_SIZE: number;
     };
     protected readonly logger: import("../../utils/Utils").LoggerType;
-    private _blockFeeCache;
+    private _blockFeeCache?;
     /**
      * Gets evm fee rate
      *

package/dist/chains/citrea/CitreaFees.js

@@ -3,11 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CitreaFees = void 0;
 const EVMFees_1 = require("../../evm/chain/modules/EVMFees");
 const Utils_1 = require("../../utils/Utils");
+/**
+ * @category Networks/Citrea
+ */
 class CitreaFees extends EVMFees_1.EVMFees {
     constructor() {
         super(...arguments);
         this.logger = (0, Utils_1.getLogger)("CitreaFees: ");
-        this._blockFeeCache = null;
     }
     /**
      * Gets evm fee rate
@@ -29,16 +31,15 @@ class CitreaFees extends EVMFees_1.EVMFees {
      */
     async getFeeRate() {
         if (this._blockFeeCache == null || Date.now() - this._blockFeeCache.timestamp > this.MAX_FEE_AGE) {
-            let obj = {
+            let obj;
+            this._blockFeeCache = obj = {
                 timestamp: Date.now(),
-                feeRate: null
+                feeRate: this.__getFeeRate().catch(e => {
+                    if (this._blockFeeCache === obj)
+                        delete this._blockFeeCache;
+                    throw e;
+                })
             };
-            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)

package/dist/chains/citrea/CitreaInitializer.d.ts

@@ -3,8 +3,20 @@ import { JsonRpcApiProvider } from "ethers";
 import { EVMConfiguration, EVMRetryPolicy } from "../../evm/chain/EVMChainInterface";
 import { CitreaChainType } from "./CitreaChainType";
 import { CitreaFees } from "./CitreaFees";
+/**
+ * Token assets available on Citrea
+ * @category Networks/Citrea
+ */
 export type CitreaAssetsType = BaseTokenType<"CBTC" | "WBTC" | "USDC">;
+/**
+ * Default Citrea token assets configuration
+ * @category Networks/Citrea
+ */
 export declare const CitreaAssets: CitreaAssetsType;
+/**
+ * Configuration options for initializing Citrea chain
+ * @category Networks/Citrea
+ */
 export type CitreaOptions = {
     rpcUrl: string | JsonRpcApiProvider;
     retryPolicy?: EVMRetryPolicy;
@@ -25,6 +37,18 @@ export type CitreaOptions = {
     fees?: CitreaFees;
     evmConfig?: Omit<EVMConfiguration, "safeBlockTag" | "finalizedBlockTag">;
 };
+/**
+ * Initialize Citrea chain integration
+ * @category Networks/Citrea
+ */
 export declare function initializeCitrea(options: CitreaOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork): ChainData<CitreaChainType>;
+/**
+ * Type definition for the Citrea chain initializer
+ * @category Networks/Citrea
+ */
 export type CitreaInitializerType = ChainInitializer<CitreaOptions, CitreaChainType, CitreaAssetsType>;
+/**
+ * Citrea chain initializer instance
+ * @category Networks/Citrea
+ */
 export declare const CitreaInitializer: CitreaInitializerType;

package/dist/chains/citrea/CitreaInitializer.js

@@ -57,6 +57,14 @@ const CitreaContractAddresses = {
         }
     }
 };
+const chainTypeMapping = {
+    [base_1.BitcoinNetwork.MAINNET]: "MAINNET",
+    [base_1.BitcoinNetwork.TESTNET4]: "TESTNET4",
+};
+/**
+ * Default Citrea token assets configuration
+ * @category Networks/Citrea
+ */
 exports.CitreaAssets = {
     CBTC: {
         address: "0x0000000000000000000000000000000000000000",
@@ -69,24 +77,23 @@ exports.CitreaAssets = {
         displayDecimals: 8
     },
     USDC: {
-        address: "0x2C8abD2A528D19AFc33d2ebA507c0F405c131335",
+        address: "0xE045e6c36cF77FAA2CfB54466D71A3aEF7bbE839",
         decimals: 6,
         displayDecimals: 6
     }
 };
+/**
+ * Initialize Citrea chain integration
+ * @category Networks/Citrea
+ */
 function initializeCitrea(options, bitcoinRpc, network) {
-    if (options.chainType == null) {
-        switch (network) {
-            case base_1.BitcoinNetwork.TESTNET4:
-                options.chainType = "TESTNET4";
-                break;
-            case base_1.BitcoinNetwork.MAINNET:
-                options.chainType = "MAINNET";
-                break;
-        }
-    }
+    options.chainType ?? (options.chainType = chainTypeMapping[network]);
+    if (options.chainType == null)
+        throw new Error("Please specify chainType in options!");
     const defaultContractAddresses = CitreaContractAddresses[options.chainType];
     const chainId = CitreaChainIds[options.chainType];
+    if (chainId == null)
+        throw new Error("Invalid chainId due to wrong chainType specified, check the passed chainType!");
     const provider = typeof (options.rpcUrl) === "string" ?
         (options.rpcUrl.startsWith("ws")
             ? new ethers_1.WebSocketProvider(options.rpcUrl, { name: "Citrea", chainId })
@@ -131,6 +138,10 @@ function initializeCitrea(options, bitcoinRpc, network) {
 }
 exports.initializeCitrea = initializeCitrea;
 ;
+/**
+ * Citrea chain initializer instance
+ * @category Networks/Citrea
+ */
 exports.CitreaInitializer = {
     chainId: "CITREA",
     chainType: null,

package/dist/chains/goat/GoatChainType.d.ts

@@ -1,6 +1,6 @@
 import { ChainType } from "@atomiqlabs/base";
 import { EVMPreFetchVerification } from "../../evm/swaps/modules/EVMSwapInit";
-import { EVMTx } from "../../evm/chain/modules/EVMTransactions";
+import { EVMTx, SignedEVMTx } from "../../evm/chain/modules/EVMTransactions";
 import { EVMSigner } from "../../evm/wallet/EVMSigner";
 import { EVMSwapData } from "../../evm/swaps/EVMSwapData";
 import { EVMChainInterface } from "../../evm/chain/EVMChainInterface";
@@ -11,4 +11,8 @@ import { EVMSwapContract } from "../../evm/swaps/EVMSwapContract";
 import { EVMBtcRelay } from "../../evm/btcrelay/EVMBtcRelay";
 import { EVMSpvVaultContract } from "../../evm/spv_swap/EVMSpvVaultContract";
 import { Signer } from "ethers";
-export type GoatChainType = ChainType<"GOAT", never, EVMPreFetchVerification, EVMTx, EVMSigner, Signer, EVMSwapData, EVMSwapContract<"GOAT">, EVMChainInterface<"GOAT">, EVMChainEventsBrowser, EVMBtcRelay<any>, EVMSpvVaultData, EVMSpvWithdrawalData, EVMSpvVaultContract<"GOAT">>;
+/**
+ * Type definition for the GOAT Network chain implementation
+ * @category Networks/GOAT
+ */
+export type GoatChainType = ChainType<"GOAT", never, EVMPreFetchVerification, EVMTx, SignedEVMTx, EVMSigner, Signer, EVMSwapData, EVMSwapContract<"GOAT">, EVMChainInterface<"GOAT">, EVMChainEventsBrowser, EVMBtcRelay<any>, EVMSpvWithdrawalData, EVMSpvVaultData, EVMSpvVaultContract<"GOAT">>;

package/dist/chains/goat/GoatInitializer.d.ts

@@ -3,8 +3,20 @@ import { JsonRpcApiProvider } from "ethers";
 import { EVMConfiguration, EVMRetryPolicy } from "../../evm/chain/EVMChainInterface";
 import { EVMFees } from "../../evm/chain/modules/EVMFees";
 import { GoatChainType } from "./GoatChainType";
+/**
+ * Token assets available on GOAT Network
+ * @category Networks/GOAT
+ */
 export type GoatAssetsType = BaseTokenType<"BTC" | "PBTC" | "_PBTC_DEV">;
+/**
+ * Default GOAT Network token assets configuration
+ * @category Networks/GOAT
+ */
 export declare const GoatAssets: GoatAssetsType;
+/**
+ * Configuration options for initializing GOAT Network chain
+ * @category Networks/GOAT
+ */
 export type GoatOptions = {
     rpcUrl: string | JsonRpcApiProvider;
     retryPolicy?: EVMRetryPolicy;
@@ -25,6 +37,18 @@ export type GoatOptions = {
     fees?: EVMFees;
     evmConfig?: Omit<EVMConfiguration, "safeBlockTag" | "finalizedBlockTag">;
 };
+/**
+ * Initialize GOAT Network chain integration
+ * @category Networks/GOAT
+ */
 export declare function initializeGoat(options: GoatOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork): ChainData<GoatChainType>;
+/**
+ * Type definition for the GOAT Network chain initializer
+ * @category Networks/GOAT
+ */
 export type GoatInitializerType = ChainInitializer<GoatOptions, GoatChainType, GoatAssetsType>;
+/**
+ * GOAT Network chain initializer instance
+ * @category Networks/GOAT
+ */
 export declare const GoatInitializer: GoatInitializerType;

package/dist/chains/goat/GoatInitializer.js

@@ -76,6 +76,15 @@ const GoatContractAddresses = {
         }
     }
 };
+const chainTypeMapping = {
+    [base_1.BitcoinNetwork.MAINNET]: "MAINNET",
+    [base_1.BitcoinNetwork.TESTNET]: "TESTNET",
+    [base_1.BitcoinNetwork.TESTNET4]: "TESTNET4",
+};
+/**
+ * Default GOAT Network token assets configuration
+ * @category Networks/GOAT
+ */
 exports.GoatAssets = {
     BTC: {
         address: "0x0000000000000000000000000000000000000000",
@@ -93,20 +102,14 @@ exports.GoatAssets = {
         displayDecimals: 8
     }
 };
+/**
+ * Initialize GOAT Network chain integration
+ * @category Networks/GOAT
+ */
 function initializeGoat(options, bitcoinRpc, network) {
-    if (options.chainType == null) {
-        switch (network) {
-            case base_1.BitcoinNetwork.MAINNET:
-                options.chainType = "MAINNET";
-                break;
-            case base_1.BitcoinNetwork.TESTNET:
-                options.chainType = "TESTNET";
-                break;
-            case base_1.BitcoinNetwork.TESTNET4:
-                options.chainType = "TESTNET4";
-                break;
-        }
-    }
+    options.chainType ?? (options.chainType = chainTypeMapping[network]);
+    if (options.chainType == null)
+        throw new Error("Please specify chainType in options!");
     const defaultContractAddresses = GoatContractAddresses[options.chainType];
     const chainId = GoatChainIds[options.chainType];
     const provider = typeof (options.rpcUrl) === "string" ?
@@ -152,6 +155,10 @@ function initializeGoat(options, bitcoinRpc, network) {
 }
 exports.initializeGoat = initializeGoat;
 ;
+/**
+ * GOAT Network chain initializer instance
+ * @category Networks/GOAT
+ */
 exports.GoatInitializer = {
     chainId: "GOAT",
     chainType: null,

package/dist/evm/btcrelay/EVMBtcRelay.d.ts

@@ -8,6 +8,9 @@ import { EVMBtcStoredHeader } from "./headers/EVMBtcStoredHeader";
 import { EVMSigner } from "../wallet/EVMSigner";
 import { EVMTx } from "../chain/modules/EVMTransactions";
 import { EVMChainInterface } from "../chain/EVMChainInterface";
+/**
+ * @category BTC Relay
+ */
 export declare class EVMBtcRelay<B extends BtcBlock> extends EVMContractBase<BtcRelayTypechain> implements BtcRelay<EVMBtcStoredHeader, EVMTx, B, EVMSigner> {
     static GasCosts: {
         GAS_PER_BLOCKHEADER: number;
@@ -39,7 +42,6 @@ export declare class EVMBtcRelay<B extends BtcBlock> extends EVMContractBase<Btc
      * @param signer
      * @param headers headers to sync to the btc relay
      * @param storedHeader current latest stored block header for a given fork
-     * @param tipWork work of the current tip in a given fork
      * @param forkId forkId to submit to, forkId=0 means main chain, forkId=-1 means short fork
      * @param feeRate feeRate for the transaction
      * @param totalForkHeaders Total number of headers in a fork
@@ -59,7 +61,7 @@ export declare class EVMBtcRelay<B extends BtcBlock> extends EVMContractBase<Btc
         blockhash: string;
         chainWork: Buffer;
         blockheight: number;
-    }>;
+    } | null>;
     /**
      * Retrieves blockheader with a specific blockhash, returns null if requiredBlockheight is provided and
      *  btc relay contract is not synced up to the desired blockheight
@@ -72,7 +74,7 @@ export declare class EVMBtcRelay<B extends BtcBlock> extends EVMContractBase<Btc
     }, requiredBlockheight?: number): Promise<{
         header: EVMBtcStoredHeader;
         height: number;
-    }>;
+    } | null>;
     /**
      * Retrieves blockheader data by blockheader's commit hash,
      *
@@ -81,14 +83,14 @@ export declare class EVMBtcRelay<B extends BtcBlock> extends EVMContractBase<Btc
      */
     retrieveLogByCommitHash(commitmentHashStr: string, blockData: {
         blockhash: string;
-    }): Promise<EVMBtcStoredHeader>;
+    }): Promise<EVMBtcStoredHeader | null>;
     /**
      * Retrieves latest known stored blockheader & blockheader from bitcoin RPC that is in the main chain
      */
     retrieveLatestKnownBlockLog(): Promise<{
         resultStoredHeader: EVMBtcStoredHeader;
         resultBitcoinHeader: B;
-    }>;
+    } | null>;
     /**
      * Saves blockheaders as a bitcoin main chain to the btc relay
      *
@@ -193,5 +195,5 @@ export declare class EVMBtcRelay<B extends BtcBlock> extends EVMContractBase<Btc
         blockhash: string;
     }[], txs: EVMTx[], synchronizer?: RelaySynchronizer<EVMBtcStoredHeader, EVMTx, any>, feeRate?: string): Promise<{
         [blockhash: string]: EVMBtcStoredHeader;
-    }>;
+    } | null>;
 }