nknwallet

package module

v0.0.0-...-acf55ce Latest Latest Go to latest Published: Aug 13, 2023 License: MIT Imports: 32 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/omani/nkn-wallet

Links

Open Source Insights

README ¶

nkn-wallet

A next generation NKN wallet with built-in age encryption and NKN OpenAPI support.

nkn-wallet is a library that implements nkn-sdk-go with a new wallet functionality utilizing age encryption and using the NKN OpenAPI for querying the NKN blockchain.

Upcoming releases will include the possibility for encryption by SSH public key ("ssh-ed25519 AAAA...", "ssh-rsa AAAA...") stored on disk or by fetching the keys from a Github user profile (github.com/[user].keys).

While nkn-wallet has its own wallet implementation the underlying SDK functionality remains the same and is compatible with nkn-sdk-go. The move to age as an encryption toolkit results in overall less loc since there is no need to implement scrypt functionality manually. This wallet implementation uses age's internal scrypt feature which is identical to the original NKN wallet implementation performance-wise and slightly enhanced security-wise through the use of an additional layer, that is, the derived scrypt key being encrypted again with a ChaCha20-Poly1305 AEAD.

Features:

Manage all your different accounts from a central place
State-of-the-art encryption with Age
Manage multiple accounts in a single wallet file (multiwallet capability)
List all your accounts
Set an alias for your account
Show the balance of your account
Show transactions of your account
Move funds between accounts in the wallet
Transfer funds to another NKN address
Restore your accounts
Change password of your account
Change or set an alias for your account
NKN OpenAPI support

Library

Installation

import nknwallet "github.com/omani/nkn-wallet"

Example

package main

import (
	"fmt"
	"log"

	"github.com/nknorg/nkn-sdk-go"
	nknwallet "github.com/omani/nkn-wallet"
)

func main() {
	passwd := []byte("secretpassword")
	store := nknwallet.NewStore("mywallet.json")

	walletcfg := &nkn.WalletConfig{}
	wallet, err := store.NewWallet(passwd, "my-new-shiny-account", walletcfg)
	if err != nil {
		log.Fatal(err)
	}

	// save new wallet to store (otherwise it is in-memory only)
	store.SaveWallet(wallet)

	// list wallets in store
	store.ListWallets()

	// get balance of newly created account
	balance, err := wallet.OpenAPI().GetBalance()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Address: %s - Balance: %s NKN\n", wallet.Address(), balance)

	// fetch a wallet from store
	wallet, err = store.GetWalletByAlias("my-new-shiny-account", passwd)
	if err != nil {
		log.Fatal(err)
	}

	// print account address
	fmt.Printf("Address of account: %s\n", wallet.Address())

	// get transactions associated with account
	txn, err := wallet.OpenAPI().GetTransactions()
	if err != nil {
		log.Fatal(err)
	}
	if len(txn.Data) == 0 {
		fmt.Println("Account has no transactions.")
		return
	}

	for _, tx := range txn.Data {
		fmt.Printf("Sent %s NKN to address %s", tx.Payload.Amount, tx.Payload.RecipientWallet)
	}
}

Use with nkn-sdk-go

package main

import (
	"crypto/rand"
	"encoding/hex"
	"fmt"
	"log"
	"time"

	"github.com/nknorg/nkn-sdk-go"
	nknwallet "github.com/omani/nkn-wallet"
)

func main() {
	store := nknwallet.NewStore("mywallet.json")

	walletcfg := &nkn.WalletConfig{}
	wallet, err := store.NewWallet([]byte("secretpassword"), "my-new-shiny-account", walletcfg)
	if err != nil {
		log.Fatal(err)
	}

	// continue to use nkn-sdk-go as usual
	err = func() error {
		// get the underlying nkn.Account
		account := wallet.Account()

		fromIdentifier := make([]byte, 8)
		_, err = rand.Read(fromIdentifier)
		if err != nil {
			return err
		}
		toIdentifier := make([]byte, 8)
		_, err = rand.Read(toIdentifier)
		if err != nil {
			return err
		}

		fromClient, err := nkn.NewMultiClient(account, hex.EncodeToString(fromIdentifier), 4, false, nil)
		if err != nil {
			return err
		}
		defer fromClient.Close()
		<-fromClient.OnConnect.C

		toClient, err := nkn.NewMultiClient(account, hex.EncodeToString(toIdentifier), 4, false, nil)
		if err != nil {
			return err
		}
		defer toClient.Close()
		<-toClient.OnConnect.C

		time.Sleep(time.Second)

		timeSent := time.Now().UnixNano() / int64(time.Millisecond)
		var timeReceived int64
		go func() {
			msg := <-toClient.OnMessage.C
			timeReceived = time.Now().UnixNano() / int64(time.Millisecond)
			isEncryptedStr := "unencrypted"
			if msg.Encrypted {
				isEncryptedStr = "encrypted"
			}
			log.Println("Receive", isEncryptedStr, "message", "\""+string(msg.Data)+"\"", "from", msg.Src, "after", timeReceived-timeSent, "ms")
			// []byte("World") can be replaced with "World" for text payload type
			msg.Reply([]byte("World"))
		}()

		log.Println("Send message from", fromClient.Address(), "to", toClient.Address())
		// []byte("Hello") can be replaced with "Hello" for text payload type
		onReply, err := fromClient.Send(nkn.NewStringArray(toClient.Address()), []byte("Hello"), nil)
		if err != nil {
			return err
		}
		reply := <-onReply.C
		isEncryptedStr := "unencrypted"
		if reply.Encrypted {
			isEncryptedStr = "encrypted"
		}
		timeResponse := time.Now().UnixNano() / int64(time.Millisecond)
		log.Println("Got", isEncryptedStr, "reply", "\""+string(reply.Data)+"\"", "from", reply.Src, "after", timeResponse-timeReceived, "ms")

		// wait to send receipt
		time.Sleep(time.Second)

		return nil
	}()
	if err != nil {
		fmt.Println(err)
	}

}

CLI App

This package comes with a CLI app in cmd/

Installation

go install github.com/omani/nkn-wallet/cmd/nkn-wallet@latest

Usage

Invocation

$ nkn-wallet
nkn-wallet v1.0
---------------------------------------------------------------------------
nkn-wallet is a library that implements nkn-sdk-go with a new wallet
functionality utilizing age encryption and using the NKN OpenAPI for
querying the NKN blockchain.

Upcoming releases will include the possibility for encryption by
SSH public key ("ssh-ed25519 AAAA...", "ssh-rsa AAAA...") stored on disk
or by fetching the keys from a Github user profile (github.com/[user].keys).

URL: https://github.com/omani/nkn-wallet
MIT license. Copyright (c) 2023 HAH! Sun

[This message will be removed with the next version]
---------------------------------------------------------------------------

Usage:
  nkn-wallet [command]

Available Commands:
  change      Change various information of an account in the wallet
  create      Create an account in the wallet
  delete      Delete an account from the wallet
  help        Help about any command
  list        List all accounts of the wallet
  move        Move funds between accounts in the wallet
  restore     Restore an account from a seed
  show        Show various information to an account in the wallet
  transfer    Transfer funds to another NKN address

Flags:
  -h, --help          help for nkn-wallet
      --ip string     DNS/IP of NKN remote node (default "mainnet-seed-0001.org")
  -p, --path string   path to wallet file (default "./nkn-wallet.json")
  -v, --version       version for nkn-wallet

Use "nkn-wallet [command] --help" for more information about a command.

Create account

$ nkn-wallet --path usethiswallet.json create --alias mining-wallet-srv01 -s
Password:
Re-enter Password:

Account information:
Seed: c2017a52472f4e616b1ee028297c8609d09fdec90db8522b978df85df9a14d10
Address: NKNT43Q5z863qL2wdheRqEmSgPtNDnbiLTw3
Alias: mining-wallet-srv01
Account saved successfully.

Note: Use the -s flag to save the newly created account to the wallet!

Create another one

$ nkn-wallet --path usethiswallet.json create --alias github-donations -s
Password:
Re-enter Password:

Account information:
Seed: de392b438d5020b46123f461d0c1db50c2eef244fb6e213c20bfaa3a4b2ae237
Address: NKND1ejSRWBExoq8t4DWpPHaK5BMBe4yifTN
Alias: github-donations
Account saved successfully.

Note: Use the -s flag to save the newly created account to the wallet!

List accounts

$ nkn-wallet --path usethiswallet.json list
────┼─────────────────────┼──────────────────────────────────────
 ID │ ALIAS               │ ADDRESS
────┼─────────────────────┼──────────────────────────────────────
  1 │ mining-wallet-srv01 │ NKNT43Q5z863qL2wdheRqEmSgPtNDnbiLTw3
  2 │ github-donations    │ NKND1ejSRWBExoq8t4DWpPHaK5BMBe4yifTN

Show account info

$ nkn-wallet --path usethiswallet.json show info -i 1
Password:
 ID │ ALIAS               │ ADDRESS                              │ PUBKEY                                                           │ SEED
────┼─────────────────────┼──────────────────────────────────────┼──────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────
  1 │ mining-wallet-srv01 │ NKNT43Q5z863qL2wdheRqEmSgPtNDnbiLTw3 │ d9390cfde27fb118c18e70367afb2fc4ffb17d2386c43f5b157b13c34a5b3120 │ c2017a52472f4e616b1ee028297c8609d09fdec90db8522b978df85df9a14d10

Show balance of account

$ nkn-wallet --path usethiswallet.json show balance -i 1
 ID │ ALIAS               │ ADDRESS                              │ BALANCE
────┼─────────────────────┼──────────────────────────────────────┼─────────
  1 │ mining-wallet-srv01 │ NKNT43Q5z863qL2wdheRqEmSgPtNDnbiLTw3 │       0

Show transactions of account

For example purposes the wallet shown in this example is a wallet with already several transactions, not the newly created one in the examples above.

$ nkn-wallet --path usethiswallet.json show transactions -i 1
Password:
 CREATED AT          │ BLOCK HEIGHT │ TXN HASH                                                         │ SENDER                               │ RECIPIENT                            │       AMOUNT
─────────────────────┼──────────────┼──────────────────────────────────────────────────────────────────┼──────────────────────────────────────┼──────────────────────────────────────┼──────────────
 2023-08-05 01:58:55 │    5666741   │ 26d7c4e968a4b40a2773e74c9429b73243210981102471cae7973b3c81558510 │ NKNKQ34u5DeSxfi5VN1HDtG9iuQdhmsxAx7m │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │            0
 2023-08-05 01:49:44 │    5666719   │ b770f948117078ea9e6f07f876e8c359732a8e8fa0fa5e2619b6d5604057f8dc │ NKNKQ34u5DeSxfi5VN1HDtG9iuQdhmsxAx7m │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │            1
 2023-08-05 01:34:33 │    5666683   │ 2854bf89c665caaf393a2fa70e01f3abd861a13f16fc4ff828a14a71524667dd │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNKQ34u5DeSxfi5VN1HDtG9iuQdhmsxAx7m │            1
 2023-08-02 21:32:56 │    5658789   │ d6005aeb904038b45041ce4680ca11229178053c02c7a585b998b54f6a9b1d59 │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │            1
 2023-07-30 19:19:03 │    5647512   │ 43a465187b71e80864d72c4c40140f9e22b587628915be384d36989839d05f04 │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │            1
 2023-03-31 14:48:06 │    5205199   │ a095963dc703e3a67829b00c8a3c258b937d826ff653d2469f0cd49c88534847 │ NKNJ8PDyiaJBbJJagiWEZLfpDyeBcxvgCgTu │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │  35.87375384
 2023-03-24 15:12:15 │    5179448   │ d54bc49c200602a5c5b1a7dc58fc7e1bdf5391ebfbf0ef0ad4aada31a6cf2a18 │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNJebQsifkREcuvGVteiZwcTL8WTxEXdLtb │          300
 2023-03-24 15:07:01 │    5179436   │ c4123b1a842563520e826f6c594cd5b7dbd9b237c043a18cb91b01d73bde29dd │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNSns2iiMibVUfwmXKC2oLFfeWZoTENiMvk │          300
 2021-12-24 01:41:40 │    3469174   │ 497862b0b28dac959fabc760c3c81ef9077ce0a46b266bf598feb35edad1253c │ NKNRBnhQq4dG68C3XVmEsos2QPaHtN4JiC6V │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │          281
 2021-12-21 07:52:54 │    3458748   │ 8e703cdd54696df94cc11c91163ebcb3c203e85bad8708764ae05132eb0da808 │ NKNToMMXL3W4EQxAZ7ooqgkyzPuHDb52fQJy │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │          100
 2021-12-05 03:33:45 │    3397448   │ 5ee5a1c763d7a1bdb00486fcf176363ac6c1b111b98fdea6277278f113df9a9b │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNPDgusz7HSnXGcvCqPQsLiqNaGspQoCzbz │           10
 2021-12-05 03:33:00 │    3397446   │ 3719cfee8b7c4c0c34df799120f717b65cff035843e221428ec3021481def1b3 │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNGuNrjgcLTsRvGpYKfE68Fht4Anbh52aR4 │           10
 2021-12-05 02:22:24 │    3397261   │ e64cf77e46833a1d9e23ca0988b9624b4d7b29f0660fde85277b51937149f955 │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ NKNJ8PDyiaJBbJJagiWEZLfpDyeBcxvgCgTu │           10
 2021-12-05 02:05:20 │    3397216   │ b0c260b27903df84d7719f1ef602f02be5a457dfc53c2d2d02bf24ee7a60928c │ NKNHb4UMs8whWosffseg7aPpztVNBt5NDrCR │ NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm │ 284.96270000
Total balance of account: 71.83645384 NKN

Transfer funds to another NKN address

For example purposes the wallet shown in this example is a wallet with a positive balance, not the newly created one in the examples above.

$ nkn-wallet transfer -i 10 --amount 1 --to NKNCSjyCsuDbJcSrRW4kG2atu4SW6sTJkx4o
Password:
Successfully sent 1 KNN from NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm to NKNCSjyCsuDbJcSrRW4kG2atu4SW6sTJkx4o. txHash: ba2313cdffa1060a4f28474a01ef19dc09ea5e042398eb56593870542e664cbb

Move funds between accounts within the wallet

For example purposes the wallet shown in this example is a wallet with a positive balance, not the newly created one in the examples above.

Use the special keyword "all" to move all funds.

$ nkn-wallet move --from-id 11 --to-id 10 --amount all
Password:
Successfully sent 1 NKN from NKNCSjyCsuDbJcSrRW4kG2atu4SW6sTJkx4o to NKNVmZQZcDrgdMJKdgRfz2gn5ZdTAyro5uHm. txHash: 61c8035b27b8232faad2adf641922dea09d4e925e4e5230d73c9a55ae8917549

Example with age encryption

Install age

Refer to https://github.com/FiloSottile/age to see how to install age.

Create a new age identity

~ $ cd /tmp/
/tmp $ age-keygen > ident1
age-keygen: warning: writing secret key to a world-readable file
Public key: age1f2fcrl2l5swmd4nquukwhh7kd8qz579usp74ee4t7gm068wqpgjqwnuldf

Create another one for demonstration purposes

/tmp $ age-keygen > ident2
age-keygen: warning: writing secret key to a world-readable file
Public key: age1pklphvwtf6sfedu4seth44vepy597tesc4e82zsh536lj58ggp4szg25p3
/tmp $

Use newly created age identity as a recipient for new wallet

$ go run main.go create -r age1f2fcrl2l5swmd4nquukwhh7kd8qz579usp74ee4t7gm068wqpgjqwnuldf -s
Account information:
ID: 1
Address: NKNEtSx32P6AnhSjdaWujE98sKZHFm2iHPSv
Seed: 947c34c358c9157aa01e9f46d1af613ac9aed0912644fe55e9391184802d9063
Account saved successfully.

$ go run main.go create -r age1pklphvwtf6sfedu4seth44vepy597tesc4e82zsh536lj58ggp4szg25p3 -s
Account information:
ID: 2
Address: NKNYzaG8M6VcBcbSyUPgak46TQRCav8LzGfQ
Seed: 405ef86b621ebb7a3bab1de127a203778366b5abee445aaf5d40cbc7322b1c05
Account saved successfully.

Now we have to accounts in the wallet. Each encrypted to the recipients above

$ go run main.go list
 ID │ ALIAS │ ADDRESS
────┼───────┼──────────────────────────────────────
  1 │       │ NKNEtSx32P6AnhSjdaWujE98sKZHFm2iHPSv
  2 │       │ NKNYzaG8M6VcBcbSyUPgak46TQRCav8LzGfQ

Access to account will only work with identity file

$ go run main.go show info --index 1
Error: Wallet is not an scrypt type. Use an identity file to decrypt it.
exit status 1

$ go run main.go show info --index 1 -i /tmp/ident2
Error: no identity matched any of the recipients
exit status 1

$ go run main.go show info --index 1 -i /tmp/ident1
 ID │ ALIAS │ ADDRESS                              │ PUBKEY                                                           │ SEED
────┼───────┼──────────────────────────────────────┼──────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────
  1 │       │ NKNEtSx32P6AnhSjdaWujE98sKZHFm2iHPSv │ 8a16c717629980ed7fcf93f4430300b65f1645a83020d97d9615539b5a08a499 │ 947c34c358c9157aa01e9f46d1af613ac9aed0912644fe55e9391184802d9063

Example using SSH Keys

Create new account with SSH public key file as recipient

go run main.go create -R ~/.ssh/id_ed25519.pub -s
Account information:
ID: 1
Address: NKNTNxHR3NRFHT3RGbjjwkKQzWVYF3cfraSR
Seed: bb54ec61a42a9b1dd213a0a2e613576c17590c429c79621c6bccfc0e97d93092
Account saved successfully.

Access to account will only work with SSH private key

go run main.go show info --index 1
Error: Wallet is not an scrypt type. Use an identity file to decrypt it.
exit status 1

go run main.go show info --index 1 -i ~/.ssh/id_ed25519
1
 ID │ ALIAS │ ADDRESS                              │ PUBKEY                                                           │ SEED                                   
────┼───────┼──────────────────────────────────────┼──────────────────────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────
  1 │       │ NKNTNxHR3NRFHT3RGbjjwkKQzWVYF3cfraSR │ 101905457c9e798d5e04fb350779d79999c4f3a9297dcdcf803d182d11ddaf17 │ bb54ec61a42a9b1dd213a0a2e613576c17590c429c79621c6bccfc0e97d93092

For information refer to the help menu with nkn-wallet help or nkn-wallet [cmd] help.

File Format

The file format of the wallet looks like this:

  ...
  {
    "id": 5,
    "address": "NKNRdA5G8U5kSQ68Q5beeAuzGfvp2vEiRzEr",
    "armor": "-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IHNjcnlwdCBqWjFpT01iV2g0VzZ6aW9L\nM21tajZnIDE4Cm1BZFNnNjhzdWR4NGQzUUR6TzBKV2xSOVJFZXl4ZW1oVDZJZWdh\nSzhtRWMKLS0tIHRBSlp0ZkdKaWNHamd4b1Vab250WFF3TTFxVThXUFFyUVQxRDRy\nWGNqQTgK7M8ZKYVVvQGP0LEKwiEO9lN0mTK3MUjnO4X98nEerJOh+kJZnziJPkxL\nxrKvpsGOCurMSkuTLbU10NlQfuc6Bv1oHSYP1+GYcmwrvJgI/6B00atlHGY/jmeb\nMRo5D1mJBxhhgdWe3udvjMB264k46R/oIGKkxeCC5nA/eLToqvplb0qDv6FMapDe\nScrKSg50eNuaoe3yWxZlP8bS1RsPDJtIgJ+cTE0B66xt6G8rLQX80B4xp72AzHnh\nXn182U0+2i5PjYIpFZsoKdIKTD4eXXDF0aH8BfpYm0bHHM32vRS2rW3pCYz0mF35\nBzBHCel5A3kXhksSCgze7w==\n-----END AGE ENCRYPTED FILE-----\n",
    "alias": "personal"
  },
  {
    "id": 7,
    "address": "NKNHyoTeS3XEWFfEMuBXGKi16RP6rSqjr3bU",
    "armor": "-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IHNjcnlwdCA2YkZDbmlrN3J6QkpIK0xE\naXNEcDlnIDE4Cnp0KzFOeWNQRmM5MjYzajI2L3NzK3RaeFY2WWZNd2YyTzNLRWJH\na0o1dTgKLS0tIHFNdTFTc0pXUVMrdVVLSjlsREU1RkdJamMrWit2cXVoZjVvdzNI\naDZQVlUKVzxvmCI4A9+tVmEzKnTADJ1T2yAVoWQ8pUJ7yuPXOR3Kf1VPc+iwGMsF\n5Tdoom46Ii/VtBG8DPpFVNflehqdS5zAqjvB3UQO9qtUR1ZRL2goG20UtVbrS0Np\nWHEgi/gr+QZho6rYd9wr1M691rbDrOSgzQUNEdALczrwe/SBFDXGMPGRlGP5SAyP\nX/ZhQaYO6QTwdjnpbEzYsZ+OoijyAT9052RDhQwtCYKuZ4p4NxITmFM6TAdgfo3P\nR5XHKHVzGY/JLsqFQcp1nMGPy5XNghnDvxk+v/TqA6BEe4qn4YoloZ5cFjvmf4Xp\n1Mem0tXgEHxIt8rO4enQNg==\n-----END AGE ENCRYPTED FILE-----\n",
    "alias": "github-donations"
  },
  {
    "id": 8,
    "address": "NKNKQ34u5DeSxfi5VN1HDtG9iuQdhmsxAx7m",
    "armor": "-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IHNjcnlwdCBjbTRUK3Z2N2xLWCtnQk1W\nVjlaVEdRIDE4CmNkYm9DVThDRFNVdE53elhSK0l3b2F0SFpqdUxNbVY0OEFDdmd4\nZ0FlSHMKLS0tIHFIaVRmZVBCUDhOWUJVZjlJUE9KU2F5clpvejMrM2tuakVJUTJQ\nRENjU0kK1ov/aEbZzd+WUV+i47MpGR0LdhNWBXewUjwSrqIPH8xGsm8hwmvs/j5v\nGTSO9ndzzFdizU93zhvsXoQIZmzkm5OvTRXCj6IUj/B0UlCtcUHkcvUFK9KJQ7Uc\nuUVpxazelIDCg5Oi3+tGrT45KqKYiwnYwPKbk5zj7nVNvOVEST15m2MjPM4cWq9W\ny17jdKrHekeIOvXGiLau3ZGEUh7Z9XtJh9BAI20lN9upMrpQYZzn9vuKQZByznI5\n5ge3CbAs9F8ldD4TocSbg8vabQ3iQwPanxZQZiXrn6u4+fQJnXaw/LXUpJITg0Az\n7gX1fz/Ea6FVyk+ZggB3Ig==\n-----END AGE ENCRYPTED FILE-----\n",
    "alias": "office"
  },
  ...

The age encryption is stored as an armor in the armor field. the associated NKN address, id and alias are cleartext.

The base64 decoded armor looks like this:

$ echo "YWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IHNjcnlwdCBqWjFpT01iV2g0VzZ6aW9L
M21tajZnIDE4Cm1BZFNnNjhzdWR4NGQzUUR6TzBKV2xSOVJFZXl4ZW1oVDZJZWdh
SzhtRWMKLS0tIHRBSlp0ZkdKaWNHamd4b1Vab250WFF3TTFxVThXUFFyUVQxRDRy
WGNqQTgK7M8ZKYVVvQGP0LEKwiEO9lN0mTK3MUjnO4X98nEerJOh+kJZnziJPkxL
xrKvpsGOCurMSkuTLbU10NlQfuc6Bv1oHSYP1+GYcmwrvJgI/6B00atlHGY/jmeb
MRo5D1mJBxhhgdWe3udvjMB264k46R/oIGKkxeCC5nA/eLToqvplb0qDv6FMapDe
ScrKSg50eNuaoe3yWxZlP8bS1RsPDJtIgJ+cTE0B66xt6G8rLQX80B4xp72AzHnh
Xn182U0+2i5PjYIpFZsoKdIKTD4eXXDF0aH8BfpYm0bHHM32vRS2rW3pCYz0mF35
BzBHCel5A3kXhksSCgze7w==" | base64 -d

age-encryption.org/v1
-> scrypt jZ1iOMbWh4W6zioK3mmj6g 18
mAdSg68sudx4d3QDzO0JWlR9REeyxemhT6IegaK8mEc
--- tAJZtfGJicGjgxoUZontXQwM1qU8WPQrQT1D4rXcjA8
)Uб
!St21H;qBY8>LKƲ
JK-5P~:h&rltѫef?g19Ya՞ov8 bp?xeoJLjIJtxۚ[e?
                                          LMmo+-1y^}|M>.O)()
L>]pXFm ]0G     yyK

Contribution

You can fork this, extend it and contribute back.
You can contribute with pull requests.

Donations

I accept payments and donations in BTC:

bc1qgezvfp4s0xme8pdv6aaqu9ayfgnv4mejdlv3tx

LICENSE

MIT License

Documentation ¶

Index ¶

type EncryptedIdentity
- func (i *EncryptedIdentity) Recipients() ([]age.Recipient, error)
- func (i *EncryptedIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error)
type LazyScryptIdentity
- func (i *LazyScryptIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error)
type Openapi
- func (o *Openapi) GetBalance() (common.Fixed64, error)
- func (o *Openapi) GetTransactions() (*client.ResponseGetAddressTransaction, error)
type PasswordEncryptScryptIdentity
- func (i *PasswordEncryptScryptIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error)
type Store
- func NewStore(path string) (*Store, error)
type Wallet

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type EncryptedIdentity ¶

type EncryptedIdentity struct {
	Contents       []byte
	Passphrase     func() (string, error)
	NoMatchWarning func()
	// contains filtered or unexported fields
}

func (*EncryptedIdentity) Recipients ¶

func (i *EncryptedIdentity) Recipients() ([]age.Recipient, error)

func (*EncryptedIdentity) Unwrap ¶

func (i *EncryptedIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error)

type LazyScryptIdentity ¶

type LazyScryptIdentity struct {
	Passphrase func() (string, error)
}

LazyScryptIdentity is an age.Identity that requests a passphrase only if it encounters an scrypt stanza. After obtaining a passphrase, it delegates to ScryptIdentity.

func (*LazyScryptIdentity) Unwrap ¶

func (i *LazyScryptIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error)

type Openapi ¶

type Openapi struct {
	// contains filtered or unexported fields
}

func (*Openapi) GetBalance ¶

func (o *Openapi) GetBalance() (common.Fixed64, error)

func (*Openapi) GetTransactions ¶

func (o *Openapi) GetTransactions() (*client.ResponseGetAddressTransaction, error)

type PasswordEncryptScryptIdentity ¶

type PasswordEncryptScryptIdentity struct {
	// contains filtered or unexported fields
}

func (*PasswordEncryptScryptIdentity) Unwrap ¶

func (i *PasswordEncryptScryptIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error)

Unwrap unwraps given password and delegates it to NewScriptIdentity()

type Store ¶

type Store struct {
	// contains filtered or unexported fields
}

func NewStore ¶

func NewStore(path string) (*Store, error)

func (*Store) DeleteWalletByIndex ¶

func (s *Store) DeleteWalletByIndex(index int)

func (*Store) GetWalletByIndex ¶

func (s *Store) GetWalletByIndex(index int) (*Wallet, error)

func (*Store) GetWallets ¶

func (s *Store) GetWallets() []*Wallet

func (*Store) IsExistWalletByAlias ¶

func (s *Store) IsExistWalletByAlias(alias string) bool

func (*Store) IsExistWalletByIndex ¶

func (s *Store) IsExistWalletByIndex(index int) bool

func (*Store) ListWallets ¶

func (s *Store) ListWallets() error

func (*Store) NewWalletByIdentity ¶

func (s *Store) NewWalletByIdentity(identity string, index int, config *nkn.WalletConfig) (*Wallet, error)

func (*Store) NewWalletByPassword ¶

func (s *Store) NewWalletByPassword(index int, config *nkn.WalletConfig) (*Wallet, error)

func (*Store) NewWalletByRecipient ¶

func (s *Store) NewWalletByRecipient(recipient string, index int, config *nkn.WalletConfig) (*Wallet, error)

func (*Store) NewWalletByRecipientFile ¶

func (s *Store) NewWalletByRecipientFile(file string, index int, config *nkn.WalletConfig) (*Wallet, error)

func (*Store) ParseIdentity ¶

func (s *Store) ParseIdentity(identity string) ([]age.Recipient, error)

func (*Store) ParseRecipient ¶

func (s *Store) ParseRecipient(recipient string) ([]age.Recipient, error)

func (*Store) ParseRecipientFile ¶

func (s *Store) ParseRecipientFile(file string) ([]age.Recipient, error)

func (*Store) PromptPassword ¶

func (s *Store) PromptPassword(create bool) (string, error)

func (*Store) RestoreFromSeedByIdentity ¶

func (s *Store) RestoreFromSeedByIdentity(seed []byte, identity string) (*Wallet, error)

func (*Store) RestoreFromSeedByPassword ¶

func (s *Store) RestoreFromSeedByPassword(seed []byte) (*Wallet, error)

func (*Store) SaveWallet ¶

func (s *Store) SaveWallet(wallet *Wallet) error

func (*Store) SetAlias ¶

func (s *Store) SetAlias(wallet *Wallet, alias string) error

func (*Store) SetName ¶

func (s *Store) SetName(index int, alias string)

func (*Store) SetPassword ¶

func (s *Store) SetPassword(wallet *Wallet) error

type Wallet ¶

type Wallet struct {
	ID         int    `json:"id"`
	Type       string `json:"type"`
	NKNAddress string `json:"address"`
	Armor      string `json:"armor"`
	Alias      string `json:"alias,omitempty"`
	// contains filtered or unexported fields
}

func (*Wallet) Account ¶

func (w *Wallet) Account() *nkn.Account

Account returns the account of the wallet.

func (*Wallet) Address ¶

func (w *Wallet) Address() string

Address returns the NKN wallet address of the wallet.

func (*Wallet) Balance ¶

func (w *Wallet) Balance() (*nkn.Amount, error)

Balance wraps BalanceContext with background context.

func (*Wallet) BalanceByAddress ¶

func (w *Wallet) BalanceByAddress(address string) (*nkn.Amount, error)

BalanceByAddress wraps BalanceByAddressContext with background context.

func (*Wallet) BalanceByAddressContext ¶

func (w *Wallet) BalanceByAddressContext(ctx context.Context, address string) (*nkn.Amount, error)

BalanceByAddressContext is the same as package level GetBalanceContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) BalanceContext ¶

func (w *Wallet) BalanceContext(ctx context.Context) (*nkn.Amount, error)

BalanceContext is the same as package level GetBalanceContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) DeleteName ¶

func (w *Wallet) DeleteName(name string, config *nkn.TransactionConfig) (string, error)

DeleteName wraps DeleteNameContext with background context.

func (*Wallet) DeleteNameContext ¶

func (w *Wallet) DeleteNameContext(ctx context.Context, name string, config *nkn.TransactionConfig) (string, error)

DeleteNameContext is a shortcut for DeleteNameContext using this wallet as SignerRPCClient.

func (*Wallet) GetHeight ¶

func (w *Wallet) GetHeight() (int32, error)

GetHeight wraps GetHeightContext with background context.

func (*Wallet) GetHeightContext ¶

func (w *Wallet) GetHeightContext(ctx context.Context) (int32, error)

GetHeightContext is the same as package level GetHeightContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) GetNonce ¶

func (w *Wallet) GetNonce(txPool bool) (int64, error)

GetNonce wraps GetNonceContext with background context.

func (*Wallet) GetNonceByAddress ¶

func (w *Wallet) GetNonceByAddress(address string, txPool bool) (int64, error)

GetNonceByAddress wraps GetNonceByAddressContext with background context.

func (*Wallet) GetNonceByAddressContext ¶

func (w *Wallet) GetNonceByAddressContext(ctx context.Context, address string, txPool bool) (int64, error)

GetNonceByAddressContext is the same as package level GetNonceContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) GetNonceContext ¶

func (w *Wallet) GetNonceContext(ctx context.Context, txPool bool) (int64, error)

GetNonceContext is the same as package level GetNonceContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) GetRegistrant ¶

func (w *Wallet) GetRegistrant(name string) (*nkn.Registrant, error)

GetRegistrant wraps GetRegistrantContext with background context.

func (*Wallet) GetRegistrantContext ¶

func (w *Wallet) GetRegistrantContext(ctx context.Context, name string) (*nkn.Registrant, error)

GetRegistrantContext is the same as package level GetRegistrantContext, but this wallet's SeedRPCServerAddr.

func (*Wallet) GetSubscribers ¶

func (w *Wallet) GetSubscribers(topic string, offset, limit int, meta, txPool bool, subscriberHashPrefix []byte) (*nkn.Subscribers, error)

GetSubscribers wraps GetSubscribersContext with background context.

func (*Wallet) GetSubscribersContext ¶

func (w *Wallet) GetSubscribersContext(ctx context.Context, topic string, offset, limit int, meta, txPool bool, subscriberHashPrefix []byte) (*nkn.Subscribers, error)

GetSubscribersContext is the same as package level GetSubscribersContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) GetSubscribersCount ¶

func (w *Wallet) GetSubscribersCount(topic string, subscriberHashPrefix []byte) (int, error)

GetSubscribersCount wraps GetSubscribersCountContext with background context.

func (*Wallet) GetSubscribersCountContext ¶

func (w *Wallet) GetSubscribersCountContext(ctx context.Context, topic string, subscriberHashPrefix []byte) (int, error)

GetSubscribersCountContext is the same as package level GetSubscribersCountContext, but this wallet's SeedRPCServerAddr.

func (*Wallet) GetSubscription ¶

func (w *Wallet) GetSubscription(topic string, subscriber string) (*nkn.Subscription, error)

GetSubscription wraps GetSubscriptionContext with background context.

func (*Wallet) GetSubscriptionContext ¶

func (w *Wallet) GetSubscriptionContext(ctx context.Context, topic string, subscriber string) (*nkn.Subscription, error)

GetSubscriptionContext is the same as package level GetSubscriptionContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) NewNanoPay ¶

func (w *Wallet) NewNanoPay(recipientAddress, fee string, duration int) (*nkn.NanoPay, error)

NewNanoPay is a shortcut for NewNanoPay using this wallet as sender.

Duration is changed to signed int for gomobile compatibility.

func (*Wallet) NewNanoPayClaimer ¶

func (w *Wallet) NewNanoPayClaimer(recipientAddress string, claimIntervalMs, lingerMs int32, minFlushAmount string, onError *nkn.OnError) (*nkn.NanoPayClaimer, error)

NewNanoPayClaimer is a shortcut for NewNanoPayClaimer using this wallet as RPC client.

func (*Wallet) OpenAPI ¶

func (w *Wallet) OpenAPI() *Openapi

func (*Wallet) ProgramHash ¶

func (w *Wallet) ProgramHash() common.Uint160

ProgramHash returns the program hash of this wallet's account.

func (*Wallet) PubKey ¶

func (w *Wallet) PubKey() []byte

PubKey returns the public key of the wallet.

func (*Wallet) RegisterName ¶

func (w *Wallet) RegisterName(name string, config *nkn.TransactionConfig) (string, error)

RegisterName wraps RegisterNameContext with background context.

func (*Wallet) RegisterNameContext ¶

func (w *Wallet) RegisterNameContext(ctx context.Context, name string, config *nkn.TransactionConfig) (string, error)

RegisterNameContext is a shortcut for RegisterNameContext using this wallet as SignerRPCClient.

func (*Wallet) Seed ¶

func (w *Wallet) Seed() []byte

Seed returns the secret seed of the wallet. Secret seed can be used to create client/wallet with the same key pair and should be kept secret and safe.

func (*Wallet) SendRawTransaction ¶

func (w *Wallet) SendRawTransaction(txn *transaction.Transaction) (string, error)

SendRawTransaction wraps SendRawTransactionContext with background context.

func (*Wallet) SendRawTransactionContext ¶

func (w *Wallet) SendRawTransactionContext(ctx context.Context, txn *transaction.Transaction) (string, error)

SendRawTransactionContext is the same as package level SendRawTransactionContext, but using this wallet's SeedRPCServerAddr.

func (*Wallet) ShowSeed ¶

func (w *Wallet) ShowSeed() string

func (*Wallet) SignTransaction ¶

func (w *Wallet) SignTransaction(tx *transaction.Transaction) error

SignTransaction signs an unsigned transaction using this wallet's key pair.

func (w *Wallet) Subscribe(identifier, topic string, duration int, meta string, config *nkn.TransactionConfig) (string, error)

Subscribe wraps SubscribeContext with background context.

func (*Wallet) SubscribeContext ¶

func (w *Wallet) SubscribeContext(ctx context.Context, identifier, topic string, duration int, meta string, config *nkn.TransactionConfig) (string, error)

SubscribeContext is a shortcut for SubscribeContext using this wallet as SignerRPCClient.

Duration is changed to signed int for gomobile compatibility.

func (*Wallet) Transfer ¶

func (w *Wallet) Transfer(address, amount string, config *nkn.TransactionConfig) (string, error)

Transfer wraps TransferContext with background context.

func (*Wallet) TransferContext ¶

func (w *Wallet) TransferContext(ctx context.Context, address, amount string, config *nkn.TransactionConfig) (string, error)

TransferContext is a shortcut for TransferContext using this wallet as SignerRPCClient.

func (*Wallet) TransferName ¶

func (w *Wallet) TransferName(name string, recipientPubKey []byte, config *nkn.TransactionConfig) (string, error)

TransferName wraps TransferNameContext with background context.

func (*Wallet) TransferNameContext ¶

func (w *Wallet) TransferNameContext(ctx context.Context, name string, recipientPubKey []byte, config *nkn.TransactionConfig) (string, error)

TransferNameContext is a shortcut for TransferNameContext using this wallet as SignerRPCClient.

func (*Wallet) Unsubscribe ¶

func (w *Wallet) Unsubscribe(identifier, topic string, config *nkn.TransactionConfig) (string, error)

Unsubscribe wraps UnsubscribeContext with background context.

func (*Wallet) UnsubscribeContext ¶

func (w *Wallet) UnsubscribeContext(ctx context.Context, identifier, topic string, config *nkn.TransactionConfig) (string, error)

UnsubscribeContext is a shortcut for UnsubscribeContext using this wallet as SignerRPCClient.

func (*Wallet) VerifyPassword ¶

func (w *Wallet) VerifyPassword(password []byte) error

VerifyPassword returns nil if provided password is the correct password of account

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
nkn-wallet
nkn-wallet/commands

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL