@atomiqlabs/sdk 8.1.7 → 8.3.1

package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts

@@ -5,16 +5,34 @@ import { Intermediary, SingleChainReputationType } from "../../../intermediaries
 import { IEscrowSwapWrapper } from "../IEscrowSwapWrapper";
 import { AmountData } from "../../../types/AmountData";
 export type IToBTCDefinition<T extends ChainType, W extends IToBTCWrapper<T, any>, S extends IToBTCSwap<T>> = SwapTypeDefinition<T, W, S>;
+/**
+ * Base class for wrappers of escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
+ *
+ * @category Swaps
+ */
 export declare abstract class IToBTCWrapper<T extends ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends IEscrowSwapWrapper<T, D, O> {
+    /**
+     * @internal
+     */
+    protected readonly tickSwapState: ToBTCSwapState[];
+    /**
+     * @internal
+     */
+    readonly _pendingSwapStates: ToBTCSwapState[];
+    /**
+     * @internal
+     */
+    readonly _refundableSwapStates: ToBTCSwapState[];
     /**
      * Pre-fetches intermediary's reputation, doesn't throw, instead aborts via abortController and returns null
      *
      * @param amountData
      * @param lp Intermediary
      * @param abortController
-     * @protected
      * @returns Intermediary's reputation or null if failed
      * @throws {IntermediaryError} If the intermediary vault doesn't exist
+     *
+     * @internal
      */
     protected preFetchIntermediaryReputation(amountData: Omit<AmountData, "amount">, lp: Intermediary, abortController: AbortController): Promise<SingleChainReputationType | undefined>;
     /**
@@ -24,14 +42,21 @@ export declare abstract class IToBTCWrapper<T extends ChainType, D extends IToBT
      * @param amountData
      * @param claimHash optional hash of the swap or null
      * @param abortController
-     * @protected
      * @returns Fee rate
+     *
+     * @internal
      */
     protected preFetchFeeRate(signer: string, amountData: Omit<AmountData, "amount">, claimHash: string | undefined, abortController: AbortController): Promise<string | undefined>;
-    readonly pendingSwapStates: ToBTCSwapState[];
-    readonly tickSwapState: ToBTCSwapState[];
-    readonly refundableSwapStates: ToBTCSwapState[];
+    /**
+     * @internal
+     */
     protected processEventInitialize(swap: D["Swap"], event: InitializeEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * @internal
+     */
     protected processEventClaim(swap: D["Swap"], event: ClaimEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * @internal
+     */
     protected processEventRefund(swap: D["Swap"], event: RefundEvent<T["Data"]>): Promise<boolean>;
 }

package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js

@@ -4,18 +4,32 @@ exports.IToBTCWrapper = void 0;
 const IToBTCSwap_1 = require("./IToBTCSwap");
 const IntermediaryError_1 = require("../../../errors/IntermediaryError");
 const IEscrowSwapWrapper_1 = require("../IEscrowSwapWrapper");
+/**
+ * Base class for wrappers of escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
+ *
+ * @category Swaps
+ */
 class IToBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
     constructor() {
         super(...arguments);
-        this.pendingSwapStates = [
+        /**
+         * @internal
+         */
+        this.tickSwapState = [IToBTCSwap_1.ToBTCSwapState.CREATED, IToBTCSwap_1.ToBTCSwapState.COMMITED, IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED];
+        /**
+         * @internal
+         */
+        this._pendingSwapStates = [
             IToBTCSwap_1.ToBTCSwapState.CREATED,
             IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED,
             IToBTCSwap_1.ToBTCSwapState.COMMITED,
             IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED,
             IToBTCSwap_1.ToBTCSwapState.REFUNDABLE
         ];
-        this.tickSwapState = [IToBTCSwap_1.ToBTCSwapState.CREATED, IToBTCSwap_1.ToBTCSwapState.COMMITED, IToBTCSwap_1.ToBTCSwapState.SOFT_CLAIMED];
-        this.refundableSwapStates = [IToBTCSwap_1.ToBTCSwapState.REFUNDABLE];
+        /**
+         * @internal
+         */
+        this._refundableSwapStates = [IToBTCSwap_1.ToBTCSwapState.REFUNDABLE];
     }
     /**
      * Pre-fetches intermediary's reputation, doesn't throw, instead aborts via abortController and returns null
@@ -23,12 +37,13 @@ class IToBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
      * @param amountData
      * @param lp Intermediary
      * @param abortController
-     * @protected
      * @returns Intermediary's reputation or null if failed
      * @throws {IntermediaryError} If the intermediary vault doesn't exist
+     *
+     * @internal
      */
     preFetchIntermediaryReputation(amountData, lp, abortController) {
-        return lp.getReputation(this.chainIdentifier, this.contract, [amountData.token.toString()], abortController.signal).then(res => {
+        return lp.getReputation(this.chainIdentifier, this._contract, [amountData.token.toString()], abortController.signal).then(res => {
             if (res == null)
                 throw new IntermediaryError_1.IntermediaryError("Invalid data returned - invalid LP vault");
             return res;
@@ -45,46 +60,56 @@ class IToBTCWrapper extends IEscrowSwapWrapper_1.IEscrowSwapWrapper {
      * @param amountData
      * @param claimHash optional hash of the swap or null
      * @param abortController
-     * @protected
      * @returns Fee rate
+     *
+     * @internal
      */
     preFetchFeeRate(signer, amountData, claimHash, abortController) {
-        return this.contract.getInitPayInFeeRate(signer, this.chain.randomAddress(), amountData.token, claimHash)
+        return this._contract.getInitPayInFeeRate(signer, this._chain.randomAddress(), amountData.token, claimHash)
             .catch(e => {
             this.logger.warn("preFetchFeeRate(): Error: ", e);
             abortController.abort(e);
             return undefined;
         });
     }
+    /**
+     * @internal
+     */
     async processEventInitialize(swap, event) {
-        if (swap.state === IToBTCSwap_1.ToBTCSwapState.CREATED || swap.state === IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED) {
-            swap.state = IToBTCSwap_1.ToBTCSwapState.COMMITED;
-            if (swap.commitTxId == null)
-                swap.commitTxId = event.meta?.txId;
+        if (swap._state === IToBTCSwap_1.ToBTCSwapState.CREATED || swap._state === IToBTCSwap_1.ToBTCSwapState.QUOTE_SOFT_EXPIRED) {
+            swap._state = IToBTCSwap_1.ToBTCSwapState.COMMITED;
+            if (swap._commitTxId == null)
+                swap._commitTxId = event.meta?.txId;
             return true;
         }
         return false;
     }
+    /**
+     * @internal
+     */
     async processEventClaim(swap, event) {
-        if (swap.state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED && swap.state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED) {
+        if (swap._state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED && swap._state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED) {
             await swap._setPaymentResult({
                 secret: event.result,
                 txId: Buffer.from(event.result, "hex").reverse().toString("hex")
             }).catch(e => {
                 this.logger.warn(`processEventClaim(): Failed to set payment result ${event.result}: `, e);
             });
-            swap.state = IToBTCSwap_1.ToBTCSwapState.CLAIMED;
-            if (swap.claimTxId == null)
-                swap.claimTxId = event.meta?.txId;
+            swap._state = IToBTCSwap_1.ToBTCSwapState.CLAIMED;
+            if (swap._claimTxId == null)
+                swap._claimTxId = event.meta?.txId;
             return true;
         }
         return false;
     }
+    /**
+     * @internal
+     */
     processEventRefund(swap, event) {
-        if (swap.state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED && swap.state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED) {
-            swap.state = IToBTCSwap_1.ToBTCSwapState.REFUNDED;
-            if (swap.refundTxId == null)
-                swap.refundTxId = event.meta?.txId;
+        if (swap._state !== IToBTCSwap_1.ToBTCSwapState.CLAIMED && swap._state !== IToBTCSwap_1.ToBTCSwapState.REFUNDED) {
+            swap._state = IToBTCSwap_1.ToBTCSwapState.REFUNDED;
+            if (swap._refundTxId == null)
+                swap._refundTxId = event.meta?.txId;
             return Promise.resolve(true);
         }
         return Promise.resolve(false);

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

@@ -18,31 +18,56 @@ export type ToBTCLNSwapInit<T extends SwapData> = IToBTCSwapInit<T> & {
 };
 export declare function isToBTCLNSwapInit<T extends SwapData>(obj: any): obj is ToBTCLNSwapInit<T>;
 /**
- * Smart Chain to Lightning Network BTC swap
+ * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
+ *
  * @category Swaps
  */
 export declare class ToBTCLNSwap<T extends ChainType = ChainType> extends IToBTCSwap<T, ToBTCLNDefinition<T>> {
-    private readonly usesClaimHashAsId;
-    protected outputToken: BtcToken<true>;
     protected readonly TYPE = SwapType.TO_BTCLN;
+    /**
+     * @internal
+     */
+    protected readonly outputToken: BtcToken<true>;
+    /**
+     * @internal
+     */
     protected readonly logger: LoggerType;
+    private readonly usesClaimHashAsId;
     private readonly confidence;
-    private readonly pr?;
-    readonly paymentHash?: string;
-    lnurl?: string;
-    successAction?: LNURLPaySuccessAction;
+    private pr?;
     private secret?;
+    private lnurl?;
+    private successAction?;
+    /**
+     * Sets the LNURL data for the swap
+     *
+     * @internal
+     */
+    _setLNURLData(lnurl: string, successAction?: LNURLPaySuccessAction): void;
     constructor(wrapper: ToBTCLNWrapper<T>, init: ToBTCLNSwapInit<T["Data"]>);
     constructor(wrapper: ToBTCLNWrapper<T>, obj: any);
+    /**
+     * @inheritDoc
+     * @internal
+     */
     _setPaymentResult(result: {
         secret?: string;
         txId?: string;
     }, check?: boolean): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
     getOutputToken(): BtcToken<true>;
+    /**
+     * @inheritDoc
+     */
     getOutput(): TokenAmount<T["ChainId"], BtcToken<true>>;
+    /**
+     * @inheritDoc
+     */
     getOutputTxId(): string | null;
     /**
-     * Returns the lightning BOLT11 invoice where the BTC will be sent to
+     * @inheritDoc
      */
     getOutputAddress(): string | null;
     /**
@@ -50,37 +75,53 @@ export declare class ToBTCLNSwap<T extends ChainType = ChainType> extends IToBTC
      */
     getSecret(): string | null;
     /**
-     * Returns the confidence of the intermediary that this payment will succeed
-     * Value between 0 and 1, where 0 is not likely and 1 is very likely
+     * Returns the confidence of the intermediary that this payment will succeed.
+     *
+     * @returns Decimal value between 0 and 1, where 0 is not likely and 1 is very likely
      */
     getConfidence(): number;
     /**
-     * Checks whether a swap is likely to fail, based on the confidence as reported by the LP
+     * Checks whether a swap is likely to fail, based on the confidence as reported by the intermediary (LP)
      */
     willLikelyFail(): boolean;
     /**
-     * Tries to detect if the target lightning invoice is a non-custodial mobile wallet, care must be taken
-     *  for such a wallet to be online when attempting to make a swap
+     * Tries to detect if the target lightning invoice is a non-custodial mobile wallet, extract care must be taken
+     *  for such a wallet **to be online** when attempting to make a swap sending to such a wallet
      */
     isPayingToNonCustodialWallet(): boolean;
-    getIdentifierHash(): Buffer;
-    getPaymentHash(): Buffer | null;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    protected getIdentifierHash(): Buffer;
+    /**
+     * @inheritDoc
+     * @internal
+     */
     protected getLpIdentifier(): string;
     /**
-     * Is this an LNURL-pay swap?
+     * Returns the payment hash of the swap, i.e. a payment hash of the lightning network invoice that
+     *  is about to be paid
+     */
+    getPaymentHash(): Buffer | null;
+    /**
+     * Whether this is an LNURL-pay swap
      */
     isLNURL(): boolean;
     /**
-     * Gets the used LNURL or null if this is not an LNURL-pay swap
+     * Gets the used LNURL-pay link or `null` if this is not an LNURL-pay swap
      */
     getLNURL(): string | null;
     /**
-     * Checks whether this LNURL payment contains a success message
+     * Checks whether this LNURL-pay payment contains a success action
      */
     hasSuccessAction(): boolean;
     /**
-     * Returns the success action after a successful payment, else null
+     * Returns the success action after a successful payment, else `null`
      */
     getSuccessAction(): LNURLDecodedSuccessAction | null;
+    /**
+     * @inheritDoc
+     */
     serialize(): any;
 }

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

@@ -25,16 +25,29 @@ const SNOWFLAKE_LIST = new Set([
     "03a6ce61fcaacd38d31d4e3ce2d506602818e3856b4b44faff1dde9642ba705976"
 ]);
 /**
- * Smart Chain to Lightning Network BTC swap
+ * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
+ *
  * @category Swaps
  */
 class ToBTCLNSwap extends IToBTCSwap_1.IToBTCSwap {
+    /**
+     * Sets the LNURL data for the swap
+     *
+     * @internal
+     */
+    _setLNURLData(lnurl, successAction) {
+        this.lnurl = lnurl;
+        this.successAction = successAction;
+    }
     constructor(wrapper, initOrObj) {
         if (isToBTCLNSwapInit(initOrObj) && initOrObj.url != null)
             initOrObj.url += "/tobtcln";
         super(wrapper, initOrObj);
-        this.outputToken = Token_1.BitcoinTokens.BTCLN;
         this.TYPE = SwapType_1.SwapType.TO_BTCLN;
+        /**
+         * @internal
+         */
+        this.outputToken = Token_1.BitcoinTokens.BTCLN;
         if (isToBTCLNSwapInit(initOrObj)) {
             this.confidence = initOrObj.confidence;
             this.pr = initOrObj.pr;
@@ -50,49 +63,63 @@ class ToBTCLNSwap extends IToBTCSwap_1.IToBTCSwap {
             this.secret = initOrObj.secret;
             this.usesClaimHashAsId = initOrObj.usesClaimHashAsId ?? false;
         }
-        const paymentHash = this.getPaymentHash();
-        if (paymentHash != null)
-            this.paymentHash = paymentHash.toString("hex");
         this.logger = (0, Logger_1.getLogger)("ToBTCLN(" + this.getIdentifierHashString() + "): ");
         this.tryRecomputeSwapPrice();
     }
+    /**
+     * @inheritDoc
+     * @internal
+     */
     _setPaymentResult(result, check = false) {
         if (result == null)
             return Promise.resolve(false);
         if (result.secret == null)
             throw new IntermediaryError_1.IntermediaryError("No payment secret returned!");
+        const secretBuffer = buffer_1.Buffer.from(result.secret, "hex");
+        const hash = buffer_1.Buffer.from((0, sha2_1.sha256)(secretBuffer));
         if (check) {
-            const secretBuffer = buffer_1.Buffer.from(result.secret, "hex");
-            const hash = buffer_1.Buffer.from((0, sha2_1.sha256)(secretBuffer));
-            const claimHash = this.wrapper.contract.getHashForHtlc(hash);
+            const claimHash = this.wrapper._contract.getHashForHtlc(hash);
             const expectedClaimHash = buffer_1.Buffer.from(this.getClaimHash(), "hex");
             if (!claimHash.equals(expectedClaimHash))
                 throw new IntermediaryError_1.IntermediaryError("Invalid payment secret returned");
         }
+        this.pr ??= hash.toString("hex");
         this.secret = result.secret;
         return Promise.resolve(true);
     }
     //////////////////////////////
     //// Amounts & fees
+    /**
+     * @inheritDoc
+     */
     getOutputToken() {
         return Token_1.BitcoinTokens.BTCLN;
     }
+    /**
+     * @inheritDoc
+     */
     getOutput() {
         if (this.pr == null || !this.pr.toLowerCase().startsWith("ln"))
-            return (0, TokenAmount_1.toTokenAmount)(null, this.outputToken, this.wrapper.prices, this.pricingInfo);
+            return (0, TokenAmount_1.toTokenAmount)(null, this.outputToken, this.wrapper._prices, this.pricingInfo);
         const parsedPR = (0, bolt11_1.decode)(this.pr);
         if (parsedPR.millisatoshis == null)
             throw new Error("Swap invoice has no msat amount field!");
         const amount = (BigInt(parsedPR.millisatoshis) + 999n) / 1000n;
-        return (0, TokenAmount_1.toTokenAmount)(amount, this.outputToken, this.wrapper.prices, this.pricingInfo);
+        return (0, TokenAmount_1.toTokenAmount)(amount, this.outputToken, this.wrapper._prices, this.pricingInfo);
     }
     //////////////////////////////
     //// Getters & utils
+    /**
+     * @inheritDoc
+     */
     getOutputTxId() {
-        return this.getLpIdentifier();
+        const paymentHash = this.getPaymentHash();
+        if (paymentHash == null)
+            return null;
+        return paymentHash.toString("hex");
     }
     /**
-     * Returns the lightning BOLT11 invoice where the BTC will be sent to
+     * @inheritDoc
      */
     getOutputAddress() {
         return this.lnurl ?? this.pr ?? null;
@@ -104,14 +131,15 @@ class ToBTCLNSwap extends IToBTCSwap_1.IToBTCSwap {
         return this.secret ?? null;
     }
     /**
-     * Returns the confidence of the intermediary that this payment will succeed
-     * Value between 0 and 1, where 0 is not likely and 1 is very likely
+     * Returns the confidence of the intermediary that this payment will succeed.
+     *
+     * @returns Decimal value between 0 and 1, where 0 is not likely and 1 is very likely
      */
     getConfidence() {
         return this.confidence;
     }
     /**
-     * Checks whether a swap is likely to fail, based on the confidence as reported by the LP
+     * Checks whether a swap is likely to fail, based on the confidence as reported by the intermediary (LP)
      */
     willLikelyFail() {
         if (this.pr == null || !this.pr.toLowerCase().startsWith("ln"))
@@ -127,8 +155,8 @@ class ToBTCLNSwap extends IToBTCSwap_1.IToBTCSwap {
         return this.confidence === 0;
     }
     /**
-     * Tries to detect if the target lightning invoice is a non-custodial mobile wallet, care must be taken
-     *  for such a wallet to be online when attempting to make a swap
+     * Tries to detect if the target lightning invoice is a non-custodial mobile wallet, extract care must be taken
+     *  for such a wallet **to be online** when attempting to make a swap sending to such a wallet
      */
     isPayingToNonCustodialWallet() {
         if (this.pr == null || !this.pr.toLowerCase().startsWith("ln"))
@@ -139,64 +167,79 @@ class ToBTCLNSwap extends IToBTCSwap_1.IToBTCSwap {
         }
         return false;
     }
+    /**
+     * @inheritDoc
+     * @internal
+     */
     getIdentifierHash() {
         const idBuffer = this.usesClaimHashAsId
             ? buffer_1.Buffer.from(this.getClaimHash(), "hex")
             : this.getPaymentHash();
-        if (this.randomNonce == null)
+        if (this._randomNonce == null)
             return idBuffer;
-        return buffer_1.Buffer.concat([idBuffer, buffer_1.Buffer.from(this.randomNonce, "hex")]);
+        return buffer_1.Buffer.concat([idBuffer, buffer_1.Buffer.from(this._randomNonce, "hex")]);
     }
-    getPaymentHash() {
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    getLpIdentifier() {
         if (this.pr == null)
-            return null;
+            return this._data.getEscrowHash();
         if (this.pr.toLowerCase().startsWith("ln")) {
             const parsed = (0, bolt11_1.decode)(this.pr);
             if (parsed.tagsObject.payment_hash == null)
                 throw new Error("Swap invoice has no payment hash field!");
-            return buffer_1.Buffer.from(parsed.tagsObject.payment_hash, "hex");
+            return parsed.tagsObject.payment_hash;
         }
-        return buffer_1.Buffer.from(this.pr, "hex");
+        return this.pr;
     }
-    getLpIdentifier() {
+    /**
+     * Returns the payment hash of the swap, i.e. a payment hash of the lightning network invoice that
+     *  is about to be paid
+     */
+    getPaymentHash() {
         if (this.pr == null)
-            return this.data.getEscrowHash();
+            return null;
         if (this.pr.toLowerCase().startsWith("ln")) {
             const parsed = (0, bolt11_1.decode)(this.pr);
             if (parsed.tagsObject.payment_hash == null)
                 throw new Error("Swap invoice has no payment hash field!");
-            return parsed.tagsObject.payment_hash;
+            return buffer_1.Buffer.from(parsed.tagsObject.payment_hash, "hex");
         }
-        return this.pr;
+        return buffer_1.Buffer.from(this.pr, "hex");
     }
     //////////////////////////////
     //// LNURL-pay
     /**
-     * Is this an LNURL-pay swap?
+     * Whether this is an LNURL-pay swap
      */
     isLNURL() {
         return this.lnurl != null;
     }
     /**
-     * Gets the used LNURL or null if this is not an LNURL-pay swap
+     * Gets the used LNURL-pay link or `null` if this is not an LNURL-pay swap
      */
     getLNURL() {
         return this.lnurl ?? null;
     }
     /**
-     * Checks whether this LNURL payment contains a success message
+     * Checks whether this LNURL-pay payment contains a success action
      */
     hasSuccessAction() {
         return this.successAction != null;
     }
     /**
-     * Returns the success action after a successful payment, else null
+     * Returns the success action after a successful payment, else `null`
      */
     getSuccessAction() {
         return LNURL_1.LNURL.decodeSuccessAction(this.successAction, this.secret);
     }
     //////////////////////////////
     //// Storage
+    /**
+     * @inheritDoc
+     */
     serialize() {
         return {
             ...super.serialize(),