configuration

Documentation

Index

• Constants
• type Configuration
  • func LoadConfiguration() (*Configuration, error)
• 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 ICON Mainnet.
	Mainnet string = "MAINNET"

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

	Ziconet string = "ZICON"

	Devnet string = "DEVNET"

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

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

	// EndpointEnv is the environment variable
	// read to determine endpoint.
	EndpointEnv = "ENDPOINT"

	// DefaultEndPoint is the default endpoint for a running node.
	DefaultEndPoint = "http://localhost:9000"

	EndpointPrefix        = "api"
	EndpointVersionPrefix = "v3"
	DebugPrefix           = "debug"

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

Types

type Configuration

type Configuration struct {
	Mode     Mode
	Network  *types.NetworkIdentifier
	URL      string
	DebugURL string
	Port     int
}

Configuration determines how

func LoadConfiguration

func LoadConfiguration() (*Configuration, error)

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

type Mode

type Mode string

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