From 119f9556869f829a9a2b4c12b5cd49b1a7d50d38 Mon Sep 17 00:00:00 2001 From: lightclient <14004106+lightclient@users.noreply.github.com> Date: Mon, 27 Jun 2022 12:33:13 +0200 Subject: [PATCH] all: remove `public` field from `rpc.API` (#25059) all: remove public field from rpc.API --- cmd/clef/main.go | 3 +-- consensus/clique/clique.go | 1 - consensus/ethash/ethash.go | 2 -- eth/backend.go | 6 ------ eth/catalyst/api.go | 1 - eth/tracers/api.go | 1 - internal/ethapi/backend.go | 7 ------- les/catalyst/api.go | 1 - les/client.go | 6 ------ les/server.go | 3 --- node/api.go | 2 -- node/rpcstack.go | 8 ++++---- node/utils_test.go | 2 -- rpc/types.go | 2 +- 14 files changed, 6 insertions(+), 39 deletions(-) diff --git a/cmd/clef/main.go b/cmd/clef/main.go index b1ffa38ffe..1a18cd16aa 100644 --- 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 index 950300f034..f229d04265 100644 --- 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 index c196ad0621..9029492022 100644 --- a/consensus/ethash/ethash.go +++ b/consensus/ethash/ethash.go @@ -680,13 +680,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 index f34aaba369..b4bea088f5 100644 --- a/eth/backend.go +++ b/eth/backend.go @@ -310,22 +310,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", @@ -334,12 +330,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 index 0c8f0c3610..acc9c0e66e 100644 --- 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 index 13b8988513..b0f30567f0 100644 --- a/eth/tracers/api.go +++ b/eth/tracers/api.go @@ -920,7 +920,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 index 98006d957e..5119be859d 100644 --- a/internal/ethapi/backend.go +++ b/internal/ethapi/backend.go @@ -103,37 +103,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 index de09acdb02..12d2106135 100644 --- 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 index fa5de5450a..97a333ab9b 100644 --- a/les/client.go +++ b/les/client.go @@ -296,32 +296,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 index 436dff2bf6..894fc13836 100644 --- 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 index 8d0dadc9e2..b395a345ca 100644 --- 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 index 0d2be9008a..09692c0a0b 100644 --- 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 index 1974e2e17c..31dbe911ba 100644 --- 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 index f4d05be48c..a0d742f491 100644 --- 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. }