version

Documentation

Index

• Variables
• func GetApricotPhase0Time(networkID uint32) time.Time
• func GetApricotPhase1Time(networkID uint32) time.Time
• func GetApricotPhase2Time(networkID uint32) time.Time
• func GetApricotPhase3Time(networkID uint32) time.Time
• type Application
  • func NewApplication(app string, appSeparator string, versionSeparator string, major int, minor int, ...) Application
  • func NewDefaultApplication(app string, major int, minor int, patch int) Application
• type ApplicationParser
  • func NewApplicationParser(appSeparator string, versionSeparator string) ApplicationParser
  • func NewDefaultApplicationParser() ApplicationParser
• type Compatibility
  • func GetCompatibility(networkID uint32) Compatibility
  • func NewCompatibility(version Application, minCompatable Application, minCompatableTime time.Time, ...) Compatibility
• type Parser
  • func NewDefaultParser() Parser
  • func NewParser(prefix, separator string) Parser
• type Version
  • func NewDefaultVersion(major, minor, patch int) Version
  • func NewVersion(major, minor, patch int, prefix, versionSeparator string) Version

Variables

var (
	String                       string // Printed when CLI arg --version is used
	GitCommit                    string // Set in the build script (i.e. at compile time)
	Current                      = NewDefaultVersion(1, 5, 0)
	CurrentApp                   = NewDefaultApplication(constants.PlatformName, Current.Major(), Current.Minor(), Current.Patch())
	MinimumCompatibleVersion     = NewDefaultApplication(constants.PlatformName, 1, 5, 0)
	PrevMinimumCompatibleVersion = NewDefaultApplication(constants.PlatformName, 1, 4, 5)
	MinimumUnmaskedVersion       = NewDefaultApplication(constants.PlatformName, 1, 1, 0)
	PrevMinimumUnmaskedVersion   = NewDefaultApplication(constants.PlatformName, 1, 0, 0)
	VersionParser                = NewDefaultApplicationParser()

	CurrentDatabase = DatabaseVersion1_4_5
	PrevDatabase    = DatabaseVersion1_0_0

	DatabaseVersion1_4_5 = NewDefaultVersion(1, 4, 5)
	DatabaseVersion1_0_0 = NewDefaultVersion(1, 0, 0)

	ApricotPhase0Times = map[uint32]time.Time{
		constants.MainnetID: time.Date(2020, time.December, 8, 3, 0, 0, 0, time.UTC),
		constants.FujiID:    time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC),
	}
	ApricotPhase0DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	ApricotPhase1Times = map[uint32]time.Time{
		constants.MainnetID: time.Date(2021, time.March, 31, 14, 0, 0, 0, time.UTC),
		constants.FujiID:    time.Date(2021, time.March, 26, 14, 0, 0, 0, time.UTC),
	}
	ApricotPhase1DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	ApricotPhase2Times = map[uint32]time.Time{
		constants.MainnetID: time.Date(2021, time.May, 10, 11, 0, 0, 0, time.UTC),
		constants.FujiID:    time.Date(2021, time.May, 5, 14, 0, 0, 0, time.UTC),
	}
	ApricotPhase2DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	ApricotPhase3Times = map[uint32]time.Time{
		constants.FujiID: time.Date(2021, time.August, 16, 19, 0, 0, 0, time.UTC),
	}
	ApricotPhase3DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)
)

var (
	DefaultVersion1_0_0 = NewDefaultVersion(1, 0, 0)
)

Functions

func GetApricotPhase0Time

func GetApricotPhase0Time(networkID uint32) time.Time

func GetApricotPhase1Time

func GetApricotPhase1Time(networkID uint32) time.Time

func GetApricotPhase2Time

func GetApricotPhase2Time(networkID uint32) time.Time

func GetApricotPhase3Time

func GetApricotPhase3Time(networkID uint32) time.Time

Types

type Application

type Application interface {
	Version
	App() string
	Compatible(Application) error
	Before(Application) bool
}

Application defines what is needed to describe a versioned Application.

func NewApplication

func NewApplication(
	app string,
	appSeparator string,
	versionSeparator string,
	major int,
	minor int,
	patch int,
) Application

NewApplication returns a new version

func NewDefaultApplication

func NewDefaultApplication(
	app string,
	major int,
	minor int,
	patch int,
) Application

NewDefaultApplication returns a new version with default separators

type ApplicationParser

type ApplicationParser interface {
	Parse(string) (Application, error)
}

ApplicationParser defines the interface of an ApplicationVersion parser

func NewApplicationParser

func NewApplicationParser(appSeparator string, versionSeparator string) ApplicationParser

NewApplicationParser returns a new parser

func NewDefaultApplicationParser

func NewDefaultApplicationParser() ApplicationParser

NewDefaultApplicationParser returns a new parser with the default separators

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

	// Returns nil if the provided version shouldn't be masked. This means that
	// the version is connectable but not compatible. The version is so old that
	// it should just be masked.
	Unmaskable(Application) error

	// Returns nil if the provided version will not be masked by this version.
	WontMask(Application) error

	// Returns when additional masking will occur.
	MaskTime() time.Time
}

Compatibility a utility for checking the compatibility of peer versions

func GetCompatibility

func GetCompatibility(networkID uint32) Compatibility

func NewCompatibility

func NewCompatibility(
	version Application,
	minCompatable Application,
	minCompatableTime time.Time,
	prevMinCompatable Application,
	minUnmaskable Application,
	minUnmaskableTime time.Time,
	prevMinUnmaskable Application,
) Compatibility

NewCompatibility returns a compatibility checker with the provided options

type Parser

type Parser interface {
	Parse(string) (Version, error)
}

Parser defines the interface of a Version parser

func NewDefaultParser

func NewDefaultParser() Parser

func NewParser

func NewParser(prefix, separator string) Parser

type Version

type Version interface {
	fmt.Stringer

	Major() int
	Minor() int
	Patch() int
	// Compare returns a positive number if v > o, 0 if v == o, or a negative number if v < 0.
	Compare(o Version) int
}

func NewDefaultVersion

func NewDefaultVersion(major, minor, patch int) Version

func NewVersion

func NewVersion(major, minor, patch int, prefix, versionSeparator string) Version