networkoptions

Documentation

Overview

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

• func AddNetworkFlagsToCmd(cmd *cobra.Command, networkFlags *NetworkFlags, alwaysAddEndpoint bool, ...)
• func GetNetworkFromCmdLineFlags(app *application.Avalanche, networkFlags NetworkFlags, ...) (models.Network, error)
• func GetNetworkFromSidecarNetworkName(app *application.Avalanche, networkName string) (models.Network, error)
• type NetworkFlags
• type NetworkOption
  • func GetSupportedNetworkOptionsForSubnet(app *application.Avalanche, subnetName string, ...) ([]NetworkOption, []string, []string, error)
  • func (n NetworkOption) String() string

Functions

func AddNetworkFlagsToCmd

func AddNetworkFlagsToCmd(cmd *cobra.Command, networkFlags *NetworkFlags, alwaysAddEndpoint bool, supportedNetworkOptions []NetworkOption)

func GetNetworkFromCmdLineFlags

func GetNetworkFromCmdLineFlags(
	app *application.Avalanche,
	networkFlags NetworkFlags,
	requireDevnetEndpointSpecification bool,
	supportedNetworkOptions []NetworkOption,
	subnetName string,
) (models.Network, error)

func GetNetworkFromSidecarNetworkName

func GetNetworkFromSidecarNetworkName(
	app *application.Avalanche,
	networkName string,
) (models.Network, error)

Types

type NetworkFlags

type NetworkFlags struct {
	UseLocal    bool
	UseDevnet   bool
	UseTahoe    bool
	UseMainnet  bool
	Endpoint    string
	ClusterName string
}

type NetworkOption

type NetworkOption int64

const (
	Undefined NetworkOption = iota
	Mainnet
	Tahoe
	Local
	Devnet
	Cluster
)

func GetSupportedNetworkOptionsForSubnet

func GetSupportedNetworkOptionsForSubnet(
	app *application.Avalanche,
	subnetName string,
	supportedNetworkOptions []NetworkOption,
) ([]NetworkOption, []string, []string, error)

func (NetworkOption) String

func (n NetworkOption) String() string