trias-lab / bitcore-wallet-service

A multisig, HD Bitcoin and Bitcoin Cash wallet service. Used by Copay.

Home Page:https://copay.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BWS

Latest Tag NPM Package Build Status Coverage Status Node version Lincese


A HD Wallet Backend Service. Support Btc, Bch, Eth, TRY testnet(including both normal and private transactions).
Branch Tests Coverage
master CircleCI CircleCI
add-eth CircleCI CircleCI

Description

BWS facilitates HD wallets creation and operation through a (hopefully) simple and intuitive REST API.

BWS can usually be installed within minutes and accommodates all the needed infrastructure for peers in a wallet to communicate and operate – with minimum server trust.

See BWC for the official client library that communicates to BWS and verifies its response.

Requirements

Requirement Notes
Node v8.15.0 or highter
mongodb v3.0.15 or highter

Install

 git clone https://github.com/trias-lab/bitcore-wallet-service.git
 cd bitcore-wallet-service
 npm install
 npm start

This will launch the BWS service (with default settings) at http://localhost:3232/bws/api.

BWS needs mongoDB. You can configure the connection at config.js

BWS supports SSL and Clustering. For a detailed guide on installing BWS with extra features see Installing BWS.

BWS uses by default a Request Rate Limitation to CreateWallet endpoint. If you need to modify it, check defaults.js' Defaults.RateLimit

Quick Start

Here is some normal configuration keys that must be changed before start the project. Configuration file is config.js.

Key Content
storageOpts.mongoDb.uri mongodb server url, if default install, can be left unchanged
eth.EtherScanApiKey api key of etherscan, please visit https://etherscan.io/apis to apply
try.url try v1 public node rpc url

Documentation

Architecture design document is located at bws architecture

Http api document is located at bws api

Complete trias documentation can be found on the website.

A Note on Production Readiness

While Trias is being used in production in private, permissioned environments, we are still working actively to harden and audit it in preparation for use in public blockchains. We are also still making breaking changes to the protocol and the APIs. Thus, we tag the releases as alpha software.

In any case, if you intend to run Trias in production, please contact us and join the chat.

Security

To report a security vulnerability, bug report

Contributing

All code contributions and document maintenance are temporarily responsible for TriasLab

Trias are now developing at a high speed and we are looking forward to working with quality partners who are interested in Trias. If you want to join.Please contact us:

Upgrades

Trias is responsible for the code and documentation upgrades for all Trias modules. In an effort to avoid accumulating technical debt prior to Beta, we do not guarantee that data breaking changes (ie. bumps in the MINOR version) will work with existing Trias blockchains. In these cases you will have to start a new blockchain, or write something custom to get the old data into the new chain.

Resources

Research

About

A multisig, HD Bitcoin and Bitcoin Cash wallet service. Used by Copay.

https://copay.io/

License:MIT License


Languages

Language:JavaScript 99.8%Language:Shell 0.2%Language:Makefile 0.0%