# Functions
DefaultDataDir is the default data directory to use for the databases and other persistence requirements.
DefaultHTTPEndpoint returns the HTTP endpoint used by default.
DefaultIPCEndpoint returns the IPC path used by default.
DefaultWSEndpoint returns the websocket endpoint used by default.
New creates a new P2P node, ready for protocol registration.
NewPrivateAdminAPI creates a new API definition for the private admin methods of the node itself.
NewPublicAdminAPI creates a new API definition for the public admin methods of the node itself.
NewPublicDebugAPI creates a new API definition for the public debug methods of the node itself.
NewPublicWeb3API creates a new Web3Service instance.
# Constants
Default host interface for the HTTP RPC server.
Default TCP port for the HTTP RPC server.
Default host interface for the websocket RPC server.
Default TCP port for the websocket RPC server.
# Variables
DefaultConfig contains reasonable default settings.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Config represents a small collection of configuration values to fine tune the P2P network layer of a protocol stack.
DuplicateServiceError is returned during Node startup if a registered service constructor returns a service of the same type that was already started.
Node is a container on which services can be registered.
PrivateAdminAPI is the collection of administrative API methods exposed only over a secure RPC channel.
PublicAdminAPI is the collection of administrative API methods exposed over both secure and unsecure RPC channels.
PublicDebugAPI is the collection of debugging related API methods exposed over both secure and unsecure RPC channels.
PublicWeb3API offers helper utils.
ServiceContext is a collection of service independent options inherited from the protocol stack, that is passed to all constructors to be optionally used; as well as utility methods to operate on the service environment.
StopError is returned if a Node fails to stop either any of its registered services or itself.
# Interfaces
Service is an individual protocol that can be registered into a node.
# Type aliases
ServiceConstructor is the function signature of the constructors needed to be registered for service instantiation.