BTCPrivate
/
bitcore-wallet-service
mirror of https://github.com/BTCPrivate/bitcore-wallet-service.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Matias Alejo Garcia 2015-02-22 00:11:59 -03:00
parent 4c6491795d
commit 22e71f3ad0
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -23,15 +23,14 @@ A Multisig HD Wallet Service, with minimun server trust.
./bit status ./bit status
# Use -h or BIT_HOST to setup the base URL for your server. # Use -h or BIT_HOST to setup the base URL for your server.
# Use -f or BIT_FILE to setup the wallet data file
# Join the wallet from other copayer # Join the wallet from other copayer
./bit -f pete.dat join 0a18bed5-5607-4fde-a809-dc6561bc0664:L3WtafRAEHty7h2J7VCHdiyzFboAdVFnNZXMmqDGw4yiu5kW9Tp4:T ./bit -f pete.dat join 0a18bed5-5607-4fde-a809-dc6561bc0664:L3WtafRAEHty7h2J7VCHdiyzFboAdVFnNZXMmqDGw4yiu5kW9Tp4:T
./bit -f pete.dat status
# Set default file to use
export BIT_FILE=pete.dat export BIT_FILE=pete.dat
./bit -f pete.dat status
./bit address ./bit address
[1bitcoinaddress]
./bit balance ./bit balance
# Spend coins. Amount can be specified in btc, bit or sat (default) # Spend coins. Amount can be specified in btc, bit or sat (default)
@ -41,8 +40,8 @@ A Multisig HD Wallet Service, with minimun server trust.
./bit status ./bit status
# Sign or reject TXs from other copayers # Sign or reject TXs from other copayers
./bit -f pete.data reject <id> ./bit -f pete.dat reject <id>
./bit -f pete.data sign <id> ./bit -f pete.dat sign <id>
# List all commands: # List all commands:
./bit --help ./bit --help
@ -50,19 +49,11 @@ A Multisig HD Wallet Service, with minimun server trust.
``` ```
# Server API
## create a wallet
POST `/v1/wallets`
## join a wallet
POST `/v1/wallets/:id/copayers`
...
[To be completed, see app.js]
# Advanced Operation # Advanced Operation
## Mobility
You can safely access a wallet from different devices. Just copy the wallet file (`bit.dat` by default). If you need to reduce the file to the mínimum (for example to fit it on a QR) or change it's access level (by removing certain data on it), see `export` in the following section.
## Export, with different access levels ## Export, with different access levels
It is possible to export a wallet with restricted access level. The levels are: It is possible to export a wallet with restricted access level. The levels are:
@ -73,22 +64,18 @@ It is possible to export a wallet with restricted access level. The levels are:
`readonly` will only export the Wallet's Extended PublicKeys, and only the derived private key required for signing 'GET' request (readonly) to the server. `readwrite` will add the derived private key required for signing all other requests (as POST) so readwrite access will be possible. And `full` will export also the Extended Private Key, which is necesary for signing wallet's transactions. `bit import` can handle any for the levels correctly. `readonly` will only export the Wallet's Extended PublicKeys, and only the derived private key required for signing 'GET' request (readonly) to the server. `readwrite` will add the derived private key required for signing all other requests (as POST) so readwrite access will be possible. And `full` will export also the Extended Private Key, which is necesary for signing wallet's transactions. `bit import` can handle any for the levels correctly.
### full access
``` ```
# full access
bit export -o wallet.dat bit export -o wallet.dat
``` # readonly access
### readonly access
```
bit export -o wallet.dat --access readonly bit export -o wallet.dat --access readonly
``` # readwrite access (can create addresses, propose transactions, reject TX, but does not have signing keys)
### readwrite access (can create addresses, propose transactions, reject TX, but does not have signing keys)
```
bit export -o wallet.dat --access readwrite
```
### Import profile on other device, with giveng access level # Import the wallet , with giveng access level
```
bit import wallet.dat bit import wallet.dat
# Export also support QR output:
bit export --qr
``` ```
## Export / Import with a new given password (TODO) ## Export / Import with a new given password (TODO)
@ -180,3 +167,16 @@ Copayers store its extended private key and their copayer's extended public key
# Server API
## create a wallet
POST `/v1/wallets`
## join a wallet
POST `/v1/wallets/:id/copayers`
...
[To be completed, see expressapp.js]