version

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 30, 2025 License: BSD-3-Clause Imports: 10 Imported by: 12

Documentation

Index

Constants

View Source
const (
	Client = "luxd"
	// RPCChainVMProtocol should be bumped anytime changes are made which
	// require the plugin vm to upgrade to latest luxd release to be
	// compatible.
	RPCChainVMProtocol uint = 42
)

Variables

View Source
var (
	Current = &Semantic{
		Major: 2,
		Minor: 0,
		Patch: 0,
	}
	CurrentApp = &Application{
		Name:  Client,
		Major: Current.Major,
		Minor: Current.Minor,
		Patch: Current.Patch,
	}
	MinimumCompatibleVersion = &Application{
		Name:  Client,
		Major: 2,
		Minor: 0,
		Patch: 0,
	}
	PrevMinimumCompatibleVersion = &Application{
		Name:  Client,
		Major: 1,
		Minor: 13,
		Patch: 3,
	}

	CurrentDatabase = DatabaseVersion1_4_5
	PrevDatabase    = DatabaseVersion1_0_0

	DatabaseVersion1_4_5 = &Semantic{
		Major: 1,
		Minor: 4,
		Patch: 5,
	}
	DatabaseVersion1_0_0 = &Semantic{
		Major: 1,
		Minor: 0,
		Patch: 0,
	}

	// RPCChainVMProtocolCompatibility maps RPCChainVMProtocol versions to the
	// set of luxd versions that supported that version. This is not used
	// by luxd, but is useful for downstream libraries.
	RPCChainVMProtocolCompatibility map[uint][]*Semantic
)

These are globals that describe network upgrades and node versions

View Source
var GitCommit string

GitCommit is set in the build script at compile time

Functions

This section is empty.

Types

type Application

type Application struct {
	Name  string `json:"name"  yaml:"name"`
	Major int    `json:"major" yaml:"major"`
	Minor int    `json:"minor" yaml:"minor"`
	Patch int    `json:"patch" yaml:"patch"`
	// contains filtered or unexported fields
}

func (*Application) Before

func (a *Application) Before(o *Application) bool

func (*Application) Compare

func (a *Application) Compare(o *Application) int

Compare returns a positive number if s > o, 0 if s == o, or a negative number if s < o.

func (*Application) Compatible

func (a *Application) Compatible(o *Application) error

func (*Application) String

func (a *Application) String() string

The only difference here between Application and Semantic is that Application prepends the client name rather than "v".

type Compatibility

type Compatibility interface {
	// Returns the local version
	Version() *Application

	// Returns nil if the provided version is compatible with the local version.
	// This means that the version is connectable and that consensus messages
	// can be made to them.
	Compatible(*Application) error
}

Compatibility a utility for checking the compatibility of peer versions

func GetCompatibility

func GetCompatibility(minCompatibleTime time.Time) Compatibility

func NewCompatibility

func NewCompatibility(
	version *Application,
	minCompatible *Application,
	minCompatibleTime time.Time,
	prevMinCompatible *Application,
) Compatibility

NewCompatibility returns a compatibility checker with the provided options

type Semantic

type Semantic struct {
	Major int
	Minor int
	Patch int
}

Semantic represents a semantic version.

func Parse

func Parse(s string) (*Semantic, error)

func (*Semantic) Before

func (v *Semantic) Before(o *Semantic) bool

Before returns true if v < o

func (*Semantic) Compare

func (v *Semantic) Compare(o *Semantic) int

Compare returns: -1 if v < o 0 if v == o 1 if v > o

func (*Semantic) String

func (v *Semantic) String() string

String returns the string representation of the version.

type Versions

type Versions struct {
	Application string `json:"application"`
	Database    string `json:"database"`
	RPCChainVM  uint64 `json:"rpcchainvm"`
	// Commit may be empty if GitCommit was not set at compile time
	Commit string `json:"commit"`
	Go     string `json:"go"`
}

Versions contains the versions relevant to a build of luxd. In addition to supporting construction of the string displayed by --version, it is used to produce the output of --version-json and can be used to unmarshal that output.

func GetVersions

func GetVersions() *Versions

func (*Versions) String

func (v *Versions) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL