@atomiqlabs/sdk 8.5.0 → 8.6.0

package/dist/swapper/Swapper.d.ts

@@ -123,9 +123,15 @@ export type SwapperOptions = {
      */
     dontFetchLPs?: boolean;
     /**
-     * By setting this flag the SDK persists all created swaps. By default, the SDK only saves and persists swaps that
-     *  are considered initiated, i.e. when `commit()`, `execute()` or `waitTillPayment` is called (or their respective
-     *  txs... prefixed variations).
+     * Defaults to `true`, this means every swap regardless of it being initiated (i.e. when `commit()`, `execute()` or
+     *  `waitTillPayment` is called) is saved to the persistent storage. This is a reasonable default for when you
+     *  want to only create a swap, and then later on retrieve it with the `swapper.getSwapById()` function.
+     *
+     * Setting this to `false` means the SDK only saves and persists swaps that are considered initiated, i.e. when
+     *  `commit()`, `execute()` or `waitTillPayment` is called (or their respective txs... prefixed variations). This
+     *  might save calls to the persistent storage for swaps that are never initiated. This is useful in e.g.
+     *  frontend implementations where the frontend holds the swap object reference until it is initiated anyway, not
+     *  necessitating the saving of the swap data to the persistent storage until it is actually initiated.
      */
     saveUninitializedSwaps?: boolean;
     /**

package/dist/swapper/Swapper.js

@@ -63,6 +63,7 @@ class Swapper extends events_1.EventEmitter {
         this.SwapTypeInfo = SwapUtils_1.SwapProtocolInfo;
         const storagePrefix = options?.storagePrefix ?? "atomiq-";
         options ??= {};
+        options.saveUninitializedSwaps ??= true;
         options.bitcoinNetwork = options.bitcoinNetwork == null ? base_1.BitcoinNetwork.TESTNET : options.bitcoinNetwork;
         const swapStorage = options.swapStorage ??= (name) => new IndexedDBUnifiedStorage_1.IndexedDBUnifiedStorage(name);
         this.options = options;

package/dist/swaps/ISwap.js

@@ -109,8 +109,8 @@ class ISwap {
         // swap exists, it will just never resolve!
         return new Promise((resolve, reject) => {
             let listener;
-            listener = (swap) => {
-                if (type === "eq" ? swap._state === targetState : type === "gte" ? swap._state >= targetState : swap._state != targetState) {
+            listener = () => {
+                if (type === "eq" ? this._state === targetState : type === "gte" ? this._state >= targetState : this._state != targetState) {
                     resolve();
                     this.events.removeListener("swapState", listener);
                 }

package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js

@@ -102,9 +102,10 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
             swap._commitTxId = event.meta?.txId;
             swap._commitedAt ??= Date.now();
             swap._state = FromBTCLNAutoSwap_1.FromBTCLNAutoSwapState.CLAIM_COMMITED;
-            swap._broadcastSecret().catch(e => {
-                this.logger.error("processEventInitialize(" + swap.getId() + "): Error when broadcasting swap secret: ", e);
-            });
+            if (swap.hasSecretPreimage())
+                swap._broadcastSecret().catch(e => {
+                    this.logger.error("processEventInitialize(" + swap.getId() + "): Error when broadcasting swap secret: ", e);
+                });
             return true;
         }
         return false;

package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts

@@ -119,6 +119,7 @@ export declare function isSpvFromBTCSwapInit(obj: any): obj is SpvFromBTCSwapIni
  * @category Swaps/Bitcoin → Smart chain
  */
 export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFromBTCTypeDefinition<T>> implements IBTCWalletSwap, ISwapWithGasDrop<T>, IClaimableSwap<T, SpvFromBTCTypeDefinition<T>, SpvFromBTCSwapState> {
+    protected readonly currentVersion: number;
     readonly TYPE: SwapType.SPV_VAULT_FROM_BTC;
     /**
      * @internal
@@ -169,6 +170,7 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
     private readonly frontingFeeShare;
     private readonly executionFeeShare;
     private readonly gasPricingInfo?;
+    private posted?;
     /**
      * @internal
      */

package/dist/swaps/spv_swaps/SpvFromBTCSwap.js

@@ -143,6 +143,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
         if (isSpvFromBTCSwapInit(initOrObject) && initOrObject.url != null)
             initOrObject.url += "/frombtc_spv";
         super(wrapper, initOrObject);
+        this.currentVersion = 2;
         this.TYPE = SwapType_1.SwapType.SPV_VAULT_FROM_BTC;
         /**
          * @internal
@@ -213,6 +214,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
             this._frontTxId = initOrObject.frontTxId;
             this.gasPricingInfo = (0, PriceInfoType_1.deserializePriceInfoType)(initOrObject.gasPricingInfo);
             this.btcTxConfirmedAt = initOrObject.btcTxConfirmedAt;
+            this.posted = initOrObject.posted;
             if (initOrObject.data != null)
                 this._data = new this.wrapper._spvWithdrawalDataDeserializer(initOrObject.data);
         }
@@ -223,7 +225,12 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
      * @inheritDoc
      * @internal
      */
-    upgradeVersion() { }
+    upgradeVersion() {
+        if (this.version === 1) {
+            this.posted = this.initiated;
+            this.version = 2;
+        }
+    }
     /**
      * @inheritDoc
      * @internal
@@ -723,6 +730,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
         }
         this._data = data;
         this.initiated = true;
+        this.posted = true;
         await this._saveAndEmit(SpvFromBTCSwapState.SIGNED);
         try {
             await IntermediaryAPI_1.IntermediaryAPI.initSpvFromBTC(this.chainIdentifier, this.url, {
@@ -895,7 +903,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
     async waitForBitcoinTransaction(updateCallback, checkIntervalSeconds, abortSignal) {
         if (this._state !== SpvFromBTCSwapState.POSTED &&
             this._state !== SpvFromBTCSwapState.BROADCASTED &&
-            !(this._state === SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && this.initiated))
+            !(this._state === SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && this.posted))
             throw new Error("Must be in POSTED or BROADCASTED state!");
         if (this._data == null)
             throw new Error("Expected swap to have withdrawal data filled!");
@@ -1201,6 +1209,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
             executionFeeShare: this.executionFeeShare.toString(10),
             genesisSmartChainBlockHeight: this._genesisSmartChainBlockHeight,
             gasPricingInfo: (0, PriceInfoType_1.serializePriceInfoType)(this.gasPricingInfo),
+            posted: this.posted,
             senderAddress: this._senderAddress,
             claimTxId: this._claimTxId,
             frontTxId: this._frontTxId,
@@ -1362,7 +1371,7 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
                 return true;
             }
         }
-        if (this._state === SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && !this.initiated) {
+        if (this._state === SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && !this.posted) {
             if (this.expiry < Date.now()) {
                 this._state = SpvFromBTCSwapState.QUOTE_EXPIRED;
                 if (save)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "8.5.0",
+  "version": "8.6.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/swapper/Swapper.ts

@@ -152,9 +152,15 @@ export type SwapperOptions = {
      */
     dontFetchLPs?: boolean,
     /**
-     * By setting this flag the SDK persists all created swaps. By default, the SDK only saves and persists swaps that
-     *  are considered initiated, i.e. when `commit()`, `execute()` or `waitTillPayment` is called (or their respective
-     *  txs... prefixed variations).
+     * Defaults to `true`, this means every swap regardless of it being initiated (i.e. when `commit()`, `execute()` or
+     *  `waitTillPayment` is called) is saved to the persistent storage. This is a reasonable default for when you
+     *  want to only create a swap, and then later on retrieve it with the `swapper.getSwapById()` function.
+     *
+     * Setting this to `false` means the SDK only saves and persists swaps that are considered initiated, i.e. when
+     *  `commit()`, `execute()` or `waitTillPayment` is called (or their respective txs... prefixed variations). This
+     *  might save calls to the persistent storage for swaps that are never initiated. This is useful in e.g.
+     *  frontend implementations where the frontend holds the swap object reference until it is initiated anyway, not
+     *  necessitating the saving of the swap data to the persistent storage until it is actually initiated.
      */
     saveUninitializedSwaps?: boolean,
     /**
@@ -318,6 +324,7 @@ export class Swapper<T extends MultiChain> extends EventEmitter<{
         const storagePrefix = options?.storagePrefix ?? "atomiq-";
 
         options ??= {};
+        options.saveUninitializedSwaps ??= true;
         options.bitcoinNetwork = options.bitcoinNetwork==null ? BitcoinNetwork.TESTNET : options.bitcoinNetwork;
         const swapStorage = options.swapStorage ??= (name: string) => new IndexedDBUnifiedStorage(name);
 

package/src/swaps/ISwap.ts

@@ -229,9 +229,9 @@ export abstract class ISwap<
         //TODO: This doesn't hold strong reference to the swap, hence if no other strong reference to the
         // swap exists, it will just never resolve!
         return new Promise((resolve, reject) => {
-            let listener: (swap: D["Swap"]) => void;
-            listener = (swap) => {
-                if(type==="eq" ? swap._state===targetState : type==="gte" ? swap._state>=targetState : swap._state!=targetState) {
+            let listener: () => void;
+            listener = () => {
+                if(type==="eq" ? this._state===targetState : type==="gte" ? this._state>=targetState : this._state!=targetState) {
                     resolve();
                     this.events.removeListener("swapState", listener);
                 }

package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts

@@ -213,7 +213,7 @@ export class FromBTCLNAutoWrapper<
             swap._commitTxId = event.meta?.txId;
             swap._commitedAt ??= Date.now();
             swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
-            swap._broadcastSecret().catch(e => {
+            if(swap.hasSecretPreimage()) swap._broadcastSecret().catch(e => {
                 this.logger.error("processEventInitialize("+swap.getId()+"): Error when broadcasting swap secret: ", e);
             });
             return true;

package/src/swaps/spv_swaps/SpvFromBTCSwap.ts

@@ -193,6 +193,8 @@ export class SpvFromBTCSwap<T extends ChainType>
     extends ISwap<T, SpvFromBTCTypeDefinition<T>>
     implements IBTCWalletSwap, ISwapWithGasDrop<T>, IClaimableSwap<T, SpvFromBTCTypeDefinition<T>, SpvFromBTCSwapState> {
 
+    protected readonly currentVersion: number = 2;
+
     readonly TYPE: SwapType.SPV_VAULT_FROM_BTC = SwapType.SPV_VAULT_FROM_BTC;
 
     /**
@@ -240,6 +242,8 @@ export class SpvFromBTCSwap<T extends ChainType>
 
     private readonly gasPricingInfo?: PriceInfoType;
 
+    private posted?: boolean;
+
     /**
      * @internal
      */
@@ -337,6 +341,7 @@ export class SpvFromBTCSwap<T extends ChainType>
             this._frontTxId = initOrObject.frontTxId;
             this.gasPricingInfo = deserializePriceInfoType(initOrObject.gasPricingInfo);
             this.btcTxConfirmedAt = initOrObject.btcTxConfirmedAt;
+            this.posted = initOrObject.posted;
             if(initOrObject.data!=null) this._data = new this.wrapper._spvWithdrawalDataDeserializer(initOrObject.data);
         }
         this.tryCalculateSwapFee();
@@ -347,7 +352,12 @@ export class SpvFromBTCSwap<T extends ChainType>
      * @inheritDoc
      * @internal
      */
-    protected upgradeVersion() { /*NOOP*/ }
+    protected upgradeVersion() {
+        if(this.version===1) {
+            this.posted = this.initiated;
+            this.version = 2;
+        }
+    }
 
     /**
      * @inheritDoc
@@ -973,6 +983,7 @@ export class SpvFromBTCSwap<T extends ChainType>
 
         this._data = data;
         this.initiated = true;
+        this.posted = true;
         await this._saveAndEmit(SpvFromBTCSwapState.SIGNED);
 
         try {
@@ -1186,7 +1197,7 @@ export class SpvFromBTCSwap<T extends ChainType>
         if(
             this._state!==SpvFromBTCSwapState.POSTED &&
             this._state!==SpvFromBTCSwapState.BROADCASTED &&
-            !(this._state===SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && this.initiated)
+            !(this._state===SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && this.posted)
         ) throw new Error("Must be in POSTED or BROADCASTED state!");
         if(this._data==null) throw new Error("Expected swap to have withdrawal data filled!");
 
@@ -1529,6 +1540,7 @@ export class SpvFromBTCSwap<T extends ChainType>
             executionFeeShare: this.executionFeeShare.toString(10),
             genesisSmartChainBlockHeight: this._genesisSmartChainBlockHeight,
             gasPricingInfo: serializePriceInfoType(this.gasPricingInfo),
+            posted: this.posted,
 
             senderAddress: this._senderAddress,
             claimTxId: this._claimTxId,
@@ -1704,7 +1716,7 @@ export class SpvFromBTCSwap<T extends ChainType>
             }
         }
 
-        if(this._state===SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && !this.initiated) {
+        if(this._state===SpvFromBTCSwapState.QUOTE_SOFT_EXPIRED && !this.posted) {
             if(this.expiry<Date.now()) {
                 this._state = SpvFromBTCSwapState.QUOTE_EXPIRED;
                 if(save) await this._saveAndEmit();