@atomiqlabs/sdk 8.1.8 → 8.3.5

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

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OnchainForGasSwap = exports.isOnchainForGasSwapInit = exports.OnchainForGasSwapState = void 0;
 const SwapType_1 = require("../../../enums/SwapType");
-const PaymentAuthError_1 = require("../../../errors/PaymentAuthError");
 const Utils_1 = require("../../../utils/Utils");
 const BitcoinUtils_1 = require("../../../utils/BitcoinUtils");
 const ISwap_1 = require("../../ISwap");
@@ -20,15 +19,34 @@ const TimeoutUtils_1 = require("../../../utils/TimeoutUtils");
 const BitcoinWalletUtils_1 = require("../../../utils/BitcoinWalletUtils");
 /**
  * State enum for trusted on-chain gas swaps
- * @category Swaps
+ *
+ * @category Swaps/Trusted Gas Swaps
  */
 var OnchainForGasSwapState;
 (function (OnchainForGasSwapState) {
+    /**
+     * The swap quote expired without user sending in the BTC
+     */
     OnchainForGasSwapState[OnchainForGasSwapState["EXPIRED"] = -3] = "EXPIRED";
+    /**
+     * The swap has failed after the intermediary already received the BTC on the source chain
+     */
     OnchainForGasSwapState[OnchainForGasSwapState["FAILED"] = -2] = "FAILED";
+    /**
+     * Swap was refunded and BTC returned to the user's refund address
+     */
     OnchainForGasSwapState[OnchainForGasSwapState["REFUNDED"] = -1] = "REFUNDED";
+    /**
+     * Swap was created
+     */
     OnchainForGasSwapState[OnchainForGasSwapState["PR_CREATED"] = 0] = "PR_CREATED";
+    /**
+     * The swap is finished after the intermediary sent funds on the destination chain
+     */
     OnchainForGasSwapState[OnchainForGasSwapState["FINISHED"] = 1] = "FINISHED";
+    /**
+     * Swap is refundable because the intermediary cannot honor the swap request on the destination chain
+     */
     OnchainForGasSwapState[OnchainForGasSwapState["REFUNDABLE"] = 2] = "REFUNDABLE";
 })(OnchainForGasSwapState = exports.OnchainForGasSwapState || (exports.OnchainForGasSwapState = {}));
 function isOnchainForGasSwapInit(obj) {
@@ -44,15 +62,16 @@ function isOnchainForGasSwapInit(obj) {
 }
 exports.isOnchainForGasSwapInit = isOnchainForGasSwapInit;
 /**
- * Trusted on-chain BTC to gas token swap
- * @category Swaps
+ * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
+ *  destination chain, which is only needed for Solana, which still uses legacy swaps
+ *
+ * @category Swaps/Trusted Gas Swaps
  */
 class OnchainForGasSwap extends ISwap_1.ISwap {
     constructor(wrapper, initOrObj) {
         if (isOnchainForGasSwapInit(initOrObj) && initOrObj.url != null)
             initOrObj.url += "/frombtc_trusted";
         super(wrapper, initOrObj);
-        this.getSmartChainNetworkFee = null;
         this.TYPE = SwapType_1.SwapType.TRUSTED_FROM_BTC;
         this.wrapper = wrapper;
         if (isOnchainForGasSwapInit(initOrObj)) {
@@ -64,7 +83,7 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
             this.recipient = initOrObj.recipient;
             this.token = initOrObj.token;
             this.refundAddress = initOrObj.refundAddress;
-            this.state = OnchainForGasSwapState.PR_CREATED;
+            this._state = OnchainForGasSwapState.PR_CREATED;
         }
         else {
             this.paymentHash = initOrObj.paymentHash;
@@ -82,6 +101,10 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         this.logger = (0, Logger_1.getLogger)("OnchainForGas(" + this.getId() + "): ");
         this.tryRecomputeSwapPrice();
     }
+    /**
+     * @inheritDoc
+     * @internal
+     */
     upgradeVersion() {
         if (this.version == null) {
             //Noop
@@ -89,8 +112,8 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         }
     }
     /**
-     * In case swapFee in BTC is not supplied it recalculates it based on swap price
-     * @protected
+     * @inheritDoc
+     * @internal
      */
     tryRecomputeSwapPrice() {
         if (this.swapFeeBtc == null && this.swapFee != null) {
@@ -100,120 +123,203 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
     }
     //////////////////////////////
     //// Getters & utils
+    /**
+     * @inheritDoc
+     * @internal
+     */
     _getEscrowHash() {
         return this.paymentHash;
     }
+    /**
+     * @inheritDoc
+     */
     getOutputAddress() {
         return this.recipient;
     }
+    /**
+     * @inheritDoc
+     */
     getInputAddress() {
         //TODO: Fuck this, it's not used anyway
         return null;
     }
+    /**
+     * @inheritDoc
+     */
     getInputTxId() {
         return this.txId ?? null;
     }
+    /**
+     * @inheritDoc
+     */
     getOutputTxId() {
         return this.scTxId ?? null;
     }
+    /**
+     * @inheritDoc
+     */
     getId() {
         return this.paymentHash;
     }
+    /**
+     * @inheritDoc
+     */
     getAddress() {
         return this.address;
     }
+    /**
+     * @inheritDoc
+     */
     getHyperlink() {
         return "bitcoin:" + this.address + "?amount=" + encodeURIComponent((Number(this.inputAmount) / 100000000).toString(10));
     }
+    /**
+     * @inheritDoc
+     */
     requiresAction() {
-        return this.state === OnchainForGasSwapState.REFUNDABLE;
+        return this._state === OnchainForGasSwapState.REFUNDABLE;
     }
+    /**
+     * @inheritDoc
+     */
     isFinished() {
-        return this.state === OnchainForGasSwapState.FINISHED || this.state === OnchainForGasSwapState.FAILED || this.state === OnchainForGasSwapState.EXPIRED || this.state === OnchainForGasSwapState.REFUNDED;
+        return this._state === OnchainForGasSwapState.FINISHED || this._state === OnchainForGasSwapState.FAILED || this._state === OnchainForGasSwapState.EXPIRED || this._state === OnchainForGasSwapState.REFUNDED;
     }
+    /**
+     * @inheritDoc
+     */
     isQuoteExpired() {
-        return this.state === OnchainForGasSwapState.EXPIRED;
+        return this._state === OnchainForGasSwapState.EXPIRED;
     }
+    /**
+     * @inheritDoc
+     */
     isQuoteSoftExpired() {
         return this.expiry < Date.now();
     }
+    /**
+     * @inheritDoc
+     */
     isFailed() {
-        return this.state === OnchainForGasSwapState.FAILED;
+        return this._state === OnchainForGasSwapState.FAILED;
     }
+    /**
+     * @inheritDoc
+     */
     isSuccessful() {
-        return this.state === OnchainForGasSwapState.FINISHED;
+        return this._state === OnchainForGasSwapState.FINISHED;
     }
-    verifyQuoteValid() {
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _verifyQuoteDefinitelyExpired() {
+        return Promise.resolve(this.expiry < Date.now());
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _verifyQuoteValid() {
         return Promise.resolve(this.expiry > Date.now());
     }
     //////////////////////////////
     //// Amounts & fees
+    /**
+     * Returns an output amount in base units without a swap fee included, hence this value
+     *  is larger than the actual output amount
+     *
+     * @internal
+     */
     getOutAmountWithoutFee() {
         return this.outputAmount + (this.swapFee ?? 0n);
     }
+    /**
+     * @inheritDoc
+     */
     getOutputToken() {
-        return this.wrapper.tokens[this.wrapper.chain.getNativeCurrencyAddress()];
+        return this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()];
     }
+    /**
+     * @inheritDoc
+     */
     getOutput() {
-        return (0, TokenAmount_1.toTokenAmount)(this.outputAmount, this.wrapper.tokens[this.wrapper.chain.getNativeCurrencyAddress()], this.wrapper.prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(this.outputAmount, this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()], this.wrapper._prices, this.pricingInfo);
     }
+    /**
+     * @inheritDoc
+     */
     getInputToken() {
         return Token_1.BitcoinTokens.BTC;
     }
+    /**
+     * @inheritDoc
+     */
     getInput() {
-        return (0, TokenAmount_1.toTokenAmount)(this.inputAmount, Token_1.BitcoinTokens.BTC, this.wrapper.prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(this.inputAmount, Token_1.BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
     }
+    /**
+     * @inheritDoc
+     */
     getInputWithoutFee() {
-        return (0, TokenAmount_1.toTokenAmount)(this.inputAmount - (this.swapFeeBtc ?? 0n), Token_1.BitcoinTokens.BTC, this.wrapper.prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(this.inputAmount - (this.swapFeeBtc ?? 0n), Token_1.BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
     }
+    /**
+     * 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!");
         const feeWithoutBaseFee = this.swapFeeBtc == null ? 0n : this.swapFeeBtc - this.pricingInfo.satsBaseFee;
         const swapFeePPM = feeWithoutBaseFee * 1000000n / this.getInputWithoutFee().rawAmount;
-        const amountInSrcToken = (0, TokenAmount_1.toTokenAmount)(this.swapFeeBtc ?? 0n, Token_1.BitcoinTokens.BTC, this.wrapper.prices, this.pricingInfo);
+        const amountInSrcToken = (0, TokenAmount_1.toTokenAmount)(this.swapFeeBtc ?? 0n, Token_1.BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
         return {
             amountInSrcToken,
-            amountInDstToken: (0, TokenAmount_1.toTokenAmount)(this.swapFee ?? 0n, this.wrapper.tokens[this.wrapper.chain.getNativeCurrencyAddress()], this.wrapper.prices, this.pricingInfo),
+            amountInDstToken: (0, TokenAmount_1.toTokenAmount)(this.swapFee ?? 0n, this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()], this.wrapper._prices, this.pricingInfo),
             currentUsdValue: amountInSrcToken.currentUsdValue,
             usdValue: amountInSrcToken.usdValue,
             pastUsdValue: amountInSrcToken.pastUsdValue,
             composition: {
-                base: (0, TokenAmount_1.toTokenAmount)(this.pricingInfo.satsBaseFee, Token_1.BitcoinTokens.BTC, this.wrapper.prices, this.pricingInfo),
+                base: (0, TokenAmount_1.toTokenAmount)(this.pricingInfo.satsBaseFee, Token_1.BitcoinTokens.BTC, 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
+     */
     getRequiredConfirmationsCount() {
         return 1;
     }
     /**
-     * Returns the PSBT that is already funded with wallet's UTXOs (runs a coin-selection algorithm to choose UTXOs to use),
-     *  also returns inputs indices that need to be signed by the wallet before submitting the PSBT back to the SDK with
-     *  `swap.submitPsbt()`
-     *
-     * @param _bitcoinWallet Sender's bitcoin wallet
-     * @param feeRate Optional fee rate for the transaction, needs to be at least as big as {minimumBtcFeeRate} field
-     * @param additionalOutputs additional outputs to add to the PSBT - can be used to collect fees from users
+     * @inheritDoc
      */
     async getFundedPsbt(_bitcoinWallet, feeRate, additionalOutputs) {
-        if (this.state !== OnchainForGasSwapState.PR_CREATED)
+        if (this._state !== OnchainForGasSwapState.PR_CREATED)
             throw new Error("Swap already paid for!");
         let bitcoinWallet;
         if ((0, IBitcoinWallet_1.isIBitcoinWallet)(_bitcoinWallet)) {
             bitcoinWallet = _bitcoinWallet;
         }
         else {
-            bitcoinWallet = new SingleAddressBitcoinWallet_1.SingleAddressBitcoinWallet(this.wrapper.btcRpc, this.wrapper.options.bitcoinNetwork, _bitcoinWallet);
+            bitcoinWallet = new SingleAddressBitcoinWallet_1.SingleAddressBitcoinWallet(this.wrapper._btcRpc, this.wrapper._options.bitcoinNetwork, _bitcoinWallet);
         }
         //TODO: Maybe re-introduce fee rate check here if passed from the user
         if (feeRate == null) {
@@ -225,13 +331,13 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         });
         basePsbt.addOutput({
             amount: this.outputAmount,
-            script: (0, BitcoinUtils_1.toOutputScript)(this.wrapper.options.bitcoinNetwork, this.address)
+            script: (0, BitcoinUtils_1.toOutputScript)(this.wrapper._options.bitcoinNetwork, this.address)
         });
         if (additionalOutputs != null)
             additionalOutputs.forEach(output => {
                 basePsbt.addOutput({
                     amount: output.amount,
-                    script: output.outputScript ?? (0, BitcoinUtils_1.toOutputScript)(this.wrapper.options.bitcoinNetwork, output.address)
+                    script: output.outputScript ?? (0, BitcoinUtils_1.toOutputScript)(this.wrapper._options.bitcoinNetwork, output.address)
                 });
             });
         const psbt = await bitcoinWallet.fundPsbt(basePsbt, feeRate);
@@ -249,13 +355,11 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         };
     }
     /**
-     * Submits a PSBT signed by the wallet back to the SDK
-     *
-     * @param _psbt A psbt - either a Transaction object or a hex or base64 encoded PSBT string
+     * @inheritDoc
      */
     async submitPsbt(_psbt) {
         const psbt = (0, BitcoinUtils_1.parsePsbtTransaction)(_psbt);
-        if (this.state !== OnchainForGasSwapState.PR_CREATED)
+        if (this._state !== OnchainForGasSwapState.PR_CREATED)
             throw new Error("Swap already paid for!");
         //Ensure not expired
         if (this.expiry < Date.now()) {
@@ -264,22 +368,28 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         const output0 = psbt.getOutput(0);
         if (output0.amount !== this.outputAmount)
             throw new Error("PSBT output amount invalid, expected: " + this.outputAmount + " got: " + output0.amount);
-        const expectedOutputScript = (0, BitcoinUtils_1.toOutputScript)(this.wrapper.options.bitcoinNetwork, this.address);
+        const expectedOutputScript = (0, BitcoinUtils_1.toOutputScript)(this.wrapper._options.bitcoinNetwork, this.address);
         if (output0.script == null || !expectedOutputScript.equals(output0.script))
             throw new Error("PSBT output script invalid!");
         if (!psbt.isFinal)
             psbt.finalize();
-        return await this.wrapper.btcRpc.sendRawTransaction(buffer_1.Buffer.from(psbt.toBytes(true, true)).toString("hex"));
+        return await this.wrapper._btcRpc.sendRawTransaction(buffer_1.Buffer.from(psbt.toBytes(true, true)).toString("hex"));
     }
+    /**
+     * @inheritDoc
+     */
     async estimateBitcoinFee(_bitcoinWallet, feeRate) {
-        const bitcoinWallet = (0, BitcoinWalletUtils_1.toBitcoinWallet)(_bitcoinWallet, this.wrapper.btcRpc, this.wrapper.options.bitcoinNetwork);
+        const bitcoinWallet = (0, BitcoinWalletUtils_1.toBitcoinWallet)(_bitcoinWallet, this.wrapper._btcRpc, this.wrapper._options.bitcoinNetwork);
         const txFee = await bitcoinWallet.getTransactionFee(this.address, this.inputAmount, feeRate);
         if (txFee == null)
             return null;
-        return (0, TokenAmount_1.toTokenAmount)(BigInt(txFee), Token_1.BitcoinTokens.BTC, this.wrapper.prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(BigInt(txFee), Token_1.BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
     }
+    /**
+     * @inheritDoc
+     */
     async sendBitcoinTransaction(wallet, feeRate) {
-        if (this.state !== OnchainForGasSwapState.PR_CREATED)
+        if (this._state !== OnchainForGasSwapState.PR_CREATED)
             throw new Error("Swap already paid for!");
         //Ensure not expired
         if (this.expiry < Date.now()) {
@@ -296,9 +406,15 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
             return await this.submitPsbt(signedPsbt);
         }
     }
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
+     *  if not provided an address is returned instead.
+     */
     async txsExecute(options) {
-        if (this.state === OnchainForGasSwapState.PR_CREATED) {
-            if (!await this.verifyQuoteValid())
+        if (this._state === OnchainForGasSwapState.PR_CREATED) {
+            if (!await this._verifyQuoteValid())
                 throw new Error("Quote already expired or close to expiry!");
             return [
                 {
@@ -323,16 +439,24 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
     }
     //////////////////////////////
     //// Payment
+    /**
+     * Queries the intermediary (LP) node for the state of the swap
+     *
+     * @param save Whether the save the result or not
+     *
+     * @returns Whether the swap was successful as `boolean` or `null` if the swap is still pending
+     * @internal
+     */
     async checkAddress(save = true) {
-        if (this.state === OnchainForGasSwapState.FAILED ||
-            this.state === OnchainForGasSwapState.EXPIRED ||
-            this.state === OnchainForGasSwapState.REFUNDED)
+        if (this._state === OnchainForGasSwapState.FAILED ||
+            this._state === OnchainForGasSwapState.EXPIRED ||
+            this._state === OnchainForGasSwapState.REFUNDED)
             return false;
-        if (this.state === OnchainForGasSwapState.FINISHED)
+        if (this._state === OnchainForGasSwapState.FINISHED)
             return false;
         if (this.url == null)
             return false;
-        const response = await TrustedIntermediaryAPI_1.TrustedIntermediaryAPI.getAddressStatus(this.url, this.paymentHash, this.sequence, this.wrapper.options.getRequestTimeout);
+        const response = await TrustedIntermediaryAPI_1.TrustedIntermediaryAPI.getAddressStatus(this.url, this.paymentHash, this.sequence, this.wrapper._options.getRequestTimeout);
         switch (response.code) {
             case TrustedIntermediaryAPI_1.AddressStatusResponseCodes.AWAIT_PAYMENT:
                 if (this.txId != null) {
@@ -366,9 +490,9 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
                 }
                 return false;
             case TrustedIntermediaryAPI_1.AddressStatusResponseCodes.PAID:
-                const txStatus = await this.wrapper.chain.getTxIdStatus(response.data.txId);
+                const txStatus = await this.wrapper._chain.getTxIdStatus(response.data.txId);
                 if (txStatus === "success") {
-                    this.state = OnchainForGasSwapState.FINISHED;
+                    this._state = OnchainForGasSwapState.FINISHED;
                     this.scTxId = response.data.txId;
                     if (save)
                         await this._saveAndEmit();
@@ -376,30 +500,36 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
                 }
                 return false;
             case TrustedIntermediaryAPI_1.AddressStatusResponseCodes.EXPIRED:
-                this.state = OnchainForGasSwapState.EXPIRED;
+                this._state = OnchainForGasSwapState.EXPIRED;
                 if (save)
                     await this._saveAndEmit();
                 return true;
             case TrustedIntermediaryAPI_1.AddressStatusResponseCodes.REFUNDABLE:
-                if (this.state === OnchainForGasSwapState.REFUNDABLE)
+                if (this._state === OnchainForGasSwapState.REFUNDABLE)
                     return null;
-                this.state = OnchainForGasSwapState.REFUNDABLE;
+                this._state = OnchainForGasSwapState.REFUNDABLE;
                 if (save)
                     await this._saveAndEmit();
                 return true;
             case TrustedIntermediaryAPI_1.AddressStatusResponseCodes.REFUNDED:
-                this.state = OnchainForGasSwapState.REFUNDED;
+                this._state = OnchainForGasSwapState.REFUNDED;
                 this.refundTxId = response.data.txId;
                 if (save)
                     await this._saveAndEmit();
                 return true;
             default:
-                this.state = OnchainForGasSwapState.FAILED;
+                this._state = OnchainForGasSwapState.FAILED;
                 if (save)
                     await this._saveAndEmit();
                 return true;
         }
     }
+    /**
+     * Sets the bitcoin address used for possible refunds in case something goes wrong with the swap
+     *
+     * @param refundAddress Bitcoin address to receive the refund to
+     * @internal
+     */
     async setRefundAddress(refundAddress) {
         if (this.refundAddress != null) {
             if (this.refundAddress !== refundAddress)
@@ -408,31 +538,24 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         }
         if (this.url == null)
             throw new Error("LP URL not known, cannot set refund address!");
-        await TrustedIntermediaryAPI_1.TrustedIntermediaryAPI.setRefundAddress(this.url, this.paymentHash, this.sequence, refundAddress, this.wrapper.options.getRequestTimeout);
+        await TrustedIntermediaryAPI_1.TrustedIntermediaryAPI.setRefundAddress(this.url, this.paymentHash, this.sequence, refundAddress, this.wrapper._options.getRequestTimeout);
         this.refundAddress = refundAddress;
     }
     /**
-     * A blocking promise resolving when payment was received by the intermediary and client can continue
-     * rejecting in case of failure
-     *
-     * @param abortSignal Abort signal
-     * @param checkIntervalSeconds How often to poll the intermediary for answer
-     * @param updateCallback Callback called when txId is found, and also called with subsequent confirmations
-     * @throws {PaymentAuthError} If swap expired or failed
-     * @throws {Error} When in invalid state (not PR_CREATED)
+     * @inheritDoc
      */
     async waitForBitcoinTransaction(updateCallback, checkIntervalSeconds = 5, abortSignal) {
-        if (this.state !== OnchainForGasSwapState.PR_CREATED)
+        if (this._state !== OnchainForGasSwapState.PR_CREATED)
             throw new Error("Must be in PR_CREATED state!");
         if (!this.initiated) {
             this.initiated = true;
             await this._saveAndEmit();
         }
         while (!abortSignal?.aborted &&
-            this.state === OnchainForGasSwapState.PR_CREATED) {
+            this._state === OnchainForGasSwapState.PR_CREATED) {
             await this.checkAddress(true);
             if (this.txId != null && updateCallback != null) {
-                const res = await this.wrapper.btcRpc.getTransaction(this.txId);
+                const res = await this.wrapper._btcRpc.getTransaction(this.txId);
                 if (res == null) {
                     updateCallback();
                 }
@@ -440,39 +563,53 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
                     updateCallback(res.txid, res.confirmations, 1, 0);
                 }
                 else {
-                    const delay = await this.wrapper.btcRpc.getConfirmationDelay(res, 1);
+                    const delay = await this.wrapper._btcRpc.getConfirmationDelay(res, 1);
                     updateCallback(res.txid, 0, 1, delay ?? undefined);
                 }
             }
-            if (this.state === OnchainForGasSwapState.PR_CREATED)
+            if (this._state === OnchainForGasSwapState.PR_CREATED)
                 await (0, TimeoutUtils_1.timeoutPromise)(checkIntervalSeconds * 1000, abortSignal);
         }
-        if (this.state === OnchainForGasSwapState.REFUNDABLE ||
-            this.state === OnchainForGasSwapState.REFUNDED)
+        if (this._state === OnchainForGasSwapState.REFUNDABLE ||
+            this._state === OnchainForGasSwapState.REFUNDED)
             return this.txId;
         if (this.isQuoteExpired())
-            throw new PaymentAuthError_1.PaymentAuthError("Swap expired");
+            throw new Error("Swap expired");
         if (this.isFailed())
-            throw new PaymentAuthError_1.PaymentAuthError("Swap failed");
+            throw new Error("Swap failed");
         return this.txId;
     }
+    /**
+     * Waits till the LP processes a refund for a failed swap. The swap must be in
+     *  {@link OnchainForGasSwapState.REFUNDABLE} state
+     *
+     * @param checkIntervalSeconds How often to check (default 5 seconds)
+     * @param abortSignal Abort signal
+     */
     async waitTillRefunded(checkIntervalSeconds, abortSignal) {
         checkIntervalSeconds ??= 5;
-        if (this.state === OnchainForGasSwapState.REFUNDED)
+        if (this._state === OnchainForGasSwapState.REFUNDED)
             return;
-        if (this.state !== OnchainForGasSwapState.REFUNDABLE)
+        if (this._state !== OnchainForGasSwapState.REFUNDABLE)
             throw new Error("Must be in REFUNDABLE state!");
         while (!abortSignal?.aborted &&
-            this.state === OnchainForGasSwapState.REFUNDABLE) {
+            this._state === OnchainForGasSwapState.REFUNDABLE) {
             await this.checkAddress(true);
-            if (this.state === OnchainForGasSwapState.REFUNDABLE)
+            if (this._state === OnchainForGasSwapState.REFUNDABLE)
                 await (0, TimeoutUtils_1.timeoutPromise)(checkIntervalSeconds * 1000, abortSignal);
         }
         if (this.isQuoteExpired())
-            throw new PaymentAuthError_1.PaymentAuthError("Swap expired");
+            throw new Error("Swap expired");
         if (this.isFailed())
-            throw new PaymentAuthError_1.PaymentAuthError("Swap failed");
+            throw new Error("Swap failed");
     }
+    /**
+     * Requests a refund after the swap failed, this also waits till the refund is actually sent by the
+     *  intermediary (LP). The swap must be in {@link OnchainForGasSwapState.REFUNDABLE} state
+     *
+     * @param refundAddress Bitcoin address to receive the refund to
+     * @param abortSignal Abort signal
+     */
     async requestRefund(refundAddress, abortSignal) {
         if (refundAddress != null)
             await this.setRefundAddress(refundAddress);
@@ -480,6 +617,9 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
     }
     //////////////////////////////
     //// Storage
+    /**
+     * @inheritDoc
+     */
     serialize() {
         return {
             ...super.serialize(),
@@ -496,13 +636,21 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
             refundTxId: this.refundTxId,
         };
     }
+    /**
+     * @inheritDoc
+     * @internal
+     */
     _getInitiator() {
         return this.recipient;
     }
     //////////////////////////////
     //// Swap ticks & sync
+    /**
+     * @inheritDoc
+     * @internal
+     */
     async _sync(save) {
-        if (this.state === OnchainForGasSwapState.PR_CREATED) {
+        if (this._state === OnchainForGasSwapState.PR_CREATED) {
             //Check if it's maybe already paid
             const result = await this.checkAddress(false);
             if (result) {
@@ -513,6 +661,10 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         }
         return false;
     }
+    /**
+     * @inheritDoc
+     * @internal
+     */
     _tick(save) {
         return Promise.resolve(false);
     }