diff --git a/docs/cli/backfill-statesync-txs.md b/docs/cli/backfill-statesync-txs.md new file mode 100644 index 0000000000..0b33ae4c1e --- /dev/null +++ b/docs/cli/backfill-statesync-txs.md @@ -0,0 +1,11 @@ +# Backfill StateSync Txs + +The ```backfill-statesync-txs``` command receives a trusted file containing statesync txs and events from a time period and backfill it into the database. It walks over the block period checking any missing data and backfilling them. It writes just over KV database, which means the data which were supposed to already be on ancient will be now always at ancient. + +## Options + +- ```backfill-file```: Path of the file containing the backfill data + +- ```datadir```: Path of the data directory to store information + +- ```keystore```: Path of the data directory to store keys \ No newline at end of file diff --git a/docs/cli/server.md b/docs/cli/server.md index d1b58bac89..439dca0431 100644 --- a/docs/cli/server.md +++ b/docs/cli/server.md @@ -114,6 +114,10 @@ The ```bor server``` command runs the Bor client. - ```witness.fastforwardthreshold```: Minimum necessary distance between local header and chain tip to trigger fast forward (default: 6400) +- ```witness.parallelstatelessimport```: Enable parallel stateless block import (default: false) + +- ```witness.parallelstatelessimportworkers```: Number of workers to use for parallel stateless import (0 = GOMAXPROCS) (default: 0) + - ```witness.producewitnesses```: Produce witnesses while syncing (default: false) - ```witness.syncwithwitnesses```: Sync blocks with witnesses (default: false) @@ -134,12 +138,20 @@ The ```bor server``` command runs the Bor client. - ```cache```: Megabytes of memory allocated to internal caching (default: 1024) +- ```cache.addresscachesizes```: Address-specific cache sizes for biased caching in MB (format: address=sizeMB,address=sizeMB, e.g. 0x1234...=1024,0x5678...=512) + - ```cache.blocklogs```: Size (in number of blocks) of the log cache for filtering (default: 32) - ```cache.database```: Percentage of cache memory allowance to use for database io (default: 50) - ```cache.gc```: Percentage of cache memory allowance to use for trie pruning (default: 25) +- ```cache.godebug```: Set GODEBUG variables for runtime debugging (e.g. 'gctrace=1,gcpacertrace=1') + +- ```cache.gogc```: Set GOGC percentage for garbage collection trigger (default: 100) (default: 100) + +- ```cache.gomemlimit```: Set GOMEMLIMIT for the runtime (e.g. '34GB', '34359738368'). Empty means no limit + - ```cache.noprefetch```: Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data) (default: false) - ```cache.preimages```: Enable recording the SHA3/keccak preimages of trie keys (default: false) @@ -284,9 +296,11 @@ The ```bor server``` command runs the Bor client. ### Sealer Options +- ```allow-gas-tip-override```: Allows block producers to override the mining gas tip (default: false) + - ```mine```: Enable mining (default: false) -- ```allow-gas-tip-override```: Allows block producers to override the mining gas tip (default: false) +- ```miner.blocktime```: The block time defined by the miner. Needs to be larger or equal to the consensus block time. If not set (default = 0), the miner will use the consensus block time. (default: 0s) - ```miner.etherbase```: Public address for block mining rewards