search

terracoin / TRCpay

TRCpay (based on copay) is a secure Terracoin platform for both desktop and mobile devices.
http://copay.io
MIT License
1 stars 2 forks source link

readme

TRCpay

Build Status Crowdin

TRCpay is a secure Terracoin wallet platform for both desktop and mobile devices. TRCpay uses Bitcore Wallet Service for Terracoin (BWS) for peer synchronization and network interfacing.

Binary versions of TRCpay are available for download at Terracoin.io. TRCpay Binaries are signed with the key support@terracoin.io – See the section How to Verify TRCpay Signatures for details.

For a list of frequently asked questions please visit the Copay FAQ.

Main Features

Testing in a Browser

Note: This method should only be used for development purposes. When running TRCpay in a normal browser environment, browser extensions and other malicious code might have access to internal data and private keys. For production use, see the latest official releases.

Clone the repo and open the directory:

git clone https://github.com/terracoin/TRCpay.git
cd TRCpay

Ensure you have Node installed, then install and start TRCpay:

npm run apply:trcpay
npm start

Visit localhost:8100 to view the app.

A watch task is also available to rebuild components of the app as changes are made. This task can be run in a separate process – while the server started by npm start is running – to quickly test changes.

npm run watch

Testing on Real Devices

It's recommended that all final testing be done on a real device – both to assess performance and to enable features that are unavailable to the emulator (e.g. a device camera).

Android

Follow the Cordova Android Platform Guide to set up your development environment.

When your developement enviroment is ready, run the start:android npm package script.

npm run apply:trcpay
npm run start:android

iOS

Follow the Cordova iOS Platform Guide to set up your development environment.

When your developement enviroment is ready, run the start:ios npm package script.

npm run apply:trcpay
npm run start:ios

Desktop (Linux, macOS, and Windows)

The desktop version of TRCpay currently uses NW.js, an app runtime based on Chromium. To get started, first install NW.js on your system from the NW.js website.

When NW.js is installed, run the start:desktop npm package script.

npm run apply:trcpay
npm run start:desktop

Build TRCpay App Bundles

Before building the release version for a platform, run the clean-all command to delete any untracked files in your current working directory. (Be sure to stash any uncommited changes you've made.) This guarantees consistency across builds for the current state of this repository.

The final commands build the production version of the app, and bundle it with the release version of the platform being built.

Android

npm run clean-all
npm run apply:trcpay
npm run final:android

iOS

npm run clean-all
npm run apply:trcpay
npm run final:ios

Desktop (Linux, macOS, and Windows)

npm run clean-all
npm run apply:trcpay
npm run final:desktop

Google Chrome App

cd chrome-app/

npm run apply:trcpay
grunt
make

On success, the Chrome extension will be located at: browser-extensions/chrome/trcpay-chrome-extension. To install it go to chrome://extensions/ in your browser and ensure you have the 'developer mode' option enabled in the settings. Then click on "Load unpacked chrome extension" and choose the directory mentioned above.

Configuration

Enable External Services

To enable external services, set the COPAY_EXTERNAL_SERVICES_CONFIG_LOCATION or BITPAY_EXTERNAL_SERVICES_CONFIG_LOCATION environment variable to the location of your configuration before running the apply task.

TRCPAY_EXTERNAL_SERVICES_CONFIG_LOCATION="~/.trcpay/externalServices.json" npm run apply:trcpay

About TRCpay

General

TRCpay implements a multisig wallet using p2sh addresses. It supports multiple wallets, each with its own configuration, 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, TRCpay requires the extended public keys of all the wallet participants. Those public keys are then incorporated into the wallet configuration and combined to generate a payment address where funds can be sent into the wallet. Conversely, each participant manages their own private key and that private key is never transmitted anywhere.

To unlock a 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.). Once a transaction proposal is created, the proposal is distributed among the wallet participants for each to sign the transaction locally. Finally, when the transaction is signed, the last signing participant will broadcast the transaction to the Bitcoin network.

TRCpay also implements BIP32 to generate new addresses for peers. The public key that 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. Once again, it's important to stress that each participant keeps their own private keys locally - private keys are not shared - and are used to sign transaction proposals to make payments from the shared wallet.

For more information regarding how addresses are generated using this procedure, see: Structure for Deterministic P2SH Multisignature Wallets.

TRCpay Backups and Recovery

Since v1.2 TRCpay uses BIP39 mnemonics for backing up wallets. The BIP44 standard is used for wallet address derivation. Multisig wallets use P2SH addresses, while non-multisig wallets use P2PKH.

Information about backup and recovery procedures is available at: https://github.com/terracoin/TRCpay/blob/master/backupRecovery.md

Previous versions of TRCpay used files as backups. See the following section.

It is possible to recover funds from a TRCpay Wallet without using TRCpay or the Wallet Service, check the TRCpay Recovery Tool.

Wallet Export Format

TRCpay encrypts the backup with the Stanford JS Crypto Library. To extract the private key of your wallet you can use https://bitwiseshiftleft.github.io/sjcl/demo/, copy the backup to 'ciphertext' and enter your password. The resulting JSON will have a key named: xPrivKey, that is the extended private key of your wallet. That information is enough to sign any transaction from your wallet, so be careful when handling it!

The backup also contains the key publicKeyRing that holds the extended public keys of the Copayers. Depending on the key derivationStrategy, addresses are derived using BIP44 or BIP45. Wallets created in TRCpay v1.2 and forward always use BIP44, all previous wallets use BIP45. Also note that since TRCpay version v1.2, non-multisig wallets use address types Pay-to-PublicKeyHash (P2PKH) while multisig wallets still use Pay-to-ScriptHash (P2SH) (key addressType at the backup):

TRCpay Version Wallet Type Derivation Strategy Address Type
<1.2 All BIP45 P2SH
>=1.2 Non-multisig BIP44 P2PKH
>=1.2 Multisig BIP44 P2SH
>=1.5 Multisig Hardware wallets BIP44 (root m/48') P2SH

Using a tool like Bitcore PlayGround all wallet addresses can be generated. (TIP: Use the Address section for P2PKH address type wallets and Multisig Address for P2SH address type wallets). For multisig addresses, the required number of signatures (key m on the export) is also needed to recreate the addresses.

BIP45 note: All addresses generated at BWS with BIP45 use the 'shared cosigner index' (2147483647) so TRCpay address indexes look like: m/45'/2147483647/0/x for main addresses and m/45'/2147483647/1/y for change addresses.

Since version 1.5, TRCpay uses the root m/48' for hardware multisignature wallets. This was coordinated with Ledger and Trezor teams. While the derivation path format is still similar to BIP44, the root was in order to indicate that these wallets are not discoverable by scanning addresses for funds. Address generation for multisignature wallets requires the other TRCpayers extended public keys.

Bitcore Wallet Service

TRCpay depends on Bitcore Wallet Service for Terracoin (BWS) for blockchain information, networking and Copayer synchronization. A BWS instance can be setup and operational within minutes or you can use a public instance like https://bws.terracoin.io. Switching between BWS instances is very simple and can be done with a click from within TRCpay.

Hardware Wallet Support

TRCpay supports Ledger and Trezor hardware wallets. Hardware wallet support is only available through the Chrome App. Ledger support is only available on multisig wallets.

To use Ledger, you need to have the Ledger Chrome App installed, available at: https://chrome.google.com/webstore/detail/ledger-wallet/kkdpmhnladdopljabkgpacgpliggeeaf

To use Trezor, you need to have the Trezor Chrome Extension installed, available at: https://chrome.google.com/webstore/detail/trezor-chrome-extension/jcjjhjgimijdkoamemaghajlhegmoclj

To create or join a wallet using Ledger or Trezor go to:

Add Wallet -> Create or Join -> Advanced options -> Wallet Seed -> select Trezor or Ledger

Both devices support multiple accounts, so you can use them for multiple wallets. Select the account and then click on create or join.

It is also possible to import a wallet from a device using: Add Wallet -> Import -> Hardware wallet

Here it is also necesary to select the account number.

When creating or joining a wallet, TRCpay will ask for two public keys for the device. One public keys is used for the wallet itself and the other is used as an entropy source to create a private / public key pair for signing requests to the Wallet Service.

Every time you need to sign a transaction, the device will be needed to perform the signature. Follow the on screen instructions after clicking the send or accept buttons.

Finally, in case you lose the device and you have the 24 word seed for the device, you can recover access to your funds using TRCpay, see: https://github.com/terracoin/TRCpay/blob/master/backupRecovery.md#hardware-wallets

Translations

TRCpay uses standard gettext PO files for translations and Crowdin as the front-end tool for translators. To join our team of translators, please create an account at Crowdin and translate the TRCpay documentation and application text into your native language.

To download and build using the latest translations from Crowdin, please use the following commands:

cd i18n
node crowdin_download.js

This will download all partial and complete language translations while also cleaning out any untranslated ones.

Translation Credits:

Gracias totales!

Release Schedules

TRCpay uses the MAJOR.MINOR.BATCH convention for versioning. Any release that adds features should modify the MINOR or MAJOR number.

Bug Fixing Releases

We release bug fixes as soon as possible for all platforms. Usually around a week after patches, a new release is made with language translation updates (like 1.1.4 and then 1.1.5). There is no coordination so all platforms are updated at the same time.

Minor and Major Releases

How to Verify TRCpay Signatures

  1. Download the support@terracoin.io public key (gpg --recv-keys A78B5052E13EC768)
  2. Download TRCpay binary ($FILENAME) and signature file ($FILENAME.sig)
  3. Verify the signature by running:
$ gpg --verify \
 $FILENAME.sig \
 $FILENAME

# It should return:
Good signature from "TRCpay (visit terracoin.io) <support@terracoin.io>"

Public Key for TRCpay Binaries

Instead of importing the public key from a public server (like gnu's) you can grab it from here:

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: SKS 1.1.5
Comment: Hostname: pgp.mit.edu

Comming soon
-----END PGP PUBLIC KEY BLOCK-----

Save that text to /tmp/key, and then import it as follows:

gpg --import /tmp/key

(Thanks @pzkpfwVI and @mika-mitzahlen for this section, taken from Gist.

Contributing to this project

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing.

Support

Please see Support requests

License

TRCpay is released under the MIT License. Please refer to the LICENSE file that accompanies this project for more information including complete terms and conditions.