README.md 4.4 KB
Newer Older
Thibaut Sardan's avatar
Thibaut Sardan committed
1
![Parity Signer](https://wiki.parity.io/images/logo-parity-signer.jpg)
Marek Kotewicz's avatar
Marek Kotewicz committed
2

Thibaut Sardan's avatar
Thibaut Sardan committed
3
# Parity Signer - a smartphone as cold storage
Thibaut Sardan's avatar
Thibaut Sardan committed
4

Thibaut Sardan's avatar
Thibaut Sardan committed
5
Parity Signer is a secure air-gapped wallet that allows users to use a smartphone as cold storage. It means that, once the App has been installed, users can create Ethereum accounts, sign transactions and transfer funds from and to these accounts without any sort of connectivity enabled on the device. Wifi, Mobile Network, Bluetooth can be shut down and even removed physically to ensure that the mobile phone containing these accounts will not be exposed to any online threat. Have a look at the tutorial on our wiki to learn how to [use MyCrypto together with Parity Signer](https://wiki.parity.io/Parity-Signer-Mobile-App-MyCrypto-tutorial).
Thibaut Sardan's avatar
Thibaut Sardan committed
6
7
8
9
10
11

Any data transfer from or to the App will happen using QR code scanning. By doing so, the most sensitive piece of information, the private keys, will never leave the phone. The Parity Signer Mobile App can be used to store any Ethereum account, this includes ETH, ETC as well as Ether from various testnets (Kovan, Ropsten...).

## How to get it and use it?

### Device security
Thibaut Sardan's avatar
Thibaut Sardan committed
12
Parity Signer Mobile App is built to be used offline. The mobile device used to run the App will hold valuable information that needs to be kept securely stored. It is therefore advised to:
Thibaut Sardan's avatar
Thibaut Sardan committed
13
14
15
16
17
18
19
20
- Get a separate mobile device.
- Make a factory reset.
- Enable full-disk encryption on the device, with a reasonable password (might not be on by default, for example for older Android devices).
- Do not use any kind of biometrics such as fingerprint or face recognition for device decryption/unlocking, as those may be less secure than regular passwords.
- Once the App has been installed, enable airplane mode and make sure to switch off Wifi, Bluetooth or any connection ability of the device.
- Only charge the phone on a power outlet that is never connected to the internet. Only charge the phone with the manufacturer's charging adapter. Do not charge the phone on public USB chargers.

## Installation
21
22
23
24
25
26
[![App Store][app-store-badge]][app-store-url]
[![Google Play][google-play-badge]][google-play-url]

[app-store-badge]: ./res/app-store-badge.png
[app-store-url]: https://itunes.apple.com/us/app/parity-signer/id1218174838
[google-play-badge]: ./res/google-play-badge.png
Thibaut Sardan's avatar
Thibaut Sardan committed
27
[google-play-url]: https://play.google.com/store/apps/details?id=io.parity.signer
28

Thibaut Sardan's avatar
Thibaut Sardan committed
29
30
31
32
33
## Screenshots

![Parity Signer Screenshots](https://i.imgur.com/HHnwyAp.jpg)

## Build it
34
35
### Requirements

36
- `node.js` (tested on `v8.4.0`)
Marek Kotewicz's avatar
Marek Kotewicz committed
37
- `yarn` (tested on `1.6.0`)
38
39
40
- `rustup` (tested on `rustup 1.5.0 (92d0d1e9e 2017-06-24)`)
- `rustc` (tested on `rustc 1.27.0 (3eda71b00 2018-06-19)`)
- `cargo` (tested on `cargo 1.27.0 (1e95190e5 2018-05-27)`)
41
- `android_ndk` (tested on `r13b`)
42
- `Xcode` (only, for iOS, tested on `Version 9.4.1 (9F2000)`)
43
- `$NDK_HOME` envarionment variable set to ndk home directory (eg. `/usr/local/opt/android-ndk`)
Marek Kotewicz's avatar
Marek Kotewicz committed
44
- `$JAVA_HOME` envarionment variable set to java home directory (eg. `/Library/Java/JavaVirtualMachines/jdk1.8.0_60.jdk/Contents/Home`)
45

Thibaut Sardan's avatar
Thibaut Sardan committed
46
### Setup
47
48
49
50
51

- macOS

    ```
    ./setup_macos.sh
52
53
54

    echo "ndk.dir=$NDK_HOME" > android/local.properties
    echo "sdk.dir=$ANDROID_HOME" >> android/local.properties
55
56
57
58
59
60
    ```

- linux

    ```
    ./setup_linux.sh
61
62
63

    echo "ndk.dir=$NDK_HOME" > android/local.properties
    echo "sdk.dir=$ANDROID_HOME" >> android/local.properties
64
    ```
Marek Kotewicz's avatar
Marek Kotewicz committed
65

Thibaut Sardan's avatar
Thibaut Sardan committed
66
### Usage
Marek Kotewicz's avatar
Marek Kotewicz committed
67

68
69
70
- iOS

    ```
71
    npm run ios
72
73
74
75
76
    ```

- Android

    ```
77
    npm run android
78
79
    ```

Marek Kotewicz's avatar
Marek Kotewicz committed
80

Thibaut Sardan's avatar
Thibaut Sardan committed
81
### Test Parity Signer
82

Thibaut Sardan's avatar
Thibaut Sardan committed
83
84
85
86
87
88
For a quick test and to avoid the hurdle of creating an account, sending funds to it and finally create a transaction as described in the [MyCrypto Tutorial](https://wiki.parity.io/Parity-Signer-Mobile-App-MyCrypto-tutorial)), you can use a pre-funded account on Kovan Network. To get access to this account, you need to:

- Recover an account
- Select `Kovan` network and choose a name
- Use the recovery phrase: `this is sparta` you'll get the account address: `006E27B6A72E1f34C626762F3C4761547Aff1421`
- Validate and accept the warning message
Thibaut Sardan's avatar
Thibaut Sardan committed
89
90
- Chose a pin code
- Scan this QR code to sign a transaction sending some Kovan Eth to the same account.
Marek Kotewicz's avatar
Marek Kotewicz committed
91

Thibaut Sardan's avatar
Thibaut Sardan committed
92
![qr code parity signer](docs/tx_qr.png)
Marek Kotewicz's avatar
Marek Kotewicz committed
93

Thibaut Sardan's avatar
Thibaut Sardan committed
94
Corresponding data:
Marek Kotewicz's avatar
Marek Kotewicz committed
95
96
97

```json
{
Thibaut Sardan's avatar
Thibaut Sardan committed
98
99
100
101
102
    "action": "signTransaction",
    "data": {
        "account": "006e27b6a72e1f34c626762f3c4761547aff1421",
        "rlp": "ea1584ee6b280082520894006e27b6a72e1f34c626762f3c4761547aff1421872386f26fc10000802a8080"
    }
Marek Kotewicz's avatar
Marek Kotewicz committed
103
104
}
```