2020-05-05 08:19:17 +00:00
// Copyright 2020 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// go-ethereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
package utils
import (
"fmt"
all: activate pbss as experimental feature (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-10 19:21:36 +00:00
"github.com/ethereum/go-ethereum/eth/ethconfig"
2022-06-27 16:22:36 +00:00
"github.com/ethereum/go-ethereum/internal/flags"
"github.com/urfave/cli/v2"
2020-05-05 08:19:17 +00:00
)
2022-06-27 16:22:36 +00:00
var ShowDeprecated = & cli . Command {
2020-05-05 08:19:17 +00:00
Action : showDeprecated ,
Name : "show-deprecated-flags" ,
Usage : "Show flags that have been deprecated" ,
ArgsUsage : " " ,
Description : "Show flags that have been deprecated and will soon be removed" ,
}
2021-08-10 08:28:33 +00:00
var DeprecatedFlags = [ ] cli . Flag {
2021-08-17 16:49:19 +00:00
NoUSBFlag ,
2023-07-11 19:21:32 +00:00
LegacyWhitelistFlag ,
cmd, core, eth, graphql, trie: no persisted clean trie cache file (#27525)
The clean trie cache is persisted periodically, therefore Geth can
quickly warmup the cache in next restart.
However it will reduce the robustness of system. The assumption is
held in Geth that if the parent trie node is present, then the entire
sub-trie associated with the parent are all prensent.
Imagine the scenario that Geth rewinds itself to a past block and
restart, but Geth finds the root node of "future state" in clean
cache then regard this state is present in disk, while is not in fact.
Another example is offline pruning tool. Whenever an offline pruning
is performed, the clean cache file has to be removed to aviod hitting
the root node of "deleted states" in clean cache.
All in all, compare with the minor performance gain, system robustness
is something we care more.
2023-07-04 07:21:06 +00:00
CacheTrieJournalFlag ,
CacheTrieRejournalFlag ,
2023-07-11 19:21:32 +00:00
LegacyDiscoveryV5Flag ,
all: activate pbss as experimental feature (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-10 19:21:36 +00:00
TxLookupLimitFlag ,
2021-08-10 08:28:33 +00:00
}
2020-05-05 08:19:17 +00:00
var (
2023-07-11 19:21:32 +00:00
// Deprecated May 2020, shown in aliased flags section
2022-06-27 16:22:36 +00:00
NoUSBFlag = & cli . BoolFlag {
Name : "nousb" ,
Usage : "Disables monitoring for and managing USB hardware wallets (deprecated)" ,
Category : flags . DeprecatedCategory ,
2021-08-17 16:49:19 +00:00
}
2023-07-11 19:21:32 +00:00
// Deprecated March 2022
LegacyWhitelistFlag = & cli . StringFlag {
Name : "whitelist" ,
Usage : "Comma separated block number-to-hash mappings to enforce (<number>=<hash>) (deprecated in favor of --eth.requiredblocks)" ,
Category : flags . DeprecatedCategory ,
}
// Deprecated July 2023
cmd, core, eth, graphql, trie: no persisted clean trie cache file (#27525)
The clean trie cache is persisted periodically, therefore Geth can
quickly warmup the cache in next restart.
However it will reduce the robustness of system. The assumption is
held in Geth that if the parent trie node is present, then the entire
sub-trie associated with the parent are all prensent.
Imagine the scenario that Geth rewinds itself to a past block and
restart, but Geth finds the root node of "future state" in clean
cache then regard this state is present in disk, while is not in fact.
Another example is offline pruning tool. Whenever an offline pruning
is performed, the clean cache file has to be removed to aviod hitting
the root node of "deleted states" in clean cache.
All in all, compare with the minor performance gain, system robustness
is something we care more.
2023-07-04 07:21:06 +00:00
CacheTrieJournalFlag = & cli . StringFlag {
Name : "cache.trie.journal" ,
Usage : "Disk journal directory for trie cache to survive node restarts" ,
2023-07-11 19:21:32 +00:00
Category : flags . DeprecatedCategory ,
cmd, core, eth, graphql, trie: no persisted clean trie cache file (#27525)
The clean trie cache is persisted periodically, therefore Geth can
quickly warmup the cache in next restart.
However it will reduce the robustness of system. The assumption is
held in Geth that if the parent trie node is present, then the entire
sub-trie associated with the parent are all prensent.
Imagine the scenario that Geth rewinds itself to a past block and
restart, but Geth finds the root node of "future state" in clean
cache then regard this state is present in disk, while is not in fact.
Another example is offline pruning tool. Whenever an offline pruning
is performed, the clean cache file has to be removed to aviod hitting
the root node of "deleted states" in clean cache.
All in all, compare with the minor performance gain, system robustness
is something we care more.
2023-07-04 07:21:06 +00:00
}
CacheTrieRejournalFlag = & cli . DurationFlag {
Name : "cache.trie.rejournal" ,
Usage : "Time interval to regenerate the trie cache journal" ,
2023-07-11 19:21:32 +00:00
Category : flags . DeprecatedCategory ,
}
LegacyDiscoveryV5Flag = & cli . BoolFlag {
Name : "v5disc" ,
Usage : "Enables the experimental RLPx V5 (Topic Discovery) mechanism (deprecated, use --discv5 instead)" ,
Category : flags . DeprecatedCategory ,
cmd, core, eth, graphql, trie: no persisted clean trie cache file (#27525)
The clean trie cache is persisted periodically, therefore Geth can
quickly warmup the cache in next restart.
However it will reduce the robustness of system. The assumption is
held in Geth that if the parent trie node is present, then the entire
sub-trie associated with the parent are all prensent.
Imagine the scenario that Geth rewinds itself to a past block and
restart, but Geth finds the root node of "future state" in clean
cache then regard this state is present in disk, while is not in fact.
Another example is offline pruning tool. Whenever an offline pruning
is performed, the clean cache file has to be removed to aviod hitting
the root node of "deleted states" in clean cache.
All in all, compare with the minor performance gain, system robustness
is something we care more.
2023-07-04 07:21:06 +00:00
}
all: activate pbss as experimental feature (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-10 19:21:36 +00:00
// Deprecated August 2023
TxLookupLimitFlag = & cli . Uint64Flag {
Name : "txlookuplimit" ,
Usage : "Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain) (deprecated, use history.transactions instead)" ,
Value : ethconfig . Defaults . TransactionHistory ,
Category : flags . DeprecatedCategory ,
}
2020-05-05 08:19:17 +00:00
)
// showDeprecated displays deprecated flags that will be soon removed from the codebase.
2022-06-27 16:22:36 +00:00
func showDeprecated ( * cli . Context ) error {
2020-05-05 08:19:17 +00:00
fmt . Println ( "--------------------------------------------------------------------" )
fmt . Println ( "The following flags are deprecated and will be removed in the future!" )
fmt . Println ( "--------------------------------------------------------------------" )
fmt . Println ( )
2021-08-10 08:28:33 +00:00
for _ , flag := range DeprecatedFlags {
fmt . Println ( flag . String ( ) )
}
2021-02-24 13:07:58 +00:00
fmt . Println ( )
2022-06-27 16:22:36 +00:00
return nil
2020-05-05 08:19:17 +00:00
}