Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaguar0625 committed Nov 5, 2021
2 parents 487cfe0 + 013bb04 commit 3ab2285
Show file tree
Hide file tree
Showing 155 changed files with 5,614 additions and 10,373 deletions.
42 changes: 35 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,63 @@ 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.1.0] - NEXT

**Milestone**: Mainnet(1.0.2.0)

| Package | Version | Link |
| ---------------- | ------- | ------------------------------------------------------------------ |
| Symbol Bootstrap | v1.1.0 | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |

- Added `wizard` command.
- Added `pack` command.
- Added `modifyMultisig` command.
- Added `--serviceProviderPublicKey` to `link` command.
- Rest `2.3.8` upgrade.
- Explorer `1.1.0` upgrade.
- Faucet `1.0.1` upgrade.
- Removed node reward support.
- Removed unused `sshpk` service and dependency.
- Removed unused `forge` service and dependency.
- Changed `stop` command to run `docker-compose stop` instead of `docker-compose down`
- Added statistic service integration.
- Removed node static list from `mainnet` and `testnet` preset. The node lists are resolved using the statistic service.
- Updated explorer and faucet urls.
- Removed private and mijin network types support.

## [1.0.9] - Sep-15-2021

**Milestone**: Mainnet(1.0.2.0)

| Package | Version | Link |
| ---------------- | ------- | ------------------------------------------------------------------ |
| Symbol Bootstrap | v1.0.9 | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |

- Hot fix `updateVotingKeys` command bug.

## [1.0.8] - Sep-14-2021

**Milestone**: Mainnet(1.0.2.0)

- Fixed `updateVotingKeys` command when upgrading from `1.0.6`.
- Catapult `1.0.2.0` upgrade.
- Updated `minPartnerNodeVersion` to `1.0.1.0`. Older Catapult clients will be rejected.

| Package | Version | Link |
| ---------------- | ------- | ------------------------------------------------------------------ |
| Symbol Bootstrap | v1.0.8 | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |

- Fixed `updateVotingKeys` command when upgrading from `1.0.6`.
- Catapult `1.0.2.0` upgrade.
- Updated `minPartnerNodeVersion` to `1.0.1.0`. Older Catapult clients will be rejected.

## [1.0.7] - June-22-2021

**Milestone**: Mainnet(1.0.1.0)

- Added multi voting key file support.
- Added `updateVotingKeys` command.

| Package | Version | Link |
| ---------------- | ------- | ------------------------------------------------------------------ |
| Symbol Bootstrap | v1.0.7 | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |

- Added multi voting key file support.
- Added `updateVotingKeys` command.

## [1.0.6] - June-8-2021

**Milestone**: Mainnet(1.0.1.0)
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Symbol CLI tool that allows you creating, configuring and running Symbol's c
* [Concepts](#concepts)
* [Requirements](#requirements)
* [Usage](#usage)
* [General Usage](#general-usage)
* [Wizard](#wizard)
* [E2E Testing support](#e2e-testing-support)
* [Development](#development)
* [Commands](#commands)
Expand Down Expand Up @@ -135,14 +137,16 @@ $ npm install -g symbol-bootstrap
$ symbol-bootstrap COMMAND
running command...
$ symbol-bootstrap (-v|--version|version)
symbol-bootstrap/1.0.9 linux-x64 node-v12.22.6
symbol-bootstrap/1.1.0 linux-x64 node-v12.22.6
$ symbol-bootstrap --help [COMMAND]
USAGE
$ symbol-bootstrap COMMAND
...
```
<!-- usagestop -->

# General Usage

The general usage would be:

```
Expand All @@ -163,6 +167,14 @@ If you need to start fresh, you many need to sudo remove the target folder (dock
sudo rm -rf ./target
```

# Wizard

If this is your first time creating a node, it's recommended to use the Wizard. Just follow the instructions:

```
symbol-bootstrap wizard
```

# E2E Testing support

One use case of this CLI is client E2E testing support. If you are coding a Symbol client, you (Travis or Jenkins) can run e2e tests like:
Expand Down Expand Up @@ -268,17 +280,19 @@ General users should install this tool like any other node module.
* [`symbol-bootstrap config`](docs/config.md) - Command used to set up the configuration files and the nemesis block for the current network
* [`symbol-bootstrap decrypt`](docs/decrypt.md) - It decrypts a yml file using the provided password. The source file can be a custom preset file, a preset.yml file or an addresses.yml.
* [`symbol-bootstrap encrypt`](docs/encrypt.md) - It encrypts a yml file using the provided password. The source files would be a custom preset file, a preset.yml file or an addresses.yml.
* [`symbol-bootstrap enrollRewardProgram`](docs/enrollRewardProgram.md) - It enrols the nodes in the rewards program by announcing the enroll transaction to the registration address. You can also use this command to update the program registration when you change the agent keys (changing the agent-ca-csr) or server host.
* [`symbol-bootstrap healthCheck`](docs/healthCheck.md) - It checks if the services created with docker compose are up and running.
* [`symbol-bootstrap help`](docs/help.md) - display help for symbol-bootstrap
* [`symbol-bootstrap link`](docs/link.md) - It announces VRF and Voting Link transactions to the network for each node with 'Peer' or 'Voting' roles. This command finalizes the node registration to an existing network.
* [`symbol-bootstrap modifyMultisig`](docs/modifyMultisig.md) - Create or modify a multisig account
* [`symbol-bootstrap pack`](docs/pack.md) - It configures and packages your node into a zip file that can be uploaded to the final node machine.
* [`symbol-bootstrap report`](docs/report.md) - it generates reStructuredText (.rst) reports describing the configuration of each node.
* [`symbol-bootstrap resetData`](docs/resetData.md) - It removes the data keeping the generated configuration, certificates, keys and block 1.
* [`symbol-bootstrap run`](docs/run.md) - It boots the network via docker using the generated `docker-compose.yml` file and configuration. The config and compose methods/commands need to be called before this method. This is just a wrapper for the `docker-compose up` bash call.
* [`symbol-bootstrap start`](docs/start.md) - Single command that aggregates config, compose and run in one line!
* [`symbol-bootstrap stop`](docs/stop.md) - It stops the docker-compose network if running (symbol-bootstrap started with --detached). This is just a wrapper for the `docker-compose down` bash call.
* [`symbol-bootstrap updateVotingKeys`](docs/updateVotingKeys.md) - It updates the voting files containing the voting keys when required.
* [`symbol-bootstrap verify`](docs/verify.md) - It tests the installed software in the current computer reporting if there is any missing dependency, invalid version, or software related issue.
* [`symbol-bootstrap wizard`](docs/wizard.md) - An utility command that will help you configuring node!

<!-- commandsstop -->

Expand Down
3 changes: 0 additions & 3 deletions cmds/config-testnet-supernode.sh

This file was deleted.

3 changes: 0 additions & 3 deletions cmds/enrollRewardProgram-testnet.sh

This file was deleted.

2 changes: 0 additions & 2 deletions cmds/link-testnet-supernode-external-node.sh

This file was deleted.

3 changes: 0 additions & 3 deletions cmds/start-testnet-supernode-demo.sh

This file was deleted.

3 changes: 0 additions & 3 deletions cmds/start-testnet-supernode.sh

This file was deleted.

4 changes: 0 additions & 4 deletions cmds/stop-testnet-supernode.sh

This file was deleted.

3 changes: 0 additions & 3 deletions cmds/upgradeVotingKeys-testnet-supernode.sh

This file was deleted.

20 changes: 0 additions & 20 deletions config/agent-cert/agent-ca.cnf

This file was deleted.

7 changes: 0 additions & 7 deletions config/agent-cert/agent-comm.cnf

This file was deleted.

8 changes: 0 additions & 8 deletions config/agent/agent.properties.mustache

This file was deleted.

5 changes: 3 additions & 2 deletions config/docker/explorer/run.sh.mustache
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#!/bin/bash
set -e
echo "Starting explorer $1"
cp config.js /usr/share/nginx/html
nginx -g 'daemon off;'
cp default.json /app/src/config/default.json
cd /app
npm start
21 changes: 0 additions & 21 deletions config/explorer/config.js.mustache

This file was deleted.

18 changes: 18 additions & 0 deletions config/explorer/default.json.mustache
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"peersApi": {
"defaultNode": "{{defaultNode}}",
"nodes": {{{toJson restNodes}}}
},
"endpoints": {
"marketData": "https://min-api.cryptocompare.com/"
},
"networkConfig": {
"namespaceName": "{{namespaceName}}",
"mosaicId": "{{{toSimpleHex currencyMosaicId}}}",
"divisibility": "{{maxMosaicDivisibility}}",
"namespaceId": "{{{toSimpleHex namespaceId}}}",
"networkIdentifier": {{networkType}}
},
"footer": {{{toJson footer}}}
}

8 changes: 8 additions & 0 deletions config/node/resources/config-finalization.properties.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,11 @@ maxHashesPerPoint = {{{toAmount maxHashesPerPoint}}}
prevoteBlocksMultiple = {{{toAmount prevoteBlocksMultiple}}}

unfinalizedBlocksDuration = {{{unfinalizedBlocksDuration}}}

treasuryReissuanceEpoch = {{{treasuryReissuanceEpoch}}}

[treasury_reissuance_epoch_ineligible_voter_addresses]

{{#each treasuryReissuanceEpochIneligibleVoterAddresses}}
{{this}} = true
{{/each}}
25 changes: 22 additions & 3 deletions config/node/resources/config-network.properties.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ maxVotingKeyLifetime = {{{maxVotingKeyLifetime}}}

harvestBeneficiaryPercentage = {{{harvestBeneficiaryPercentage}}}
harvestNetworkPercentage = {{{harvestNetworkPercentage}}}
harvestNetworkFeeSinkAddressV1 = {{{harvestNetworkFeeSinkAddressV1}}}
harvestNetworkFeeSinkAddress = {{{harvestNetworkFeeSinkAddress}}}

maxTransactionsPerBlock = {{{toAmount maxTransactionsPerBlock}}}

[fork_heights]

totalVotingBalanceCalculationFix = {{{toAmount totalVotingBalanceCalculationFix}}}
treasuryReissuanceBlockTransactionsHash = {{{treasuryReissuanceBlockTransactionsHash}}}
treasuryReissuanceFallbackBlockTransactionsHash = {{{treasuryReissuanceFallbackBlockTransactionsHash}}}

[plugin:catapult.plugins.accountlink]

Expand Down Expand Up @@ -86,6 +86,7 @@ maxMosaicsPerAccount = {{{toAmount maxMosaicsPerAccount}}}
maxMosaicDuration = {{{maxMosaicDuration}}}
maxMosaicDivisibility = {{{maxMosaicDivisibility}}}

mosaicRentalFeeSinkAddressV1 = {{{mosaicRentalFeeSinkAddressV1}}}
mosaicRentalFeeSinkAddress = {{{mosaicRentalFeeSinkAddress}}}
mosaicRentalFee = {{{mosaicRentalFee}}}

Expand All @@ -107,6 +108,7 @@ maxNamespaceDuration = {{{maxNamespaceDuration}}}
namespaceGracePeriodDuration = {{{namespaceGracePeriodDuration}}}
reservedRootNamespaceNames = {{{reservedRootNamespaceNames}}}

namespaceRentalFeeSinkAddressV1 = {{{namespaceRentalFeeSinkAddressV1}}}
namespaceRentalFeeSinkAddress = {{{namespaceRentalFeeSinkAddress}}}
rootNamespaceRentalFeePerBlock = {{{rootNamespaceRentalFeePerBlock}}}
childNamespaceRentalFee = {{{childNamespaceRentalFee}}}
Expand All @@ -122,3 +124,20 @@ maxMosaicRestrictionValues = {{{maxMosaicRestrictionValues}}}
[plugin:catapult.plugins.transfer]

maxMessageSize = {{{maxMessageSize}}}

[fork_heights]

totalVotingBalanceCalculationFix = {{{toAmount totalVotingBalanceCalculationFix}}}
treasuryReissuance = {{{toAmount treasuryReissuance}}}

[treasury_reissuance_transaction_signatures]

{{#each treasuryReissuanceTransactionSignatures}}
{{this}} = true
{{/each}}

[treasury_reissuance_fallback_transaction_signatures]

{{#each treasuryReissuanceFallbackTransactionSignatures}}
{{this}} = true
{{/each}}
4 changes: 4 additions & 0 deletions config/rest-gateway/rest.json.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
},

"port": 3000,
"protocol": "{{{restProtocol}}}",
"sslKeyPath": "{{{restSSLPath}}}/{{{restSSLKeyFileName}}}",
"sslCertificatePath": "{{{restSSLPath}}}/{{{restSSLCertificateFileName}}}",

"crossDomain": {
"allowedHosts": ["*"],
"allowedMethods": ["GET", "POST", "PUT", "OPTIONS"]
Expand Down
2 changes: 1 addition & 1 deletion docs/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ EXAMPLE
$ symbol-bootstrap clean
```

_See code: [src/commands/clean.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.9/src/commands/clean.ts)_
_See code: [src/commands/clean.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.1.0/src/commands/clean.ts)_
2 changes: 1 addition & 1 deletion docs/compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ EXAMPLE
$ symbol-bootstrap compose
```

_See code: [src/commands/compose.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.9/src/commands/compose.ts)_
_See code: [src/commands/compose.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.1.0/src/commands/compose.ts)_
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,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.9/src/commands/config.ts)_
_See code: [src/commands/config.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.1.0/src/commands/config.ts)_
2 changes: 1 addition & 1 deletion docs/decrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ EXAMPLES
plain-addresses.yml
```

_See code: [src/commands/decrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.9/src/commands/decrypt.ts)_
_See code: [src/commands/decrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.1.0/src/commands/decrypt.ts)_
2 changes: 1 addition & 1 deletion docs/encrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ EXAMPLES
encrypted-custom-preset.yml
```

_See code: [src/commands/encrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.0.9/src/commands/encrypt.ts)_
_See code: [src/commands/encrypt.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.1.0/src/commands/encrypt.ts)_
Loading

0 comments on commit 3ab2285

Please sign in to comment.