metadata

Documentation

Overview

Package metadata contains build information of executable usually provided by automated build systems like Travis. Default values are populated if not overridden by build system

Index

• Constants
• Variables
• func BuildAsString() string
• func FormatString(commit, branch, buildNumber string) string
• func LicenseCopyright(warrantyCommand, conditionsCommand string) string
• func VersionAsString() string
• func VersionAsSummary(licenseCopyright string) string
• type NetworkDefinition

Constants

const LicenseConditions = `` /* 28846-byte string literal not displayed */

LicenseConditions of license

const LicenseWarranty = `` /* 551-byte string literal not displayed */

LicenseWarranty of license

Variables

var (
	// BuildCommit comes from BUILD_COMMIT env variable (set via linker flags)
	BuildCommit = ""
	// BuildBranch comes from BUILD_BRANCH env variable (set via linker flags)
	BuildBranch = "<unknown>"
	// BuildNumber comes from BUILD_NUMBER env variable (set via linker flags)
	BuildNumber = "dev-build"
)

var DefaultNetwork = TestnetDefinition

DefaultNetwork defines default network values when no runtime parameters are given

var LocalnetDefinition = NetworkDefinition{
	"http://localhost/v1",
	"localhost",
	"http://localhost:8545",
	common.HexToAddress("0x1955141ba8e77a5B56efBa8522034352c94f77Ea"),
}

LocalnetDefinition defines parameters for local network (expects discovery and broker services on localhost)

var TestnetDefinition = NetworkDefinition{
	"https://testnet-api.mysterium.network/v1",
	"testnet-broker.mysterium.network",
	"https://ropsten.infura.io",
	common.HexToAddress("0xbe5F9CCea12Df756bF4a5Baf4c29A10c3ee7C83B"),
}

TestnetDefinition defines parameters for test network (currently default network)

var Version = ""

Version comes from BUILD_VERSION env variable (set via linker flags)

Functions

func BuildAsString

func BuildAsString() string

BuildAsString returns all defined build constants as single string

func FormatString

func FormatString(commit, branch, buildNumber string) string

FormatString formats build info to string with given build data

func LicenseCopyright

func LicenseCopyright(warrantyCommand, conditionsCommand string) string

LicenseCopyright returns copyright text string with custom commands

func VersionAsString

func VersionAsString() string

VersionAsString returns all defined version constants as single string

func VersionAsSummary

func VersionAsSummary(licenseCopyright string) string

VersionAsSummary returns overview of current program's version

Types

type NetworkDefinition

type NetworkDefinition struct {
	DiscoveryAPIAddress     string
	BrokerAddress           string
	EtherClientRPC          string
	PaymentsContractAddress common.Address
}

NetworkDefinition structure holds all parameters which describe particular network