@atomiqlabs/sdk 8.9.1 → 8.9.2

package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts

@@ -1,133 +1,133 @@
-import {ISwapWrapper, ISwapWrapperOptions, SwapTypeDefinition, WrapperCtorTokens} from "../../ISwapWrapper";
-import {IntermediaryError} from "../../../errors/IntermediaryError";
-import {BitcoinRpcWithAddressIndex, ChainType} from "@atomiqlabs/base";
-import {OnchainForGasSwap, OnchainForGasSwapInit, OnchainForGasSwapState} from "./OnchainForGasSwap";
-import {ISwapPrice} from "../../../prices/abstract/ISwapPrice";
-import {EventEmitter} from "events";
-import {Intermediary} from "../../../intermediaries/Intermediary";
-import {SwapType} from "../../../enums/SwapType";
-import {UnifiedSwapEventListener} from "../../../events/UnifiedSwapEventListener";
-import {UnifiedSwapStorage} from "../../../storage/UnifiedSwapStorage";
-import {ISwap} from "../../ISwap";
-import {BTC_NETWORK} from "@scure/btc-signer/utils";
-import {IntermediaryAPI} from "../../../intermediaries/apis/IntermediaryAPI";
-
-export type OnchainForGasWrapperOptions = ISwapWrapperOptions & {
-    bitcoinNetwork: BTC_NETWORK
-};
-
-export type OnchainForGasSwapTypeDefinition<T extends ChainType> = SwapTypeDefinition<T, OnchainForGasWrapper<T>, OnchainForGasSwap<T>>;
-
-/**
- * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
- *  destination chain, which is only needed for Solana, which still uses legacy swaps
- *
- * @category Swaps/Trusted Gas Swaps
- */
-export class OnchainForGasWrapper<T extends ChainType> extends ISwapWrapper<T, OnchainForGasSwapTypeDefinition<T>, OnchainForGasWrapperOptions> {
-    public readonly TYPE: SwapType.TRUSTED_FROM_BTC = SwapType.TRUSTED_FROM_BTC;
-    /**
-     * @internal
-     */
-    readonly _swapDeserializer = OnchainForGasSwap;
-
-    /**
-     * @internal
-     */
-    readonly _pendingSwapStates = [OnchainForGasSwapState.PR_CREATED];
-    /**
-     * @internal
-     */
-    protected readonly tickSwapState = undefined;
-    /**
-     * @internal
-     */
-    protected processEvent = undefined;
-
-    /**
-     * @internal
-     */
-    readonly _btcRpc: BitcoinRpcWithAddressIndex<any>;
-
-    /**
-     * @param chainIdentifier
-     * @param unifiedStorage Storage interface for the current environment
-     * @param unifiedChainEvents On-chain event listener
-     * @param chain
-     * @param prices Pricing to use
-     * @param tokens
-     * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
-     * @param lpApi
-     * @param options
-     * @param events Instance to use for emitting events
-     */
-    constructor(
-        chainIdentifier: string,
-        unifiedStorage: UnifiedSwapStorage<T>,
-        unifiedChainEvents: UnifiedSwapEventListener<T>,
-        chain: T["ChainInterface"],
-        prices: ISwapPrice,
-        tokens: WrapperCtorTokens,
-        btcRpc: BitcoinRpcWithAddressIndex<any>,
-        lpApi: IntermediaryAPI,
-        options: OnchainForGasWrapperOptions,
-        events?: EventEmitter<{swapState: [ISwap]}>
-    ) {
-        super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, lpApi, options, events);
-        this._btcRpc = btcRpc;
-    }
-
-    /**
-     * Returns a newly created trusted Bitcoin on-chain -> Smart chain swap, receiving
-     *  the specified amount of native token on the destination chain.
-     *
-     * @param recipient Address of the recipient on the smart chain destination chain
-     * @param amount Amount of native token to receive in base units
-     * @param lpOrUrl Intermediary (LP) to use for the swap
-     * @param refundAddress Bitcoin address to receive refund on in case the intermediary (LP) cannot execute the swap
-     */
-    async create(recipient: string, amount: bigint, lpOrUrl: Intermediary | string, refundAddress?: string): Promise<OnchainForGasSwap<T>> {
-        if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
-
-        const lpUrl = typeof(lpOrUrl)==="string" ? lpOrUrl : lpOrUrl.url;
-
-        const token = this._chain.getNativeCurrencyAddress();
-
-        const resp = await this._lpApi.initTrustedFromBTC(this.chainIdentifier, lpUrl, {
-            address: recipient,
-            amount,
-            refundAddress,
-            token
-        }, this._options.getRequestTimeout);
-
-        if(resp.total !== amount) throw new IntermediaryError("Invalid total returned");
-
-        const pricingInfo = await this.verifyReturnedPrice(
-            typeof(lpOrUrl)==="string" || lpOrUrl.services[SwapType.TRUSTED_FROM_BTC]==null ?
-                {swapFeePPM: 10000, swapBaseFee: 10} :
-                lpOrUrl.services[SwapType.TRUSTED_FROM_BTC],
-            false, resp.amountSats,
-            amount, this._chain.getNativeCurrencyAddress(), {swapFeeBtc: resp.swapFeeSats}
-        );
-
-        const quote = new OnchainForGasSwap(this, {
-            paymentHash: resp.paymentHash,
-            sequence: resp.sequence,
-            address: resp.btcAddress,
-            inputAmount: resp.amountSats,
-            outputAmount: resp.total,
-            recipient,
-            refundAddress,
-            pricingInfo,
-            url: lpUrl,
-            expiry: resp.expiresAt,
-            swapFee: resp.swapFee,
-            swapFeeBtc: resp.swapFeeSats,
-            exactIn: false,
-            token,
-            contractVersion: "v1"
-        } as OnchainForGasSwapInit);
-        return quote;
-    }
-
-}
+import {ISwapWrapper, ISwapWrapperOptions, SwapTypeDefinition, WrapperCtorTokens} from "../../ISwapWrapper";
+import {IntermediaryError} from "../../../errors/IntermediaryError";
+import {BitcoinRpcWithAddressIndex, ChainType} from "@atomiqlabs/base";
+import {OnchainForGasSwap, OnchainForGasSwapInit, OnchainForGasSwapState} from "./OnchainForGasSwap";
+import {ISwapPrice} from "../../../prices/abstract/ISwapPrice";
+import {EventEmitter} from "events";
+import {Intermediary} from "../../../intermediaries/Intermediary";
+import {SwapType} from "../../../enums/SwapType";
+import {UnifiedSwapEventListener} from "../../../events/UnifiedSwapEventListener";
+import {UnifiedSwapStorage} from "../../../storage/UnifiedSwapStorage";
+import {ISwap} from "../../ISwap";
+import {BTC_NETWORK} from "@scure/btc-signer/utils";
+import {IntermediaryAPI} from "../../../intermediaries/apis/IntermediaryAPI";
+
+export type OnchainForGasWrapperOptions = ISwapWrapperOptions & {
+    bitcoinNetwork: BTC_NETWORK
+};
+
+export type OnchainForGasSwapTypeDefinition<T extends ChainType> = SwapTypeDefinition<T, OnchainForGasWrapper<T>, OnchainForGasSwap<T>>;
+
+/**
+ * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
+ *  destination chain, which is only needed for Solana, which still uses legacy swaps
+ *
+ * @category Swaps/Trusted Gas Swaps
+ */
+export class OnchainForGasWrapper<T extends ChainType> extends ISwapWrapper<T, OnchainForGasSwapTypeDefinition<T>, OnchainForGasWrapperOptions> {
+    public readonly TYPE: SwapType.TRUSTED_FROM_BTC = SwapType.TRUSTED_FROM_BTC;
+    /**
+     * @internal
+     */
+    readonly _swapDeserializer = OnchainForGasSwap;
+
+    /**
+     * @internal
+     */
+    readonly _pendingSwapStates = [OnchainForGasSwapState.PR_CREATED];
+    /**
+     * @internal
+     */
+    protected readonly tickSwapState = undefined;
+    /**
+     * @internal
+     */
+    protected processEvent = undefined;
+
+    /**
+     * @internal
+     */
+    readonly _btcRpc: BitcoinRpcWithAddressIndex<any>;
+
+    /**
+     * @param chainIdentifier
+     * @param unifiedStorage Storage interface for the current environment
+     * @param unifiedChainEvents On-chain event listener
+     * @param chain
+     * @param prices Pricing to use
+     * @param tokens
+     * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
+     * @param lpApi
+     * @param options
+     * @param events Instance to use for emitting events
+     */
+    constructor(
+        chainIdentifier: string,
+        unifiedStorage: UnifiedSwapStorage<T>,
+        unifiedChainEvents: UnifiedSwapEventListener<T>,
+        chain: T["ChainInterface"],
+        prices: ISwapPrice,
+        tokens: WrapperCtorTokens,
+        btcRpc: BitcoinRpcWithAddressIndex<any>,
+        lpApi: IntermediaryAPI,
+        options: OnchainForGasWrapperOptions,
+        events?: EventEmitter<{swapState: [ISwap]}>
+    ) {
+        super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, lpApi, options, events);
+        this._btcRpc = btcRpc;
+    }
+
+    /**
+     * Returns a newly created trusted Bitcoin on-chain -> Smart chain swap, receiving
+     *  the specified amount of native token on the destination chain.
+     *
+     * @param recipient Address of the recipient on the smart chain destination chain
+     * @param amount Amount of native token to receive in base units
+     * @param lpOrUrl Intermediary (LP) to use for the swap
+     * @param refundAddress Bitcoin address to receive refund on in case the intermediary (LP) cannot execute the swap
+     */
+    async create(recipient: string, amount: bigint, lpOrUrl: Intermediary | string, refundAddress?: string): Promise<OnchainForGasSwap<T>> {
+        if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
+
+        const lpUrl = typeof(lpOrUrl)==="string" ? lpOrUrl : lpOrUrl.url;
+
+        const token = this._chain.getNativeCurrencyAddress();
+
+        const resp = await this._lpApi.initTrustedFromBTC(this.chainIdentifier, lpUrl, {
+            address: recipient,
+            amount,
+            refundAddress,
+            token
+        }, this._options.getRequestTimeout);
+
+        if(resp.total !== amount) throw new IntermediaryError("Invalid total returned");
+
+        const pricingInfo = await this.verifyReturnedPrice(
+            typeof(lpOrUrl)==="string" || lpOrUrl.services[SwapType.TRUSTED_FROM_BTC]==null ?
+                {swapFeePPM: 10000, swapBaseFee: 10} :
+                lpOrUrl.services[SwapType.TRUSTED_FROM_BTC],
+            false, resp.amountSats,
+            amount, this._chain.getNativeCurrencyAddress(), {swapFeeBtc: resp.swapFeeSats}
+        );
+
+        const quote = new OnchainForGasSwap(this, {
+            paymentHash: resp.paymentHash,
+            sequence: resp.sequence,
+            address: resp.btcAddress,
+            inputAmount: resp.amountSats,
+            outputAmount: resp.total,
+            recipient,
+            refundAddress,
+            pricingInfo,
+            url: lpUrl,
+            expiry: resp.expiresAt,
+            swapFee: resp.swapFee,
+            swapFeeBtc: resp.swapFeeSats,
+            exactIn: false,
+            token,
+            contractVersion: "v1"
+        } as OnchainForGasSwapInit);
+        return quote;
+    }
+
+}

package/src/types/AmountData.ts

@@ -1,10 +1,10 @@
-/**
- * Amount, token and exact input object for initiating swap operations
- *
- * @category Tokens
- */
-export type AmountData = {
-    amount: bigint,
-    token: string,
-    exactIn: boolean
+/**
+ * Amount, token and exact input object for initiating swap operations
+ *
+ * @category Tokens
+ */
+export type AmountData = {
+    amount: bigint,
+    token: string,
+    exactIn: boolean
 }

package/src/types/CustomPriceFunction.ts

@@ -1,11 +1,11 @@
-/**
- * Custom pricing callback function type, fetches the USD price for the provided array
- *  of token tickers.
- *
- * @param tickers Tickers of the tokens to fetch USD price for
- * @param abortSignal Abort signal
- * @returns USD prices of the passed tickers in the order that they were passed
- *
- * @category Pricing
- */
-export type CustomPriceFunction = (tickers: string[], abortSignal?: AbortSignal) => Promise<number[]>;
+/**
+ * Custom pricing callback function type, fetches the USD price for the provided array
+ *  of token tickers.
+ *
+ * @param tickers Tickers of the tokens to fetch USD price for
+ * @param abortSignal Abort signal
+ * @returns USD prices of the passed tickers in the order that they were passed
+ *
+ * @category Pricing
+ */
+export type CustomPriceFunction = (tickers: string[], abortSignal?: AbortSignal) => Promise<number[]>;

package/src/types/PriceInfoType.ts

@@ -1,67 +1,67 @@
-import {toBigInt} from "../utils/Utils";
-
-/**
- * Pricing information for swap validation
- * @category Pricing
- */
-export type PriceInfoType = {
-    isValid: boolean,
-    differencePPM: bigint,
-    satsBaseFee: bigint,
-    feePPM: bigint,
-    realPriceUSatPerToken?: bigint,
-    realPriceUsdPerBitcoin?: number,
-    swapPriceUSatPerToken: bigint
-};
-
-/**
- * Type guard for PriceInfoType
- * @category Pricing
- */
-export function isPriceInfoType(obj: any): obj is PriceInfoType {
-    return obj != null &&
-        typeof (obj.isValid) === "boolean" &&
-        typeof (obj.differencePPM) === "bigint" &&
-        typeof (obj.satsBaseFee) === "bigint" &&
-        typeof (obj.feePPM) === "bigint" &&
-        (obj.realPriceUSatPerToken == null || typeof (obj.realPriceUSatPerToken) === "bigint") &&
-        (obj.realPriceUsdPerBitcoin == null || typeof (obj.realPriceUsdPerBitcoin) === "number") &&
-        typeof (obj.swapPriceUSatPerToken) === "bigint";
-}
-
-/**
- * Serializes PriceInfoType for storage
- * @category Pricing
- */
-export function serializePriceInfoType(obj: PriceInfoType | undefined): any {
-    if (obj == null) return null;
-    return {
-        isValid: obj.isValid,
-        differencePPM: obj.differencePPM == null ? null : obj.differencePPM.toString(10),
-        satsBaseFee: obj.satsBaseFee == null ? null : obj.satsBaseFee.toString(10),
-        feePPM: obj.feePPM == null ? null : obj.feePPM.toString(10),
-        realPriceUSatPerToken: obj.realPriceUSatPerToken == null ? null : obj.realPriceUSatPerToken.toString(10),
-        realPriceUsdPerBitcoin: obj.realPriceUsdPerBitcoin,
-        swapPriceUSatPerToken: obj.swapPriceUSatPerToken == null ? null : obj.swapPriceUSatPerToken.toString(10),
-    }
-}
-
-/**
- * Deserializes PriceInfoType from storage
- * @category Pricing
- */
-export function deserializePriceInfoType(obj: any): PriceInfoType | undefined {
-    if (obj == null) return;
-    if (
-        obj.isValid != null && obj.differencePPM != null && obj.satsBaseFee != null &&
-        obj.feePPM != null && obj.swapPriceUSatPerToken != null
-    ) return {
-        isValid: obj.isValid,
-        differencePPM: toBigInt(obj.differencePPM),
-        satsBaseFee: toBigInt(obj.satsBaseFee),
-        feePPM: toBigInt(obj.feePPM),
-        realPriceUSatPerToken: toBigInt(obj.realPriceUSatPerToken),
-        realPriceUsdPerBitcoin: obj.realPriceUsdPerBitcoin,
-        swapPriceUSatPerToken: toBigInt(obj.swapPriceUSatPerToken),
-    }
+import {toBigInt} from "../utils/Utils";
+
+/**
+ * Pricing information for swap validation
+ * @category Pricing
+ */
+export type PriceInfoType = {
+    isValid: boolean,
+    differencePPM: bigint,
+    satsBaseFee: bigint,
+    feePPM: bigint,
+    realPriceUSatPerToken?: bigint,
+    realPriceUsdPerBitcoin?: number,
+    swapPriceUSatPerToken: bigint
+};
+
+/**
+ * Type guard for PriceInfoType
+ * @category Pricing
+ */
+export function isPriceInfoType(obj: any): obj is PriceInfoType {
+    return obj != null &&
+        typeof (obj.isValid) === "boolean" &&
+        typeof (obj.differencePPM) === "bigint" &&
+        typeof (obj.satsBaseFee) === "bigint" &&
+        typeof (obj.feePPM) === "bigint" &&
+        (obj.realPriceUSatPerToken == null || typeof (obj.realPriceUSatPerToken) === "bigint") &&
+        (obj.realPriceUsdPerBitcoin == null || typeof (obj.realPriceUsdPerBitcoin) === "number") &&
+        typeof (obj.swapPriceUSatPerToken) === "bigint";
+}
+
+/**
+ * Serializes PriceInfoType for storage
+ * @category Pricing
+ */
+export function serializePriceInfoType(obj: PriceInfoType | undefined): any {
+    if (obj == null) return null;
+    return {
+        isValid: obj.isValid,
+        differencePPM: obj.differencePPM == null ? null : obj.differencePPM.toString(10),
+        satsBaseFee: obj.satsBaseFee == null ? null : obj.satsBaseFee.toString(10),
+        feePPM: obj.feePPM == null ? null : obj.feePPM.toString(10),
+        realPriceUSatPerToken: obj.realPriceUSatPerToken == null ? null : obj.realPriceUSatPerToken.toString(10),
+        realPriceUsdPerBitcoin: obj.realPriceUsdPerBitcoin,
+        swapPriceUSatPerToken: obj.swapPriceUSatPerToken == null ? null : obj.swapPriceUSatPerToken.toString(10),
+    }
+}
+
+/**
+ * Deserializes PriceInfoType from storage
+ * @category Pricing
+ */
+export function deserializePriceInfoType(obj: any): PriceInfoType | undefined {
+    if (obj == null) return;
+    if (
+        obj.isValid != null && obj.differencePPM != null && obj.satsBaseFee != null &&
+        obj.feePPM != null && obj.swapPriceUSatPerToken != null
+    ) return {
+        isValid: obj.isValid,
+        differencePPM: toBigInt(obj.differencePPM),
+        satsBaseFee: toBigInt(obj.satsBaseFee),
+        feePPM: toBigInt(obj.feePPM),
+        realPriceUSatPerToken: toBigInt(obj.realPriceUSatPerToken),
+        realPriceUsdPerBitcoin: obj.realPriceUsdPerBitcoin,
+        swapPriceUSatPerToken: toBigInt(obj.swapPriceUSatPerToken),
+    }
 }