From 4e6192869d32812df1a885abf587181e2a3f80fa Mon Sep 17 00:00:00 2001 From: Voss Date: Wed, 1 May 2024 19:59:34 -0500 Subject: [PATCH 1/3] Update Wording, fixed install link, and link to activity report --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- README.md | 4 ++-- getting-started.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a765d82..62ad679 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -31,7 +31,7 @@ assignees: **DAppNode version:** - + - Package version: - OS: diff --git a/README.md b/README.md index e75aa67..019be0c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Nethermind DAppNode package +# Nethermind Dappnode Package -[![DAppNodeStore Available](https://img.shields.io/badge/DAppNodeStore-Available-brightgreen.svg)](http://my.dappnode/#/installer/nethermind.public.dappnode.eth) +[![DAppNodeStore Available](https://img.shields.io/badge/DAppNodeStore-Available-brightgreen.svg)](http://my.dappnode/installer/public/nethermind.public.dappnode.eth) Light wrapper around the Nethermind Ethereum client diff --git a/getting-started.md b/getting-started.md index e8c3d8a..bd0ba2e 100644 --- a/getting-started.md +++ b/getting-started.md @@ -1,6 +1,6 @@ -# Nethermind (Execution Client) +# Nethermind Mainnet (Execution Client) -Welcome to the Merged Mainnet Nethermind Execution Client. +Welcome to the Mainnet Nethermind Execution Client. There are now two RPC APIs in Execution Clients: From 5c1870b1610eb69c8f62921c5d43080d54093bf4 Mon Sep 17 00:00:00 2001 From: Voss Date: Wed, 1 May 2024 20:03:18 -0500 Subject: [PATCH 2/3] Fix setup wizard, set service in each parameter's target to` nethermind` and set defaults for all Enums to match the description default, and made the 2 default options required, with defaults set. --- setup-wizard.yml | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/setup-wizard.yml b/setup-wizard.yml index 9eec55d..86edf14 100644 --- a/setup-wizard.yml +++ b/setup-wizard.yml @@ -4,6 +4,7 @@ fields: target: type: environment name: MODE + service: nethermind title: Config type description: >- You must choose an installation method. Most users should choose the @@ -37,59 +38,70 @@ fields: - "archive" - "advanced" - "custom" + default: "normal" + required: true - id: DownloadBodiesInFastSync target: type: environment name: DOWNLOAD_BODIES_IN_FAST_SYNC + service: nethermind title: DownloadBodiesInFastSync description: >- If set to `true` then the block bodies will be downloaded in the Fast Sync mode. default value: true enum: - "true" - "false" + default: "true" if: { "mode": { "enum": ["advanced"] } } - id: downloadreceiptsinfastsync target: type: environment name: DOWNLOAD_RECEIPTS_IN_FAST_SYNC + service: nethermind title: DownloadReceiptsInFastSync description: >- If set to `true` then the receipts will be downloaded in the Fast Sync mode. This will slow down the process by a few hours but will allow you to interact with dApps that execute extensive historical logs searches (like Maker CDPs). default value: true enum: - "true" - "false" + default: "true" if: { "mode": { "enum": ["advanced"] } } - id: FastBlocks target: type: environment name: FAST_BLOCKS + service: nethermind title: FastBlocks description: >- If set to ‘true’ then in the Fast Sync mode blocks will be first downloaded from the provided PivotNumber downwards. This allows for parallelization of requests with many sync peers and with no need to worry about syncing a valid branch (syncing downwards to 0). You need to enter the pivot block number, hash and total difficulty from a trusted source (you can use etherscan and confirm with other sources if you wan to change it). default value: false enum: - "false" - "true" + default: "false" if: { "mode": { "enum": ["advanced"] } } - id: FastSync target: type: environment name: FAST_SYNC + service: nethermind title: FastSync description: >- If set to ‘true’ then the Fast Sync (eth/63) synchronization algorithm will be used. default value: false enum: - "false" - "true" + default: "false" if: { "mode": { "enum": ["advanced"] } } - id: PivotHash target: type: environment name: PIVOT_HASH + service: nethermind title: PivotHash description: >- Hash of the pivot block for the Fast Blocks sync. default value: null @@ -99,6 +111,7 @@ fields: target: type: environment name: PIVOT_NUMBER + service: nethermind title: PivotNumber description: >- Number of the pivot block for the Fast Blocks sync. default value: null @@ -108,6 +121,7 @@ fields: target: type: environment name: PIVOT_TOTAL_DIFFICULTY + service: nethermind title: PivotTotalDifficulty description: >- Total Difficulty of the pivot block for the Fast Blocks sync (not - this is total difficulty and not difficulty). default value: null @@ -117,29 +131,36 @@ fields: target: type: environment name: USE_GETH_LIMITS_IN_FAST_BLOCKS + service: nethermind title: UseGethLimitsInFastBlocks description: >- If set to `true` then in the Fast Blocks mode Nethermind generates smaller requests to avoid Geth from disconnecting. On the Geth heavy networks (mainnet) it is desired while on Parity or Nethermind heavy networks (Goerli, AuRa) it slows down the sync by a factor of ~4 default value: true enum: - "true" - "false" + default: "true" if: { "mode": { "enum": ["advanced"] } } - id: CustomConfiguration target: type: fileUpload path: /data/custom.cfg + service: nethermind title: Custom configuration file description: >- Upload your desired configuration file. You can get more info about how to configure nethermind [here](https://nethermind.readthedocs.io/en/latest/configuration.html) and also you can find some examples [here](https://github.com/NethermindEth/nethermind/tree/master/src/Nethermind/Nethermind.Runner/configs) if: { "mode": { "enum": ["custom"] } } + - id: EnableUI target: type: environment name: NETHERMIND_HEALTHCHECKSCONFIG_UIENABLED + service: nethermind title: Nethermind UI description: >- - If set to `true` then you will be able to access a UI where to check basic stuff of Nethermind client + If set to `true` then you will be able to access a UI where to check basic info from Nethermind client enum: - "true" - "false" + default: "true" + required: true From 881619886c0eb2a3df895367d9d3cae4bac9e210 Mon Sep 17 00:00:00 2001 From: Voss Date: Wed, 1 May 2024 20:10:07 -0500 Subject: [PATCH 3/3] update wording, make UI option required --- setup-wizard.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup-wizard.yml b/setup-wizard.yml index 86edf14..544595c 100644 --- a/setup-wizard.yml +++ b/setup-wizard.yml @@ -158,7 +158,7 @@ fields: service: nethermind title: Nethermind UI description: >- - If set to `true` then you will be able to access a UI where to check basic info from Nethermind client + If set to `true` then you will be able to access a UI where to check basic info from the Nethermind client. enum: - "true" - "false"