e2e

type ErrInvalidZoneID struct {
	ZoneID string
	Err    error
}

type InfrastructureData struct {
	Path string `json:"path"`

	// Provider is the name of infrastructure provider backing the testnet.
	// For example, 'docker' if it is running locally in a docker network or
	// 'digital-ocean', 'aws', 'google', etc. if it is from a cloud provider.
	Provider string `json:"provider"`

	// Instances is a map of all of the machine instances on which to run
	// processes for a testnet.
	// The key of the map is the name of the instance, which each must correspond
	// to the names of one of the testnet nodes defined in the testnet manifest.
	Instances map[string]InstanceData `json:"instances"`

	// Network is the CIDR notation range of IP addresses that all of the instances'
	// IP addresses are expected to be within.
	Network string `json:"network"`
}

type InstanceData struct {
	IPAddress          net.IP `json:"ip_address"`
	ExtIPAddress       net.IP `json:"ext_ip_address"`
	RPCPort            uint32 `json:"rpc_port"`
	GRPCPort           uint32 `json:"grpc_port"`
	PrivilegedGRPCPort uint32 `json:"privileged_grpc_port"`
}

type Manifest struct {
	// IPv6 uses IPv6 networking instead of IPv4. Defaults to IPv4.
	IPv6 bool `toml:"ipv6"`

	// InitialHeight specifies the initial block height, set in genesis. Defaults to 1.
	InitialHeight int64 `toml:"initial_height"`

	// InitialState is an initial set of key/value pairs for the application,
	// set in genesis. Defaults to nothing.
	InitialState map[string]string `toml:"initial_state"`

	// Validators is the initial validator set in genesis, given as node names
	// and power:
	//
	// validators = { validator01 = 10; validator02 = 20; validator03 = 30 }
	//
	// Defaults to all nodes that have mode=validator at power 100. Explicitly
	// specifying an empty set will start with no validators in genesis, and
	// the application must return the validator set in InitChain via the
	// setting validator_update.0 (see below).
	Validators map[string]int64 `toml:"validators"`

	// ValidatorUpdatesMap is a map of heights to validator names and their power,
	// and will be returned by the ABCI application. For example, the following
	// changes the power of validator01 and validator02 at height 1000:
	//
	// [validator_update.1000]
	// validator01 = 20
	// validator02 = 10
	//
	// Specifying height 0 returns the validator update during InitChain. The
	// application returns the validator updates as-is, i.e. removing a
	// validator must be done by returning it with power 0, and any validators
	// not specified are not changed.
	ValidatorUpdatesMap map[string]map[string]int64 `toml:"validator_update"`

	// NodesMap specifies the network nodes. At least one node must be given.
	NodesMap map[string]*ManifestNode `toml:"node"`

	// Disable the peer-exchange reactor on all nodes.
	DisablePexReactor bool `toml:"disable_pex"`

	// KeyType sets the curve that will be used by validators.
	// Options are ed25519, secp256k1, secp256k1eth and bls12381.
	KeyType string `toml:"key_type"`

	// Evidence indicates the amount of evidence that will be injected into the
	// testnet via the RPC endpoint of a random node. Default is 0
	Evidence int `toml:"evidence"`

	// ABCIProtocol specifies the protocol used to communicate with the ABCI
	// application: "unix", "tcp", "grpc", "builtin" or "builtin_connsync".
	//
	// Defaults to "builtin". "builtin" will build a complete CometBFT node
	// into the application and launch it instead of launching a separate
	// CometBFT process.
	//
	// "builtin_connsync" is basically the same as "builtin", except that it
	// uses a "connection-synchronized" local client creator, which attempts to
	// replicate the same concurrency model locally as the socket client.
	ABCIProtocol string `toml:"abci_protocol"`

	// Add artificial delays to each of the main ABCI calls to mimic computation time
	// of the application
	PrepareProposalDelay time.Duration `toml:"prepare_proposal_delay"`
	ProcessProposalDelay time.Duration `toml:"process_proposal_delay"`
	CheckTxDelay         time.Duration `toml:"check_tx_delay"`
	VoteExtensionDelay   time.Duration `toml:"vote_extension_delay"`
	FinalizeBlockDelay   time.Duration `toml:"finalize_block_delay"`

	// UpgradeVersion specifies to which version nodes need to upgrade.
	// Currently only uncoordinated upgrade is supported
	UpgradeVersion string `toml:"upgrade_version"`

	LoadTxSizeBytes   int `toml:"load_tx_size_bytes"`
	LoadTxBatchSize   int `toml:"load_tx_batch_size"`
	LoadTxConnections int `toml:"load_tx_connections"`
	LoadMaxSeconds    int `toml:"load_max_seconds"`
	LoadMaxTxs        int `toml:"load_max_txs"`
	LoadNumNodesPerTx int `toml:"load_num_nodes_per_tx"`

	// Weight for each lane defined by the app. The transaction loader will
	// assign lanes to generated transactions proportionally to their weights.
	LoadLaneWeights map[string]uint `toml:"load_lane_weights"`

	// LogLevel specifies the log level to be set on all nodes.
	LogLevel string `toml:"log_level"`

	// LogFormat specifies the log format to be set on all nodes.
	LogFormat string `toml:"log_format"`

	// Enable or disable Prometheus metrics on all nodes.
	// Defaults to false (disabled).
	Prometheus bool `toml:"prometheus"`

	// BlockMaxBytes specifies the maximum size in bytes of a block. This
	// value will be written to the genesis file of all nodes.
	BlockMaxBytes int64 `toml:"block_max_bytes"`

	// Defines a minimum size for the vote extensions.
	VoteExtensionSize uint `toml:"vote_extension_size"`

	// VoteExtensionsEnableHeight configures the first height during which
	// the chain will use and require vote extension data to be present
	// in precommit messages.
	VoteExtensionsEnableHeight int64 `toml:"vote_extensions_enable_height"`

	// VoteExtensionsUpdateHeight configures the height at which consensus
	// param VoteExtensionsEnableHeight will be set.
	// -1 denotes it is set at genesis.
	// 0 denotes it is set at InitChain.
	VoteExtensionsUpdateHeight int64 `toml:"vote_extensions_update_height"`

	// Upper bound of sleep duration then gossipping votes and block parts
	PeerGossipIntraloopSleepDuration time.Duration `toml:"peer_gossip_intraloop_sleep_duration"`

	// Maximum number of peers to which the node gossips transactions
	ExperimentalMaxGossipConnectionsToPersistentPeers    uint `toml:"experimental_max_gossip_connections_to_persistent_peers"`
	ExperimentalMaxGossipConnectionsToNonPersistentPeers uint `toml:"experimental_max_gossip_connections_to_non_persistent_peers"`

	// Enable or disable e2e tests for CometBFT's expected behavior with respect
	// to ABCI.
	ABCITestsEnabled bool `toml:"abci_tests_enabled"`

	// Default geographical zone ID for simulating latencies, assigned to nodes that don't have a
	// specific zone assigned.
	DefaultZone string `toml:"default_zone"`

	// PbtsEnableHeight configures the first height during which
	// the chain will start using Proposer-Based Timestamps (PBTS)
	// to create and validate new blocks.
	PbtsEnableHeight int64 `toml:"pbts_enable_height"`

	// PbtsUpdateHeight configures the height at which consensus
	// param PbtsEnableHeight will be set.
	// -1 denotes it is set at genesis.
	// 0 denotes it is set at InitChain.
	PbtsUpdateHeight int64 `toml:"pbts_update_height"`

	// Used to disable lanes for testing behavior of
	// networks that upgrade to a version of CometBFT
	// that supports lanes but do not opt for using them.
	NoLanes bool `toml:"no_lanes"`

	// Mapping from lane IDs to lane priorities. These lanes will be used by the
	// application for setting up the mempool and for classifying transactions.
	Lanes map[string]uint32 `toml:"lanes"`

	// Genesis is a set of key-value config entries to write to the
	// produced genesis file. The format is "key = value".
	// Example: "consensus_params.evidence.max_bytes = 1024".
	Genesis []string `toml:"genesis"`

	// Config is a set of key-value config entries to write to CometBFT's
	// configuration files for all nodes. The format is "key = value".
	// Example: "p2p.send_rate = 512000".
	Config []string `toml:"config"`

	// If true, the application will return validator updates and
	// `ConsensusParams` updates at every height.
	// This is useful to create a more dynamic testnet.
	// * An existing validator will be chosen, and its power will alternate between 0 and 1.
	// * `ConsensusParams` will be flipping on and off key types not set at genesis.
	ConstantFlip bool `toml:"constant_flip"`

	// PerturbInterval is the time to wait between successive perturbations.
	PerturbInterval time.Duration `toml:"perturb_interval"`
}

type ManifestNode struct {
	// ModeStr specifies the type of node: "validator", "full", "light" or "seed".
	// Defaults to "validator". Full nodes do not get a signing key (a dummy key
	// is generated), and seed nodes run in seed mode with the PEX reactor enabled.
	ModeStr string `toml:"mode"`

	// Version specifies which version of CometBFT this node is. Specifying different
	// versions for different nodes allows for testing the interaction of different
	// node's compatibility. Note that in order to use a node at a particular version,
	// there must be a docker image of the test app tagged with this version present
	// on the machine where the test is being run.
	Version string `toml:"version"`

	// SeedsList is the list of node names to use as P2P seed nodes. Defaults to none.
	SeedsList []string `toml:"seeds"`

	// PersistentPeersList is a list of node names to maintain persistent P2P
	// connections to. If neither seeds nor persistent peers are specified,
	// this defaults to all other nodes in the network. For light clients,
	// this relates to the providers the light client is connected to.
	PersistentPeersList []string `toml:"persistent_peers"`

	// Database specifies the database backend: "goleveldb", "rocksdb",
	// "pebbledb" or "badgerdb". Defaults to "pebbledb".
	Database string `toml:"database"`

	// PrivvalProtocolStr specifies the protocol used to sign consensus messages:
	// "file", "unix", or "tcp". Defaults to "file". For unix and tcp, the ABCI
	// application will launch a remote signer client in a separate goroutine.
	// Only nodes with mode=validator will actually make use of this.
	PrivvalProtocolStr string `toml:"privval_protocol"`

	// StartAt specifies the block height at which the node will be started. The
	// runner will wait for the network to reach at least this block height.
	StartAt int64 `toml:"start_at"`

	// BlockSyncVersion specifies which version of Block Sync to use (currently
	// only "v0", the default value).
	BlockSyncVersion string `toml:"block_sync_version"`

	// StateSync enables state sync. The runner automatically configures trusted
	// block hashes and RPC servers. At least one node in the network must have
	// SnapshotInterval set to non-zero, and the state syncing node must have
	// StartAt set to an appropriate height where a snapshot is available.
	StateSync bool `toml:"state_sync"`

	// PersistIntervalPtr specifies the height interval at which the application
	// will persist state to disk. Defaults to 1 (every height), setting this to
	// 0 disables state persistence.
	PersistIntervalPtr *uint64 `toml:"persist_interval"`

	// SnapshotInterval specifies the height interval at which the application
	// will take state sync snapshots. Defaults to 0 (disabled).
	SnapshotInterval uint64 `toml:"snapshot_interval"`

	// RetainBlocks specifies the number of recent blocks to retain. Defaults to
	// 0, which retains all blocks. Must be greater that PersistInterval,
	// SnapshotInterval and EvidenceAgeHeight.
	RetainBlocks uint64 `toml:"retain_blocks"`

	// EnableCompanionPruning specifies whether or not storage pruning on the
	// node should take a data companion into account.
	EnableCompanionPruning bool `toml:"enable_companion_pruning"`

	// Perturb lists perturbations to apply to the node after it has been
	// started and synced with the network:
	//
	// disconnect: temporarily disconnects the node from the network
	// kill:       kills the node with SIGKILL then restarts it
	// pause:      temporarily pauses (freezes) the node
	// restart:    restarts the node, shutting it down with SIGTERM
	Perturb []string `toml:"perturb"`

	// SendNoLoad determines if the e2e test should send load to this node.
	// It defaults to false so unless the configured, the node will
	// receive load.
	SendNoLoad bool `toml:"send_no_load"`

	// Geographical zone ID for simulating latencies.
	Zone string `toml:"zone"`

	// ExperimentalKeyLayout sets the key representation in the DB
	ExperimentalKeyLayout string `toml:"experimental_db_key_layout"`

	// Compact triggers compaction on the DB after pruning
	Compact bool `toml:"compact"`

	// CompactionInterval sets the number of blocks at which we trigger compaction
	CompactionInterval int64 `toml:"compaction_interval"`

	// DiscardABCIResponses disables abci rsponses
	DiscardABCIResponses bool `toml:"discard_abci_responses"`

	// Indexer sets the indexer, default kv
	Indexer string `toml:"indexer"`

	// Simulated clock skew for this node
	ClockSkew time.Duration `toml:"clock_skew"`

	// Config is a set of key-value config entries to write to CometBFT's
	// configuration files for this node. The format is "key = value".
	// Example: "p2p.send_rate = 512000".
	Config []string `toml:"config"`
}

type Mode string

type Node struct {
	ManifestNode

	Name                    string
	Testnet                 *Testnet
	Mode                    Mode
	PrivvalKey              crypto.PrivKey
	NodeKey                 crypto.PrivKey
	InternalIP              net.IP
	ExternalIP              net.IP
	RPCProxyPort            uint32
	GRPCProxyPort           uint32
	GRPCPrivilegedProxyPort uint32
	ABCIProtocol            Protocol
	PrivvalProtocol         Protocol
	PersistInterval         uint64
	Seeds                   []*Node
	PersistentPeers         []*Node
	Perturbations           []Perturbation
	Prometheus              bool
	PrometheusProxyPort     uint32
	Zone                    string
}

type Perturbation string

type Protocol string

type Testnet struct {
	*Manifest

	Name string
	File string
	Dir  string

	IP               *net.IPNet
	ValidatorUpdates map[int64]map[string]int64
	Nodes            []*Node

	// If not empty, ignore the manifest and send transaction load only to the
	// node names in this list. It is set only from a command line flag.
	LoadTargetNodes []string

	// Latency Emulation is enabled when all the nodes have a zone assigned.
	LatencyEmulationEnabled bool
	// contains filtered or unexported fields
}