fix: supporting localnet (#492)

cmd/cmd.go

@@ -17,8 +17,13 @@ import (
 	"github.com/manifoldco/promptui"
 	"github.com/pactus-project/pactus/config"
 	"github.com/pactus-project/pactus/crypto"
+	"github.com/pactus-project/pactus/crypto/bls"
 	"github.com/pactus-project/pactus/genesis"
 	"github.com/pactus-project/pactus/node"
+	"github.com/pactus-project/pactus/types/account"
+	"github.com/pactus-project/pactus/types/param"
+	"github.com/pactus-project/pactus/types/validator"
+	"github.com/pactus-project/pactus/util"
 	"github.com/pactus-project/pactus/wallet"
 )
 
@@ -282,6 +287,8 @@ func CreateNode(numValidators int, chain genesis.ChainType, workingDir string,
 	genPath := PactusGenesisPath(workingDir)
 
 	switch chain {
+	case genesis.Mainnet:
+		panic("not yet!")
 	case genesis.Testnet:
 		err = genesis.TestnetGenesis().SaveToFile(genPath)
 		if err != nil {
@@ -292,8 +299,16 @@ func CreateNode(numValidators int, chain genesis.ChainType, workingDir string,
 		if err != nil {
 			return nil, nil, err
 		}
-	case genesis.Mainnet:
-		panic("not yet!")
+	case genesis.Localnet:
+		err = makeLocalGenesis(*wallet).SaveToFile(genPath)
+		if err != nil {
+			return nil, nil, err
+		}
+
+		err := config.SaveLocalnetConfig(confPath, numValidators)
+		if err != nil {
+			return nil, nil, err
+		}
 	}
 
 	err = wallet.UpdatePassword("", walletPassword)
@@ -316,7 +331,7 @@ func StartNode(workingDir string, passwordFetcher func(*wallet.Wallet) (string,
 		return nil, nil, err
 	}
 
-	if gen.ChainType().IsTestnet() {
+	if !gen.ChainType().IsMainnet() {
 		crypto.AddressHRP = "tpc"
 		crypto.PublicKeyHRP = "tpublic"
 		crypto.PrivateKeyHRP = "tsecret"
@@ -419,3 +434,25 @@ func StartNode(workingDir string, passwordFetcher func(*wallet.Wallet) (string,
 
 	return node, wallet, nil
 }
+
+// makeLocalGenesis makes genesis file for the local network.
+func makeLocalGenesis(w wallet.Wallet) *genesis.Genesis {
+	// Treasury account
+	acc := account.NewAccount(0)
+	acc.AddToBalance(21 * 1e14)
+	accs := map[crypto.Address]*account.Account{
+		crypto.TreasuryAddress: acc}
+
+	vals := make([]*validator.Validator, 4)
+	for i := 0; i < 4; i++ {
+		ai := w.AddressInfo(w.AddressLabels()[i].Address)
+		vals[i] = validator.NewValidator(
+			ai.Pub.(*bls.PublicKey), int32(i))
+	}
+
+	// create genesis
+	params := param.DefaultParams()
+	params.BlockVersion = 0
+	gen := genesis.MakeGenesis(util.RoundNow(60), accs, vals, params)
+	return gen
+}

cmd/daemon/init.go

@@ -24,6 +24,11 @@ func Init() func(c *cli.Cmd) {
 			Desc:  "Initialize working directory for joining the testnet",
 			Value: true, // TODO: make it false after mainnet launch
 		})
+		localnetOpt := c.Bool(cli.BoolOpt{
+			Name:  "localnet",
+			Desc:  "Initialize working directory for localnet (for developers)",
+			Value: false,
+		})
 
 		c.LongDesc = "Initializing the working directory by new validator's private key and genesis file"
 		c.Before = func() { fmt.Println(cmd.Pactus) }
@@ -55,11 +60,15 @@ func Init() func(c *cli.Cmd) {
 			cmd.PrintInfoMsg("You can define validators based on the amount of coins you want to stake.")
 			numValidators := cmd.PromptInputWithRange("Number of Validators", 7, 1, 32)
 
-			network := genesis.Mainnet
+			chain := genesis.Mainnet
+			// The order of checking the network (chain type) matters here.
 			if *testnetOpt {
-				network = genesis.Testnet
+				chain = genesis.Testnet
+			}
+			if *localnetOpt {
+				chain = genesis.Localnet
 			}
-			validatorAddrs, rewardAddrs, err := cmd.CreateNode(numValidators, network, workingDir, mnemonic, password)
+			validatorAddrs, rewardAddrs, err := cmd.CreateNode(numValidators, chain, workingDir, mnemonic, password)
 			cmd.FatalErrorCheck(err)
 
 			cmd.PrintLine()
@@ -75,7 +84,7 @@ func Init() func(c *cli.Cmd) {
 			}
 
 			cmd.PrintLine()
-			cmd.PrintInfoMsgBold("Network: %v", network.String())
+			cmd.PrintInfoMsgBold("Network: %v", chain.String())
 			cmd.PrintLine()
 			cmd.PrintSuccessMsg("A pactus node is successfully initialized at %v", workingDir)
 			cmd.PrintLine()

cmd/gtk/main.go

@@ -56,7 +56,7 @@ func main() {
 
 	// Create a new app.
 	// When using GtkApplication, it is not necessary to call gtk_init() manually.
-	app, err := gtk.ApplicationNew(appID, glib.APPLICATION_FLAGS_NONE)
+	app, err := gtk.ApplicationNew(appID, glib.APPLICATION_NON_UNIQUE)
 	fatalErrorCheck(err)
 
 	// Connect function to application startup event, this is not required.

config/config.go

@@ -124,6 +124,27 @@ func SaveTestnetConfig(path string, numValidators int) error {
 	return util.WriteFile(path, conf.toTOML())
 }
 
+func SaveLocalnetConfig(path string, numValidators int) error {
+	conf := DefaultConfig()
+	conf.Node.NumValidators = numValidators
+	conf.Network.Name = "pactus-localnet"
+	conf.Network.Listens = []string{}
+	conf.Network.EnableNAT = false
+	conf.Network.Bootstrap.Addresses = []string{}
+	conf.Network.Bootstrap.MinThreshold = 4
+	conf.Network.Bootstrap.MaxThreshold = 8
+	conf.GRPC.Enable = true
+	conf.GRPC.Listen = "[::]:0"
+	conf.GRPC.Gateway.Enable = true
+	conf.GRPC.Gateway.Listen = "[::]:0"
+	conf.HTTP.Enable = true
+	conf.HTTP.Listen = "[::]:0"
+	conf.Nanomsg.Enable = true
+	conf.Nanomsg.Listen = "tcp://127.0.0.1:0"
+
+	return util.WriteFile(path, conf.toTOML())
+}
+
 func (conf *Config) toTOML() []byte {
 	buf := new(bytes.Buffer)
 	encoder := toml.NewEncoder(buf)

config/config_test.go

@@ -31,6 +31,19 @@ func TestSaveTestnetConfig(t *testing.T) {
 	assert.Equal(t, conf.Network.Name, "pactus-testnet")
 }
 
+func TestSaveLocalnetConfig(t *testing.T) {
+	path := util.TempFilePath()
+	assert.NoError(t, SaveLocalnetConfig(path, 4))
+
+	conf, err := LoadFromFile(path, true)
+	assert.NoError(t, err)
+
+	assert.NoError(t, conf.SanityCheck())
+	assert.Equal(t, conf.Network.Name, "pactus-localnet")
+	assert.Empty(t, conf.Network.Listens)
+	assert.Empty(t, conf.Network.RelayAddrs)
+}
+
 func TestLoadFromFile(t *testing.T) {
 	path := util.TempFilePath()
 	_, err := LoadFromFile(path, true)

docs/install.md

@@ -59,6 +59,15 @@ and then start the node:
 ./pactus-daemon start -w=<working_dir>
 ```
 
+### Local net
+
+You can create a local node to set up a local network for development purposes on your machine:
+
+ ```text
+ ./pactus-daemon init  -w=<working_dir> --localnet
+ ./pactus-daemon start -w=<working_dir>
+ ```
+
 ## What is pactus-wallet?
 
 Pactus wallet is a native wallet in the Pactus blockchain that lets users easily manage

genesis/genesis.go

@@ -19,13 +19,13 @@ import (
 type ChainType uint8
 
 const (
-	Unknown ChainType = 0xff
-	Mainnet ChainType = 0
-	Testnet ChainType = 1
+	Mainnet  ChainType = 0
+	Testnet  ChainType = 1
+	Localnet ChainType = 2
 )
 
-func (n ChainType) IsTestnet() bool {
-	return n == Testnet
+func (n ChainType) IsMainnet() bool {
+	return n == Mainnet
 }
 
 func (n ChainType) String() string {
@@ -34,6 +34,8 @@ func (n ChainType) String() string {
 		return "Mainnet"
 	case Testnet:
 		return "Testnet"
+	case Localnet:
+		return "Localnet"
 	default:
 		return "Unknown"
 	}
@@ -172,6 +174,7 @@ func (gen *Genesis) ChainType() ChainType {
 	if gen.Hash() == TestnetGenesis().Hash() {
 		return Testnet
 	}
+	// TODO: add mainnet here
 
-	return Unknown
+	return Localnet
 }

wallet/wallet.go

@@ -71,7 +71,8 @@ func Create(path, mnemonic, password string, chain genesis.ChainType) (*Wallet,
 	switch chain {
 	case genesis.Mainnet:
 		coinType = 21888
-	case genesis.Testnet:
+	case genesis.Testnet,
+		genesis.Localnet:
 		coinType = 21777
 	default:
 		return nil, ErrInvalidNetwork
@@ -102,7 +103,7 @@ func Create(path, mnemonic, password string, chain genesis.ChainType) (*Wallet,
 }
 
 func newWallet(path string, store *store, offline bool) (*Wallet, error) {
-	if store.Network.IsTestnet() {
+	if !store.Network.IsMainnet() {
 		crypto.AddressHRP = "tpc"
 		crypto.PublicKeyHRP = "tpublic"
 		crypto.PrivateKeyHRP = "tsecret"