Merge pull request #560 from harmony-one/rj_branch

Setup genesis shard state, and fix other issues

core/blockchain.go

@@ -1732,8 +1732,8 @@ func (bc *BlockChain) ValidateNewShardState(block *types.Block, stakeInfo *map[c
 	return nil
 }
 
-// InsertNewShardState insert new shard state into epoch block
+// StoreNewShardState insert new shard state into epoch block
-func (bc *BlockChain) InsertNewShardState(block *types.Block, stakeInfo *map[common.Address]*structs.StakeInfo) {
+func (bc *BlockChain) StoreNewShardState(block *types.Block, stakeInfo *map[common.Address]*structs.StakeInfo) {
 	// write state into db.
 	shardState := bc.GetNewShardState(block, stakeInfo)
 	if shardState == nil {
@@ -1742,8 +1742,8 @@ func (bc *BlockChain) InsertNewShardState(block *types.Block, stakeInfo *map[com
 	hash := block.Hash()
 	number := block.NumberU64()
 	rawdb.WriteShardState(bc.db, hash, number, shardState)
-	utils.GetLogInstance().Debug("[resharding] save new shard state success", "shardStateHash", shardState.Hash())
+	utils.GetLogInstance().Debug("[Resharding] Saved new shard state success", "shardStateHash", shardState.Hash())
 	for _, c := range shardState {
-		utils.GetLogInstance().Debug("[resharding] new shard information", "shardID", c.ShardID, "NodeList", c.NodeList)
+		utils.GetLogInstance().Debug("[Resharding] Shard Info", "shardID", c.ShardID, "NodeList", c.NodeList)
 	}
 }

core/gen_genesis.go

@@ -28,6 +28,7 @@ func (g Genesis) MarshalJSON() ([]byte, error) {
 		Mixhash        common.Hash                                 `json:"mixHash"`
 		Coinbase       common.Address                              `json:"coinbase"`
 		Alloc          map[common.UnprefixedAddress]GenesisAccount `json:"alloc"      gencodec:"required"`
+		ShardStateHash common.Hash                                 `json:"shardStateHash"`
 		Number         math.HexOrDecimal64                         `json:"number"`
 		GasUsed        math.HexOrDecimal64                         `json:"gasUsed"`
 		ParentHash     common.Hash                                 `json:"parentHash"`
@@ -48,6 +49,7 @@ func (g Genesis) MarshalJSON() ([]byte, error) {
 			enc.Alloc[common.UnprefixedAddress(k)] = v
 		}
 	}
+	enc.ShardStateHash = g.ShardStateHash
 	enc.Number = math.HexOrDecimal64(g.Number)
 	enc.GasUsed = math.HexOrDecimal64(g.GasUsed)
 	enc.ParentHash = g.ParentHash
@@ -67,6 +69,7 @@ func (g *Genesis) UnmarshalJSON(input []byte) error {
 		Mixhash        *common.Hash                                `json:"mixHash"`
 		Coinbase       *common.Address                             `json:"coinbase"`
 		Alloc          map[common.UnprefixedAddress]GenesisAccount `json:"alloc"      gencodec:"required"`
+		ShardStateHash *common.Hash                                `json:"shardStateHash"`
 		Number         *math.HexOrDecimal64                        `json:"number"`
 		GasUsed        *math.HexOrDecimal64                        `json:"gasUsed"`
 		ParentHash     *common.Hash                                `json:"parentHash"`
@@ -111,6 +114,9 @@ func (g *Genesis) UnmarshalJSON(input []byte) error {
 	for k, v := range dec.Alloc {
 		g.Alloc[common.Address(k)] = v
 	}
+	if dec.ShardStateHash != nil {
+		g.ShardStateHash = *dec.ShardStateHash
+	}
 	if dec.Number != nil {
 		g.Number = uint64(*dec.Number)
 	}

core/genesis.go

@@ -55,6 +55,7 @@ type Genesis struct {
 	Mixhash        common.Hash         `json:"mixHash"`
 	Coinbase       common.Address      `json:"coinbase"`
 	Alloc          GenesisAlloc        `json:"alloc"      gencodec:"required"`
+	ShardStateHash common.Hash         `json:"shardStateHash"`
 
 	// These fields are used for consensus tests. Please don't use them
 	// in actual genesis blocks.
@@ -249,6 +250,7 @@ func (g *Genesis) ToBlock(db ethdb.Database) *types.Block {
 		MixDigest:      g.Mixhash,
 		Coinbase:       g.Coinbase,
 		Root:           root,
+		ShardStateHash: g.ShardStateHash,
 	}
 	if g.GasLimit == 0 {
 		head.GasLimit = 10000000000 // TODO(RJ): figure out better solution. // params.GenesisGasLimit

core/resharding.go

@@ -19,9 +19,12 @@ import (
 const (
 	// InitialSeed is the initial random seed, a magic number to answer everything, remove later
 	InitialSeed uint32 = 42
-	// FirstEpoch is the number of the first epoch.
+	// GenesisEpoch is the number of the first genesis epoch.
-	// TODO(minhdoan): we should design the first epoch as 0. Please figure out how to change other logic to make it 0
+	GenesisEpoch = 0
-	FirstEpoch = 1
+	// GenesisShardNum is the number of shard at genesis
+	GenesisShardNum = 3
+	// GenesisShardSize is the size of each shard at genesis
+	GenesisShardSize = 10
 )
 
 // ShardingState is data structure hold the sharding state
@@ -83,10 +86,13 @@ func (ss *ShardingState) cuckooResharding(percent float64) {
 // assignLeaders will first add new nodes into shards, then use cuckoo rule to reshard to get new shard state
 func (ss *ShardingState) assignLeaders() {
 	for i := 0; i < ss.numShards; i++ {
+		// At genesis epoch, the shards are empty.
+		if len(ss.shardState[i].NodeList) > 0 {
 			Shuffle(ss.shardState[i].NodeList)
 			ss.shardState[i].Leader = ss.shardState[i].NodeList[0]
 		}
 	}
+}
 
 // Reshard will first add new nodes into shards, then use cuckoo rule to reshard to get new shard state
 func (ss *ShardingState) Reshard(newNodeList []types.NodeID, percent float64) {
@@ -134,12 +140,13 @@ func GetShardingStateFromBlockChain(bc *BlockChain, epoch uint64) *ShardingState
 // CalculateNewShardState get sharding state from previous epoch and calculate sharding state for new epoch
 // TODO: currently, we just mock everything
 func CalculateNewShardState(bc *BlockChain, epoch uint64, stakeInfo *map[common.Address]*structs.StakeInfo) types.ShardState {
-	if epoch == FirstEpoch {
+	if epoch == GenesisEpoch {
-		return getInitShardState(3, 10)
+		return GetInitShardState()
 	}
 	ss := GetShardingStateFromBlockChain(bc, epoch-1)
 	newNodeList := ss.UpdateShardingState(stakeInfo)
 	percent := ss.calculateKickoutRate(newNodeList)
+	utils.GetLogInstance().Info("Kickout Percentage", "percentage", percent)
 	ss.Reshard(newNodeList, percent)
 	return ss.shardState
 }
@@ -190,15 +197,16 @@ func (ss *ShardingState) calculateKickoutRate(newNodeList []types.NodeID) float6
 	return math.Max(0.1, math.Min(rate, 1.0))
 }
 
-// getInitShardState returns the initial shard state at genesis.
+// GetInitShardState returns the initial shard state at genesis.
-func getInitShardState(numberOfShards, numNodesPerShard int) types.ShardState {
+// TODO: make the deploy.sh config file in sync with genesis constants.
+func GetInitShardState() types.ShardState {
 	shardState := types.ShardState{}
-	for i := 0; i < numberOfShards; i++ {
+	for i := 0; i < GenesisShardNum; i++ {
 		com := types.Committee{ShardID: uint32(i)}
 		if i == 0 {
-			for j := 0; j < numNodesPerShard; j++ {
+			for j := 0; j < GenesisShardSize; j++ {
 				priKey := bls.SecretKey{}
-				priKey.SetHexString(contract.InitialBeaconChainAccounts[i].Private)
+				priKey.SetHexString(contract.InitialBeaconChainAccounts[j].Private)
 				addrBytes := priKey.GetPublicKey().GetAddress()
 				address := hex.EncodeToString(addrBytes[:])
 				com.NodeList = append(com.NodeList, types.NodeID(address))

node/node.go

@@ -240,6 +240,9 @@ func New(host p2p.Host, consensusObj *consensus.Consensus, db ethdb.Database) *N
 			os.Exit(1)
 		}
 		node.blockchain = chain
+		// Store the genesis shard state into db.
+		node.blockchain.StoreNewShardState(node.blockchain.CurrentBlock(), nil)
+
 		node.BlockChannel = make(chan *types.Block)
 		node.ConfirmedBlockChannel = make(chan *types.Block)
 		node.BeaconBlockChannel = make(chan *types.Block)

node/node_genesis.go

@@ -46,6 +46,7 @@ func (node *Node) GenesisBlockSetup(db ethdb.Database) (*core.BlockChain, error)
 		Config:         chainConfig,
 		Alloc:          genesisAlloc,
 		ShardID:        uint32(node.Consensus.ShardID),
+		ShardStateHash: core.GetInitShardState().Hash(),
 	}
 
 	// Store genesis block into db.

node/node_handler.go

@@ -153,7 +153,7 @@ func (node *Node) messageHandler(content []byte, sender string) {
 			utils.GetLogInstance().Info("NET: received message: Node/Control")
 			controlType := msgPayload[0]
 			if proto_node.ControlMessageType(controlType) == proto_node.STOP {
-				utils.GetLogInstance().Debug("Stopping Node", "node", node, "numBlocks", node.blockchain.CurrentBlock().NumberU64(), "numTxsProcessed", node.countNumTransactionsInBlockchain())
+				utils.GetLogInstance().Debug("Stopping Node", "numBlocks", node.blockchain.CurrentBlock().NumberU64(), "numTxsProcessed", node.countNumTransactionsInBlockchain())
 
 				var avgBlockSizeInBytes common.StorageSize
 				txCount := 0
@@ -297,7 +297,7 @@ func (node *Node) PostConsensusProcessing(newBlock *types.Block) {
 func (node *Node) AddNewBlock(newBlock *types.Block) {
 	blockNum, err := node.blockchain.InsertChain([]*types.Block{newBlock})
 
-	node.blockchain.InsertNewShardState(newBlock, &node.CurrentStakes)
+	node.blockchain.StoreNewShardState(newBlock, &node.CurrentStakes)
 	if err != nil {
 		utils.GetLogInstance().Debug("Error adding new block to blockchain", "blockNum", blockNum, "Error", err)
 	} else {

node/node_newblock.go

@@ -60,7 +60,7 @@ func (node *Node) WaitForConsensusReady(readySignal chan struct{}, stopChan chan
 						} else {
 							// add new shard state if it's epoch block
 							// TODO(minhdoan): only happens for beaconchain
-							node.addNewShardState(block)
+							node.addNewShardStateHash(block)
 							newBlock = block
 							break
 						}
@@ -78,7 +78,7 @@ func (node *Node) WaitForConsensusReady(readySignal chan struct{}, stopChan chan
 	}()
 }
 
-func (node *Node) addNewShardState(block *types.Block) {
+func (node *Node) addNewShardStateHash(block *types.Block) {
 	shardState := node.blockchain.GetNewShardState(block, &node.CurrentStakes)
 	if shardState != nil {
 		shardHash := shardState.Hash()

test/configs/beaconchain.txt

@@ -8,3 +8,4 @@
 127.0.0.1 9007 validator 0
 127.0.0.1 9008 validator 0
 127.0.0.1 9009 validator 0
+127.0.0.1 19999 client 0