Update README.md

This commit is contained in:
Matias Alejo Garcia 2015-02-17 19:09:28 -03:00
parent a03f2f7b8f
commit 8f56645892
1 changed files with 23 additions and 1 deletions

View File

@ -1,5 +1,6 @@
# bitcore-wallet-service
A Multisig HD Wallet Service, with minimun server trust.
# Quick Guide
@ -28,7 +29,7 @@
./bit send 1xxxxx 100 "100 satoshis to mother"
./bit status
# Export your critical wallet data (you need quorum of wallet's copayer to extract coins)
# Export your critical wallet data (you need *quorum* of wallet's copayer to extract coins)
./bit export
# Or export it to a QR
./bit export --qr
@ -39,3 +40,24 @@
# List all commands:
./bit --help
```
# Server API
create a wallet
POST `/v1/wallets`
join a wallet
POST `/v1/wallets/:id/copayers`
...
[To be completed, see app.js]
# Security Considerations
* Private keys are never send to the server. Copayers store them locally.
* Extended public keys are stored on the server. This allow the server to easily check wallet's balances, send offline notifications to copayers, etc. In case the server is compromised, the attacked could see past (and future) wallet's transactions.
* During wallet creation a wallet secret is created by the initial copayer containg a private key. Following copayers need to prof the have the secret by signing their information to join the wallet. The secret should be shared using secured channels.
* Note that a copayer could should more that one time to the wallet, and there is not mechanism to prevent it. Copayers should use 'confirm' to check others copayer's identity.
* All server responses are verified:
* Addresses, change addresses are derived individually by copayers from their local data.
* TX Proposals templates are signed by copayers, and verified by others, so the server cannot create / tamper them
# Export Format
Exporting a wallet will expose copayer's extended private key and other's copayers extended public keys. This information is enough to extract funds from the wallet, given the required quorum is meet.