node

Documentation

Index

• Variables
• func ConstructModule(tp Type) fx.Option
• func WithMetrics(lc fx.Lifecycle) error
• type API
  • func (api *API) AuthNew(ctx context.Context, perms []auth.Permission) (string, error)
  • func (api *API) AuthNewWithExpiry(ctx context.Context, perms []auth.Permission, ttl time.Duration) (string, error)
  • func (api *API) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
  • func (api *API) Info(ctx context.Context) (Info, error)
  • func (api *API) LogLevelSet(ctx context.Context, name, level string) error
  • func (api *API) Ready(ctx context.Context) (bool, error)
• type BuildInfo
  • func GetBuildInfo() *BuildInfo
  • func (b *BuildInfo) CommitShortSha() string
  • func (b *BuildInfo) GetSemanticVersion() string
• type Config
  • func DefaultConfig(tp Type) Config
  • func (c *Config) Validate() error
• type Info
• type Module
• type StorePath
• type Type
  • func GetTypes() []Type
  • func ParseType(str string) Type
  • func (t Type) IsValid() bool
  • func (t Type) String() string

Variables

var APIVersion = GetBuildInfo().SemanticVersion

var SecretName = keystore.KeyName("jwt-secret.jwt")

Functions

func ConstructModule

func ConstructModule(tp Type) fx.Option

func WithMetrics

func WithMetrics(lc fx.Lifecycle) error

WithMetrics registers node metrics.

Types

type API

type API struct {
	Internal struct {
		Info              func(context.Context) (Info, error)                                                   `perm:"admin"`
		Ready             func(context.Context) (bool, error)                                                   `perm:"read"`
		LogLevelSet       func(ctx context.Context, name, level string) error                                   `perm:"admin"`
		AuthVerify        func(ctx context.Context, token string) ([]auth.Permission, error)                    `perm:"admin"`
		AuthNew           func(ctx context.Context, perms []auth.Permission) (string, error)                    `perm:"admin"`
		AuthNewWithExpiry func(ctx context.Context, perms []auth.Permission, ttl time.Duration) (string, error) `perm:"admin"`
	}
}

func (*API) AuthNew

func (api *API) AuthNew(ctx context.Context, perms []auth.Permission) (string, error)

func (*API) AuthNewWithExpiry

func (api *API) AuthNewWithExpiry(ctx context.Context, perms []auth.Permission, ttl time.Duration) (string, error)

func (*API) AuthVerify

func (api *API) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)

func (*API) Info

func (api *API) Info(ctx context.Context) (Info, error)

func (*API) LogLevelSet

func (api *API) LogLevelSet(ctx context.Context, name, level string) error

func (*API) Ready

func (api *API) Ready(ctx context.Context) (bool, error)

type BuildInfo

type BuildInfo struct {
	BuildTime       string
	LastCommit      string
	SemanticVersion string
	SystemVersion   string
	GolangVersion   string
}

BuildInfo represents all necessary information about current build.

func GetBuildInfo

func GetBuildInfo() *BuildInfo

GetBuildInfo returns information about current build.

func (*BuildInfo) CommitShortSha

func (b *BuildInfo) CommitShortSha() string

func (*BuildInfo) GetSemanticVersion

func (b *BuildInfo) GetSemanticVersion() string

type Config

type Config struct {
	StartupTimeout  time.Duration
	ShutdownTimeout time.Duration
}

func DefaultConfig

func DefaultConfig(tp Type) Config

DefaultConfig returns the default node configuration for a given node type.

func (*Config) Validate

func (c *Config) Validate() error

type Info

type Info struct {
	Type       Type   `json:"type"`
	APIVersion string `json:"api_version"`
}

Info contains information related to the administrative node.

type Module

type Module interface {
	// Info returns administrative information about the node.
	Info(context.Context) (Info, error)

	// Ready returns true once the node's RPC is ready to accept requests.
	Ready(context.Context) (bool, error)

	// LogLevelSet sets the given component log level to the given level.
	LogLevelSet(ctx context.Context, name, level string) error

	// AuthVerify returns the permissions assigned to the given token.
	AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
	// AuthNew signs and returns a new token with the given permissions.
	AuthNew(ctx context.Context, perms []auth.Permission) (string, error)
	// AuthNewWithExpiry signs and returns a new token with the given permissions and TTL.
	AuthNewWithExpiry(ctx context.Context, perms []auth.Permission, ttl time.Duration) (string, error)
}

Module defines the API related to interacting with the "administrative" node.

type StorePath

type StorePath string

StorePath is an alias used in order to pass the base path of the node store to nodebuilder modules.

type Type

type Type uint8

Type defines the Node type (e.g. `light`, `bridge`) for identity purposes. The zero value for Type is invalid.

const (
	// Bridge is a Celestia Node that bridges the Celestia consensus network and data availability
	// network. It maintains a trusted channel/connection to a Celestia Core node via the core.Client
	// API.
	Bridge Type = iota + 1
	// Light is a stripped-down Celestia Node which aims to be lightweight while preserving the highest
	// possible security guarantees.
	Light
	// Full is a Celestia Node that stores blocks in their entirety.
	Full
)

func GetTypes

func GetTypes() []Type

GetTypes returns a list of all known types in order of priority.

func ParseType

func ParseType(str string) Type

ParseType converts string in a type if possible.

func (Type) IsValid

func (t Type) IsValid() bool

IsValid reports whether the Type is valid.

func (Type) String

func (t Type) String() string

String converts Type to its string representation.