config

Documentation

Overview

Package config contains the configuration required to run a node. while each submodule defines it's own validator adhering to common.Validator they are all stored and validated centrally bt the node here.

Index

• Constants
• Variables
• func GetConfigDir() (string, error)
• func GetLogoPath() (_ string, err error)
• type BuildInfo
  • func NewBuildInfo(version, commit, name, date string) BuildInfo
  • func (b BuildInfo) Commit() string
  • func (b BuildInfo) Date() string
  • func (b BuildInfo) MetricInterval() time.Duration
  • func (b BuildInfo) Name() string
  • func (b BuildInfo) Version() string
  • func (b BuildInfo) VersionString() string

Constants

const AppName = "Sanguine"

AppName is the application name.

const DefaultCommit = "none"

DefaultCommit is the default commit. Build info will attempt to replace with the current commit if not present.

const DefaultMetricInterval = time.Duration(1) * time.Minute

DefaultMetricInterval is the metric interval.

const DefaultVersion = "0.1.0"

DefaultVersion is the application version.

const VendorName = "synapsecns"

VendorName is the vendor named used for versioning schemes that depend on a vendor name we use the github name for convince.

Variables

var DefaultDate = time.Now().Format(time.RFC3339)

DefaultDate when not passed in by the compiler.

Functions

func GetConfigDir

func GetConfigDir() (string, error)

GetConfigDir gets the config dir. We create a default file to mark the directory level. if the config dir can not be created, an error is returned.

func GetLogoPath

func GetLogoPath() (_ string, err error)

GetLogoPath fetches the logo path from the config and writes it to the global config if it doesn't exist TODO this should be more generalized to work across static assets when we have more. returns an empty string if not present.

Types

type BuildInfo

type BuildInfo struct {
	// contains filtered or unexported fields
}

BuildInfo will contains build info from https://goreleaser.com/cookbooks/using-main.version it is set at compile time by default. If it cannot be, we attempt to derive it at runtime.

func NewBuildInfo

func NewBuildInfo(version, commit, name, date string) BuildInfo

NewBuildInfo creates a build info struct from buildtime data it sets sensible defaults.

func (BuildInfo) Commit

func (b BuildInfo) Commit() string

Commit of the build.

func (BuildInfo) Date

func (b BuildInfo) Date() string

Date the application was built.

func (BuildInfo) MetricInterval

func (b BuildInfo) MetricInterval() time.Duration

MetricInterval the interval to record metrics at.

func (BuildInfo) Name

func (b BuildInfo) Name() string

Name of the application.

func (BuildInfo) Version

func (b BuildInfo) Version() string

Version of the build.

func (BuildInfo) VersionString

func (b BuildInfo) VersionString() string

VersionString pretty prints a version string with the info above.