Merge pull request #238 from nemtech/dev

Dev -> Main
fboucquez · Jun 8, 2021 · 43e8090 · 43e8090
2 parents 7c297af + cf022c9
commit 43e8090
Show file tree

Hide file tree

Showing 82 changed files with 1,203 additions and 332 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+/test/reports/**/*.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,20 @@ 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.5] - NEXT
+## [1.0.6] - Next
+
+**Milestone**: Mainnet(1.0.0.0)
+
+| Package          | Version | Link                                                               |
+| ---------------- | ------- | ------------------------------------------------------------------ |
+| Symbol Bootstrap | v1.0.6  | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |
+
+-   Reward Program Agent `2.0.0` upgrade.
+-   Added `MonitorOnly` reward program.
+-   The `link` and `enrollRewardProgram` commands allow `--customPreset` to avoid password prompt when main private key is not stored in the target folder. 
+-   Symbol rest `3.5.6` upgrade.
+
+## [1.0.5] - May-3-2021
 
 **Milestone**: Mainnet(1.0.0.0)
 

diff --git a/README.md b/README.md
@@ -135,7 +135,7 @@ $ npm install -g symbol-bootstrap
 $ symbol-bootstrap COMMAND
 running command...
 $ symbol-bootstrap (-v|--version|version)
-symbol-bootstrap/1.0.5 linux-x64 node-v12.22.1
+symbol-bootstrap/1.0.6 linux-x64 node-v12.22.1
 $ symbol-bootstrap --help [COMMAND]
 USAGE
   $ symbol-bootstrap COMMAND

diff --git a/config/rest-gateway/rest.json.mustache b/config/rest-gateway/rest.json.mustache
@@ -9,19 +9,7 @@
     "allowedHosts": ["*"],
     "allowedMethods": ["GET", "POST", "PUT", "OPTIONS"]
   },
-  "extensions": [
-    "accountLink",
-    "aggregate",
-    "lockHash",
-    "lockSecret",
-    "mosaic",
-    "metadata",
-    "multisig",
-    "namespace",
-    "receipts",
-    "restrictions",
-    "transfer"
-  ],
+  "extensions": {{{toJson (splitCsv restExtensions)}}},
   "db": {
     "url": "mongodb://{{{databaseHost}}}:27017/",
     "name": "catapult",
@@ -79,5 +67,11 @@
     }
   },
 
-  "numBlocksTransactionFeeStats": 300
+  "numBlocksTransactionFeeStats": 300,
+
+  "deployment": {
+    "deploymentTool": "{{{restDeploymentTool}}}",
+    "deploymentToolVersion": "{{{restDeploymentToolVersion}}}",
+    "lastUpdatedDate": "{{{restDeploymentToolLastUpdatedDate}}}"
+  }
 }
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.5/src/commands/clean.ts)_
+_See code: [src/commands/clean.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/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.5/src/commands/compose.ts)_
+_See code: [src/commands/compose.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/compose.ts)_
diff --git a/docs/config.md b/docs/config.md
@@ -18,7 +18,6 @@ OPTIONS
                                             resolved from the target/preset.yml file.
 
   -c, --customPreset=customPreset           External preset file. Values in this file will override the provided presets
-                                            (optional)
 
   -h, --help                                It shows the help of this command.
 
@@ -59,4 +58,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.5/src/commands/config.ts)_
+_See code: [src/commands/config.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/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.5/src/commands/decrypt.ts)_
+_See code: [src/commands/decrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/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.5/src/commands/encrypt.ts)_
+_See code: [src/commands/encrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/encrypt.ts)_
diff --git a/docs/enrollRewardProgram.md b/docs/enrollRewardProgram.md
@@ -16,25 +16,32 @@ USAGE
   $ symbol-bootstrap enrollRewardProgram
 
 OPTIONS
-  -h, --help              It shows the help of this command.
-  -t, --target=target     [default: target] The target folder where the symbol-bootstrap network is generated
-  -u, --url=url           [default: http://localhost:3000] the network url
+  -c, --customPreset=customPreset  This command uses the encrypted addresses.yml to resolve the main private key. If the
+                                   main private is only stored in the custom preset, you can provide it using this
+                                   param. Otherwise, the command may ask for it when required.
 
-  --maxFee=maxFee         the max fee used when announcing (absolute). The node min multiplier will be used if it is not
-                          provided.
+  -h, --help                       It shows the help of this command.
 
-  --noPassword            When provided, Bootstrap will not use a password, so private keys will be stored in plain
-                          text. Use with caution.
+  -t, --target=target              [default: target] The target folder where the symbol-bootstrap network is generated
 
-  --password=password     A password used to encrypt and decrypt private keys in preset files like addresses.yml and
-                          preset.yml. Bootstrap prompts for a password by default, can be provided in the command line
-                          (--password=XXXX) or disabled in the command line (--noPassword).
+  -u, --url=url                    [default: http://localhost:3000] the network url
 
-  --ready                 If --ready is provided, the command will not ask for confirmation when announcing
-                          transactions.
+  --maxFee=maxFee                  the max fee used when announcing (absolute). The node min multiplier will be used if
+                                   it is not provided.
 
-  --useKnownRestGateways  Use the best NEM node available when announcing. Otherwise the command will use the node
-                          provided by the --url parameter.
+  --noPassword                     When provided, Bootstrap will not use a password, so private keys will be stored in
+                                   plain text. Use with caution.
+
+  --password=password              A password used to encrypt and decrypt private keys in preset files like
+                                   addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be
+                                   provided in the command line (--password=XXXX) or disabled in the command line
+                                   (--noPassword).
+
+  --ready                          If --ready is provided, the command will not ask for confirmation when announcing
+                                   transactions.
+
+  --useKnownRestGateways           Use the best NEM node available when announcing. Otherwise the command will use the
+                                   node provided by the --url parameter.
 
 DESCRIPTION
   Currently, the only program that can be enrolled post-launch is 'SuperNode'.
@@ -47,4 +54,4 @@ EXAMPLES
   $ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap enrollRewardProgram --url http://external-rest:3000
 ```
 
-_See code: [src/commands/enrollRewardProgram.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.5/src/commands/enrollRewardProgram.ts)_
+_See code: [src/commands/enrollRewardProgram.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/enrollRewardProgram.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.5/src/commands/healthCheck.ts)_
+_See code: [src/commands/healthCheck.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/healthCheck.ts)_
diff --git a/docs/link.md b/docs/link.md
@@ -14,31 +14,39 @@ USAGE
   $ symbol-bootstrap link
 
 OPTIONS
-  -h, --help              It shows the help of this command.
-  -t, --target=target     [default: target] The target folder where the symbol-bootstrap network is generated
-  -u, --url=url           [default: http://localhost:3000] the network url
+  -c, --customPreset=customPreset  This command uses the encrypted addresses.yml to resolve the main private key. If the
+                                   main private is only stored in the custom preset, you can provide it using this
+                                   param. Otherwise, the command may ask for it when required.
 
-  --maxFee=maxFee         the max fee used when announcing (absolute). The node min multiplier will be used if it is not
-                          provided.
+  -h, --help                       It shows the help of this command.
 
-  --noPassword            When provided, Bootstrap will not use a password, so private keys will be stored in plain
-                          text. Use with caution.
+  -t, --target=target              [default: target] The target folder where the symbol-bootstrap network is generated
 
-  --password=password     A password used to encrypt and decrypt private keys in preset files like addresses.yml and
-                          preset.yml. Bootstrap prompts for a password by default, can be provided in the command line
-                          (--password=XXXX) or disabled in the command line (--noPassword).
+  -u, --url=url                    [default: http://localhost:3000] the network url
 
-  --ready                 If --ready is provided, the command will not ask for confirmation when announcing
-                          transactions.
+  --maxFee=maxFee                  the max fee used when announcing (absolute). The node min multiplier will be used if
+                                   it is not provided.
 
-  --unlink                Perform "Unlink" transactions unlinking the voting and VRF keys from the node signer account
+  --noPassword                     When provided, Bootstrap will not use a password, so private keys will be stored in
+                                   plain text. Use with caution.
 
-  --useKnownRestGateways  Use the best NEM node available when announcing. Otherwise the command will use the node
-                          provided by the --url parameter.
+  --password=password              A password used to encrypt and decrypt private keys in preset files like
+                                   addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be
+                                   provided in the command line (--password=XXXX) or disabled in the command line
+                                   (--noPassword).
+
+  --ready                          If --ready is provided, the command will not ask for confirmation when announcing
+                                   transactions.
+
+  --unlink                         Perform "Unlink" transactions unlinking the voting and VRF keys from the node signer
+                                   account
+
+  --useKnownRestGateways           Use the best NEM node available when announcing. Otherwise the command will use the
+                                   node provided by the --url parameter.
 
 EXAMPLES
   $ symbol-bootstrap link
   $ 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.5/src/commands/link.ts)_
+_See code: [src/commands/link.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/link.ts)_
diff --git a/docs/presetGuides.md b/docs/presetGuides.md
@@ -142,7 +142,7 @@ will generate a docker service like:
 ```yaml
   peer-node-0:
         container_name: peer-node-0
-        image: 'symbolplatform/symbol-server:gcc-0.10.0.6'
+        image: 'symbolplatform/symbol-server:gcc-10-1.0.1.0'
         .......
         cpu_count: 4
         shm_size: 64M

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.5/src/commands/report.ts)_
+_See code: [src/commands/report.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/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.5/src/commands/resetData.ts)_
+_See code: [src/commands/resetData.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/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.5/src/commands/run.ts)_
+_See code: [src/commands/run.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/run.ts)_
diff --git a/docs/start.md b/docs/start.md
@@ -21,7 +21,7 @@ OPTIONS
       If provided, docker-compose will run with -b (--build)
 
   -c, --customPreset=customPreset
-      External preset file. Values in this file will override the provided presets (optional)
+      External preset file. Values in this file will override the provided presets
 
   -d, --detached
       If provided, docker-compose will run with -d (--detached) and this command will wait unit server is running before 
@@ -90,4 +90,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.5/src/commands/start.ts)_
+_See code: [src/commands/start.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/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.5/src/commands/stop.ts)_
+_See code: [src/commands/stop.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/stop.ts)_
diff --git a/docs/verify.md b/docs/verify.md
@@ -20,4 +20,4 @@ EXAMPLE
   $ symbol-bootstrap verify
 ```
 
-_See code: [src/commands/verify.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.5/src/commands/verify.ts)_
+_See code: [src/commands/verify.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.6/src/commands/verify.ts)_