@atomiqlabs/sdk 8.9.0 → 8.9.2

package/src/types/fees/Fee.ts

@@ -1,56 +1,56 @@
-import {PercentagePPM} from "./PercentagePPM";
-import {TokenAmount} from "../TokenAmount";
-import {Token} from "../Token";
-
-/**
- * Fee represented in both, source and destination tokens, as well as providing USD valuation helpers and
- *  fee composition
- *
- * @category Pricing
- */
-export type Fee<
-    ChainIdentifier extends string = string,
-    TSrc extends Token<ChainIdentifier> = Token<ChainIdentifier>,
-    TDst extends Token<ChainIdentifier> = Token<ChainIdentifier>
-> = {
-    /**
-     * Fee value equivalent in source token
-     */
-    amountInSrcToken: TokenAmount<TSrc, true>,
-    /**
-     * Fee value equivalent in destination token
-     */
-    amountInDstToken: TokenAmount<TDst, true>,
-    /**
-     * Fetches the current USD value of the fee
-     *
-     * @param abortSignal
-     * @param preFetchedUsdPrice You can supply a pre-fetched usd price to the pricing function
-     * @returns A promise resolving to the current USD value of the token amount
-     */
-    currentUsdValue: (abortSignal?: AbortSignal, preFetchedUsdPrice?: number) => Promise<number>,
-    /**
-     * Gets USD value of the fee, if the USD value when the swap was created is known (newer swaps) it returns this value,
-     *  otherwise fetches the usd value on-demand
-     *
-     * @param abortSignal
-     * @param preFetchedUsdPrice You can supply a pre-fetched usd price to the pricing function
-     * @returns A promise resolving to the current USD value of the fee
-     */
-    usdValue: (abortSignal?: AbortSignal, preFetchedUsdPrice?: number) => Promise<number>,
-    /**
-     * USD value of the fee when swap was created - only present for newer swaps where the USD value at create
-     *  time is known. Left for convenience only, use usdValue() instead, which automatically
-     *  recognizes which pricing to use (either past value if available or fetches it on-demand)
-     */
-    pastUsdValue?: number,
-    /**
-     * Returns the composition of the fee (base fee + percentage fee) if known, the total fee is calculated as:
-     *  base_fee + amount * percentage_fee
-     */
-    composition?: {
-        base: TokenAmount,
-        percentage: PercentagePPM
-    }
-}
-
+import {PercentagePPM} from "./PercentagePPM";
+import {TokenAmount} from "../TokenAmount";
+import {Token} from "../Token";
+
+/**
+ * Fee represented in both, source and destination tokens, as well as providing USD valuation helpers and
+ *  fee composition
+ *
+ * @category Pricing
+ */
+export type Fee<
+    ChainIdentifier extends string = string,
+    TSrc extends Token<ChainIdentifier> = Token<ChainIdentifier>,
+    TDst extends Token<ChainIdentifier> = Token<ChainIdentifier>
+> = {
+    /**
+     * Fee value equivalent in source token
+     */
+    amountInSrcToken: TokenAmount<TSrc, true>,
+    /**
+     * Fee value equivalent in destination token
+     */
+    amountInDstToken: TokenAmount<TDst, true>,
+    /**
+     * Fetches the current USD value of the fee
+     *
+     * @param abortSignal
+     * @param preFetchedUsdPrice You can supply a pre-fetched usd price to the pricing function
+     * @returns A promise resolving to the current USD value of the token amount
+     */
+    currentUsdValue: (abortSignal?: AbortSignal, preFetchedUsdPrice?: number) => Promise<number>,
+    /**
+     * Gets USD value of the fee, if the USD value when the swap was created is known (newer swaps) it returns this value,
+     *  otherwise fetches the usd value on-demand
+     *
+     * @param abortSignal
+     * @param preFetchedUsdPrice You can supply a pre-fetched usd price to the pricing function
+     * @returns A promise resolving to the current USD value of the fee
+     */
+    usdValue: (abortSignal?: AbortSignal, preFetchedUsdPrice?: number) => Promise<number>,
+    /**
+     * USD value of the fee when swap was created - only present for newer swaps where the USD value at create
+     *  time is known. Left for convenience only, use usdValue() instead, which automatically
+     *  recognizes which pricing to use (either past value if available or fetches it on-demand)
+     */
+    pastUsdValue?: number,
+    /**
+     * Returns the composition of the fee (base fee + percentage fee) if known, the total fee is calculated as:
+     *  base_fee + amount * percentage_fee
+     */
+    composition?: {
+        base: TokenAmount,
+        percentage: PercentagePPM
+    }
+}
+

package/src/types/fees/FeeBreakdown.ts

@@ -1,12 +1,12 @@
-import {FeeType} from "../../enums/FeeType";
-import {Fee} from "./Fee";
-
-/**
- * Breakdown of fees by type (swap fee, network fee, etc.)
- *
- * @category Pricing
- */
-export type FeeBreakdown<ChainIdentifier extends string = string> = {
-    type: FeeType,
-    fee: Fee<ChainIdentifier>
+import {FeeType} from "../../enums/FeeType";
+import {Fee} from "./Fee";
+
+/**
+ * Breakdown of fees by type (swap fee, network fee, etc.)
+ *
+ * @category Pricing
+ */
+export type FeeBreakdown<ChainIdentifier extends string = string> = {
+    type: FeeType,
+    fee: Fee<ChainIdentifier>
 }[];

package/src/types/fees/PercentagePPM.ts

@@ -1,26 +1,26 @@
-/**
- * Parts-per-million fee representation with conversion helpers
- *
- * @category Pricing
- */
-export type PercentagePPM = {
-    ppm: bigint,
-    decimal: number,
-    percentage: number,
-    toString: (decimal?: number) => string
-};
-
-/**
- * Converts parts-per-million to percentage representation
- *
- * @category Pricing
- */
-export function ppmToPercentage(ppm: bigint): PercentagePPM {
-    const percentage = Number(ppm) / 10_000;
-    return {
-        ppm,
-        decimal: Number(ppm) / 1_000_000,
-        percentage: percentage,
-        toString: (decimals?: number) => (decimals != null ? percentage.toFixed(decimals) : percentage) + "%"
-    }
-}
+/**
+ * Parts-per-million fee representation with conversion helpers
+ *
+ * @category Pricing
+ */
+export type PercentagePPM = {
+    ppm: bigint,
+    decimal: number,
+    percentage: number,
+    toString: (decimal?: number) => string
+};
+
+/**
+ * Converts parts-per-million to percentage representation
+ *
+ * @category Pricing
+ */
+export function ppmToPercentage(ppm: bigint): PercentagePPM {
+    const percentage = Number(ppm) / 10_000;
+    return {
+        ppm,
+        decimal: Number(ppm) / 1_000_000,
+        percentage: percentage,
+        toString: (decimals?: number) => (decimals != null ? percentage.toFixed(decimals) : percentage) + "%"
+    }
+}

package/src/types/lnurl/LNURLPay.ts

@@ -1,79 +1,79 @@
-/**
- * Response of the LNURL-pay link
- *
- * @category Lightning
- */
-export type LNURLPayParams = {
-    tag: "payRequest";
-    callback: string;
-    domain: string;
-    minSendable: number;
-    maxSendable: number;
-    metadata: string;
-    decodedMetadata: string[][];
-    commentAllowed: number;
-}
-
-/**
- * Response of the LNURL-pay link with the added original url
- *
- * @category Lightning
- */
-export type LNURLPayParamsWithUrl = LNURLPayParams & { url: string };
-
-/**
- * Parsed LNURL-pay specification
- *
- * @category Lightning
- */
-export type LNURLPay = {
-    type: "pay",
-    min: bigint,
-    max: bigint,
-    commentMaxLength: number,
-    shortDescription?: string,
-    longDescription?: string,
-    icon?: string,
-    params: LNURLPayParamsWithUrl
-}
-
-/**
- * Type guard for {@link LNURLPayParams}
- *
- * @category Lightning
- * @internal
- */
-export function isLNURLPayParams(obj: any): obj is LNURLPayParams {
-    return obj.tag === "payRequest";
-}
-
-/**
- * Type guard for {@link LNURLPay}
- *
- * @category Lightning
- */
-export function isLNURLPay(value: any): value is LNURLPay {
-    return (
-        typeof value === "object" &&
-        value != null &&
-        value.type === "pay" &&
-        typeof (value.min) === "bigint" &&
-        typeof (value.max) === "bigint" &&
-        typeof value.commentMaxLength === "number" &&
-        (value.shortDescription === undefined || typeof value.shortDescription === "string") &&
-        (value.longDescription === undefined || typeof value.longDescription === "string") &&
-        (value.icon === undefined || typeof value.icon === "string") &&
-        isLNURLPayParams(value.params)
-    );
-}
-
-/**
- * Decoded LNURL-pay success action, revealed after a lightning payment is finished
- *
- * @category Lightning
- */
-export type LNURLDecodedSuccessAction = {
-    description: string,
-    text?: string,
-    url?: string
-};
+/**
+ * Response of the LNURL-pay link
+ *
+ * @category Lightning
+ */
+export type LNURLPayParams = {
+    tag: "payRequest";
+    callback: string;
+    domain: string;
+    minSendable: number;
+    maxSendable: number;
+    metadata: string;
+    decodedMetadata: string[][];
+    commentAllowed: number;
+}
+
+/**
+ * Response of the LNURL-pay link with the added original url
+ *
+ * @category Lightning
+ */
+export type LNURLPayParamsWithUrl = LNURLPayParams & { url: string };
+
+/**
+ * Parsed LNURL-pay specification
+ *
+ * @category Lightning
+ */
+export type LNURLPay = {
+    type: "pay",
+    min: bigint,
+    max: bigint,
+    commentMaxLength: number,
+    shortDescription?: string,
+    longDescription?: string,
+    icon?: string,
+    params: LNURLPayParamsWithUrl
+}
+
+/**
+ * Type guard for {@link LNURLPayParams}
+ *
+ * @category Lightning
+ * @internal
+ */
+export function isLNURLPayParams(obj: any): obj is LNURLPayParams {
+    return obj.tag === "payRequest";
+}
+
+/**
+ * Type guard for {@link LNURLPay}
+ *
+ * @category Lightning
+ */
+export function isLNURLPay(value: any): value is LNURLPay {
+    return (
+        typeof value === "object" &&
+        value != null &&
+        value.type === "pay" &&
+        typeof (value.min) === "bigint" &&
+        typeof (value.max) === "bigint" &&
+        typeof value.commentMaxLength === "number" &&
+        (value.shortDescription === undefined || typeof value.shortDescription === "string") &&
+        (value.longDescription === undefined || typeof value.longDescription === "string") &&
+        (value.icon === undefined || typeof value.icon === "string") &&
+        isLNURLPayParams(value.params)
+    );
+}
+
+/**
+ * Decoded LNURL-pay success action, revealed after a lightning payment is finished
+ *
+ * @category Lightning
+ */
+export type LNURLDecodedSuccessAction = {
+    description: string,
+    text?: string,
+    url?: string
+};

package/src/types/lnurl/LNURLWithdraw.ts

@@ -1,61 +1,61 @@
-/**
- * Response of the LNURL-withdraw link
- *
- * @category Lightning
- */
-export type LNURLWithdrawParams = {
-    tag: "withdrawRequest";
-    k1: string;
-    callback: string;
-    domain: string;
-    minWithdrawable: number;
-    maxWithdrawable: number;
-    defaultDescription: string;
-    balanceCheck?: string;
-    payLink?: string;
-}
-
-/**
- * Response of the LNURL-withdraw link with the added original url
- *
- * @category Lightning
- */
-export type LNURLWithdrawParamsWithUrl = LNURLWithdrawParams & { url: string };
-
-/**
- * Parsed LNURL-withdraw specification
- *
- * @category Lightning
- */
-export type LNURLWithdraw = {
-    type: "withdraw",
-    min: bigint,
-    max: bigint,
-    params: LNURLWithdrawParamsWithUrl
-}
-
-/**
- * Type guard for {@link LNURLWithdraw}
- *
- * @category Lightning
- */
-export function isLNURLWithdraw(value: any): value is LNURLWithdraw {
-    return (
-        typeof value === "object" &&
-        value != null &&
-        value.type === "withdraw" &&
-        typeof (value.min) === "bigint" &&
-        typeof (value.max) === "bigint" &&
-        isLNURLWithdrawParams(value.params)
-    );
-}
-
-/**
- * Type guard for {@link LNURLWithdrawParams}
- *
- * @category Lightning
- * @internal
- */
-export function isLNURLWithdrawParams(obj: any): obj is LNURLWithdrawParams {
-    return obj.tag === "withdrawRequest";
-}
+/**
+ * Response of the LNURL-withdraw link
+ *
+ * @category Lightning
+ */
+export type LNURLWithdrawParams = {
+    tag: "withdrawRequest";
+    k1: string;
+    callback: string;
+    domain: string;
+    minWithdrawable: number;
+    maxWithdrawable: number;
+    defaultDescription: string;
+    balanceCheck?: string;
+    payLink?: string;
+}
+
+/**
+ * Response of the LNURL-withdraw link with the added original url
+ *
+ * @category Lightning
+ */
+export type LNURLWithdrawParamsWithUrl = LNURLWithdrawParams & { url: string };
+
+/**
+ * Parsed LNURL-withdraw specification
+ *
+ * @category Lightning
+ */
+export type LNURLWithdraw = {
+    type: "withdraw",
+    min: bigint,
+    max: bigint,
+    params: LNURLWithdrawParamsWithUrl
+}
+
+/**
+ * Type guard for {@link LNURLWithdraw}
+ *
+ * @category Lightning
+ */
+export function isLNURLWithdraw(value: any): value is LNURLWithdraw {
+    return (
+        typeof value === "object" &&
+        value != null &&
+        value.type === "withdraw" &&
+        typeof (value.min) === "bigint" &&
+        typeof (value.max) === "bigint" &&
+        isLNURLWithdrawParams(value.params)
+    );
+}
+
+/**
+ * Type guard for {@link LNURLWithdrawParams}
+ *
+ * @category Lightning
+ * @internal
+ */
+export function isLNURLWithdrawParams(obj: any): obj is LNURLWithdrawParams {
+    return obj.tag === "withdrawRequest";
+}

package/src/types/wallets/LightningInvoiceCreateService.ts

@@ -1,30 +1,30 @@
-/**
- * Invoice getter callback for the {@link LightningInvoiceCreateService}
- *
- * @category Lightning
- */
-export type LightningWalletCallback = (valueSats: number, abortSignal?: AbortSignal) => Promise<string>;
-/**
- * Service that creates on-demand fixed amount bolt11 lightning network invoices, optionally
- *  specifying minimum and maximum swappable sats amount. This used for exact input Smart chain ->
- *  Lightning swaps.
- *
- * @category Lightning
- */
-export type LightningInvoiceCreateService = {
-    getInvoice: LightningWalletCallback,
-    minMsats?: bigint,
-    maxMSats?: bigint
-};
-
-/**
- * Type guard for {@link LightningInvoiceCreateService}
- *
- * @internal
- */
-export function isLightningInvoiceCreateService(obj: any): obj is LightningInvoiceCreateService {
-    return typeof (obj) === "object" &&
-        typeof (obj.getInvoice) === "function" &&
-        (obj.minMsats == null || typeof (obj.minMsats) === "bigint") &&
-        (obj.maxMSats == null || typeof (obj.maxMSats) === "bigint");
-}
+/**
+ * Invoice getter callback for the {@link LightningInvoiceCreateService}
+ *
+ * @category Lightning
+ */
+export type LightningWalletCallback = (valueSats: number, abortSignal?: AbortSignal) => Promise<string>;
+/**
+ * Service that creates on-demand fixed amount bolt11 lightning network invoices, optionally
+ *  specifying minimum and maximum swappable sats amount. This used for exact input Smart chain ->
+ *  Lightning swaps.
+ *
+ * @category Lightning
+ */
+export type LightningInvoiceCreateService = {
+    getInvoice: LightningWalletCallback,
+    minMsats?: bigint,
+    maxMSats?: bigint
+};
+
+/**
+ * Type guard for {@link LightningInvoiceCreateService}
+ *
+ * @internal
+ */
+export function isLightningInvoiceCreateService(obj: any): obj is LightningInvoiceCreateService {
+    return typeof (obj) === "object" &&
+        typeof (obj.getInvoice) === "function" &&
+        (obj.minMsats == null || typeof (obj.minMsats) === "bigint") &&
+        (obj.maxMSats == null || typeof (obj.maxMSats) === "bigint");
+}

package/src/types/wallets/MinimalBitcoinWalletInterface.ts

@@ -1,21 +1,21 @@
-import {Transaction} from "@scure/btc-signer";
-
-/**
- * A type with minimum possible required data about a bitcoin wallet to be able to estimate fees and produce unsigned
- *  funded PSBTs with address's UTXOs
- *
- * @category Bitcoin
- */
-export type MinimalBitcoinWalletInterface = {
-    address: string,
-    publicKey: string
-};
-
-/**
- * A type with minimum possible required data about a bitcoin wallet to be able to estimate fees and sign PSBTs
- *
- * @category Bitcoin
- */
-export type MinimalBitcoinWalletInterfaceWithSigner = MinimalBitcoinWalletInterface & {
-    signPsbt: (psbtToSign: {psbt: Transaction, psbtHex: string, psbtBase64: string}, signInputs: number[]) => Promise<Transaction | string>
-};
+import {Transaction} from "@scure/btc-signer";
+
+/**
+ * A type with minimum possible required data about a bitcoin wallet to be able to estimate fees and produce unsigned
+ *  funded PSBTs with address's UTXOs
+ *
+ * @category Bitcoin
+ */
+export type MinimalBitcoinWalletInterface = {
+    address: string,
+    publicKey: string
+};
+
+/**
+ * A type with minimum possible required data about a bitcoin wallet to be able to estimate fees and sign PSBTs
+ *
+ * @category Bitcoin
+ */
+export type MinimalBitcoinWalletInterfaceWithSigner = MinimalBitcoinWalletInterface & {
+    signPsbt: (psbtToSign: {psbt: Transaction, psbtHex: string, psbtBase64: string}, signInputs: number[]) => Promise<Transaction | string>
+};

package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts

@@ -1,9 +1,9 @@
-/**
- * A type with minimum possible required functionality to be usable with lightning network swaps, i.e.
- *  a function to pay bolt11 lightning network invoices.
- *
- * @category Lightning
- */
-export type MinimalLightningNetworkWalletInterface = {
-    payInvoice: (bolt11PaymentRequest: string) => Promise<string>
-}
+/**
+ * A type with minimum possible required functionality to be usable with lightning network swaps, i.e.
+ *  a function to pay bolt11 lightning network invoices.
+ *
+ * @category Lightning
+ */
+export type MinimalLightningNetworkWalletInterface = {
+    payInvoice: (bolt11PaymentRequest: string) => Promise<string>
+}