state_history_plugin
Overview
The state_history_plugin is a valuable tool for capturing and storing historical information about the state of the blockchain. This plugin operates by receiving blockchain data from other interconnected nodes and then storing that data into files. Additionally, the plugin establishes a socket connection to listen for incoming connections from applications. Once connected, it can provide the requested blockchain data based on the specific options set for the plugin when initiating the nodeos instance.
Usage
# config.ini
plugin = eosio::state_history_plugin
[options]
# command-line
nodeos ... --plugin eosio::state_history_plugin [operations] [options]
Operations
These can only be specified from the nodeos command-line:
Command Line Options for state_history_plugin
| Option (=default) | Description |
|---|---|
--delete-state-history | clear state history files |
Options
These can be specified from either the nodeos command-line or the config.ini file:
Config Options for state_history_plugin
| Option (=default) | Description |
|---|---|
--state-history-dir arg (="state-history") | the location of the state-history directory (absolute path or relative to application data dir) |
--state-history-retained-dir arg | the location of the state history retained directory (absolute path or relative to state-history dir). |
--state-history-archive-dir arg | the location of the state history archive directory (absolute path or relative to state-history dir). If the value is empty string, blocks files beyond the retained limit will be deleted. All files in the archive directory are completely under user's control, i.e. they won't be accessed by nodeos anymore. |
--state-history-stride arg | split the state history log files when the block number is the multiple of the stride When the stride is reached, the current history log and index will be renamed '*-history-^start num^-^end num^.log/index' and a new current history log and index will be created with the most recent blocks. All files following this format will be used to construct an extended history log. |
--max-retained-history-files arg | the maximum number of history file groups to retain so that the blocks in those files can be queried. When the number is reached, the oldest history file would be moved to archive dir or deleted if the archive dir is empty. The retained history log files should not be manipulated by users. |
--trace-history | enable trace history |
--chain-state-history | enable chain state history |
--state-history-endpoint arg (=127.0.0.1:8080) | the endpoint upon which to listen for incoming connections. Caution: only expose this port to your internal network. |
--state-history-unix-socket-path arg | the path (relative to data-dir) to create a unix socket upon which to listen for incoming connections. |
--trace-history-debug-mode | enable debug mode for trace history |
--state-history-log-retain-blocks arg | if set, periodically prune the state history files to store only configured number of most recent blocks |
Examples
- How to replay or resync with full history
- How to create a portable snapshot with full state history
- How to restore a portable snapshot with full state history
Dependencies
Load Dependency Examples
# config.ini
plugin = eosio::chain_plugin --disable-replay-opts
# command-line
nodeos ... --plugin eosio::chain_plugin --disable-replay-opts