@atomiqlabs/sdk 8.1.8 → 8.3.1

package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js

@@ -6,13 +6,19 @@ const IEscrowSelfInitSwap_1 = require("../IEscrowSelfInitSwap");
 const FeeType_1 = require("../../../enums/FeeType");
 const PercentagePPM_1 = require("../../../types/fees/PercentagePPM");
 const TokenAmount_1 = require("../../../types/TokenAmount");
+/**
+ * Base class for legacy escrow-based Bitcoin (on-chain & lightning) -> Smart chain swaps,
+ *  which require the user to manually initiate the escrow on the destination smart chain
+ *
+ * @category Swaps
+ */
 class IFromBTCSelfInitSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
     constructor(wrapper, initOrObj) {
         super(wrapper, initOrObj);
     }
     /**
-     * In case swapFee in BTC is not supplied it recalculates it based on swap price
-     * @protected
+     * @inheritDoc
+     * @internal
      */
     tryRecomputeSwapPrice() {
         const input = this.getInput();
@@ -21,106 +27,163 @@ class IFromBTCSelfInitSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
         }
         super.tryRecomputeSwapPrice();
     }
+    /**
+     * @inheritDoc
+     * @internal
+     */
     _getInitiator() {
         return this.getSwapData().getClaimer();
     }
+    /**
+     * @inheritDoc
+     */
     getOutputTxId() {
-        return this.claimTxId ?? null;
+        return this._claimTxId ?? null;
     }
+    /**
+     * @inheritDoc
+     */
     getOutputAddress() {
         return this._getInitiator();
     }
+    /**
+     * @inheritDoc
+     */
     requiresAction() {
         return this.isClaimable();
     }
     //////////////////////////////
     //// Amounts & fees
+    /**
+     * Returns the swap output amount in destination token based units without any fees, this
+     *  value is therefore always higher than the actual received output.
+     *
+     * @internal
+     */
     getOutAmountWithoutFee() {
         return this.getSwapData().getAmount() + this.swapFee;
     }
+    /**
+     * Returns the swap fee charged by the intermediary (LP) on this swap
+     *
+     * @internal
+     */
     getSwapFee() {
         if (this.pricingInfo == null)
             throw new Error("No pricing info known, cannot estimate fee!");
         const feeWithoutBaseFee = this.swapFeeBtc - this.pricingInfo.satsBaseFee;
         const inputWithoutFee = this.getInputWithoutFee();
         const swapFeePPM = inputWithoutFee.rawAmount == null ? 0n : feeWithoutBaseFee * 1000000n / inputWithoutFee.rawAmount;
-        const amountInSrcToken = (0, TokenAmount_1.toTokenAmount)(this.swapFeeBtc, this.inputToken, this.wrapper.prices, this.pricingInfo);
+        const amountInSrcToken = (0, TokenAmount_1.toTokenAmount)(this.swapFeeBtc, this.inputToken, this.wrapper._prices, this.pricingInfo);
         return {
             amountInSrcToken,
-            amountInDstToken: (0, TokenAmount_1.toTokenAmount)(this.swapFee, this.wrapper.tokens[this.getSwapData().getToken()], this.wrapper.prices, this.pricingInfo),
+            amountInDstToken: (0, TokenAmount_1.toTokenAmount)(this.swapFee, this.wrapper._tokens[this.getSwapData().getToken()], this.wrapper._prices, this.pricingInfo),
             currentUsdValue: amountInSrcToken.currentUsdValue,
             usdValue: amountInSrcToken.usdValue,
             pastUsdValue: amountInSrcToken.pastUsdValue,
             composition: {
-                base: (0, TokenAmount_1.toTokenAmount)(this.pricingInfo.satsBaseFee, this.inputToken, this.wrapper.prices, this.pricingInfo),
+                base: (0, TokenAmount_1.toTokenAmount)(this.pricingInfo.satsBaseFee, this.inputToken, this.wrapper._prices, this.pricingInfo),
                 percentage: (0, PercentagePPM_1.ppmToPercentage)(swapFeePPM)
             }
         };
     }
+    /**
+     * @inheritDoc
+     */
     getFee() {
         return this.getSwapFee();
     }
+    /**
+     * @inheritDoc
+     */
     getFeeBreakdown() {
         return [{
                 type: FeeType_1.FeeType.SWAP,
                 fee: this.getSwapFee()
             }];
     }
+    /**
+     * @inheritDoc
+     */
     getOutputToken() {
-        return this.wrapper.tokens[this.getSwapData().getToken()];
+        return this.wrapper._tokens[this.getSwapData().getToken()];
     }
+    /**
+     * @inheritDoc
+     */
     getOutput() {
-        return (0, TokenAmount_1.toTokenAmount)(this.getSwapData().getAmount(), this.wrapper.tokens[this.getSwapData().getToken()], this.wrapper.prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(this.getSwapData().getAmount(), this.wrapper._tokens[this.getSwapData().getToken()], this.wrapper._prices, this.pricingInfo);
     }
+    /**
+     * @inheritDoc
+     */
     getInputWithoutFee() {
         const input = this.getInput();
         if (input.rawAmount == null)
-            return (0, TokenAmount_1.toTokenAmount)(null, this.inputToken, this.wrapper.prices, this.pricingInfo);
-        return (0, TokenAmount_1.toTokenAmount)(input.rawAmount - this.swapFeeBtc, this.inputToken, this.wrapper.prices, this.pricingInfo);
-    }
-    getSecurityDeposit() {
-        return (0, TokenAmount_1.toTokenAmount)(this.getSwapData().getSecurityDeposit(), this.wrapper.getNativeToken(), this.wrapper.prices, this.pricingInfo);
-    }
-    getTotalDeposit() {
-        return (0, TokenAmount_1.toTokenAmount)(this.getSwapData().getTotalDeposit(), this.wrapper.getNativeToken(), this.wrapper.prices, this.pricingInfo);
+            return (0, TokenAmount_1.toTokenAmount)(null, this.inputToken, this.wrapper._prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(input.rawAmount - this.swapFeeBtc, this.inputToken, this.wrapper._prices, this.pricingInfo);
     }
+    /**
+     * @inheritDoc
+     */
     async hasEnoughForTxFees() {
         const [balance, commitFee] = await Promise.all([
-            this.wrapper.contract.getBalance(this._getInitiator(), this.wrapper.chain.getNativeCurrencyAddress(), false),
+            this.wrapper._contract.getBalance(this._getInitiator(), this.wrapper._chain.getNativeCurrencyAddress(), false),
             this.getCommitFee()
         ]);
         const totalFee = commitFee + this.getSwapData().getTotalDeposit();
         return {
             enoughBalance: balance >= totalFee,
-            balance: (0, TokenAmount_1.toTokenAmount)(balance, this.wrapper.getNativeToken(), this.wrapper.prices, this.pricingInfo),
-            required: (0, TokenAmount_1.toTokenAmount)(totalFee, this.wrapper.getNativeToken(), this.wrapper.prices, this.pricingInfo)
+            balance: (0, TokenAmount_1.toTokenAmount)(balance, this.wrapper._getNativeToken(), this.wrapper._prices, this.pricingInfo),
+            required: (0, TokenAmount_1.toTokenAmount)(totalFee, this.wrapper._getNativeToken(), this.wrapper._prices, this.pricingInfo)
         };
     }
+    /**
+     * Returns the amount of native token of the destination chain locked up during initialization of the escrow
+     *  to act as a security deposit that can be taken by the intermediary (LP) if the user doesn't go through
+     *  with the swap
+     */
+    getSecurityDeposit() {
+        return (0, TokenAmount_1.toTokenAmount)(this.getSwapData().getSecurityDeposit(), this.wrapper._getNativeToken(), this.wrapper._prices, this.pricingInfo);
+    }
+    /**
+     * Returns the total amount of native token of the destination chain locked up during initialization of the escrow.
+     *  This covers the security deposit and the watchtower fee (if applicable), it is calculated a maximum of those
+     *  two values.
+     */
+    getTotalDeposit() {
+        return (0, TokenAmount_1.toTokenAmount)(this.getSwapData().getTotalDeposit(), this.wrapper._getNativeToken(), this.wrapper._prices, this.pricingInfo);
+    }
     //////////////////////////////
     //// Commit
     /**
-     * Returns the transactions required for committing the swap on-chain, locking the tokens from the intermediary
-     *  in an HTLC or PTLC
+     * Creates the escrow on the destination smart chain side, pre-locking the tokens from the intermediary (LP)
+     *  into an escrow.
+     *
+     * @inheritDoc
      *
-     * @param skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
-     *  (this is handled when swap is created (quoted), if you commit right after quoting, you can use skipChecks=true)
      * @throws {Error} When in invalid state to commit the swap
      */
     async txsCommit(skipChecks) {
         if (!this.canCommit())
             throw new Error("Must be in CREATED state!");
-        if (this.data == null || this.signatureData == null)
+        if (this._data == null || this.signatureData == null)
             throw new Error("data or signature data is null, invalid state?");
         if (!this.initiated) {
             this.initiated = true;
             await this._saveAndEmit();
         }
-        return await this.wrapper.contract.txsInit(this._getInitiator(), this.data, this.signatureData, skipChecks, this.feeRate).catch(e => Promise.reject(e instanceof base_1.SignatureVerificationError ? new Error("Request timed out") : e));
+        return await this.wrapper._contract.txsInit(this._getInitiator(), this._data, this.signatureData, skipChecks, this.feeRate).catch(e => Promise.reject(e instanceof base_1.SignatureVerificationError ? new Error("Request timed out") : e));
     }
     //////////////////////////////
     //// Claim
-    getClaimFee() {
-        return this.wrapper.contract.getClaimFee(this._getInitiator(), this.getSwapData());
+    /**
+     * Returns the transaction fee required for the claim transaction to settle the escrow on the destination
+     *  smart chain
+     */
+    async getClaimNetworkFee() {
+        const swapContract = this.wrapper._contract;
+        return (0, TokenAmount_1.toTokenAmount)(await swapContract.getClaimFee(this._getInitiator(), this.getSwapData()), this.wrapper._getNativeToken(), this.wrapper._prices);
     }
 }
 exports.IFromBTCSelfInitSwap = IFromBTCSelfInitSwap;

package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts

@@ -5,41 +5,54 @@ import { IEscrowSwapDefinition, IEscrowSwapWrapper } from "../IEscrowSwapWrapper
 import { IEscrowSwap } from "../IEscrowSwap";
 import { AmountData } from "../../../types/AmountData";
 export type IFromBTCDefinition<T extends ChainType, W extends IFromBTCWrapper<T, any>, S extends IEscrowSwap<T>> = IEscrowSwapDefinition<T, W, S>;
+/**
+ * Base class for wrappers of escrow-based Bitcoin (on-chain & lightning) -> Smart chain swaps
+ *
+ * @category Swaps
+ */
 export declare abstract class IFromBTCWrapper<T extends ChainType, D extends IFromBTCDefinition<T, IFromBTCWrapper<T, D>, IEscrowSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends IEscrowSwapWrapper<T, D, O> {
     /**
      * Returns a random sequence to be used for swaps
      *
-     * @protected
      * @returns Random 64-bit sequence number
+     *
+     * @internal
      */
     protected getRandomSequence(): bigint;
     /**
-     * Pre-fetches feeRate for a given swap
+     * Pre-fetches smart chain fee rate for initiating a swap escrow on the smart chain side
      *
      * @param signer Address initiating the swap
      * @param amountData
      * @param claimHash optional claim hash of the swap or null
      * @param abortController
-     * @protected
+     *
      * @returns Fee rate
+     *
+     * @internal
      */
     protected preFetchFeeRate(signer: string, amountData: AmountData, claimHash: string | undefined, abortController: AbortController): Promise<string | undefined>;
     /**
-     * Pre-fetches intermediary's available SC on-chain liquidity
+     * Pre-fetches intermediary (LP) available smart chain liquidity
+     *
      * @param amountData
      * @param lp Intermediary
      * @param abortController
-     * @protected
+     *
      * @returns Intermediary's liquidity balance
+     *
+     * @internal
      */
     protected preFetchIntermediaryLiquidity(amountData: AmountData, lp: Intermediary, abortController: AbortController): Promise<bigint | undefined>;
     /**
-     * Verifies whether the intermediary has enough available liquidity such that we can initiate the swap
+     * Verifies whether the intermediary (LP) has enough available liquidity such that we can initiate the swap
+     *
+     * @param amount Swap amount that the recipient should receive
+     * @param liquidityPromise pre-fetched liquidity promise as obtained from {@link preFetchIntermediaryLiquidity}
      *
-     * @param amount Swap amount that we should receive
-     * @param liquidityPromise pre-fetched liquidity promise as obtained from preFetchIntermediaryLiquidity()
-     * @protected
      * @throws {IntermediaryError} if intermediary's liquidity is lower than what's required for the swap
+     *
+     * @internal
      */
     protected verifyIntermediaryLiquidity(amount: bigint, liquidityPromise: Promise<bigint>): Promise<void>;
 }

package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js

@@ -5,28 +5,36 @@ const IntermediaryError_1 = require("../../../errors/IntermediaryError");
 const Utils_1 = require("../../../utils/Utils");
 const base_1 = require("@atomiqlabs/base");
 const IEscrowSwapWrapper_1 = require("../IEscrowSwapWrapper");
+/**
+ * Base class for wrappers of escrow-based Bitcoin (on-chain & lightning) -> Smart chain swaps
+ *
+ * @category Swaps
+ */
 class IFromBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
     /**
      * Returns a random sequence to be used for swaps
      *
-     * @protected
      * @returns Random 64-bit sequence number
+     *
+     * @internal
      */
     getRandomSequence() {
         return base_1.BigIntBufferUtils.fromBuffer((0, Utils_1.randomBytes)(8));
     }
     /**
-     * Pre-fetches feeRate for a given swap
+     * Pre-fetches smart chain fee rate for initiating a swap escrow on the smart chain side
      *
      * @param signer Address initiating the swap
      * @param amountData
      * @param claimHash optional claim hash of the swap or null
      * @param abortController
-     * @protected
+     *
      * @returns Fee rate
+     *
+     * @internal
      */
     preFetchFeeRate(signer, amountData, claimHash, abortController) {
-        return this.contract.getInitFeeRate(this.chain.randomAddress(), signer, amountData.token, claimHash)
+        return this._contract.getInitFeeRate(this._chain.randomAddress(), signer, amountData.token, claimHash)
             .catch(e => {
             this.logger.warn("preFetchFeeRate(): Error: ", e);
             abortController.abort(e);
@@ -34,27 +42,32 @@ class IFromBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
         });
     }
     /**
-     * Pre-fetches intermediary's available SC on-chain liquidity
+     * Pre-fetches intermediary (LP) available smart chain liquidity
+     *
      * @param amountData
      * @param lp Intermediary
      * @param abortController
-     * @protected
+     *
      * @returns Intermediary's liquidity balance
+     *
+     * @internal
      */
     preFetchIntermediaryLiquidity(amountData, lp, abortController) {
-        return lp.getLiquidity(this.chainIdentifier, this.contract, amountData.token.toString(), abortController.signal).catch(e => {
+        return lp.getLiquidity(this.chainIdentifier, this._contract, amountData.token.toString(), abortController.signal).catch(e => {
             this.logger.warn("preFetchIntermediaryLiquidity(): Error: ", e);
             abortController.abort(e);
             return undefined;
         });
     }
     /**
-     * Verifies whether the intermediary has enough available liquidity such that we can initiate the swap
+     * Verifies whether the intermediary (LP) has enough available liquidity such that we can initiate the swap
+     *
+     * @param amount Swap amount that the recipient should receive
+     * @param liquidityPromise pre-fetched liquidity promise as obtained from {@link preFetchIntermediaryLiquidity}
      *
-     * @param amount Swap amount that we should receive
-     * @param liquidityPromise pre-fetched liquidity promise as obtained from preFetchIntermediaryLiquidity()
-     * @protected
      * @throws {IntermediaryError} if intermediary's liquidity is lower than what's required for the swap
+     *
+     * @internal
      */
     async verifyIntermediaryLiquidity(amount, liquidityPromise) {
         const liquidity = await liquidityPromise;