Multisig multilevel subscription (#800)

bassemmagdy · web-flow · commit 2630c1f6ac79 · 2021-08-06T15:47:08.000+01:00
* fix #798 - fixed multilevel multisig description. - updated rxjs version. * clean package.json * update function return type and add docs * fix sonarcloud bugs * add type for multisig children tree * refactor and adding docs * linting
diff --git a/.DS_Store b/.DS_Store
diff --git a/.npmignore b/.npmignore
@@ -15,3 +15,4 @@ ts-docs/
 .travis
 *.iml
 *.log
+.npm-pack-all-tmp
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -110,7 +110,7 @@
         "minimist": "^1.2.5",
         "node-fetch": "^2.6.0",
         "ripemd160": "^2.0.2",
-        "rxjs": "^6.6.3",
+        "rxjs": "^6.6.7",
         "rxjs-compat": "^6.6.3",
         "symbol-openapi-typescript-fetch-client": "1.0.1-SNAPSHOT.202106160954",
         "tweetnacl": "^1.0.3",
diff --git a/src/core/format/Utilities.ts b/src/core/format/Utilities.ts
@@ -173,3 +173,18 @@ export const decodeBlock = (input: any, inputOffset: number, output: any, output
     output[outputOffset + 3] = ((bytes[4] & 0x01) << 7) | (bytes[5] << 2) | (bytes[6] >> 3);
     output[outputOffset + 4] = ((bytes[6] & 0x07) << 5) | bytes[7];
 };
+
+/**
+ * Traverses the tree object to pick addresses strings.
+ * @param {array} array of multisig children
+ * @param {parse} function to parse tree and pick children addresses
+ */
+export const parseObjectProperties = (obj: [], parse): any => {
+    for (const k in obj) {
+        if (typeof obj[k] === 'object' && obj[k] !== null) {
+            parseObjectProperties(obj[k], parse);
+        } else if (Object.prototype.hasOwnProperty.call(obj, k)) {
+            parse(k, obj[k]);
+        }
+    }
+};
diff --git a/src/core/utils/MultisigGraphUtils.ts b/src/core/utils/MultisigGraphUtils.ts
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2020 NEM
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { MultisigAccountGraphInfo } from '../../model/account/MultisigAccountGraphInfo';
+import { MultisigAccountInfo } from '../../model/account/MultisigAccountInfo';
+
+/**
+ * MultisigGraph utilities
+ */
+
+// Type for Multisig Tree children Object
+export type MultisigChildrenTreeObject = {
+    address: string;
+    children: []; // children array.
+};
+
+export class MultisigGraphUtils {
+    /**
+     * creates a structred Tree object containing Current multisig account with children
+     * @param {MultisigAccountInfo[][]} multisigEnteries
+     * @returns {MultisigChildrenTreeObject[]} Array of multisigChildrentTree objects
+     */
+    public static getMultisigChildren(multisigAccountGraphInfoMapped: MultisigAccountInfo[][]): MultisigChildrenTreeObject[] {
+        if (multisigAccountGraphInfoMapped) {
+            const mappedTree: MultisigChildrenTreeObject[] = [];
+            multisigAccountGraphInfoMapped.forEach((level: MultisigAccountInfo[]) => {
+                level.forEach((entry: MultisigAccountInfo) => {
+                    mappedTree.push({
+                        address: entry.accountAddress.plain(),
+                        children: [],
+                    });
+                    // find the entry matching with address matching cosignatory address and update his children
+                    const updateRecursively = (address: string, object: MultisigChildrenTreeObject) => (obj): any => {
+                        if (obj.address === address) {
+                            obj.children.push(object);
+                        } else if (obj.children) {
+                            obj.children.forEach(updateRecursively(address, object));
+                        }
+                    };
+                    entry.cosignatoryAddresses.forEach((addressVal) => {
+                        mappedTree.forEach(
+                            updateRecursively(addressVal['address'], {
+                                address: entry.accountAddress.plain(),
+                                children: [],
+                            }),
+                        );
+                    });
+                });
+            });
+            return mappedTree;
+        }
+        return [];
+    }
+    /**
+     * sort entries based on tree hierarchy from top to bottom
+     * @param {Map<number, MultisigAccountInfo[]>} multisigEnteries
+     * @returns {MultisigAccountInfo[]}  sorted multisig graph
+     */
+    private static getMultisigGraphArraySorted(multisigEntries: Map<number, MultisigAccountInfo[]>): MultisigAccountInfo[][] {
+        return [...multisigEntries.keys()]
+            .sort((a, b) => b - a) // Get addresses from top to bottom
+            .map((key) => multisigEntries.get(key) || [])
+            .filter((x) => x.length > 0);
+    }
+    /**
+     * returns sorted tree entries
+     * @param {MultisigAccountGraphInfo} graphInfo
+     * @returns {MultisigAccountInfo[][]}  array of sorted multisigInfo
+     */
+    public static getMultisigInfoFromMultisigGraphInfo(graphInfo: MultisigAccountGraphInfo): MultisigAccountInfo[][] {
+        const { multisigEntries } = graphInfo;
+        return [...this.getMultisigGraphArraySorted(multisigEntries)].map((item) => item);
+    }
+}
diff --git a/src/core/utils/index.ts b/src/core/utils/index.ts
@@ -2,5 +2,6 @@
 
 export * from './DtoMapping';
 export * from './LockHashUtils';
+export * from './MultisigGraphUtils';
 export * from './TransactionMapping';
 export * from './UnresolvedMapping';
diff --git a/src/infrastructure/Listener.ts b/src/infrastructure/Listener.ts
@@ -18,7 +18,9 @@ import { Observable, of, Subject } from 'rxjs';
 import { catchError, distinctUntilChanged, filter, map, mergeMap, share, switchMap } from 'rxjs/operators';
 import { BlockInfoDTO } from 'symbol-openapi-typescript-fetch-client';
 import * as WebSocket from 'ws';
-import { UnresolvedAddress } from '../model';
+import { parseObjectProperties } from '../core/format/Utilities';
+import { MultisigChildrenTreeObject, MultisigGraphUtils } from '../core/utils';
+import { MultisigAccountInfo, UnresolvedAddress } from '../model';
 import { Address } from '../model/account/Address';
 import { PublicAccount } from '../model/account/PublicAccount';
 import { FinalizedBlock } from '../model/blockchain/FinalizedBlock';
@@ -34,7 +36,6 @@ import { MultisigHttp } from './MultisigHttp';
 import { MultisigRepository } from './MultisigRepository';
 import { NamespaceRepository } from './NamespaceRepository';
 import { CreateTransactionFromDTO } from './transaction/CreateTransactionFromDTO';
-
 export enum ListenerChannelName {
     block = 'block',
     confirmedAdded = 'confirmedAdded',
@@ -596,9 +597,18 @@ export class Listener implements IListener {
         }
         return this.getResolvedAddress(cosigner).pipe(
             mergeMap((address: Address) => {
-                return this.multisigRepository!.getMultisigAccountInfo(address).pipe(
+                return this.multisigRepository!.getMultisigAccountGraphInfo(address).pipe(
                     map((multisigInfo) => {
-                        const subscribers = [cosigner].concat(multisigInfo.multisigAddresses);
+                        const multisigGraphInfo: MultisigAccountInfo[][] = MultisigGraphUtils.getMultisigInfoFromMultisigGraphInfo(
+                            multisigInfo,
+                        );
+                        const multisigChildren: MultisigChildrenTreeObject[] = MultisigGraphUtils.getMultisigChildren(multisigGraphInfo);
+                        const subscribers: Address[] = [address];
+                        if (!!multisigChildren.length && multisigChildren[0].children) {
+                            parseObjectProperties(multisigChildren[0].children, (k, prop: string) => {
+                                subscribers.push(Address.createFromRawAddress(prop));
+                            });
+                        }
                         subscribers.forEach((m) => {
                             this.subscribeTo(`${channel.toString()}/${m.plain()}`);
                         });
diff --git a/test/infrastructure/Listener.spec.ts b/test/infrastructure/Listener.spec.ts
@@ -18,7 +18,7 @@ import { deepEqual } from 'assert';
 import { expect } from 'chai';
 import { Observable, of as observableOf } from 'rxjs';
 import { deepEqual as deepEqualParam, instance, mock, verify, when } from 'ts-mockito';
-import { UnresolvedAddress } from '../../src';
+import { MultisigAccountGraphInfo, UnresolvedAddress } from '../../src';
 import { Listener, ListenerChannelName } from '../../src/infrastructure/Listener';
 import { MultisigRepository } from '../../src/infrastructure/MultisigRepository';
 import { NamespaceRepository } from '../../src/infrastructure/NamespaceRepository';
@@ -43,7 +43,29 @@ describe('Listener', () => {
         '26b64cb10f005e5988a36744ca19e20d835ccc7c105aaa5f3b212da593180930',
         NetworkType.PRIVATE_TEST,
     );
+    const account1 = Address.createFromPublicKey(
+        '68B3FBB18729C1FDE225C57F8CE080FA828F0067E451A3FD81FA628842B0B763',
+        NetworkType.PRIVATE_TEST,
+    );
+    const account2 = Address.createFromPublicKey(
+        'DAB1C38C3E1642494FCCB33138B95E81867B5FB59FC4277A1D53761C8B9F6D14',
+        NetworkType.PRIVATE_TEST,
+    );
+
+    const account3 = Address.createFromPublicKey(
+        '1674016C27FE2C2EB5DFA73996FA54A183B38AED0AA64F756A3918BAF08E061B',
+        NetworkType.PRIVATE_TEST,
+    );
+
+    const multisig1 = Address.createFromPublicKey(
+        'B694186EE4AB0558CA4AFCFDD43B42114AE71094F5A1FC4A913FE9971CACD21D',
+        NetworkType.PRIVATE_TEST,
+    );
 
+    const multisig2 = Address.createFromPublicKey(
+        'CF893FFCC47C33E7F68AB1DB56365C156B0736824A0C1E273F9E00B8DF8F01EB',
+        NetworkType.PRIVATE_TEST,
+    );
     let namespaceRepoMock: NamespaceRepository;
     let namespaceRepo: NamespaceRepository;
     let multisigRepoMock: MultisigRepository;
@@ -57,6 +79,14 @@ describe('Listener', () => {
         multisigRepo = instance(multisigRepoMock);
     });
 
+    function givenMultisig2AccountGraphInfo(): MultisigAccountGraphInfo {
+        const map = new Map<number, MultisigAccountInfo[]>();
+        map.set(0, [new MultisigAccountInfo(1, multisig2, 2, 1, [multisig1, account1], [])]).set(1, [
+            new MultisigAccountInfo(1, multisig1, 1, 1, [account2, account3], [multisig2]),
+        ]);
+
+        return new MultisigAccountGraphInfo(map);
+    }
     it('should createComplete a WebSocket instance given url parameter', () => {
         const listener = new Listener('http://localhost:3000/ws', namespaceRepo, epochAdjustment);
         expect('http://localhost:3000/ws').to.be.equal(listener.url);
@@ -215,7 +245,6 @@ describe('Listener', () => {
 
     [ListenerChannelName.confirmedAdded, ListenerChannelName.partialAdded, ListenerChannelName.unconfirmedAdded].forEach((name) => {
         const subscribedAddress = account.address;
-        const multisigAccount = Account.generateNewAccount(NetworkType.PRIVATE_TEST);
         class WebSocketMock {
             constructor(public readonly url: string) {}
             send(payload: string): void {
@@ -259,14 +288,15 @@ describe('Listener', () => {
         describe(`${name} transaction subscription`, () => {
             it('subscribe multsig', () => {
                 const alias = new NamespaceId('test');
-                const multisigInfo = new MultisigAccountInfo(1, subscribedAddress, 1, 1, [], [multisigAccount.address]);
-                when(multisigRepoMock.getMultisigAccountInfo(deepEqualParam(subscribedAddress))).thenReturn(observableOf(multisigInfo));
-                when(namespaceRepoMock.getAccountsNames(deepEqualParam([subscribedAddress]))).thenReturn(
-                    observableOf([new AccountNames(subscribedAddress, [new NamespaceName(alias, 'test')])]),
+                when(multisigRepoMock.getMultisigAccountGraphInfo(deepEqualParam(account2))).thenReturn(
+                    observableOf(givenMultisig2AccountGraphInfo()),
+                );
+                when(namespaceRepoMock.getAccountsNames(deepEqualParam([account2]))).thenReturn(
+                    observableOf([new AccountNames(account2, [new NamespaceName(alias, 'test')])]),
                 );
                 const transferTransaction = TransferTransaction.create(
                     Deadline.create(epochAdjustment),
-                    multisigAccount.address,
+                    multisig2,
                     [],
                     PlainMessage.create('test-message'),
                     NetworkType.PRIVATE_TEST,
@@ -277,7 +307,7 @@ describe('Listener', () => {
 
                 const listener = new Listener('http://localhost:3000', namespaceRepo, WebSocketMultisigMock, multisigRepo);
                 listener.open();
-                subscriptionMethod(listener, subscribedAddress, hash, true).subscribe();
+                subscriptionMethod(listener, account2, hash, true).subscribe();
 
                 listener.handleMessage(
                     {
@@ -377,8 +407,6 @@ describe('Listener', () => {
             });
 
             it('Using invalid no hash', () => {
-                const subscribedAddress = account.address;
-
                 const alias = new NamespaceId('test');
                 const transferTransaction = TransferTransaction.create(
                     Deadline.create(epochAdjustment),
@@ -511,7 +539,6 @@ describe('Listener', () => {
 
     [ListenerChannelName.unconfirmedRemoved, ListenerChannelName.partialRemoved].forEach((name) => {
         const subscribedAddress = account.address;
-        const multisigAccount = Account.generateNewAccount(NetworkType.PRIVATE_TEST);
         class WebSocketMock {
             constructor(public readonly url: string) {}
             send(payload: string): void {
@@ -539,20 +566,20 @@ describe('Listener', () => {
 
         describe(`${name} transaction subscription`, () => {
             it('subscribe multsig', () => {
-                const multisigInfo = new MultisigAccountInfo(1, subscribedAddress, 1, 1, [], [multisigAccount.address]);
-                when(multisigRepoMock.getMultisigAccountInfo(deepEqualParam(subscribedAddress))).thenReturn(observableOf(multisigInfo));
+                when(multisigRepoMock.getMultisigAccountGraphInfo(deepEqualParam(account2))).thenReturn(
+                    observableOf(givenMultisig2AccountGraphInfo()),
+                );
                 const hash = 'abc';
                 const message = {
-                    topic: `${name.toString()}/${subscribedAddress.plain()}`,
+                    topic: `${name.toString()}/${account2.plain()}`,
                     data: { meta: { height: '1', hash: hash } },
                 };
 
                 const listener = new Listener('http://localhost:3000', namespaceRepo, WebSocketMultisigMock, multisigRepo);
                 listener.open();
-                subscriptionMethod(listener, subscribedAddress, hash, true).subscribe();
+                subscriptionMethod(listener, account2, hash, true).subscribe();
 
                 listener.handleMessage(message, null);
-
                 expect(multisigIndex).to.be.equal(2);
             });
         });

-Original file line number
+Diff line change
 .travis
 *.iml
 *.log
 +.npm-pack-all-tmp