From c02e2cbb935429003c5ef230631fcc3ed7a3e221 Mon Sep 17 00:00:00 2001 From: Jerry Date: Tue, 17 May 2022 17:07:14 -0700 Subject: [PATCH] Rename whitelist to requiredblocks --- docs/cli/bootnode.md | 2 +- docs/cli/server.md | 6 +++--- internal/cli/server/config.go | 22 +++++++++++----------- internal/cli/server/config_test.go | 8 ++++---- internal/cli/server/flags.go | 4 ++-- internal/cli/server/testdata/simple.hcl | 2 +- internal/cli/server/testdata/simple.json | 2 +- 7 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/cli/bootnode.md b/docs/cli/bootnode.md index 3e6025234140..48e933a93437 100644 --- a/docs/cli/bootnode.md +++ b/docs/cli/bootnode.md @@ -14,4 +14,4 @@ - ```save-key```: path to save the ecdsa private key -- ```dry-run``` \ No newline at end of file +- ```dry-run```: validates parameters and prints bootnode configurations, but does not start bootnode \ No newline at end of file diff --git a/docs/cli/server.md b/docs/cli/server.md index ba6f3389c5e0..beca2c2fde6f 100644 --- a/docs/cli/server.md +++ b/docs/cli/server.md @@ -18,7 +18,7 @@ The ```bor server``` command runs the Bor client. - ```gcmode```: Blockchain garbage collection mode ("full", "archive") -- ```whitelist```: Comma separated block number-to-hash mappings to enforce (=) +- ```requiredblocks```: Comma separated block number-to-hash mappings to enforce (=) - ```no-snapshot```: Disables the snapshot-database mode (default = false) @@ -72,7 +72,7 @@ The ```bor server``` command runs the Bor client. - ```cache.preimages```: Enable recording the SHA3/keccak preimages of trie keys -- ```txlookuplimit```: Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain) +- ```txlookuplimit```: Number of recent blocks to maintain transactions index for (default = about 56 days, 0 = entire chain) ### JsonRPC Options @@ -192,4 +192,4 @@ The ```bor server``` command runs the Bor client. - ```txpool.globalqueue```: Maximum number of non-executable transaction slots for all accounts -- ```txpool.lifetime```: Maximum amount of time non-executable transaction are queued +- ```txpool.lifetime```: Maximum amount of time non-executable transaction are queued \ No newline at end of file diff --git a/internal/cli/server/config.go b/internal/cli/server/config.go index a5e255ad48fa..9457a8a2700d 100644 --- a/internal/cli/server/config.go +++ b/internal/cli/server/config.go @@ -43,8 +43,8 @@ type Config struct { // Name, or identity of the node Name string `hcl:"name,optional"` - // Whitelist is a list of required (block number, hash) pairs to accept - Whitelist map[string]string `hcl:"whitelist,optional"` + // RequiredBlocks is a list of required (block number, hash) pairs to accept + RequiredBlocks map[string]string `hcl:"requiredblocks,optional"` // LogLevel is the level of the logs to put out LogLevel string `hcl:"log-level,optional"` @@ -380,11 +380,11 @@ type DeveloperConfig struct { func DefaultConfig() *Config { return &Config{ - Chain: "mainnet", - Name: Hostname(), - Whitelist: map[string]string{}, - LogLevel: "INFO", - DataDir: defaultDataDir(), + Chain: "mainnet", + Name: Hostname(), + RequiredBlocks: map[string]string{}, + LogLevel: "INFO", + DataDir: defaultDataDir(), P2P: &P2PConfig{ MaxPeers: 30, MaxPendPeers: 50, @@ -718,17 +718,17 @@ func (c *Config) buildEth(stack *node.Node) (*ethconfig.Config, error) { n.SnapDiscoveryURLs = c.P2P.Discovery.DNS } - // whitelist + // RequiredBlocks { n.PeerRequiredBlocks = map[uint64]common.Hash{} - for k, v := range c.Whitelist { + for k, v := range c.RequiredBlocks { number, err := strconv.ParseUint(k, 0, 64) if err != nil { - return nil, fmt.Errorf("invalid whitelist block number %s: %v", k, err) + return nil, fmt.Errorf("invalid required block number %s: %v", k, err) } var hash common.Hash if err = hash.UnmarshalText([]byte(v)); err != nil { - return nil, fmt.Errorf("invalid whitelist hash %s: %v", v, err) + return nil, fmt.Errorf("invalid required block hash %s: %v", v, err) } n.PeerRequiredBlocks[number] = hash } diff --git a/internal/cli/server/config_test.go b/internal/cli/server/config_test.go index 6f5f9ff97d3b..6fedd0910929 100644 --- a/internal/cli/server/config_test.go +++ b/internal/cli/server/config_test.go @@ -24,7 +24,7 @@ func TestConfigMerge(t *testing.T) { c0 := &Config{ Chain: "0", NoSnapshot: true, - Whitelist: map[string]string{ + RequiredBlocks: map[string]string{ "a": "b", }, TxPool: &TxPoolConfig{ @@ -40,7 +40,7 @@ func TestConfigMerge(t *testing.T) { } c1 := &Config{ Chain: "1", - Whitelist: map[string]string{ + RequiredBlocks: map[string]string{ "b": "c", }, P2P: &P2PConfig{ @@ -55,7 +55,7 @@ func TestConfigMerge(t *testing.T) { expected := &Config{ Chain: "1", NoSnapshot: true, - Whitelist: map[string]string{ + RequiredBlocks: map[string]string{ "a": "b", "b": "c", }, @@ -104,7 +104,7 @@ func TestConfigLoadFile(t *testing.T) { assert.NoError(t, err) assert.Equal(t, config, &Config{ DataDir: "./data", - Whitelist: map[string]string{ + RequiredBlocks: map[string]string{ "a": "b", }, P2P: &P2PConfig{ diff --git a/internal/cli/server/flags.go b/internal/cli/server/flags.go index ce93e8c0715e..cc8f474ecd26 100644 --- a/internal/cli/server/flags.go +++ b/internal/cli/server/flags.go @@ -45,9 +45,9 @@ func (c *Command) Flags() *flagset.Flagset { Value: &c.cliConfig.GcMode, }) f.MapStringFlag(&flagset.MapStringFlag{ - Name: "whitelist", + Name: "requiredblocks", Usage: "Comma separated block number-to-hash mappings to enforce (=)", - Value: &c.cliConfig.Whitelist, + Value: &c.cliConfig.RequiredBlocks, }) f.BoolFlag(&flagset.BoolFlag{ Name: "no-snapshot", diff --git a/internal/cli/server/testdata/simple.hcl b/internal/cli/server/testdata/simple.hcl index e276960e6d4d..5afc09185907 100644 --- a/internal/cli/server/testdata/simple.hcl +++ b/internal/cli/server/testdata/simple.hcl @@ -1,6 +1,6 @@ data-dir = "./data" -whitelist = { +requiredblocks = { a = "b" } diff --git a/internal/cli/server/testdata/simple.json b/internal/cli/server/testdata/simple.json index 277f05d1059e..6270ee6d13c5 100644 --- a/internal/cli/server/testdata/simple.json +++ b/internal/cli/server/testdata/simple.json @@ -1,6 +1,6 @@ { "data-dir": "./data", - "whitelist": { + "requiredblocks": { "a": "b" }, "p2p": {