inclusive terms: change whitelist terms by baptiste-b-pegasys · Pull Request #23290 · ethereum/go-ethereum

baptiste-b-pegasys · 2021-07-29T07:51:57Z

split of #23283 containing only the changes for the whitelist terms.

Thanks to @holiman for the prior review.

karalabe · 2021-07-29T08:18:32Z

This PR breaks API compatibility, so it's a no go.

karalabe · 2021-07-29T08:19:20Z

 		utils.UltraLightOnlyAnnounceFlag,
 		utils.LightNoSyncServeFlag,
-		utils.WhitelistFlag,
+		utils.AllowListFlag,


You disabled the whitelist flag.

karalabe · 2021-07-29T08:20:29Z

Allow list is not a good enough change. The block whitelist enforces the specified hashes to be present at the remote side. It's not merely a suggestion, rather a requirement.

karalabe · 2021-07-29T08:20:57Z

 	errAlreadyConnected = errors.New("already connected")
 	errRecentlyDialed   = errors.New("recently dialed")
-	errNotWhitelisted   = errors.New("not contained in netrestrict whitelist")
+	errNotAllowListed   = errors.New("not contained in netrestrict allowList")


This sounds like a mouthfull.

The error name could be errNetRestrict

baptiste-b-pegasys · 2021-07-29T09:24:05Z

 		utils.UltraLightOnlyAnnounceFlag,
 		utils.LightNoSyncServeFlag,
-		utils.WhitelistFlag,
+		utils.AllowListFlag,


Suggested change

utils.AllowListFlag,

utils.WhitelistFlag,

utils.AllowListFlag,

should it work or should we use only Whitelist flag?

baptiste-b-pegasys · 2021-07-29T09:26:36Z

 	errAlreadyConnected = errors.New("already connected")
 	errRecentlyDialed   = errors.New("recently dialed")
-	errNotWhitelisted   = errors.New("not contained in netrestrict whitelist")
+	errNotAllowListed   = errors.New("not contained in netrestrict allowList")


Suggested change

errNotAllowListed = errors.New("not contained in netrestrict allowList")

errNotAllowListed = errors.New("not contained in the netrestrict allowed list")

"not contained in netrestrict list"

fjl

In general, I'm happy about the initiative to improve the terms, but unhappy about the PR changing unrelated components. I would much prefer if the changes were made individually.

fjl · 2021-07-29T11:46:01Z

+// RegisterApisFromAllowList checks the given modules' availability, generates an allowlist based on the allowed modules,
 // and then registers all of the APIs exposed by the services.
-func RegisterApisFromWhitelist(apis []rpc.API, modules []string, srv *rpc.Server, exposeAll bool) error {
+func RegisterApisFromAllowList(apis []rpc.API, modules []string, srv *rpc.Server, exposeAll bool) error {


For this function, both terms are not appropriate. The 'list' here really just a list of API names that should be registered, so we could simply call it RegisterAPIs.

fjl · 2021-07-29T11:47:04Z

 	errAlreadyConnected = errors.New("already connected")
 	errRecentlyDialed   = errors.New("recently dialed")
-	errNotWhitelisted   = errors.New("not contained in netrestrict whitelist")
+	errNotAllowListed   = errors.New("not contained in netrestrict allowList")


"not contained in netrestrict list"

fjl · 2021-07-29T11:51:00Z

 	skiploadpat  []*regexp.Regexp
 	slowpat      []*regexp.Regexp
-	whitelistpat *regexp.Regexp
+	allowlistpat *regexp.Regexp


Here, too, the term 'allowlist' doesn't capture the meaning in the same way that 'whitelist' did. Since we are not using this feature at all, we might as well just delete it completely.

fjl · 2021-07-29T11:52:52Z

-	// Whitelist of required block number -> hash values to accept
-	Whitelist map[uint64]common.Hash `toml:"-"`
+	// AllowList of required block number -> hash values to accept
+	AllowList map[uint64]common.Hash `toml:"-"`


This change breaks compatibility with config files, so we cannot apply it without providing some kind of translator / deprecation mechanism.

You can check how to do this in https://github.com/ethereum/go-ethereum/blob/master/cmd/geth/config.go#L238

When I've done it, seeing the tag "-" I thought it was omitted, just here for reference not in the config file.
A team member gave me this reference https://github.com/BurntSushi/toml/blob/ebe1404fc680a89e43605f720106b16be2ba141c/encode.go#L561-L563

Oh, I didn't notice that! That's OK then.

baptiste-b-pegasys · 2021-07-29T12:58:34Z

thank you @karalabe and @fjl for the review, I will split this PR by feature, with the requested changes

inclusive terms: change whitelist terms

00c9154

baptiste-b-pegasys requested review from fjl, holiman, karalabe, rjl493456442 and zsfelfoldi as code owners July 29, 2021 07:51

karalabe reviewed Jul 29, 2021

View reviewed changes

baptiste-b-pegasys commented Jul 29, 2021

View reviewed changes

fjl requested changes Jul 29, 2021

View reviewed changes

baptiste-b-pegasys closed this Jul 29, 2021

This was referenced Jul 29, 2021

all: remove term "whitelist" in comments and log messages #23294

Merged

p2p: remove term "whitelist" #23295

Merged

node, cmd/clef: remove term "whitelist" #23296

Merged

tests: remove whitelist feature #23297

Merged

This was referenced Aug 10, 2021

cmd/geth, eth: change whitelist terms to enforcelist baptiste-b-pegasys/go-ethereum#2

Open

cmd/geth, eth: (typo) change whitelist terms to enforcelist #23372

Closed

	utils.AllowListFlag,
	utils.WhitelistFlag,
	utils.AllowListFlag,

	errNotAllowListed = errors.New("not contained in netrestrict allowList")
	errNotAllowListed = errors.New("not contained in the netrestrict allowed list")

Conversation

baptiste-b-pegasys commented Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

karalabe commented Jul 29, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

karalabe commented Jul 29, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fjl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

baptiste-b-pegasys Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

baptiste-b-pegasys commented Jul 29, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

baptiste-b-pegasys commented Jul 29, 2021 •

edited

Loading

baptiste-b-pegasys Jul 29, 2021 •

edited

Loading