cosmos-lib

1.1.0 • Public • Published

Cosmos Lib

JS implementation of Cosmos cryptography and addresses logic.

Features:

  • Generate private/public key from mnemonic and path.
  • Sign/verify bytes/JSON with private/public key.s
  • Convert Cosmos bech32 address to bytes32 (solidity capability).

Installation

Install dependency:

yarn add cosmos-lib

And use in code:

const cosmos = require('cosmos-lib');

Usage

Generate private/public key from mnemonic:

const MNEMONIC = 'cluster unveil differ bright define prosper hunt warrior fetch rough host fringe worry mention gospel enlist elder laugh segment funny avoid regular market fortune';
 
const keys = cosmos.crypto.getKeysFromMnemonic(MNEMONIC);
console.log(keys.publicKey, keys.privateKey);

Sign bytes/JSON:

const bytes = crypto.randomBytes(12);
const json  = {
    data: crypto.randomBytes(128)
};
 
let signature = cosmos.crypto.sign(bytes, keys.privateKey);
let verify    = cosmos.crypto.verify(bytes, signature, keys.publicKey);
 
if (!verify) {
    throw 'Cant verify signature';
}
 
signature = cosmos.crypto.signJson(json, keys.privateKey);
verify = cosmos.crypto.verifyJson(json, signature, keys.publicKey);
 
if (!verify) {
    throw 'Cant verify signature';
}

Get address from public key:

const prefix = 'mywallet';
const address = cosmos.address.getAddress(keys.publicKey, prefix); // prefix by default is 'cosmos'.
console.log(address);

Get bytes32 from address:

bytes32 = cosmos.address.getBytes32(address);
console.log(bytes32.toString('hex'));

More examples could be found in tests.

Docs

To generate docs:

yarn global add jsdoc
yarn run docs

Then server them from out directory.

Tests

To run tests:

git clone git@github.com:WingsDao/cosmos-lib.git
cd cosmos-lib/
yarn install
yarn test

LICENSE

MIT.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.1.0
    60
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.1.0
    60
  • 1.0.4
    0

Package Sidebar

Install

npm i cosmos-lib

Weekly Downloads

60

Version

1.1.0

License

MIT

Unpacked Size

12.5 kB

Total Files

8

Last publish

Collaborators

  • boris_wings