woop/cmd/harmony.go

package main

import (
	"flag"
	"fmt"
	"math/rand"
	"os"
	"path"
	"runtime"
	"time"

	"github.com/harmony-one/harmony/drand"

	"github.com/ethereum/go-ethereum/ethdb"
	"github.com/ethereum/go-ethereum/log"
	peerstore "github.com/libp2p/go-libp2p-peerstore"
	multiaddr "github.com/multiformats/go-multiaddr"

	"github.com/harmony-one/harmony/consensus"
	"github.com/harmony-one/harmony/internal/attack"
	pkg_newnode "github.com/harmony-one/harmony/internal/newnode"
	"github.com/harmony-one/harmony/internal/profiler"
	"github.com/harmony-one/harmony/internal/utils"
	"github.com/harmony-one/harmony/node"
	"github.com/harmony-one/harmony/p2p"
	"github.com/harmony-one/harmony/p2p/p2pimpl"
)

var (
	version string
	builtBy string
	builtAt string
	commit  string
)

// Constants used by the harmony.
const (
	AttackProbability = 20
)

func attackDetermination(attackedMode int) bool {
	switch attackedMode {
	case 0:
		return false
	case 1:
		return true
	case 2:
		return rand.Intn(100) < AttackProbability
	}
	return false
}

// InitLDBDatabase initializes a LDBDatabase. isBeacon=true will return the beacon chain database for normal shard nodes
func InitLDBDatabase(ip string, port string, freshDB bool, isBeacon bool) (*ethdb.LDBDatabase, error) {
	var dbFileName string
	if isBeacon {
		dbFileName = fmt.Sprintf("./db/harmony_beacon_%s_%s", ip, port)
	} else {
		dbFileName = fmt.Sprintf("./db/harmony_%s_%s", ip, port)
	}
	if freshDB {
		var err = os.RemoveAll(dbFileName)
		if err != nil {
			fmt.Println(err.Error())
		}
	}
	return ethdb.NewLDBDatabase(dbFileName, 0, 0)
}

func printVersion(me string) {
	fmt.Fprintf(os.Stderr, "Harmony (C) 2018. %v, version %v-%v (%v %v)\n", path.Base(me), version, commit, builtBy, builtAt)
	os.Exit(0)
}

func loggingInit(logFolder, role, ip, port string, onlyLogTps bool) {
	// Setup a logger to stdout and log file.
	logFileName := fmt.Sprintf("./%v/%s-%v-%v.log", logFolder, role, ip, port)
	h := log.MultiHandler(
		log.StreamHandler(os.Stdout, log.TerminalFormat(false)),
		log.Must.FileHandler(logFileName, log.JSONFormat()), // Log to file
	)
	if onlyLogTps {
		h = log.MatchFilterHandler("msg", "TPS Report", h)
	}
	log.Root().SetHandler(h)
}

func main() {
	// TODO: use http://getmyipaddress.org/ or http://www.get-myip.com/ to retrieve my IP address
	ip := flag.String("ip", "127.0.0.1", "IP of the node")
	port := flag.String("port", "9000", "port of the node.")
	logFolder := flag.String("log_folder", "latest", "the folder collecting the logs of this execution")
	attackedMode := flag.Int("attacked_mode", 0, "0 means not attacked, 1 means attacked, 2 means being open to be selected as attacked")
	dbSupported := flag.Bool("db_supported", true, "false means not db_supported, true means db_supported")
	freshDB := flag.Bool("fresh_db", false, "true means the existing disk based db will be removed")
	profile := flag.Bool("profile", false, "Turn on profiling (CPU, Memory).")
	metricsReportURL := flag.String("metrics_report_url", "", "If set, reports metrics to this URL.")
	versionFlag := flag.Bool("version", false, "Output version info")
	onlyLogTps := flag.Bool("only_log_tps", false, "Only log TPS if true")

	//This IP belongs to jenkins.harmony.one
	bcIP := flag.String("bc", "127.0.0.1", "IP of the identity chain")
	bcPort := flag.String("bc_port", "8081", "port of the identity chain")
	bcAddr := flag.String("bc_addr", "", "MultiAddr of the identity chain")

	//Leader needs to have a minimal number of peers to start consensus
	minPeers := flag.Int("min_peers", 100, "Minimal number of Peers in shard")

	// Key file to store the private key
	keyFile := flag.String("key", "./.hmykey", "the private key file of the harmony node")
	flag.Var(&utils.BootNodes, "bootnodes", "a list of bootnode multiaddress")

	// LibP2P peer discovery integration test
	libp2pPD := flag.Bool("libp2p_pd", false, "enable libp2p based peer discovery")

	// isBeacon indicates this node is a beacon chain node
	isBeacon := flag.Bool("is_beacon", false, "true means this node is a beacon chain node")

	// isLeader indicates this node is a beacon chain leader node during the bootstrap process
	isLeader := flag.Bool("is_leader", false, "true means this node is a beacon chain leader node")

	// logConn logs incoming/outgoing connections
	logConn := flag.Bool("log_conn", false, "log incoming/outgoing connections")

	flag.Parse()

	if *versionFlag {
		printVersion(os.Args[0])
	}

	// Logging setup
	utils.SetPortAndIP(*port, *ip)

	// Add GOMAXPROCS to achieve max performance.
	runtime.GOMAXPROCS(1024)

	// Set up randomization seed.
	rand.Seed(int64(time.Now().Nanosecond()))

	if len(utils.BootNodes) == 0 {
		bootNodeAddrs, err := utils.StringsToAddrs(utils.DefaultBootNodeAddrStrings)
		if err != nil {
			panic(err)
		}
		utils.BootNodes = bootNodeAddrs
	}

	var shardID = "0"
	var peers []p2p.Peer
	var leader p2p.Peer
	var selfPeer p2p.Peer
	var clientPeer *p2p.Peer
	var BCPeer *p2p.Peer
	var role string

	nodePriKey, _, err := utils.LoadKeyFromFile(*keyFile)
	if err != nil {
		panic(err)
	}

	peerPriKey, peerPubKey := utils.GenKey(*ip, *port)
	if peerPriKey == nil || peerPubKey == nil {
		panic(fmt.Errorf("generate key error"))
	}
	selfPeer = p2p.Peer{IP: *ip, Port: *port, ValidatorID: -1, PubKey: peerPubKey}

	if !*libp2pPD {
		if *bcAddr != "" {
			// Turn the destination into a multiaddr.
			maddr, err := multiaddr.NewMultiaddr(*bcAddr)
			if err != nil {
				panic(err)
			}

			// Extract the peer ID from the multiaddr.
			info, err := peerstore.InfoFromP2pAddr(maddr)
			if err != nil {
				panic(err)
			}

			BCPeer = &p2p.Peer{IP: *bcIP, Port: *bcPort, Addrs: info.Addrs, PeerID: info.ID}
		} else {
			BCPeer = &p2p.Peer{IP: *bcIP, Port: *bcPort}
		}

		//Use Peer Discovery to get shard/leader/peer/...
		candidateNode := pkg_newnode.New(*ip, *port, nodePriKey)
		candidateNode.AddPeer(BCPeer)
		candidateNode.ContactBeaconChain(*BCPeer)

		shardID = candidateNode.GetShardID()
		leader = candidateNode.GetLeader()
		selfPeer = candidateNode.GetSelfPeer()
		clientPeer = candidateNode.GetClientPeer()
		selfPeer.PubKey = candidateNode.PubK

		if leader.IP == *ip && leader.Port == *port {
			role = "leader"
		} else {
			role = "validator"
		}

		if role == "validator" {
			// Attack determination.
			attack.GetInstance().SetAttackEnabled(attackDetermination(*attackedMode))
		}
		utils.UseLibP2P = false
	} else {
		if *isLeader {
			role = "leader"
			leader = selfPeer
		} else {
			role = "validator"
		}
		utils.UseLibP2P = true
	}
	// Init logging.
	loggingInit(*logFolder, role, *ip, *port, *onlyLogTps)

	// Initialize leveldb if dbSupported.
	var ldb *ethdb.LDBDatabase
	if *dbSupported {
		ldb, _ = InitLDBDatabase(*ip, *port, *freshDB, false)
	}

	host, err := p2pimpl.NewHost(&selfPeer, nodePriKey)
	if *logConn {
		host.GetP2PHost().Network().Notify(utils.ConnLogger)
	}
	if err != nil {
		panic("unable to new host in harmony")
	}

	log.Info("HARMONY", "multiaddress", fmt.Sprintf("/ip4/%s/tcp/%s/p2p/%s", *ip, *port, host.GetID().Pretty()))

	host.AddPeer(&leader)

	// Consensus object.
	// TODO: consensus object shouldn't start here
	consensus := consensus.New(host, shardID, peers, leader)
	consensus.MinPeers = *minPeers

	// Start Profiler for leader if profile argument is on
	if role == "leader" && (*profile || *metricsReportURL != "") {
		prof := profiler.GetProfiler()
		prof.Config(shardID, *metricsReportURL)
		if *profile {
			prof.Start()
		}
	}

	// Current node.
	currentNode := node.New(host, consensus, ldb)
	currentNode.Consensus.OfflinePeers = currentNode.OfflinePeers
	currentNode.Role = node.NewNode

	if *isBeacon {
		if role == "leader" {
			currentNode.Role = node.BeaconLeader
		} else {
			currentNode.Role = node.BeaconValidator
		}
		currentNode.MyShardGroupID = p2p.GroupIDBeacon
	} else {
		var beacondb ethdb.Database
		if *dbSupported {
			beacondb, _ = InitLDBDatabase(*ip, *port, *freshDB, true)
		}
		currentNode.AddBeaconChainDatabase(beacondb)

		if role == "leader" {
			currentNode.Role = node.ShardLeader
		} else {
			currentNode.Role = node.ShardValidator
		}
		currentNode.MyShardGroupID = p2p.GroupIDUnknown
	}

	// Add randomness protocol
	// TODO: enable drand only for beacon chain
	// TODO: put this in a better place other than main.
	dRand := drand.New(host, shardID, peers, leader, currentNode.ConfirmedBlockChannel)
	currentNode.Consensus.RegisterPRndChannel(dRand.PRndChannel)
	currentNode.Consensus.RegisterRndChannel(dRand.RndChannel)
	currentNode.DRand = dRand

	// If there is a client configured in the node list.
	if clientPeer != nil {
		currentNode.ClientPeer = clientPeer
	}

	// Assign closure functions to the consensus object
	consensus.BlockVerifier = currentNode.VerifyNewBlock
	consensus.OnConsensusDone = currentNode.PostConsensusProcessing
	currentNode.State = node.NodeWaitToJoin

	if !*libp2pPD {
		if consensus.IsLeader {
			currentNode.State = node.NodeLeader
		} else {
			go currentNode.JoinShard(leader)
		}
	} else {
		if consensus.IsLeader {
			go currentNode.SendPongMessage()
		}
	}

	go currentNode.SupportSyncing()
	currentNode.ServiceManagerSetup()
	currentNode.RunServices()
	currentNode.StartServer()
}