all: remove public field from rpc.API (ethereum#25059)

lightclient · jagdeep sidhu · commit 8627a9ff9d61 · 2022-07-04T16:49:18.000-07:00
all: remove public field from rpc.API
diff --git a/cmd/clef/main.go b/cmd/clef/main.go
@@ -647,7 +647,6 @@ func signer(c *cli.Context) error {
 	rpcAPI := []rpc.API{
 		{
 			Namespace: "account",
-			Public:    true,
 			Service:   api,
 			Version:   "1.0"},
 	}
@@ -656,7 +655,7 @@ func signer(c *cli.Context) error {
 		cors := utils.SplitAndTrim(c.GlobalString(utils.HTTPCORSDomainFlag.Name))
 
 		srv := rpc.NewServer()
-		err := node.RegisterApis(rpcAPI, []string{"account"}, srv, false)
+		err := node.RegisterApis(rpcAPI, []string{"account"}, srv)
 		if err != nil {
 			utils.Fatalf("Could not register API: %w", err)
 		}
diff --git a/consensus/clique/clique.go b/consensus/clique/clique.go
@@ -699,7 +699,6 @@ func (c *Clique) APIs(chain consensus.ChainHeaderReader) []rpc.API {
 		Namespace: "clique",
 		Version:   "1.0",
 		Service:   &API{chain: chain, clique: c},
-		Public:    false,
 	}}
 }
 
diff --git a/consensus/ethash/ethash.go b/consensus/ethash/ethash.go
@@ -681,13 +681,11 @@ func (ethash *Ethash) APIs(chain consensus.ChainHeaderReader) []rpc.API {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   &API{ethash},
-			Public:    true,
 		},
 		{
 			Namespace: "ethash",
 			Version:   "1.0",
 			Service:   &API{ethash},
-			Public:    true,
 		},
 	}
 }
diff --git a/eth/backend.go b/eth/backend.go
@@ -459,22 +459,18 @@ func (s *Ethereum) APIs() []rpc.API {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   NewEthereumAPI(s),
-			Public:    true,
 		}, {
 			Namespace: "miner",
 			Version:   "1.0",
 			Service:   NewMinerAPI(s),
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   downloader.NewDownloaderAPI(s.handler.downloader, s.eventMux),
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   filters.NewFilterAPI(s.APIBackend, false, 5*time.Minute),
-			Public:    true,
 		}, {
 			Namespace: "admin",
 			Version:   "1.0",
@@ -483,12 +479,10 @@ func (s *Ethereum) APIs() []rpc.API {
 			Namespace: "debug",
 			Version:   "1.0",
 			Service:   NewDebugAPI(s),
-			Public:    true,
 		}, {
 			Namespace: "net",
 			Version:   "1.0",
 			Service:   s.netRPCService,
-			Public:    true,
 		},
 	}...)
 }
diff --git a/eth/catalyst/api.go b/eth/catalyst/api.go
@@ -44,7 +44,6 @@ func Register(stack *node.Node, backend *eth.Ethereum) error {
 			Namespace:     "engine",
 			Version:       "1.0",
 			Service:       NewConsensusAPI(backend),
-			Public:        true,
 			Authenticated: true,
 		},
 	})
diff --git a/eth/tracers/api.go b/eth/tracers/api.go
@@ -939,7 +939,6 @@ func APIs(backend Backend) []rpc.API {
 			Namespace: "debug",
 			Version:   "1.0",
 			Service:   NewAPI(backend),
-			Public:    false,
 		},
 	}
 }
diff --git a/internal/ethapi/backend.go b/internal/ethapi/backend.go
@@ -106,37 +106,30 @@ func GetAPIs(apiBackend Backend) []rpc.API {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   NewEthereumAPI(apiBackend),
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   NewBlockChainAPI(apiBackend),
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   NewTransactionAPI(apiBackend, nonceLock),
-			Public:    true,
 		}, {
 			Namespace: "txpool",
 			Version:   "1.0",
 			Service:   NewTxPoolAPI(apiBackend),
-			Public:    true,
 		}, {
 			Namespace: "debug",
 			Version:   "1.0",
 			Service:   NewDebugAPI(apiBackend),
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   NewEthereumAccountAPI(apiBackend.AccountManager()),
-			Public:    true,
 		}, {
 			Namespace: "personal",
 			Version:   "1.0",
 			Service:   NewPersonalAccountAPI(apiBackend, nonceLock),
-			Public:    false,
 		},
 	}
 }
diff --git a/les/catalyst/api.go b/les/catalyst/api.go
@@ -37,7 +37,6 @@ func Register(stack *node.Node, backend *les.LightEthereum) error {
 			Namespace:     "engine",
 			Version:       "1.0",
 			Service:       NewConsensusAPI(backend),
-			Public:        true,
 			Authenticated: true,
 		},
 	})
diff --git a/les/client.go b/les/client.go
@@ -416,32 +416,26 @@ func (s *LightEthereum) APIs() []rpc.API {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   &LightDummyAPI{},
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   downloader.NewDownloaderAPI(s.handler.downloader, s.eventMux),
-			Public:    true,
 		}, {
 			Namespace: "eth",
 			Version:   "1.0",
 			Service:   filters.NewFilterAPI(s.ApiBackend, true, 5*time.Minute),
-			Public:    true,
 		}, {
 			Namespace: "net",
 			Version:   "1.0",
 			Service:   s.netRPCService,
-			Public:    true,
 		}, {
 			Namespace: "les",
 			Version:   "1.0",
 			Service:   NewLightAPI(&s.lesCommons),
-			Public:    false,
 		}, {
 			Namespace: "vflux",
 			Version:   "1.0",
 			Service:   s.serverPool.API(),
-			Public:    false,
 		},
 	}...)
 }
diff --git a/les/server.go b/les/server.go
@@ -161,19 +161,16 @@ func (s *LesServer) APIs() []rpc.API {
 			Namespace: "les",
 			Version:   "1.0",
 			Service:   NewLightAPI(&s.lesCommons),
-			Public:    false,
 		},
 		{
 			Namespace: "les",
 			Version:   "1.0",
 			Service:   NewLightServerAPI(s),
-			Public:    false,
 		},
 		{
 			Namespace: "debug",
 			Version:   "1.0",
 			Service:   NewDebugAPI(s),
-			Public:    false,
 		},
 	}
 }
diff --git a/node/api.go b/node/api.go
@@ -37,7 +37,6 @@ func (n *Node) apis() []rpc.API {
 			Namespace: "admin",
 			Version:   "1.0",
 			Service:   &adminAPI{n},
-			Public:    true,
 		}, {
 			Namespace: "debug",
 			Version:   "1.0",
@@ -46,7 +45,6 @@ func (n *Node) apis() []rpc.API {
 			Namespace: "web3",
 			Version:   "1.0",
 			Service:   &web3API{n},
-			Public:    true,
 		},
 	}
 }
diff --git a/node/rpcstack.go b/node/rpcstack.go
@@ -281,7 +281,7 @@ func (h *httpServer) enableRPC(apis []rpc.API, config httpConfig) error {
 
 	// Create RPC server and handler.
 	srv := rpc.NewServer()
-	if err := RegisterApis(apis, config.Modules, srv, false); err != nil {
+	if err := RegisterApis(apis, config.Modules, srv); err != nil {
 		return err
 	}
 	h.httpConfig = config
@@ -312,7 +312,7 @@ func (h *httpServer) enableWS(apis []rpc.API, config wsConfig) error {
 	}
 	// Create RPC server and handler.
 	srv := rpc.NewServer()
-	if err := RegisterApis(apis, config.Modules, srv, false); err != nil {
+	if err := RegisterApis(apis, config.Modules, srv); err != nil {
 		return err
 	}
 	h.wsConfig = config
@@ -528,7 +528,7 @@ func (is *ipcServer) stop() error {
 
 // RegisterApis 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 RegisterApis(apis []rpc.API, modules []string, srv *rpc.Server, exposeAll bool) error {
+func RegisterApis(apis []rpc.API, modules []string, srv *rpc.Server) error {
 	if bad, available := checkModuleAvailability(modules, apis); len(bad) > 0 {
 		log.Error("Unavailable modules in HTTP API list", "unavailable", bad, "available", available)
 	}
@@ -539,7 +539,7 @@ func RegisterApis(apis []rpc.API, modules []string, srv *rpc.Server, exposeAll b
 	}
 	// Register all the APIs exposed by the services
 	for _, api := range apis {
-		if exposeAll || allowList[api.Namespace] || (len(allowList) == 0 && api.Public) {
+		if allowList[api.Namespace] || len(allowList) == 0 {
 			if err := srv.RegisterName(api.Namespace, api.Service); err != nil {
 				return err
 			}
diff --git a/node/utils_test.go b/node/utils_test.go
@@ -100,12 +100,10 @@ func (f *FullService) APIs() []rpc.API {
 		{
 			Namespace: "debug",
 			Version:   "1.0",
-			Public:    true,
 		},
 		{
 			Namespace: "net",
 			Version:   "1.0",
-			Public:    true,
 		},
 	}
 }
diff --git a/rpc/types.go b/rpc/types.go
@@ -33,7 +33,7 @@ type API struct {
 	Namespace     string      // namespace under which the rpc methods of Service are exposed
 	Version       string      // api version for DApp's
 	Service       interface{} // receiver instance which holds the methods
-	Public        bool        // indication if the methods must be considered safe for public use
+	Public        bool        // deprecated - this field is no longer used, but retained for compatibility
 	Authenticated bool        // whether the api should only be available behind authentication.
 }
 

Original file line number	Diff line number	Diff line change
`@@ -647,7 +647,6 @@ func signer(c *cli.Context) error {`
`647`	`647`	`rpcAPI := []rpc.API{`
`648`	`648`	`{`
`649`	`649`	`Namespace: "account",`
`650`		`- Public: true,`
`651`	`650`	`Service: api,`
`652`	`651`	`Version: "1.0"},`
`653`	`652`	`}`
`@@ -656,7 +655,7 @@ func signer(c *cli.Context) error {`
`656`	`655`	`cors := utils.SplitAndTrim(c.GlobalString(utils.HTTPCORSDomainFlag.Name))`
`657`	`656`
`658`	`657`	`srv := rpc.NewServer()`
`659`		`- err := node.RegisterApis(rpcAPI, []string{"account"}, srv, false)`
	`658`	`+ err := node.RegisterApis(rpcAPI, []string{"account"}, srv)`
`660`	`659`	`if err != nil {`
`661`	`660`	`utils.Fatalf("Could not register API: %w", err)`
`662`	`661`	`}`
Original file line number	Diff line number	Diff line change
`@@ -699,7 +699,6 @@ func (c *Clique) APIs(chain consensus.ChainHeaderReader) []rpc.API {`
`699`	`699`	`Namespace: "clique",`
`700`	`700`	`Version: "1.0",`
`701`	`701`	`Service: &API{chain: chain, clique: c},`
`702`		`- Public: false,`
`703`	`702`	`}}`
`704`	`703`	`}`
`705`	`704`
Original file line number	Diff line number	Diff line change
`@@ -681,13 +681,11 @@ func (ethash *Ethash) APIs(chain consensus.ChainHeaderReader) []rpc.API {`
`681`	`681`	`Namespace: "eth",`
`682`	`682`	`Version: "1.0",`
`683`	`683`	`Service: &API{ethash},`
`684`		`- Public: true,`
`685`	`684`	`},`
`686`	`685`	`{`
`687`	`686`	`Namespace: "ethash",`
`688`	`687`	`Version: "1.0",`
`689`	`688`	`Service: &API{ethash},`
`690`		`- Public: true,`
`691`	`689`	`},`
`692`	`690`	`}`
`693`	`691`	`}`
Original file line number	Diff line number	Diff line change
`@@ -939,7 +939,6 @@ func APIs(backend Backend) []rpc.API {`
`939`	`939`	`Namespace: "debug",`
`940`	`940`	`Version: "1.0",`
`941`	`941`	`Service: NewAPI(backend),`
`942`		`- Public: false,`
`943`	`942`	`},`
`944`	`943`	`}`
`945`	`944`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,19 +161,16 @@ func (s *LesServer) APIs() []rpc.API {`
`161`	`161`	`Namespace: "les",`
`162`	`162`	`Version: "1.0",`
`163`	`163`	`Service: NewLightAPI(&s.lesCommons),`
`164`		`- Public: false,`
`165`	`164`	`},`
`166`	`165`	`{`
`167`	`166`	`Namespace: "les",`
`168`	`167`	`Version: "1.0",`
`169`	`168`	`Service: NewLightServerAPI(s),`
`170`		`- Public: false,`
`171`	`169`	`},`
`172`	`170`	`{`
`173`	`171`	`Namespace: "debug",`
`174`	`172`	`Version: "1.0",`
`175`	`173`	`Service: NewDebugAPI(s),`
`176`		`- Public: false,`
`177`	`174`	`},`
`178`	`175`	`}`
`179`	`176`	`}`