feat: added custom opt-in distribution (#1)

Author: fboucquez

package-lock.json

@@ -15,6 +15,7 @@
  */
 
 import { ConfigAccount, CustomPreset } from 'symbol-bootstrap';
+import { CurrencyDistribution } from 'symbol-bootstrap/lib/model/ConfigPreset';
 import { NodeInformation, NodeMetadataType, RestProtocol } from './NodeInformation';
 
 export interface CosignerAccountInput {
@@ -63,7 +64,7 @@ export interface BasicNetworkFile {
     isNewNetwork: boolean;
     nemesisSeedFolder?: string;
     faucetBalances?: number[];
-
+    additionalCurrencyDistributions?: CurrencyDistribution[][];
     multisig?: {
         ownershipCount: number;
         cosigners: CosignerPerson[];

src/model/NetworkFile.ts

@@ -138,7 +138,7 @@ export class NetworkGenesisService {
                     nemesisBalances.push({
                         mosaicIndex: mosaicIndex,
                         address: mainAccount.address.plain(),
-                        amount: parseInt(nodeBalance + NetworkUtils.zeroPad(0, divisibility)),
+                        amount: nodeBalance * 10 ** divisibility,
                     });
                 }
             });
@@ -213,7 +213,27 @@ export class NetworkGenesisService {
                     nemesisBalances.push({
                         mosaicIndex: mosaicIndex,
                         address: faucetAccount.address.plain(),
-                        amount: parseInt(faucetBalance + NetworkUtils.zeroPad(0, divisibility)),
+                        amount: faucetBalance * 10 ** divisibility,
+                    });
+                }
+            });
+        }
+
+        const additionalCurrencyDistributions = input.additionalCurrencyDistributions;
+        if (additionalCurrencyDistributions) {
+            nemesisPreset.mosaics.forEach((m, mosaicIndex) => {
+                const mosaicAdditionalCurrencyDistributions = additionalCurrencyDistributions[mosaicIndex];
+                if (mosaicAdditionalCurrencyDistributions) {
+                    const divisibility = nemesisPreset.mosaics[mosaicIndex].divisibility;
+                    if (divisibility == undefined) {
+                        throw new Error('Divisibility should be defined!!');
+                    }
+                    mosaicAdditionalCurrencyDistributions.forEach((distribution) => {
+                        nemesisBalances.push({
+                            mosaicIndex: mosaicIndex,
+                            address: distribution.address,
+                            amount: distribution.amount * 10 ** divisibility,
+                        });
                     });
                 }
             });

src/services/NetworkGenesisService.ts

@@ -21,6 +21,7 @@ import {
     CommandUtils,
     ConfigLoader,
     CustomPreset,
+    DeepPartial,
     FileSystemService,
     Logger,
     LoggerFactory,
@@ -29,7 +30,8 @@ import {
     Preset,
     YamlUtils,
 } from 'symbol-bootstrap';
-import { Account, NetworkType } from 'symbol-sdk';
+import { CurrencyDistribution, MosaicPreset } from 'symbol-bootstrap/lib/model/ConfigPreset';
+import { Account, Address, NetworkType } from 'symbol-sdk';
 import {
     Network,
     NetworkConfigurationService,
@@ -97,6 +99,7 @@ export class InitService {
         if (!nemesisPreset) throw new Error('Network nemesis must be found!');
         if (!nemesisPreset.mosaics) throw new Error(`Network nemesis's mosaics must be found!`);
         let faucetBalances: number[] | undefined;
+        let additionalCurrencyDistributions: CurrencyDistribution[][] | undefined;
         let customNetworkPreset: CustomPreset | undefined = {};
         if (isNewNetwork) {
             customNetworkPreset = _.merge({ nemesis: { mosaics: [] } }, this.params.additionalNetworkPreset);
@@ -126,17 +129,18 @@ export class InitService {
                 'Enter the basename for the network aliases',
                 networkPreset.baseNamespace,
             );
-
+            additionalCurrencyDistributions = [];
             for (const [index, mosaic] of nemesisPreset.mosaics.entries()) {
                 const currencyType = index == 0 ? 'Network' : index == 1 ? 'Harvest' : 'Custom';
                 const name = await this.promptName(
                     `${currencyType} Currency Name`,
                     `Enter the alias for the ${currencyType} Currency`,
                     mosaic.name,
                 );
-                customNetworkPreset.nemesis!.mosaics!.push({
+                const mosaicPreset: DeepPartial<MosaicPreset> = {
                     name,
-                });
+                };
+                customNetworkPreset.nemesis!.mosaics!.push(mosaicPreset);
             }
 
             const nemesisSignerAccount = await this.promptPrivateKey(networkType, 'Nemesis Signer Account');
@@ -148,15 +152,20 @@ export class InitService {
             if (await this.confirm('Do you want to have a Faucet account?')) {
                 const faucetAccount = await this.promptPrivateKey(networkType, 'Faucet Account');
                 await keyStore.saveNetworkAccount(networkType, 'faucet', faucetAccount.privateKey);
-                for (const mosaic of nemesisPreset.mosaics) {
+                for (const [index, mosaic] of nemesisPreset.mosaics.entries()) {
+                    const name = customNetworkPreset.nemesis!.mosaics![index]?.name || mosaic.name;
                     const balance = await this.promptNumber(
                         'Balance',
-                        `What's the initial ${mosaic.name} balance for the Faucet Account ${faucetAccount.address.plain()}?`,
+                        `What's the initial ${name} coin balance for the Faucet Account ${faucetAccount.address.plain()}?`,
                         Math.floor(mosaic.supply / 100 / Math.pow(10, mosaic.divisibility)) * 5,
                     );
                     faucetBalances.push(balance);
                 }
             }
+            for (const [index, mosaic] of nemesisPreset.mosaics.entries()) {
+                const name = customNetworkPreset.nemesis!.mosaics![index]?.name || mosaic.name;
+                additionalCurrencyDistributions.push(await this.promptDistribution(networkType, name));
+            }
 
             const harvestNetworkFeeSinkAccount = await this.promptPrivateKey(networkType, 'Harvest Network Fee Sink Account');
             await keyStore.saveNetworkAccount(networkType, 'harvestNetworkFeeSink', harvestNetworkFeeSinkAccount.privateKey);
@@ -194,6 +203,7 @@ export class InitService {
             networkType: networkType!,
             isNewNetwork: isNewNetwork,
             faucetBalances: faucetBalances,
+            additionalCurrencyDistributions: additionalCurrencyDistributions,
             nemesisSeedFolder: nemesisSeedFolder,
             nodeTypes: nodeTypes,
             customNetworkPreset: customNetworkPreset,
@@ -283,7 +293,7 @@ export class InitService {
                 ]);
                 nemesisSeedFolder = nemesisSeedFolderResponse.value;
                 try {
-                    await new FileSystemService(this.logger).validateSeedFolder(nemesisSeedFolder, '');
+                    new FileSystemService(this.logger).validateSeedFolder(nemesisSeedFolder, '');
                 } catch (e) {
                     console.log();
                     console.log(
@@ -452,6 +462,54 @@ export class InitService {
         );
     }
 
+    public async promptAddress(networkType: NetworkType, fieldName: string): Promise<Address> {
+        return this.confirmedPrompt<Address>(
+            fieldName,
+            async (currentValue): Promise<Address> => {
+                const { value } = await prompt([
+                    {
+                        name: 'value',
+                        message: `Enter a valid Symbol ${fieldName}`,
+                        type: 'input',
+                        default: currentValue?.plain(),
+                        validate: (value) => {
+                            try {
+                                const address = Address.createFromRawAddress(value);
+                                if (address.networkType != networkType) {
+                                    return `it's not for the right network`;
+                                }
+                                return true;
+                            } catch (e) {
+                                return `it is not a valid address. ${NetworkUtils.getMessage(e)}`;
+                            }
+                        },
+                    },
+                ]);
+                return Address.createFromRawAddress(value);
+            },
+            undefined,
+            (address) => `address ${address.plain()} `,
+        );
+    }
+
+    public async promptDistribution(networkType: NetworkType, mosaicName: string): Promise<CurrencyDistribution[]> {
+        const list: CurrencyDistribution[] = [];
+        console.log();
+        console.log(
+            `In additions to the node, faucet and founder accounts, you can include (opt-in) more accounts into the nemesis block by distributing ${mosaicName} coins.`,
+        );
+        while (await this.confirm(`Do you want to distribute coin ${mosaicName} to different accounts on the nemesis block?`, false)) {
+            const address = await this.promptAddress(networkType, 'distribution address');
+            const amount = await this.promptNumber(
+                'distribution amount',
+                `Enter how much ${mosaicName} you want to give to address ${address.plain()}`,
+                100,
+            );
+            list.push({ address: address.plain(), amount: amount });
+        }
+        return list;
+    }
+
     public async generateRandomKey(fieldName: string, message: string, networkType: NetworkType): Promise<string> {
         return this.promptText(fieldName, message, Account.generateNewAccount(networkType).privateKey, CommandUtils.isValidPrivateKey);
     }

src/utils/InitService.ts

@@ -17,6 +17,7 @@
 import 'mocha';
 import { join } from 'path';
 import { FileSystemService, LoggerFactory, LogType } from 'symbol-bootstrap';
+import { Account, NetworkType } from 'symbol-sdk';
 import { InitService } from '../../src';
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
@@ -51,6 +52,8 @@ describe('Init', () => {
 
     it('network2 init', async () => {
         // Given this prompts
+        const distributionAddress1 = Account.createFromPrivateKey(TestUtils.toKey('D1'), NetworkType.MAIN_NET).address.plain();
+        const distributionAddress2 = Account.createFromPrivateKey(TestUtils.toKey('D2'), NetworkType.MAIN_NET).address.plain();
         StdUtils.in([
             '\n',
             '\n',
@@ -63,19 +66,28 @@ describe('Init', () => {
             `${TestUtils.toKey('A')}`,
             '\n',
             '1626575785\n',
-            'pirate\n',
+            'pirate\n', //Mosaic 1
             'gold\n',
-            `${TestUtils.toKey('B')}`,
+            `${TestUtils.toKey('B')}`, // Nemesis signer.
             '\n',
-            `${TestUtils.toKey('C')}`,
+            `${TestUtils.toKey('C')}`, // Founder
             '\n',
             'Y\n',
-            `${TestUtils.toKey('D')}`,
+            `${TestUtils.toKey('D')}`, // Faucet
             '\n',
             '\n',
-            `${TestUtils.toKey('E')}\n`,
-            `${TestUtils.toKey('F')}\n`,
-            `${TestUtils.toKey('AA')}\n`,
+            'y\n', // Yes, enter distribution addresses
+            distributionAddress1,
+            '\n',
+            `500\n`,
+            'y\n', // Yes, enter distribution addresses
+            distributionAddress2,
+            '\n',
+            `100\n`,
+            'n\n', // No more distribution
+            `${TestUtils.toKey('E')}\n`, //sink
+            `${TestUtils.toKey('F')}\n`, //sink
+            `${TestUtils.toKey('AA')}\n`, //sink
             //First node
             `\n`,
             '2',

test/commands/init.test.ts

@@ -4,11 +4,11 @@
    Voting Balance: 6000000000000
 *
   Generation Hash: D43808D5F3FDA9AC541CCB75F00F7077202787C4DA7867BF06AB37B1D7B4EA0C
-Transactions Hash: 4E9FE39B09F12B6241B6DF1EA1D63E58A8709E4520106602463A2467BBCB8410
+Transactions Hash: 9AE6469ED739214ECD592712B1C82CA34F801C714E69788E3822319622C753B0
     Receipts Hash: FDDDDD29B4408DF2044CBA322E35BA989A9F92B81D49E3CC141E46613D226287
-       State Hash: 6E427011A127AEEE13831EC9A7EF93422C47A087BADBD2C8C9A4975EE13AF234
+       State Hash: A7F42760454F1576B1F9BCF3F6B75C462ECBBF163379ACB43BED6A6AFEF5F712
 --- Components (9) ---
- + 93DFC0E053587BA8D384EC4AEF71F2C14C91C585A720FF32A3E456762D89453E
+ + A3A0D88B9276114D3F4A0E8C563124C946BBF3F7165548A7F8D9D57C0B089315
  + AF037B19C5461AF9D214DCF21406555E7CC960E1084A674E6167C31CE5A3F84B
  + DD42D8D1905B40D7CAA4B0BE5E8ABC9292A25A62CBBBD81203D58A58DC387CA7
  + 0000000000000000000000000000000000000000000000000000000000000000