Merge pull request #209 from nemtech/dev

Dev -> Main
fboucquez · Mar 24, 2021 · d38463f · d38463f
2 parents 56e7018 + 2f86910
commit d38463f
Show file tree

Hide file tree

Showing 42 changed files with 2,274 additions and 171 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.0.2] - Mar-24-2021
+
+**Milestone**: Mainnet(1.0.0.0)
+
+| Package          | Version | Link                                                               |
+| ---------------- | ------- | ------------------------------------------------------------------ |
+| Symbol Bootstrap | v1.0.2  | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |
+
+-   Fixed link (--unlink) command when voting properties changes.
+-   Broker ports (7902) are closed by default in compose.
+-   Peer role is selected based on `syncsource` configuration and not on the `harvesting` flag.
+
 ## [1.0.1] - Mar-22-2021
 
 **Milestone**: Mainnet(1.0.0.0)

diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ $ npm install -g symbol-bootstrap
 $ symbol-bootstrap COMMAND
 running command...
 $ symbol-bootstrap (-v|--version|version)
-symbol-bootstrap/1.0.1 linux-x64 node-v10.24.0
+symbol-bootstrap/1.0.2 linux-x64 node-v12.18.4
 $ symbol-bootstrap --help [COMMAND]
 USAGE
   $ symbol-bootstrap COMMAND

diff --git a/cmds/link-testnet-supernode-external-node.sh b/cmds/link-testnet-supernode-external-node.sh
@@ -1,2 +1,2 @@
 #!/bin/bash
-symbol-bootstrap link -t target/testnet-supernode --useKnownRestGateways $1 $2 $3 $4
+symbol-bootstrap link -t target/testnet-supernode --useKnownRestGateways $1 $2 $3 $4 $5 $6 $7
diff --git a/docs/clean.md b/docs/clean.md
@@ -21,4 +21,4 @@ EXAMPLE
   $ symbol-bootstrap clean
 ```
 
-_See code: [src/commands/clean.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/clean.ts)_
+_See code: [src/commands/clean.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/clean.ts)_
diff --git a/docs/compose.md b/docs/compose.md
@@ -33,4 +33,4 @@ EXAMPLE
   $ symbol-bootstrap compose
 ```
 
-_See code: [src/commands/compose.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/compose.ts)_
+_See code: [src/commands/compose.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/compose.ts)_
diff --git a/docs/config.md b/docs/config.md
@@ -57,4 +57,4 @@ EXAMPLES
   $ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap config -p testnet -a dual
 ```
 
-_See code: [src/commands/config.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/config.ts)_
+_See code: [src/commands/config.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/config.ts)_
diff --git a/docs/decrypt.md b/docs/decrypt.md
@@ -56,4 +56,4 @@ EXAMPLES
   plain-addresses.yml
 ```
 
-_See code: [src/commands/decrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/decrypt.ts)_
+_See code: [src/commands/decrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/decrypt.ts)_
diff --git a/docs/encrypt.md b/docs/encrypt.md
@@ -46,4 +46,4 @@ EXAMPLES
   encrypted-custom-preset.yml
 ```
 
-_See code: [src/commands/encrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/encrypt.ts)_
+_See code: [src/commands/encrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/encrypt.ts)_
diff --git a/docs/enrolRewardProgram.md b/docs/enrolRewardProgram.md
@@ -47,4 +47,4 @@ EXAMPLES
   $ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap enrolRewardProgram --url http://external-rest:3000
 ```
 
-_See code: [src/commands/enrolRewardProgram.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/enrolRewardProgram.ts)_
+_See code: [src/commands/enrolRewardProgram.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/enrolRewardProgram.ts)_
diff --git a/docs/healthCheck.md b/docs/healthCheck.md
@@ -36,4 +36,4 @@ EXAMPLE
   $ symbol-bootstrap healthCheck
 ```
 
-_See code: [src/commands/healthCheck.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/healthCheck.ts)_
+_See code: [src/commands/healthCheck.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/healthCheck.ts)_
diff --git a/docs/link.md b/docs/link.md
@@ -41,4 +41,4 @@ EXAMPLES
   $ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap link --unlink --useKnownRestGateways
 ```
 
-_See code: [src/commands/link.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/link.ts)_
+_See code: [src/commands/link.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/link.ts)_
diff --git a/docs/report.md b/docs/report.md
@@ -21,4 +21,4 @@ EXAMPLE
   $ symbol-bootstrap report
 ```
 
-_See code: [src/commands/report.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/report.ts)_
+_See code: [src/commands/report.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/report.ts)_
diff --git a/docs/resetData.md b/docs/resetData.md
@@ -21,4 +21,4 @@ EXAMPLE
   $ symbol-bootstrap resetData
 ```
 
-_See code: [src/commands/resetData.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/resetData.ts)_
+_See code: [src/commands/resetData.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/resetData.ts)_
diff --git a/docs/run.md b/docs/run.md
@@ -53,4 +53,4 @@ EXAMPLE
   $ symbol-bootstrap run
 ```
 
-_See code: [src/commands/run.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/run.ts)_
+_See code: [src/commands/run.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/run.ts)_
diff --git a/docs/start.md b/docs/start.md
@@ -89,4 +89,4 @@ EXAMPLES
   $ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap start -p testnet -a dual
 ```
 
-_See code: [src/commands/start.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/start.ts)_
+_See code: [src/commands/start.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/start.ts)_
diff --git a/docs/stop.md b/docs/stop.md
@@ -21,4 +21,4 @@ EXAMPLE
   $ symbol-bootstrap stop
 ```
 
-_See code: [src/commands/stop.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.1/src/commands/stop.ts)_
+_See code: [src/commands/stop.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.2/src/commands/stop.ts)_
diff --git a/presets/mainnet/assembly-api.yml b/presets/mainnet/assembly-api.yml
@@ -10,7 +10,7 @@ nodes:
       databaseHost: 'db'
       brokerName: 'broker'
       openPort: true
-      brokerOpenPort: true
+      brokerOpenPort: false
       trustedHosts: 127.0.0.1, 172.20.0.25
       localNetworks: 127.0.0.1, 172.20.0.25
 gateways:

diff --git a/presets/mainnet/assembly-dual.yml b/presets/mainnet/assembly-dual.yml
@@ -10,7 +10,7 @@ nodes:
       databaseHost: 'db'
       brokerName: 'broker'
       openPort: true
-      brokerOpenPort: true
+      brokerOpenPort: false
       trustedHosts: 127.0.0.1, 172.20.0.25
       localNetworks: 127.0.0.1, 172.20.0.25
 gateways:

diff --git a/presets/testnet/assembly-api.yml b/presets/testnet/assembly-api.yml
@@ -9,7 +9,7 @@ nodes:
       databaseHost: 'db'
       brokerName: 'api-broker'
       openPort: true
-      brokerOpenPort: true
+      brokerOpenPort: false
       trustedHosts: 127.0.0.1, 172.20.0.25
       localNetworks: 127.0.0.1, 172.20.0.25
 gateways:

diff --git a/presets/testnet/assembly-dual.yml b/presets/testnet/assembly-dual.yml
@@ -9,7 +9,7 @@ nodes:
       databaseHost: 'db'
       brokerName: 'api-broker'
       openPort: true
-      brokerOpenPort: true
+      brokerOpenPort: false
       trustedHosts: 127.0.0.1, 172.20.0.25
       localNetworks: 127.0.0.1, 172.20.0.25
 gateways:

diff --git a/src/model/ConfigPreset.ts b/src/model/ConfigPreset.ts
@@ -25,6 +25,10 @@ export enum PrivateKeySecurityMode {
     PROMPT_ALL = 'PROMPT_ALL',
 }
 
+export type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+
 export interface DockerServicePreset {
     ipv4_address?: string;
     openPort?: boolean | number | string;
@@ -71,6 +75,16 @@ export interface NodePreset extends DockerServicePreset {
     api: boolean;
     voting: boolean;
 
+    syncsource: boolean;
+    filespooling: boolean;
+    partialtransaction: boolean;
+    sinkType: 'Async' | 'Sync';
+    enableSingleThreadPool: boolean;
+    addressextraction: boolean;
+    mongo: boolean;
+    zeromq: boolean;
+    enableAutoSyncCleanup: boolean;
+
     // At least these properties.
     // If true, harvesterSigningPrivateKey != mainPrivateKey and harvesterSigningPrivateKey will be linked to mainPrivateKey
     serverVersion?: string;

diff --git a/src/service/BootstrapService.ts b/src/service/BootstrapService.ts
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { Addresses, ConfigPreset } from '../model';
-import { DockerCompose } from '../model/DockerCompose';
+import { Addresses, ConfigPreset, DockerCompose } from '../model';
+import { BootstrapUtils } from './BootstrapUtils';
 import { ComposeParams, ComposeService } from './ComposeService';
 import { ConfigParams, ConfigResult, ConfigService } from './ConfigService';
 import { LinkParams, LinkService } from './LinkService';
@@ -29,7 +29,7 @@ export type StartParams = ConfigParams & ComposeParams & RunParams;
  * Main entry point for API integration.
  */
 export class BootstrapService {
-    public constructor(private readonly root: string = './node_modules/symbol-bootstrap') {}
+    public constructor(private readonly root: string = BootstrapUtils.DEFAULT_ROOT_FOLDER) {}
 
     /**
      * It generates the configuration and nemesis for the provided preset

diff --git a/src/service/BootstrapUtils.ts b/src/service/BootstrapUtils.ts
@@ -76,6 +76,7 @@ export class BootstrapUtils {
     private static readonly pulledImages: string[] = [];
 
     public static readonly VERSION = version;
+    public static readonly DEFAULT_ROOT_FOLDER = BootstrapUtils.resolveRootFolder();
 
     public static stopProcess = false;
 

diff --git a/src/service/ConfigLoader.ts b/src/service/ConfigLoader.ts
@@ -20,7 +20,16 @@ import { Account, Address, Convert, Crypto, MosaicId, MosaicNonce, NetworkType,
 import { LogType } from '../logger';
 import Logger from '../logger/Logger';
 import LoggerFactory from '../logger/LoggerFactory';
-import { Addresses, ConfigAccount, ConfigPreset, MosaicAccounts, NodeAccount, NodePreset, PrivateKeySecurityMode } from '../model';
+import {
+    Addresses,
+    ConfigAccount,
+    ConfigPreset,
+    DeepPartial,
+    MosaicAccounts,
+    NodeAccount,
+    NodePreset,
+    PrivateKeySecurityMode,
+} from '../model';
 import { BootstrapUtils, KnownError, Migration, Password } from './BootstrapUtils';
 import { CommandUtils } from './CommandUtils';
 import { KeyName, Preset } from './ConfigService';
@@ -371,63 +380,60 @@ export class ConfigLoader {
 
     public dynamicDefaultNodeConfiguration(nodes?: NodePreset[]): NodePreset[] {
         return _.map(nodes || [], (node) => {
-            const roles = this.resolveRoles(node);
-            if (node.harvesting && node.api) {
-                return {
-                    syncsource: true,
-                    filespooling: true,
-                    partialtransaction: true,
-                    openPort: true,
-                    sinkType: 'Async',
-                    enableSingleThreadPool: false,
-                    brokerOpenPort: true,
-                    addressextraction: true,
-                    enableAutoSyncCleanup: false,
-                    mongo: true,
-                    zeromq: true,
-                    ...node,
-                    roles,
-                };
-            }
-            if (node.api) {
-                return {
-                    sinkType: 'Async',
-                    syncsource: false,
-                    filespooling: true,
-                    partialtransaction: true,
-                    enableSingleThreadPool: false,
-                    addressextraction: true,
-                    mongo: true,
-                    zeromq: true,
-                    enableAutoSyncCleanup: false,
-                    ...node,
-                    roles,
-                };
-            }
+            const expandedNodeConfiguration = { ...this.getDefaultConfiguration(node), ...node };
+            const roles = this.resolveRoles(expandedNodeConfiguration);
+            return { ...expandedNodeConfiguration, roles };
+        });
+    }
 
-            //peer only (harvesting or not).
+    private getDefaultConfiguration(node: NodePreset): DeepPartial<NodePreset> {
+        if (node.harvesting && node.api) {
             return {
-                sinkType: 'Sync',
-                enableSingleThreadPool: true,
-                addressextraction: false,
-                mongo: false,
-                zeromq: false,
                 syncsource: true,
-                filespooling: false,
-                enableAutoSyncCleanup: true,
-                partialtransaction: false,
-                ...node,
-                roles,
+                filespooling: true,
+                partialtransaction: true,
+                openPort: true,
+                sinkType: 'Async',
+                enableSingleThreadPool: false,
+                addressextraction: true,
+                enableAutoSyncCleanup: false,
+                mongo: true,
+                zeromq: true,
             };
-        });
+        }
+        if (node.api) {
+            return {
+                sinkType: 'Async',
+                syncsource: false,
+                filespooling: true,
+                partialtransaction: true,
+                enableSingleThreadPool: false,
+                addressextraction: true,
+                mongo: true,
+                zeromq: true,
+                enableAutoSyncCleanup: false,
+            };
+        }
+        //peer only (harvesting or not).
+        return {
+            sinkType: 'Sync',
+            enableSingleThreadPool: true,
+            addressextraction: false,
+            mongo: false,
+            zeromq: false,
+            syncsource: true,
+            filespooling: false,
+            enableAutoSyncCleanup: true,
+            partialtransaction: false,
+        };
     }
 
     private resolveRoles(nodePreset: NodePreset): string {
         if (nodePreset.roles) {
             return nodePreset.roles;
         }
         const roles: string[] = [];
-        if (nodePreset.harvesting) {
+        if (nodePreset.syncsource) {
             roles.push('Peer');
         }
         if (nodePreset.api) {

diff --git a/src/service/ConfigService.ts b/src/service/ConfigService.ts
@@ -382,7 +382,7 @@ export class ConfigService {
             presetData.peersP2PListLimit,
             serverConfig,
             NodeType.PEER_NODE,
-            (nodePresetData) => nodePresetData.harvesting && nodePresetData != nodePreset,
+            (nodePresetData) => nodePresetData.syncsource && nodePresetData != nodePreset,
             'peers-p2p.json',
         );
         const peersApiFile = await this.generateP2PFile(