nkn-wallet-js

JavaScript implementation of NKN wallet.

Note: This repository is in the early development stage and may not have all functions working properly. It should be used only for testing now.

Install

For npm:

npm install nkn-wallet

And then in your code:

const nknWallet = require('nkn-wallet');

For browser, use dist/nkn-wallet.js or dist/nkn-wallet.min.js.

Usage

import

const nknWallet = require('nkn-wallet');

create a new wallet

const wallet = nknWallet.newWallet('pwd')

get wallet's json string

const walletJson = wallet.toJSON()

load wallet from a wallet json string

const walletFromJson = nknWallet.loadJsonWallet(walletJson, 'pwd')

restore wallet from a private key

const walletFromPrivateKey = nknWallet.restoreWalletByPrivateKey('the private key', 'new-wallet-password')

query asset balance for this wallet

wallet.queryAssetBalance().then(function(value) {
  console.log('asset balance for this wallet is: ', value.toString())
}).catch(function(error) {
  console.log('query balance fail: ', error)
})

transfer asset to some address

wallet.transferTo(wallet.address, 100, 'pwd').then(function(data) {
  console.log('success: ', data)
}).catch(function(error) {
  console.log('fail: ', error)
})

wallet.registerName('somename', 'pwd').then(function(data) {
  console.log('success: ', data)
}).catch(function(error) {
  console.log('fail: ', error)
})

delete name for this wallet

wallet.deleteName('somename', 'pwd').then(function(data) {
  console.log('success: ', data)
}).catch(function(error) {
  console.log('fail: ', error)
})

subscribe to bucket 0 of specified topic for this wallet for next 10 blocks (publish is done through nkn-client-js)

wallet.subscribe('topic', 0, 10, 'pwd', 'identifier').then(function(data) {
  console.log('success: ', data)
}).catch(function(error) {
  console.log('fail: ', error)
})

Check examples for full examples.

Configure

NKN wallet only stores some static information such as encrypted private keys, addresses and so on. All dynamic information needs to be queried from a NKN node. By default it will try to use RPC server provided by us, but you can change it (together with NKN token ID) by calling the global configure function:

nknWallet.configure({
  rpcAddr: 'http://127.0.0.1:30003',
})

Note that configure is optional. If you don't call configure(), default configurations will be used.

API

nknWallet

/***
 * global configuration:
 * {
 *  assetId: '',  // the NKN Token id, default value: 4945ca009174097e6614d306b66e1f9cb1fce586cb857729be9e1c5cc04c9c02
 *  rpcAddr:'',   // node addr for dynamic information query, default value: http://cluster2-oregon.nkn.org:30003
 * }
 *
 * @param config | Object
 */
nknWallet.configure(config)

/**
 * create a new wallet
 * @param password : string : the password to encrypt wallet
 * @returns {NknWallet} : a NknWallet instance
 */
nknWallet.newWallet(password)

/***
 * load wallet from json string
 * @param walletJson : string : a json format wallet
 * @param password : string : password for this wallet
 * @returns {NknWallet | null} : return NknWallet instance or null if key information is missing.
 *
 * !this method will thow an error if the password is wrong!
 */
nknWallet.loadJsonWallet(walletJson, password)

/***
 * restore a wallet from private key
 * @param privateKey : string : the private key for wallet restore
 * @param password : string : password for new wallet
 * @returns {NknWallet} : a NknWallet instance
 */
nknWallet.restoreWalletByPrivateKey(privateKey, password)

NknWallet

All of the following methods are instance methods

/***
 * generate wallet json
 * @returns {string} : wallet json
 */
toJSON()

/***
 * get the public key of this wallet
 * @returns {string} : the public key of this wallet
 */
getPublicKey()

/***
 * get the private key of this wallet
 * @returns {string} : the private key of this wallet
 *
 * !!! anyone with the private key has the power to restore a full-featured wallet !!!!
 */
getPrivateKey()

/***
 * transfer nkn to some valid address
 * @param toAddress : string : valid nkn address
 * @param value : number : value for transfer
 * @param password : string : wallet password
 *
 * !!! the fail function will be called for any transfer errors  
 *     and the parameter applied is a WalletError instance. !!!
  */
transferTo(toAddress, value, password)

/***
 * register name on nkn for current wallet
 * @param name : string : name to register
 * @param password : string : wallet password
 *
 * !!! the fail function will be called for any register errors  
 *     and the parameter applied is a WalletError instance. !!!
  */
registerName(name, password)

/***
 * delete name on nkn for current wallet
 * @param name : string : name to delete
 * @param password : string : wallet password
 *
 * !!! the fail function will be called for any delete errors  
 *     and the parameter applied is a WalletError instance. !!!
  */
deleteName(name, password)

/***
 * subscribe to topic on nkn for current wallet
 * @param topic : string : topic to subscribe to
 * @param bucket : number : bucket of topic to subscribe to
 * @param duration : number : subscription duration
 * @param password : string : wallet password
 * @param identifier : string : optional identifier
 *
 * !!! the fail function will be called for any register errors  
 *     and the parameter applied is a WalletError instance. !!!
  */
subscribe(topic, bucket, duration, password, identifier = '')

/***
 * query asset balance
 * @returns {promise} : if resolved, the parameter is a decimal.js instance
 */
queryAssetBalance()

/***
 * recharge the prepaid balance
 * @param value : number : how much NKN you want to prepay
 * @param rates : number : how much NKN you want to pay for one data transfer
 * @param password : string : password for this wallet
 */
prepay(value, rates, password)

/***
 * query the prepay balance
 * @returns {promise} : if resolved, the data's will be an object like this {Amount: string, Rates: string}
 */
queryPrepaiedInfo()

Contributing

Can I submit a bug, suggestion or feature request?

Yes. Please open an issue for that.

Can I contribute patches?

Yes, we appreciate your help! To make contributions, please fork the repo, push your changes to the forked repo with signed-off commits, and open a pull request here.

Please sign off your commit. This means adding a line "Signed-off-by: Name " at the end of each commit, indicating that you wrote the code and have the right to pass it on as an open source patch. This can be done automatically by adding -s when committing:

git commit -s

AKACoder/nkn-wallet-js

nkn-wallet-js

Install

Usage

Configure

API

Contributing

Community