Clarify why 'eth1Network' is an Option type

2021-09-08 15:47:48 +03:00 · 2021-09-08 15:47:48 +03:00 · 2121cf1f0d
parent b6334e0970
commit 2121cf1f0d
1 changed files with 4 additions and 0 deletions
--- a/beacon_chain/networking/network_metadata.nim
+++ b/beacon_chain/networking/network_metadata.nim
@ -45,6 +45,10 @@ type
      #      branch is not active and thus it will override the first variable
      #      in this branch.
      dummy: string
+      # If the eth1Network is specified, the Eth1Monitor will perform some
+      # additional checks to ensure we are connecting to a web3 provider
+      # serving data for the same network. The value can be set to `None`
+      # for custom networks and testing purposes.
      eth1Network*: Option[Eth1Network]
      cfg*: RuntimeConfig