codechain-io / codechain-keystore-js Goto Github PK

View Code? Open in Web Editor NEW

14.0 9.0 8.0 193 KB

A private key management library for CodeChain

Home Page: https://www.npmjs.com/package/codechain-keystore

License: ISC License

TypeScript 99.53% JavaScript 0.47%

codechain keystore

codechain-keystore-js's Introduction

CodeChain keystore

CodeChain keystore is a private key management library. It saves CodeChain's asset transfer address safely in a disk. If you want to manage CodeChain keys using nodejs, you should use this.

Example

var CCKey = require('codechain-keystore');

async function example() {
  const cckey = await CCKey.create();
  const savedKeys = await cckey.platform.getKeys();
  console.dir(savedKeys);
  await cckey.platform.createKey({ passphrase: "my password" });
  const savedKeys_ = await cckey.platform.getKeys();
  console.dir(savedKeys_);

  await cckey.close();
};
example();

How your private key is saved

We use a JSON file to save an encrypted private key. You can find the file in ./keystore.db

codechain-keystore-js's People

Contributors

Stargazers

Watchers

Forkers

majecty kseo sgkim126 joojis hyunsikjeong baumstern hoongee kkc90

codechain-keystore-js's Issues

Update codechain-keystore and add migrate.

CodeChain keystore changes its data format at 0.5.0.
We should apply it add provide migrate feature to users.

hdwseed.getPublicKeyFromSeed function requires passphrase argument even though the field is optional

Why is secret stringified when stored?

Currently, the keystore format looks like a below. I can't find a reason to stringify the secret field.

{
  "platform_keys": [
    {
      "secret": "{\"crypto\":{\"ciphertext\":\"e5bc2edb24c39ca7ab93797de1c69bff4bc10116307a4c709fa03964cb1f05c9\",\"cipherparams\":{\"iv\":\"f95cc95d42f23d3dc23fd806e0dda5b4\"},\"cipher\":\"aes-128-ctr\",\"kdf\":\"pbkdf2\",\"kdfparams\":{\"dklen\":32,\"salt\":\"fad7cf1a0bb90752a7c8670b192f7257c6d16807e1290cf8915fd09d5dd47ab5\",\"c\":262144,\"prf\":\"hmac-sha256\"},\"mac\":\"9af7457f7eb41537182bcdc704471f3f08e6ea5ee6af15e8df63f93920b7ee2c\"},\"id\":\"e4fa910b-b6ea-411b-9e34-cde4241beb94\",\"version\":3}",
      "publicKey": "b1d9d3079416c50a1ed51b9a7b6bfe5966a158a4b65d9a51472134cba26ca7ff00bbc7a76c023b879a2abac199c9b7d9fb5fbb25bc31850d06dfa9362f68d8f7"
    }
  ],
  "asset_keys": [],
  "mapping": {
    "09880ce815b65b3f73a1ffad14e3fb6bbee7f380": "b1d9d3079416c50a1ed51b9a7b6bfe5966a158a4b65d9a51472134cba26ca7ff00bbc7a76c023b879a2abac199c9b7d9fb5fbb25bc31850d06dfa9362f68d8f7"
  }
}

need more contents in readme

Unlike codechain-primitives-js,
keystore readme lacks installing package, API functions and how to test(yarn test).

Exclude yarn.lock

codechain-keystore should not include yarn.lock file in the repo because it is a library.

tsfmt fails

$ tsfmt
Error: Invalid "extends" configuration value - could not require "tslint-config-prettier". Review the Node lookup algorithm (https://nodejs.org/api/modules.html#modules_all_together) for the approximate method TSLint uses to find the referenced configuration file.
    at resolveConfigurationPath (/usr/local/lib/node_modules/tslint/lib/configuration.js:223:19)
    at loadExtendsRecursive (/usr/local/lib/node_modules/tslint/lib/configuration.js:414:32)
    at parseConfigFile (/usr/local/lib/node_modules/tslint/lib/configuration.js:403:12)
    at Object.loadConfigurationFromPath (/usr/local/lib/node_modules/tslint/lib/configuration.js:161:16)
    at /usr/local/lib/node_modules/typescript-formatter/lib/provider/tslintjson.js:134:43
    at step (/usr/local/lib/node_modules/typescript-formatter/lib/provider/tslintjson.js:32:23)
    at Object.next (/usr/local/lib/node_modules/typescript-formatter/lib/provider/tslintjson.js:13:53)
    at fulfilled (/usr/local/lib/node_modules/typescript-formatter/lib/provider/tslintjson.js:4:58)

Rename KeyNotExist to NoSuchKey

Global keystore.db

keystore.db is currently located in $PWD. It is little bit awkward for CLIs.

Boto uses AWS CLI configurations located in ~/.aws/, and it is overridable.
Link: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html

Git config also has a good convention. It uses several configuration files, from repository local to user global, and system-wise.
Link: https://git-scm.com/docs/git-config#FILES

Add a new storage adapter that uses a session storage

Intergrate Travis CI

Introduce HD wallets

Introduce HD(Hierarchical Deterministic) Wallets.

Library to use

bitcore-lib

To-do

Master Key Generation

In BIP-0032, master key generation is defined as:

Generate a seed byte sequence S of a chosen length (between 128 and 512 bits; 256 bits is advised) from a (P)RNG.
Calculate I = HMAC-SHA512(Key = "Bitcoin seed", Data = S)
Split I into two 32-byte sequences, I_L and I_R.
Use parse₂₅₆(I_L) as master secret key, and I_R as master chain code.
In case I_L is 0 or ≥n, the master key is invalid.

CodeChain may use a different key instead of "Bitcoin seed".

Path levels

This will follow BIP 0044:

m / purpose' / coin_type' / account' / change / address_index

purpose is 44, as BIP 0043.
coin_types vary by coins, and SLIP-0044 provides the list of registered coin types for BIP-0044. I suggest 0x80003485 for the keystore.

Wallet name

A master seed or a master node should be private, so there should be a tag to distinguish between seeds.
It may be

Hash value of a seed
~~Hash value of a master node (private key + chain code)~~
~~String given by a user~~

Seed

The format of seeds will follow the serialization format from BIP-0032.

Functions

New functions should be introduced.

importSeed, exportSeed
createSeed, deleteSeed
getPublicKeyFromSeed, getPrivateKeyFromSeed
- This exports only a key, not a chain code, to use it on CodeChain.
signFromSeed

Errors on the travis CI

https://travis-ci.org/CodeChain-io/codechain-wallet/jobs/442266609

TypeError: Cannot read property 'getItem' of undefined
    at SessionStorage.read (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/lowdb-session-storag$
-adapter/index.js:9:37)
    at LodashWrapper.db.read (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/lowdb/lib/main.js:$
2:21)
    at Object.<anonymous>.module.exports (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/lowdb/$
ib/main.js:51:13)
    at Object.<anonymous> (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/li$
/context.js:73:46)
    at step (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/lib/context.js:3$
:23)
    at Object.next (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/lib/conte$
t.js:13:53)
    at /Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/lib/context.js:7:71
    at new Promise (<anonymous>)
    at Object.<anonymous>.__awaiter (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-ke
ystore/lib/context.js:3:12)
    at Object.storageExist (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/li
b/context.js:69:12)
    at Function.<anonymous> (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/l
ib/index.js:88:49)
    at step (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/lib/index.js:43:2
3)
    at Object.next (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/lib/index.
js:24:53)
    at /Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-keystore/lib/index.js:18:71
    at new Promise (<anonymous>)
    at Object.<anonymous>.__awaiter (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/codechain-ke
ystore/lib/index.js:14:12)
    at Function.Object.<anonymous>.CCKey.exist (/Users/gilyoungkim/Documents/workspace/codechain-wallet/node_modules/c
odechain-keystore/lib/index.js:83:16)

key
signature
message