unclear what the 'time' field represents in "cleos net status" #8239

Activity

1. johndebord commented on Nov 26, 2019

   

   johndebord

   on Nov 26, 2019

   Last edited by johndebord

   Contributor

   More actions

   We can find the underlying data structure of last_handshake in file eos/plugins/net_plugin/include/eosio/net_plugin/protocol.hpp#L24-L40:

   struct handshake_message {
      uint16_t                   network_version = 0; ///< incremental value above a computed base
      chain_id_type              chain_id; ///< used to identify chain
      fc::sha256                 node_id; ///< used to identify peers and prevent self-connect     
      chain::public_key_type     key; ///< authentication key; may be a producer or peer key, or empty
      tstamp                     time;
      fc::sha256                 token; ///< digest of time to prove we own the private key of the key above
      chain::signature_type      sig; ///< signature for the digest
      string                     p2p_address;
      uint32_t                   last_irreversible_block_num = 0;
      block_id_type              last_irreversible_block_id;
      uint32_t                   head_num = 0;
      block_id_type              head_id;
      string                     os;
      string                     agent;
      int16_t                    generation;
   };

   In the same file, we can also see that the field time is of type tstamp which is a typedef to:

   typedef std::chrono::system_clock::duration::rep tstamp;

   But what is it a timestamp of?
   Well, let's follow the logic in the code originating from file eos/programs/cleos/main.cpp#L3114-L3119:

   auto status = net->add_subcommand("status", localized("Status of existing connection"), false);
      status->add_option("host", new_host, localized("The hostname:port to query status of connection"))->required();
      status->set_callback([&] {
      const auto& v = call(url, net_status, new_host);
      std::cout << fc::json::to_pretty_string(v) << std::endl;
   });

   We end up calling the function connection::get_status() in file eos/plugins/net_plugin/net_plugin.cpp#L508-L515:

   connection_status connection::get_status()const {
      connection_status stat;
      stat.peer = peer_addr;
      stat.connecting = connecting;
      stat.syncing = syncing;
      std::lock_guard<std::mutex> g( conn_mtx );
      stat.last_handshake = last_handshake_recv;
      return stat;
   }

   Lastly, the type connection_status holds a field that is of type handshake_message; which can be found in file eos/plugins/net_plugin/include/eosio/net_plugin/net_plugin.hpp#L13-L18:

   struct connection_status {
      string            peer;
      bool              connecting = false;
      bool              syncing    = false;
      handshake_message last_handshake;
   };

   We can now see that the field time corresponds to the last timestamp of the last handshake received; last_handshake_recv.

   👍React with 👍1Reacted by Matthew Darwin

   ❤️React with ❤️1Reacted by Matthew Darwin
2. jgiszczak

   added

   documentationRequires attention from documentation team. e.g. documentation is expected to be generated.Requires attention from documentation team. e.g. documentation is expected to be generated.

   on Nov 26, 2019
3. lparisc

   self-assigned this

   on Jan 31, 2020
4. iamveritas

   assigned

   iamveritas

   and unassigned

   lparisc

   on Feb 24, 2020
5. lparisc commented on Feb 26, 2020

   

   lparisc

   on Feb 26, 2020

   Contributor

   More actions

   @matthewdarwin See also a description of the handshake message in the EOSIO network protocol document.

   👍React with 👍1Reacted by iamveritas
6. iamveritas commented on Feb 27, 2020

   

   iamveritas

   on Feb 27, 2020

   Contributor

   More actions

   thank you all, for reporting this and for contributing to the solution @lparisc and @johndebord .
   in the light of the new documentation that explains the time field of the handshake message can we close this issue @matthewdarwin ?
7. matthewdarwin commented on Feb 27, 2020

   

   matthewdarwin

   on Feb 27, 2020

   Author

   More actions

   Can the page at https://developers.eos.io/manuals/eos/latest/cleos/command-reference/net/status point to the web page with the handshake details?
8. iamveritas commented on Feb 28, 2020

   

   iamveritas

   on Feb 28, 2020

   Last edited by iamveritas

   Contributor

   More actions

   Can the page at https://developers.eos.io/manuals/eos/latest/cleos/command-reference/net/status point to the web page with the handshake details?

   #8718

   we have in plan to improve the whole cleos reference documentation for now this is the best I can do.
9. lparisc commented on Feb 28, 2020

   

   lparisc

   on Feb 28, 2020

   Contributor

   More actions

   docs/02_cleos/03_command-reference/net/status.md
   network_peer_protocol#421-handshake-message
10. lparisc

    closed this as completedon Feb 28, 2020