@atomiqlabs/sdk 8.4.3 → 8.5.0

package/dist/swaps/trusted/ln/LnForGasSwap.d.ts

@@ -151,6 +151,10 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
      * @inheritDoc
      */
     isSuccessful(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      * @internal
@@ -175,7 +179,7 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
     /**
      * @inheritDoc
      */
-    getOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    getOutput(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * @inheritDoc
      */
@@ -183,11 +187,11 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
     /**
      * @inheritDoc
      */
-    getInput(): TokenAmount<T["ChainId"], BtcToken<true>, true>;
+    getInput(): TokenAmount<BtcToken<true>, true>;
     /**
      * @inheritDoc
      */
-    getInputWithoutFee(): TokenAmount<T["ChainId"], BtcToken<true>, true>;
+    getInputWithoutFee(): TokenAmount<BtcToken<true>, true>;
     /**
      * Returns the swap fee charged by the intermediary (LP) on this swap
      *
@@ -209,6 +213,10 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
      * @inheritDoc
      */
     txsExecute(): Promise<[SwapExecutionActionLightning]>;
+    /**
+     * @remark Not supported
+     */
+    execute(): Promise<boolean>;
     /**
      * @inheritDoc
      */

package/dist/swaps/trusted/ln/LnForGasSwap.js

@@ -218,6 +218,12 @@ class LnForGasSwap extends ISwap_1.ISwap {
     isSuccessful() {
         return this._state === LnForGasSwapState.FINISHED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === LnForGasSwapState.PR_CREATED && this.initiated) || this._state === LnForGasSwapState.PR_PAID;
+    }
     /**
      * @inheritDoc
      * @internal
@@ -347,6 +353,12 @@ class LnForGasSwap extends ISwap_1.ISwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED");
     }
+    /**
+     * @remark Not supported
+     */
+    async execute() {
+        throw new Error("Not supported");
+    }
     /**
      * @inheritDoc
      */

package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts

@@ -171,6 +171,10 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
      * @inheritDoc
      */
     isSuccessful(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      * @internal
@@ -195,7 +199,7 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     /**
      * @inheritDoc
      */
-    getOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
+    getOutput(): TokenAmount<SCToken<T["ChainId"]>, true>;
     /**
      * @inheritDoc
      */
@@ -203,11 +207,11 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     /**
      * @inheritDoc
      */
-    getInput(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
+    getInput(): TokenAmount<BtcToken<false>, true>;
     /**
      * @inheritDoc
      */
-    getInputWithoutFee(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
+    getInputWithoutFee(): TokenAmount<BtcToken<false>, true>;
     /**
      * Returns the swap fee charged by the intermediary (LP) on this swap
      *
@@ -251,7 +255,7 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     /**
      * @inheritDoc
      */
-    estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<any, BtcToken<false>, true> | null>;
+    estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<BtcToken<false>, true> | null>;
     /**
      * @inheritDoc
      */
@@ -267,6 +271,10 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     }): Promise<[
         SwapExecutionActionBitcoin<"ADDRESS" | "FUNDED_PSBT">
     ]>;
+    /**
+     * @remark Not supported
+     */
+    execute(): Promise<boolean>;
     /**
      * @inheritDoc
      *

package/dist/swaps/trusted/onchain/OnchainForGasSwap.js

@@ -225,6 +225,13 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
     isSuccessful() {
         return this._state === OnchainForGasSwapState.FINISHED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === OnchainForGasSwapState.PR_CREATED && this.txId != null) ||
+            (this._state === OnchainForGasSwapState.REFUNDABLE && this.refundAddress != null);
+    }
     /**
      * @inheritDoc
      * @internal
@@ -453,6 +460,12 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
     }
+    /**
+     * @remark Not supported
+     */
+    async execute() {
+        throw new Error("Not supported");
+    }
     /**
      * @inheritDoc
      *

package/dist/types/Token.d.ts

@@ -1,15 +1,71 @@
+/**
+ * Type for all token types (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+export type Token<ChainIdentifier extends string = string> = {
+    /**
+     * Chain identifier for the token's chain
+     */
+    chainId: ChainIdentifier | "BITCOIN" | "LIGHTNING";
+    /**
+     * Ticker of the token
+     */
+    ticker: string;
+    /**
+     * Full name of the token
+     */
+    name: string;
+    /**
+     * Actual decimal places of the tokens
+     */
+    decimals: number;
+    /**
+     * The decimal places that should be rendered and displayed to the user
+     */
+    displayDecimals?: number;
+    /**
+     * Address of the token contract, or `""` for Bitcoin
+     */
+    address: string;
+    /**
+     * Legacy chain identifier distinguishing between Smart Chain and Bitcoin tokens
+     */
+    chain: "SC" | "BTC";
+    /**
+     * Legacy lightning flag, determines whether a Bitcoin token is an Lightning or on-chain one
+     */
+    lightning?: boolean;
+    /**
+     * Equality check between tokens
+     */
+    equals: (other: Token) => boolean;
+    /**
+     * Returns the
+     */
+    toString: () => string;
+};
+/**
+ * Type guard for a {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+export declare function isToken(obj: any): obj is Token;
 /**
  * Bitcoin token type (BTC on on-chain or lightning)
  *
  * @category Tokens
  */
-export type BtcToken<L = boolean> = {
-    chain: "BTC";
-    lightning: L;
+export type BtcToken<L = boolean> = Token & {
+    chainId: L extends true ? "LIGHTNING" : "BITCOIN";
     ticker: "BTC";
-    decimals: 8;
     name: L extends true ? "Bitcoin (lightning L2)" : "Bitcoin (on-chain L1)";
-    displayDecimals?: number;
+    decimals: 8;
+    displayDecimals: 8;
+    address: "";
+    chain: "BTC";
+    lightning: L;
+    toString: () => L extends true ? "BTC-LN" : "BTC";
 };
 /**
  * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
@@ -31,29 +87,13 @@ export declare const BitcoinTokens: {
  *
  * @category Tokens
  */
-export type SCToken<ChainIdentifier extends string = string> = {
-    chain: "SC";
+export type SCToken<ChainIdentifier extends string = string> = Token<ChainIdentifier> & {
     chainId: ChainIdentifier;
-    address: string;
-    ticker: string;
-    decimals: number;
-    displayDecimals?: number;
-    name: string;
+    chain: "SC";
+    toString: () => `${ChainIdentifier}-${string}`;
 };
 /**
  * Type guard for {@link SCToken} (token on the smart chain)
  * @category Tokens
  */
-export declare function isSCToken(obj: any): obj is SCToken;
-/**
- * Union type for all token types (BTC or smart chain)
- *
- * @category Tokens
- */
-export type Token<ChainIdentifier extends string = string> = BtcToken | SCToken<ChainIdentifier>;
-/**
- * Type guard for an union {@link Token} type, encompassing all tokens (BTC or smart chain)
- *
- * @category Tokens
- */
-export declare function isToken(obj: any): obj is Token;
+export declare function isSCToken<ChainIdentifier extends string = string>(obj: any, chainIdentifier?: ChainIdentifier[]): obj is SCToken<ChainIdentifier>;

package/dist/types/Token.js

@@ -1,6 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isToken = exports.isSCToken = exports.BitcoinTokens = exports.isBtcToken = void 0;
+exports.isSCToken = exports.BitcoinTokens = exports.isBtcToken = exports.isToken = void 0;
+/**
+ * Type guard for a {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+function isToken(obj) {
+    return typeof (obj) === "object" &&
+        (obj.chain === "SC" || obj.chain === "BTC") &&
+        typeof (obj.ticker) === "string" &&
+        typeof (obj.decimals) === "number" &&
+        typeof (obj.name) === "string";
+}
+exports.isToken = isToken;
 /**
  * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
  *
@@ -23,39 +36,41 @@ exports.isBtcToken = isBtcToken;
 exports.BitcoinTokens = {
     BTC: {
         chain: "BTC",
+        chainId: "BITCOIN",
         lightning: false,
         ticker: "BTC",
         decimals: 8,
-        name: "Bitcoin (on-chain L1)"
+        displayDecimals: 8,
+        name: "Bitcoin (on-chain L1)",
+        address: "",
+        equals: (other) => other.chainId === "BITCOIN" && other.ticker === "BTC",
+        toString: () => "BTC"
     },
     BTCLN: {
         chain: "BTC",
+        chainId: "LIGHTNING",
         lightning: true,
         ticker: "BTC",
         decimals: 8,
-        name: "Bitcoin (lightning L2)"
+        displayDecimals: 8,
+        name: "Bitcoin (lightning L2)",
+        address: "",
+        equals: (other) => other.chainId === "LIGHTNING" && other.ticker === "BTC",
+        toString: () => "BTC-LN"
     }
 };
 /**
  * Type guard for {@link SCToken} (token on the smart chain)
  * @category Tokens
  */
-function isSCToken(obj) {
+function isSCToken(obj, chainIdentifier) {
     return typeof (obj) === "object" &&
         obj.chain === "SC" &&
         typeof (obj.chainId) === "string" &&
+        (chainIdentifier == null || chainIdentifier.includes(obj.chainId)) &&
         typeof (obj.address) === "string" &&
         typeof (obj.ticker) === "string" &&
         typeof (obj.decimals) === "number" &&
         typeof (obj.name) === "string";
 }
 exports.isSCToken = isSCToken;
-/**
- * Type guard for an union {@link Token} type, encompassing all tokens (BTC or smart chain)
- *
- * @category Tokens
- */
-function isToken(obj) {
-    return isBtcToken(obj) || isSCToken(obj);
-}
-exports.isToken = isToken;

package/dist/types/TokenAmount.d.ts

@@ -6,7 +6,7 @@ import { PriceInfoType } from "./PriceInfoType";
  *
  * @category Tokens
  */
-export type TokenAmount<ChainIdentifier extends string = string, T extends Token<ChainIdentifier> = Token<ChainIdentifier>, Known extends boolean = boolean> = {
+export type TokenAmount<T extends Token = Token, Known extends boolean = boolean> = {
     /**
      * Raw amount in base units represented as bigint, might be `undefined` when the amount is unknown
      */
@@ -66,4 +66,4 @@ export type TokenAmount<ChainIdentifier extends string = string, T extends Token
  * @category Tokens
  * @internal
  */
-export declare function toTokenAmount<ChainIdentifier extends string = string, T extends Token<ChainIdentifier> = Token<ChainIdentifier>, Known extends boolean = boolean>(amount: Known extends true ? bigint : null, token: T, prices: ISwapPrice, pricingInfo?: PriceInfoType): TokenAmount<ChainIdentifier, T, Known>;
+export declare function toTokenAmount<T extends Token = Token, Known extends boolean = boolean>(amount: Known extends true ? bigint : null, token: T, prices: ISwapPrice, pricingInfo?: PriceInfoType): TokenAmount<T, Known>;

package/dist/types/fees/Fee.d.ts

@@ -11,11 +11,11 @@ export type Fee<ChainIdentifier extends string = string, TSrc extends Token<Chai
     /**
      * Fee value equivalent in source token
      */
-    amountInSrcToken: TokenAmount<ChainIdentifier, TSrc, true>;
+    amountInSrcToken: TokenAmount<TSrc, true>;
     /**
      * Fee value equivalent in destination token
      */
-    amountInDstToken: TokenAmount<ChainIdentifier, TDst, true>;
+    amountInDstToken: TokenAmount<TDst, true>;
     /**
      * Fetches the current USD value of the fee
      *
@@ -44,7 +44,7 @@ export type Fee<ChainIdentifier extends string = string, TSrc extends Token<Chai
      *  base_fee + amount * percentage_fee
      */
     composition?: {
-        base: TokenAmount<ChainIdentifier>;
+        base: TokenAmount;
         percentage: PercentagePPM;
     };
 };

package/dist/types/lnurl/LNURLPay.d.ts

@@ -47,7 +47,6 @@ export declare function isLNURLPayParams(obj: any): obj is LNURLPayParams;
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 export declare function isLNURLPay(value: any): value is LNURLPay;
 /**

package/dist/types/lnurl/LNURLPay.js

@@ -15,7 +15,6 @@ exports.isLNURLPayParams = isLNURLPayParams;
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 function isLNURLPay(value) {
     return (typeof value === "object" &&

package/dist/types/lnurl/LNURLWithdraw.d.ts

@@ -37,7 +37,6 @@ export type LNURLWithdraw = {
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 export declare function isLNURLWithdraw(value: any): value is LNURLWithdraw;
 /**

package/dist/types/lnurl/LNURLWithdraw.js

@@ -5,7 +5,6 @@ exports.isLNURLWithdrawParams = exports.isLNURLWithdraw = void 0;
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 function isLNURLWithdraw(value) {
     return (typeof value === "object" &&

package/dist/utils/Utils.d.ts

@@ -55,3 +55,4 @@ export declare function randomBytes(bytesLength: number): Buffer;
 export declare function getTxoHash(outputScriptHex: string, value: number): Buffer;
 export declare function fromDecimal(amount: string, decimalCount: number): bigint;
 export declare function toDecimal(amount: bigint, decimalCount: number, cut?: boolean, displayDecimals?: number): string;
+export declare function parseHashValueExact32Bytes(value?: Buffer | string, variableName?: string): Buffer | undefined;

package/dist/utils/Utils.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toDecimal = exports.fromDecimal = exports.getTxoHash = exports.randomBytes = exports.toBigInt = exports.bigIntCompare = exports.bigIntMax = exports.bigIntMin = exports.extendAbortController = exports.mapToArray = exports.objectMap = exports.promiseAny = exports.throwIfUndefined = void 0;
+exports.parseHashValueExact32Bytes = exports.toDecimal = exports.fromDecimal = exports.getTxoHash = exports.randomBytes = exports.toBigInt = exports.bigIntCompare = exports.bigIntMax = exports.bigIntMin = exports.extendAbortController = exports.mapToArray = exports.objectMap = exports.promiseAny = exports.throwIfUndefined = void 0;
 const buffer_1 = require("buffer");
 const utils_1 = require("@noble/hashes/utils");
 const sha2_1 = require("@noble/hashes/sha2");
 const base_1 = require("@atomiqlabs/base");
+const UserError_1 = require("../errors/UserError");
 /**
  * Returns a promise that rejects if the passed promise resolves to `undefined` or `null`
  *
@@ -176,3 +177,18 @@ function toDecimal(amount, decimalCount, cut, displayDecimals) {
     return amountStr.substring(0, splitPoint) + "." + decimalPart.substring(0, cutTo);
 }
 exports.toDecimal = toDecimal;
+function parseHashValueExact32Bytes(value, variableName) {
+    let hash;
+    if (typeof (value) === "string") {
+        if (value.length !== 64)
+            throw new UserError_1.UserError(`Invalid ${variableName} length, must be exactly 64 hexadecimal characters!`);
+        hash = buffer_1.Buffer.from(value, "hex");
+    }
+    else {
+        hash = value;
+    }
+    if (hash != null && hash.length !== 32)
+        throw new UserError_1.UserError(`Invalid ${variableName} length, must be exactly 32 bytes!`);
+    return hash;
+}
+exports.parseHashValueExact32Bytes = parseHashValueExact32Bytes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "8.4.3",
+  "version": "8.5.0",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",

package/src/enums/SwapSide.ts

@@ -0,0 +1,16 @@
+
+/**
+ * Enum representing the side of the swap for querying available input/output tokens
+ *
+ * @category Core
+ */
+export enum SwapSide {
+    /**
+     * Represents input / source side of the swap
+     */
+    INPUT = 1,
+    /**
+     * Represents output / destination side of the swap
+     */
+    OUTPUT = 0
+}

package/src/index.ts

@@ -45,6 +45,7 @@ export {CoinselectAddressTypes} from "./bitcoin/coinselect2";
 export * from "./enums/FeeType";
 export * from "./enums/SwapAmountType";
 export * from "./enums/SwapDirection";
+export * from "./enums/SwapSide";
 export * from "./enums/SwapType";
 
 export * from "./errors/IntermediaryError";
@@ -127,6 +128,7 @@ export * from "./types/wallets/MinimalBitcoinWalletInterface";
 export * from "./types/wallets/MinimalLightningNetworkWalletInterface";
 export * from "./types/wallets/LightningInvoiceCreateService";
 
+export * from "./types/SwapStateInfo";
 export * from "./types/AmountData";
 export * from "./types/CustomPriceFunction";
 export * from "./types/SwapExecutionAction";

package/src/intermediaries/apis/IntermediaryAPI.ts

@@ -204,9 +204,9 @@ export type FromBTCInit = BaseFromBTCSwapInit & {
     sequence: bigint,
     claimerBounty: Promise<{
         feePerBlock: bigint,
-        safetyFactor: number,
+        safetyFactor: bigint,
         startTimestamp: bigint,
-        addBlock: number,
+        addBlock: bigint,
         addFee: bigint
     }>
 }
@@ -532,9 +532,9 @@ export class IntermediaryAPI {
                 claimerBounty: init.claimerBounty.then(claimerBounty => {
                     return {
                         feePerBlock: claimerBounty.feePerBlock.toString(10),
-                        safetyFactor: claimerBounty.safetyFactor,
+                        safetyFactor: claimerBounty.safetyFactor.toString(10),
                         startTimestamp: claimerBounty.startTimestamp.toString(10),
-                        addBlock: claimerBounty.addBlock,
+                        addBlock: claimerBounty.addBlock.toString(10),
                         addFee: claimerBounty.addFee.toString(10)
                     }
                 }),

package/src/storage/UnifiedSwapStorage.ts

@@ -18,6 +18,7 @@ const indexes = [
  * Simple index types for SDK swap storage
  *
  * @category Storage
+ * @useDeclaredType
  */
 export type UnifiedSwapStorageIndexes = typeof indexes;
 
@@ -31,6 +32,7 @@ const compositeIndexes = [
  * Composite index types for SDK swap storage
  *
  * @category Storage
+ * @useDeclaredType
  */
 export type UnifiedSwapStorageCompositeIndexes = typeof compositeIndexes;