added some documentation

node/node.go

@@ -56,7 +56,7 @@ type Node struct {
 
 	lifecycles map[reflect.Type]Lifecycle // All registered backends, services, and auxiliary services that have a lifecycle
 
-	HTTPServers *HTTPServers // TODO document
+	HTTPServers *HTTPServers // HTTPServers stores information about the node's rpc, ws, and graphQL http servers.
 
 	rpcAPIs       []rpc.API   // List of APIs currently provided by the node
 	inprocHandler *rpc.Server // In-process RPC request handler to process the API requests

node/rpcstack.go

@@ -241,7 +241,7 @@ func isWebsocket(r *http.Request) bool {
 		strings.ToLower(r.Header.Get("Connection")) == "upgrade"
 }
 
-// TODO document
+// NewGQLUpgradeHandler wraps the given handler, h, in the given graphQL handler.
 func NewGQLUpgradeHandler(h http.Handler, gql http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if isGQL(r) {
@@ -254,7 +254,7 @@ func NewGQLUpgradeHandler(h http.Handler, gql http.Handler) http.Handler {
 	})
 }
 
-// TODO document
+// isGQL checks if the given request is a graphQL request.
 func isGQL(r *http.Request) bool {
 	return r.URL.Path == "/graphql" || r.URL.Path == "/graphql/"
 }

node/service.go

@@ -89,7 +89,10 @@ func (ctx *ServiceContext) ExtRPCEnabled() bool {
 	return ctx.Config.ExtRPCEnabled()
 }
 
-// TODO document
+// Lifecycle encompasses the behavior of services that can be started and stopped
+// on the node. Lifecycle management is delegated to the node, but it is the
+// responsibility of the service-specific package to configure and register the
+// service on the node using the `RegisterLifecycle` method.
 type Lifecycle interface {
 	// Start is called after all services have been constructed and the networking
 	// layer was also initialized to spawn any goroutines required by the service.