@atomiqlabs/sdk 8.6.3 → 8.7.1

package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js

@@ -6,6 +6,7 @@ const base_1 = require("@atomiqlabs/base");
 const SpvFromBTCSwap_1 = require("./SpvFromBTCSwap");
 const utils_1 = require("@scure/btc-signer/utils");
 const SwapType_1 = require("../../enums/SwapType");
+const Intermediary_1 = require("../../intermediaries/Intermediary");
 const Utils_1 = require("../../utils/Utils");
 const BitcoinUtils_1 = require("../../utils/BitcoinUtils");
 const IntermediaryAPI_1 = require("../../intermediaries/apis/IntermediaryAPI");
@@ -27,17 +28,15 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
      * @param unifiedStorage Storage interface for the current environment
      * @param unifiedChainEvents On-chain event listener
      * @param chain
-     * @param contract Underlying contract handling the swaps
      * @param prices Pricing to use
      * @param tokens
-     * @param spvWithdrawalDataDeserializer Deserializer for SpvVaultWithdrawalData
-     * @param btcRelay
-     * @param synchronizer Btc relay synchronizer
+     * @param versionedContracts
+     * @param versionedSynchronizer
      * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
      * @param options
      * @param events Instance to use for emitting events
      */
-    constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, contract, prices, tokens, spvWithdrawalDataDeserializer, btcRelay, synchronizer, btcRpc, options, events) {
+    constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, versionedSynchronizer, btcRpc, options, events) {
         super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, {
             ...options,
             bitcoinNetwork: options?.bitcoinNetwork ?? utils_1.TEST_NETWORK,
@@ -57,6 +56,16 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
          * @internal
          */
         this._swapDeserializer = SpvFromBTCSwap_1.SpvFromBTCSwap;
+        /**
+         * @internal
+         */
+        this.btcRelay = (version) => {
+            const _version = version ?? "v1";
+            const data = this.versionedContracts[_version];
+            if (data == null)
+                throw new Error(`Invalid contract version ${_version} requested`);
+            return data.btcRelay;
+        };
         /**
          * @internal
          */
@@ -67,6 +76,36 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
             SpvFromBTCSwap_1.SpvFromBTCSwapState.POSTED,
             SpvFromBTCSwap_1.SpvFromBTCSwapState.BROADCASTED
         ];
+        /**
+         * @internal
+         */
+        this._synchronizer = (version) => {
+            const _version = version ?? "v1";
+            const data = this.versionedSynchronizer[_version];
+            if (data == null)
+                throw new Error(`Invalid contract version ${_version} requested`);
+            return data.synchronizer;
+        };
+        /**
+         * @internal
+         */
+        this._contract = (version) => {
+            const _version = version ?? "v1";
+            const data = this.versionedContracts[_version];
+            if (data == null)
+                throw new Error(`Invalid contract version ${_version} requested`);
+            return data.spvVaultContract;
+        };
+        /**
+         * @internal
+         */
+        this._spvWithdrawalDataDeserializer = (version) => {
+            const _version = version ?? "v1";
+            const data = this.versionedContracts[_version];
+            if (data == null)
+                throw new Error(`Invalid contract version ${_version} requested`);
+            return data.spvVaultWithdrawalDataConstructor;
+        };
         /**
          * @internal
          */
@@ -79,10 +118,10 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
             SpvFromBTCSwap_1.SpvFromBTCSwapState.DECLINED,
             SpvFromBTCSwap_1.SpvFromBTCSwapState.BTC_TX_CONFIRMED
         ];
-        this._spvWithdrawalDataDeserializer = spvWithdrawalDataDeserializer;
-        this._contract = contract;
-        this.btcRelay = btcRelay;
-        this._synchronizer = synchronizer;
+        this.versionedContracts = {};
+        this.versionedSynchronizer = {};
+        this.versionedContracts = versionedContracts;
+        this.versionedSynchronizer = versionedSynchronizer;
         this._btcRpc = btcRpc;
     }
     async processEventFront(event, swap) {
@@ -173,19 +212,20 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
      * @param pricePrefetch
      * @param nativeTokenPricePrefetch
      * @param abortController
+     * @param contractVersion
      * @private
      */
-    async preFetchCallerFeeShare(amountData, options, pricePrefetch, nativeTokenPricePrefetch, abortController) {
+    async preFetchCallerFeeShare(amountData, options, pricePrefetch, nativeTokenPricePrefetch, abortController, contractVersion) {
         if (options.unsafeZeroWatchtowerFee)
             return 0n;
         if (amountData.amount === 0n)
             return 0n;
         try {
             const [feePerBlock, btcRelayData, currentBtcBlock, claimFeeRate, nativeTokenPrice] = await Promise.all([
-                this.btcRelay.getFeePerBlock(),
-                this.btcRelay.getTipData(),
+                this.btcRelay(contractVersion).getFeePerBlock(),
+                this.btcRelay(contractVersion).getTipData(),
                 this._btcRpc.getTipHeight(),
-                this._contract.getClaimFee(this._chain.randomAddress()),
+                this._contract(contractVersion).getClaimFee(this._chain.randomAddress()),
                 nativeTokenPricePrefetch ?? (amountData.token === this._chain.getNativeCurrencyAddress() ?
                     pricePrefetch :
                     this._prices.preFetchPrice(this.chainIdentifier, this._chain.getNativeCurrencyAddress(), abortController.signal))
@@ -243,6 +283,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
         abortSignal.throwIfAborted();
         if (btcFeeRate != null && resp.btcFeeRate > btcFeeRate)
             throw new IntermediaryError_1.IntermediaryError(`Required bitcoin fee rate returned from the LP is too high! Maximum accepted: ${btcFeeRate} sats/vB, required by LP: ${resp.btcFeeRate} sats/vB`);
+        const lpVersion = lp.getContractVersion(this.chainIdentifier);
         //Vault related
         let vaultScript;
         let vaultAddressType;
@@ -288,7 +329,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                 //Fetch vault data
                 let vault;
                 try {
-                    vault = await this._contract.getVaultData(resp.address, resp.vaultId);
+                    vault = await this._contract(lpVersion).getVaultData(resp.address, resp.vaultId);
                 }
                 catch (e) {
                     this.logger.error("Error getting spv vault (owner: " + resp.address + " vaultId: " + resp.vaultId.toString(10) + "): ", e);
@@ -367,7 +408,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                     throw new IntermediaryError_1.IntermediaryError("Invalid ancestor transaction (not found)");
                 btcTx = _btcTx;
             }
-            const withdrawalData = await this._contract.getWithdrawalData(btcTx);
+            const withdrawalData = await this._contract(lpVersion).getWithdrawalData(btcTx);
             abortSignal.throwIfAborted();
             pendingWithdrawals.unshift(withdrawalData);
             utxo = pendingWithdrawals[0].getSpentVaultUtxo();
@@ -393,7 +434,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
         //Also verify that all the withdrawal txns are valid, this is an extra sanity check
         try {
             for (let withdrawal of pendingWithdrawals) {
-                await this._contract.checkWithdrawalTx(withdrawal);
+                await this._contract(lpVersion).checkWithdrawalTx(withdrawal);
             }
         }
         catch (e) {
@@ -427,6 +468,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
         };
         if (amountData.token === this._chain.getNativeCurrencyAddress() && _options.gasAmount !== 0n)
             throw new UserError_1.UserError("Cannot specify `gasAmount` for swaps to a native token!");
+        const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
         const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
         const pricePrefetchPromise = this.preFetchPrice(amountData, _abortController.signal);
         const usdPricePrefetchPromise = this.preFetchUsdPrice(_abortController.signal);
@@ -435,7 +477,9 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
         const gasTokenPricePrefetchPromise = _options.gasAmount === 0n ?
             undefined :
             this.preFetchPrice({ token: nativeTokenAddress }, _abortController.signal);
-        const callerFeePrefetchPromise = this.preFetchCallerFeeShare(amountData, _options, pricePrefetchPromise, gasTokenPricePrefetchPromise, _abortController);
+        const callerFeePrefetchPromise = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
+            return this.preFetchCallerFeeShare(amountData, _options, pricePrefetchPromise, gasTokenPricePrefetchPromise, _abortController, contractVersion);
+        });
         const bitcoinFeeRatePromise = _options.maxAllowedBitcoinFeeRate != Infinity ?
             Promise.resolve(_options.maxAllowedBitcoinFeeRate) :
             this._btcRpc.getFeeRate().then(x => this._options.maxBtcFeeOffset + (x * this._options.maxBtcFeeMultiplier)).catch(e => {
@@ -448,6 +492,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                 quote: (0, RetryUtils_1.tryWithRetries)(async () => {
                     if (lp.services[SwapType_1.SwapType.SPV_VAULT_FROM_BTC] == null)
                         throw new Error("LP service for processing spv vault swaps not found!");
+                    const version = lp.getContractVersion(this.chainIdentifier);
                     const abortController = (0, Utils_1.extendAbortController)(_abortController.signal);
                     try {
                         const resp = await (0, RetryUtils_1.tryWithRetries)(async (retryCount) => {
@@ -458,13 +503,13 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                                 exactOut: !amountData.exactIn,
                                 gasToken: nativeTokenAddress,
                                 gasAmount: _options.gasAmount,
-                                callerFeeRate: (0, Utils_1.throwIfUndefined)(callerFeePrefetchPromise, "Caller fee prefetch failed!"),
+                                callerFeeRate: (0, Utils_1.throwIfUndefined)(callerFeePrefetchPromise[version], "Caller fee prefetch failed!"),
                                 frontingFeeRate: 0n,
                                 additionalParams
                             }, this._options.postRequestTimeout, abortController.signal, retryCount > 0 ? false : undefined);
                         }, undefined, e => e instanceof RequestError_1.RequestError, abortController.signal);
                         this.logger.debug("create(" + lp.url + "): LP response: ", resp);
-                        const callerFeeShare = (await callerFeePrefetchPromise);
+                        const callerFeeShare = (await callerFeePrefetchPromise[version]);
                         const [pricingInfo, gasPricingInfo, { vault, vaultUtxoValue }] = await Promise.all([
                             this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.SPV_VAULT_FROM_BTC], false, resp.btcAmountSwap, resp.total * (100000n + callerFeeShare) / 100000n, amountData.token, {}, pricePrefetchPromise, usdPricePrefetchPromise, abortController.signal),
                             _options.gasAmount === 0n ? Promise.resolve(undefined) : this.verifyReturnedPrice({ ...lp.services[SwapType_1.SwapType.SPV_VAULT_FROM_BTC], swapBaseFee: 0 }, //Base fee should be charged only on the amount, not on gas
@@ -502,7 +547,8 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                             callerFeeShare: resp.callerFeeShare,
                             frontingFeeShare: resp.frontingFeeShare,
                             executionFeeShare: resp.executionFeeShare,
-                            genesisSmartChainBlockHeight: await (0, Utils_1.throwIfUndefined)(finalizedBlockHeightPrefetchPromise, "Finalize block height promise failed!")
+                            genesisSmartChainBlockHeight: await (0, Utils_1.throwIfUndefined)(finalizedBlockHeightPrefetchPromise, "Finalize block height promise failed!"),
+                            contractVersion: version
                         };
                         const quote = new SpvFromBTCSwap_1.SpvFromBTCSwap(this, swapInit);
                         return quote;
@@ -522,9 +568,9 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
      * @param vault SPV vault processing the swap
      * @param lp Intermediary (LP) used as a counterparty for the swap
      */
-    async recoverFromState(state, vault, lp) {
+    async recoverFromState(state, contractVersion, vault, lp) {
         //Get the vault
-        vault ??= await this._contract.getVaultData(state.owner, state.vaultId);
+        vault ??= await this._contract(contractVersion).getVaultData(state.owner, state.vaultId);
         if (vault == null)
             return null;
         if (state.btcTxId == null)
@@ -532,7 +578,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
         const btcTx = await this._btcRpc.getTransaction(state.btcTxId);
         if (btcTx == null)
             return null;
-        const withdrawalData = await this._contract.getWithdrawalData(btcTx)
+        const withdrawalData = await this._contract(contractVersion).getWithdrawalData(btcTx)
             .catch(e => {
             this.logger.warn(`Error parsing withdrawal data for tx ${btcTx.txid}: `, e);
             return null;
@@ -590,7 +636,8 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
             callerFeeShare: withdrawalData.callerFeeRate,
             frontingFeeShare: withdrawalData.frontingFeeRate,
             executionFeeShare: withdrawalData.executionFeeRate,
-            genesisSmartChainBlockHeight: txBlock?.blockHeight ?? 0
+            genesisSmartChainBlockHeight: txBlock?.blockHeight ?? 0,
+            contractVersion
         };
         const quote = new SpvFromBTCSwap_1.SpvFromBTCSwap(this, swapInit);
         quote._data = withdrawalData;
@@ -644,11 +691,20 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
             script: randomVaultOutScript,
             amount: 600n
         });
-        const opReturnData = this._contract.toOpReturnData(this._chain.randomAddress(), includeGasToken ? [0xffffffffffffffffn, 0xffffffffffffffffn] : [0xffffffffffffffffn]);
+        let longestOpReturnData = undefined;
+        for (let contractVersion in this.versionedContracts) {
+            if (this.versionedContracts[contractVersion].spvVaultContract == null)
+                continue;
+            const opReturnData = this._contract(contractVersion).toOpReturnData(this._chain.randomAddress(), includeGasToken ? [0xffffffffffffffffn, 0xffffffffffffffffn] : [0xffffffffffffffffn]);
+            if (longestOpReturnData == null || longestOpReturnData.length < opReturnData.length)
+                longestOpReturnData = opReturnData;
+        }
+        if (longestOpReturnData == null)
+            throw new Error(`No contract version supporting the Spv Vault BTC -> ${this.chainIdentifier} swaps found!`);
         psbt.addOutput({
             script: Buffer.concat([
-                opReturnData.length <= 75 ? Buffer.from([0x6a, opReturnData.length]) : Buffer.from([0x6a, 0x4c, opReturnData.length]),
-                opReturnData
+                longestOpReturnData.length <= 75 ? Buffer.from([0x6a, longestOpReturnData.length]) : Buffer.from([0x6a, 0x4c, longestOpReturnData.length]),
+                longestOpReturnData
             ]),
             amount: 0n
         });
@@ -661,7 +717,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
     async _checkPastSwaps(pastSwaps) {
         const changedSwaps = new Set();
         const removeSwaps = [];
-        const broadcastedOrConfirmedSwaps = [];
+        const broadcastedOrConfirmedSwaps = {};
         for (let pastSwap of pastSwaps) {
             let changed = false;
             if (pastSwap._state === SpvFromBTCSwap_1.SpvFromBTCSwapState.SIGNED ||
@@ -695,56 +751,63 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                 changedSwaps.add(pastSwap);
             if (pastSwap._state === SpvFromBTCSwap_1.SpvFromBTCSwapState.BROADCASTED || pastSwap._state === SpvFromBTCSwap_1.SpvFromBTCSwapState.BTC_TX_CONFIRMED) {
                 if (pastSwap._data != null)
-                    broadcastedOrConfirmedSwaps.push(pastSwap);
+                    (broadcastedOrConfirmedSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap);
             }
         }
-        const checkWithdrawalStateSwaps = [];
-        const _fronts = await this._contract.getFronterAddresses(broadcastedOrConfirmedSwaps.map(val => ({
-            ...val.getSpvVaultData(),
-            withdrawal: val._data
-        })));
-        const _vaultUtxos = await this._contract.getVaultLatestUtxos(broadcastedOrConfirmedSwaps.map(val => val.getSpvVaultData()));
-        for (const pastSwap of broadcastedOrConfirmedSwaps) {
-            const fronterAddress = _fronts[pastSwap._data.getTxId()];
-            const vault = pastSwap.getSpvVaultData();
-            const latestVaultUtxo = _vaultUtxos[vault.owner]?.[vault.vaultId.toString(10)];
-            if (fronterAddress === undefined)
-                this.logger.warn(`_checkPastSwaps(): No fronter address returned for ${pastSwap._data.getTxId()}`);
-            if (latestVaultUtxo === undefined)
-                this.logger.warn(`_checkPastSwaps(): No last vault utxo returned for ${pastSwap._data.getTxId()}`);
-            if (await pastSwap._shouldCheckWithdrawalState(fronterAddress, latestVaultUtxo))
-                checkWithdrawalStateSwaps.push(pastSwap);
-        }
-        const withdrawalStates = await this._contract.getWithdrawalStates(checkWithdrawalStateSwaps.map(val => ({
-            withdrawal: val._data,
-            scStartBlockheight: val._genesisSmartChainBlockHeight
-        })));
-        for (const pastSwap of checkWithdrawalStateSwaps) {
-            const status = withdrawalStates[pastSwap._data.getTxId()];
-            if (status == null) {
-                this.logger.warn(`_checkPastSwaps(): No withdrawal state returned for ${pastSwap._data.getTxId()}`);
+        for (let contractVersion in broadcastedOrConfirmedSwaps) {
+            if (this.versionedContracts[contractVersion] == null) {
+                this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${contractVersion}! Skipping these swaps!`);
                 continue;
             }
-            this.logger.debug("syncStateFromChain(): status of " + pastSwap._data.btcTx.txid, status?.type);
-            let changed = false;
-            switch (status.type) {
-                case base_1.SpvWithdrawalStateType.FRONTED:
-                    pastSwap._frontTxId = status.txId;
-                    pastSwap._state = SpvFromBTCSwap_1.SpvFromBTCSwapState.FRONTED;
-                    changed ||= true;
-                    break;
-                case base_1.SpvWithdrawalStateType.CLAIMED:
-                    pastSwap._claimTxId = status.txId;
-                    pastSwap._state = SpvFromBTCSwap_1.SpvFromBTCSwapState.CLAIMED;
-                    changed ||= true;
-                    break;
-                case base_1.SpvWithdrawalStateType.CLOSED:
-                    pastSwap._state = SpvFromBTCSwap_1.SpvFromBTCSwapState.CLOSED;
-                    changed ||= true;
-                    break;
+            const _broadcastedOrConfirmedSwaps = broadcastedOrConfirmedSwaps[contractVersion];
+            const checkWithdrawalStateSwaps = [];
+            const _fronts = await this._contract(contractVersion).getFronterAddresses(_broadcastedOrConfirmedSwaps.map(val => ({
+                ...val.getSpvVaultData(),
+                withdrawal: val._data
+            })));
+            const _vaultUtxos = await this._contract(contractVersion).getVaultLatestUtxos(_broadcastedOrConfirmedSwaps.map(val => val.getSpvVaultData()));
+            for (const pastSwap of _broadcastedOrConfirmedSwaps) {
+                const fronterAddress = _fronts[pastSwap._data.getTxId()];
+                const vault = pastSwap.getSpvVaultData();
+                const latestVaultUtxo = _vaultUtxos[vault.owner]?.[vault.vaultId.toString(10)];
+                if (fronterAddress === undefined)
+                    this.logger.warn(`_checkPastSwaps(): No fronter address returned for ${pastSwap._data.getTxId()}`);
+                if (latestVaultUtxo === undefined)
+                    this.logger.warn(`_checkPastSwaps(): No last vault utxo returned for ${pastSwap._data.getTxId()}`);
+                if (await pastSwap._shouldCheckWithdrawalState(fronterAddress, latestVaultUtxo))
+                    checkWithdrawalStateSwaps.push(pastSwap);
+            }
+            const withdrawalStates = await this._contract(contractVersion).getWithdrawalStates(checkWithdrawalStateSwaps.map(val => ({
+                withdrawal: val._data,
+                scStartBlockheight: val._genesisSmartChainBlockHeight
+            })));
+            for (const pastSwap of checkWithdrawalStateSwaps) {
+                const status = withdrawalStates[pastSwap._data.getTxId()];
+                if (status == null) {
+                    this.logger.warn(`_checkPastSwaps(): No withdrawal state returned for ${pastSwap._data.getTxId()}`);
+                    continue;
+                }
+                this.logger.debug("syncStateFromChain(): status of " + pastSwap._data.btcTx.txid, status?.type);
+                let changed = false;
+                switch (status.type) {
+                    case base_1.SpvWithdrawalStateType.FRONTED:
+                        pastSwap._frontTxId = status.txId;
+                        pastSwap._state = SpvFromBTCSwap_1.SpvFromBTCSwapState.FRONTED;
+                        changed ||= true;
+                        break;
+                    case base_1.SpvWithdrawalStateType.CLAIMED:
+                        pastSwap._claimTxId = status.txId;
+                        pastSwap._state = SpvFromBTCSwap_1.SpvFromBTCSwapState.CLAIMED;
+                        changed ||= true;
+                        break;
+                    case base_1.SpvWithdrawalStateType.CLOSED:
+                        pastSwap._state = SpvFromBTCSwap_1.SpvFromBTCSwapState.CLOSED;
+                        changed ||= true;
+                        break;
+                }
+                if (changed)
+                    changedSwaps.add(pastSwap);
             }
-            if (changed)
-                changedSwaps.add(pastSwap);
         }
         return {
             changedSwaps: Array.from(changedSwaps),

package/dist/swaps/trusted/ln/LnForGasWrapper.js

@@ -73,7 +73,8 @@ class LnForGasWrapper extends ISwapWrapper_1.ISwapWrapper {
             swapFee: resp.swapFee,
             swapFeeBtc: resp.swapFeeSats,
             token,
-            exactIn: false
+            exactIn: false,
+            contractVersion: "v1"
         };
         const quote = new LnForGasSwap_1.LnForGasSwap(this, quoteInit);
         return quote;

package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js

@@ -84,7 +84,8 @@ class OnchainForGasWrapper extends ISwapWrapper_1.ISwapWrapper {
             swapFee: resp.swapFee,
             swapFeeBtc: resp.swapFeeSats,
             exactIn: false,
-            token
+            token,
+            contractVersion: "v1"
         });
         return quote;
     }

package/dist/utils/Utils.d.ts

@@ -17,6 +17,15 @@ export declare function throwIfUndefined<T>(promise: Promise<T | undefined>, msg
  * @category Utilities
  */
 export declare function promiseAny<T>(promises: Promise<T>[]): Promise<T>;
+/**
+ * Maps an array to object properties using the translation function
+ *
+ * @param array
+ * @param translator
+ */
+export declare function mapArrayToObject<T extends string[], O>(array: T, translator: (key: T[number]) => O): {
+    [key in T[number]]: O;
+};
 /**
  * Maps a JS object to another JS object based on the translation function, the translation function is called for every
  *  property (value/key) of the old object and returns the new value of for this property

package/dist/utils/Utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseHashValueExact32Bytes = exports.toDecimal = exports.fromDecimal = exports.getTxoHash = exports.randomBytes = exports.toBigInt = exports.bigIntCompare = exports.bigIntMax = exports.bigIntMin = exports.extendAbortController = exports.mapToArray = exports.objectMap = exports.promiseAny = exports.throwIfUndefined = void 0;
+exports.parseHashValueExact32Bytes = exports.toDecimal = exports.fromDecimal = exports.getTxoHash = exports.randomBytes = exports.toBigInt = exports.bigIntCompare = exports.bigIntMax = exports.bigIntMin = exports.extendAbortController = exports.mapToArray = exports.objectMap = exports.mapArrayToObject = exports.promiseAny = exports.throwIfUndefined = void 0;
 const buffer_1 = require("buffer");
 const utils_1 = require("@noble/hashes/utils");
 const sha2_1 = require("@noble/hashes/sha2");
@@ -48,6 +48,20 @@ function promiseAny(promises) {
     });
 }
 exports.promiseAny = promiseAny;
+/**
+ * Maps an array to object properties using the translation function
+ *
+ * @param array
+ * @param translator
+ */
+function mapArrayToObject(array, translator) {
+    const obj = {};
+    array.forEach((item) => {
+        obj[item] = translator(item);
+    });
+    return obj;
+}
+exports.mapArrayToObject = mapArrayToObject;
 /**
  * Maps a JS object to another JS object based on the translation function, the translation function is called for every
  *  property (value/key) of the old object and returns the new value of for this property

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "8.6.3",
+  "version": "8.7.1",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",
@@ -23,7 +23,7 @@
   "author": "adambor",
   "license": "ISC",
   "dependencies": {
-    "@atomiqlabs/base": "^13.1.9",
+    "@atomiqlabs/base": "^13.5.0",
     "@atomiqlabs/bolt11": "1.6.1",
     "@atomiqlabs/btc-mempool": "^1.0.4",
     "@atomiqlabs/messenger-nostr": "^2.0.0",

package/src/events/UnifiedSwapEventListener.ts

@@ -82,9 +82,10 @@ export class UnifiedSwapEventListener<
 
         for(let event of events) {
             const escrowHash = chainEventToEscrowHash(event);
+            const eventVersion = event.contractVersion ?? "v1";
             if(escrowHash!=null) {
                 const swap = swapsByEscrowHash[escrowHash];
-                if(swap!=null) {
+                if(swap!=null && (swap._contractVersion ?? "v1")===eventVersion) {
                     const obj = this.listeners[swap.getType()];
                     if(obj==null) continue;
                     await obj.listener(event, swap);
@@ -124,8 +125,9 @@ export class UnifiedSwapEventListener<
 
         for(let claimData in htlcCheckInitializeEvents) {
             const event = htlcCheckInitializeEvents[claimData];
+            const eventVersion = event.contractVersion ?? "v1";
             const swap = swapsByClaimDataHash[claimData];
-            if(swap!=null) {
+            if(swap!=null && (swap._contractVersion ?? "v1")===eventVersion) {
                 const obj = this.listeners[swap.getType()];
                 if(obj==null) continue;
                 await obj.listener(event, swap);

package/src/intermediaries/Intermediary.ts

@@ -55,6 +55,10 @@ export class Intermediary {
      * Addresses of the intermediary on smart chains, used for checking the provided signatures
      */
     readonly addresses: {[chainIdentifier: string]: string};
+    /**
+     * Contract versions of the intermediary on smart chains
+     */
+    readonly contractVersions: {[chainIdentifier: string]: string};
     /**
      * Swap protocol services offered by the intermediary
      */
@@ -99,12 +103,14 @@ export class Intermediary {
         url: string,
         addresses: {[chainIdentifier: string]: string},
         services: ServicesType,
-        reputation: { [chainIdentifier: string]: SingleChainReputationType } = {}
+        reputation: { [chainIdentifier: string]: SingleChainReputationType } = {},
+        contractVersions: {[chainIdentifier: string]: string} = {},
     ) {
         this.url = url;
         this.addresses = addresses;
         this.services = services;
         this.reputation = reputation;
+        this.contractVersions = contractVersions;
 
         this.swapBounds = {};
         for(let _swapType in this.services) {
@@ -247,4 +253,28 @@ export class Intermediary {
         return this.addresses[chainIdentifier];
     }
 
+    /**
+     * Returns the contract version used by the intermediary for a given chain
+     *
+     * @param chainIdentifier
+     */
+    getContractVersion(chainIdentifier: string): string {
+        return this.contractVersions[chainIdentifier] ?? "v1";
+    }
+
+    /**
+     * Returns the range of contract versions used by the LPs
+     *
+     * @param chainIdentifier
+     * @param lps
+     */
+    static getContractVersionsForLps(chainIdentifier: string, lps: Intermediary[]): string[] {
+        const versions: string[] = [];
+        lps.forEach((lp) => {
+            const lpVersion = lp.getContractVersion(chainIdentifier);
+            if(!versions.includes(lpVersion)) versions.push(lpVersion);
+        });
+        return versions;
+    }
+
 }

package/src/intermediaries/IntermediaryDiscovery.ts

@@ -1,6 +1,6 @@
 import {Intermediary, ServicesType} from "./Intermediary";
 import {SwapType} from "../enums/SwapType";
-import {SwapContract} from "@atomiqlabs/base";
+import {SpvVaultContract, SwapContract} from "@atomiqlabs/base";
 import {EventEmitter} from "events";
 import {Buffer} from "buffer";
 import {bigIntMax, bigIntMin, extendAbortController} from "../utils/Utils";
@@ -169,7 +169,7 @@ export class IntermediaryDiscovery extends EventEmitter {
     /**
      * Swap contracts for checking intermediary signatures
      */
-    swapContracts: {[key: string]: SwapContract};
+    swapContracts: {[chainIdentifier: string]: {[contractVersion: string]: {swapContract: SwapContract, spvVaultContract: SpvVaultContract}}};
     /**
      * Registry URL used as a source for the list of intermediaries, this should be a link to a
      *  github-hosted JSON file
@@ -193,7 +193,7 @@ export class IntermediaryDiscovery extends EventEmitter {
     private overrideNodeUrls?: string[];
 
     constructor(
-        swapContracts: {[key: string]: SwapContract},
+        swapContracts: {[chainIdentifier: string]: {[contractVersion: string]: {swapContract: SwapContract, spvVaultContract: SpvVaultContract}}},
         registryUrl: string = REGISTRY_URL,
         nodeUrls?: string[],
         httpRequestTimeout?: number,
@@ -236,7 +236,11 @@ export class IntermediaryDiscovery extends EventEmitter {
      * @param url
      * @param abortSignal
      */
-    private async getNodeInfo(url: string, abortSignal?: AbortSignal) : Promise<{addresses: {[key: string]: string}, info: InfoHandlerResponseEnvelope}> {
+    private async getNodeInfo(url: string, abortSignal?: AbortSignal) : Promise<{
+        addresses: {[chainIdentifier: string]: string},
+        contractVersions: {[chainIdentifier: string]: string},
+        info: InfoHandlerResponseEnvelope
+    }> {
         const response = await tryWithRetries(
             () => IntermediaryAPI.getIntermediaryInfo(url, this.httpRequestTimeout, abortSignal),
             {maxRetries: 3, delay: 100, exponential: true},
@@ -247,14 +251,22 @@ export class IntermediaryDiscovery extends EventEmitter {
         abortSignal?.throwIfAborted();
 
         const promises: Promise<void>[] = [];
-        const addresses: {[key: string]: string} = {};
+        const addresses: {[chainIdentifier: string]: string} = {};
+        const contractVersions: {[chainIdentifier: string]: string} = {};
         for(let chain in response.chains) {
             if(this.swapContracts[chain]!=null) {
+                const {signature, address, contractVersion} = response.chains[chain];
+                const _contractVersion = contractVersion ?? "v1";
+                const contract = this.swapContracts[chain][_contractVersion];
+                if(contract==null) {
+                    logger.warn("getNodeInfo(): Unknown chain contract version "+_contractVersion+" for "+chain+" reported by intermediary: "+url);
+                    continue;
+                }
                 promises.push((async () => {
-                    const {signature, address} = response.chains[chain];
                     try {
-                        await this.swapContracts[chain].isValidDataSignature(Buffer.from(response.envelope), signature, address);
+                        await contract.swapContract.isValidDataSignature(Buffer.from(response.envelope), signature, address);
                         addresses[chain] = address;
+                        contractVersions[chain] = _contractVersion;
                     } catch (e) {
                         logger.warn("getNodeInfo(): Failed to verify "+chain+" signature for intermediary: "+url);
                     }
@@ -285,6 +297,7 @@ export class IntermediaryDiscovery extends EventEmitter {
 
         return {
             addresses,
+            contractVersions,
             info
         };
     }
@@ -303,7 +316,7 @@ export class IntermediaryDiscovery extends EventEmitter {
             for(let key in nodeInfo.info.services) {
                 services[swapHandlerTypeToSwapType(key as SwapHandlerType)] = nodeInfo.info.services[key as SwapHandlerType];
             }
-            return new Intermediary(url, nodeInfo.addresses, services);
+            return new Intermediary(url, nodeInfo.addresses, services, undefined, nodeInfo.contractVersions);
         } catch (e: any) {
             logger.warn("fetchIntermediaries(): Intermediary "+url+` is unreachable due to ${e.name ?? e.message} error, skipping...`);
             logger.debug("fetchIntermediaries(): Error contacting intermediary "+url+": ", e);
@@ -476,6 +489,8 @@ export class IntermediaryDiscovery extends EventEmitter {
     /**
      * Returns swap candidates for a specific swap type & token address
      *
+     * @remark Also filters the LPs based on supported swap versions
+     *
      * @param chainIdentifier Chain identifier of the smart chain
      * @param swapType Swap protocol type
      * @param tokenAddress Token address
@@ -491,6 +506,10 @@ export class IntermediaryDiscovery extends EventEmitter {
             if(swapService.chainTokens==null) return false;
             if(swapService.chainTokens[chainIdentifier]==null) return false;
             if(!swapService.chainTokens[chainIdentifier].includes(tokenAddress.toString())) return false;
+            const contracts = this.swapContracts[chainIdentifier][e.getContractVersion(chainIdentifier) ?? "v1"];
+            if(contracts==null) return false;
+            if(swapType===SwapType.FROM_BTCLN_AUTO && !contracts.swapContract?.supportsInitWithoutClaimer) return false;
+            if(swapType===SwapType.SPV_VAULT_FROM_BTC && contracts.spvVaultContract==null) return false;
             return true;
         });
 

package/src/intermediaries/apis/IntermediaryAPI.ts

@@ -14,7 +14,8 @@ export type InfoHandlerResponse = {
     chains: {
         [chainIdentifier: string]: {
             address: string,
-            signature: string
+            signature: string,
+            contractVersion?: string,
         }
     }
 };