context

Documentation

Index

• Constants
• func SetHyperdriveContext(c *cli.Context, hd *HyperdriveContext)
• type HyperdriveContext
  • func GetHyperdriveContext(c *cli.Context) *HyperdriveContext
  • func NewHyperdriveContext(userDirPath string, installationInfo *InstallationInfo) *HyperdriveContext
  • func (c *HyperdriveContext) LoadNetworkSettings() error
• type InstallationInfo
  • func NewInstallationInfo() *InstallationInfo

Constants

const (
	// Environment variable to set the system path for unit tests
	TestSystemDirEnvVar string = "HYPERDRIVE_TEST_SYSTEM_DIR"
)

Functions

func SetHyperdriveContext

func SetHyperdriveContext(c *cli.Context, hd *HyperdriveContext)

Add the Hyperdrive context into a CLI context

Types

type HyperdriveContext

type HyperdriveContext struct {
	*InstallationInfo

	// The path to the Hyperdrive user directory
	UserDirPath string

	// The max fee for transactions
	MaxFee float64

	// The max priority fee for transactions
	MaxPriorityFee float64

	// The nonce for the first transaction, if set
	Nonce *big.Int

	// True if debug mode is enabled
	DebugEnabled bool

	// True if this is a secure session
	SecureSession bool

	// The address and URL of the API server
	ApiUrl *url.URL

	// The HTTP trace file if tracing is enabled
	HttpTraceFile *os.File

	// The list of networks options and corresponding settings for Hyperdrive itself
	HyperdriveNetworkSettings []*hdconfig.HyperdriveSettings

	// The list of networks options and corresponding settings for the StakeWise module
	StakeWiseNetworkSettings []*swconfig.StakeWiseSettings

	// The list of networks options and corresponding settings for the Constellation module
	ConstellationNetworkSettings []*csconfig.ConstellationSettings
}

Context for global settings

func GetHyperdriveContext

func GetHyperdriveContext(c *cli.Context) *HyperdriveContext

Get the Hyperdrive context from a CLI context

func NewHyperdriveContext

func NewHyperdriveContext(userDirPath string, installationInfo *InstallationInfo) *HyperdriveContext

Creates a new Hyperdrive context. If installationInfo is nil, a new one will be created using the system configuration.

func (*HyperdriveContext) LoadNetworkSettings

func (c *HyperdriveContext) LoadNetworkSettings() error

Load the network settings

type InstallationInfo

type InstallationInfo struct {
	// The system path for Hyperdrive scripts used in the Docker containers
	ScriptsDir string

	// The system path for Hyperdrive templates
	TemplatesDir string

	// The system path for the source files to put in the user's override directory
	OverrideSourceDir string

	// The system path for built-in network settings and resource definitions
	NetworksDir string
}

Holds information about Hyperdrive's installation on the system

func NewInstallationInfo

func NewInstallationInfo() *InstallationInfo

Creates a new installation info instance