Skip to content

docs: add BalanceViewer configuration namespace #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marchhill wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add BalanceViewer configuration namespace #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions docs/fundamentals/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,63 @@ The configuration options are case-sensitive and can be defined only once unless
The address of the transaction priority contract to use when selecting transactions from the transaction pool. Defaults to `null`.


### BalanceViewer

- #### `BalanceViewer.Enabled` \{#balanceviewer-enabled\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--balanceviewer-enabled [true|false]
--BalanceViewer.Enabled [true|false]
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_BALANCEVIEWERCONFIG_ENABLED=true|false
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"BalanceViewer": {
"Enabled": true|false
}
}
```
</TabItem>
</Tabs>

Whether to serve the balance viewer UI at the `/balances` path of the JSON-RPC HTTP endpoint. Allowed values: `true` `false`. Defaults to `true`.

- #### `BalanceViewer.SiblingProbePorts` \{#balanceviewer-siblingprobeports\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--balanceviewer-siblingprobeports <value>
--BalanceViewer.SiblingProbePorts <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_BALANCEVIEWERCONFIG_SIBLINGPROBEPORTS=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"BalanceViewer": {
"SiblingProbePorts": <value>
}
}
```
</TabItem>
</Tabs>

Comma-separated localhost ports probed to discover sibling Nethermind nodes on other chains for the multi-chain balance view. Defaults to `8545,8546,8547,8548,8549,8550`.


### BalRecorder

- #### `BalRecorder.Path` \{#balrecorder-path\}
Expand Down