Skip to main content

admin

Used to perform administrative tasks.

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>

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>

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>

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

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

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

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

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

data-validator-path

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

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

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

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

network

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

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

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

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>

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>

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

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

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

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

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

data-validator-path

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

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

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

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

network

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

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.