Regenesis (0xPolygon#1224)

* initial poc

* fix

* add gitignore binary

* migration test fixes

* fix migration test

* returen sc commit

* 💅

* property based test

* fix lint

* sync cases

* remove debug

* minor changes

* fix

* Update command/regenesis/cmd.go

Co-authored-by: Victor Castell <victor@polygon.technology>

* Update command/regenesis/cmd.go

Co-authored-by: Victor Castell <victor@polygon.technology>

* cleanup

* fix lint

* clean

* fix

* fix lint

* remove local env

* fix

* Update state/immutable-trie/copy_trie.go

Co-authored-by: Goran Rojovic <100121253+goran-ethernal@users.noreply.github.com>

* Update command/genesis/genesis.go

Co-authored-by: Stefan Negovanović <93934272+Stefan-Ethernal@users.noreply.github.com>

* fix review comments

* Update server/server.go

Co-authored-by: Stefan Negovanović <93934272+Stefan-Ethernal@users.noreply.github.com>

* fix

* fix

* review fix

* fix

* fix

* fix

---------

Co-authored-by: Victor Castell <victor@victorcastell.com>
Co-authored-by: Victor Castell <victor@polygon.technology>
Co-authored-by: Goran Rojovic <100121253+goran-ethernal@users.noreply.github.com>
Co-authored-by: Stefan Negovanović <93934272+Stefan-Ethernal@users.noreply.github.com>

.gitignore

@@ -4,6 +4,7 @@ manifest.json
 secretsManagerConfig.json
 *-packr.go
 config*.json
+polygon-edge
 
 bin/
 

command/genesis/genesis.go

@@ -198,6 +198,14 @@ func setFlags(cmd *cobra.Command) {
 			"event tracker starting block configuration, which is specified per contract address "+
 				"(format: <contract address>:<start block>)",
 		)
+
+		//Regenesis flag that allows to start from non-empty database
+		cmd.Flags().StringVar(
+			&params.initialStateRoot,
+			trieRootFlag,
+			"",
+			"trie root from the corresponding triedb",
+		)
 	}
 
 	// Allow list

command/genesis/params.go

@@ -85,6 +85,8 @@ type genesisParams struct {
 	epochReward             uint64
 	eventTrackerStartBlocks []string
 
+	initialStateRoot string
+
 	// allowlist
 	contractDeployerAllowListAdmin   []string
 	contractDeployerAllowListEnabled []string

command/genesis/polybft_params.go

@@ -28,6 +28,7 @@ const (
 	blockTimeFlag          = "block-time"
 	bridgeFlag             = "bridge-json-rpc"
 	trackerStartBlocksFlag = "tracker-start-blocks"
+	trieRootFlag           = "trieroot"
 
 	defaultManifestPath     = "./manifest.json"
 	defaultEpochSize        = uint64(10)
@@ -94,6 +95,7 @@ func (p *genesisParams) generatePolyBftChainConfig(o command.OutputFormatter) er
 		Bridge:            bridge,
 		ValidatorSetAddr:  contracts.ValidatorSetContract,
 		StateReceiverAddr: contracts.StateReceiverContract,
+		InitialTrieRoot:   types.StringToHash(p.initialStateRoot),
 	}
 
 	chainConfig := &chain.Chain{

command/regenesis/cmd.go

@@ -0,0 +1,23 @@
+package regenesis
+
+import (
+	"github.com/spf13/cobra"
+)
+
+var (
+	params = &regenesisParams{}
+)
+
+type regenesisParams struct {
+	TrieDBPath         string
+	SnapshotTrieDBPath string
+	TrieRoot           string
+}
+
+func GetCommand() *cobra.Command {
+	genesisCMD := RegenesisCMD()
+	genesisCMD.AddCommand(GetRootCMD())
+	genesisCMD.AddCommand(HistoryTestCmd())
+
+	return genesisCMD
+}

command/regenesis/get_root.go

@@ -0,0 +1,65 @@
+package regenesis
+
+import (
+	"fmt"
+
+	"github.com/0xPolygon/polygon-edge/command"
+	"github.com/spf13/cobra"
+	"github.com/umbracle/ethgo"
+	"github.com/umbracle/ethgo/jsonrpc"
+)
+
+var (
+	jsonRPCAddress string
+	blockNumber    int64
+)
+
+/*
+./polygon-edge regenesis getroot --rpc "http://localhost:10002"
+*/
+func GetRootCMD() *cobra.Command {
+	getRootCmd := &cobra.Command{
+		Use:   "getroot",
+		Short: "returns state root of old chain",
+	}
+	getRootCmd.Run = func(cmd *cobra.Command, args []string) {
+		outputter := command.InitializeOutputter(getRootCmd)
+		defer outputter.WriteOutput()
+
+		rpcClient, err := jsonrpc.NewClient(jsonRPCAddress)
+		if err != nil {
+			outputter.SetError(fmt.Errorf("connect to client error:%w", err))
+
+			return
+		}
+
+		block, err := rpcClient.Eth().GetBlockByNumber(ethgo.BlockNumber(blockNumber), false)
+		if err != nil {
+			outputter.SetError(fmt.Errorf("get block error:%w", err))
+
+			return
+		}
+
+		_, err = outputter.Write([]byte(fmt.Sprintf("state root %s for block %d\n", block.StateRoot, block.Number)))
+		if err != nil {
+			outputter.SetError(fmt.Errorf("get block error:%w", err))
+
+			return
+		}
+	}
+
+	getRootCmd.Flags().StringVar(
+		&jsonRPCAddress,
+		"rpc",
+		"",
+		"the JSON RPC IP address for old chain",
+	)
+	getRootCmd.Flags().Int64Var(
+		&blockNumber,
+		"block",
+		int64(ethgo.Latest),
+		"Block number of trie snapshot",
+	)
+
+	return getRootCmd
+}

command/regenesis/howtotest.md

@@ -0,0 +1,166 @@
+1) create cluster
+```bash
+scripts/cluster ibft
+```
+2) check balance
+```bash
+curl -s -X POST --data '{"jsonrpc":"2.0", "method":"eth_getBalance", "params":["0x85da99c8a7c2c95964c8efd687e95e632fc533d6", "latest"], "id":1}' http://localhost:10002
+
+{"jsonrpc":"2.0","id":1,"result":"0x3635c9adc5dea00000"}
+```
+
+3) get trie root
+```bash
+./polygon-edge regenesis getroot --rpc "http://localhost:10002"
+
+[Trie copy SUCCESS]
+state root 0xf5ef1a28c82226effb90f4465180ec3469226747818579673f4be929f1cd8663 for block 38
+
+```
+
+4) make trie snapshot
+```bash
+
+./polygon-edge regenesis --target-path ./trie_new --stateRoot 0xf5ef1a28c82226effb90f4465180ec3469226747818579673f4be929f1cd8663  --source-path ./test-chain-1/trie 
+
+[Trie copy SUCCESS]
+
+```
+
+5) remove old chain data
+```bash
+rm -rf test-chain-*
+```
+6) create new validators
+```bash
+./polygon-edge polybft-secrets --insecure --data-dir test-chain- --num 4
+
+[WARNING: INSECURE LOCAL SECRETS - SHOULD NOT BE RUN IN PRODUCTION]
+
+[SECRETS INIT]
+Public key (address) = 0x467CaA6185461E4c518597dCE7DE497Fb98a5680
+BLS Public key       = 197059fdc3a78bd4001d802481c5ff1d84870c0b37aef851c83522323bd80f6429751ddae63cf38d180a8d45a5b4bf5519f380d60d6eedf9ccd22c3f95fc5e3a1193155af6ff3ab9e2aea5beab3f52e5e364d2cb410d6108c92f9a8375aac73110b8526407691c7e92e5cfab984e9011202b0606dc2be942808554b848cce67b
+Node ID              = 16Uiu2HAmTN2YAviWyyG4A56Zz8gsVJhmksdojymS4pk54SZqVbGV
+
+[WARNING: INSECURE LOCAL SECRETS - SHOULD NOT BE RUN IN PRODUCTION]
+
+[SECRETS INIT]
+Public key (address) = 0x33177bBAebcB20F8545864a83b9b6EE334e4f94D
+BLS Public key       = 12d82d172646703d298453cef6f4415ceab2052267d9ec300fd4742fa46fd8db0168b5e98372ae3efd52d647f9b356043163fc4f76182f1ef685faf5e53b1dba15b7d0d9cb9b7868592e02179255775618dbacafd384cffba95b647a5d84de9a27995bb8cc0766194f370ad5b274d1a53b9b8ab21a3dee2f4ee4f177f63fb1f0
+Node ID              = 16Uiu2HAkvtXkr1Hsct3UGn19ULNb7jgzPvEPu6Fpdakco8P45648
+
+[WARNING: INSECURE LOCAL SECRETS - SHOULD NOT BE RUN IN PRODUCTION]
+
+[SECRETS INIT]
+Public key (address) = 0xf308dF858dA25c2e40485FfA2c037D98105FD254
+BLS Public key       = 220efa87e71744f44e286230cf4ac95a419abdd6d33d1a578fee21387b841fa32184dd132c077adb8f46db0eb66333672e36b5f363778030475672defce0b5622bb0974424dd7babfdf722fe9eab75ab6e5e34e2ecfcea89420f757bf8adfeb7020f0f961ca946cdb2dde40413c5c0d48aa9f13182ec35b58c4052de466c0e25
+Node ID              = 16Uiu2HAmJqYRtWGbepPjQMgWfXnFEkXuX4GKH8AdD1voTwHpKuFa
+
+[WARNING: INSECURE LOCAL SECRETS - SHOULD NOT BE RUN IN PRODUCTION]
+
+[SECRETS INIT]
+Public key (address) = 0x7eC6b7fc98D988472AD1AC0cFcaC6DA993d865B0
+BLS Public key       = 2b8188f4bc99a19d5476fc97d14e17231cfb80b205a9fc45261725edefb0195209d972e9c1ad7d3c52b8fa129637738a88203c92fe8aa70fd0998d00f6251cb403ee077ddb4192fac270fe321468fe209308ea7597288e2505ed819f551ed00510c61f3da60f6a83d6017cbaeb7590c44bd354415178bbb160701b12a72a35a6
+Node ID              = 16Uiu2HAmEuYYyzQKpyVr2HVCG8Gqx5e5DLCi8LWY4TkFYvHYcWAq
+
+```
+
+7) generate genesis manifest
+```bash
+./polygon-edge manifest
+```
+
+8) generate genesis file
+```bash
+./polygon-edge genesis --consensus polybft --validator-set-size=4 --bridge-json-rpc http://127.0.0.1:8545 \
+--block-gas-limit 10000000 \
+--epoch-size 10 --trieroot 0xf5ef1a28c82226effb90f4465180ec3469226747818579673f4be929f1cd8663
+
+[GENESIS SUCCESS]
+**** POLYBFT CONSENSUS PROTOCOL IS IN EXPERIMENTAL PHASE AND IS NOT FULLY PRODUCTION READY. YOU ARE USING IT AT YOUR OWN RISK. ****
+Genesis written to ./genesis.json
+
+```
+
+9) Try to start a new v0.7 chain
+```bash
+ ./polygon-edge server --data-dir ./test-chain-1 --chain genesis.json --grpc-address :10000 --libp2p :30301 --jsonrpc :10002 --seal --log-level DEBUG &
+./polygon-edge server --data-dir ./test-chain-2 --chain genesis.json --grpc-address :20000 --libp2p :30302 --jsonrpc :20002 --seal --log-level DEBUG &
+./polygon-edge server --data-dir ./test-chain-3 --chain genesis.json --grpc-address :30000 --libp2p :30303 --jsonrpc :30002 --seal --log-level DEBUG &
+./polygon-edge server --data-dir ./test-chain-4 --chain genesis.json --grpc-address :40000 --libp2p :30304 --jsonrpc :40002 --seal --log-level DEBUG &
+wait
+
+[1] 2615
+[2] 2616
+[3] 2617
+[4] 2618
+2023-03-15T11:02:25.149+0400 [INFO]  polygon.server: Data dir: path=./test-chain-1
+2023-03-15T11:02:25.149+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+2023-03-15T11:02:25.233+0400 [INFO]  polygon.server: Data dir: path=./test-chain-3
+2023-03-15T11:02:25.251+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+invalid initial state root
+[1]    exit 1     ./polygon-edge server --data-dir ./test-chain-1 --chain genesis.json  :10000 
+2023-03-15T11:02:25.299+0400 [INFO]  polygon.server: Data dir: path=./test-chain-2
+2023-03-15T11:02:25.302+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+2023-03-15T11:02:25.396+0400 [INFO]  polygon.server: Data dir: path=./test-chain-4
+2023-03-15T11:02:25.413+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+invalid initial state root
+[3]  - exit 1     ./polygon-edge server --data-dir ./test-chain-3 --chain genesis.json  :30000 
+invalid initial state root
+[2]  - exit 1     ./polygon-edge server --data-dir ./test-chain-2 --chain genesis.json  :20000 
+invalid initial state root
+[4]  + exit 1     ./polygon-edge server --data-dir ./test-chain-4 --chain genesis.json  :40000 
+```
+
+It fails, because we havent provided trie database with correct state trie.
+
+10) Copy snapshot trie to our data directory
+```bash
+rm -rf ./test-chain-1/trie
+rm -rf ./test-chain-2/trie
+rm -rf ./test-chain-3/trie
+rm -rf ./test-chain-4/trie
+cp -fR ./trie_new/ ./test-chain-1/trie/
+cp -fR ./trie_new/ ./test-chain-2/trie/
+cp -fR ./trie_new/ ./test-chain-3/trie/
+cp -fR ./trie_new/ ./test-chain-4/trie/
+```
+
+11) run chain again
+```bash
+ ./polygon-edge server --data-dir ./test-chain-1 --chain genesis.json --grpc-address :10000 --libp2p :30301 --jsonrpc :10002 --seal --log-level DEBUG &
+./polygon-edge server --data-dir ./test-chain-2 --chain genesis.json --grpc-address :20000 --libp2p :30302 --jsonrpc :20002 --seal --log-level DEBUG &
+./polygon-edge server --data-dir ./test-chain-3 --chain genesis.json --grpc-address :30000 --libp2p :30303 --jsonrpc :30002 --seal --log-level DEBUG &
+./polygon-edge server --data-dir ./test-chain-4 --chain genesis.json --grpc-address :40000 --libp2p :30304 --jsonrpc :40002 --seal --log-level DEBUG &
+wait
+
+[1] 2721
+[2] 2722
+[3] 2723
+[4] 2724
+2023-03-15T11:09:41.481+0400 [INFO]  polygon.server: Data dir: path=./test-chain-2
+2023-03-15T11:09:41.481+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+2023-03-15T11:09:41.597+0400 [INFO]  polygon.server: Data dir: path=./test-chain-1
+2023-03-15T11:09:41.597+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+2023-03-15T11:09:41.609+0400 [WARN]  polygon: Initial state root checked and correct
+2023-03-15T11:09:41.661+0400 [INFO]  polygon.server: Data dir: path=./test-chain-4
+2023-03-15T11:09:41.661+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+2023-03-15T11:09:41.725+0400 [INFO]  polygon.server: Data dir: path=./test-chain-3
+2023-03-15T11:09:41.725+0400 [DEBUG] polygon.server: DataDog profiler disabled, set DD_PROFILING_ENABLED env var to enable it.
+2023-03-15T11:09:41.844+0400 [INFO]  polygon.blockchain: genesis: hash=0x627b70a8abc294324808d9820015faa5e0616afca5fdc75528b03b703a461acd
+2023-03-15T11:09:41.844+0400 [INFO]  polygon.server.polybft: initializing polybft...
+2023-03-15T11:09:41.951+0400 [WARN]  polygon: Initial state root checked and correct
+2023-03-15T11:09:42.101+0400 [WARN]  polygon: Initial state root checked and correct
+2023-03-15T11:09:42.254+0400 [WARN]  polygon: Initial state root checked and correct
+2023-03-15T11:09:42.445+0400 [INFO]  polygon.blockchain: genesis: hash=0x627b70a8abc294324808d9820015faa5e0616afca5fdc75528b03b703a461acd
+2023-03-15T11:09:42.445+0400 [INFO]  polygon.server.polybft: initializing polybft...
+2023-03-15T11:09:42.462+0400 [INFO]  polygon.server.polybft.consensus_runtime: restartEpoch: block number=0 epoch=1 validators=4 firstBlockInEpoch=1
+...
+```
+
+12) check that balance of account on v0.6 is not 0
+```bash
+ curl -s -X POST --data '{"jsonrpc":"2.0", "method":"eth_getBalance", "params":["0x85da99c8a7c2c95964c8efd687e95e632fc533d6", "latest"], "id":1}' http://localhost:10002
+
+{"jsonrpc":"2.0","id":1,"result":"0x3635c9adc5dea00000"}% 
+```