Skip to main content
Version: 23.10.0

admin

Used to perform administrative tasks.

weak-subjectivity

Display or clear weak subjectivity configuration.

clear-state

Clears the stored weak subjectivity configuration.

config-file

Syntax

teku admin weak-subjectivity clear-state --config-file=<FILE>

Example

teku admin weak-subjectivity clear-state --config-file=/home/me/me_node/config.yaml

Environment variable

TEKU_CONFIG_FILE=/home/me/me_node/config.yaml

Path to the YAML configuration file. The default is none.

data-base-path, data-path

Syntax

teku admin weak-subjectivity clear-state --data-base-path=<PATH>

Example

teku admin weak-subjectivity clear-state --data-base-path=/home/me/me_node

Environment variable

TEKU_DATA_BASE_PATH=/home/me/me_node

Configuration file

data-base-path: "/home/me/me_node"

Path to the Teku data directory. The default directory is OS-dependent:

  • macOS: ~/Library/teku
  • Unix/Linux: $XDG_DATA_HOME/teku if $XDG_DATA_HOME is set; otherwise ~/.local/share/teku
  • Windows: %localappdata%\teku.

The default Docker image location is /root/.local/share/teku.

data-beacon-path

Syntax

teku admin weak-subjectivity clear-state --data-beacon-path=<PATH>

Example

teku admin weak-subjectivity clear-state --data-beacon-path=/home/me/me_beacon

Environment variable

TEKU_DATA_BEACON_PATH=/home/me/me_beacon

Configuration file

data-beacon-path: "/home/me/me_beaon"

Path to the beacon node data. The default is <data-base-path>/beacon where <data-base-path> is specified using --data-base-path.

data-storage-archive-frequency

Syntax

teku admin weak-subjectivity clear-state --data-storage-archive-frequency=<NUMBER>

Example

teku admin weak-subjectivity clear-state --data-storage-archive-frequency=1028

Environment variable

TEKU_DATA_STORAGE_ARCHIVE_FREQUENCY=1028

Configuration file

data-storage-archive-frequency: 1028

Set the frequency (in slots) at which to store finalized states to disk. The default is 2048.

This option is ignored if --data-storage-mode is set to prune.

note

Specifying a larger number of slots as the archive frequency has a potentially higher overhead for retrieving finalized states since more states may need to be regenerated to get to the requested state. Specifying a lower number of slots as the frequency increases the disk space usage.

For example, --data-storage-archive-frequency=1 uses maximum disk space but has the lowest response time for retrieving a finalized state since each slot state is saved, whereas --data-storage-archive-frequency=2048 uses less disk space, but may need to regenerate the state because every 2048th slot state is saved.

data-storage-mode

Syntax

teku admin weak-subjectivity clear-state --data-storage-mode=<STORAGE_MODE>

Example

teku admin weak-subjectivity clear-state --data-storage-mode=archive

Environment variable

TEKU_DATA_STORAGE_MODE=archive

Configuration file

data-storage-mode: "archive"

Set the strategy for handling historical chain data. Valid options are minimal, prune and archive. The default is prune.

data-validator-path

Syntax

teku admin weak-subjectivity clear-state --data-validator-path=<PATH>

Example

teku admin weak-subjectivity clear-state --data-validator-path=/home/me/me_validator

Environment variable

TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator

Configuration file

data-validator-path: "/home/me/me_validator"

Path to the validator client data. The default is <data-base-path>/validator where <data-base-path> is specified using --data-base-path.

eth1-deposit-contract-address

Syntax

teku admin weak-subjectivity clear-state --eth1-deposit-contract-address=<ADDRESS>

Example

teku admin weak-subjectivity clear-state --eth1-deposit-contract-address=0x77f7bED277449F51505a4C54550B074030d989bC

Environment variable

TEKU_ETH1_DEPOSIT_CONTRACT_ADDRESS=0x77f7bED277449F51505a4C54550B074030d989bC

Configuration file

eth1-deposit-contract-address: "0x77f7bED277449F51505a4C54550B074030d989bC"

The address of the deposit contract. Only required when creating a custom network.

network

Syntax

teku admin weak-subjectivity clear-state --network=<NETWORK>

Example

teku admin weak-subjectivity clear-state --network=mainnet

Environment variable

TEKU_NETWORK=mainnet

Configuration file

network: "mainnet"

Predefined network configuration. Accepts a predefined network name, or file path or URL to a YAML configuration file. The default is mainnet.

Possible values are:

NetworkChainTypeDescription
mainnetConsensus layerProductionMain network
minimalConsensus layerTestUsed for local testing and development networks
holeskyConsensus layerTestMulti-client testnet
goerliConsensus layerTestMulti-client testnet
gnosisConsensus layerProductionNetwork for the Gnosis chain
sepoliaConsensus layerTestMulti-client testnet
chiadoConsensus layerTestGnosis testnet
luksoConsensus layerProductionNetwork for the Lukso chain

Predefined networks can provide defaults such the initial state of the network, bootnodes, and the address of the deposit contract.

display-state

Displays the stored weak subjectivity configuration.

config-file

Syntax

teku admin weak-subjectivity display-state --config-file=<FILE>

Example

teku admin weak-subjectivity display-state --config-file=/home/me/me_node/config.yaml

Environment variable

TEKU_CONFIG_FILE=/home/me/me_node/config.yaml

Path to the YAML configuration file. The default is none.

data-base-path, data-path

Syntax

teku admin weak-subjectivity display-state --data-base-path=<PATH>

Example

teku admin weak-subjectivity display-state --data-base-path=/home/me/me_node

Environment variable

TEKU_DATA_BASE_PATH=/home/me/me_node

Configuration file

data-base-path: "/home/me/me_node"

Path to the Teku data directory. The default directory is OS-dependent:

  • macOS: ~/Library/teku
  • Unix/Linux: $XDG_DATA_HOME/teku if $XDG_DATA_HOME is set; otherwise ~/.local/share/teku
  • Windows: %localappdata%\teku.

The default Docker image location is /root/.local/share/teku.

data-beacon-path

Syntax

teku admin weak-subjectivity display-state --data-beacon-path=<PATH>

Example

teku admin weak-subjectivity display-state --data-beacon-path=/home/me/me_beacon

Environment variable

TEKU_DATA_BEACON_PATH=/home/me/me_beacon

Configuration file

data-beacon-path: "/home/me/me_beacon"

Path to the beacon node data. The default is <data-base-path>/beacon where <data-base-path> is specified using --data-base-path.

data-storage-archive-frequency

Syntax

teku admin weak-subjectivity display-state --data-storage-archive-frequency=<NUMBER>

Example

teku admin weak-subjectivity display-state --data-storage-archive-frequency=1028

Environment variable

TEKU_DATA_STORAGE_ARCHIVE_FREQUENCY=1028

Configuration file

data-storage-archive-frequency: 1028

Set the frequency (in slots) at which to store finalized states to disk. The default is 2048.

This option is ignored if --data-storage-mode is not set to archive.

note

Specifying a larger number of slots as the archive frequency has a potentially higher overhead for retrieving finalized states since more states may need to be regenerated to get to the requested state. Specifying a lower number of slots as the frequency increases the disk space usage.

For example, --data-storage-archive-frequency=1 uses maximum disk space but has the lowest response time for retrieving a finalized state since each slot state is saved, whereas --data-storage-archive-frequency=2048 uses less disk space, but may need to regenerate the state because every 2048th slot state is saved.

data-storage-mode

Syntax

teku admin weak-subjectivity display-state --data-storage-mode=<STORAGE_MODE>

Example

teku admin weak-subjectivity display-state --data-storage-mode=archive

Environment variable

TEKU_DATA_STORAGE_MODE=archive

Configuration file

data-storage-mode: "archive"

Set the strategy for handling historical chain data. Valid options are minimal, prune and archive. The default is minimal.

data-validator-path

Syntax

teku admin weak-subjectivity display-state --data-validator-path=<PATH>

Example

teku admin weak-subjectivity display-state --data-validator-path=/home/me/me_validator

Environment variable

TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator

Configuration file

data-validator-path: "/home/me/me_validator"

Path to the validator client data. The default is <data-base-path>/validator where <data-base-path> is specified using --data-base-path.

eth1-deposit-contract-address

Syntax

teku admin weak-subjectivity display-state --eth1-deposit-contract-address=<ADDRESS>

Example

teku admin weak-subjectivity display-state --eth1-deposit-contract-address=0x77f7bED277449F51505a4C54550B074030d989bC

Environment variable

TEKU_ETH1_DEPOSIT_CONTRACT_ADDRESS=0x77f7bED277449F51505a4C54550B074030d989bC

Configuration file

eth1-deposit-contract-address: "0x77f7bED277449F51505a4C54550B074030d989bC"

The address of the deposit contract. Only required when creating a custom network.

network

Syntax

teku admin weak-subjectivity display-state --network=<NETWORK>

Example

teku admin weak-subjectivity display-state --network=mainnet

Environment variable

TEKU_NETWORK=mainnet

Configuration file

network: "mainnet"

Predefined network configuration. Accepts a predefined network name, or file path or URL to a YAML configuration file. The default is mainnet.

Possible values are:

NetworkChainTypeDescription
mainnetConsensus layerProductionMain network
minimalConsensus layerTestUsed for local testing and development networks
goerliConsensus layerTestMulti-client testnet
gnosisConsensus layerProductionNetwork for the Gnosis chain
holeskyConsensus layerTestMulti-client testnet
sepoliaConsensus layerTestMulti-client testnet
chiadoConsensus layerTestGnosis testnet
luksoConsensus layerProductionNetwork for the Lukso chain

Predefined networks can provide defaults such the initial state of the network, bootnodes, and the address of the deposit contract.