configuration

Documentation

Index

• Constants
• func LoadConfiguration(*Configuration, error)
• type Configuration
• type Mode

Constants

const (
	// Online is when the implementation is permitted
	// to make outbound connections.
	Online Mode = "ONLINE"

	// Offline is when the implementation is not permitted
	// to make outbound connections.
	Offline Mode = "OFFLINE"

	// Mainnet is the Bitcoin Mainnet.
	Mainnet string = "MAINNET"

	// Testnet is Bitcoin Testnet3.
	Testnet string = "TESTNET"

	RPCPort = 7777

	// DataDirectory is the default location for all
	// persistent data.
	DataDirectory = "/data"

	// ModeEnv is the environment variable read
	// to determine mode.
	ModeEnv = "MODE"

	// NetworkEnv is the environment variable
	// read to determine network.
	NetworkEnv = "NETWORK"

	// PortEnv is the environment variable
	// read to determine the port for the Rosetta
	// implementation.
	PortEnv = "PORT"

	DefaultRPCURL = "http://157.245.67.232:7777/rpc"
)

Functions

func LoadConfiguration

func LoadConfiguration(*Configuration, error)

LoadConfiguration attempts to create a new Configuration using the ENVs in the environment.

Types

type Configuration

type Configuration struct {
	Mode                   Mode
	Network                *types.NetworkIdentifier
	Currency               *types.Currency
	GenesisBlockIdentifier *types.BlockIdentifier
	Port                   int
	RPCPort                int
	RPCURL                 string
}

Configuration determines how

type Mode

type Mode string

Mode is the setting that determines if the implementation is "online" or "offline".