configuration

Documentation

Overview

Package configuration loads service configuration from the environment

Index

• Constants
• Variables
• type ConfigLoader
• type Configuration
  • func LoadConfig(loader ConfigLoader) (*Configuration, error)
• type EnvLoader
  • func (l *EnvLoader) Get(key string) string
• type Mode
  • func ModeFromString(val string) (m Mode, err error)
  • func (m Mode) String() string

Constants

const (
	// Online specifies that outbound connections are permitted.
	Online Mode = "online"

	// Offline specifies that outbound connections are not permitted.
	Offline Mode = "offline"

	// ModeEnv specifies the environment variable read to set the Mode
	ModeEnv = "MODE"

	// NetworkEnv specifies the environment variable to read Network/ChainId from
	NetworkEnv = "NETWORK"

	// PortEnv specifies the environment variable to read server port from
	PortEnv = "PORT"

	// KavaRPCURLEnv specifies the environment variable to read server port from
	KavaRPCURLEnv = "KAVA_RPC_URL"
)

Variables

var MiddlewareVersion = "0.0.1"

MiddlewareVersion represents the kava rosetta service version

Types

type ConfigLoader

type ConfigLoader interface {
	Get(key string) string
}

ConfigLoader provides an interface for loading values from a string key

type Configuration

type Configuration struct {
	Mode              Mode
	NetworkIdentifier *types.NetworkIdentifier
	Port              int
	KavaRPCURL        string
}

Configuration represents values to configure behavior of rosetta-kava and network to communicate with.

func LoadConfig

func LoadConfig(loader ConfigLoader) (*Configuration, error)

LoadConfig loads keys from a provided loader and returns a complete Configuration reference for rosetta-kava

type EnvLoader

type EnvLoader struct {
}

EnvLoader loads keys from os environment and implements ConfigLoader

func (*EnvLoader) Get

func (l *EnvLoader) Get(key string) string

Get retrieves key from os environment

type Mode

type Mode string

Mode identifies if the service is running in an 'online' or 'offline' capacity. Ref: https://www.rosetta-api.org/docs/node_deployment.html#multiple-modes

func ModeFromString

func ModeFromString(val string) (m Mode, err error)

ModeFromString returns a Mode from a string value

func (Mode) String

func (m Mode) String() string

String converts mode to string