utils

Documentation

Overview

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

Index

• Constants
• func APMConfigExists(subnetName string) (bool, error)
• func AddSubnetIDToSidecar(subnetName string, network models.Network, subnetID string) error
• func ChainConfigExists(subnetName string) (bool, error)
• func CheckAvalancheGoExists(version string) bool
• func CheckKeyEquality(keyPath1, keyPath2 string) (bool, error)
• func CheckSubnetEVMExists(version string) bool
• func CheckUpgradeIsDeployed(rpcEndpoint string, deployedUpgrades params.UpgradeConfig) error
• func DeleteAPMBin(vmid string)
• func DeleteBins() error
• func DeleteConfigs(subnetName string) error
• func DeleteCustomBinary(vmName string)
• func DeleteKey(keyName string) error
• func DownloadCustomVMBin(subnetEVMversion string) (string, error)
• func FundLedgerAddress() error
• func GetAPMDir() string
• func GetBaseDir() string
• func GetFileHash(filename string) (string, error)
• func GetNodeVMVersion(nodeURI string, vmid string) (string, error)
• func GetNodesInfo() (map[string]NodeInfo, error)
• func GetPluginBinaries() ([]string, error)
• func GetVersionMapping(mapper VersionMapper) (map[string]string, error)
• func GetWhilelistedSubnetsFromConfigFile(configFile string) (string, error)
• func KeyExists(keyName string) (bool, error)
• func ParseGreeterAddress(output string) error
• func ParsePublicDeployOutput(output string) (string, string, error)
• func ParseRPCsFromOutput(output string) ([]string, error)
• func PerNodeChainConfigExists(subnetName string) (bool, error)
• func PrintStdErr(err error)
• func RemoveAPMRepo()
• func RestartNodesWithWhitelistedSubnets(whitelistedSubnets string) error
• func RunHardhatScript(script string) (string, string, error)
• func RunHardhatTests(test string) error
• func RunSpacesVMAPITest(rpc string) error
• func SetHardhatRPC(rpc string) error
• func SubnetAPMVMExists(subnetName string) (bool, error)
• func SubnetConfigExists(subnetName string) (bool, error)
• func SubnetCustomVMExists(subnetName string) (bool, error)
• func WaitSubnetValidators(subnetIDStr string, nodeInfos map[string]NodeInfo) error
• type NodeInfo
• type VersionMapper
  • func NewVersionMapper() VersionMapper

Constants

const (
	BaseTest      = "./test/index.ts"
	GreeterScript = "./scripts/deploy.ts"
	GreeterCheck  = "./scripts/checkGreeting.ts"

	Spaces2AvagoKey        = "spaces2avago"
	Avago2SpacesKey        = "avago2spaces"
	SoloSubnetEVMKey1      = "soloSubnetEVMVersion1"
	SoloSubnetEVMKey2      = "soloSubnetEVMVersion2"
	SoloAvagoKey           = "soloAvagoVersion"
	OnlyAvagoKey           = "onlyAvagoVersion"
	MultiAvagoSubnetEVMKey = "multiAvagoSubnetEVMVersion"
	MultiAvago1Key         = "multiAvagoVersion1"
	MultiAvago2Key         = "multiAvagoVersion2"
	LatestEVM2AvagoKey     = "latestEVM2Avago"
	LatestAvago2EVMKey     = "latestAvago2EVM"
	OnlyAvagoValue         = "latest"

	SubnetEvmGenesisPath      = "tests/e2e/assets/test_subnet_evm_genesis.json"
	SubnetEvmGenesis2Path     = "tests/e2e/assets/test_subnet_evm_genesis_2.json"
	SpacesVMGenesisPath       = "tests/e2e/assets/test_spacesvm_genesis.json"
	EwoqKeyPath               = "tests/e2e/assets/ewoq_key.pk"
	SubnetEvmAllowFeeRecpPath = "tests/e2e/assets/test_subnet_evm_allowFeeRecps_genesis.json"

	PluginDirExt = "plugins"
)

Functions

func APMConfigExists

func APMConfigExists(subnetName string) (bool, error)

func AddSubnetIDToSidecar

func AddSubnetIDToSidecar(subnetName string, network models.Network, subnetID string) error

func ChainConfigExists

func ChainConfigExists(subnetName string) (bool, error)

func CheckAvalancheGoExists

func CheckAvalancheGoExists(version string) bool

func CheckKeyEquality

func CheckKeyEquality(keyPath1, keyPath2 string) (bool, error)

func CheckSubnetEVMExists

func CheckSubnetEVMExists(version string) bool

func CheckUpgradeIsDeployed

func CheckUpgradeIsDeployed(rpcEndpoint string, deployedUpgrades params.UpgradeConfig) error

func DeleteAPMBin

func DeleteAPMBin(vmid string)

func DeleteBins

func DeleteBins() error

func DeleteConfigs

func DeleteConfigs(subnetName string) error

func DeleteCustomBinary

func DeleteCustomBinary(vmName string)

func DeleteKey

func DeleteKey(keyName string) error

func DownloadCustomVMBin

func DownloadCustomVMBin(subnetEVMversion string) (string, error)

Currently downloads subnet-evm, but that suffices to test the custom vm functionality

func FundLedgerAddress

func FundLedgerAddress() error

func GetAPMDir

func GetAPMDir() string

func GetBaseDir

func GetBaseDir() string

func GetFileHash

func GetFileHash(filename string) (string, error)

func GetNodeVMVersion

func GetNodeVMVersion(nodeURI string, vmid string) (string, error)

func GetNodesInfo

func GetNodesInfo() (map[string]NodeInfo, error)

func GetPluginBinaries

func GetPluginBinaries() ([]string, error)

func GetVersionMapping

func GetVersionMapping(mapper VersionMapper) (map[string]string, error)

GetVersionMapping returns a map of specific VMs resp. metalgo e2e context keys to the actual version which corresponds to that key. This allows the e2e test to know what version to download and run. Returns an error if there was a problem reading the URL compatibility json or some other issue.

func GetWhilelistedSubnetsFromConfigFile

func GetWhilelistedSubnetsFromConfigFile(configFile string) (string, error)

func KeyExists

func KeyExists(keyName string) (bool, error)

func ParseGreeterAddress

func ParseGreeterAddress(output string) error

func ParsePublicDeployOutput

func ParsePublicDeployOutput(output string) (string, string, error)

func ParseRPCsFromOutput

func ParseRPCsFromOutput(output string) ([]string, error)

func PerNodeChainConfigExists

func PerNodeChainConfigExists(subnetName string) (bool, error)

func PrintStdErr

func PrintStdErr(err error)

func RemoveAPMRepo

func RemoveAPMRepo()

func RestartNodesWithWhitelistedSubnets

func RestartNodesWithWhitelistedSubnets(whitelistedSubnets string) error

func RunHardhatScript

func RunHardhatScript(script string) (string, string, error)

func RunHardhatTests

func RunHardhatTests(test string) error

func RunSpacesVMAPITest

func RunSpacesVMAPITest(rpc string) error

func SetHardhatRPC

func SetHardhatRPC(rpc string) error

func SubnetAPMVMExists

func SubnetAPMVMExists(subnetName string) (bool, error)

func SubnetConfigExists

func SubnetConfigExists(subnetName string) (bool, error)

func SubnetCustomVMExists

func SubnetCustomVMExists(subnetName string) (bool, error)

func WaitSubnetValidators

func WaitSubnetValidators(subnetIDStr string, nodeInfos map[string]NodeInfo) error

Types

type NodeInfo

type NodeInfo struct {
	ID         string
	PluginDir  string
	ConfigFile string
	URI        string
	LogDir     string
}

type VersionMapper

type VersionMapper interface {
	GetCompatURL(vmType models.VMType) string
	GetAvagoURL() string
	GetApp() *application.Avalanche
	GetLatestAvagoByProtoVersion(app *application.Avalanche, rpcVersion int, url string) (string, error)
	GetEligibleVersions(sortedVersions []string, repoName string, app *application.Avalanche) ([]string, error)
}

VersionMapper is an abstraction for retrieving version compatibility URLs allowing unit tests without requiring external http calls. The idea is to finally calculate which VM is compatible with which metalgo, so that the e2e tests can always download and run the latest compatible versions, without having to manually update the e2e tests periodically.

func NewVersionMapper

func NewVersionMapper() VersionMapper

NewVersionMapper returns the default VersionMapper for e2e tests