feat(add keystore logic): add keystore logic

add keystore logic

Author: yuanyu90221

.gitignore

@@ -23,4 +23,5 @@ go.work.sum
 
 # env file
 .env
-bin
+bin
+wallet

Makefile

@@ -6,12 +6,18 @@ build-client:
 build-wallet:
 	@CGO_ENABLED=0 GOOS=linux go build -o bin/go-wallet learn/go-wallet/go-wallet.go
 
+build-keystore:
+	@CGO_ENABLED=0 GOOS=linux go build -o bin/go-keystore learn/go-keystore/go-keystore.go
+
 run-client: build-client
 	@./bin/go-client
 
 run-wallet: build-wallet
 	@./bin/go-wallet
 
+run-keystore: build-keystore
+	@./bin/go-keystore
+
 coverage:
 	@go test -v -cover ./...
 

README.md

@@ -111,4 +111,40 @@ func main() {
 	// address
 	fmt.Println(crypto.PubkeyToAddress(pvk.PublicKey).Hex())
 }
+```
+
+## wallet (keystore) concept
+
+![wallet-keystore-concept](wallet-keystore-concept.png)
+
+1. Generate keystore with password
+```golang
+func GenerateKeyStore() {
+	// generate keystore
+	key := keystore.NewKeyStore("./wallet", keystore.StandardScryptN, keystore.StandardScryptP)
+	account, err := key.NewAccount(config.AppConfig.KeyStorePassword)
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Println(account.Address)
+}
+```
+2. Read key from keystore with password
+```golang
+func ReadKeyFromKeyStore() {
+	b, err := os.ReadFile(fmt.Sprintf("%s/%s", "./wallet", config.AppConfig.KeyStorefile))
+	if err != nil {
+		log.Fatal(err)
+	}
+	key, err := keystore.DecryptKey(b, config.AppConfig.KeyStorePassword)
+	if err != nil {
+		log.Fatal(err)
+	}
+	pData := crypto.FromECDSA(key.PrivateKey)
+	fmt.Println("private key:", hexutil.Encode(pData))
+	pubData := crypto.FromECDSAPub(&key.PrivateKey.PublicKey)
+	fmt.Println("public key:", hexutil.Encode(pubData))
+	address := crypto.PubkeyToAddress(key.PrivateKey.PublicKey).Hex()
+	fmt.Println("address:", address)
+}
 ```

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/ethereum/go-ethereum v1.14.5 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/go-ole/go-ole v1.3.0 // indirect
+	github.com/google/uuid v1.4.0 // indirect
 	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/holiman/uint256 v1.2.4 // indirect

go.sum

@@ -29,6 +29,8 @@ github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiU
 github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE=
 github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78=
 github.com/google/subcommands v1.2.0/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk=
+github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4=
+github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
 github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=

internal/config/config.go

@@ -7,8 +7,10 @@ import (
 )
 
 type Config struct {
-	EthJsonRpcURL string `mapstructure:"ETH_JSON_RPC_URL"`
-	EthAddress    string `mapstructure:"ETH_ADDRESS"`
+	EthJsonRpcURL    string `mapstructure:"ETH_JSON_RPC_URL"`
+	EthAddress       string `mapstructure:"ETH_ADDRESS"`
+	KeyStorePassword string `mapstructure:"KEY_STORE_PASSWORD"`
+	KeyStorefile     string `mapstructure:"KEY_STORE_FILE"`
 }
 
 var AppConfig *Config
@@ -21,6 +23,8 @@ func init() {
 	v.AutomaticEnv()
 	failOnError(v.BindEnv("ETH_JSON_RPC_URL"), "fail on Bind ETH_JSON_RPC_URL")
 	failOnError(v.BindEnv("ETH_ADDRESS"), "fail on Bind ETH_ADDRESS")
+	failOnError(v.BindEnv("KEY_STORE_PASSWORD"), "fail on Bind KEY_STORE_PASSWORD")
+	failOnError(v.BindEnv("KEY_STORE_FILE"), "fail on Bind KEY_STORE_FILE")
 	err := v.ReadInConfig()
 	if err != nil {
 		log.Println("load from environment variable")

learn/go-keystore/go-keystore.go

@@ -0,0 +1,43 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/ethereum/go-ethereum/accounts/keystore"
+	"github.com/ethereum/go-ethereum/common/hexutil"
+	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/leetcode-golang-classroom/golang-ethereum-sample/internal/config"
+)
+
+func main() {
+	ReadKeyFromKeyStore()
+}
+
+func GenerateKeyStore() {
+	// generate keystore
+	key := keystore.NewKeyStore("./wallet", keystore.StandardScryptN, keystore.StandardScryptP)
+	account, err := key.NewAccount(config.AppConfig.KeyStorePassword)
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Println(account.Address)
+}
+
+func ReadKeyFromKeyStore() {
+	b, err := os.ReadFile(fmt.Sprintf("%s/%s", "./wallet", config.AppConfig.KeyStorefile))
+	if err != nil {
+		log.Fatal(err)
+	}
+	key, err := keystore.DecryptKey(b, config.AppConfig.KeyStorePassword)
+	if err != nil {
+		log.Fatal(err)
+	}
+	pData := crypto.FromECDSA(key.PrivateKey)
+	fmt.Println("private key:", hexutil.Encode(pData))
+	pubData := crypto.FromECDSAPub(&key.PrivateKey.PublicKey)
+	fmt.Println("public key:", hexutil.Encode(pubData))
+	address := crypto.PubkeyToAddress(key.PrivateKey.PublicKey).Hex()
+	fmt.Println("address:", address)
+}