@atomiqlabs/sdk 8.3.1 → 8.3.6

package/src/types/PriceInfoType.ts

@@ -2,7 +2,7 @@ import {toBigInt} from "../utils/Utils";
 
 /**
  * Pricing information for swap validation
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type PriceInfoType = {
     isValid: boolean,
@@ -16,7 +16,7 @@ export type PriceInfoType = {
 
 /**
  * Type guard for PriceInfoType
- * @category Pricing and LPs
+ * @category Pricing
  */
 export function isPriceInfoType(obj: any): obj is PriceInfoType {
     return obj != null &&
@@ -31,7 +31,7 @@ export function isPriceInfoType(obj: any): obj is PriceInfoType {
 
 /**
  * Serializes PriceInfoType for storage
- * @category Pricing and LPs
+ * @category Pricing
  */
 export function serializePriceInfoType(obj: PriceInfoType | undefined): any {
     if (obj == null) return null;
@@ -48,7 +48,7 @@ export function serializePriceInfoType(obj: PriceInfoType | undefined): any {
 
 /**
  * Deserializes PriceInfoType from storage
- * @category Pricing and LPs
+ * @category Pricing
  */
 export function deserializePriceInfoType(obj: any): PriceInfoType | undefined {
     if (obj == null) return;

package/src/types/SwapExecutionAction.ts

@@ -4,7 +4,7 @@ import {Transaction} from "@scure/btc-signer";
 /**
  * Swap execution action requiring a payment of the provided bolt11 lightning network invoice
  *
- * @category Swaps
+ * @category Swap Actions
  */
 export type SwapExecutionActionLightning = {
     name: "Payment",
@@ -24,7 +24,7 @@ export type SwapExecutionActionLightning = {
  * - `"RAW_PSBT"` - Raw PSBT without the inputs, the implementor needs to add the input UTXOs before signing
  *  the transaction
  *
- * @category Swaps
+ * @category Swap Actions
  */
 export type SwapExecutionActionBitcoin<
     T extends "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT" = "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT"
@@ -55,7 +55,7 @@ export type SwapExecutionActionBitcoin<
 /**
  * Swap execution action for committing (initiating) the escrow on the smart chain side
  *
- * @category Swaps
+ * @category Swap Actions
  */
 export type SwapExecutionActionCommit<T extends ChainType> = {
     name: "Commit",
@@ -67,7 +67,7 @@ export type SwapExecutionActionCommit<T extends ChainType> = {
 /**
  * Swap execution action for claiming (settling) the swap on the smart chain side
  *
- * @category Swaps
+ * @category Swap Actions
  */
 export type SwapExecutionActionClaim<T extends ChainType> = {
     name: "Claim",
@@ -76,12 +76,25 @@ export type SwapExecutionActionClaim<T extends ChainType> = {
     txs: T["TX"][]
 }
 
+/**
+ * Swap execution action for refunding the swap on the smart chain side after it fails
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionRefund<T extends ChainType> = {
+    name: "Refund",
+    description: string,
+    chain: T["ChainId"],
+    txs: T["TX"][]
+}
+
 /**
  * Swap execution action, a single step in the swapping process
  *
- * @category Swaps
+ * @category Swap Actions
  */
 export type SwapExecutionAction<T extends ChainType> = SwapExecutionActionLightning |
     SwapExecutionActionBitcoin |
     SwapExecutionActionCommit<T> |
-    SwapExecutionActionClaim<T>;
+    SwapExecutionActionClaim<T> |
+    SwapExecutionActionRefund<T>;

package/src/types/SwapWithSigner.ts

@@ -9,7 +9,7 @@ import {SpvFromBTCSwap} from "../swaps/spv_swaps/SpvFromBTCSwap";
 /**
  * Proxy type that auto-injects a smart chain signer into swap methods
  *
- * @category Swaps
+ * @category Swaps/Base
  */
 export type SwapWithSigner<T extends ISwap> = {
     [K in keyof T]:

package/src/types/fees/Fee.ts

@@ -6,7 +6,7 @@ import {Token} from "../Token";
  * Fee represented in both, source and destination tokens, as well as providing USD valuation helpers and
  *  fee composition
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type Fee<
     ChainIdentifier extends string = string,

package/src/types/fees/FeeBreakdown.ts

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

package/src/types/fees/PercentagePPM.ts

@@ -1,7 +1,7 @@
 /**
  * Parts-per-million fee representation with conversion helpers
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export type PercentagePPM = {
     ppm: bigint,
@@ -13,7 +13,7 @@ export type PercentagePPM = {
 /**
  * Converts parts-per-million to percentage representation
  *
- * @category Pricing and LPs
+ * @category Pricing
  */
 export function ppmToPercentage(ppm: bigint): PercentagePPM {
     const percentage = Number(ppm) / 10_000;

package/src/types/lnurl/LNURLPay.ts

@@ -1,7 +1,7 @@
 /**
  * Response of the LNURL-pay link
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLPayParams = {
     tag: "payRequest";
@@ -17,14 +17,14 @@ export type LNURLPayParams = {
 /**
  * Response of the LNURL-pay link with the added original url
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLPayParamsWithUrl = LNURLPayParams & { url: string };
 
 /**
  * Parsed LNURL-pay specification
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLPay = {
     type: "pay",
@@ -40,7 +40,7 @@ export type LNURLPay = {
 /**
  * Type guard for {@link LNURLPayParams}
  *
- * @category Bitcoin
+ * @category Lightning
  * @internal
  */
 export function isLNURLPayParams(obj: any): obj is LNURLPayParams {
@@ -50,7 +50,7 @@ export function isLNURLPayParams(obj: any): obj is LNURLPayParams {
 /**
  * Type guard for {@link LNURLPay}
  *
- * @category Bitcoin
+ * @category Lightning
  * @internal
  */
 export function isLNURLPay(value: any): value is LNURLPay {
@@ -71,7 +71,7 @@ export function isLNURLPay(value: any): value is LNURLPay {
 /**
  * Decoded LNURL-pay success action, revealed after a lightning payment is finished
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLDecodedSuccessAction = {
     description: string,

package/src/types/lnurl/LNURLWithdraw.ts

@@ -1,7 +1,7 @@
 /**
  * Response of the LNURL-withdraw link
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLWithdrawParams = {
     tag: "withdrawRequest";
@@ -18,14 +18,14 @@ export type LNURLWithdrawParams = {
 /**
  * Response of the LNURL-withdraw link with the added original url
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLWithdrawParamsWithUrl = LNURLWithdrawParams & { url: string };
 
 /**
  * Parsed LNURL-withdraw specification
  *
- * @category Bitcoin
+ * @category Lightning
  */
 export type LNURLWithdraw = {
     type: "withdraw",
@@ -37,7 +37,7 @@ export type LNURLWithdraw = {
 /**
  * Type guard for {@link LNURLWithdraw}
  *
- * @category Bitcoin
+ * @category Lightning
  * @internal
  */
 export function isLNURLWithdraw(value: any): value is LNURLWithdraw {
@@ -54,7 +54,7 @@ export function isLNURLWithdraw(value: any): value is LNURLWithdraw {
 /**
  * Type guard for {@link LNURLWithdrawParams}
  *
- * @category Bitcoin
+ * @category Lightning
  * @internal
  */
 export function isLNURLWithdrawParams(obj: any): obj is LNURLWithdrawParams {

package/src/types/wallets/LightningInvoiceCreateService.ts

@@ -1,11 +1,15 @@
 /**
  * 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,

package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts

@@ -2,7 +2,7 @@
  * 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 Bitcoin
+ * @category Lightning
  */
 export type MinimalLightningNetworkWalletInterface = {
     payInvoice: (bolt11PaymentRequest: string) => Promise<string>

package/src/utils/SwapUtils.ts

@@ -49,6 +49,8 @@ export function isSwapType<T extends ChainType, S extends SwapType>(swap: ISwap<
  *  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]: {