You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

151 lines
6.0 KiB

  1. package e2e
  2. import (
  3. "fmt"
  4. "os"
  5. "github.com/BurntSushi/toml"
  6. )
  7. // Manifest represents a TOML testnet manifest.
  8. type Manifest struct {
  9. // IPv6 uses IPv6 networking instead of IPv4. Defaults to IPv4.
  10. IPv6 bool `toml:"ipv6"`
  11. // InitialHeight specifies the initial block height, set in genesis. Defaults to 1.
  12. InitialHeight int64 `toml:"initial_height"`
  13. // InitialState is an initial set of key/value pairs for the application,
  14. // set in genesis. Defaults to nothing.
  15. InitialState map[string]string `toml:"initial_state"`
  16. // Validators is the initial validator set in genesis, given as node names
  17. // and power:
  18. //
  19. // validators = { validator01 = 10; validator02 = 20; validator03 = 30 }
  20. //
  21. // Defaults to all nodes that have mode=validator at power 100. Explicitly
  22. // specifying an empty set will start with no validators in genesis, and
  23. // the application must return the validator set in InitChain via the
  24. // setting validator_update.0 (see below).
  25. Validators *map[string]int64 `toml:"validators"`
  26. // ValidatorUpdates is a map of heights to validator names and their power,
  27. // and will be returned by the ABCI application. For example, the following
  28. // changes the power of validator01 and validator02 at height 1000:
  29. //
  30. // [validator_update.1000]
  31. // validator01 = 20
  32. // validator02 = 10
  33. //
  34. // Specifying height 0 returns the validator update during InitChain. The
  35. // application returns the validator updates as-is, i.e. removing a
  36. // validator must be done by returning it with power 0, and any validators
  37. // not specified are not changed.
  38. ValidatorUpdates map[string]map[string]int64 `toml:"validator_update"`
  39. // Nodes specifies the network nodes. At least one node must be given.
  40. Nodes map[string]*ManifestNode `toml:"node"`
  41. // KeyType sets the curve that will be used by validators.
  42. // Options are ed25519 & secp256k1
  43. KeyType string `toml:"key_type"`
  44. }
  45. // ManifestNode represents a node in a testnet manifest.
  46. type ManifestNode struct {
  47. // Mode specifies the type of node: "validator", "full", or "seed". Defaults to
  48. // "validator". Full nodes do not get a signing key (a dummy key is generated),
  49. // and seed nodes run in seed mode with the PEX reactor enabled.
  50. Mode string `toml:"mode"`
  51. // Seeds is the list of node names to use as P2P seed nodes. Defaults to none.
  52. Seeds []string `toml:"seeds"`
  53. // PersistentPeers is a list of node names to maintain persistent P2P
  54. // connections to. If neither seeds nor persistent peers are specified,
  55. // this defaults to all other nodes in the network.
  56. PersistentPeers []string `toml:"persistent_peers"`
  57. // Database specifies the database backend: "goleveldb", "cleveldb",
  58. // "rocksdb", "boltdb", or "badgerdb". Defaults to goleveldb.
  59. Database string `toml:"database"`
  60. // ABCIProtocol specifies the protocol used to communicate with the ABCI
  61. // application: "unix", "tcp", "grpc", or "builtin". Defaults to unix.
  62. // builtin will build a complete Tendermint node into the application and
  63. // launch it instead of launching a separate Tendermint process.
  64. ABCIProtocol string `toml:"abci_protocol"`
  65. // PrivvalProtocol specifies the protocol used to sign consensus messages:
  66. // "file", "unix", or "tcp". Defaults to "file". For unix and tcp, the ABCI
  67. // application will launch a remote signer client in a separate goroutine.
  68. // Only nodes with mode=validator will actually make use of this.
  69. PrivvalProtocol string `toml:"privval_protocol"`
  70. // StartAt specifies the block height at which the node will be started. The
  71. // runner will wait for the network to reach at least this block height.
  72. StartAt int64 `toml:"start_at"`
  73. // FastSync specifies the fast sync mode: "" (disable), "v0" or "v2".
  74. // Defaults to disabled.
  75. FastSync string `toml:"fast_sync"`
  76. // StateSync enables state sync. The runner automatically configures trusted
  77. // block hashes and RPC servers. At least one node in the network must have
  78. // SnapshotInterval set to non-zero, and the state syncing node must have
  79. // StartAt set to an appropriate height where a snapshot is available.
  80. StateSync bool `toml:"state_sync"`
  81. // PersistInterval specifies the height interval at which the application
  82. // will persist state to disk. Defaults to 1 (every height), setting this to
  83. // 0 disables state persistence.
  84. PersistInterval *uint64 `toml:"persist_interval"`
  85. // SnapshotInterval specifies the height interval at which the application
  86. // will take state sync snapshots. Defaults to 0 (disabled).
  87. SnapshotInterval uint64 `toml:"snapshot_interval"`
  88. // RetainBlocks specifies the number of recent blocks to retain. Defaults to
  89. // 0, which retains all blocks. Must be greater that PersistInterval and
  90. // SnapshotInterval.
  91. RetainBlocks uint64 `toml:"retain_blocks"`
  92. // Perturb lists perturbations to apply to the node after it has been
  93. // started and synced with the network:
  94. //
  95. // disconnect: temporarily disconnects the node from the network
  96. // kill: kills the node with SIGKILL then restarts it
  97. // pause: temporarily pauses (freezes) the node
  98. // restart: restarts the node, shutting it down with SIGTERM
  99. Perturb []string `toml:"perturb"`
  100. // Misbehaviors sets how a validator behaves during consensus at a
  101. // certain height. Multiple misbehaviors at different heights can be used
  102. //
  103. // An example of misbehaviors
  104. // { 10 = "double-prevote", 20 = "double-prevote"}
  105. //
  106. // For more information, look at the readme in the maverick folder.
  107. // A list of all behaviors can be found in ../maverick/consensus/behavior.go
  108. Misbehaviors map[string]string `toml:"misbehaviors"`
  109. }
  110. // Save saves the testnet manifest to a file.
  111. func (m Manifest) Save(file string) error {
  112. f, err := os.Create(file)
  113. if err != nil {
  114. return fmt.Errorf("failed to create manifest file %q: %w", file, err)
  115. }
  116. return toml.NewEncoder(f).Encode(m)
  117. }
  118. // LoadManifest loads a testnet manifest from a file.
  119. func LoadManifest(file string) (Manifest, error) {
  120. manifest := Manifest{}
  121. _, err := toml.DecodeFile(file, &manifest)
  122. if err != nil {
  123. return manifest, fmt.Errorf("failed to load testnet manifest %q: %w", file, err)
  124. }
  125. return manifest, nil
  126. }