state history plugin
Description
The state_history_plugin is useful for capturing historical data about the blockchain state. The plugin receives blockchain data from other connected nodes and caches the data into files. The plugin listens on a socket for applications to connect and sends blockchain data back based on the plugin options specified when starting nodeos.
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 eosio::state_history_plugin:
--delete-state-history clear state history files
Options
These can be specified from both the nodeos command-line or the config.ini file:
Config Options for eosio::state_history_plugin:
--state-history-dir arg (="state-history")
the location of the state-history
directory (absolute path or relative to
application data dir)
--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
Dependencies
Load Dependency Examples
# config.ini
plugin = eosio::chain_plugin --disable-replay-opts
# command-line
nodeos ... --plugin eosio::chain_plugin --disable-replay-opts