flags

Documentation

Index

• Constants
• func AddDaemonFlagsToCmd(cmd *cobra.Command)
• type BridgeFlags
• type DaemonFlags
  • func GetDaemonFlagValuesFromOptions(appOpts servertypes.AppOptions) DaemonFlags
  • func GetDefaultDaemonFlags() DaemonFlags
• type LiquidationFlags
• type PriceFlags
• type SharedFlags

Constants

const (
	// Flag names
	FlagUnixSocketAddress = "unix-socket-address"

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

	FlagBridgeDaemonEnabled        = "bridge-daemon-enabled"
	FlagBridgeDaemonLoopDelayMs    = "bridge-daemon-loop-delay-ms"
	FlagBridgeDaemonEthRpcEndpoint = "bridge-daemon-eth-rpc-endpoint"

	FlagLiquidationDaemonEnabled             = "liquidation-daemon-enabled"
	FlagLiquidationDaemonLoopDelayMs         = "liquidation-daemon-loop-delay-ms"
	FlagLiquidationDaemonSubaccountPageLimit = "liquidation-daemon-subaccount-page-limit"
	FlagLiquidationDaemonRequestChunkSize    = "liquidation-daemon-request-chunk-size"
)

List of CLI flags for Server and Client.

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. `dydxprotocold start --price-daemon-enabled=true --unix-socket-address $(unix_socket_address)`

Types

type BridgeFlags

type BridgeFlags struct {
	// Enabled toggles the bridge daemon on or off.
	Enabled bool
	// LoopDelayMs configures the update frequency of the bridge daemon.
	LoopDelayMs uint32
	// EthRpcEndpoint is the endpoint for the Ethereum node where bridge data is queried.
	EthRpcEndpoint string
}

BridgeFlags contains configuration flags for the Bridge Daemon.

type DaemonFlags

type DaemonFlags struct {
	Shared      SharedFlags
	Bridge      BridgeFlags
	Liquidation LiquidationFlags
	Price       PriceFlags
}

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 LiquidationFlags

type LiquidationFlags struct {
	// Enabled toggles the liquidation daemon on or off.
	Enabled bool
	// LoopDelayMs configures the update frequency of the liquidation daemon.
	LoopDelayMs uint32
	// SubaccountPageLimit configures the pagination limit for fetching subaccounts.
	SubaccountPageLimit uint64
	RequestChunkSize    uint64
}

LiquidationFlags contains configuration flags for the Liquidation 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 SharedFlags

type SharedFlags struct {
	// SocketAddress is the location of the unix socket to communicate with the daemon gRPC service.
	SocketAddress string
}

Shared flags contains configuration flags shared by all daemons.