p2p/node_info.go

   1 package p2p
   2
   3 import (
   4         "fmt"
   5         "net"
   6         "strconv"
   7         "strings"
   8
   9         crypto "github.com/tendermint/go-crypto"
  10 )
  11
  12 const maxNodeInfoSize = 10240 // 10Kb
  13
  14 //NodeInfo peer node info
  15 type NodeInfo struct {
  16         PubKey     crypto.PubKeyEd25519 `json:"pub_key"`
  17         Moniker    string               `json:"moniker"`
  18         Network    string               `json:"network"`
  19         ListenAddr string               `json:"listen_addr"`
  20         Version    string               `json:"version"` // major.minor.revision
  21         Other      []string             `json:"other"`   // other application specific data
  22 }
  23
  24 // CompatibleWith checks if two NodeInfo are compatible with eachother.
  25 // CONTRACT: two nodes are compatible if the major version matches and network match
  26 // and they have at least one channel in common.
  27 func (info *NodeInfo) CompatibleWith(other *NodeInfo) error {
  28         iMajor, iMinor, _, iErr := splitVersion(info.Version)
  29         oMajor, oMinor, _, oErr := splitVersion(other.Version)
  30
  31         // if our own version number is not formatted right, we messed up
  32         if iErr != nil {
  33                 return iErr
  34         }
  35
  36         // version number must be formatted correctly ("x.x.x")
  37         if oErr != nil {
  38                 return oErr
  39         }
  40
  41         // major version must match
  42         if iMajor != oMajor {
  43                 return fmt.Errorf("Peer is on a different major version. Got %v, expected %v", oMajor, iMajor)
  44         }
  45
  46         // minor version must match
  47         if iMinor != oMinor {
  48                 return fmt.Errorf("Peer is on a different minor version. Got %v, expected %v", oMinor, iMinor)
  49         }
  50
  51         // nodes must be on the same network
  52         if info.Network != other.Network {
  53                 return fmt.Errorf("Peer is on a different network. Got %v, expected %v", other.Network, info.Network)
  54         }
  55
  56         return nil
  57 }
  58
  59 //ListenHost peer listener ip address
  60 func (info *NodeInfo) ListenHost() string {
  61         host, _, _ := net.SplitHostPort(info.ListenAddr)
  62         return host
  63 }
  64
  65 //ListenPort peer listener port
  66 func (info *NodeInfo) ListenPort() int {
  67         _, port, _ := net.SplitHostPort(info.ListenAddr)
  68         portInt, err := strconv.Atoi(port)
  69         if err != nil {
  70                 return -1
  71         }
  72         return portInt
  73 }
  74
  75 //String representation
  76 func (info NodeInfo) String() string {
  77         return fmt.Sprintf("NodeInfo{pk: %v, moniker: %v, network: %v [listen %v], version: %v (%v)}", info.PubKey, info.Moniker, info.Network, info.ListenAddr, info.Version, info.Other)
  78 }
  79
  80 func splitVersion(version string) (string, string, string, error) {
  81         spl := strings.Split(version, ".")
  82         if len(spl) != 3 {
  83                 return "", "", "", fmt.Errorf("Invalid version format %v", version)
  84         }
  85         return spl[0], spl[1], spl[2], nil
  86 }