feat: add method to iterate over all registered nano contracts on storage (#654)

Author: pedroferreira1

__tests__/storage/storage.test.js

@@ -64,6 +64,13 @@ describe('handleStop', () => {
       outputs: [],
     });
     await storage.registerToken(testToken);
+    const testNano = {
+      ncId: 'abc',
+      address: 'nanoAddress',
+      blueprintId: 'blueprintId',
+      blueprintName: 'blueprintName',
+    };
+    await storage.registerNanoContract('abc', testNano);
     // We have 1 transaction
     await expect(store.historyCount()).resolves.toEqual(1);
     // 20 addresses
@@ -72,6 +79,10 @@ describe('handleStop', () => {
     let tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
+    // And 1 registered nano contract
+    let nanos = await toArray(storage.getRegisteredNanoContracts());
+    expect(nanos).toHaveLength(1);
+    expect(nanos[0]).toEqual(testNano);
 
     storage.version = 'something';
     // handleStop with defaults
@@ -82,19 +93,27 @@ describe('handleStop', () => {
     await expect(store.historyCount()).resolves.toEqual(1);
     await expect(store.addressCount()).resolves.toEqual(20);
     await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeTruthy();
+    await expect(store.isNanoContractRegistered(testNano.ncId)).resolves.toBeTruthy();
     tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
+    nanos = await toArray(storage.getRegisteredNanoContracts());
+    expect(nanos).toHaveLength(1);
+    expect(nanos[0]).toEqual(testNano);
 
     // handleStop with cleanStorage = true
     await storage.handleStop({ cleanStorage: true });
     // 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();
+    await expect(store.isNanoContractRegistered(testNano.ncId)).resolves.toBeTruthy();
     tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
+    nanos = await toArray(storage.getRegisteredNanoContracts());
+    expect(nanos).toHaveLength(1);
+    expect(nanos[0]).toEqual(testNano);
 
     await storage.addTx({
       tx_id: 'another-new-tx',
@@ -109,9 +128,13 @@ describe('handleStop', () => {
     await expect(store.historyCount()).resolves.toEqual(1);
     await expect(store.addressCount()).resolves.toEqual(0);
     await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeTruthy();
+    await expect(store.isNanoContractRegistered(testNano.ncId)).resolves.toBeTruthy();
     tokens = await toArray(storage.getRegisteredTokens());
     expect(tokens).toHaveLength(1);
     expect(tokens[0]).toEqual(testToken);
+    nanos = await toArray(storage.getRegisteredNanoContracts());
+    expect(nanos).toHaveLength(1);
+    expect(nanos[0]).toEqual(testNano);
 
     // handleStop with cleanAddresses = true
     await loadAddresses(0, 20, storage);
@@ -120,6 +143,12 @@ describe('handleStop', () => {
     await expect(store.historyCount()).resolves.toEqual(1);
     await expect(store.addressCount()).resolves.toEqual(20);
     await expect(store.isTokenRegistered(testToken.uid)).resolves.toBeFalsy();
+    await expect(store.isNanoContractRegistered(testNano.ncId)).resolves.toBeFalsy();
+
+    tokens = await toArray(storage.getRegisteredTokens());
+    expect(tokens).toHaveLength(0);
+    nanos = await toArray(storage.getRegisteredNanoContracts());
+    expect(nanos).toHaveLength(0);
 
     // Access data is untouched when stopping the wallet
     // XXX: since we stringify to save on store, the optional undefined properties are removed

src/storage/leveldb/nanocontract_index.ts

@@ -68,6 +68,19 @@ export default class LevelNanoContractIndex implements IKVNanoContractIndex {
     return nc !== null;
   }
 
+  /**
+   * Iterate over all registered nano contracts in the database
+   *
+   * @async
+   * @generator
+   * @returns {AsyncGenerator<INcData>}
+   */
+  async *registeredNanoContractsIter(): AsyncGenerator<INcData> {
+    for await (const ncData of this.registeredDB.values()) {
+      yield ncData;
+    }
+  }
+
   /**
    * Get a nano contract data on database from the ncId.
    *

src/storage/leveldb/store.ts

@@ -386,6 +386,19 @@ export default class LevelDBStore implements IStore {
     return this.nanoContractIndex.isNanoContractRegistered(ncId);
   }
 
+  /**
+   * Iterate over all registered nano contracts in the database
+   *
+   * @async
+   * @generator
+   * @returns {AsyncGenerator<INcData>}
+   */
+  async *registeredNanoContractsIter(): AsyncGenerator<INcData> {
+    for await (const ncData of this.nanoContractIndex.registeredNanoContractsIter()) {
+      yield ncData;
+    }
+  }
+
   /**
    * Get a nano contract data on storage from the ncId.
    *

src/storage/memory_store.ts

@@ -907,6 +907,19 @@ export class MemoryStore implements IStore {
     return this.registeredNanoContracts.has(ncId);
   }
 
+  /**
+   * Iterate on registered nano contracts.
+   *
+   * @async
+   * @generator
+   * @returns {AsyncGenerator<INcData>}
+   */
+  async *registeredNanoContractsIter(): AsyncGenerator<INcData> {
+    for (const ncData of this.registeredNanoContracts.values()) {
+      yield ncData;
+    }
+  }
+
   /**
    * Get a nano contract data on storage from the ncId.
    *

src/storage/storage.ts

@@ -985,6 +985,19 @@ export class Storage implements IStorage {
     return this.store.isNanoContractRegistered(ncId);
   }
 
+  /**
+   * Iterate on all registered nano contracts of the wallet.
+   *
+   * @async
+   * @generator
+   * @returns {AsyncGenerator<INcData>}
+   */
+  async *getRegisteredNanoContracts(): AsyncGenerator<INcData> {
+    for await (const ncData of this.store.registeredNanoContractsIter()) {
+      yield ncData;
+    }
+  }
+
   /**
    * Get nano contract data.
    * @param ncId Nano Contract ID.

src/types.ts

@@ -401,6 +401,7 @@ export interface IStore {
 
   // Nano Contract methods
   isNanoContractRegistered(ncId: string): Promise<boolean>;
+  registeredNanoContractsIter(): AsyncGenerator<INcData>;
   getNanoContract(ncId: string): Promise<INcData | null>;
   registerNanoContract(ncId: string, ncValue: INcData): Promise<void>;
   unregisterNanoContract(ncId: string): Promise<void>;
@@ -595,6 +596,7 @@ export interface IKVNanoContractIndex extends IKVStoreIndex<void> {
 
 export interface INcData {
   ncId: string;
+  address: string;
   blueprintId: string;
   blueprintName: string;
 }