node

Dec 21, 2025

Changes in this version

+ func RegisterDatabase(name string, factory DatabaseFactory)

+ type DatabaseFactory func(file string, cache int, handles int, namespace string, readonly bool) (ethdb.KeyValueStore, error)

Jul 18, 2025

Changes in this version

type Config

+ GethVersion string

type Node

+ func (n *Node) APIs() []rpc.API

Jul 26, 2025

Changes in this version

+ const DefaultAuthHost

+ const DefaultAuthPort

+ var DefaultAuthCors = []string

+ var DefaultAuthModules = []string

+ var DefaultAuthOrigins = []string

+ var DefaultAuthPrefix = ""

+ var DefaultAuthVhosts = []string

+ func CheckTimeouts(timeouts *rpc.HTTPTimeouts)

+ func NewHTTPHandlerStack(srv http.Handler, cors []string, vhosts []string, jwtSecret []byte) http.Handler

+ func NewJWTAuth(jwtsecret [32]byte) rpc.HTTPAuth

+ func NewWSHandlerStack(srv http.Handler, jwtSecret []byte) http.Handler

+ func ObtainJWTSecret(fileName string) ([]byte, error)

+ func RegisterApis(apis []rpc.API, modules []string, srv *rpc.Server) error

+ func StartHTTPEndpoint(endpoint string, timeouts rpc.HTTPTimeouts, handler http.Handler) (*http.Server, net.Addr, error)

type Config

+ AllowUnprotectedTxs bool

+ AuthAddr string

+ AuthPort int

+ AuthVirtualHosts []string

+ BatchRequestLimit int

+ BatchResponseMaxSize int

+ DBEngine string

+ EnablePersonal bool

+ HTTPPathPrefix string

+ JWTSecret string

+ USB bool

+ WSPathPrefix string

+ func (c *Config) GetKeyStoreDir() (string, bool, error)

+ func (c *Config) KeyDirConfig() (string, error)

+ type DatabaseOptions struct

+ AncientsDirectory string

+ Cache int

+ EraDirectory string

+ Handles int

+ MetricsNamespace string

+ ReadOnly bool

+ type Lifecycle interface

+ Start func() error

+ Stop func() error

type Node

+ func (n *Node) HTTPAuthEndpoint() string

+ func (n *Node) KeyStoreDir() string

+ func (n *Node) OpenDatabaseWithOptions(name string, opt DatabaseOptions) (ethdb.Database, error)

+ func (n *Node) RegisterAPIs(apis []rpc.API)

+ func (n *Node) RegisterHandler(name, path string, handler http.Handler)

+ func (n *Node) RegisterLifecycle(lifecycle Lifecycle)

+ func (n *Node) RegisterProtocols(protocols []p2p.Protocol)

+ func (n *Node) ResolveAncient(name string, ancient string) string

+ func (n *Node) WSAuthEndpoint() string

Apr 16, 2020

Changes in this version

+ const DefaultGraphQLHost

+ const DefaultGraphQLPort

+ const DefaultHTTPHost

+ const DefaultHTTPPort

+ const DefaultWSHost

+ const DefaultWSPort

+ var DefaultConfig = Config

+ var ErrDatadirUsed = errors.New("datadir already used by another process")

+ var ErrNodeRunning = errors.New("node already running")

+ var ErrNodeStopped = errors.New("node not started")

+ var ErrServiceUnknown = errors.New("unknown service")

+ func DefaultDataDir() string

+ func DefaultHTTPEndpoint() string

+ func DefaultIPCEndpoint(clientIdentifier string) string

+ func DefaultWSEndpoint() string

+ type Config struct

+ DataDir string

+ ExternalSigner string

+ GraphQLCors []string

+ GraphQLHost string

+ GraphQLPort int

+ GraphQLVirtualHosts []string

+ HTTPCors []string

+ HTTPHost string

+ HTTPModules []string

+ HTTPPort int

+ HTTPTimeouts rpc.HTTPTimeouts

+ HTTPVirtualHosts []string

+ IPCPath string

+ InsecureUnlockAllowed bool

+ KeyStoreDir string

+ Logger log.Logger

+ Name string

+ NoUSB bool

+ P2P p2p.Config

+ SmartCardDaemonPath string

+ UseLightweightKDF bool

+ UserIdent string

+ Version string

+ WSExposeAll bool

+ WSHost string

+ WSModules []string

+ WSOrigins []string

+ WSPort int

+ func (c *Config) AccountConfig() (int, int, string, error)

+ func (c *Config) ExtRPCEnabled() bool

+ func (c *Config) GraphQLEndpoint() string

+ func (c *Config) HTTPEndpoint() string

+ func (c *Config) IPCEndpoint() string

+ func (c *Config) NodeDB() string

+ func (c *Config) NodeKey() *ecdsa.PrivateKey

+ func (c *Config) NodeName() string

+ func (c *Config) ResolvePath(path string) string

+ func (c *Config) StaticNodes() []*enode.Node

+ func (c *Config) TrustedNodes() []*enode.Node

+ func (c *Config) WSEndpoint() string

+ type DuplicateServiceError struct

+ Kind reflect.Type

+ func (e *DuplicateServiceError) Error() string

+ type Node struct

+ func New(conf *Config) (*Node, error)

+ func (n *Node) AccountManager() *accounts.Manager

+ func (n *Node) Attach() (*rpc.Client, error)

+ func (n *Node) Close() error

+ func (n *Node) Config() *Config

+ func (n *Node) DataDir() string

+ func (n *Node) EventMux() *event.TypeMux

+ func (n *Node) HTTPEndpoint() string

+ func (n *Node) IPCEndpoint() string

+ func (n *Node) InstanceDir() string

+ func (n *Node) OpenDatabase(name string, cache, handles int, namespace string) (ethdb.Database, error)

+ func (n *Node) OpenDatabaseWithFreezer(name string, cache, handles int, freezer, namespace string) (ethdb.Database, error)

+ func (n *Node) RPCHandler() (*rpc.Server, error)

+ func (n *Node) Register(constructor ServiceConstructor) error

+ func (n *Node) ResolvePath(x string) string

+ func (n *Node) Restart() error

+ func (n *Node) Server() *p2p.Server

+ func (n *Node) Service(service interface{}) error

+ func (n *Node) Start() error

+ func (n *Node) Stop() error

+ func (n *Node) WSEndpoint() string

+ func (n *Node) Wait()

+ type PrivateAdminAPI struct

+ func NewPrivateAdminAPI(node *Node) *PrivateAdminAPI

+ func (api *PrivateAdminAPI) AddPeer(url string) (bool, error)

+ func (api *PrivateAdminAPI) AddTrustedPeer(url string) (bool, error)

+ func (api *PrivateAdminAPI) PeerEvents(ctx context.Context) (*rpc.Subscription, error)

+ func (api *PrivateAdminAPI) RemovePeer(url string) (bool, error)

+ func (api *PrivateAdminAPI) RemoveTrustedPeer(url string) (bool, error)

+ func (api *PrivateAdminAPI) StartRPC(host *string, port *int, cors *string, apis *string, vhosts *string) (bool, error)

+ func (api *PrivateAdminAPI) StartWS(host *string, port *int, allowedOrigins *string, apis *string) (bool, error)

+ func (api *PrivateAdminAPI) StopRPC() (bool, error)

+ func (api *PrivateAdminAPI) StopWS() (bool, error)

+ type PublicAdminAPI struct

+ func NewPublicAdminAPI(node *Node) *PublicAdminAPI

+ func (api *PublicAdminAPI) Datadir() string

+ func (api *PublicAdminAPI) NodeInfo() (*p2p.NodeInfo, error)

+ func (api *PublicAdminAPI) Peers() ([]*p2p.PeerInfo, error)

+ type PublicWeb3API struct

+ func NewPublicWeb3API(stack *Node) *PublicWeb3API

+ func (s *PublicWeb3API) ClientVersion() string

+ func (s *PublicWeb3API) Sha3(input hexutil.Bytes) hexutil.Bytes

+ type Service interface

+ APIs func() []rpc.API

+ Protocols func() []p2p.Protocol

+ Start func(server *p2p.Server) error

+ Stop func() error

+ type ServiceConstructor func(ctx *ServiceContext) (Service, error)

+ type ServiceContext struct

+ AccountManager *accounts.Manager

+ EventMux *event.TypeMux

+ func NewServiceContext(cfg *Config, mux *event.TypeMux) (ServiceContext, string, error)

+ func (ctx *ServiceContext) ExtRPCEnabled() bool

+ func (ctx *ServiceContext) OpenDatabase(name string, cache int, handles int, namespace string) (ethdb.Database, error)

+ func (ctx *ServiceContext) OpenDatabaseWithFreezer(name string, cache int, handles int, freezer string, namespace string) (ethdb.Database, error)

+ func (ctx *ServiceContext) ResolvePath(path string) string

+ func (ctx *ServiceContext) Service(service interface{}) error

+ type StopError struct

+ Server error

+ Services map[reflect.Type]error

+ func (e *StopError) Error() string