flags

package
v0.0.0-...-41d3419 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2025 License: AGPL-3.0, AGPL-3.0-or-later Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Flag names
	FlagUnixSocketAddress           = "unix-socket-address"
	FlagPanicOnDaemonFailureEnabled = "panic-on-daemon-failure-enabled"
	FlagMaxDaemonUnhealthySeconds   = "max-daemon-unhealthy-seconds"

	FlagSDAIDaemonEnabled        = "sDai-daemon-enabled"
	FlagSDAIDaemonMockEnabled    = "sDAI-daemon-mock-enabled"
	FlagSDAIDaemonMockNoYield    = "sDAI-daemon-mock-no-yield"
	FlagSDAIDaemonLoopDelayMs    = "sDAI-daemon-loop-delay-ms"
	FlagSDAIDaemonEthRpcEndpoint = "sDAI-daemon-eth-rpc-endpoint"

	FlagPriceDaemonEnabled     = "price-daemon-enabled"
	FlagPriceDaemonLoopDelayMs = "price-daemon-loop-delay-ms"

	FlagDeleveragingDaemonEnabled        = "deleveraging-daemon-enabled"
	FlagDeleveragingDaemonLoopDelayMs    = "deleveraging-daemon-loop-delay-ms"
	FlagDeleveragingDaemonQueryPageLimit = "deleveraging-daemon-query-page-limit"
)

List of CLI flags for Server and Client.

Variables

This section is empty.

Functions

func AddDaemonFlagsToCmd

func AddDaemonFlagsToCmd(
	cmd *cobra.Command,
)

AddDaemonFlagsToCmd adds the required flags to instantiate a server and client for price updates. These flags should be applied to the `start` command V4 Cosmos application. E.g. `klyraprotocold start --price-daemon-enabled=true --unix-socket-address $(unix_socket_address)`

Types

type DaemonFlags

type DaemonFlags struct {
	Shared       SharedFlags
	SDAI         SDAIFlags
	Price        PriceFlags
	Deleveraging DeleveragingFlags
}

DaemonFlags contains the collected configuration flags for all daemons.

func GetDaemonFlagValuesFromOptions

func GetDaemonFlagValuesFromOptions(
	appOpts servertypes.AppOptions,
) DaemonFlags

GetDaemonFlagValuesFromOptions gets all daemon flag values from the `AppOptions` struct.

func GetDefaultDaemonFlags

func GetDefaultDaemonFlags() DaemonFlags

GetDefaultDaemonFlags returns the default values for the Daemon Flags using a singleton pattern.

type DeleveragingFlags

type DeleveragingFlags struct {
	// Enabled toggles the deleveraging daemon on or off.
	Enabled bool
	// LoopDelayMs configures the update frequency of the deleveraging daemon.
	LoopDelayMs uint32
	// QueryPageLimit configures the pagination limit for fetching subaccounts.
	QueryPageLimit uint64
}

DeleveragingFlags contains configuration flags for the Deleveraging Daemon.

type PriceFlags

type PriceFlags struct {
	// Enabled toggles the price daemon on or off.
	Enabled bool
	// LoopDelayMs configures the update frequency of the price daemon.
	LoopDelayMs uint32
}

PriceFlags contains configuration flags for the Price Daemon.

type SDAIFlags

type SDAIFlags struct {
	// Enabled toggles the DAI daemon on or off.
	Enabled bool
	// MockEnabled toggles the mock DAI daemon on or off.
	MockEnabled bool
	// MockNoYield toggles the mock DAI daemon to not yield any events.
	MockNoYield bool
	// LoopDelayMs configures the update frequency of the DAI daemon.
	LoopDelayMs uint32
	// EthRpcEndpoint is the endpoint for the Ethereum node where DAI data is queried.
	EthRpcEndpoint string
}

sDAIFlags contains configuration flags for the DAI Daemon.

type SharedFlags

type SharedFlags struct {
	// SocketAddress is the location of the unix socket to communicate with the daemon gRPC service.
	SocketAddress string
	// PanicOnDaemonFailureEnabled toggles whether the daemon should panic on failure.
	PanicOnDaemonFailureEnabled bool
	// MaxDaemonUnhealthySeconds is the maximum allowable duration for which a daemon can be unhealthy.
	MaxDaemonUnhealthySeconds uint32
}

Shared flags contains configuration flags shared by all daemons.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳