Documentation
¶
Overview ¶
Package networkoptions provides network option handling for CLI commands.
Index ¶
- Variables
- func AddNetworkFlagsToCmd(cmd *cobra.Command, networkFlags *NetworkFlags, addEndpoint bool, ...)
- func GetNetworkFlagsGroup(cmd *cobra.Command, networkFlags *NetworkFlags, addEndpoint bool, ...) flags.GroupedFlags
- func GetNetworkFromCmdLineFlags(app *application.Lux, promptStr string, networkFlags NetworkFlags, ...) (models.Network, error)
- type CustomEndpointNetwork
- type NetworkFlags
- type NetworkOption
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // DefaultSupportedNetworkOptions are the default network options. DefaultSupportedNetworkOptions = []NetworkOption{ Local, Devnet, Testnet, Mainnet, } NonLocalSupportedNetworkOptions = []NetworkOption{ Devnet, Testnet, Mainnet, } NonMainnetSupportedNetworkOptions = []NetworkOption{ Local, Devnet, Testnet, } LocalClusterSupportedNetworkOptions = []NetworkOption{ Local, Cluster, } )
Functions ¶
func AddNetworkFlagsToCmd ¶
func AddNetworkFlagsToCmd(cmd *cobra.Command, networkFlags *NetworkFlags, addEndpoint bool, supportedNetworkOptions []NetworkOption)
AddNetworkFlagsToCmd adds network flags to a command.
func GetNetworkFlagsGroup ¶
func GetNetworkFlagsGroup(cmd *cobra.Command, networkFlags *NetworkFlags, addEndpoint bool, supportedNetworkOptions []NetworkOption) flags.GroupedFlags
GetNetworkFlagsGroup returns a grouped set of network flags.
func GetNetworkFromCmdLineFlags ¶
func GetNetworkFromCmdLineFlags( app *application.Lux, promptStr string, networkFlags NetworkFlags, requireDevnetEndpointSpecification bool, onlyEndpointBasedDevnets bool, supportedNetworkOptions []NetworkOption, subnetName string, ) (models.Network, error)
GetNetworkFromCmdLineFlags returns a network based on command line flags.
Types ¶
type CustomEndpointNetwork ¶
CustomEndpointNetwork wraps a Network with a custom endpoint
func (*CustomEndpointNetwork) GetEndpoint ¶
func (c *CustomEndpointNetwork) GetEndpoint() string
GetEndpoint returns the custom endpoint
type NetworkFlags ¶
type NetworkFlags struct {
UseLocal bool
UseDevnet bool
UseTestnet bool
UseMainnet bool
Endpoint string
ClusterName string
}
NetworkFlags holds network-related command flags.
type NetworkOption ¶
type NetworkOption int64
NetworkOption represents a network type option.
const ( Undefined NetworkOption = iota Mainnet Testnet Local Devnet Cluster )
Network option constants.
func GetNetworkFromSidecar ¶
func GetNetworkFromSidecar(sc models.Sidecar, defaultOption []NetworkOption) []NetworkOption
GetNetworkFromSidecar returns network options from a sidecar.
func GetSupportedNetworkOptionsForSubnet ¶
func GetSupportedNetworkOptionsForSubnet( app *application.Lux, subnetName string, supportedNetworkOptions []NetworkOption, ) ([]NetworkOption, []string, []string, error)
GetSupportedNetworkOptionsForSubnet returns supported network options for a subnet.
func NetworkOptionFromString ¶
func NetworkOptionFromString(s string) NetworkOption
NetworkOptionFromString converts a string to a NetworkOption.
func (NetworkOption) String ¶
func (n NetworkOption) String() string
Source Files
Click to show internal directories.
Click to hide internal directories.