Skip to content

Commit c989bca

Browse files
renaynayholiman
renaynay
and
holiman
authored
cmd/utils: renames flags related to http-rpc server (ethereum#20935)
* rpc flags related to starting http server renamed to http * old rpc flags aliased and still functional * pprof flags fixed * renames gpo related flags * linted * renamed rpc flags for consistency and clarity * added warn logs * added more warn logs for all deprecated flags for consistency * moves legacy flags to separate file, hides older flags under show-deprecated-flags command * legacy prefix and moved some more legacy flags to legacy file * fixed circular import * added docs * fixed imports lint error * added notes about when flags were deprecated * cmd/utils: group flags by deprecation date + reorder by date, * modified deprecated comments for consistency, added warn log for --rpc * making sure deprecated flags are still functional * show-deprecated-flags command cleaned up * fixed lint errors * corrected merge conflict * IsSet --> GlobalIsSet * uncategorized flags, if not deprecated, displayed under misc Co-authored-by: Martin Holst Swende <[email protected]>
1 parent 5876566 commit c989bca

File tree

7 files changed

+420
-143
lines changed

7 files changed

+420
-143
lines changed

‎cmd/clef/main.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,11 @@ func init() {
222222
utils.LightKDFFlag,
223223
utils.NoUSBFlag,
224224
utils.SmartCardDaemonPathFlag,
225-
utils.RPCListenAddrFlag,
226-
utils.RPCVirtualHostsFlag,
225+
utils.HTTPListenAddrFlag,
226+
utils.HTTPVirtualHostsFlag,
227227
utils.IPCDisabledFlag,
228228
utils.IPCPathFlag,
229-
utils.RPCEnabledFlag,
229+
utils.HTTPEnabledFlag,
230230
rpcPortFlag,
231231
signerSecretFlag,
232232
customDBFlag,
@@ -579,9 +579,9 @@ func signer(c *cli.Context) error {
579579
Service: api,
580580
Version: "1.0"},
581581
}
582-
if c.GlobalBool(utils.RPCEnabledFlag.Name) {
583-
vhosts := splitAndTrim(c.GlobalString(utils.RPCVirtualHostsFlag.Name))
584-
cors := splitAndTrim(c.GlobalString(utils.RPCCORSDomainFlag.Name))
582+
if c.GlobalBool(utils.HTTPEnabledFlag.Name) {
583+
vhosts := splitAndTrim(c.GlobalString(utils.HTTPVirtualHostsFlag.Name))
584+
cors := splitAndTrim(c.GlobalString(utils.HTTPCORSDomainFlag.Name))
585585

586586
srv := rpc.NewServer()
587587
err := node.RegisterApisFromWhitelist(rpcAPI, []string{"account"}, srv, false)
@@ -591,7 +591,7 @@ func signer(c *cli.Context) error {
591591
handler := node.NewHTTPHandlerStack(srv, cors, vhosts)
592592

593593
// start http server
594-
httpEndpoint := fmt.Sprintf("%s:%d", c.GlobalString(utils.RPCListenAddrFlag.Name), c.Int(rpcPortFlag.Name))
594+
httpEndpoint := fmt.Sprintf("%s:%d", c.GlobalString(utils.HTTPListenAddrFlag.Name), c.Int(rpcPortFlag.Name))
595595
httpServer, addr, err := node.StartHTTPEndpoint(httpEndpoint, rpc.DefaultHTTPTimeouts, handler)
596596
if err != nil {
597597
utils.Fatalf("Could not start RPC api: %v", err)

‎cmd/geth/main.go

+37-20
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ var (
9393
utils.GCModeFlag,
9494
utils.SnapshotFlag,
9595
utils.LightServeFlag,
96-
utils.LightLegacyServFlag,
96+
utils.LegacyLightServFlag,
9797
utils.LightIngressFlag,
9898
utils.LightEgressFlag,
9999
utils.LightMaxPeersFlag,
100-
utils.LightLegacyPeersFlag,
100+
utils.LegacyLightPeersFlag,
101101
utils.LightKDFFlag,
102102
utils.UltraLightServersFlag,
103103
utils.UltraLightFractionFlag,
@@ -114,17 +114,17 @@ var (
114114
utils.MaxPendingPeersFlag,
115115
utils.MiningEnabledFlag,
116116
utils.MinerThreadsFlag,
117-
utils.MinerLegacyThreadsFlag,
117+
utils.LegacyMinerThreadsFlag,
118118
utils.MinerNotifyFlag,
119119
utils.MinerGasTargetFlag,
120-
utils.MinerLegacyGasTargetFlag,
120+
utils.LegacyMinerGasTargetFlag,
121121
utils.MinerGasLimitFlag,
122122
utils.MinerGasPriceFlag,
123-
utils.MinerLegacyGasPriceFlag,
123+
utils.LegacyMinerGasPriceFlag,
124124
utils.MinerEtherbaseFlag,
125-
utils.MinerLegacyEtherbaseFlag,
125+
utils.LegacyMinerEtherbaseFlag,
126126
utils.MinerExtraDataFlag,
127-
utils.MinerLegacyExtraDataFlag,
127+
utils.LegacyMinerExtraDataFlag,
128128
utils.MinerRecommitIntervalFlag,
129129
utils.MinerNoVerfiyFlag,
130130
utils.NATFlag,
@@ -146,29 +146,41 @@ var (
146146
utils.FakePoWFlag,
147147
utils.NoCompactionFlag,
148148
utils.GpoBlocksFlag,
149+
utils.LegacyGpoBlocksFlag,
149150
utils.GpoPercentileFlag,
151+
utils.LegacyGpoPercentileFlag,
150152
utils.EWASMInterpreterFlag,
151153
utils.EVMInterpreterFlag,
152154
configFileFlag,
153155
}
154156

155157
rpcFlags = []cli.Flag{
156-
utils.RPCEnabledFlag,
157-
utils.RPCListenAddrFlag,
158-
utils.RPCPortFlag,
159-
utils.RPCCORSDomainFlag,
160-
utils.RPCVirtualHostsFlag,
158+
utils.HTTPEnabledFlag,
159+
utils.HTTPListenAddrFlag,
160+
utils.HTTPPortFlag,
161+
utils.HTTPCORSDomainFlag,
162+
utils.HTTPVirtualHostsFlag,
163+
utils.LegacyRPCEnabledFlag,
164+
utils.LegacyRPCListenAddrFlag,
165+
utils.LegacyRPCPortFlag,
166+
utils.LegacyRPCCORSDomainFlag,
167+
utils.LegacyRPCVirtualHostsFlag,
161168
utils.GraphQLEnabledFlag,
162169
utils.GraphQLListenAddrFlag,
163170
utils.GraphQLPortFlag,
164171
utils.GraphQLCORSDomainFlag,
165172
utils.GraphQLVirtualHostsFlag,
166-
utils.RPCApiFlag,
173+
utils.HTTPApiFlag,
174+
utils.LegacyRPCApiFlag,
167175
utils.WSEnabledFlag,
168176
utils.WSListenAddrFlag,
177+
utils.LegacyWSListenAddrFlag,
169178
utils.WSPortFlag,
179+
utils.LegacyWSPortFlag,
170180
utils.WSApiFlag,
181+
utils.LegacyWSApiFlag,
171182
utils.WSAllowedOriginsFlag,
183+
utils.LegacyWSAllowedOriginsFlag,
172184
utils.IPCDisabledFlag,
173185
utils.IPCPathFlag,
174186
utils.InsecureUnlockAllowedFlag,
@@ -227,13 +239,16 @@ func init() {
227239
dumpConfigCommand,
228240
// See retesteth.go
229241
retestethCommand,
242+
// See cmd/utils/flags_legacy.go
243+
utils.ShowDeprecated,
230244
}
231245
sort.Sort(cli.CommandsByName(app.Commands))
232246

233247
app.Flags = append(app.Flags, nodeFlags...)
234248
app.Flags = append(app.Flags, rpcFlags...)
235249
app.Flags = append(app.Flags, consoleFlags...)
236250
app.Flags = append(app.Flags, debug.Flags...)
251+
app.Flags = append(app.Flags, debug.DeprecatedFlags...)
237252
app.Flags = append(app.Flags, whisperFlags...)
238253
app.Flags = append(app.Flags, metricsFlags...)
239254

@@ -360,7 +375,7 @@ func startNode(ctx *cli.Context, stack *node.Node) {
360375

361376
// Set contract backend for ethereum service if local node
362377
// is serving LES requests.
363-
if ctx.GlobalInt(utils.LightLegacyServFlag.Name) > 0 || ctx.GlobalInt(utils.LightServeFlag.Name) > 0 {
378+
if ctx.GlobalInt(utils.LegacyLightServFlag.Name) > 0 || ctx.GlobalInt(utils.LightServeFlag.Name) > 0 {
364379
var ethService *eth.Ethereum
365380
if err := stack.Service(&ethService); err != nil {
366381
utils.Fatalf("Failed to retrieve ethereum service: %v", err)
@@ -445,16 +460,18 @@ func startNode(ctx *cli.Context, stack *node.Node) {
445460
utils.Fatalf("Ethereum service not running: %v", err)
446461
}
447462
// Set the gas price to the limits from the CLI and start mining
448-
gasprice := utils.GlobalBig(ctx, utils.MinerLegacyGasPriceFlag.Name)
449-
if ctx.IsSet(utils.MinerGasPriceFlag.Name) {
450-
gasprice = utils.GlobalBig(ctx, utils.MinerGasPriceFlag.Name)
463+
gasprice := utils.GlobalBig(ctx, utils.MinerGasPriceFlag.Name)
464+
if ctx.GlobalIsSet(utils.LegacyMinerGasPriceFlag.Name) && !ctx.GlobalIsSet(utils.MinerGasPriceFlag.Name) {
465+
gasprice = utils.GlobalBig(ctx, utils.LegacyMinerGasPriceFlag.Name)
451466
}
452467
ethereum.TxPool().SetGasPrice(gasprice)
453468

454-
threads := ctx.GlobalInt(utils.MinerLegacyThreadsFlag.Name)
455-
if ctx.GlobalIsSet(utils.MinerThreadsFlag.Name) {
456-
threads = ctx.GlobalInt(utils.MinerThreadsFlag.Name)
469+
threads := ctx.GlobalInt(utils.MinerThreadsFlag.Name)
470+
if ctx.GlobalIsSet(utils.LegacyMinerThreadsFlag.Name) && !ctx.GlobalIsSet(utils.MinerThreadsFlag.Name) {
471+
threads = ctx.GlobalInt(utils.LegacyMinerThreadsFlag.Name)
472+
log.Warn("The flag --minerthreads is deprecated and will be removed in the future, please use --miner.threads")
457473
}
474+
458475
if err := ethereum.StartMining(threads); err != nil {
459476
utils.Fatalf("Failed to start mining: %v", err)
460477
}

‎cmd/geth/retesteth.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -887,8 +887,8 @@ func retesteth(ctx *cli.Context) error {
887887
Version: "1.0",
888888
},
889889
}
890-
vhosts := splitAndTrim(ctx.GlobalString(utils.RPCVirtualHostsFlag.Name))
891-
cors := splitAndTrim(ctx.GlobalString(utils.RPCCORSDomainFlag.Name))
890+
vhosts := splitAndTrim(ctx.GlobalString(utils.HTTPVirtualHostsFlag.Name))
891+
cors := splitAndTrim(ctx.GlobalString(utils.HTTPCORSDomainFlag.Name))
892892

893893
// register apis and create handler stack
894894
srv := rpc.NewServer()
@@ -904,7 +904,7 @@ func retesteth(ctx *cli.Context) error {
904904
WriteTimeout: 120 * time.Second,
905905
IdleTimeout: 120 * time.Second,
906906
}
907-
httpEndpoint := fmt.Sprintf("%s:%d", ctx.GlobalString(utils.RPCListenAddrFlag.Name), ctx.Int(rpcPortFlag.Name))
907+
httpEndpoint := fmt.Sprintf("%s:%d", ctx.GlobalString(utils.HTTPListenAddrFlag.Name), ctx.Int(rpcPortFlag.Name))
908908
httpServer, _, err := node.StartHTTPEndpoint(httpEndpoint, RetestethHTTPTimeouts, handler)
909909
if err != nil {
910910
utils.Fatalf("Could not start RPC api: %v", err)

‎cmd/geth/usage.go

+34-19
Original file line numberDiff line numberDiff line change
@@ -157,13 +157,12 @@ var AppHelpFlagGroups = []flagGroup{
157157
Flags: []cli.Flag{
158158
utils.IPCDisabledFlag,
159159
utils.IPCPathFlag,
160-
utils.RPCEnabledFlag,
161-
utils.RPCListenAddrFlag,
162-
utils.RPCPortFlag,
163-
utils.RPCApiFlag,
164-
utils.RPCGlobalGasCap,
165-
utils.RPCCORSDomainFlag,
166-
utils.RPCVirtualHostsFlag,
160+
utils.HTTPEnabledFlag,
161+
utils.HTTPListenAddrFlag,
162+
utils.HTTPPortFlag,
163+
utils.HTTPApiFlag,
164+
utils.HTTPCORSDomainFlag,
165+
utils.HTTPVirtualHostsFlag,
167166
utils.WSEnabledFlag,
168167
utils.WSListenAddrFlag,
169168
utils.WSPortFlag,
@@ -174,6 +173,7 @@ var AppHelpFlagGroups = []flagGroup{
174173
utils.GraphQLPortFlag,
175174
utils.GraphQLCORSDomainFlag,
176175
utils.GraphQLVirtualHostsFlag,
176+
utils.RPCGlobalGasCap,
177177
utils.JSpathFlag,
178178
utils.ExecFlag,
179179
utils.PreloadJSFlag,
@@ -243,20 +243,28 @@ var AppHelpFlagGroups = []flagGroup{
243243
Flags: whisperFlags,
244244
},
245245
{
246-
Name: "DEPRECATED",
247-
Flags: []cli.Flag{
248-
utils.LegacyTestnetFlag,
249-
utils.LightLegacyServFlag,
250-
utils.LightLegacyPeersFlag,
251-
utils.MinerLegacyThreadsFlag,
252-
utils.MinerLegacyGasTargetFlag,
253-
utils.MinerLegacyGasPriceFlag,
254-
utils.MinerLegacyEtherbaseFlag,
255-
utils.MinerLegacyExtraDataFlag,
256-
},
246+
Name: "ALIASED (deprecated)",
247+
Flags: append([]cli.Flag{
248+
utils.LegacyRPCEnabledFlag,
249+
utils.LegacyRPCListenAddrFlag,
250+
utils.LegacyRPCPortFlag,
251+
utils.LegacyRPCCORSDomainFlag,
252+
utils.LegacyRPCVirtualHostsFlag,
253+
utils.LegacyRPCApiFlag,
254+
utils.LegacyWSListenAddrFlag,
255+
utils.LegacyWSPortFlag,
256+
utils.LegacyWSAllowedOriginsFlag,
257+
utils.LegacyWSApiFlag,
258+
utils.LegacyGpoBlocksFlag,
259+
utils.LegacyGpoPercentileFlag,
260+
}, debug.DeprecatedFlags...),
257261
},
258262
{
259263
Name: "MISC",
264+
Flags: []cli.Flag{
265+
utils.SnapshotFlag,
266+
cli.HelpFlag,
267+
},
260268
},
261269
}
262270

@@ -314,10 +322,17 @@ func init() {
314322
categorized[flag.String()] = struct{}{}
315323
}
316324
}
325+
deprecated := make(map[string]struct{})
326+
for _, flag := range utils.DeprecatedFlags {
327+
deprecated[flag.String()] = struct{}{}
328+
}
329+
// Only add uncategorized flags if they are not deprecated
317330
var uncategorized []cli.Flag
318331
for _, flag := range data.(*cli.App).Flags {
319332
if _, ok := categorized[flag.String()]; !ok {
320-
uncategorized = append(uncategorized, flag)
333+
if _, ok := deprecated[flag.String()]; !ok {
334+
uncategorized = append(uncategorized, flag)
335+
}
321336
}
322337
}
323338
if len(uncategorized) > 0 {

0 commit comments

Comments
 (0)