config

Documentation

Index

• Constants
• Variables
• func GetBool(key string) bool
• func GetDatadir() string
• func GetInt(key string) int
• func GetNetwork() *network.Network
• func GetRootPath() string
• func GetString(key string) string
• func GetStringSlice(key string) []string
• func IsSet(key string) bool
• func Set(key string, val interface{})
• func Unset(key string)

Constants

const (
	// DatadirKey is the key to customize the ocean datadir.
	DatadirKey = "DATADIR"
	// DbTypeKey is the key to customize the type of database to use.
	DbTypeKey = "DB_TYPE"
	// BlockchainScannerTypeKey is the key to customize the type of blockchain
	// scanner to use.
	BlockchainScannerTypeKey = "BLOCKCHAIN_SCANNER_TYPE"
	// PortKey is the key to customize the port where the wallet will be listening to.
	PortKey = "PORT"
	// ProfilerPortKey is the key to customize the port where the profiler will
	// be listening to.
	ProfilerPortKey = "PROFILER_PORT"
	// NetworkKey is the key to customize the Liquid network.
	NetworkKey = "NETWORK"
	// NativeAssetKey is the key to customize the native LBTC asset of the Liquid
	// network. Should be used only for testing purposes.
	NativeAssetKey = "NATIVE_ASSET"
	// LogLevelKey is the key to customize the log level to catch more specific
	// or more high level logs.
	LogLevelKey = "LOG_LEVEL"
	// TLSExtraIPKey is the key to bind one or more public IPs to the TLS key pair.
	// Should be used only when enabling TLS.
	TLSExtraIPKey = "TLS_EXTRA_IP"
	// TLSExtraDomainKey is the key to bind one or more public dns domains to the
	// TLS key pair. Should be used only when enabling TLS.
	TLSExtraDomainKey = "TLS_EXTRA_DOMAIN"
	// NoTLSKey is the key to disable TLS encryption.
	NoTLSKey = "NO_TLS"
	// NoProfilerKey is the key to disable Prometheus profiling.
	NoProfilerKey = "NO_PROFILER"
	// StatsIntervalKey is the key to customize the interval for the profiled to
	// gather profiling stats.
	StatsIntervalKey = "STATS_INTERVAL"
	// NodePeersKey is the key to customize the list of peers the embedded SPV
	// node will connect to when started
	NodePeersKey = "NODE_PEERS"
	// ElementsNodeRpcAddrKey is the key to set the rpc address of the node to connect
	// to when using elements-node-based blockchain scanner.
	ElementsNodeRpcAddrKey = "NODE_RPC_ADDR"
	// UtxoExpiryDurationKey is the key to customize the waiting time for one or
	// more previously locked utxos to be unlocked if not yet spent.
	UtxoExpiryDurationKey = "UTXO_EXPIRY_DURATION_IN_SECONDS"
	// RootPathKey is the key to use a custom root path for the wallet,
	// instead of the default m/84'/[1776|1]' (depending on network).
	RootPathKey = "ROOT_PATH"
	// ElectrumUrlKey is the key for the electrum server endpoint consumed by the
	// electrum blockchain scanner.
	ElectrumUrlKey = "ELECTRUM_URL"
	// DbUserKey is user used to connect to db
	DbUserKey = "DB_USER"
	// DbPassKey is password used to connect to db
	DbPassKey = "DB_PASS"
	// DbHostKey is host where db is installed
	DbHostKey = "DB_HOST"
	// DbPortKey is port on which db is listening
	DbPortKey = "DB_PORT"
	// DbNameKey is name of database
	DbNameKey = "DB_NAME"
	// DbMigrationPath is the path to migration files
	DbMigrationPath = "DB_MIGRATION_PATH"
	// DustAmountKey is the key to customize the dust amount threshold
	DustAmountKey = "DUST_AMOUNT"
	// PasswordKey is the key to set the password for auto-init/auto-unlock.
	PasswordKey = "PASSWORD"
	// MnemonicKey is the key to set the mnemonic for auto-init.
	MnemonicKey = "MNEMONIC"

	// DbLocation is the folder inside the datadir containing db files.
	DbLocation = "db"
	// TLSLocation is the folder inside the datadir containing TLS key and
	// certificate.
	TLSLocation = "tls"
	// ScannerLocation is the folder inside the datadir containing blockchain
	// scanner files.
	ScannerLocation = "blockchain"
	// ProfilerLocation is the folder inside the datadir containing profiler
	// stats files.
	ProfilerLocation = "stats"
)

Variables

var (
	SupportedDbs = supportedType{
		"badger":   {},
		"inmemory": {},
		"postgres": {},
	}
	SupportedBcScanners = supportedType{
		"neutrino": {},
		"elements": {},
		"electrum": {},
	}
)

Functions

func GetBool

func GetBool(key string) bool

func GetDatadir

func GetDatadir() string

func GetInt

func GetInt(key string) int

func GetNetwork

func GetNetwork() *network.Network

func GetRootPath

func GetRootPath() string

func GetString

func GetString(key string) string

func GetStringSlice

func GetStringSlice(key string) []string

func IsSet

func IsSet(key string) bool

func Set

func Set(key string, val interface{})

func Unset

func Unset(key string)