beneficiaryAddress set to use the node's main account (#203)

fboucquez · Mar 22, 2021 · 82d51b7 · 82d51b7
1 parent faab54f
commit 82d51b7
Show file tree

Hide file tree

Showing 17 changed files with 40 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 -   Random and limited peer/api list.
 -   Custom `votingUnfinalizedBlocksDuration` and `nonVotingUnfinalizedBlocksDuration` preset properties.
 -   Agent service is disabled until supernode program resumes. 
+-   The default `beneficiaryAddress` is the node's main address. Use `beneficiaryAddress: ''` in a custom preset to override the new default.
 
 ## [1.0.0] - Mar-16-2021
 

diff --git a/presets/bootstrap/network.yml b/presets/bootstrap/network.yml
@@ -10,6 +10,7 @@ currencyName: 'currency'
 harvestingName: 'harvest'
 explorerUrl: http://localhost:90/
 faucetUrl: http://localhost:100/
+beneficiaryAddress: ''
 nemesis:
     mosaics:
         - name: '{{currencyName}}'

diff --git a/presets/shared.yml b/presets/shared.yml
@@ -153,7 +153,6 @@ transactionElementTraceInterval: 10
 enableDispatcherAbortWhenFull: false
 enableDispatcherInputAuditing: false
 maxTrackedNodes: 5'000
-beneficiaryAddress: ''
 enableAutoHarvesting: true
 fileDatabaseBatchSize: 1
 maxUnlockedAccounts: 10

diff --git a/src/model/ConfigPreset.ts b/src/model/ConfigPreset.ts
@@ -80,6 +80,7 @@ export interface NodePreset extends DockerServicePreset {
     host?: string;
     roles?: string;
     friendlyName?: string;
+    beneficiaryAddress?: string;
 
     // Optional private keys. If not provided, bootstrap will generate random ones.
     mainPrivateKey?: string;
@@ -175,6 +176,7 @@ export interface ConfigPreset {
     harvestNetworkFeeSinkAddress?: string;
     mosaicRentalFeeSinkAddress?: string;
     namespaceRentalFeeSinkAddress?: string;
+    beneficiaryAddress?: string;
     nodeUseRemoteAccount: boolean;
     networkheight: boolean;
     dockerComposeVersion: number | string;

diff --git a/src/service/ConfigService.ts b/src/service/ConfigService.ts
@@ -306,6 +306,7 @@ export class ConfigService {
             'storing the harvesterVrfPrivateKey in the server properties',
         );
 
+        const beneficiaryAddress = nodePreset.beneficiaryAddress || presetData.beneficiaryAddress;
         const generatedContext = {
             name: name,
             friendlyName: nodePreset?.friendlyName || account.friendlyName,
@@ -314,6 +315,7 @@ export class ConfigService {
             unfinalizedBlocksDuration: nodePreset.voting
                 ? presetData.votingUnfinalizedBlocksDuration
                 : presetData.nonVotingUnfinalizedBlocksDuration,
+            beneficiaryAddress: beneficiaryAddress == undefined ? account.main.address : beneficiaryAddress,
         };
         const templateContext: any = { ...presetData, ...generatedContext, ...nodePreset };
         const excludeFiles: string[] = [];

diff --git a/test/reports/mainnet-dual-voting/node-config.csv b/test/reports/mainnet-dual-voting/node-config.csv
@@ -82,7 +82,7 @@ harvesterVrfPrivateKey; ********************************************************
 enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
 maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
 delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+beneficiaryAddress; NDQ32MTJICEPJDU45KVN7BAM4A4GI7OARNBUUFY; Address; Address of the account receiving part of the harvested fee.
 
 
 config-inflation.properties

diff --git a/test/reports/mainnet-dual-voting/node-config.rst b/test/reports/mainnet-dual-voting/node-config.rst
@@ -106,7 +106,7 @@ config-harvesting.properties
     enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
     maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
     delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-    beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+    beneficiaryAddress; NDQ32MTJICEPJDU45KVN7BAM4A4GI7OARNBUUFY; Address; Address of the account receiving part of the harvested fee.
 
 config-inflation.properties
 ===========================

diff --git a/test/reports/mainnet-dual/node-config.csv b/test/reports/mainnet-dual/node-config.csv
@@ -82,7 +82,7 @@ harvesterVrfPrivateKey; ********************************************************
 enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
 maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
 delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+beneficiaryAddress; NDQ32MTJICEPJDU45KVN7BAM4A4GI7OARNBUUFY; Address; Address of the account receiving part of the harvested fee.
 
 
 config-inflation.properties

diff --git a/test/reports/mainnet-dual/node-config.rst b/test/reports/mainnet-dual/node-config.rst
@@ -106,7 +106,7 @@ config-harvesting.properties
     enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
     maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
     delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-    beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+    beneficiaryAddress; NDQ32MTJICEPJDU45KVN7BAM4A4GI7OARNBUUFY; Address; Address of the account receiving part of the harvested fee.
 
 config-inflation.properties
 ===========================

diff --git a/test/reports/mainnet-peer/node-config.csv b/test/reports/mainnet-peer/node-config.csv
@@ -82,7 +82,7 @@ harvesterVrfPrivateKey; ********************************************************
 enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
 maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
 delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+beneficiaryAddress; NDQ32MTJICEPJDU45KVN7BAM4A4GI7OARNBUUFY; Address; Address of the account receiving part of the harvested fee.
 
 
 config-inflation.properties

diff --git a/test/reports/mainnet-peer/node-config.rst b/test/reports/mainnet-peer/node-config.rst
@@ -106,7 +106,7 @@ config-harvesting.properties
     enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
     maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
     delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-    beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+    beneficiaryAddress; NDQ32MTJICEPJDU45KVN7BAM4A4GI7OARNBUUFY; Address; Address of the account receiving part of the harvested fee.
 
 config-inflation.properties
 ===========================

diff --git a/test/reports/testnet-dual-voting/api-node-config.csv b/test/reports/testnet-dual-voting/api-node-config.csv
@@ -82,7 +82,7 @@ harvesterVrfPrivateKey; ********************************************************
 enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
 maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
 delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+beneficiaryAddress; TDQ32MTJICEPJDU45KVN7BAM4A4GI7OARMLVSXQ; Address; Address of the account receiving part of the harvested fee.
 
 
 config-inflation.properties

diff --git a/test/reports/testnet-dual-voting/api-node-config.rst b/test/reports/testnet-dual-voting/api-node-config.rst
@@ -106,7 +106,7 @@ config-harvesting.properties
     enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
     maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
     delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-    beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+    beneficiaryAddress; TDQ32MTJICEPJDU45KVN7BAM4A4GI7OARMLVSXQ; Address; Address of the account receiving part of the harvested fee.
 
 config-inflation.properties
 ===========================

diff --git a/test/reports/testnet-peer-voting/peer-node-config.csv b/test/reports/testnet-peer-voting/peer-node-config.csv
@@ -82,7 +82,7 @@ harvesterVrfPrivateKey; ********************************************************
 enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
 maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
 delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+beneficiaryAddress; TDQ32MTJICEPJDU45KVN7BAM4A4GI7OARMLVSXQ; Address; Address of the account receiving part of the harvested fee.
 
 
 config-inflation.properties

diff --git a/test/reports/testnet-peer-voting/peer-node-config.rst b/test/reports/testnet-peer-voting/peer-node-config.rst
@@ -106,7 +106,7 @@ config-harvesting.properties
     enableAutoHarvesting; true; bool; Set to true if auto harvesting is enabled.
     maxUnlockedAccounts; 10; uint32_t; Maximum number of unlocked accounts.
     delegatePrioritizationPolicy; Importance; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.
-    beneficiaryAddress; ; Address; Address of the account receiving part of the harvested fee.
+    beneficiaryAddress; TDQ32MTJICEPJDU45KVN7BAM4A4GI7OARMLVSXQ; Address; Address of the account receiving part of the harvested fee.
 
 config-inflation.properties
 ===========================

diff --git a/test/service/BootstrapUtils.test.ts b/test/service/BootstrapUtils.test.ts
@@ -16,12 +16,12 @@
 
 import { expect } from '@oclif/test';
 import { statSync } from 'fs';
+import * as _ from 'lodash';
 import 'mocha';
 import { it } from 'mocha';
 import { totalmem } from 'os';
 import { Account, Deadline, LinkAction, NetworkType, UInt64, VotingKeyLinkTransaction } from 'symbol-sdk';
-import { BootstrapUtils } from '../../src/service';
-import { CryptoUtils } from '../../src/service/CryptoUtils';
+import { BootstrapUtils, CryptoUtils } from '../../src/service';
 import assert = require('assert');
 
 describe('BootstrapUtils', () => {
@@ -142,6 +142,22 @@ describe('BootstrapUtils', () => {
         expect(CryptoUtils.encryptedCount(BootstrapUtils.loadYaml('test/encrypted.yml', false))).to.be.eq(6);
     });
 
+    it('mergeTest', async () => {
+        const a = { a: 1, list: ['1', '1', '3'], c: 'A', beneficiaryAddress: 'abc' };
+        const b = { a: undefined, c: 'B' };
+        const c = { list: ['a', 'b'], a: undefined, c: 'C', beneficiaryAddress: '' };
+        const expected = {
+            a: 1,
+            beneficiaryAddress: '',
+            c: 'C',
+            list: ['a', 'b', '3'],
+        };
+
+        expect(_.merge(a, b, c)).deep.equals(expected);
+
+        expect(_.merge(a, b, c)).deep.equals(expected);
+    });
+
     it('createVotingKeyTransaction v1 short key', async () => {
         const networkType = NetworkType.PRIVATE;
         const deadline = Deadline.createFromDTO('1');

diff --git a/test/service/ReportService.test.ts b/test/service/ReportService.test.ts
@@ -51,6 +51,7 @@ describe('ReportService', () => {
         const customPresetObject = {
             nodes: [
                 {
+                    mainPrivateKey: 'CA82E7ADAF7AB729A5462A1BD5AA78632390634904A64EB1BB22295E2E1A1BDD',
                     voting: true,
                     friendlyName: 'myFriendlyName',
                 },
@@ -74,6 +75,7 @@ describe('ReportService', () => {
         const customPresetObject = {
             nodes: [
                 {
+                    mainPrivateKey: 'CA82E7ADAF7AB729A5462A1BD5AA78632390634904A64EB1BB22295E2E1A1BDD',
                     voting: true,
                     friendlyName: 'myFriendlyName',
                 },
@@ -97,6 +99,7 @@ describe('ReportService', () => {
         const customPresetObject = {
             nodes: [
                 {
+                    mainPrivateKey: 'CA82E7ADAF7AB729A5462A1BD5AA78632390634904A64EB1BB22295E2E1A1BDD',
                     voting: false,
                     friendlyName: 'myFriendlyName',
                 },
@@ -120,6 +123,7 @@ describe('ReportService', () => {
         const customPresetObject = {
             nodes: [
                 {
+                    mainPrivateKey: 'CA82E7ADAF7AB729A5462A1BD5AA78632390634904A64EB1BB22295E2E1A1BDD',
                     voting: false,
                     friendlyName: 'myFriendlyName',
                 },
@@ -143,6 +147,7 @@ describe('ReportService', () => {
         const customPresetObject = {
             nodes: [
                 {
+                    mainPrivateKey: 'CA82E7ADAF7AB729A5462A1BD5AA78632390634904A64EB1BB22295E2E1A1BDD',
                     voting: false,
                     friendlyName: 'myFriendlyName',
                 },
@@ -166,6 +171,7 @@ describe('ReportService', () => {
         const customPresetObject = {
             nodes: [
                 {
+                    mainPrivateKey: 'CA82E7ADAF7AB729A5462A1BD5AA78632390634904A64EB1BB22295E2E1A1BDD',
                     voting: true,
                     friendlyName: 'myFriendlyName',
                 },