# update readme

Author: MacOMNI

README.md

@@ -1,2 +1,105 @@
-# hardwallet
-Hyperpay hardwallet 
+# Hyperpay Wallet HardWallet
+
+HardWallet is committed to build a straightforward and easy-to-use library.
+The open source framework displays all functions and methods related to the hardware wallet. Contains related mnemonics, private keys, addresses and related signed transactions.
+And use a ble middleware to simulate the relevant data compression and transmission under Bluetooth communication.
+
+## Environment Setup
+
+- [Go Installation](https://golang.org/doc/install)
+- About the missing librarys, use `go get xxx ..` to install them
+- `git clone https://github.com/hyperpayorg/hardwallet`
+- `cd hardwallet`
+
+## How to use
+
+For ease of use and understanding, some tests that can be tested directly are written.
+This can help to quickly understand the relationship between the various components.
+
+
+## Generate wallet
+Private key, public key and address can be generated by `GenerateMnWallet` func.
+Language supports: `english`、`korean`、`chinese_simplified` ,etc.
+Mnemonics supports: `12 words`、`24 words`,etc.
+Password supported.
+```go
+ceateAccount := &clientwallet.CreateAccount{
+	Language: "english",
+	Length:   12,
+	Password: "123456",
+}
+fmt.Println(ceateAccount)
+isCreated := clientwallet.GenerateMnWallet(ceateAccount)
+fmt.Println(isCreated)
+```
+## Wallet SignRawTransation
+SignRawTransation can be generated by `func SignRawTransaction(signIn *SignInput)` func.
+
+```go
+signIn := &clientwallet.SignInput{
+		Coin:     "btc",
+		Symbol:   "btc",
+		Amount:   10000,
+		Change:   25000000 - 10000 - 10000,
+		Fee:      10000,
+		SrcAddr:  "",
+		DestAddr: "",
+		Net:      "testnet",
+		Password: "123456",
+		Inputs:   jsonInputs,
+}
+
+signResult := clientwallet.SignRawTransaction(signIn)
+fmt.Println(signResult)
+```
+Data structure returned as follow：
+```go
+type WalletAccount struct {
+	ResCode    int    // 0 fail 1 Success
+	Address    string
+	PublicKey  string
+	PrivateKey string
+	Seed       string // root seed
+	Coin       string
+	ErrMsg     string // fail messages
+	ErrCode    int    // err code
+	Params     []byte // reserved fields
+}
+```
+
+
+### Wallet EnKeystore
+
+Key information storage supports pwd & udid.
+```go
+Key := "L1oh9KNH4XpJgqDodxhjPgaEVS1qwXToWvPf2Zyn6bcm7xxxxxxx"
+pwd := "11111"
+udid := "AOIJF-QWEQR-VDFBET-YTAWWE"
+
+// Encode
+enResult := EnKeystore(Key, pwd, udid)
+fmt.Println("Keystore : \n", enResult.Result)
+```
+## Wallet KeyStore File Decrypt
+The keystore file is decrypted using the KeyStore json, udid and the password.
+
+To decrypt keystore file, use the following methods:
+
+
+```go
+func DeKeystore(json, password, udid string)
+```
+
+> Description: JSON is the KeyStore JSON file
+
+Data structure returned as `KeystoreResult`。
+
+### Wallet DeKeystore 
+```go
+   enResult := "xxxxxxx"
+	pwd := "11111"
+	udid := "AOIJF-QWEQR-VDFBET-YTAWWE"
+  // Decode
+	deResult := DeKeystore(enResult, pwd, udid)
+	fmt.Println("PrivateKey : ", deResult.Result)
+```

hardwallet/keystore.txt

@@ -1 +1 @@
-{"crypto":{"cipher":"aes-128-ctr","ciphertext":"8f8476cbb56804cc1206914bd57ffa672294af41d0f733b92da23f9421ccdd4664373c499aba08288cba196576ed56f4fa244ab856f2625ca0c0cc87b31c9a230a15ca66bb2ccd832eb98b26c66c0b654fd54f23","cipherparams":{"iv":"efd62f81823404dee688f83a754af23d"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":2048,"p":1,"r":8,"salt":"a7ad843aa20dafecfdafc0e053d13deef77b65c6641123fbab30278ed9ba4b51"},"mac":"55069d20f67c0825c91810695b950bd210f75a163112f840b7fd665e1418e3d1"},"version":3}
+{"crypto":{"cipher":"aes-128-ctr","ciphertext":"2478f8b32c6c54ffe4ee8f03d66c7e5994ff5da93a950d168bcb2a606beeac05a5b926d0eafff8e7746a26bb198b2784e315b884deba33f7e9dfd25aa738a5fd3c5dad4ac23e2852aeb575bcb8b337","cipherparams":{"iv":"16a18732a4e3686dac90794c2bf26387"},"kdf":"scrypt","kdfparams":{"dklen":32,"n":2048,"p":1,"r":8,"salt":"9af9a31c12cbedc6b80c0c5abe66afa80a6c7f4ff7c51a71d6f0d4d75a2cd02b"},"mac":"a5acd7c3c061d6f2fe001c316744ece490b1d45a5a4117e3658f57e587359754"},"version":3}