Skip to content

Commit 9287ac6

Browse files
committed
Fix linter errors.
Signed-off-by: bgravenorst <[email protected]>
1 parent ca5364b commit 9287ac6

File tree

3 files changed

+32
-21
lines changed

3 files changed

+32
-21
lines changed

Diff for: docs/how-to/run-a-bootnode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111
## What is a bootnode?
1212

1313
When a new node joins the Ethereum network, it must connect to other nodes in the same network. This
14-
process is generally referred to as peering.
14+
process is referred to as peering.
1515

1616
Ethereum uses the Discovery protocol to find new peers. The process starts with a small set of nodes, known
1717
as bootnodes, that are hard coded into Ethereum clients. The Discovery protocol allows nodes to locate and

Diff for: docs/reference/cli/subcommands/development.md

-5
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ Generate a genesis state for a network.
1616
teku genesis
1717
```
1818

19-
<!-- links -->
20-
21-
[environment variables]: ../index.md##teku-environment-variables
22-
[configuration file]: ../../../how-to/configure/use-config-file.md
23-
2419
## `peer`
2520

2621
Generate a list of peer IDs, including the private key, public key, and peer ID.

Diff for: docs/reference/cli/subcommands/validator-client.md

+31-15
Original file line numberDiff line numberDiff line change
@@ -269,13 +269,17 @@ Specify where to output log information. Valid options are:
269269
- `DEFAULT_BOTH`
270270
- `FILE`
271271

272-
The default is `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain events are displayed on the console, and errors and other information are logged to a file. Specify the log file with the [`--log-file`](#log-file) command-line option.
272+
The default is `DEFAULT_BOTH`. When using `BOTH` or `DEFAULT_BOTH`, system updates such as blockchain events
273+
are displayed on the console, and errors and other information are logged to a file. Specify the log file
274+
with the [`--log-file`](#log-file) command-line option.
273275

274276
For production systems we recommend using the `CONSOLE` or `FILE` options to ensure all log information is available in one place.
275277

276278
:::note
277279

278-
Use `DEFAULT_BOTH` when using a [custom Log4J2 configuration file](../../../how-to/monitor/configure-logging.md#advanced-custom-logging). Any other option applies the custom logging changes on top of its default settings.
280+
Use `DEFAULT_BOTH` when using a
281+
[custom Log4J2 configuration file](../../../how-to/monitor/configure-logging.md#advanced-custom-logging). Any
282+
other option applies the custom logging changes on top of its default settings.
279283

280284
:::
281285

@@ -466,7 +470,9 @@ metrics-categories: ["BEACON", "JVM", "PROCESS"]
466470
</TabItem>
467471
</Tabs>
468472

469-
Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`, `VALIDATOR_DUTY`.
473+
Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`,
474+
`LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`, `REMOTE_VALIDATOR`, `VALIDATOR`,
475+
`VALIDATOR_PERFORMANCE`, `VALIDATOR_DUTY`.
470476

471477
When `metrics-categories` is used, only the categories specified in this option are enabled (all other categories are disabled).
472478

@@ -693,9 +699,11 @@ validator-keys: "/home/validator/keys:home/validator/passwords"
693699
</TabItem>
694700
</Tabs>
695701

696-
Directory or file to load the encrypted keystore file(s) and associated password file(s) from. Keystore files must use the `.json` file extension, and password files must use the `.txt` file extension.
702+
Directory or file to load the encrypted keystore files and associated password files from. Keystore files
703+
must use the `.json` file extension, and password files must use the `.txt` file extension.
697704

698-
When specifying directories, Teku expects to find identically named keystore and password files. For example `validator_217179e.json` and `validator_217179e.txt`.
705+
When specifying directories, Teku expects to find identically named keystore and password files. For
706+
example `validator_217179e.json` and `validator_217179e.txt`.
699707

700708
When specifying file names, Teku expects that the files exist.
701709

@@ -738,13 +746,16 @@ validators-early-attestations-enabled: false
738746
</TabItem>
739747
</Tabs>
740748

741-
Specify whether to use Teku's built-in early attestation production, which creates an attestation once a block is received. The default is `true`.
749+
Specify whether to use Teku's built-in early attestation production, which creates an attestation once a block is
750+
received. The default is `true`.
742751

743-
Set this option to `false` if running a validator client connected to a load balanced beacon node (including most hosted beacon nodes such as [Infura]), and validator effectiveness is poor.
752+
Set this option to `false` if running a validator client connected to a load balanced beacon node
753+
(including most hosted beacon nodes such as [Infura]), and validator effectiveness is poor.
744754

745755
:::note
746756

747-
Delaying attestation production increases the chances of generating a correct attestation when using a load balanced beacon node, but it increases the risk of inclusion delays.
757+
Delaying attestation production increases the chances of generating a correct attestation when using a load
758+
balanced beacon node, but it increases the risk of inclusion delays.
748759

749760
:::
750761

@@ -861,7 +872,8 @@ Use the URL to load the public keys from a remote service. For example:
861872
--validators-external-signer-public-keys=http://localhost:9900/api/v1/eth2/publicKeys
862873
```
863874

864-
Use the value `external-signer` to load all public keys managed by the external signer. Teku automatically queries the external signer's [public keys endpoint](https://consensys.github.io/web3signer/web3signer-eth2.html#tag/Public-Key).
875+
Use the value `external-signer` to load all public keys managed by the external signer. Teku automatically
876+
queries the external signer's [public keys endpoint](https://consensys.github.io/web3signer/web3signer-eth2.html#tag/Public-Key).
865877

866878
```bash
867879
--validators-external-signer-public-keys=external-signer
@@ -906,11 +918,13 @@ Set this option to `false` if using the slashing protection implemented by an ex
906918

907919
:::warning
908920

909-
Ensure the external signer has slashing protection enabled before disabling Teku slashing protection, otherwise a validator may get slashed.
921+
Ensure the external signer has slashing protection enabled before disabling Teku slashing protection, otherwise
922+
a validator may get slashed.
910923

911924
:::
912925

913-
Built-in slashing protection can only be disabled for validators using external signers. Validators using Teku to sign blocks and attestations always uses its built-in slashing protection.
926+
Built-in slashing protection can only be disabled for validators using external signers. Validators using
927+
Teku to sign blocks and attestations always uses its built-in slashing protection.
914928

915929
## `validators-external-signer-timeout`
916930

@@ -980,7 +994,8 @@ validators-external-signer-truststore: "websigner_truststore.p12"
980994
</TabItem>
981995
</Tabs>
982996

983-
PKCS12 or JKS keystore used to trust external signer's self-signed certificate or CA certificate which signs the external signer's certificate.
997+
PKCS12 or JKS keystore used to trust external signer's self-signed certificate or CA certificate which
998+
signs the external signer's certificate.
984999

9851000
## `validators-external-signer-truststore-password-file`
9861001

@@ -1122,7 +1137,8 @@ validators-graffiti-file: "/Users/me/mynode/graffiti.txt"
11221137
</TabItem>
11231138
</Tabs>
11241139

1125-
File containing the validator graffiti to add when creating a block. The file content is converted to `bytes` and padded to `Bytes32`. The same graffiti is used for all validators started with this beacon node.
1140+
File containing the validator graffiti to add when creating a block. The file content is converted to `bytes`
1141+
and padded to `Bytes32`. The same graffiti is used for all validators started with this beacon node.
11261142

11271143
You can overwrite the file while Teku is running to update the graffiti.
11281144

@@ -1200,12 +1216,12 @@ validators-performance-tracking-mode: LOGGING
12001216

12011217
Set the validator performance tracking strategy. Valid options are `LOGGING`, `METRICS`, `ALL`, and `NONE`. The default is `ALL`.
12021218

1203-
When `LOGGING` is enabled, attestation and block performance is reported as log messages. When `METRICS` is enabled, attestation and block performance is reported using [metrics] in the [`VALIDATOR_PERFORMANCE`](#metrics-categories) metrics category.
1219+
When `LOGGING` is enabled, attestation and block performance is reported as log messages. When `METRICS` is
1220+
enabled, attestation and block performance is reported using [metrics] in the [`VALIDATOR_PERFORMANCE`](#metrics-categories) metrics category.
12041221

12051222
<!-- links -->
12061223

12071224
[environment variables or a configuration file]: ../index.md#specifying-options
12081225
[Web3Signer]: https://docs.web3signer.consensys.net/en/latest/
12091226
[slashing protection]: ../../../concepts/slashing-protection.md
1210-
[recent finalized checkpoint state from which to sync]: ../../../get-started/checkpoint-start.md
12111227
[metrics]: ../../../how-to/monitor/use-metrics.md

0 commit comments

Comments
 (0)