Skip to content

Commit

Permalink
all: remove public field from rpc.API (ethereum#25059)
Browse files Browse the repository at this point in the history 
all: remove public field from rpc.API
  • Loading branch information
@lightclient @blakehhuynh
lightclient authored and blakehhuynh committed Oct 3, 2022
1 parent 91363aa commit 5a868aa
Show file tree
Hide file tree
Showing 14 changed files with 6 additions and 39 deletions.
3 changes: 1 addition & 2 deletions cmd/clef/main.go
View file
Expand Up @@ -647,7 +647,6 @@ func signer(c *cli.Context) error {
rpcAPI := []rpc.API{
{
Namespace: "account",
Public: true,
Service: api,
Version: "1.0"},
}
Expand All @@ -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)
}
Expand Down
1 change: 0 additions & 1 deletion consensus/clique/clique.go
View file
Expand Up @@ -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,
}}
}

Expand Down
2 changes: 0 additions & 2 deletions consensus/ethash/ethash.go
View file
Expand Up @@ -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,
},
}
}
Expand Down
6 changes: 0 additions & 6 deletions eth/backend.go
View file
Expand Up @@ -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",
Expand All @@ -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,
},
}...)
}
Expand Down
1 change: 0 additions & 1 deletion eth/catalyst/api.go
View file
Expand Up @@ -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,
},
})
Expand Down
1 change: 0 additions & 1 deletion eth/tracers/api.go
View file
Expand Up @@ -920,7 +920,6 @@ func APIs(backend Backend) []rpc.API {
Namespace: "debug",
Version: "1.0",
Service: NewAPI(backend),
Public: false,
},
}
}
7 changes: 0 additions & 7 deletions internal/ethapi/backend.go
View file
Expand Up @@ -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,
},
}
}
1 change: 0 additions & 1 deletion les/catalyst/api.go
View file
Expand Up @@ -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,
},
})
Expand Down
6 changes: 0 additions & 6 deletions les/client.go
View file
Expand Up @@ -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,
},
}...)
}
Expand Down
3 changes: 0 additions & 3 deletions les/server.go
View file
Expand Up @@ -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,
},
}
}
Expand Down
2 changes: 0 additions & 2 deletions node/api.go
View file
Expand Up @@ -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",
Expand All @@ -46,7 +45,6 @@ func (n *Node) apis() []rpc.API {
Namespace: "web3",
Version: "1.0",
Service: &web3API{n},
Public: true,
},
}
}
Expand Down
8 changes: 4 additions & 4 deletions node/rpcstack.go
View file
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
}
Expand All @@ -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
}
Expand Down
2 changes: 0 additions & 2 deletions node/utils_test.go
View file
Expand Up @@ -100,12 +100,10 @@ func (f *FullService) APIs() []rpc.API {
{
Namespace: "debug",
Version: "1.0",
Public: true,
},
{
Namespace: "net",
Version: "1.0",
Public: true,
},
}
}
2 changes: 1 addition & 1 deletion rpc/types.go
View file
Expand Up @@ -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.
}

Expand Down

0 comments on commit 5a868aa

Please sign in to comment.