node: refactor package node #21105

renaynay · 2020-05-19T13:04:34Z

This PR significantly changes the APIs for instantiating Ethereum nodes in a Go program. The new APIs are not backwards-compatible, but we feel that this is made up for by the much simpler way of registering services on node.Node. You can find more information and rationale in the design document: https://gist.github.com/renaynay/5bec2de19fde66f4d04c535fd24f0775.

There is also a new feature in Node's Go API: it is now possible to register arbitrary handlers on the user-facing HTTP server. In geth, this facility is used to enable GraphQL.

There is a single minor change relevant for geth users in this PR: The GraphQL API is no longer available separately from the JSON-RPC HTTP server. If you want GraphQL, you need to enable it using the --http --graphql flag combination. The --graphql.port and --graphql.addr flags are no longer available.

[ + ] Introduces Lifecycle interface
[ + ] Introduces RegisterAPIs() method
[ + ] Introduces RegisterLifecycle() method
[ + ] Introduces RegisterHTTP() method
[ + ] Introduces RegisterProtocols() method

[<>] Changes the way information about node's HTTP servers is stored
[<>] Separates LES server management from eth.Ethereum, now managed by node
[<>] GraphQL can only be started on the node's canonical HTTP server (to enable graphql --graphql, the user must also enable http with the --http flag)

[ - ] Removes Service interface
[ - ] Removes ServiceContext
[ - ] Removes the responsibility of service construction

TODO

eth/backend.go

node/service.go

eth/backend.go

renaynay · 2020-06-24T10:24:50Z

Notes from review:

either add a method to get consensus.Engine from the ethapi.Backend or get it another way.
remove all "fetch backend" instances and try to remove the Lifecycle method where it fetches a lifecycle based on its type.
remove ServiceContext
change the panic of missing backend to a nicer fatal err
take another look at WSAllowed because there could be a resulting race condition
RegisterHTTP could possibly be done better and could maybe still follow this signature:

func (n *Node) RegisterHTTP(path string, h http.Handler) error

Also fix GQL server tests, they're still failing on some builds on travis.

ethstats/ethstats.go

internal/ethapi/backend.go

cmd/geth/main.go

fjl · 2020-07-01T18:27:05Z

cmd/geth/main.go

 	// Start auxiliary services if enabled
 	if ctx.GlobalBool(utils.MiningEnabledFlag.Name) || ctx.GlobalBool(utils.DeveloperFlag.Name) {
 		// Mining only makes sense if a full Ethereum node is running
 		if ctx.GlobalString(utils.SyncModeFlag.Name) == "light" {


I think everything in this block is code that only works for full nodes.
We should create an auxiliary function for setting up *eth.Ethereum specifically
and then put a type assertion for *eth.Ethereum here.

renaynay · 2020-07-01T19:14:57Z

HTTP Rule:

flags:
--http
--http.port
--http.cors
--http.vhosts
--http.graphql enables graphql on http server

can graphql be enabled without http enabled? NO
graphql can only be on http server, not on separate endpoint.

console:

if I do a stopRPC() in the console, what happens to enabled gql server? It also stops as well.

renaynay · 2020-07-01T19:19:25Z

TODO:

ethstats gets own backend interface + full node backend then do type assertion (don't import internal ethapi)
atomic int32 wsAllowed
real type assertion for main.go so that configure eth vs les stuff in startNode
graphql can only be on http

extra:

SetContractBackend move this to eth / les configuration (ipc endpoint)

ethclient/ethclient.go

cmd/utils/flags.go

I'm not happy with 'path' for this because we also have ResolvePath to find file paths in the datadir.

This PR significantly changes the APIs for instantiating Ethereum nodes in a Go program. The new APIs are not backwards-compatible, but we feel that this is made up for by the much simpler way of registering services on node.Node. You can find more information and rationale in the design document: https://gist.github.com/renaynay/5bec2de19fde66f4d04c535fd24f0775. There is also a new feature in Node's Go API: it is now possible to register arbitrary handlers on the user-facing HTTP server. In geth, this facility is used to enable GraphQL. There is a single minor change relevant for geth users in this PR: The GraphQL API is no longer available separately from the JSON-RPC HTTP server. If you want GraphQL, you need to enable it using the ./geth --http --graphql flag combination. The --graphql.port and --graphql.addr flags are no longer available.

Merge from upstream, go-ethereum v 1.9.19 (https://github.com/ethereum/go-ethereum/releases/tag/v1.9.19) Geth v1.9.19 is our regular maintenance release Note, if you were using GraphQL previously, it was moved to the HTTP RPC endpoint. The old --graphql.host and --graphql.port flags will not work any more. You might need to adjust your TOML config files accordingly too. 1.9.19 Notes: Deprecated flags: GraphQLListenAddrFlag GraphQLPortFlag Added flags: CacheTrieJournalFlag CacheTrieRejournalFlag 28c5a8a fetcher.go/mainLoop check ancestor, otherwise the lightest sync could panic fetcher.go/newLightFetcher Add downloader.SyncMode as parameter c0c0161 (ethereum/go-ethereum#21105) node.go: startNetworking should server stop if proxyServer failed main.go startNode runnerFactory replaced 90dedea this commit tried to fusion the consensus/istanbul/core/event.go file with an erased tests (signed_data_internal_test.go) Restored that test, and add the changes from the signer/core/signed_data.go, to the shared/signer/signed_data.go c28fd9c make Berlin a copy of Istanbul instead of YoloV1 Backwards compatibility The commit c0c0161 (ethereum/go-ethereum#21105) "changes the APIs for instantiating Ethereum nodes in a Go program. The new APIs are not backwards-compatible" (following this proposal https://gist.github.com/renaynay/5bec2de19fde66f4d04c535fd24f0775)

renaynay force-pushed the draft-refactor-node branch 2 times, most recently from 582c0aa to 124539d Compare June 9, 2020 12:57

renaynay requested a review from fjl June 22, 2020 15:21

renaynay force-pushed the draft-refactor-node branch from 9359c43 to c471809 Compare June 22, 2020 15:37

renaynay commented Jun 24, 2020

View reviewed changes

eth/backend.go Outdated Show resolved Hide resolved

renaynay commented Jun 24, 2020

View reviewed changes

node/service.go Outdated Show resolved Hide resolved

renaynay commented Jun 24, 2020

View reviewed changes

eth/backend.go Outdated Show resolved Hide resolved