@atomiqlabs/sdk 8.3.6 → 8.4.4

package/dist/swaps/spv_swaps/SpvFromBTCSwap.js

@@ -87,6 +87,20 @@ var SpvFromBTCSwapState;
      */
     SpvFromBTCSwapState[SpvFromBTCSwapState["CLAIMED"] = 6] = "CLAIMED";
 })(SpvFromBTCSwapState = exports.SpvFromBTCSwapState || (exports.SpvFromBTCSwapState = {}));
+const SpvFromBTCSwapStateDescription = {
+    [SpvFromBTCSwapState.CLOSED]: "Catastrophic failure has occurred when processing the swap on the smart chain side, this implies a bug in the smart contract code or the user and intermediary deliberately creating a bitcoin transaction with invalid format unparsable by the smart contract.",
+    [SpvFromBTCSwapState.FAILED]: "Some of the bitcoin swap transaction inputs were double-spent, this means the swap has failed and no BTC was sent",
+    [SpvFromBTCSwapState.DECLINED]: "The intermediary (LP) declined to co-sign the submitted PSBT, hence the swap failed",
+    [SpvFromBTCSwapState.QUOTE_EXPIRED]: "Swap has expired for good and there is no way how it can be executed anymore",
+    [SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED]: "A swap is almost expired, and it should be presented to the user as expired, though there is still a chance that it will be processed",
+    [SpvFromBTCSwapState.CREATED]: "Swap was created, get the bitcoin swap PSBT that should be signed by the user's wallet and then submit it back to the SDK.",
+    [SpvFromBTCSwapState.SIGNED]: "Swap bitcoin PSBT was submitted by the client to the SDK",
+    [SpvFromBTCSwapState.POSTED]: "Swap bitcoin PSBT sent to the intermediary (LP), waiting for the intermediary co-sign it and broadcast.",
+    [SpvFromBTCSwapState.BROADCASTED]: "Intermediary (LP) has co-signed and broadcasted the bitcoin transaction.",
+    [SpvFromBTCSwapState.FRONTED]: "Settlement on the destination smart chain was fronted and funds were already received by the user, even before the final settlement.",
+    [SpvFromBTCSwapState.BTC_TX_CONFIRMED]: "Bitcoin transaction confirmed with necessary amount of confirmations, wait for automatic settlement by the watchtower or settle manually.",
+    [SpvFromBTCSwapState.CLAIMED]: "Swap settled on the smart chain and funds received"
+};
 function isSpvFromBTCSwapInit(obj) {
     return typeof obj === "object" &&
         typeof (obj.quoteId) === "string" &&
@@ -130,6 +144,14 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
             initOrObject.url += "/frombtc_spv";
         super(wrapper, initOrObject);
         this.TYPE = SwapType_1.SwapType.SPV_VAULT_FROM_BTC;
+        /**
+         * @internal
+         */
+        this.swapStateDescription = SpvFromBTCSwapStateDescription;
+        /**
+         * @internal
+         */
+        this.swapStateName = (state) => SpvFromBTCSwapState[state];
         if (isSpvFromBTCSwapInit(initOrObject)) {
             this._state = SpvFromBTCSwapState.CREATED;
             this.quoteId = initOrObject.quoteId;
@@ -190,6 +212,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
             this._claimTxId = initOrObject.claimTxId;
             this._frontTxId = initOrObject.frontTxId;
             this.gasPricingInfo = (0, PriceInfoType_1.deserializePriceInfoType)(initOrObject.gasPricingInfo);
+            this.btcTxConfirmedAt = initOrObject.btcTxConfirmedAt;
             if (initOrObject.data != null)
                 this._data = new this.wrapper._spvWithdrawalDataDeserializer(initOrObject.data);
         }
@@ -323,6 +346,14 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
     isFailed() {
         return this._state === SpvFromBTCSwapState.FAILED || this._state === SpvFromBTCSwapState.DECLINED || this._state === SpvFromBTCSwapState.CLOSED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return this._state === SpvFromBTCSwapState.POSTED ||
+            this._state === SpvFromBTCSwapState.BROADCASTED ||
+            this._state === SpvFromBTCSwapState.BTC_TX_CONFIRMED;
+    }
     /**
      * @inheritDoc
      */
@@ -778,6 +809,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
     /**
      * @inheritDoc
      *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
      * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
      *  if not provided a raw PSBT is returned instead which necessitates the implementor to manually add
      *  inputs to the bitcoin transaction and **set the nSequence field of the 2nd input** (input 1 -
@@ -795,13 +827,46 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
                     txs: [
                         options?.bitcoinWallet == null
                             ? { ...await this.getPsbt(), type: "RAW_PSBT" }
-                            : { ...await this.getFundedPsbt(options.bitcoinWallet), type: "FUNDED_PSBT" }
+                            : { ...await this.getFundedPsbt(options.bitcoinWallet, options?.bitcoinFeeRate), type: "FUNDED_PSBT" }
                     ]
                 }
             ];
         }
         throw new Error("Invalid swap state to obtain execution txns, required CREATED");
     }
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
+     * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
+     *  if not provided a raw PSBT is returned instead which necessitates the implementor to manually add
+     *  inputs to the bitcoin transaction and **set the nSequence field of the 2nd input** (input 1 -
+     *  indexing from 0) to the value returned in `in1sequence`
+     * @param options.manualSettlementSmartChainSigner Optional smart chain signer to create a manual claim (settlement) transaction
+     * @param options.maxWaitTillAutomaticSettlementSeconds Maximum time to wait for an automatic settlement after
+     *  the bitcoin transaction is confirmed (defaults to 60 seconds)
+     */
+    async getCurrentActions(options) {
+        if (this._state === SpvFromBTCSwapState.CREATED) {
+            try {
+                return await this.txsExecute(options);
+            }
+            catch (e) { }
+        }
+        if (this._state === SpvFromBTCSwapState.BTC_TX_CONFIRMED) {
+            if (this.btcTxConfirmedAt == null ||
+                options?.maxWaitTillAutomaticSettlementSeconds === 0 ||
+                (Date.now() - this.btcTxConfirmedAt) > (options?.maxWaitTillAutomaticSettlementSeconds ?? 60) * 1000) {
+                return [{
+                        name: "Claim",
+                        description: "Manually settle (claim) the swap on the destination smart chain",
+                        chain: this.chainIdentifier,
+                        txs: await this.txsClaim(options?.manualSettlementSmartChainSigner)
+                    }];
+            }
+        }
+        return [];
+    }
     //////////////////////////////
     //// Bitcoin tx listener
     /**
@@ -860,6 +925,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
         }
         if (this._state !== SpvFromBTCSwapState.FRONTED &&
             this._state !== SpvFromBTCSwapState.CLAIMED) {
+            this.btcTxConfirmedAt ??= Date.now();
             this._state = SpvFromBTCSwapState.BTC_TX_CONFIRMED;
             save = true;
         }
@@ -1078,7 +1144,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
         if (res.type === base_1.SpvWithdrawalStateType.CLAIMED) {
             if (this._state !== SpvFromBTCSwapState.CLAIMED) {
                 this._claimTxId = res.txId;
-                await this._saveAndEmit(SpvFromBTCSwapState.FRONTED);
+                await this._saveAndEmit(SpvFromBTCSwapState.CLAIMED);
             }
         }
         if (res.type === base_1.SpvWithdrawalStateType.CLOSED) {
@@ -1138,7 +1204,8 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
             senderAddress: this._senderAddress,
             claimTxId: this._claimTxId,
             frontTxId: this._frontTxId,
-            data: this._data?.serialize()
+            data: this._data?.serialize(),
+            btcTxConfirmedAt: this.btcTxConfirmedAt
         };
     }
     //////////////////////////////
@@ -1200,6 +1267,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
                 if (this._state !== SpvFromBTCSwapState.BTC_TX_CONFIRMED &&
                     this._state !== SpvFromBTCSwapState.FRONTED &&
                     this._state !== SpvFromBTCSwapState.CLAIMED) {
+                    this.btcTxConfirmedAt ??= Date.now();
                     this._state = SpvFromBTCSwapState.BTC_TX_CONFIRMED;
                     needsSave = true;
                 }

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

@@ -8,7 +8,7 @@ import { FeeType } from "../../../enums/FeeType";
 import { TokenAmount } from "../../../types/TokenAmount";
 import { BtcToken, SCToken } from "../../../types/Token";
 import { LoggerType } from "../../../utils/Logger";
-import { SwapExecutionActionLightning } from "../../../types/SwapExecutionAction";
+import { SwapExecutionAction, SwapExecutionActionLightning } from "../../../types/SwapExecutionAction";
 /**
  * State enum for trusted Lightning gas swaps
  *
@@ -24,7 +24,7 @@ export declare enum LnForGasSwapState {
      */
     FAILED = -1,
     /**
-     * Swap was created
+     * Swap was created, pay the provided lightning network invoice
      */
     PR_CREATED = 0,
     /**
@@ -51,6 +51,20 @@ export declare function isLnForGasSwapInit(obj: any): obj is LnForGasSwapInit;
  */
 export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap<T, LnForGasSwapTypeDefinition<T>, LnForGasSwapState> implements IAddressSwap {
     protected readonly TYPE: SwapType.TRUSTED_FROM_BTCLN;
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription: {
+        [-2]: string;
+        [-1]: string;
+        0: string;
+        1: string;
+        2: string;
+    };
+    /**
+     * @internal
+     */
+    protected readonly swapStateName: (state: number) => string;
     /**
      * @internal
      */
@@ -137,6 +151,10 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
      * @inheritDoc
      */
     isSuccessful(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      * @internal
@@ -195,6 +213,14 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
      * @inheritDoc
      */
     txsExecute(): Promise<[SwapExecutionActionLightning]>;
+    /**
+     * @remark Not supported
+     */
+    execute(): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
+    getCurrentActions(): Promise<SwapExecutionAction<T>[]>;
     /**
      * Queries the intermediary (LP) node for the state of the swap
      *

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

@@ -28,7 +28,7 @@ var LnForGasSwapState;
      */
     LnForGasSwapState[LnForGasSwapState["FAILED"] = -1] = "FAILED";
     /**
-     * Swap was created
+     * Swap was created, pay the provided lightning network invoice
      */
     LnForGasSwapState[LnForGasSwapState["PR_CREATED"] = 0] = "PR_CREATED";
     /**
@@ -40,6 +40,13 @@ var LnForGasSwapState;
      */
     LnForGasSwapState[LnForGasSwapState["FINISHED"] = 2] = "FINISHED";
 })(LnForGasSwapState = exports.LnForGasSwapState || (exports.LnForGasSwapState = {}));
+const LnForGasSwapStateDescription = {
+    [LnForGasSwapState.EXPIRED]: "The swap quote expired without user sending in the lightning network payment",
+    [LnForGasSwapState.FAILED]: "The swap has failed after the intermediary already received a lightning network payment on the source",
+    [LnForGasSwapState.PR_CREATED]: "Swap was created, pay the provided lightning network invoice",
+    [LnForGasSwapState.PR_PAID]: "User paid the lightning network invoice on the source",
+    [LnForGasSwapState.FINISHED]: "The swap is finished after the intermediary sent funds on the destination chain"
+};
 function isLnForGasSwapInit(obj) {
     return typeof (obj.pr) === "string" &&
         typeof (obj.outputAmount) === "bigint" &&
@@ -60,6 +67,14 @@ class LnForGasSwap extends ISwap_1.ISwap {
             initOrObj.url += "/lnforgas";
         super(wrapper, initOrObj);
         this.TYPE = SwapType_1.SwapType.TRUSTED_FROM_BTCLN;
+        /**
+         * @internal
+         */
+        this.swapStateDescription = LnForGasSwapStateDescription;
+        /**
+         * @internal
+         */
+        this.swapStateName = (state) => LnForGasSwapState[state];
         /**
          * @internal
          */
@@ -203,6 +218,12 @@ class LnForGasSwap extends ISwap_1.ISwap {
     isSuccessful() {
         return this._state === LnForGasSwapState.FINISHED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === LnForGasSwapState.PR_CREATED && this.initiated) || this._state === LnForGasSwapState.PR_PAID;
+    }
     /**
      * @inheritDoc
      * @internal
@@ -332,6 +353,23 @@ class LnForGasSwap extends ISwap_1.ISwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED");
     }
+    /**
+     * @remark Not supported
+     */
+    async execute() {
+        throw new Error("Not supported");
+    }
+    /**
+     * @inheritDoc
+     */
+    async getCurrentActions() {
+        try {
+            return await this.txsExecute();
+        }
+        catch (e) {
+            return [];
+        }
+    }
     /**
      * Queries the intermediary (LP) node for the state of the swap
      *

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

@@ -12,7 +12,7 @@ import { FeeType } from "../../../enums/FeeType";
 import { TokenAmount } from "../../../types/TokenAmount";
 import { BtcToken, SCToken } from "../../../types/Token";
 import { LoggerType } from "../../../utils/Logger";
-import { SwapExecutionActionBitcoin } from "../../../types/SwapExecutionAction";
+import { SwapExecutionAction, SwapExecutionActionBitcoin } from "../../../types/SwapExecutionAction";
 /**
  * State enum for trusted on-chain gas swaps
  *
@@ -32,7 +32,7 @@ export declare enum OnchainForGasSwapState {
      */
     REFUNDED = -1,
     /**
-     * Swap was created
+     * Swap was created, send the BTC to the swap address
      */
     PR_CREATED = 0,
     /**
@@ -61,8 +61,16 @@ export declare function isOnchainForGasSwapInit(obj: any): obj is OnchainForGasS
  *
  * @category Swaps/Trusted Gas Swaps
  */
-export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends ISwap<T, OnchainForGasSwapTypeDefinition<T>> implements IAddressSwap, IBTCWalletSwap {
+export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends ISwap<T, OnchainForGasSwapTypeDefinition<T>, OnchainForGasSwapState> implements IAddressSwap, IBTCWalletSwap {
     protected readonly TYPE: SwapType.TRUSTED_FROM_BTC;
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription: Record<OnchainForGasSwapState, string>;
+    /**
+     * @internal
+     */
+    protected readonly swapStateName: (state: number) => string;
     /**
      * @internal
      */
@@ -163,6 +171,10 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
      * @inheritDoc
      */
     isSuccessful(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      * @internal
@@ -259,6 +271,19 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     }): Promise<[
         SwapExecutionActionBitcoin<"ADDRESS" | "FUNDED_PSBT">
     ]>;
+    /**
+     * @remark Not supported
+     */
+    execute(): Promise<boolean>;
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
+     *  if not provided an address is returned instead.
+     */
+    getCurrentActions(options?: {
+        bitcoinWallet?: MinimalBitcoinWalletInterface;
+    }): Promise<SwapExecutionAction<T>[]>;
     /**
      * Queries the intermediary (LP) node for the state of the swap
      *

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

@@ -37,7 +37,7 @@ var OnchainForGasSwapState;
      */
     OnchainForGasSwapState[OnchainForGasSwapState["REFUNDED"] = -1] = "REFUNDED";
     /**
-     * Swap was created
+     * Swap was created, send the BTC to the swap address
      */
     OnchainForGasSwapState[OnchainForGasSwapState["PR_CREATED"] = 0] = "PR_CREATED";
     /**
@@ -49,6 +49,14 @@ var OnchainForGasSwapState;
      */
     OnchainForGasSwapState[OnchainForGasSwapState["REFUNDABLE"] = 2] = "REFUNDABLE";
 })(OnchainForGasSwapState = exports.OnchainForGasSwapState || (exports.OnchainForGasSwapState = {}));
+const OnchainForGasSwapStateDescription = {
+    [OnchainForGasSwapState.EXPIRED]: "The swap quote expired without user sending in the BTC",
+    [OnchainForGasSwapState.FAILED]: "The swap has failed after the intermediary already received the BTC on the source chain",
+    [OnchainForGasSwapState.REFUNDED]: "Swap was refunded and BTC returned to the user's refund address",
+    [OnchainForGasSwapState.PR_CREATED]: "Swap was created, send the BTC to the swap address",
+    [OnchainForGasSwapState.FINISHED]: "The swap is finished after the intermediary sent funds on the destination chain",
+    [OnchainForGasSwapState.REFUNDABLE]: "Swap is refundable because the intermediary cannot honor the swap request on the destination chain",
+};
 function isOnchainForGasSwapInit(obj) {
     return typeof (obj.paymentHash) === "string" &&
         typeof (obj.sequence) === "bigint" &&
@@ -73,6 +81,14 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
             initOrObj.url += "/frombtc_trusted";
         super(wrapper, initOrObj);
         this.TYPE = SwapType_1.SwapType.TRUSTED_FROM_BTC;
+        /**
+         * @internal
+         */
+        this.swapStateDescription = OnchainForGasSwapStateDescription;
+        /**
+         * @internal
+         */
+        this.swapStateName = (state) => OnchainForGasSwapState[state];
         this.wrapper = wrapper;
         if (isOnchainForGasSwapInit(initOrObj)) {
             this.paymentHash = initOrObj.paymentHash;
@@ -209,6 +225,13 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
     isSuccessful() {
         return this._state === OnchainForGasSwapState.FINISHED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === OnchainForGasSwapState.PR_CREATED && this.txId != null) ||
+            (this._state === OnchainForGasSwapState.REFUNDABLE && this.refundAddress != null);
+    }
     /**
      * @inheritDoc
      * @internal
@@ -437,6 +460,26 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
     }
+    /**
+     * @remark Not supported
+     */
+    async execute() {
+        throw new Error("Not supported");
+    }
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
+     *  if not provided an address is returned instead.
+     */
+    async getCurrentActions(options) {
+        try {
+            return await this.txsExecute(options);
+        }
+        catch (e) {
+            return [];
+        }
+    }
     //////////////////////////////
     //// Payment
     /**

package/dist/types/SwapStateInfo.d.ts

@@ -0,0 +1,5 @@
+export type SwapStateInfo<S extends number> = {
+    state: S;
+    name: string;
+    description: string;
+};

package/dist/types/SwapStateInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/lnurl/LNURLPay.d.ts

@@ -47,7 +47,6 @@ export declare function isLNURLPayParams(obj: any): obj is LNURLPayParams;
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 export declare function isLNURLPay(value: any): value is LNURLPay;
 /**

package/dist/types/lnurl/LNURLPay.js

@@ -15,7 +15,6 @@ exports.isLNURLPayParams = isLNURLPayParams;
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 function isLNURLPay(value) {
     return (typeof value === "object" &&

package/dist/types/lnurl/LNURLWithdraw.d.ts

@@ -37,7 +37,6 @@ export type LNURLWithdraw = {
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 export declare function isLNURLWithdraw(value: any): value is LNURLWithdraw;
 /**

package/dist/types/lnurl/LNURLWithdraw.js

@@ -5,7 +5,6 @@ exports.isLNURLWithdrawParams = exports.isLNURLWithdraw = void 0;
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 function isLNURLWithdraw(value) {
     return (typeof value === "object" &&

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "8.3.6",
+  "version": "8.4.4",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",
@@ -30,6 +30,8 @@
     "@noble/ciphers": "^1.2.1",
     "@noble/hashes": "^1.7.1",
     "@scure/base": "^1.2.4",
+    "@scure/bip32": "^2.0.1",
+    "@scure/bip39": "^2.0.1",
     "@scure/btc-signer": "1.7.0",
     "buffer": "6.0.3",
     "events": "3.3.0"

package/src/bitcoin/wallet/BitcoinWallet.ts

@@ -1,5 +1,5 @@
 import {coinSelect, maxSendable, CoinselectAddressTypes, CoinselectTxInput} from "../coinselect2";
-import {BTC_NETWORK} from "@scure/btc-signer/utils"
+import {BTC_NETWORK, NETWORK, TEST_NETWORK} from "@scure/btc-signer/utils"
 import {p2wpkh, OutScript, Transaction, p2tr, Address} from "@scure/btc-signer";
 import {IBitcoinWallet} from "./IBitcoinWallet";
 import {Buffer} from "buffer";
@@ -7,7 +7,7 @@ import {randomBytes} from "../../utils/Utils";
 import {toCoinselectAddressType, toOutputScript} from "../../utils/BitcoinUtils";
 import {TransactionInputUpdate} from "@scure/btc-signer/psbt";
 import {getLogger} from "../../utils/Logger";
-import {BitcoinRpcWithAddressIndex} from "@atomiqlabs/base";
+import {BitcoinNetwork, BitcoinRpcWithAddressIndex} from "@atomiqlabs/base";
 
 /**
  * UTXO data structure for Bitcoin wallets
@@ -50,6 +50,16 @@ export function identifyAddressType(address: string, network: BTC_NETWORK): Coin
     }
 }
 
+const btcNetworkMapping = {
+    [BitcoinNetwork.MAINNET]: NETWORK,
+    [BitcoinNetwork.TESTNET]: TEST_NETWORK,
+    [BitcoinNetwork.TESTNET4]: TEST_NETWORK,
+    [BitcoinNetwork.REGTEST]: {
+        ...TEST_NETWORK,
+        bech32: "bcrt"
+    }
+}
+
 const logger = getLogger("BitcoinWallet: ");
 
 /**
@@ -65,9 +75,13 @@ export abstract class BitcoinWallet implements IBitcoinWallet {
     protected feeMultiplier: number;
     protected feeOverride?: number;
 
-    constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, network: BTC_NETWORK, feeMultiplier: number = 1.25, feeOverride?: number) {
+    constructor(
+        mempoolApi: BitcoinRpcWithAddressIndex<any>,
+        network: BitcoinNetwork | BTC_NETWORK,
+        feeMultiplier: number = 1.25, feeOverride?: number
+    ) {
         this.rpc = mempoolApi;
-        this.network = network;
+        this.network = typeof(network)==="object" ? network : BitcoinWallet.bitcoinNetworkToObject(network);
         this.feeMultiplier = feeMultiplier;
         this.feeOverride = feeOverride;
     }
@@ -407,5 +421,8 @@ export abstract class BitcoinWallet implements IBitcoinWallet {
         totalFee: number
     }>;
 
+    static bitcoinNetworkToObject(network: BitcoinNetwork): BTC_NETWORK {
+        return btcNetworkMapping[network];
+    }
 
 }

package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts

@@ -1,9 +1,13 @@
 import {CoinselectAddressTypes} from "../coinselect2";
-import {BTC_NETWORK, pubECDSA, randomPrivateKeyBytes} from "@scure/btc-signer/utils"
+import {BTC_NETWORK, NETWORK, pubECDSA, randomPrivateKeyBytes, TEST_NETWORK} from "@scure/btc-signer/utils"
 import {getAddress, Transaction, WIF} from "@scure/btc-signer";
 import {Buffer} from "buffer";
 import {identifyAddressType, BitcoinWallet} from "./BitcoinWallet";
-import {BitcoinRpcWithAddressIndex} from "@atomiqlabs/base";
+import {BitcoinNetwork, BitcoinRpcWithAddressIndex} from "@atomiqlabs/base";
+import {HDKey} from "@scure/bip32";
+import {entropyToMnemonic, generateMnemonic, mnemonicToSeed} from "@scure/bip39";
+import {wordlist} from "@scure/bip39/wordlists/english.js";
+import {sha256} from "@noble/hashes/sha2";
 
 /**
  * Bitcoin wallet implementation deriving a single address from a WIF encoded private key
@@ -19,11 +23,14 @@ export class SingleAddressBitcoinWallet extends BitcoinWallet {
 
     constructor(
         mempoolApi: BitcoinRpcWithAddressIndex<any>,
-        network: BTC_NETWORK,
+        _network: BitcoinNetwork | BTC_NETWORK,
         addressDataOrWIF: string | {address: string, publicKey: string},
         feeMultiplier: number = 1.25,
         feeOverride?: number
     ) {
+        const network = typeof(_network)==="object"
+            ? _network
+            : BitcoinWallet.bitcoinNetworkToObject(_network);
         super(mempoolApi, network, feeMultiplier, feeOverride);
         if(typeof(addressDataOrWIF)==="string") {
             try {
@@ -144,8 +151,56 @@ export class SingleAddressBitcoinWallet extends BitcoinWallet {
      *
      * @returns A WIF encoded bitcoin private key
      */
-    static generateRandomPrivateKey(network?: BTC_NETWORK): string {
-         return WIF(network).encode(randomPrivateKeyBytes());
+    static generateRandomPrivateKey(network?: BitcoinNetwork | BTC_NETWORK): string {
+        const networkObject = network==null || typeof(network)==="object"
+            ? network
+            : BitcoinWallet.bitcoinNetworkToObject(network);
+         return WIF(networkObject).encode(randomPrivateKeyBytes());
+    }
+
+    /**
+     * Generates a 12-word long mnemonic from any entropy source with 128-bits or more, the entropy is first hashed
+     *  using sha256, and the first 16 bytes of the hash are used to generate the mnemonic
+     *
+     * @param entropy Entropy to use for generating the mnemonic
+     */
+    static mnemonicFromEntropy(entropy: Buffer): string {
+        if(entropy.length<16) throw new Error("Requires at least 128-bit entropy (16 bytes)");
+        const entropyHash = Buffer.from(sha256(entropy)).subarray(0, 16);
+        return entropyToMnemonic(entropyHash, wordlist);
+    }
+
+    /**
+     * Generates a random 12-word long mnemonic
+     */
+    static generateRandomMnemonic(): string {
+        return generateMnemonic(wordlist, 128)
+    }
+
+    /**
+     * Generates a WIF private key from mnemonic phrase
+     *
+     * @param mnemonic Mnemonic to generate the WIF key from
+     * @param network Optional bitcoin network to generate the WIF for
+     * @param derivationPath Optional custom derivation path to use for deriving the wallet
+     */
+    static async mnemonicToPrivateKey(
+        mnemonic: string,
+        network?: BitcoinNetwork | BTC_NETWORK,
+        derivationPath?: string
+    ): Promise<string> {
+        const networkObject = network==null || typeof(network)==="object"
+            ? network
+            : BitcoinWallet.bitcoinNetworkToObject(network);
+
+        derivationPath = networkObject==null || networkObject.bech32===NETWORK.bech32
+            ? "m/84'/0'/0'/0/0" //Mainnet
+            : "m/84'/1'/0'/0/0"; //Testnet
+        const seed = await mnemonicToSeed(mnemonic);
+        const hdKey = HDKey.fromMasterSeed(seed);
+        const privateKey = hdKey.derive(derivationPath).privateKey;
+        if(privateKey==null) throw new Error("Cannot derive private key from the mnemonic!");
+        return WIF(networkObject).encode(privateKey);
     }
 
 }

package/src/index.ts

@@ -127,6 +127,7 @@ export * from "./types/wallets/MinimalBitcoinWalletInterface";
 export * from "./types/wallets/MinimalLightningNetworkWalletInterface";
 export * from "./types/wallets/LightningInvoiceCreateService";
 
+export * from "./types/SwapStateInfo";
 export * from "./types/AmountData";
 export * from "./types/CustomPriceFunction";
 export * from "./types/SwapExecutionAction";