@gardenfi/core 2.2.1 → 2.3.0

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-lHPQc7tc.cjs");exports.API=e.API;exports.BlockNumberFetcher=e.BlockNumberFetcher;exports.EvmRelay=e.EvmRelay;exports.Garden=e.Garden;exports.OrderActions=e.OrderActions;exports.OrderStatus=e.OrderStatus;exports.ParseOrderStatus=e.ParseOrderStatus;exports.ParseSwapStatus=e.ParseSwapStatus;exports.Quote=e.Quote;exports.STARKNET_CONFIG=e.STARKNET_CONFIG;exports.SecretManager=e.SecretManager;exports.SolanaHTLC=e.SolanaHTLC;exports.SolanaRelay=e.SolanaRelay;exports.SolanaRelayerAddress=e.SolanaRelayerAddress;exports.StarknetHTLC=e.StarknetHTLC;exports.StarknetRelay=e.StarknetRelay;exports.SwapStatus=e.SwapStatus;exports.botanix=e.botanixMainnet;exports.checkStarknetAlloance=e.checkAllowance;exports.checkStarknetAllowanceAndApprove=e.checkAllowanceAndApprove;exports.constructOrderPair=e.constructOrderPair;exports.evmToViemChainMap=e.evmToViemChainMap;exports.filterDeadlineExpiredOrders=e.filterDeadlineExpiredOrders;exports.hyperliquid=e.hyperliquid;exports.hyperliquidTestnet=e.hyperliquidTestnet;exports.isExpired=e.isExpired;exports.isStarknetAllowanceSufficient=e.isAllowanceSufficient;exports.parseAction=e.parseAction;exports.parseActionFromStatus=e.parseActionFromStatus;exports.resolveApiConfig=e.resolveApiConfig;exports.solanaProgramAddress=e.solanaProgramAddress;exports.switchOrAddNetwork=e.switchOrAddNetwork;exports.toXOnly=e.toXOnly;exports.validateBTCAddress=e.validateBTCAddress;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-DVTNtaWz.cjs");exports.API=e.API;exports.BitcoinNetwork=e.BitcoinNetwork;exports.BitcoinProvider=e.BitcoinProvider;exports.BitcoinWallet=e.BitcoinWallet;exports.BlockNumberFetcher=e.BlockNumberFetcher;exports.EvmRelay=e.EvmRelay;exports.Garden=e.Garden;exports.OrderActions=e.OrderActions;exports.OrderStatus=e.OrderStatus;exports.ParseOrderStatus=e.ParseOrderStatus;exports.ParseSwapStatus=e.ParseSwapStatus;exports.Quote=e.Quote;exports.STARKNET_CONFIG=e.STARKNET_CONFIG;exports.SecretManager=e.SecretManager;exports.SolanaHTLC=e.SolanaHTLC;exports.SolanaRelay=e.SolanaRelay;exports.SolanaRelayerAddress=e.SolanaRelayerAddress;exports.StarknetHTLC=e.StarknetHTLC;exports.StarknetRelay=e.StarknetRelay;exports.SwapStatus=e.SwapStatus;exports.botanix=e.botanixMainnet;exports.checkStarknetAlloance=e.checkAllowance;exports.checkStarknetAllowanceAndApprove=e.checkAllowanceAndApprove;exports.constructOrderPair=e.constructOrderPair;exports.evmToViemChainMap=e.evmToViemChainMap;exports.filterDeadlineExpiredOrders=e.filterDeadlineExpiredOrders;exports.hyperliquid=e.hyperliquid;exports.hyperliquidTestnet=e.hyperliquidTestnet;exports.isExpired=e.isExpired;exports.isStarknetAllowanceSufficient=e.isAllowanceSufficient;exports.parseAction=e.parseAction;exports.parseActionFromStatus=e.parseActionFromStatus;exports.resolveApiConfig=e.resolveApiConfig;exports.solanaProgramAddress=e.solanaProgramAddress;exports.switchOrAddNetwork=e.switchOrAddNetwork;exports.toXOnly=e.toXOnly;exports.validateBTCAddress=e.validateBTCAddress;

package/dist/index.js

@@ -1,37 +1,40 @@
-import { M as e, m as r, E as t, G as n, O as o, n as i, P as l, q as d, Q as S, N as c, v as A, k as p, j as u, R as k, h as O, S as h, o as m, L as y, y as T, w, z as C, F as v, t as P, K as R, J as f, r as x, x as E, p as N, u as F, D as g, T as q, I as G, C as I, A as L } from "./index-eHNvzW2C.js";
+import { T as e, M as r, N as t, R as i, m as n, E as o, G as l, O as d, n as c, P as S, q as A, Q as p, U as u, v as k, k as O, j as h, V as m, h as w, S as y, o as T, L as v, y as C, w as P, z as N, F as R, t as f, K as x, J as B, r as E, x as F, p as g, u as q, D as G, W as I, I as L, C as M, A as b } from "./index-rQk9wiZU.js";
 export {
   e as API,
-  r as BlockNumberFetcher,
-  t as EvmRelay,
-  n as Garden,
-  o as OrderActions,
-  i as OrderStatus,
-  l as ParseOrderStatus,
-  d as ParseSwapStatus,
-  S as Quote,
-  c as STARKNET_CONFIG,
-  A as SecretManager,
-  p as SolanaHTLC,
-  u as SolanaRelay,
-  k as SolanaRelayerAddress,
-  O as StarknetHTLC,
-  h as StarknetRelay,
-  m as SwapStatus,
-  y as botanix,
-  T as checkStarknetAlloance,
-  w as checkStarknetAllowanceAndApprove,
-  C as constructOrderPair,
-  v as evmToViemChainMap,
-  P as filterDeadlineExpiredOrders,
-  R as hyperliquid,
-  f as hyperliquidTestnet,
-  x as isExpired,
-  E as isStarknetAllowanceSufficient,
-  N as parseAction,
-  F as parseActionFromStatus,
-  g as resolveApiConfig,
-  q as solanaProgramAddress,
-  G as switchOrAddNetwork,
-  I as toXOnly,
-  L as validateBTCAddress
+  r as BitcoinNetwork,
+  t as BitcoinProvider,
+  i as BitcoinWallet,
+  n as BlockNumberFetcher,
+  o as EvmRelay,
+  l as Garden,
+  d as OrderActions,
+  c as OrderStatus,
+  S as ParseOrderStatus,
+  A as ParseSwapStatus,
+  p as Quote,
+  u as STARKNET_CONFIG,
+  k as SecretManager,
+  O as SolanaHTLC,
+  h as SolanaRelay,
+  m as SolanaRelayerAddress,
+  w as StarknetHTLC,
+  y as StarknetRelay,
+  T as SwapStatus,
+  v as botanix,
+  C as checkStarknetAlloance,
+  P as checkStarknetAllowanceAndApprove,
+  N as constructOrderPair,
+  R as evmToViemChainMap,
+  f as filterDeadlineExpiredOrders,
+  x as hyperliquid,
+  B as hyperliquidTestnet,
+  E as isExpired,
+  F as isStarknetAllowanceSufficient,
+  g as parseAction,
+  q as parseActionFromStatus,
+  G as resolveApiConfig,
+  I as solanaProgramAddress,
+  L as switchOrAddNetwork,
+  M as toXOnly,
+  b as validateBTCAddress
 };

package/dist/src/index.d.ts

@@ -18,7 +18,11 @@ export { SecretManager } from './lib/secretManager/secretManager';
 export type { ISecretManager, Secret, } from './lib/secretManager/secretManager.types';
 export { checkAllowanceAndApprove as checkStarknetAllowanceAndApprove, isAllowanceSufficient as isStarknetAllowanceSufficient, checkAllowance as checkStarknetAlloance, } from './lib/starknet/checkAllowanceAndApprove';
 export { Quote } from './lib/quote/quote';
-export type { IQuote, QuoteResponse, Strategies, } from './lib/quote/quote.types';
+export type { IQuote, QuoteResponse, Strategies, QuoteParamsForAssets, QuoteParamsForOrderPair, QuoteOptions, BaseQuoteParams, } from './lib/quote/quote.types';
 export { constructOrderPair, validateBTCAddress, toXOnly, resolveApiConfig, } from './lib/utils';
 export { evmToViemChainMap, switchOrAddNetwork, hyperliquidTestnet, hyperliquid, botanixMainnet as botanix, } from './lib/switchOrAddNetwork';
+export { BitcoinNetwork } from './lib/bitcoin/provider/provider.interface';
+export { BitcoinProvider } from './lib/bitcoin/provider/provider';
+export { BitcoinWallet } from './lib/bitcoin/wallet/wallet';
+export type { IBitcoinProvider } from './lib/bitcoin/provider/provider.interface';
 export { API, STARKNET_CONFIG, SolanaRelayerAddress, solanaProgramAddress, } from './lib/constants';

package/dist/src/lib/bitcoin/API.d.ts

@@ -0,0 +1,4 @@
+export declare const verifyAPIs: (APIs: string[]) => string[];
+export declare const getAPIs: (network: string) => string[];
+export declare const RPC_URLS_TESTNET: string[];
+export declare const RPC_URLS_MAINNET: string[];

package/dist/src/lib/bitcoin/ASConfig.d.ts

@@ -0,0 +1,19 @@
+import { Address } from 'viem';
+import { OnChainIdentifier } from '../identifier';
+
+export type AtomicSwapConfig = {
+    secretHash: string;
+    /**
+     * The number of blocks before the swap expires
+     */
+    expiryBlocks: number;
+    /**
+     * Amount in it's lowest denomination
+     */
+    amount: bigint;
+    recipientAddress: OnChainIdentifier;
+    refundAddress: OnChainIdentifier;
+    initiatorAddress: OnChainIdentifier;
+    contractAddress?: Address;
+    chain?: number;
+};

package/dist/src/lib/bitcoin/errors.d.ts

@@ -0,0 +1,16 @@
+export declare const BWErrors: {
+    INVALID_PK: string;
+    FEE_EXCEEDS_AMOUNT: (fee: number, amt: number) => string;
+    SWAP_NOT_FOUND: string;
+    SCRIPT_NOT_FUNDED: string;
+    SWAP_NOT_EXPIRED: (expiry: number) => string;
+    MIN_AMOUNT: (minAmt: number) => string;
+    INSUFFICIENT_FUNDS: (actual: number, expected: number) => string;
+    AmtPlusFeeExceedsBalance: (amt: number, fee: number, balance: number) => string;
+};
+export declare const BitcoinHTLCErrors: {
+    INVALID_SECRET_HASH: string;
+    INVALID_PUBKEY_OR_SECRET: string;
+    INVALID_PUBKEY: string;
+    ORDER_NOT_EXPIRED: string;
+};

package/dist/src/lib/bitcoin/htlc.d.ts

@@ -1,4 +1,5 @@
-import { IBitcoinWallet, IHTLCWallet } from '@catalogfi/wallets';
+import { IHTLCWallet } from '../htlc.interface';
+import { IBitcoinWallet } from './wallet/wallet.interface';
 
 export declare enum Leaf {
     REFUND = 0,

package/dist/src/lib/bitcoin/htlcScript.d.ts

@@ -0,0 +1,7 @@
+import { Network } from 'bitcoinjs-lib';
+import { AtomicSwapConfig } from './ASConfig';
+
+export declare const getHTLCScript: (swapConfig: AtomicSwapConfig, network: Network, legacy?: boolean) => {
+    script: Buffer<ArrayBufferLike>;
+    address: string;
+};

package/dist/src/lib/bitcoin/interface.d.ts

@@ -0,0 +1,6 @@
+export declare const AddressType: {
+    readonly p2pkh: "p2pkh";
+    readonly p2wpkh: "p2wpkh";
+    readonly 'p2wpkh-p2sh': "p2wpkh-p2sh";
+};
+export type AddressType = typeof AddressType[keyof typeof AddressType];

package/dist/src/lib/bitcoin/paths.d.ts

@@ -0,0 +1,7 @@
+import { BitcoinNetwork } from './provider/provider.interface';
+
+export declare const BitcoinPaths: {
+    bip44: (network: BitcoinNetwork, index?: number, account?: number) => string;
+    bip49: (network: BitcoinNetwork, index?: number, account?: number) => string;
+    bip84: (network: BitcoinNetwork, index?: number, account?: number) => string;
+};

package/dist/src/lib/bitcoin/provider/provider.d.ts

@@ -0,0 +1,118 @@
+import { BitcoinNetwork, BitcoinTx, BitcoinTxType, BitcoinUTXO, FeeRates, IBitcoinProvider, Urgency } from './provider.interface';
+
+export declare class BitcoinProvider implements IBitcoinProvider {
+    private readonly network;
+    private readonly APIs;
+    private cacheTimeout;
+    private readonly utxosCache;
+    constructor(network: BitcoinNetwork, API?: string);
+    /**
+     * Gets the output index of the UTXO
+     *
+     * @param {string} txId - Transaction ID
+     * @param {string} address - Address of the UTXO
+     *
+     * @returns {Promise<number>} Output index
+     *
+     * @throws If the UTXO is not found
+     */
+    getTxIndex(txId: string, address: string): Promise<number>;
+    /**
+     * Broadcasts the transaction. Retries upto 5 times.
+     *
+     * @param {string} tx - Hex representation of the transaction
+     * @returns {Promise<string>} Transaction ID
+     *
+     * @throws If the it fails to broadcast
+     */
+    broadcast(tx: string): Promise<string>;
+    /**
+     * Gets the balance of an address
+     *
+     * @param {string} address - Bitcoin address
+     * @returns {Promise<number>} The balance in satoshies
+     */
+    getBalance(address: string): Promise<number>;
+    /**
+     * Sets the timeout for the cache
+     *
+     * After the timeout, the cache will be invalidated and the next call will not use the cache
+     * @param timeout - Time in milliseconds
+     */
+    setTimeoutForCache(timeout: number): void;
+    /**
+     * Returns all UTXOs that can be unlocked by the given address. If the balance field is provided
+     * then the returned UTXOs are sorted in descending order.
+     *
+     * @param {string} address - Bitcoin address
+     * @param {number} [balance] - The upper cap for the summation of the returned UTXOs.
+     */
+    getUTXOs(address: string, balance?: number | undefined): Promise<BitcoinUTXO[]>;
+    /**
+     * Transaction Hex for the given transaction ID
+     *
+     * @param {string} txId - Transaction ID
+     * @returns {Promise<string>} Transaction Hex
+     */
+    getTransactionHex(txId: string): Promise<string>;
+    /**
+     * Transaction for the given transaction ID
+     *
+     * @param {string} txId - Transaction ID
+     * @returns {Promise<BitcoinTx>}
+     */
+    getTransaction(txId: string): Promise<BitcoinTx>;
+    /**
+     * Confirmations for the given transaction ID
+     *
+     * @param {string} txHash - Transaction ID
+     * @returns {Promise<number>} The number of confirmation
+     */
+    getConfirmations(txHash: string): Promise<number>;
+    /**
+     * Get fee rates
+     *
+     * @returns {Promise<FeeRates>}
+     */
+    getFeeRates(): Promise<FeeRates>;
+    /**
+     * Transactions for the given address and type. Limits to the latest 50 transactions.
+     *
+     * @param {string} address - Bitcoin address
+     * @param {BitcoinTxType} type - Transaction type
+     *
+     * @returns {Promise<BitcoinTx[]>}
+     */
+    getTransactions(address: string, type: BitcoinTxType): Promise<BitcoinTx[]>;
+    /**
+     * Returns the network of the provider
+     *
+     * @returns {BitcoinNetwork}
+     */
+    getNetwork(): BitcoinNetwork;
+    /**
+     * Returns the latest block height
+     *
+     * @returns {Promise<number>} Block height
+     */
+    getLatestTip(): Promise<number>;
+    /**
+     * Suggests fee for sending a transaction with a given amount. Must only be used for segwit inputs and outputs
+     *
+     *
+     * only for segwit inputs and outputs
+     * @param {string} account - Bitcoin address
+     * @param {number} amount - in satoshis
+     * @param {Urgency} urgency - urgency of the transaction
+     *
+     * @returns {Promise<number>} Recommended Fee
+     */
+    suggestFee(account: string, amount: number, urgency: Urgency): Promise<number>;
+    /**
+     * Returns the timestamps when a list of unconfirmed transactions was initially observed in the mempool.
+     * If a transaction is not found in the mempool or has been mined, the timestamp will be 0.
+     * @param txIds
+     * @returns List of time stamps in milliseconds
+     */
+    getTransactionTimes(txIds: string[]): Promise<number[]>;
+}

package/dist/src/lib/bitcoin/provider/provider.interface.d.ts

@@ -0,0 +1,99 @@
+type BaseUTXO = {
+    txid: string;
+    vout: number;
+    value: number;
+};
+export type BitcoinUTXO = ({
+    status: {
+        confirmed: true;
+        block_height: number;
+    };
+} | {
+    status: {
+        confirmed: false;
+    };
+}) & BaseUTXO;
+/**
+ * Enum for fee rates
+ * @enum {string}
+ */
+export declare enum Urgency {
+    SLOW = "SLOW",
+    MEDIUM = "MEDIUM",
+    FAST = "FAST"
+}
+/**
+ * Interface for Bitcoin provider
+ *
+ * Gives read only access to the mempool
+ */
+export interface IBitcoinProvider {
+    broadcast(tx: string): Promise<string>;
+    getUTXOs(address: string, balance?: number): Promise<BitcoinUTXO[]>;
+    getBalance(address: string): Promise<number>;
+    getTransaction(txId: string): Promise<BitcoinTx>;
+    getTransactionHex(txId: string): Promise<string>;
+    getFeeRates(): Promise<FeeRates>;
+    getTransactions(address: string, type: BitcoinTxType): Promise<BitcoinTx[]>;
+    getNetwork(): BitcoinNetwork;
+    getLatestTip(): Promise<number>;
+    getConfirmations(txHash: string): Promise<number>;
+    getTxIndex(txId: string, address: string): Promise<number>;
+    getTransactionTimes(txIds: string[]): Promise<number[]>;
+    suggestFee(account: string, amount: number, urgency: Urgency): Promise<number>;
+}
+export type BitcoinTx = {
+    txid: string;
+    fee: number;
+    vin: {
+        txid: string;
+        vout: number;
+        scriptsig?: string;
+        scriptsig_asm?: string;
+        is_coinbase: boolean;
+        witness?: string[];
+        sequence: number;
+        prevout: {
+            scriptpubkey: string;
+            scriptpubkey_asm: string;
+            scriptpubkey_type: string;
+            scriptpubkey_address: string;
+            value: number;
+        };
+    }[];
+    vout: {
+        scriptpubkey: string;
+        scriptpubkey_asm: string;
+        scriptpubkey_type: string;
+        scriptpubkey_address: string;
+        value: number;
+    }[];
+    status: {
+        confirmed: boolean;
+        block_height?: number;
+        block_hash?: string;
+        block_time?: number;
+    };
+};
+export type FeeRates = {
+    fastestFee: number;
+    halfHourFee: number;
+    hourFee: number;
+    economyFee: number;
+    minimumFee: number;
+};
+export declare enum BitcoinNetwork {
+    Mainnet = "Mainnet",
+    Testnet = "Testnet",
+    Regtest = "Regtest"
+}
+export declare enum BitcoinTxType {
+    ALL = "ALL",
+    IN = "IN",
+    OUT = "OUT"
+}
+export type FeeRateKeys = keyof FeeRates;
+export declare const UrgencyToFeeRateKey: {
+    [urgency in Urgency]: FeeRateKeys;
+};
+export {};

package/dist/src/lib/bitcoin/script.d.ts

@@ -0,0 +1,6 @@
+export declare const ScriptType: {
+    readonly P2SH: "p2sh";
+    readonly P2WSH: "p2wsh";
+    readonly P2TR: "p2tr";
+};
+export type ScriptType = typeof ScriptType[keyof typeof ScriptType];

package/dist/src/lib/bitcoin/sig.d.ts

@@ -0,0 +1,20 @@
+export type SigHashType = number;
+type SignatureType = 'segwitV0' | 'segwitV1' | 'p2shSignature';
+export declare const SigHashType: {
+    readonly ALL: 1;
+    readonly NONE: 2;
+    readonly SINGLE: 3;
+    readonly ALL_ANYONECANPAY: number;
+    readonly NONE_ANYONECANPAY: number;
+    readonly SINGLE_ANYONECANPAY: number;
+};
+export declare class AddSignature {
+    _scriptType: SignatureType;
+    _sigHashType: SigHashType;
+    constructor(type: SignatureType, sigHashType: SigHashType);
+    get scriptType(): SignatureType;
+    get sigHashType(): number;
+    toString(): string;
+    static fromString(str: string): Promise<AddSignature>;
+}
+export {};

package/dist/src/lib/bitcoin/utils.d.ts

@@ -0,0 +1,8 @@
+import { networks } from 'bitcoinjs-lib';
+import { BitcoinNetwork } from './provider/provider.interface';
+
+export declare function getBitcoinNetwork(network: BitcoinNetwork): networks.Network;
+export declare function mnemonicToPrivateKey(mnemonic: string, network: BitcoinNetwork, opts?: {
+    index?: number;
+    path?: string;
+}): string;

package/dist/src/lib/bitcoin/wallet/abstractWallet.d.ts

@@ -0,0 +1,145 @@
+import { Network, payments, Transaction } from 'bitcoinjs-lib';
+import { BitcoinUTXO, IBitcoinProvider, Urgency } from '../provider/provider.interface';
+import { AddSignature, SigHashType } from '../sig';
+import { AtomicSwapConfig } from '../ASConfig';
+import { IHTLCWallet } from '../../htlc.interface';
+import { ScriptType } from '../script';
+import { BitcoinWalletConfig, IBitcoinWallet } from './wallet.interface';
+import { WalletChain } from './baseWallet';
+
+export declare abstract class AbstractBitcoinWallet implements IBitcoinWallet {
+    abstract getAddress(): Promise<string>;
+    abstract getBalance(): Promise<number>;
+    abstract sign(hexString: string): Promise<string>;
+    abstract getPublicKey(): Promise<string>;
+    abstract getNetwork(): Promise<Network>;
+    abstract getProvider(): Promise<IBitcoinProvider>;
+    abstract send(toAddress: string, amt: number, fee?: number): Promise<string>;
+    abstract spend(script: Buffer, scriptAddress: string, { toAddress, fee, nSequence, unlockScript, // only for p2sh
+    witness, }: {
+        toAddress?: string;
+        fee?: number;
+        nSequence?: number;
+        witness?: (Buffer | AddSignature)[];
+        unlockScript?: (payments.StackElement | AddSignature)[];
+    }): Promise<string>;
+    abstract walletConfig(): BitcoinWalletConfig;
+    abstract signSchnorr(buf: Buffer): Promise<Buffer>;
+    addSignatureSegwitV0(type?: SigHashType): AddSignature;
+    addSignatureP2sh(type?: SigHashType): AddSignature;
+    addSignatureSegwitV1(type?: SigHashType): AddSignature;
+    /**
+     * Returns the chain of the wallet. It can be Bitcoin or EVM
+     */
+    chain(): WalletChain;
+    /**
+     * Add all inputs to a transaction
+     * @param {Transaction} tx
+     * @param {string} address - The address whose UTXOs you want to include
+     * @param {IBitcoinProvider} provider
+     * @param {Object} opts - Optional
+     * @param {BitcoinUTXO[]} opts.utxos - List of UTXOs to include in the transaction. Optional. If not provide then the UTXOs belong to the specified address will be used
+     * @param {number} opts.nSequence - The sequence number. Optional
+     *
+     */
+    addAllInputs(tx: Transaction, address: string, provider: IBitcoinProvider, opts?: {
+        utxos?: BitcoinUTXO[];
+        nSequence?: number;
+    }): Promise<Transaction>;
+    /**
+     * Fee suggested by the provided
+     *
+     * @override
+     * @param {number} amount - in satoshis
+     * @param {Urgency} urgency - urgency of the fee
+     * @returns {Promise<number>}
+     *
+     */
+    suggestFee(amount: number, urgency: Urgency): Promise<number>;
+    /**
+     * Converts an address to its corresponding output script.
+     *
+     * @param {string} address - The address to convert.
+     * @return {Promise<Buffer>} The output script corresponding to the address.
+     *
+     */
+    toOutputScript(address: string): Promise<Buffer>;
+    /**
+     * Calculates the total value (balance) from an array of Bitcoin UTXOs.
+     *
+     * @param {BitcoinUTXO[]} utxos - The array of Bitcoin UTXOs.
+     * @return {number} The total value of the UTXOs.
+     *
+     */
+    totalValueFromUTXOs(utxos: BitcoinUTXO[]): number;
+    /**
+     * Converts a script to an p2wsh address.
+     *
+     * @param {Buffer} script - The script to convert.
+     * @return {Promise<string>} The generated address.
+     *
+     */
+    scriptToAddress(script: Buffer): Promise<string>;
+    /**
+     * Creates an HTLC wallet.
+     *
+     * @param {AtomicSwapConfig} swapConfig - The swap configuration for the HTLC wallet.
+     * @returns {Promise<IHTLCWallet>}
+     *
+     */
+    newSwap(swapConfig: AtomicSwapConfig): Promise<IHTLCWallet>;
+    /**
+     * Given a script address and network, returns the type of the script.
+     *
+     * @returns {ScriptType} The type of the script (P2SH, P2WSH, P2TR)
+     */
+    getScriptType(scriptAddress: string, network: Network): ScriptType;
+}
+type AtomicSwap = AtomicSwapConfig & {
+    redeemScript: Buffer;
+    scriptAddress: string;
+};
+export declare class BitcoinHTLC implements IHTLCWallet {
+    private readonly wallet;
+    private readonly swap;
+    /**
+     * @constructor
+     * @param {IBitcoinWallet} wallet
+     * @param {AtomicSwap} swap - Atomic swap config
+     *
+     */
+    constructor(wallet: IBitcoinWallet, swap: AtomicSwap);
+    /**
+     * Returns the script address
+     *
+     * @returns {string}
+     *
+     */
+    id(): string;
+    /**
+     * Initiate the HTLC by sending bitcoin to the HTLC script
+     *
+     * @returns {Promise<string>} Transaction ID
+     *
+     */
+    init(): Promise<string>;
+    /**
+     * Redeems the HTLC by spending all bitcoin from the given script.
+     *
+     * @param {string} secret - The secret for the atomic swap
+     * @param {string} [receiver] - The address of the receiver. If not provided then the wallet address is used as the receiver.
+     *
+     * @returns {Promise<string>} Transaction ID
+     *
+     */
+    redeem(secret: string, receiver?: string): Promise<string>;
+    /**
+     * Refunds the HTLC by spending all bitcoin from the given script.
+     *
+     * @param {string} [receiver] - The address of the receiver. If not provided then the wallet address is used as the receiver.
+     * @returns {Promise<string>} Transaction ID
+     *
+     */
+    refund(receiver?: string): Promise<string>;
+}
+export {};

package/dist/src/lib/bitcoin/wallet/baseWallet.d.ts

@@ -0,0 +1,13 @@
+import { IHTLCWallet } from '../../htlc.interface';
+import { AtomicSwapConfig } from '../ASConfig';
+
+export declare enum WalletChain {
+    Bitcoin = 0,
+    EVM = 1
+}
+export interface IBaseWallet {
+    chain(): WalletChain;
+    getAddress(): Promise<string>;
+    sign(hexMsg: string): Promise<string>;
+    newSwap(swapConfig: AtomicSwapConfig): Promise<IHTLCWallet>;
+}