@stellar-broker/client 0.6.3 → 0.6.5

package/README.md

@@ -131,6 +131,7 @@ directly or create alternative logic based on it.
 ```js
 import {Mediator} from '@stellar-broker/client'
 
+const source = 'GDNDS76YATRWMRQ7SGCI7FG3Y4A2MREDSKWDGLEB75IX5W2T25HA4DS3'
 const sellingAsset = 'XLM'
 const buyingAsset = 'AQUA-GBNZILSTVQZ4R7IKQDGHYGY2QXL5QOFJYQMXPKWRRM5PAV7Y4M67AQUA'
 const sellingAmount = '10'
@@ -158,4 +159,8 @@ console.log('Mediator account disposed')
 if (mediator.hasObsoleteMediators) {
     await mediator.disposeObsoleteMediators()
 }
+//or using static methods
+if (Mediator.hasObsoleteMediators(source)) {
+    await Mediator.disposeObsoleteMediators(source, signTx)
+}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar-broker/client",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "Client library for StellarBroker service",
   "author": "team@stellar.broker",
   "homepage": "https://stellar.broker",

package/src/index.d.ts

@@ -244,11 +244,26 @@ export class Mediator {
      */
     get hasObsoleteMediators(): boolean;
 
+    /**
+     * Check if there are any non-disposed mediators that belong to lost swap sessions
+     * @param source - Initiator account that created a mediator
+     * @param [storagePrefix] - Local storage key prefix
+     */
+    static hasObsoleteMediators(source: string, storagePrefix?: string): boolean
+
     /**
      * Retrieve funds from mediator accounts that belong to lost swap sessions
      */
     disposeObsoleteMediators(): Promise<void>;
 
+    /**
+     * Retrieve funds from mediator accounts that belong to lost swap sessions
+     * @param source - Initiator account that created a mediator
+     * @param authorization - Authorization callback or secret key
+     * @param [storagePrefix] - Local storage key prefix
+     */
+    static disposeObsoleteMediators(source: string, authorization: ClientAuthorizationParams, storagePrefix?: string): Promise<void>;
+
     /**
      * Create mediator account and deposit tokens to sell
      */

package/src/mediator.js

@@ -5,6 +5,7 @@ import {AuthorizationWrapper} from './authorization.js'
 
 //additional XLM amount to cover tx fees
 const feesReserve = '3'
+const defaultStoragePrefix = 'msb_'
 
 export class Mediator {
     /**
@@ -13,7 +14,7 @@ export class Mediator {
      * @param {string|Asset} sellingAsset - Identifier of the asset to sell
      * @param {string|Asset} buyingAsset - Identifier of the asset to buy
      * @param {string} sellingAmount - Asset amount to sell
-     * @param {ClientAuthorizationParams} authorization - Authorization
+     * @param {ClientAuthorizationParams} authorization - Authorization callback or secret key
      */
     constructor(source, sellingAsset, buyingAsset, sellingAmount, authorization) {
         if (!StrKey.isValidEd25519PublicKey(source))
@@ -81,15 +82,25 @@ export class Mediator {
      * @type {string}
      * @private
      */
-    storagePrefix = 'msb_'
+    storagePrefix = defaultStoragePrefix
 
     /**
      * Check if there are any non-disposed mediators that belong to lost swap sessions
      * @return {boolean}
      */
     get hasObsoleteMediators() {
+        return this.constructor.hasObsoleteMediators(this.source, this.storagePrefix)
+    }
+
+    /**
+     * Check if there are any non-disposed mediators that belong to lost swap sessions
+     * @param {string} source - Initiator account that created a mediator
+     * @param {string} [storagePrefix] - Local storage key prefix
+     * @return {boolean}
+     */
+    static hasObsoleteMediators(source, storagePrefix = defaultStoragePrefix) {
         return Object.entries(localStorage).some(([key, initiator]) =>
-            initiator === this.source && key.startsWith(this.storagePrefix))
+            initiator === source && key.startsWith(storagePrefix))
     }
 
     /**
@@ -104,6 +115,19 @@ export class Mediator {
         }
     }
 
+    /**
+     * Retrieve funds from mediator accounts that belong to lost swap sessions
+     * @param {string} source - Initiator account that created a mediator
+     * @param {ClientAuthorizationParams} authorization - Authorization callback or secret key
+     * @param {string} [storagePrefix] - Local storage key prefix
+     * @return {Promise}
+     */
+    static async disposeObsoleteMediators(source, authorization, storagePrefix = defaultStoragePrefix) {
+        const wrapper = new Mediator(source, 'XLM', 'XLM', '0', authorization)
+        wrapper.storagePrefix = storagePrefix
+        await wrapper.disposeObsoleteMediators()
+    }
+
     /**
      * Create mediator account and deposit tokens to sell
      * @return {Promise<string>} - Newly created mediator secret key
@@ -270,7 +294,7 @@ export class Mediator {
             tx = await this.authorization.authorize(tx)
         }
         //execute the tx
-        const res = await this.createHorizon().submitTransaction(tx, {skipMemoRequiredCheck: true})
+        const res = await this.constructor.createHorizon().submitTransaction(tx, {skipMemoRequiredCheck: true})
         if (!res.successful)
             throw new Error('Failed to create mediator account')
     }
@@ -282,7 +306,7 @@ export class Mediator {
      */
     async loadAccount(address) {
         try {
-            return this.createHorizon().loadAccount(address)
+            return this.constructor.createHorizon().loadAccount(address)
         } catch (e) {
             console.error(e)
         }
@@ -292,7 +316,7 @@ export class Mediator {
      * @return {HorizonServer}
      * @private
      */
-    createHorizon() {
+    static createHorizon() {
         return new Horizon.Server('https://horizon.stellar.org')
     }
 }