Skip to content

creditbit/creditbitcore-wallet-service

Repository files navigation

creditbitcore-wallet-service

NPM Package Build Status Coverage Status

A Multisig HD creditbitcore Wallet Service.

Description

creditbitcore Wallet Service facilitates multisig HD wallets creation and operation through a (hopefully) simple and intuitive REST API.

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

See [creditbitcore-wallet-client] (https://github.com/creditbit/creditbitcore-wallet-client) for the official client library that communicates to CWS and verifies its response.

CWS have a extensive test suite but have not been tested on production environments yet and have been recently released, so it it is still should be considered BETA software.

Install

 npm install 
 npm start

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

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

Security Considerations

  • Private keys are never sent to CWS. Copayers store them locally.
  • Extended public keys are stored on CWS. This allows CWS to easily check wallet balance, send offline notifications to copayers, etc.
  • During wallet creation, the initial copayer creates a wallet secret that contains a private key. All copayers need to prove they have the secret by signing their information with this private key when joining the wallet. The secret should be shared using secured channels.
  • A copayer could join the wallet more than once, and there is no mechanism to prevent this.
  • All CWS responses are verified:
  • Addresses and change addresses are derived independently and locally by the copayers from their local data.
  • TX Proposals templates are signed by copayers and verified by others, so the CWS cannot create or tamper with them.

REST API

Authentication

In order to access a wallet, clients are required to send the headers:

  x-identity
  x-signature

Identity is the Peer-ID, this will identify the peer and its wallet. Signature is the current request signature, using requestSigningKey, the m/1/1 derivative of the Extended Private Key.

GET Endpoints

/v1/wallets/: Get wallet information

Returns:

/v1/txhistory/: Get Wallet's transaction history

Optional Arguments:

  • skip: Records to skip from the result (defaults to 0)
  • limit: Total number of records to return (return all available records if not specified).

Returns:

  • History of incoming and outgoing transactions of the wallet. The list is paginated using the skip & limit params. Each item has the following fields:
  • action ('sent', 'received', 'moved')
  • amount
  • fees
  • time
  • addressTo
  • confirmations
  • proposalId
  • creatorName
  • message
  • actions array ['createdOn', 'type', 'copayerId', 'copayerName', 'comment']

/v1/txproposals/: Get Wallet's pending transaction proposals and their status Returns:

/v1/addresses/: Get Wallet's main addresses (does not include change addresses)

Returns:

/v1/balance/: Get Wallet's balance

Returns:

  • totalAmount: Wallet's total balance
  • lockedAmount: Current balance of outstanding transaction proposals, that cannot be used on new transactions.
  • byAddress array ['address', 'path', 'amount']: A list of addresses holding funds.

POST Endpoints

/v1/wallets/: Create a new Wallet

Required Arguments:

  • name: Name of the wallet
  • m: Number of required peers to sign transactions
  • n: Number of total peers on the wallet
  • pubKey: Wallet Creation Public key to check joining copayer's signatures (the private key is unknown by BWS and must be communicated by the creator peer to other peers).

Returns:

  • walletId: Id of the new created wallet

/v1/wallets/:id/copayers/: Join a Wallet in creation Required Arguments:

  • walletId: Id of the wallet to join
  • name: Copayer Name
  • xPubKey - Extended Public Key for this copayer.
  • requestPubKey - Public Key used to check requests from this copayer.
  • copayerSignature - Signature used by other copayers to verify that the copayer joining knows the wallet secret.

Returns:

  • copayerId: Assigned ID of the copayer (to be used on x-identity header)
  • wallet: Object with wallet's information

/v1/txproposals/: Add a new transaction proposal Required Arguments:

  • toAddress: RCPT creditbit address
  • amount: amount (in satoshis) of the mount proposed to be transfered
  • proposalsSignature: Signature of the proposal by the creator peer, using prososalSigningKey.
  • (opt) message: Encrypted private message to peers

Returns:

/v1/addresses/: Request a new main address from wallet

Returns:

/v1/txproposals/:id/signatures/: Sign a transaction proposal

Required Arguments:

  • signatures: All Transaction's input signatures, in order of appearance.

Returns:

/v1/txproposals/:id/broadcast/: Broadcast a transaction proposal

Returns:

/v1/txproposals/:id/rejections: Reject a transaction proposal

Returns:

/v1/addresses/scan: Start an address scan process looking for activity.

Optional Arguments:

  • includeCopayerBranches: Scan all copayer branches following BIP45 recommendation (defaults to false).

DELETE Endpoints

/v1/txproposals/:id/: Deletes a transaction proposal. Only the creator can delete a TX Proposal, and only if it has no other signatures or rejections

Returns:

`

About

A Multisig HD Creditbitcore Wallet Service

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages