@atomiqlabs/sdk 8.1.8 → 8.3.5

package/src/utils/SwapUtils.ts

@@ -12,7 +12,10 @@ import {LnForGasSwap} from "../swaps/trusted/ln/LnForGasSwap";
 import {ISwap} from "../swaps/ISwap";
 
 /**
- * Type mapping from SwapType enum to specific swap class implementations
+ * Type mapping from SwapType enum to specific swap class implementations, it is important
+ *  to pass the chain type generic, since different chains support different swap protocols
+ *  for some directions.
+ *
  * @category Utilities
  */
 export type SwapTypeMapping<T extends ChainType> = {
@@ -28,6 +31,7 @@ export type SwapTypeMapping<T extends ChainType> = {
 
 /**
  * Type guard to check if a swap is of a specific swap type
+ *
  * @category Utilities
  */
 export function isSwapType<T extends ChainType, S extends SwapType>(swap: ISwap<T>, swapType: S): swap is SwapTypeMapping<T>[S] {
@@ -36,3 +40,61 @@ export function isSwapType<T extends ChainType, S extends SwapType>(swap: ISwap<
     if(swap.getType()===SwapType.FROM_BTCLN_AUTO && swapType===SwapType.FROM_BTCLN) return true;
     return swap.getType()===swapType;
 }
+
+/**
+ * Helper information about various swap protocol and their features:
+ * - `requiresInputWallet`: Whether a swap requires a connected wallet on the input chain able to sign
+ *  arbitrary transaction
+ * - `requiresOutputWallet`: Whether a swap requires a connected wallet on the output chain able to sign
+ *  arbitrary transactions
+ * - `supportsGasDrop`: Whether a swap supports the "gas drop" feature, allowing to user to receive a small
+ *  amount of native token as part of the swap when swapping to smart chains
+ *
+ * @category Core
+ */
+export const SwapProtocolInfo = {
+    [SwapType.TO_BTC]: {
+        requiresInputWallet: true,
+        requiresOutputWallet: false,
+        supportsGasDrop: false
+    },
+    [SwapType.TO_BTCLN]: {
+        requiresInputWallet: true,
+        requiresOutputWallet: false,
+        supportsGasDrop: false
+    },
+    [SwapType.FROM_BTC]: {
+        requiresInputWallet: false,
+        requiresOutputWallet: true,
+        supportsGasDrop: false
+    },
+    [SwapType.FROM_BTCLN]: {
+        requiresInputWallet: false,
+        requiresOutputWallet: true,
+        supportsGasDrop: false
+    },
+    [SwapType.SPV_VAULT_FROM_BTC]: {
+        requiresInputWallet: true,
+        requiresOutputWallet: false,
+        supportsGasDrop: true
+    },
+    [SwapType.FROM_BTCLN_AUTO]: {
+        requiresInputWallet: false,
+        requiresOutputWallet: false,
+        supportsGasDrop: true
+    },
+    [SwapType.TRUSTED_FROM_BTC]: {
+        requiresInputWallet: false,
+        requiresOutputWallet: false,
+        supportsGasDrop: false
+    },
+    [SwapType.TRUSTED_FROM_BTCLN]: {
+        requiresInputWallet: false,
+        requiresOutputWallet: false,
+        supportsGasDrop: false
+    }
+} as const satisfies Record<SwapType, {
+    requiresInputWallet: boolean,
+    requiresOutputWallet: boolean,
+    supportsGasDrop: boolean
+}>;

package/src/utils/TokenUtils.ts

@@ -4,21 +4,29 @@ import {fromDecimal, toDecimal} from "./Utils";
 
 /**
  * Converts a raw bigint amount to a human-readable string with decimals
+ *
+ * @param amount Amount in base units
+ * @param token Token
+ *
  * @category Utilities
  */
-export function toHumanReadableString(amount: bigint, currencySpec: Token): string {
+export function toHumanReadableString(amount: bigint, token: Token): string {
     if(amount==null) return "";
-    return toDecimal(amount, currencySpec.decimals, undefined, currencySpec.displayDecimals);
+    return toDecimal(amount, token.decimals, undefined, token.displayDecimals);
 }
 
 /**
  * Parses a human-readable decimal string to a raw bigint amount
+ *
+ * @param amount Amount in base units
+ * @param token Token
+ *
  * @category Utilities
  */
-export function fromHumanReadableString(amount: string, currencySpec: Token): bigint | null {
+export function fromHumanReadableString(amount: string, token: Token): bigint | null {
     if(amount==="" || amount==null) return null;
     try {
-        return fromDecimal(amount, currencySpec.decimals);
+        return fromDecimal(amount, token.decimals);
     } catch (e) {
         return null;
     }

package/dist/bitcoin/BitcoinRpcWithAddressIndex.d.ts

@@ -1,68 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { BitcoinRpc, BtcBlock, BtcTx } from "@atomiqlabs/base";
-import { Buffer } from "buffer";
-export type BtcTxWithBlockheight = BtcTx & {
-    blockheight?: number;
-    inputAddresses?: string[];
-};
-export type BtcAddressUtxo = {
-    txid: string;
-    vout: number;
-    confirmed: boolean;
-    block_height: number;
-    block_hash: string;
-    block_time: number;
-    value: bigint;
-};
-export interface BitcoinRpcWithAddressIndex<T extends BtcBlock> extends BitcoinRpc<T> {
-    getFeeRate(): Promise<number>;
-    getAddressBalances(address: string): Promise<{
-        confirmedBalance: bigint;
-        unconfirmedBalance: bigint;
-    }>;
-    getAddressUTXOs(address: string): Promise<BtcAddressUtxo[]>;
-    getCPFPData(txId: string): Promise<{
-        effectiveFeePerVsize: number;
-        adjustedVsize: number;
-    }>;
-    getTransaction(txId: string): Promise<BtcTxWithBlockheight | null>;
-    waitForTransaction(txId: string, requiredConfirmations: number, stateUpdateCbk: (btcTx?: BtcTxWithBlockheight, txEtaMS?: number) => void, abortSignal?: AbortSignal, intervalSeconds?: number): Promise<BtcTxWithBlockheight>;
-    /**
-     * Returns an estimate after which time the tx will confirm with the required amount of confirmations,
-     *  confirmationDelay of -1 means the transaction won't confirm in the near future
-     *
-     * @param tx
-     * @param requiredConfirmations
-     * @private
-     *
-     * @returns estimated confirmation delay, -1 if the transaction won't confirm in the near future, null if the
-     *  transaction was replaced or was confirmed in the meantime
-     */
-    getConfirmationDelay(tx: BtcTx, requiredConfirmations: number): Promise<number | null>;
-    /**
-     * Checks if an address received the transaction with the required txoHash, returns info about that
-     *  specific transaction if found, or null if not found
-     *
-     * @param address Address that should receive the transaction
-     * @param txoHash Required output txoHash
-     */
-    checkAddressTxos(address: string, txoHash: Buffer): Promise<{
-        tx: Omit<BtcTxWithBlockheight, "hex" | "raw">;
-        vout: number;
-    } | null>;
-    /**
-     * Waits till the address receives a transaction containing a specific txoHash
-     *
-     * @param address Address that should receive the transaction
-     * @param txoHash Required output txoHash
-     * @param requiredConfirmations Required confirmations of the transaction
-     * @param stateUpdateCbk Callback for transaction state updates
-     * @param abortSignal Abort signal
-     * @param intervalSeconds How often to check new transaction
-     */
-    waitForAddressTxo(address: string, txoHash: Buffer, requiredConfirmations: number, stateUpdateCbk: (btcTx?: Omit<BtcTxWithBlockheight, "hex" | "raw">, vout?: number, txEtaMS?: number) => void, abortSignal?: AbortSignal, intervalSeconds?: number): Promise<{
-        tx: Omit<BtcTxWithBlockheight, "hex" | "raw">;
-        vout: number;
-    }>;
-}

package/dist/bitcoin/BitcoinRpcWithAddressIndex.js

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

package/dist/bitcoin/LightningNetworkApi.d.ts

@@ -1,12 +0,0 @@
-export type LNNodeLiquidity = {
-    publicKey: string;
-    capacity: bigint;
-    numChannels: number;
-};
-export interface LightningNetworkApi {
-    /**
-     * Returns the lightning network's node liquidity as identified by an identity public key
-     * @param pubkey
-     */
-    getLNNodeLiquidity(pubkey: string): Promise<LNNodeLiquidity | null>;
-}

package/dist/bitcoin/LightningNetworkApi.js

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

package/dist/bitcoin/mempool/MempoolApi.d.ts

@@ -1,350 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Buffer } from "buffer";
-/**
- * Bitcoin transaction confirmation status
- * @category Bitcoin
- */
-export type BitcoinTransactionStatus = {
-    confirmed: boolean;
-    block_height: number;
-    block_hash: string;
-    block_time: number;
-};
-/**
- * Bitcoin transaction output
- * @category Bitcoin
- */
-export type TxVout = {
-    scriptpubkey: string;
-    scriptpubkey_asm: string;
-    scriptpubkey_type: string;
-    scriptpubkey_address: string;
-    value: number;
-};
-/**
- * Bitcoin transaction input
- * @category Bitcoin
- */
-export type TxVin = {
-    txid: string;
-    vout: number;
-    prevout: TxVout;
-    scriptsig: string;
-    scriptsig_asm: string;
-    witness: string[];
-    is_coinbase: boolean;
-    sequence: number;
-    inner_witnessscript_asm: string;
-};
-/**
- * Full Bitcoin transaction data
- * @category Bitcoin
- */
-export type BitcoinTransaction = {
-    txid: string;
-    version: number;
-    locktime: number;
-    vin: TxVin[];
-    vout: TxVout[];
-    size: number;
-    weight: number;
-    fee: number;
-    status: BitcoinTransactionStatus;
-};
-/**
- * Bitcoin block data
- * @category Bitcoin
- */
-export type BlockData = {
-    bits: number;
-    difficulty: number;
-    extras: any;
-    height: number;
-    id: string;
-    mediantime: number;
-    merkle_root: string;
-    nonce: number;
-    previousblockhash: string;
-    size: number;
-    timestamp: number;
-    tx_count: number;
-    version: number;
-    weight: number;
-};
-/**
- * Bitcoin block header data
- * @category Bitcoin
- */
-export type BitcoinBlockHeader = {
-    id: string;
-    height: number;
-    version: number;
-    timestamp: number;
-    tx_count: number;
-    size: number;
-    weight: number;
-    merkle_root: string;
-    previousblockhash: string;
-    mediantime: number;
-    nonce: number;
-    bits: number;
-    difficulty: number;
-};
-export type LNNodeInfo = {
-    public_key: string;
-    alias: string;
-    first_seen: number;
-    updated_at: number;
-    color: string;
-    sockets: string;
-    as_number: number;
-    city_id: number;
-    country_id: number;
-    subdivision_id: number;
-    longtitude: number;
-    latitude: number;
-    iso_code: string;
-    as_organization: string;
-    city: {
-        [lang: string]: string;
-    };
-    country: {
-        [lang: string]: string;
-    };
-    subdivision: {
-        [lang: string]: string;
-    };
-    active_channel_count: number;
-    capacity: string;
-    opened_channel_count: number;
-    closed_channel_count: number;
-};
-export type AddressInfo = {
-    address: string;
-    chain_stats: {
-        funded_txo_count: number;
-        funded_txo_sum: number;
-        spent_txo_count: number;
-        spent_txo_sum: number;
-        tx_count: number;
-    };
-    mempool_stats: {
-        funded_txo_count: number;
-        funded_txo_sum: number;
-        spent_txo_count: number;
-        spent_txo_sum: number;
-        tx_count: number;
-    };
-};
-export type TransactionCPFPData = {
-    ancestors: {
-        txid: string;
-        fee: number;
-        weight: number;
-    }[];
-    descendants: {
-        txid: string;
-        fee: number;
-        weight: number;
-    }[];
-    effectiveFeePerVsize: number;
-    sigops: number;
-    adjustedVsize: number;
-};
-export type BitcoinFees = {
-    fastestFee: number;
-    halfHourFee: number;
-    hourFee: number;
-    economyFee: number;
-    minimumFee: number;
-};
-export type BitcoinPendingBlock = {
-    blockSize: number;
-    blockVSize: number;
-    nTx: number;
-    totalFees: number;
-    medianFee: number;
-    feeRange: number[];
-};
-export type BlockStatus = {
-    in_best_chain: boolean;
-    height: number;
-    next_best: string;
-};
-export type TransactionProof = {
-    block_height: number;
-    merkle: string[];
-    pos: number;
-};
-export type TransactionOutspend = {
-    spent: boolean;
-    txid: string;
-    vin: number;
-    status: BitcoinTransactionStatus;
-};
-/**
- * Mempool.space REST API client for Bitcoin blockchain data
- * @category Bitcoin
- */
-export declare class MempoolApi {
-    backends: {
-        url: string;
-        operational: boolean | null;
-    }[];
-    timeout: number;
-    /**
-     * Returns api url that should be operational
-     *
-     * @private
-     */
-    private getOperationalApi;
-    /**
-     * Returns api urls that are maybe operational, in case none is considered operational returns all of the price
-     *  apis such that they can be tested again whether they are operational
-     *
-     * @private
-     */
-    private getMaybeOperationalApis;
-    /**
-     * Sends a GET or POST request to the mempool api, handling the non-200 responses as errors & throwing
-     *
-     * @param url
-     * @param path
-     * @param responseType
-     * @param type
-     * @param body
-     */
-    private _request;
-    /**
-     * Sends request in parallel to multiple maybe operational api urls
-     *
-     * @param path
-     * @param responseType
-     * @param type
-     * @param body
-     * @private
-     */
-    private requestFromMaybeOperationalUrls;
-    /**
-     * Sends a request to mempool API, first tries to use the operational API (if any) and if that fails it falls back
-     *  to using maybe operational price APIs
-     *
-     * @param path
-     * @param responseType
-     * @param type
-     * @param body
-     * @private
-     */
-    private request;
-    constructor(url?: string | string[], timeout?: number);
-    /**
-     * Returns information about a specific lightning network node as identified by the public key (in hex encoding)
-     *
-     * @param pubkey
-     */
-    getLNNodeInfo(pubkey: string): Promise<LNNodeInfo | null>;
-    /**
-     * Returns on-chain transaction as identified by its txId
-     *
-     * @param txId
-     */
-    getTransaction(txId: string): Promise<BitcoinTransaction | null>;
-    /**
-     * Returns raw binary encoded bitcoin transaction, also strips the witness data from the transaction
-     *
-     * @param txId
-     */
-    getRawTransaction(txId: string): Promise<Buffer | null>;
-    /**
-     * Returns confirmed & unconfirmed balance of the specific bitcoin address
-     *
-     * @param address
-     */
-    getAddressBalances(address: string): Promise<{
-        confirmedBalance: bigint;
-        unconfirmedBalance: bigint;
-    }>;
-    /**
-     * Returns CPFP (children pays for parent) data for a given transaction
-     *
-     * @param txId
-     */
-    getCPFPData(txId: string): Promise<TransactionCPFPData>;
-    /**
-     * Returns UTXOs (unspent transaction outputs) for a given address
-     *
-     * @param address
-     */
-    getAddressUTXOs(address: string): Promise<{
-        txid: string;
-        vout: number;
-        status: {
-            confirmed: boolean;
-            block_height: number;
-            block_hash: string;
-            block_time: number;
-        };
-        value: bigint;
-    }[]>;
-    /**
-     * Returns current on-chain bitcoin fees
-     */
-    getFees(): Promise<BitcoinFees>;
-    /**
-     * Returns all transactions for a given address
-     *
-     * @param address
-     */
-    getAddressTransactions(address: string): Promise<BitcoinTransaction[]>;
-    /**
-     * Returns expected pending (mempool) blocks
-     */
-    getPendingBlocks(): Promise<BitcoinPendingBlock[]>;
-    /**
-     * Returns the blockheight of the current bitcoin blockchain's tip
-     */
-    getTipBlockHeight(): Promise<number>;
-    /**
-     * Returns the bitcoin blockheader as identified by its blockhash
-     *
-     * @param blockhash
-     */
-    getBlockHeader(blockhash: string): Promise<BitcoinBlockHeader>;
-    /**
-     * Returns the block status
-     *
-     * @param blockhash
-     */
-    getBlockStatus(blockhash: string): Promise<BlockStatus>;
-    /**
-     * Returns the transaction's proof (merkle proof)
-     *
-     * @param txId
-     */
-    getTransactionProof(txId: string): Promise<TransactionProof>;
-    /**
-     * Returns the transaction's proof (merkle proof)
-     *
-     * @param txId
-     */
-    getOutspends(txId: string): Promise<TransactionOutspend[]>;
-    /**
-     * Returns blockhash of a block at a specific blockheight
-     *
-     * @param height
-     */
-    getBlockHash(height: number): Promise<string>;
-    /**
-     * Returns past 15 blockheaders before (and including) the specified height
-     *
-     * @param endHeight
-     */
-    getPast15BlockHeaders(endHeight: number): Promise<BlockData[]>;
-    /**
-     * Sends raw hex encoded bitcoin transaction
-     *
-     * @param transactionHex
-     */
-    sendTransaction(transactionHex: string): Promise<string>;
-}