Skip to content
You are reading the Teku development version documentation and some features may not be available in the stable release. You can switch to the stable version using the version box at the bottom of the screen.

Updated on November 18, 2020

admin

Used to perform administrative tasks. To use the admin subcommand run:

teku admin [subcommand] [subcommand] [options]

You can also supply the subcommand options using environment variables or a configuration file.

weak-subjectivity

Display or clear weak subjectivity configuration.

clear-state

Clears the stored weak subjectivity configuration.

config-file

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

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

data-base-path, data-path

teku admin weak-subjectivity clear-state --data-base-path=<PATH>
teku admin weak-subjectivity clear-state --data-base-path=/home/me/me_node
TEKU_DATA_BASE_PATH=/home/me/me_node
data-base-path: "/home/me/me_node"

The 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

teku admin weak-subjectivity clear-state --data-beacon-path=<PATH>
teku admin weak-subjectivity clear-state --data-beacon-path=/home/me/me_beacon
TEKU_DATA_BEACON_PATH=/home/me/me_beacon
data-beacon-path: "/home/me/me_beaon"

Path to the beacon chain client data. Defaults to <data-base-path>/beacon where <data-base-path> is specified using --data-base-path.

data-storage-archive-frequency

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

Set the frequency (in slots) at which to store finalized states to disk. Defaults to 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

teku admin weak-subjectivity clear-state --data-storage-mode=<STORAGE_MODE>
teku admin weak-subjectivity clear-state --data-storage-mode=archive
TEKU_DATA_STORAGE_MODE=archive
data-storage-mode: "archive"

Set the strategy for handling historical chain data. Valid options are prune and archive. Defaults to prune.

data-validator-path

teku admin weak-subjectivity clear-state --data-validator-path=<PATH>
teku admin weak-subjectivity clear-state --data-validator-path=/home/me/me_validator
TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator
data-validator-path: "/home/me/me_validator"

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

initial-state

teku admin weak-subjectivity clear-state --initial-state=<FILE>
teku admin weak-subjectivity clear-state --initial-state=/home/me/genesis.ssz
TEKU_INITIAL_STATE=/home/me/genesis.ssz
initial-state: "/home/me/genesis.ssz"

Path or URL to the network genesis file.

This option does not need to be specified if the initial state is provided by the network specified using the --network option.

network

teku admin weak-subjectivity clear-state --network=<NETWORK>
teku admin weak-subjectivity clear-state --network=mainnet
TEKU_NETWORK=mainnet
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:

Network Chain Type Description
mainnet Eth 2.0 Production Main network.
altona Eth 2.0 Test Multi-client testnet maintained by the Goerli testnet initiative.
medalla Eth 2.0 Test Multi-client testnet maintained by the Goerli testnet initiative.
minimal Eth 2.0 Test Used for local testing and development networks.
pyrmont Eth 2.0 Test Multi-client testnet maintained by the Goerli testnet initiative.

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

display-state

Displays the stored weak subjectivity configuration.

config-file

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

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

data-base-path, data-path

teku admin weak-subjectivity display-state --data-base-path=<PATH>
teku admin weak-subjectivity display-state --data-base-path=/home/me/me_node
TEKU_DATA_BASE_PATH=/home/me/me_node
data-base-path: "/home/me/me_node"

The 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

teku admin weak-subjectivity display-state --data-beacon-path=<PATH>
teku admin weak-subjectivity display-state --data-beacon-path=/home/me/me_beacon
TEKU_DATA_BEACON_PATH=/home/me/me_beacon
data-beacon-path: "/home/me/me_beaon"

Path to the beacon chain client data. Defaults to <data-base-path>/beacon where <data-base-path> is specified using --data-base-path.

data-storage-archive-frequency

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

Set the frequency (in slots) at which to store finalized states to disk. Defaults to 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

teku admin weak-subjectivity display-state --data-storage-mode=<STORAGE_MODE>
teku admin weak-subjectivity display-state --data-storage-mode=archive
TEKU_DATA_STORAGE_MODE=archive
data-storage-mode: "archive"

Set the strategy for handling historical chain data. Valid options are prune and archive. Defaults to prune.

data-validator-path

teku admin weak-subjectivity display-state --data-validator-path=<PATH>
teku admin weak-subjectivity display-state --data-validator-path=/home/me/me_validator
TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator
data-validator-path: "/home/me/me_validator"

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

initial-state

teku admin weak-subjectivity display-state --initial-state=<FILE>
teku admin weak-subjectivity display-state --initial-state=/home/me/genesis.ssz
TEKU_INITIAL_STATE=/home/me/genesis.ssz
initial-state: "/home/me/genesis.ssz"

Path or URL to the network genesis file.

This option does not need to be specified if the initial state is provided by the network specified using the --network option.

network

teku admin weak-subjectivity display-state --network=<NETWORK>
teku admin weak-subjectivity display-state --network=mainnet
TEKU_NETWORK=mainnet
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:

Network Chain Type Description
mainnet Eth 2.0 Production Main network.
altona Eth 2.0 Test Multi-client testnet maintained by the Goerli testnet initiative.
medalla Eth 2.0 Test Multi-client testnet maintained by the Goerli testnet initiative.
minimal Eth 2.0 Test Used for local testing and development networks.
pyrmont Eth 2.0 Test Multi-client testnet maintained by the Goerli testnet initiative.

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

Questions or feedback? You can discuss issues and obtain free support on Teku Discord channel.
For paid professional support by Consensys, contact us at quorum@consensys.net