@atomiqlabs/sdk 8.6.5 → 8.6.6

package/dist/utils/Utils.d.ts

@@ -1,58 +1,56 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Buffer } from "buffer";
-/**
- * Returns a promise that rejects if the passed promise resolves to `undefined` or `null`
- *
- * @param promise Promise to check resolve value of
- * @param msg Optional message to pass to the thrown `Error`
- * @category Utilities
- */
-export declare function throwIfUndefined<T>(promise: Promise<T | undefined>, msg?: string): Promise<T>;
-/**
- * Returns a promise that resolves when any of the passed promises resolves, and rejects if all the underlying
- *  promises fail with an array of errors returned by the respective promises
- *
- * @param promises A list of promises
- * @category Utilities
- */
-export declare function promiseAny<T>(promises: Promise<T>[]): Promise<T>;
-/**
- * Maps a JS object to another JS object based on the translation function, the translation function is called for every
- *  property (value/key) of the old object and returns the new value of for this property
- *
- * @param obj
- * @param translator
- */
-export declare function objectMap<InputObject extends {
-    [key in string]: any;
-}, OutputObject extends {
-    [key in keyof InputObject]: any;
-}>(obj: InputObject, translator: <InputKey extends Extract<keyof InputObject, string>>(value: InputObject[InputKey], key: InputKey) => OutputObject[InputKey]): {
-    [key in keyof InputObject]: OutputObject[key];
-};
-/**
- * Maps the entries from the map to the array using the translator function
- *
- * @param map
- * @param translator
- */
-export declare function mapToArray<K, V, Output>(map: Map<K, V>, translator: (key: K, value: V) => Output): Output[];
-/**
- * Creates a new abort controller that will abort if the passed abort signal aborts
- *
- * @param abortSignal
- */
-export declare function extendAbortController(abortSignal?: AbortSignal): AbortController;
-export declare function bigIntMin(a: bigint, b: bigint): bigint;
-export declare function bigIntMin(a?: bigint, b?: bigint): bigint | undefined;
-export declare function bigIntMax(a: bigint, b: bigint): bigint;
-export declare function bigIntMax(a?: bigint, b?: bigint): bigint | undefined;
-export declare function bigIntCompare(a: bigint, b: bigint): -1 | 0 | 1;
-export declare function toBigInt(value: string): bigint;
-export declare function toBigInt(value: undefined): undefined;
-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;
+import { Buffer } from "buffer";
+/**
+ * Returns a promise that rejects if the passed promise resolves to `undefined` or `null`
+ *
+ * @param promise Promise to check resolve value of
+ * @param msg Optional message to pass to the thrown `Error`
+ * @category Utilities
+ */
+export declare function throwIfUndefined<T>(promise: Promise<T | undefined>, msg?: string): Promise<T>;
+/**
+ * Returns a promise that resolves when any of the passed promises resolves, and rejects if all the underlying
+ *  promises fail with an array of errors returned by the respective promises
+ *
+ * @param promises A list of promises
+ * @category Utilities
+ */
+export declare function promiseAny<T>(promises: Promise<T>[]): Promise<T>;
+/**
+ * Maps a JS object to another JS object based on the translation function, the translation function is called for every
+ *  property (value/key) of the old object and returns the new value of for this property
+ *
+ * @param obj
+ * @param translator
+ */
+export declare function objectMap<InputObject extends {
+    [key in string]: any;
+}, OutputObject extends {
+    [key in keyof InputObject]: any;
+}>(obj: InputObject, translator: <InputKey extends Extract<keyof InputObject, string>>(value: InputObject[InputKey], key: InputKey) => OutputObject[InputKey]): {
+    [key in keyof InputObject]: OutputObject[key];
+};
+/**
+ * Maps the entries from the map to the array using the translator function
+ *
+ * @param map
+ * @param translator
+ */
+export declare function mapToArray<K, V, Output>(map: Map<K, V>, translator: (key: K, value: V) => Output): Output[];
+/**
+ * Creates a new abort controller that will abort if the passed abort signal aborts
+ *
+ * @param abortSignal
+ */
+export declare function extendAbortController(abortSignal?: AbortSignal): AbortController;
+export declare function bigIntMin(a: bigint, b: bigint): bigint;
+export declare function bigIntMin(a?: bigint, b?: bigint): bigint | undefined;
+export declare function bigIntMax(a: bigint, b: bigint): bigint;
+export declare function bigIntMax(a?: bigint, b?: bigint): bigint | undefined;
+export declare function bigIntCompare(a: bigint, b: bigint): -1 | 0 | 1;
+export declare function toBigInt(value: string): bigint;
+export declare function toBigInt(value: undefined): undefined;
+export declare function randomBytes(bytesLength: number): Buffer;
+export declare function getTxoHash(outputScriptHex: string, value: number): Buffer<ArrayBuffer>;
+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,194 +1,193 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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`
- *
- * @param promise Promise to check resolve value of
- * @param msg Optional message to pass to the thrown `Error`
- * @category Utilities
- */
-function throwIfUndefined(promise, msg) {
-    return promise.then(val => {
-        if (val == undefined)
-            throw new Error(msg ?? "Promise value is undefined!");
-        return val;
-    });
-}
-exports.throwIfUndefined = throwIfUndefined;
-/**
- * Returns a promise that resolves when any of the passed promises resolves, and rejects if all the underlying
- *  promises fail with an array of errors returned by the respective promises
- *
- * @param promises A list of promises
- * @category Utilities
- */
-function promiseAny(promises) {
-    return new Promise((resolve, reject) => {
-        let numRejected = 0;
-        const rejectReasons = Array(promises.length);
-        promises.forEach((promise, index) => {
-            promise.then((val) => {
-                if (resolve != null)
-                    resolve(val);
-                resolve = null;
-            }).catch(err => {
-                rejectReasons[index] = err;
-                numRejected++;
-                if (numRejected === promises.length) {
-                    reject(rejectReasons);
-                }
-            });
-        });
-    });
-}
-exports.promiseAny = promiseAny;
-/**
- * Maps a JS object to another JS object based on the translation function, the translation function is called for every
- *  property (value/key) of the old object and returns the new value of for this property
- *
- * @param obj
- * @param translator
- */
-function objectMap(obj, translator) {
-    const resp = {};
-    for (let key in obj) {
-        resp[key] = translator(obj[key], key);
-    }
-    return resp;
-}
-exports.objectMap = objectMap;
-/**
- * Maps the entries from the map to the array using the translator function
- *
- * @param map
- * @param translator
- */
-function mapToArray(map, translator) {
-    const arr = Array(map.size);
-    let pointer = 0;
-    for (let entry of map.entries()) {
-        arr[pointer++] = translator(entry[0], entry[1]);
-    }
-    return arr;
-}
-exports.mapToArray = mapToArray;
-/**
- * Creates a new abort controller that will abort if the passed abort signal aborts
- *
- * @param abortSignal
- */
-function extendAbortController(abortSignal) {
-    const _abortController = new AbortController();
-    if (abortSignal != null) {
-        abortSignal.throwIfAborted();
-        abortSignal.onabort = () => _abortController.abort(abortSignal.reason);
-    }
-    return _abortController;
-}
-exports.extendAbortController = extendAbortController;
-function bigIntMin(a, b) {
-    if (a == null)
-        return b;
-    if (b == null)
-        return a;
-    return a > b ? b : a;
-}
-exports.bigIntMin = bigIntMin;
-function bigIntMax(a, b) {
-    if (a == null)
-        return b;
-    if (b == null)
-        return a;
-    return b > a ? b : a;
-}
-exports.bigIntMax = bigIntMax;
-function bigIntCompare(a, b) {
-    return a > b ? 1 : a === b ? 0 : -1;
-}
-exports.bigIntCompare = bigIntCompare;
-function toBigInt(value) {
-    if (value == null)
-        return undefined;
-    return BigInt(value);
-}
-exports.toBigInt = toBigInt;
-function randomBytes(bytesLength) {
-    return buffer_1.Buffer.from((0, utils_1.randomBytes)(bytesLength));
-}
-exports.randomBytes = randomBytes;
-function getTxoHash(outputScriptHex, value) {
-    return buffer_1.Buffer.from((0, sha2_1.sha256)(buffer_1.Buffer.concat([
-        base_1.BigIntBufferUtils.toBuffer(BigInt(value), "le", 8),
-        buffer_1.Buffer.from(outputScriptHex, "hex")
-    ])));
-}
-exports.getTxoHash = getTxoHash;
-function fromDecimal(amount, decimalCount) {
-    if (amount.includes(".")) {
-        const [before, after] = amount.split(".");
-        if (decimalCount < 0) {
-            return BigInt(before.substring(0, before.length + decimalCount));
-        }
-        if (after.length > decimalCount) {
-            //Cut the last digits
-            return BigInt((before === "0" ? "" : before) + after.substring(0, decimalCount));
-        }
-        return BigInt((before === "0" ? "" : before) + after.padEnd(decimalCount, "0"));
-    }
-    else {
-        if (decimalCount < 0) {
-            return BigInt(amount.substring(0, amount.length + decimalCount));
-        }
-        else {
-            return BigInt(amount + "0".repeat(decimalCount));
-        }
-    }
-}
-exports.fromDecimal = fromDecimal;
-function toDecimal(amount, decimalCount, cut, displayDecimals) {
-    if (decimalCount <= 0) {
-        return amount.toString(10) + "0".repeat(-decimalCount);
-    }
-    const amountStr = amount.toString(10).padStart(decimalCount + 1, "0");
-    const splitPoint = amountStr.length - decimalCount;
-    const decimalPart = amountStr.substring(splitPoint, amountStr.length);
-    let cutTo = decimalPart.length;
-    if (cut && cutTo > 0) {
-        for (let i = decimalPart.length - 1; i--; i >= 0) {
-            if (decimalPart.charAt(i) === "0") {
-                cutTo = i;
-            }
-            else
-                break;
-        }
-        if (cutTo === 0)
-            cutTo = 1;
-    }
-    if (displayDecimals === 0)
-        return amountStr.substring(0, splitPoint);
-    if (displayDecimals != null && cutTo > displayDecimals)
-        cutTo = 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;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwIfUndefined = throwIfUndefined;
+exports.promiseAny = promiseAny;
+exports.objectMap = objectMap;
+exports.mapToArray = mapToArray;
+exports.extendAbortController = extendAbortController;
+exports.bigIntMin = bigIntMin;
+exports.bigIntMax = bigIntMax;
+exports.bigIntCompare = bigIntCompare;
+exports.toBigInt = toBigInt;
+exports.randomBytes = randomBytes;
+exports.getTxoHash = getTxoHash;
+exports.fromDecimal = fromDecimal;
+exports.toDecimal = toDecimal;
+exports.parseHashValueExact32Bytes = parseHashValueExact32Bytes;
+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`
+ *
+ * @param promise Promise to check resolve value of
+ * @param msg Optional message to pass to the thrown `Error`
+ * @category Utilities
+ */
+function throwIfUndefined(promise, msg) {
+    return promise.then(val => {
+        if (val == undefined)
+            throw new Error(msg ?? "Promise value is undefined!");
+        return val;
+    });
+}
+/**
+ * Returns a promise that resolves when any of the passed promises resolves, and rejects if all the underlying
+ *  promises fail with an array of errors returned by the respective promises
+ *
+ * @param promises A list of promises
+ * @category Utilities
+ */
+function promiseAny(promises) {
+    return new Promise((resolve, reject) => {
+        let numRejected = 0;
+        const rejectReasons = Array(promises.length);
+        promises.forEach((promise, index) => {
+            promise.then((val) => {
+                if (resolve != null)
+                    resolve(val);
+                resolve = null;
+            }).catch(err => {
+                rejectReasons[index] = err;
+                numRejected++;
+                if (numRejected === promises.length) {
+                    reject(rejectReasons);
+                }
+            });
+        });
+    });
+}
+/**
+ * Maps a JS object to another JS object based on the translation function, the translation function is called for every
+ *  property (value/key) of the old object and returns the new value of for this property
+ *
+ * @param obj
+ * @param translator
+ */
+function objectMap(obj, translator) {
+    const resp = {};
+    for (let key in obj) {
+        resp[key] = translator(obj[key], key);
+    }
+    return resp;
+}
+/**
+ * Maps the entries from the map to the array using the translator function
+ *
+ * @param map
+ * @param translator
+ */
+function mapToArray(map, translator) {
+    const arr = Array(map.size);
+    let pointer = 0;
+    for (let entry of map.entries()) {
+        arr[pointer++] = translator(entry[0], entry[1]);
+    }
+    return arr;
+}
+/**
+ * Creates a new abort controller that will abort if the passed abort signal aborts
+ *
+ * @param abortSignal
+ */
+function extendAbortController(abortSignal) {
+    const _abortController = new AbortController();
+    if (abortSignal != null) {
+        abortSignal.throwIfAborted();
+        abortSignal.onabort = () => _abortController.abort(abortSignal.reason);
+    }
+    return _abortController;
+}
+function bigIntMin(a, b) {
+    if (a == null)
+        return b;
+    if (b == null)
+        return a;
+    return a > b ? b : a;
+}
+function bigIntMax(a, b) {
+    if (a == null)
+        return b;
+    if (b == null)
+        return a;
+    return b > a ? b : a;
+}
+function bigIntCompare(a, b) {
+    return a > b ? 1 : a === b ? 0 : -1;
+}
+function toBigInt(value) {
+    if (value == null)
+        return undefined;
+    return BigInt(value);
+}
+function randomBytes(bytesLength) {
+    return buffer_1.Buffer.from((0, utils_1.randomBytes)(bytesLength));
+}
+function getTxoHash(outputScriptHex, value) {
+    return buffer_1.Buffer.from((0, sha2_1.sha256)(buffer_1.Buffer.concat([
+        base_1.BigIntBufferUtils.toBuffer(BigInt(value), "le", 8),
+        buffer_1.Buffer.from(outputScriptHex, "hex")
+    ])));
+}
+function fromDecimal(amount, decimalCount) {
+    if (amount.includes(".")) {
+        const [before, after] = amount.split(".");
+        if (decimalCount < 0) {
+            return BigInt(before.substring(0, before.length + decimalCount));
+        }
+        if (after.length > decimalCount) {
+            //Cut the last digits
+            return BigInt((before === "0" ? "" : before) + after.substring(0, decimalCount));
+        }
+        return BigInt((before === "0" ? "" : before) + after.padEnd(decimalCount, "0"));
+    }
+    else {
+        if (decimalCount < 0) {
+            return BigInt(amount.substring(0, amount.length + decimalCount));
+        }
+        else {
+            return BigInt(amount + "0".repeat(decimalCount));
+        }
+    }
+}
+function toDecimal(amount, decimalCount, cut, displayDecimals) {
+    if (decimalCount <= 0) {
+        return amount.toString(10) + "0".repeat(-decimalCount);
+    }
+    const amountStr = amount.toString(10).padStart(decimalCount + 1, "0");
+    const splitPoint = amountStr.length - decimalCount;
+    const decimalPart = amountStr.substring(splitPoint, amountStr.length);
+    let cutTo = decimalPart.length;
+    if (cut && cutTo > 0) {
+        for (let i = decimalPart.length - 1; i--; i >= 0) {
+            if (decimalPart.charAt(i) === "0") {
+                cutTo = i;
+            }
+            else
+                break;
+        }
+        if (cutTo === 0)
+            cutTo = 1;
+    }
+    if (displayDecimals === 0)
+        return amountStr.substring(0, splitPoint);
+    if (displayDecimals != null && cutTo > displayDecimals)
+        cutTo = displayDecimals;
+    return amountStr.substring(0, splitPoint) + "." + decimalPart.substring(0, cutTo);
+}
+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;
+}

package/package.json

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

package/src/intermediaries/apis/IntermediaryAPI.ts

@@ -309,7 +309,8 @@ export type SpvFromBTCPrepare = SwapInit & {
     gasToken: string,
     exactOut: boolean,
     callerFeeRate: Promise<bigint>,
-    frontingFeeRate: bigint
+    frontingFeeRate: bigint,
+    stickyAddress?: boolean
 }
 
 const SpvFromBTCInitResponseSchema = {
@@ -877,7 +878,8 @@ export class IntermediaryAPI {
             gasAmount: init.gasAmount.toString(10),
             gasToken: init.gasToken,
             frontingFeeRate: init.frontingFeeRate.toString(10),
-            callerFeeRate: init.callerFeeRate.then(val => val.toString(10))
+            callerFeeRate: init.callerFeeRate.then(val => val.toString(10)),
+            stickyAddress: init.stickyAddress
         }, {
             code: FieldTypeEnum.Number,
             msg: FieldTypeEnum.String,

package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts

@@ -68,6 +68,13 @@ export type SpvFromBTCOptions = {
      *  the settlement gas fee cost)
      */
     feeSafetyFactor?: number,
+    /**
+     * Instruct the LP to create a "sticky address" for your destination wallet address. After the first successful
+     *  swap with that LP, the used bitcoin address will be permanently linked to your destination wallet address. So
+     *  all subsequent swaps to the same address will yield the same LP deposit bitcoin address. Useful for corporate
+     *  whitelist-only wallets
+     */
+    stickyAddress?: boolean,
 
     /**
      * @deprecated Use `maxAllowedBitcoinFeeRate` instead!
@@ -633,6 +640,7 @@ export class SpvFromBTCWrapper<
                                     gasAmount: _options.gasAmount,
                                     callerFeeRate: throwIfUndefined(callerFeePrefetchPromise, "Caller fee prefetch failed!"),
                                     frontingFeeRate: 0n,
+                                    stickyAddress: options?.stickyAddress,
                                     additionalParams
                                 },
                                 this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined