config

Documentation

Index

• Variables
• func MakeAbsolute(root, path string) string
• func OffsetPort(addr string, offset int) (*url.URL, error)
• func Store(config *Config) error
• type API
• type Accumulate
• type Config
  • func Default(net NetworkType, node NodeType, netId string) *Config
  • func Load(dir string) (*Config, error)
• type LogLevel
  • func (l LogLevel) Parse(s string) LogLevel
  • func (l LogLevel) SetDefault(level string) LogLevel
  • func (l LogLevel) SetModule(module, level string) LogLevel
  • func (l LogLevel) String() string
• type Network
  • func (n *Network) AnchorPool() *url.URL
  • func (n *Network) GetBvnNames() []string
  • func (n *Network) GetSubnetByID(subnetID string) Subnet
  • func (n *Network) Ledger() *url.URL
  • func (n *Network) NodeUrl(path ...string) *url.URL
  • func (n *Network) OperatorBook() *url.URL
  • func (n *Network) OperatorPage(index uint64) *url.URL
  • func (n *Network) Synthetic() *url.URL
  • func (n *Network) ValidatorBook() *url.URL
  • func (n *Network) ValidatorPage(index uint64) *url.URL
• type NetworkType
• type NetworkUrl
  • func (u NetworkUrl) AnchorPool() *url.URL
  • func (u NetworkUrl) Ledger() *url.URL
  • func (u NetworkUrl) OperatorBook() *url.URL
  • func (u NetworkUrl) OperatorPage(index uint64) *url.URL
  • func (u NetworkUrl) Synthetic() *url.URL
  • func (u NetworkUrl) ValidatorBook() *url.URL
  • func (u NetworkUrl) ValidatorPage(index uint64) *url.URL
• type Node
• type NodeType
• type Snapshots
• type Storage
• type StorageType
• type Subnet
• type Website

Variables

var DefaultLogLevels = LogLevel{}.
	SetDefault("error").
	SetModule("snapshot", "info").
	SetModule("executor", "info").
	String()

Functions

func MakeAbsolute

func MakeAbsolute(root, path string) string

func OffsetPort

func OffsetPort(addr string, offset int) (*url.URL, error)

func Store

func Store(config *Config) error

Types

type API

type API struct {
	TxMaxWaitTime      time.Duration `toml:"tx-max-wait-time" mapstructure:"tx-max-wait-time"`
	PrometheusServer   string        `toml:"prometheus-server" mapstructure:"prometheus-server"`
	ListenAddress      string        `toml:"listen-address" mapstructure:"listen-address"`
	DebugJSONRPC       bool          `toml:"debug-jsonrpc" mapstructure:"debug-jsonrpc"`
	EnableDebugMethods bool          `toml:"enable-debug-methods" mapstructure:"enable-debug-methods"`
	ConnectionLimit    int           `toml:"connection-limit" mapstructure:"connection-limit"`
}

type Accumulate

type Accumulate struct {
	SentryDSN string `toml:"sentry-dsn" mapstructure:"sentry-dsn"`

	Network   Network   `toml:"network" mapstructure:"network"`
	Snapshots Snapshots `toml:"snapshots" mapstructure:"snapshots"`
	Storage   Storage   `toml:"storage" mapstructure:"storage"`
	API       API       `toml:"api" mapstructure:"api"`
	Website   Website   `toml:"website" mapstructure:"website"`
}

type Config

type Config struct {
	tm.Config
	Accumulate Accumulate
}

func Default

func Default(net NetworkType, node NodeType, netId string) *Config

func Load

func Load(dir string) (*Config, error)

type LogLevel

type LogLevel struct {
	Default string
	Modules [][2]string
}

LogLevel defines the default and per-module log level for Accumulate's logging.

func (LogLevel) Parse

func (l LogLevel) Parse(s string) LogLevel

Parse parses a string such as "error;accumulate=info" into a LogLevel.

func (LogLevel) SetDefault

func (l LogLevel) SetDefault(level string) LogLevel

SetDefault sets the default log level.

func (LogLevel) SetModule

func (l LogLevel) SetModule(module, level string) LogLevel

SetModule sets the log level for a module.

func (LogLevel) String

func (l LogLevel) String() string

String convers the log level into a string, for example "error;accumulate=debug".

type Network

type Network struct {
	Type          NetworkType `toml:"type" mapstructure:"type"`
	LocalSubnetID string      `toml:"local-subnet" mapstructure:"local-subnet"`
	LocalAddress  string      `toml:"local-address" mapstructure:"local-address"`
	Subnets       []Subnet    `toml:"subnets" mapstructure:"subnets"`
}

func (*Network) AnchorPool

func (n *Network) AnchorPool() *url.URL

AnchorPool returns the URL of the subnet's anchor pool.

func (*Network) GetBvnNames

func (n *Network) GetBvnNames() []string

func (*Network) GetSubnetByID

func (n *Network) GetSubnetByID(subnetID string) Subnet

func (*Network) Ledger

func (n *Network) Ledger() *url.URL

Ledger returns the URL of the subnet's ledger account.

func (*Network) NodeUrl

func (n *Network) NodeUrl(path ...string) *url.URL

NodeUrl returns the URL of the subnet, optionally with a path appended.

func (*Network) OperatorBook

func (n *Network) OperatorBook() *url.URL

OperatorBook returns the URL of the subnet's operator key book.

func (*Network) OperatorPage

func (n *Network) OperatorPage(index uint64) *url.URL

OperatorPage returns the URL of the page of the subnet's operator key book.

func (*Network) Synthetic

func (n *Network) Synthetic() *url.URL

Synthetic returns the URL of the subnet's ledger account.

func (*Network) ValidatorBook

func (n *Network) ValidatorBook() *url.URL

ValidatorBook returns the URL of the subnet's validator key book.

func (*Network) ValidatorPage

func (n *Network) ValidatorPage(index uint64) *url.URL

ValidatorPage returns the URL of the page of the subnet's validator key book.

type NetworkType

type NetworkType string

const (
	BlockValidator NetworkType = "block-validator"
	Directory      NetworkType = "directory"
)

type NetworkUrl

type NetworkUrl struct {
	*url.URL
}

func (NetworkUrl) AnchorPool

func (u NetworkUrl) AnchorPool() *url.URL

AnchorPool returns the URL of the subnet's anchor pool.

func (NetworkUrl) Ledger

func (u NetworkUrl) Ledger() *url.URL

Ledger returns the URL of the subnet's ledger account.

func (NetworkUrl) OperatorBook

func (u NetworkUrl) OperatorBook() *url.URL

OperatorBook returns the URL of the subnet's operator key book.

func (NetworkUrl) OperatorPage

func (u NetworkUrl) OperatorPage(index uint64) *url.URL

OperatorPage returns the URL of the page of the subnet's operator key book.

func (NetworkUrl) Synthetic

func (u NetworkUrl) Synthetic() *url.URL

Synthetic returns the URL of the subnet's synthetic transaction ledger account.

func (NetworkUrl) ValidatorBook

func (u NetworkUrl) ValidatorBook() *url.URL

ValidatorBook returns the URL of the subnet's validator key book.

func (NetworkUrl) ValidatorPage

func (u NetworkUrl) ValidatorPage(index uint64) *url.URL

ValidatorPage returns the URL of the page of the subnet's validator key book.

type Node

type Node struct {
	Address string
	Type    NodeType `toml:"type" mapstructure:"type"`
}

type NodeType

type NodeType string

const (
	Validator NodeType = "validator"
	Follower  NodeType = "follower"
)

type Snapshots

type Snapshots struct {
	// Directory is the directory to store snapshots in
	Directory string `toml:"directory" mapstructure:"directory"`

	// RetainCount is the number of snapshots to retain
	RetainCount int `toml:"retain" mapstructure:"retain"`

	// Frequency is how many major blocks should occur before another snapshot
	// is taken
	Frequency int `toml:"frequency" mapstructure:"frequency"`
}

type Storage

type Storage struct {
	Type StorageType  `toml:"type" mapstructure:"type"`
	Path string       `toml:"path" mapstructure:"path"`
	Etcd *etcd.Config `toml:"etcd" mapstructure:"etcd"`
}

type StorageType

type StorageType string

const (
	MemoryStorage StorageType = "memory"
	BadgerStorage StorageType = "badger"
	EtcdStorage   StorageType = "etcd"
)

type Subnet

type Subnet struct {
	ID    string      `toml:"id" mapstructure:"id"`
	Type  NetworkType `toml:"type" mapstructure:"type"`
	Nodes []Node      `toml:"nodes" mapstructure:"nodes"`
}

type Website

type Website struct {
	Enabled       bool   `toml:"website-enabled" mapstructure:"website-enabled"`
	ListenAddress string `toml:"website-listen-address" mapstructure:"website-listen-address"`
}