version

Documentation

Index

• Variables
• func GetNetworkVersionThroughGRPC(hosts []string) (string, error)
• func IsUnreleased() bool
• type CheckSoftwareCompatibilityResponse
  • func CheckSoftwareCompatibility(netStore NetworkStore, requestVersionFn RequestVersionFn) (*CheckSoftwareCompatibilityResponse, error)
• type GetSoftwareVersionResponse
  • func GetSoftwareVersionInfo() *GetSoftwareVersionResponse
• type NetworkCompatibility
• type NetworkStore
• type RequestVersionFn

Variables

var (
	ErrConnectionError      = errors.New("verify you are connected to the internet")
	ErrCouldNotConnectNodes = errors.New("could not connect to any nodes: verify your network configuration is up to date")
)

var ErrCouldNotListNetworks = errors.New("couldn't list the networks")

Functions

func GetNetworkVersionThroughGRPC

func GetNetworkVersionThroughGRPC(hosts []string) (string, error)

func IsUnreleased

func IsUnreleased() bool

Types

type CheckSoftwareCompatibilityResponse

type CheckSoftwareCompatibilityResponse struct {
	NetworksCompatibility []NetworkCompatibility `json:"networksCompatibility"`
}

func CheckSoftwareCompatibility

func CheckSoftwareCompatibility(netStore NetworkStore, requestVersionFn RequestVersionFn) (*CheckSoftwareCompatibilityResponse, error)

type GetSoftwareVersionResponse

type GetSoftwareVersionResponse struct {
	Version string `json:"version"`
	GitHash string `json:"gitHash"`
}

func GetSoftwareVersionInfo

func GetSoftwareVersionInfo() *GetSoftwareVersionResponse

type NetworkCompatibility

type NetworkCompatibility struct {
	Network          string `json:"network"`
	IsCompatible     bool   `json:"isCompatible"`
	RetrievedVersion string `json:"retrievedVersion"`
	Error            error  `json:"error"`
}

type NetworkStore

type NetworkStore interface {
	ListNetworks() ([]string, error)
	GetNetwork(string) (*network.Network, error)
}

type RequestVersionFn

type RequestVersionFn func(hosts []string) (string, error)

RequestVersionFn is the function in charge of retrieving the network version ran by the host lists.