JavaScript implementation of NKN client.
Send and receive data between any NKN clients without setting up a server.
Note: This is a client version of the NKN protocol, which can send and receive data but not relay data (mining). For node implementation which can mine NKN token by relaying data, please refer to nkn.
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.
For npm:
npm install nkn-clientAnd then in your code:
const nkn = require('nkn-client');For browser, use dist/nkn.js or dist/nkn.min.js.
Create a client with a generated key pair:
const client = nkn();Or with an identifier (used to distinguish different clients sharing the same key pair):
const client = nkn({
identifier: 'any string',
});Get client key pair:
console.log(client.key.privateKey, client.key.publicKey);Create a client using an existing private key:
const client = nkn({
identifier: 'any string',
privateKey: 'cd5fa29ed5b0e951f3d1bce5997458706186320f1dd89156a73d54ed752a7f37',
});By default the client will use bootstrap RPC server (for getting node address) provided by us. Any NKN full node can serve as a bootstrap RPC server. To create a client using customized bootstrap RPC server:
const client = nkn({
identifier: 'any string',
seedRpcServerAddr: 'https://xxx',
});Private key should be kept SECRET! Never put it in version control system like here.
Get client identifier:
console.log(client.identifier);And client NKN address, which is used to receive data from other clients:
console.log(client.addr);Listen for connection established:
client.on('connect', () => {
console.log('Connection opened.');
});Send data to other clients:
client.send(
'another client address',
'some message',
);Receive data from other clients:
client.on('message', (src, payload) => {
console.log(src, payload);
});Check examples for full examples.
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