# Copay

Copay is a secure bitcoin wallet for friends and companies. Easy-to-use multisignature bitcoin wallet, bringing corporate-level security to ordinary people.

When friends or company executives join a Copay wallet, more than one person must sign every transaction. If your computer is compromised and your private keys are stolen, the bitcoins are still safe. This is in addition to state-of-the-art encrypted storage and communication.

## Before you start

Please check Copay Known Issues before using Copay with real Bitcoins.

## Installation

    git clone https://github.com/bitpay/copay.git
    cd copay

Install bower and grunt if you haven't already:

    npm install -g bower
    npm install -g grunt-cli

Build Copay:

    npm install
    bower install
    grunt shell --target=dev

Open Copay:

    npm start

Then visit localhost:3000 in your browser.

## Running copay

To run on a different port:

    PORT=3001 npm start

To open up five different instances to test 3-of-5 multisig with yourself, then run this in 5 different terminals:

    PORT=3001 npm start
    PORT=3002 npm start
    PORT=3003 npm start
    PORT=3004 npm start
    PORT=3005 npm start

To open n different instances more easily, just run:

    n=5
    node launch.js $n &

To require Copay as a module for use within your application:

    require('copay').start(3000, function(location) {
      console.log('Copay server running at: ' + location);
    });

## Tests

Open test/index.html in your browser to test models. Install and run karma to test the services and controllers.

## Configuration

The default configuration can be found in the config.js file. See config.js for more info. This configuration could be partially overidden with the options set at the "Settings" tab.

## Troubleshooting

### Building on Ubuntu 14.04, gyp, Python

      gyp_main.py: error: no such option: --no-parallel
      gyp ERR! configure error
      gyp ERR! stack Error: `gyp` failed with exit code: 2

Ubuntu 14.04 has Python 2.7, but gyp requires Python 2.6 (http://stackoverflow.com/questions/21155922/error-installing-node-gyp-on-ubuntu)

One solution is to use Copay with a Python version manager for 2.6.

# Development

## Android APK

System Requirements

- Download Android SDK
- Download and install Crosswalk 8 (Use Linux setup for OSX)

Add to your ~/.bash_profile or ~/.bashrc

    export CROSSWALK="<path to Crosswalk directory>"

To build the APK run the script:

    sh android/build.sh [-d]

- The -d flag will package the apk in debug mode, allowing remote debugging chrome
- The APK file is in android/Copay_VERSION_arm.apk

To install the APK in your device run:

    adb install -r Copay_VERSION_arm.apk

## Google Chrome Extension

To build Copay's Chrome Extension, run:

    $ npm run-script chrome

- On sucess, the chrome extension is located at: `browser-extensions/chrome/copay-chrome-extension`

To install it go to `chrome://extensions/` at your chrome browser, make sure you have 'developer mode' option checked at your Chrome settings. Click on "Load unpacked chrome extension" and choose the directory mentioned above.

## Firefox Add-on

System Requirements

- Download Add-on SDK
- Install it. Mozilla Docs

Run

    $ npm run-script firefox

- On sucess, the firefox add-on is located at: browser-extensions/firefox/copay.xpi `

## Web App

The Web App is a clean version of Copay, only the neededs files (html, css, js) for run Copay locally or in your own server.

In order to get the ZIP file of Copay, you just need to run:

    $ sh webapp/build.sh

- The ZIP file is webapp/download/copay.zip
- The webapp/copay-webapp is the unzipped version

# About Copay

## General

Copay implements a multisig wallet using p2sh addresses. It supports multiple wallet configurations, such as 3-of-5 (3 required signatures from 5 participant peers) or 2-of-3. To create a multisig wallet shared between multiple participants, Copay needs the public keys of all the wallet participants. Those public keys are incorporated into the wallet configuration and are combined to generate a payment address with which funds can be sent into the wallet.

To unlock the payment and spend the wallet's funds, a quorum of participant signatures must be collected and assembled in the transaction. The funds cannot be spent without at least the minimum number of signatures required by the wallet configuration (2 of 3, 3 of 5, 6 of 6, etc). Each participant manages their own private key, and that private key is never transmitted anywhere. Once a transaction proposal is created, the proposal is distributed among the wallet participants for each participant to sign the transaction locally. Once the transaction is signed, the last signing participant will broadcast the transaction to the Bitcoin network using a public API (defaults to the Insight API).

Copay also implements BIP32 to generate new addresses for the peers. The public key each participant contributes to the wallet is a BIP32 extended public key. As additional public keys are needed for wallet operations (to produce new addresses to receive payments into the wallet, for example) new public keys can be derived from the participants' original extended public keys. Each participant keeps their own private keys locally. Private keys are not shared. Private keys are used to sign transaction proposals to make a payment from the shared wallet.

Addresses are generated using the procedure described on [https://github.com/maraoz/bips/blob/master/bip-NNNN.mediawiki].

## Serverless web

Copay software does not need an application server to run. All the software is implemented in client-side JavaScript. For persistent storage, the client browser's localStorage is used. Locally stored data is encrypted using a password provided by the local user. Data kept in browser local storage should be backed up for safekeeping using one of the methods provided by Copay, such as downloading the data into a file.
Without a proper backup of the user's private key data, all funds stored in the wallet may be lost or inaccessible if the browser's localStorage is deleted, the browser uninstalled, the local hard disk fails, etc.

## Peer communications

Copay uses peer-to-peer (p2p) networking to communicate between wallet participants. Participants exchange transaction proposals, public keys, nicknames and information about the wallet configuration. Private keys are not shared with anyone.

Copay network communications use the webRTC protocol. A p2p facilitator server is needed to enable the peers to find each other. Copay uses the open-sourced peerjs server implementation for p2p discovery. Wallet participants can use a public peerjs server or install their own. Once the peers find each other, a true p2p connection is established between the peers and there is no further flow of information to the p2p discovery server.

webRTC uses DTLS to secure communications between the peers, and each peer uses a self-signed certificate.

## Security model

On top of webRTC, Copay peers encrypt and sign each message using ECIES (a.k.a. asynchronous encryptio) as decribed on [http://en.wikipedia.org/wiki/Integrated_Encryption_Scheme].

The identity key is a ECDSA public key derived from the participant's extended public key using a specific BIP32 branch. This special public key is never used for Bitcoin address creation, and should only be known by members of the WR. In Copay this special public key is named copayerId. The copayerId is hashed and the hash is used to register with the peerjs server (See SINs at https://en.bitcoin.it/wiki/Identity_protocol_v1). This hash is named peerId.

Registering with a hash avoids disclosing the copayerId to parties outside of the WR. Peer discovery is accomplished using only the hashes of the WR members' copayerIds. All members of the WR know the full copayerIds of all the other members of the WR.

## Secret String

When a wallet is been created, a secret string is provided to invite new peers to the new wallet. This string is the peerId of the wallet creator, and it is necessary for the other peers to find the wallet. Once the other peers join, all public keys (copayerIds) are stored by each peer, so peers can find each other with out sharing extra information.

For added security and to prevent Man-on-the-middle Attacks on the peerJS server, peers should check each other's IDs (peerIDs), during wallet creation. That information is shown on the setup screen.

## Wallet backups

Wallet funds can be restored using an old backups, since new addresses are scanned in the blockchain for transactions. The scan window is set to 20. However, if address bookmarks were created after the backup, or new transaction proposal were created, they will only be restored if one peer participating the wallet have them.