version

Documentation

Index

• Constants
• Variables
• func GetApricotPhase3Time(networkID uint32) time.Time
• func GetApricotPhase4MinOChainHeight(networkID uint32) uint64
• func GetApricotPhase4Time(networkID uint32) time.Time
• func GetApricotPhase5Time(networkID uint32) time.Time
• func GetApricotPhase6Time(networkID uint32) time.Time
• func GetBanffTime(networkID uint32) time.Time
• func GetCortinaTime(networkID uint32) time.Time
• type Application
  • func ParseApplication(s string) (*Application, error)
  • func (a *Application) Before(o *Application) bool
  • func (a *Application) Compare(o *Application) int
  • func (a *Application) Compatible(o *Application) error
  • func (a *Application) String() string
• type Compatibility
  • func GetCompatibility(networkID uint32) Compatibility
  • func NewCompatibility(version *Application, minCompatable *Application, minCompatableTime time.Time, ...) Compatibility
• type Semantic
  • func Parse(s string) (*Semantic, error)
  • func (s *Semantic) Compare(o *Semantic) int
  • func (s *Semantic) String() string

Constants

const RPCChainVMProtocol uint = 28

RPCChainVMProtocol should be bumped anytime changes are made which require the plugin vm to upgrade to latest odysseygo release to be compatible.

Variables

var (
	Current = &Semantic{
		Major: 1,
		Minor: 10,
		Patch: 10,
	}
	CurrentApp = &Application{
		Major: Current.Major,
		Minor: Current.Minor,
		Patch: Current.Patch,
	}
	MinimumCompatibleVersion = &Application{
		Major: 1,
		Minor: 10,
		Patch: 0,
	}
	PrevMinimumCompatibleVersion = &Application{
		Major: 1,
		Minor: 9,
		Patch: 0,
	}

	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 odysseygo versions that supported that version. This is not used
	// by odysseygo, but is useful for downstream libraries.
	RPCChainVMProtocolCompatibility map[uint][]*Semantic

	ApricotPhase3Times       = map[uint32]time.Time{}
	ApricotPhase3DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	ApricotPhase4Times                  = map[uint32]time.Time{}
	ApricotPhase4DefaultTime            = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)
	ApricotPhase4MinOChainHeight        = map[uint32]uint64{}
	ApricotPhase4DefaultMinOChainHeight uint64

	ApricotPhase5Times       = map[uint32]time.Time{}
	ApricotPhase5DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	ApricotPhase6Times       = map[uint32]time.Time{}
	ApricotPhase6DefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	BanffTimes       = map[uint32]time.Time{}
	BanffDefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)

	CortinaTimes       = map[uint32]time.Time{}
	CortinaDefaultTime = time.Date(2020, time.December, 5, 5, 0, 0, 0, time.UTC)
)

These are globals that describe network upgrades and node versions

var (
	// String is displayed when CLI arg --version is used
	String string

	// GitCommit is set in the build script at compile time
	GitCommit string
)

var (
	// V1_0_0 is a useful version to use in tests
	Semantic1_0_0 = &Semantic{
		Major: 1,
		Minor: 0,
		Patch: 0,
	}
)

Functions

func GetApricotPhase3Time

func GetApricotPhase3Time(networkID uint32) time.Time

func GetApricotPhase4MinOChainHeight

func GetApricotPhase4MinOChainHeight(networkID uint32) uint64

func GetApricotPhase4Time

func GetApricotPhase4Time(networkID uint32) time.Time

func GetApricotPhase5Time

func GetApricotPhase5Time(networkID uint32) time.Time

func GetApricotPhase6Time

func GetApricotPhase6Time(networkID uint32) time.Time

func GetBanffTime

func GetBanffTime(networkID uint32) time.Time

func GetCortinaTime

func GetCortinaTime(networkID uint32) time.Time

Types

type Application

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

func ParseApplication

func ParseApplication(s string) (*Application, error)

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 "odyssey/" 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(networkID uint32) Compatibility

func NewCompatibility

func NewCompatibility(
	version *Application,
	minCompatable *Application,
	minCompatableTime time.Time,
	prevMinCompatable *Application,
) Compatibility

NewCompatibility returns a compatibility checker with the provided options

type Semantic

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

func Parse

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

func (*Semantic) Compare

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

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

func (*Semantic) String

func (s *Semantic) String() string

The only difference here between Semantic and Application is that Semantic prepends "v" rather than "odyssey/".