feat: add cleanTokens to new/wallet (#648)

* feat: add cleanTokens to new/wallet

* test: add cleanTokens test to handleStop

* chore: increase timeout

Author: alexruzenhack

__tests__/storage/storage.test.js

@@ -36,13 +36,13 @@ describe('handleStop', () => {
   it('should work with memory store', async () => {
     const store = new MemoryStore();
     await handleStopTest(store);
-  }, 10000);
+  }, 20000);
 
   it('should work with leveldb store', async () => {
     const walletId = walletUtils.getWalletIdFromXPub(accessData.xpubkey);
     const store = new LevelDBStore(walletId, DATA_DIR);
     await handleStopTest(store);
-  }, 10000);
+  }, 20000);
 
   /**
    * @param {IStore} store
@@ -81,6 +81,7 @@ describe('handleStop', () => {
     // Nothing changed in the store
     await expect(store.historyCount()).resolves.toEqual(1);
     await expect(store.addressCount()).resolves.toEqual(20);
+    await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeTruthy();
     tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
@@ -90,6 +91,7 @@ describe('handleStop', () => {
     // Will clean the history bit not addresses or registered tokens
     await expect(store.historyCount()).resolves.toEqual(0);
     await expect(store.addressCount()).resolves.toEqual(20);
+    await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeTruthy();
     tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
@@ -106,10 +108,19 @@ describe('handleStop', () => {
     // Will clean the history bit not addresses
     await expect(store.historyCount()).resolves.toEqual(1);
     await expect(store.addressCount()).resolves.toEqual(0);
+    await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeTruthy();
     tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
 
+    // handleStop with cleanAddresses = true
+    await loadAddresses(0, 20, storage);
+    await storage.handleStop({ cleanTokens: true });
+    // Will clean the history bit not addresses
+    await expect(store.historyCount()).resolves.toEqual(1);
+    await expect(store.addressCount()).resolves.toEqual(20);
+    await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeFalsy();
+
     // Access data is untouched when stopping the wallet
     // XXX: since we stringify to save on store, the optional undefined properties are removed
     // Since they are optional and unset, we can safely remove them from the expected value

src/new/wallet.js

@@ -1450,11 +1450,11 @@ class HathorWallet extends EventEmitter {
   /**
    * Close the connections and stop emitting events.
    */
-  async stop({ cleanStorage = true, cleanAddresses = false } = {}) {
+  async stop({ cleanStorage = true, cleanAddresses = false, cleanTokens = false } = {}) {
     this.setState(HathorWallet.CLOSED);
     this.removeAllListeners();
 
-    await this.storage.handleStop({connection: this.conn, cleanStorage, cleanAddresses});
+    await this.storage.handleStop({connection: this.conn, cleanStorage, cleanAddresses, cleanTokens});
 
     this.firstConnection = true;
     this.walletStopped = true;

src/storage/storage.ts

@@ -814,19 +814,24 @@ export class Storage implements IStorage {
 
   /**
    * Handle storage operations for a wallet being stopped.
-   * @param {{connection?: FullNodeConnection, cleanStorage?: boolean, cleanAddresses?: boolean}} Options to handle stop
+   * @param {{
+   *   connection?: FullNodeConnection;
+   *   cleanStorage?: boolean;
+   *   cleanAddresses?: boolean;
+   *   cleanTokens?: boolean;
+   * }} Options to handle stop
    * @returns {Promise<void>}
    */
-  async handleStop({connection, cleanStorage = false, cleanAddresses = false}: {connection?: FullNodeConnection, cleanStorage?: boolean, cleanAddresses?: boolean} = {}): Promise<void> {
+  async handleStop({connection, cleanStorage = false, cleanAddresses = false, cleanTokens = false}: {connection?: FullNodeConnection, cleanStorage?: boolean, cleanAddresses?: boolean, cleanTokens?: boolean} = {}): Promise<void> {
     if (connection) {
       for await (const addressInfo of this.getAllAddresses()) {
         connection.unsubscribeAddress(addressInfo.base58);
       }
       connection.removeMetricsHandlers();
     }
     this.version = null;
-    if (cleanStorage || cleanAddresses) {
-      await this.cleanStorage(cleanStorage, cleanAddresses);
+    if (cleanStorage || cleanAddresses || cleanTokens) {
+      await this.cleanStorage(cleanStorage, cleanAddresses, cleanTokens);
     }
   }