@atomiqlabs/sdk 8.4.4 → 8.5.0

package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts

@@ -15,11 +15,55 @@ import { LNURLPayParamsWithUrl } from "../../../../types/lnurl/LNURLPay";
 import { AllOptional } from "../../../../utils/TypeUtils";
 import { LightningInvoiceCreateService } from "../../../../types/wallets/LightningInvoiceCreateService";
 export type ToBTCLNOptions = {
+    /**
+     * HTLC expiration timeout in seconds to use when offering the HTLC to the LP. Larger expirations mean that more
+     *  lightning network payment paths can be considered (every hop in the lightning network payment adds additional
+     *  timeout requirement). On the other side, larger expiration also means that user's funds are locked for longer
+     *  in case of a non-cooperative LP.
+     *
+     * Uses 5 days as default.
+     */
     expirySeconds?: number;
+    /**
+     * Maximum fee for routing the swap output payment through the lightning network. Higher fee percentages means that
+     *  more payment routes can be considered (every hop in the lightning network payment adds additional fee
+     *  requirements).
+     *
+     * The fee is express as percentage of the swap value, uses `0.2` by default which means the maximum
+     *  routing fee is capped at 0.2% of the swap value.
+     *
+     * The full fee also contains the base component (set by `maxRoutingBaseFee` option), the resulting maximum routing
+     *  fee rate is:
+     *
+     * `maxRoutingFee` = `maxRoutingBaseFee` sats + `value` * `maxRoutingFeePercentage`%
+     */
+    maxRoutingFeePercentage?: number;
+    /**
+     *
+     * Maximum base fee (in sats) for routing the swap output payment through the lightning network. Higher fee
+     *  percentages means that more payment routes can be considered (every hop in the lightning network payment adds additional fee
+     *  requirements).
+     *
+     * Uses 10 sats as a default.
+     *
+     * The full fee also contains the value percentage component (set by `maxRoutingFeePercentage` option), the
+     *  resulting maximum routing fee rate is:
+     *
+     * `maxRoutingFee` = `maxRoutingBaseFee` sats + (`value` * `maxRoutingFeePercentage`%)
+     */
+    maxRoutingBaseFee?: bigint;
+    /**
+     * @deprecated Use `maxRoutingFeePercentage` and express the routing fee in percentage instead!
+     */
+    maxRoutingPPM?: bigint;
+    /**
+     * @deprecated Adjust fee with `maxRoutingFeePercentage` & `maxRoutingBaseFee` params!
+     */
     maxFee?: bigint | Promise<bigint>;
+    /**
+     * @deprecated Pass desired HTLC expiration timeout as `expirySeconds`
+     */
     expiryTimestamp?: bigint;
-    maxRoutingPPM?: bigint;
-    maxRoutingBaseFee?: bigint;
 };
 export type ToBTCLNWrapperOptions = ISwapWrapperOptions & {
     lightningBaseFee: number;
@@ -71,7 +115,7 @@ export declare class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T
      * @param parsedPr Parsed bolt11 lightning invoice
      * @param token Smart chain token to be used in the swap
      * @param lp
-     * @param options Swap options as passed to the swap create function
+     * @param calculatedOptions Swap options computed from the swap create options
      * @param data Parsed swap data returned by the LP
      * @param requiredTotal Required total to be paid on the input (for exactIn swaps)
      *
@@ -88,7 +132,7 @@ export declare class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T
      * @param lp Intermediary
      * @param pr bolt11 lightning network invoice
      * @param parsedPr Parsed bolt11 lightning network invoice
-     * @param options Options as passed to the swap create function
+     * @param calculatedOptions Swap options computed from the swap create options
      * @param preFetches
      * @param abort Abort signal or controller, if AbortController is passed it is used as-is, when AbortSignal is passed
      *  it is extended with extendAbortController and then used
@@ -110,7 +154,9 @@ export declare class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T
      * @param abortSignal Abort signal
      * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
      */
-    create(signer: string, recipient: string, amountData: Omit<AmountData, "amount">, lps: Intermediary[], options?: ToBTCLNOptions, additionalParams?: Record<string, any>, abortSignal?: AbortSignal, preFetches?: {
+    create(signer: string, recipient: string, amountData: Omit<AmountData, "amount"> & {
+        exactIn: false;
+    }, lps: Intermediary[], options?: ToBTCLNOptions, additionalParams?: Record<string, any>, abortSignal?: AbortSignal, preFetches?: {
         feeRatePromise: Promise<string | undefined>;
         pricePreFetchPromise: Promise<bigint | undefined>;
         usdPricePrefetchPromise: Promise<number | undefined>;
@@ -138,7 +184,7 @@ export declare class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T
      * @param lp Intermediary (LPs) to get the quote from
      * @param dummyPr Dummy minimum value bolt11 lightning invoice returned from the LNURL-pay, used to estimate
      *  network fees for an actual invoice
-     * @param options Optional additional quote options
+     * @param calculatedOptions Swap options computed from the swap create options
      * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
      * @param abortSignal Abort signal
      * @param additionalParams Additional params to be sent to the intermediary

package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js

@@ -23,7 +23,7 @@ const RetryUtils_1 = require("../../../../utils/RetryUtils");
 class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
     constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, contract, prices, tokens, swapDataDeserializer, options, events) {
         super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, contract, prices, tokens, swapDataDeserializer, {
-            paymentTimeoutSeconds: options?.paymentTimeoutSeconds ?? 4 * 24 * 60 * 60,
+            paymentTimeoutSeconds: options?.paymentTimeoutSeconds ?? 5 * 24 * 60 * 60,
             lightningBaseFee: options?.lightningBaseFee ?? 10,
             lightningFeePPM: options?.lightningFeePPM ?? 2000
         }, events);
@@ -36,7 +36,9 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
     toRequiredSwapOptions(amountData, options, pricePreFetchPromise, abortSignal) {
         const expirySeconds = options?.expirySeconds ?? this._options.paymentTimeoutSeconds;
         const maxRoutingBaseFee = options?.maxRoutingBaseFee ?? BigInt(this._options.lightningBaseFee);
-        const maxRoutingPPM = options?.maxRoutingPPM ?? BigInt(this._options.lightningFeePPM);
+        const maxRoutingPPM = options?.maxRoutingFeePercentage != null
+            ? BigInt(Math.floor(options.maxRoutingFeePercentage * 10000))
+            : options?.maxRoutingPPM ?? BigInt(this._options.lightningFeePPM);
         let maxFee;
         if (options?.maxFee != null) {
             maxFee = options.maxFee;
@@ -56,10 +58,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
             maxFee = this.calculateFeeForAmount(amountData.amount, maxRoutingBaseFee, maxRoutingPPM);
         }
         return {
-            expirySeconds,
             expiryTimestamp: options?.expiryTimestamp ?? BigInt(Math.floor(Date.now() / 1000) + expirySeconds),
-            maxRoutingBaseFee,
-            maxRoutingPPM,
             maxFee
         };
     }
@@ -101,7 +100,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
      * @param parsedPr Parsed bolt11 lightning invoice
      * @param token Smart chain token to be used in the swap
      * @param lp
-     * @param options Swap options as passed to the swap create function
+     * @param calculatedOptions Swap options computed from the swap create options
      * @param data Parsed swap data returned by the LP
      * @param requiredTotal Required total to be paid on the input (for exactIn swaps)
      *
@@ -109,8 +108,8 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
      *
      * @private
      */
-    async verifyReturnedData(signer, resp, parsedPr, token, lp, options, data, requiredTotal) {
-        if (resp.routingFeeSats > await options.maxFee)
+    async verifyReturnedData(signer, resp, parsedPr, token, lp, calculatedOptions, data, requiredTotal) {
+        if (resp.routingFeeSats > await calculatedOptions.maxFee)
             throw new IntermediaryError_1.IntermediaryError("Invalid max fee sats returned");
         if (requiredTotal != null && resp.total !== requiredTotal)
             throw new IntermediaryError_1.IntermediaryError("Invalid data returned - total amount");
@@ -119,7 +118,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
         const claimHash = this._contract.getHashForHtlc(Buffer.from(parsedPr.tagsObject.payment_hash, "hex"));
         if (data.getAmount() !== resp.total ||
             !Buffer.from(data.getClaimHash(), "hex").equals(claimHash) ||
-            data.getExpiry() !== options.expiryTimestamp ||
+            data.getExpiry() !== calculatedOptions.expiryTimestamp ||
             data.getType() !== base_1.ChainSwapType.HTLC ||
             !data.isPayIn() ||
             !data.isToken(token) ||
@@ -137,7 +136,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
      * @param lp Intermediary
      * @param pr bolt11 lightning network invoice
      * @param parsedPr Parsed bolt11 lightning network invoice
-     * @param options Options as passed to the swap create function
+     * @param calculatedOptions Swap options computed from the swap create options
      * @param preFetches
      * @param abort Abort signal or controller, if AbortController is passed it is used as-is, when AbortSignal is passed
      *  it is extended with extendAbortController and then used
@@ -145,7 +144,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
      *
      * @private
      */
-    async getIntermediaryQuote(signer, amountData, lp, pr, parsedPr, options, preFetches, abort, additionalParams) {
+    async getIntermediaryQuote(signer, amountData, lp, pr, parsedPr, calculatedOptions, preFetches, abort, additionalParams) {
         if (lp.services[SwapType_1.SwapType.TO_BTCLN] == null)
             throw new Error("LP service for processing to btcln swaps not found!");
         const abortController = abort instanceof AbortController ? abort : (0, Utils_1.extendAbortController)(abort);
@@ -155,8 +154,8 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
                 const { signDataPrefetch, response } = IntermediaryAPI_1.IntermediaryAPI.initToBTCLN(this.chainIdentifier, lp.url, {
                     offerer: signer,
                     pr,
-                    maxFee: await options.maxFee,
-                    expiryTimestamp: options.expiryTimestamp,
+                    maxFee: await calculatedOptions.maxFee,
+                    expiryTimestamp: calculatedOptions.expiryTimestamp,
                     token: amountData.token,
                     feeRate: (0, Utils_1.throwIfUndefined)(preFetches.feeRatePromise),
                     additionalParams
@@ -172,7 +171,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
             const totalFee = resp.swapFee + resp.maxFee;
             const data = new this._swapDataDeserializer(resp.data);
             data.setOfferer(signer);
-            await this.verifyReturnedData(signer, resp, parsedPr, amountData.token, lp, options, data);
+            await this.verifyReturnedData(signer, resp, parsedPr, amountData.token, lp, calculatedOptions, data);
             const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
                 this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.TO_BTCLN], true, amountOut, data.getAmount(), amountData.token, { networkFee: resp.maxFee }, preFetches.pricePreFetchPromise, preFetches.usdPricePrefetchPromise, abortController.signal),
                 this.verifyReturnedSignature(signer, data, resp, preFetches.feeRatePromise, signDataPromise, abortController.signal),
@@ -223,16 +222,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
         if (parsedPr.millisatoshis == null)
             throw new UserError_1.UserError("Must be an invoice with amount");
         const amountOut = (BigInt(parsedPr.millisatoshis) + 999n) / 1000n;
-        const expirySeconds = options?.expirySeconds ?? this._options.paymentTimeoutSeconds;
-        const maxRoutingBaseFee = options?.maxRoutingBaseFee ?? BigInt(this._options.lightningBaseFee);
-        const maxRoutingPPM = options?.maxRoutingPPM ?? BigInt(this._options.lightningFeePPM);
-        const _options = {
-            expirySeconds,
-            expiryTimestamp: options?.expiryTimestamp ?? BigInt(Math.floor(Date.now() / 1000) + expirySeconds),
-            maxRoutingBaseFee,
-            maxRoutingPPM,
-            maxFee: options?.maxFee ?? this.calculateFeeForAmount(amountOut, maxRoutingBaseFee, maxRoutingPPM)
-        };
+        const _options = this.toRequiredSwapOptions({ ...amountData, amount: amountOut }, options);
         if (parsedPr.tagsObject.payment_hash == null)
             throw new Error("Provided lightning invoice doesn't contain payment hash field!");
         await this.checkPaymentHashWasPaid(parsedPr.tagsObject.payment_hash);
@@ -279,14 +269,14 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
      * @param lp Intermediary (LPs) to get the quote from
      * @param dummyPr Dummy minimum value bolt11 lightning invoice returned from the LNURL-pay, used to estimate
      *  network fees for an actual invoice
-     * @param options Optional additional quote options
+     * @param calculatedOptions Swap options computed from the swap create options
      * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
      * @param abortSignal Abort signal
      * @param additionalParams Additional params to be sent to the intermediary
      *
      * @private
      */
-    async getIntermediaryQuoteExactIn(signer, amountData, invoiceCreateService, lp, dummyPr, options, preFetches, abortSignal, additionalParams) {
+    async getIntermediaryQuoteExactIn(signer, amountData, invoiceCreateService, lp, dummyPr, calculatedOptions, preFetches, abortSignal, additionalParams) {
         if (lp.services[SwapType_1.SwapType.TO_BTCLN] == null)
             throw new Error("LP service for processing to btcln swaps not found!");
         const abortController = (0, Utils_1.extendAbortController)(abortSignal);
@@ -298,8 +288,8 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
                     offerer: signer,
                     pr: dummyPr,
                     amount: amountData.amount,
-                    maxFee: await options.maxFee,
-                    expiryTimestamp: options.expiryTimestamp,
+                    maxFee: await calculatedOptions.maxFee,
+                    expiryTimestamp: calculatedOptions.expiryTimestamp,
                     additionalParams
                 }, this._options.postRequestTimeout, abortController.signal, retryCount > 0 ? false : undefined);
                 return {
@@ -331,7 +321,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
             const totalFee = resp.swapFee + resp.maxFee;
             const data = new this._swapDataDeserializer(resp.data);
             data.setOfferer(signer);
-            await this.verifyReturnedData(signer, resp, parsedInvoice, amountData.token, lp, options, data, amountData.amount);
+            await this.verifyReturnedData(signer, resp, parsedInvoice, amountData.token, lp, calculatedOptions, data, amountData.amount);
             const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
                 this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.TO_BTCLN], true, prepareResp.amount, data.getAmount(), amountData.token, { networkFee: resp.maxFee }, preFetches.pricePreFetchPromise, preFetches.usdPricePrefetchPromise, abortSignal),
                 this.verifyReturnedSignature(signer, data, resp, preFetches.feeRatePromise, signDataPromise, abortController.signal),
@@ -413,7 +403,7 @@ class ToBTCLNWrapper extends IToBTCWrapper_1.IToBTCWrapper {
                         throw new UserError_1.UserError("Amount more than maximum");
                 }
                 const invoice = await invoiceCreateService.getInvoice(Number(amountData.amount), _abortController.signal);
-                return (await this.create(signer, invoice, amountData, lps, options, additionalParams, _abortController.signal, {
+                return (await this.create(signer, invoice, { ...amountData, exactIn: false }, lps, options, additionalParams, _abortController.signal, {
                     feeRatePromise,
                     pricePreFetchPromise,
                     usdPricePrefetchPromise,

package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts

@@ -53,7 +53,7 @@ export declare class ToBTCSwap<T extends ChainType = ChainType> extends IToBTCSw
     /**
      * @inheritDoc
      */
-    getOutput(): TokenAmount<T["ChainId"], BtcToken<false>>;
+    getOutput(): TokenAmount<BtcToken<false>>;
     /**
      * @inheritDoc
      */

package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts

@@ -14,7 +14,13 @@ import { ISwap } from "../../../ISwap";
 import { AmountData } from "../../../../types/AmountData";
 import { AllOptional } from "../../../../utils/TypeUtils";
 export type ToBTCOptions = {
+    /**
+     * @deprecated Ignored by the LP anyway
+     */
     confirmationTarget?: number;
+    /**
+     * @deprecated Default 2 confirmations should be enough for any currently supported amount by atomiq
+     */
     confirmations?: number;
 };
 export type ToBTCWrapperOptions = ISwapWrapperOptions & {

package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts

@@ -323,7 +323,7 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
      *
      * @internal
      */
-    protected getOutputWithoutFee(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    protected getOutputWithoutFee(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * Returns the swap fee charged by the intermediary (LP) on this swap
      *
@@ -361,15 +361,15 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
     /**
      * @inheritDoc
      */
-    getOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    getOutput(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * @inheritDoc
      */
-    getGasDropOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    getGasDropOutput(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * @inheritDoc
      */
-    getInputWithoutFee(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
+    getInputWithoutFee(): TokenAmount<BtcToken<false>, true>;
     /**
      * @inheritDoc
      */
@@ -377,7 +377,7 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
     /**
      * @inheritDoc
      */
-    getInput(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
+    getInput(): TokenAmount<BtcToken<false>, true>;
     /**
      * @inheritDoc
      */
@@ -440,7 +440,7 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
     /**
      * @inheritDoc
      */
-    estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<any, BtcToken<false>, true> | null>;
+    estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<BtcToken<false>, true> | null>;
     /**
      * @inheritDoc
      */

package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts

@@ -15,9 +15,40 @@ import { IClaimableSwapWrapper } from "../IClaimableSwapWrapper";
 import { AmountData } from "../../types/AmountData";
 import { AllOptional } from "../../utils/TypeUtils";
 export type SpvFromBTCOptions = {
-    gasAmount?: bigint;
+    /**
+     * Optional additional native token to receive as an output of the swap (e.g. STRK on Starknet or cBTC on Citrea).
+     *
+     * When passed as a `bigint` it is specified in base units of the token and in `string` it is the human readable
+     *  decimal format.
+     */
+    gasAmount?: bigint | string;
+    /**
+     * The LP enforces a minimum bitcoin fee rate in sats/vB for the swap transaction. With this config you can optionally
+     *  limit how high of a minimum fee rate would you accept.
+     *
+     * By default the maximum allowed fee rate is calculated dynamically based on current bitcoin fee rate as:
+     *
+     * `maxAllowedBitcoinFeeRate` = 10 + `currentBitcoinFeeRate` * 1.5
+     */
+    maxAllowedBitcoinFeeRate?: number;
+    /**
+     * A flag to attach 0 watchtower fee to the swap, this would make the settlement unattractive for the watchtowers
+     *  and therefore automatic settlement for such swaps will not be possible, you will have to settle manually
+     *  with {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim} functions.
+     */
     unsafeZeroWatchtowerFee?: boolean;
+    /**
+     * A safety factor to use when estimating the watchtower fee to attach to the swap (this has to cover the gas fee
+     *  of watchtowers settling the swap). A higher multiple here would mean that a swap is more attractive for
+     *  watchtowers to settle automatically.
+     *
+     * Uses a `1.25` multiple by default (i.e. the current network fee is multiplied by 1.25 and then used to estimate
+     *  the settlement gas fee cost)
+     */
     feeSafetyFactor?: number;
+    /**
+     * @deprecated Use `maxAllowedBitcoinFeeRate` instead!
+     */
     maxAllowedNetworkFeeRate?: number;
 };
 export type SpvFromBTCWrapperOptions = ISwapWrapperOptions & {

package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js

@@ -13,6 +13,7 @@ const RequestError_1 = require("../../errors/RequestError");
 const IntermediaryError_1 = require("../../errors/IntermediaryError");
 const btc_signer_1 = require("@scure/btc-signer");
 const RetryUtils_1 = require("../../utils/RetryUtils");
+const UserError_1 = require("../../errors/UserError");
 /**
  * New spv vault (UTXO-controlled vault) based swaps for Bitcoin -> Smart chain swaps not requiring
  *  any initiation on the destination chain, and with the added possibility for the user to receive
@@ -316,7 +317,7 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
                     if (resp.total !== adjustedAmount)
                         throw new IntermediaryError_1.IntermediaryError("Invalid total returned");
                 }
-                if (options.gasAmount == null || options.gasAmount === 0n) {
+                if (options.gasAmount === 0n) {
                     if (resp.totalGas !== 0n)
                         throw new IntermediaryError_1.IntermediaryError("Invalid gas total returned");
                 }
@@ -420,11 +421,13 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
      */
     create(recipient, amountData, lps, options, additionalParams, abortSignal) {
         const _options = {
-            gasAmount: options?.gasAmount ?? 0n,
+            gasAmount: this.parseGasAmount(options?.gasAmount),
             unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
             feeSafetyFactor: options?.feeSafetyFactor ?? 1.25,
-            maxAllowedNetworkFeeRate: options?.maxAllowedNetworkFeeRate ?? Infinity
+            maxAllowedBitcoinFeeRate: options?.maxAllowedBitcoinFeeRate ?? options?.maxAllowedNetworkFeeRate ?? Infinity
         };
+        if (amountData.token === this._chain.getNativeCurrencyAddress() && _options.gasAmount !== 0n)
+            throw new UserError_1.UserError("Cannot specify `gasAmount` for swaps to a native token!");
         const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
         const pricePrefetchPromise = this.preFetchPrice(amountData, _abortController.signal);
         const usdPricePrefetchPromise = this.preFetchUsdPrice(_abortController.signal);
@@ -434,8 +437,8 @@ class SpvFromBTCWrapper extends ISwapWrapper_1.ISwapWrapper {
             undefined :
             this.preFetchPrice({ token: nativeTokenAddress }, _abortController.signal);
         const callerFeePrefetchPromise = this.preFetchCallerFeeShare(amountData, _options, pricePrefetchPromise, gasTokenPricePrefetchPromise, _abortController);
-        const bitcoinFeeRatePromise = _options.maxAllowedNetworkFeeRate != Infinity ?
-            Promise.resolve(_options.maxAllowedNetworkFeeRate) :
+        const bitcoinFeeRatePromise = _options.maxAllowedBitcoinFeeRate != Infinity ?
+            Promise.resolve(_options.maxAllowedBitcoinFeeRate) :
             this._btcRpc.getFeeRate().then(x => this._options.maxBtcFeeOffset + (x * this._options.maxBtcFeeMultiplier)).catch(e => {
                 _abortController.abort(e);
                 return undefined;

package/dist/swaps/trusted/ln/LnForGasSwap.d.ts

@@ -179,7 +179,7 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
     /**
      * @inheritDoc
      */
-    getOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    getOutput(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * @inheritDoc
      */
@@ -187,11 +187,11 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
     /**
      * @inheritDoc
      */
-    getInput(): TokenAmount<T["ChainId"], BtcToken<true>, true>;
+    getInput(): TokenAmount<BtcToken<true>, true>;
     /**
      * @inheritDoc
      */
-    getInputWithoutFee(): TokenAmount<T["ChainId"], BtcToken<true>, true>;
+    getInputWithoutFee(): TokenAmount<BtcToken<true>, true>;
     /**
      * Returns the swap fee charged by the intermediary (LP) on this swap
      *

package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts

@@ -199,7 +199,7 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     /**
      * @inheritDoc
      */
-    getOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    getOutput(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * @inheritDoc
      */
@@ -207,11 +207,11 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     /**
      * @inheritDoc
      */
-    getInput(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
+    getInput(): TokenAmount<BtcToken<false>, true>;
     /**
      * @inheritDoc
      */
-    getInputWithoutFee(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
+    getInputWithoutFee(): TokenAmount<BtcToken<false>, true>;
     /**
      * Returns the swap fee charged by the intermediary (LP) on this swap
      *
@@ -255,7 +255,7 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     /**
      * @inheritDoc
      */
-    estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<any, BtcToken<false>, true> | null>;
+    estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<BtcToken<false>, true> | null>;
     /**
      * @inheritDoc
      */

package/dist/types/Token.d.ts

@@ -1,15 +1,71 @@
+/**
+ * Type for all token types (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+export type Token<ChainIdentifier extends string = string> = {
+    /**
+     * Chain identifier for the token's chain
+     */
+    chainId: ChainIdentifier | "BITCOIN" | "LIGHTNING";
+    /**
+     * Ticker of the token
+     */
+    ticker: string;
+    /**
+     * Full name of the token
+     */
+    name: string;
+    /**
+     * Actual decimal places of the tokens
+     */
+    decimals: number;
+    /**
+     * The decimal places that should be rendered and displayed to the user
+     */
+    displayDecimals?: number;
+    /**
+     * Address of the token contract, or `""` for Bitcoin
+     */
+    address: string;
+    /**
+     * Legacy chain identifier distinguishing between Smart Chain and Bitcoin tokens
+     */
+    chain: "SC" | "BTC";
+    /**
+     * Legacy lightning flag, determines whether a Bitcoin token is an Lightning or on-chain one
+     */
+    lightning?: boolean;
+    /**
+     * Equality check between tokens
+     */
+    equals: (other: Token) => boolean;
+    /**
+     * Returns the
+     */
+    toString: () => string;
+};
+/**
+ * Type guard for a {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+export declare function isToken(obj: any): obj is Token;
 /**
  * Bitcoin token type (BTC on on-chain or lightning)
  *
  * @category Tokens
  */
-export type BtcToken<L = boolean> = {
-    chain: "BTC";
-    lightning: L;
+export type BtcToken<L = boolean> = Token & {
+    chainId: L extends true ? "LIGHTNING" : "BITCOIN";
     ticker: "BTC";
-    decimals: 8;
     name: L extends true ? "Bitcoin (lightning L2)" : "Bitcoin (on-chain L1)";
-    displayDecimals?: number;
+    decimals: 8;
+    displayDecimals: 8;
+    address: "";
+    chain: "BTC";
+    lightning: L;
+    toString: () => L extends true ? "BTC-LN" : "BTC";
 };
 /**
  * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
@@ -31,29 +87,13 @@ export declare const BitcoinTokens: {
  *
  * @category Tokens
  */
-export type SCToken<ChainIdentifier extends string = string> = {
-    chain: "SC";
+export type SCToken<ChainIdentifier extends string = string> = Token<ChainIdentifier> & {
     chainId: ChainIdentifier;
-    address: string;
-    ticker: string;
-    decimals: number;
-    displayDecimals?: number;
-    name: string;
+    chain: "SC";
+    toString: () => `${ChainIdentifier}-${string}`;
 };
 /**
  * Type guard for {@link SCToken} (token on the smart chain)
  * @category Tokens
  */
-export declare function isSCToken(obj: any): obj is SCToken;
-/**
- * Union type for all token types (BTC or smart chain)
- *
- * @category Tokens
- */
-export type Token<ChainIdentifier extends string = string> = BtcToken | SCToken<ChainIdentifier>;
-/**
- * Type guard for an union {@link Token} type, encompassing all tokens (BTC or smart chain)
- *
- * @category Tokens
- */
-export declare function isToken(obj: any): obj is Token;
+export declare function isSCToken<ChainIdentifier extends string = string>(obj: any, chainIdentifier?: ChainIdentifier[]): obj is SCToken<ChainIdentifier>;

package/dist/types/Token.js

@@ -1,6 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isToken = exports.isSCToken = exports.BitcoinTokens = exports.isBtcToken = void 0;
+exports.isSCToken = exports.BitcoinTokens = exports.isBtcToken = exports.isToken = void 0;
+/**
+ * Type guard for a {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+function isToken(obj) {
+    return typeof (obj) === "object" &&
+        (obj.chain === "SC" || obj.chain === "BTC") &&
+        typeof (obj.ticker) === "string" &&
+        typeof (obj.decimals) === "number" &&
+        typeof (obj.name) === "string";
+}
+exports.isToken = isToken;
 /**
  * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
  *
@@ -23,39 +36,41 @@ exports.isBtcToken = isBtcToken;
 exports.BitcoinTokens = {
     BTC: {
         chain: "BTC",
+        chainId: "BITCOIN",
         lightning: false,
         ticker: "BTC",
         decimals: 8,
-        name: "Bitcoin (on-chain L1)"
+        displayDecimals: 8,
+        name: "Bitcoin (on-chain L1)",
+        address: "",
+        equals: (other) => other.chainId === "BITCOIN" && other.ticker === "BTC",
+        toString: () => "BTC"
     },
     BTCLN: {
         chain: "BTC",
+        chainId: "LIGHTNING",
         lightning: true,
         ticker: "BTC",
         decimals: 8,
-        name: "Bitcoin (lightning L2)"
+        displayDecimals: 8,
+        name: "Bitcoin (lightning L2)",
+        address: "",
+        equals: (other) => other.chainId === "LIGHTNING" && other.ticker === "BTC",
+        toString: () => "BTC-LN"
     }
 };
 /**
  * Type guard for {@link SCToken} (token on the smart chain)
  * @category Tokens
  */
-function isSCToken(obj) {
+function isSCToken(obj, chainIdentifier) {
     return typeof (obj) === "object" &&
         obj.chain === "SC" &&
         typeof (obj.chainId) === "string" &&
+        (chainIdentifier == null || chainIdentifier.includes(obj.chainId)) &&
         typeof (obj.address) === "string" &&
         typeof (obj.ticker) === "string" &&
         typeof (obj.decimals) === "number" &&
         typeof (obj.name) === "string";
 }
 exports.isSCToken = isSCToken;
-/**
- * Type guard for an union {@link Token} type, encompassing all tokens (BTC or smart chain)
- *
- * @category Tokens
- */
-function isToken(obj) {
-    return isBtcToken(obj) || isSCToken(obj);
-}
-exports.isToken = isToken;