codechain-io/codechain-keystore-server

A private key management server for CodeChain

CodeChain keystore server

CodeChain keystore server is a private key management server. It saves CodeChain's asset transfer address safely in a database. You should use this keystore server to save your private key safely in CodeChain SDK.

Installation

Prerequisite

1. Install PostgreSQL

Initial Configuration

1. Install dependencies with yarn install
2. Execute the following SQL queries

CREATE DATABASE "codechain-keystore";
CREATE USER "codechain" WITH ENCRYPTED PASSWORD 'DATABASE_PASSWORD';
GRANT ALL PRIVILEGES ON DATABASE "codechain-keystore" TO "codechain";

1. Create config/local.json with the following data

{
    "knex": {
        "connection": {
            "password": "DATABASE_PASSWORD"
        }
    }
}

1. Update the database with yarn migrate
2. Seed the database with yarn seed

Usage

• yarn start to start a server
• yarn load to load local keystore to database
• yarn lint to lint the entire source code
• yarn fmt to apply formatters
• yarn migrate to migrate the database
• yarn rollback to rollback the database
• yarn seed to reset and seed the database

Check if the server is alive

You can send a ping to the server to check if it's up and running.

curl http://localhost:7007/ping

codechain-keystore-server's Issues

Document APIs

Document the endpoints of codechain-keystore-server.

Add script to load HD wallet keys in local keystore file to db

Integrate Swagger UI

How to check if the keystore server is up and running

Please update README.md.

Moved from CodeChain-io/codechain-keystore-js#4

Add --port command line option

Make it possible to specify the listening port as a command line option.

Validate inputs

Integrate Travis CI

Support DB backend

Update the codechain-keystore-js version

Support docker build