README.md 5.88 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

Thibaut Sardan's avatar
Thibaut Sardan committed
4
5
6
7
8
9
10
11
12
13
14
[![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
[google-play-url]: https://play.google.com/store/apps/details?id=io.parity.signer

# Parity Signer - Turn your smartphone into a hardware wallet

Parity Signer is a mobile application that turns a smartphone into a secure air-gapped wallet also called 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
15

Thibaut Sardan's avatar
Thibaut Sardan committed
16
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...).
Thibaut Sardan's avatar
Thibaut Sardan committed
17

Thibaut Sardan's avatar
Thibaut Sardan committed
18
## Device security
Thibaut Sardan's avatar
Thibaut Sardan committed
19

Thibaut Sardan's avatar
Thibaut Sardan committed
20
Parity Signer was 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
21
22
23
24
- 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.
Thibaut Sardan's avatar
Thibaut Sardan committed
25
- Once the app has been installed, enable airplane mode and make sure to switch off Wifi, Bluetooth or any connection ability of the device.
Thibaut Sardan's avatar
Thibaut Sardan committed
26
27
28
29
30
31
32
- 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.

## Screenshots

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

## Build it
33
34
### Requirements

35
- `node.js` (tested on `v8.4.0`)
Marek Kotewicz's avatar
Marek Kotewicz committed
36
- `yarn` (tested on `1.6.0`)
37
38
39
- `rustup` (tested on `rustup 1.16.0`)
- `rustc` (tested on `rustc 1.32.0 (9fda7c223 2019-01-16)`)
- `cargo` (tested on `cargo 1.32.0 (8610973aa 2019-01-02)`)
40
- `android_ndk` (tested on `r13b`)
41
42
- `Android Studio` (only for Android, tested on `Version 3.3`)
- `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
46
47
- `$ANDROID_HOME` environment variable set to Android SDK directory (eg. `/home/your_username/Android/Sdk`)*.

\* It's recommended to install **Android Studio** and use that to install the necessary build tools and SDKs for the Android version you want to test on. It's also the best way to test in the emulator. **DO NOT INSTALL NDK VIA ANDROID STUDIO** as that will install the latest version instead of `r13b`.
48

Thibaut Sardan's avatar
Thibaut Sardan committed
49
### Setup
50
51
52
53
54

- macOS

    ```
    ./setup_macos.sh
55
56
57

    echo "ndk.dir=$NDK_HOME" > android/local.properties
    echo "sdk.dir=$ANDROID_HOME" >> android/local.properties
58
59
60
61
62
63
    ```

- linux

    ```
    ./setup_linux.sh
64
65
66

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

Thibaut Sardan's avatar
Thibaut Sardan committed
69
### Usage
Marek Kotewicz's avatar
Marek Kotewicz committed
70

71
72
73
- iOS

    ```
74
    npm run ios
75
76
77
78
79
    ```

- Android

    ```
80
    npm run android
81
82
    ```

Marek Kotewicz's avatar
Marek Kotewicz committed
83

Thibaut Sardan's avatar
Thibaut Sardan committed
84
### Test Parity Signer
85

Thibaut Sardan's avatar
Thibaut Sardan committed
86
87
88
89
90
91
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
92
93
- 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
94

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

Thibaut Sardan's avatar
Thibaut Sardan committed
97
Corresponding data:
Marek Kotewicz's avatar
Marek Kotewicz committed
98
99
100

```json
{
Thibaut Sardan's avatar
Thibaut Sardan committed
101
102
103
104
105
    "action": "signTransaction",
    "data": {
        "account": "006e27b6a72e1f34c626762f3c4761547aff1421",
        "rlp": "ea1584ee6b280082520894006e27b6a72e1f34c626762f3c4761547aff1421872386f26fc10000802a8080"
    }
Marek Kotewicz's avatar
Marek Kotewicz committed
106
107
}
```
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

### Troubleshooting

#### `No dimension set for key window` on Andrid < 5.0

This error should be accompanied with `error: closed` in terminal when deploying the debug version of the signer on a device that runs Android older than 5.0. It happens because the Android API does not support the reverse proxy that would allow the phone to communicate with the debug server on your computer.

A suitable workaround is to run both devices on the same WiFi and use your local WiFi IP address. Check your WiFi settings for your local IP address (eg. `192.168.1.42`), then, while having the app open on the phone (either on error page or blank screen) run a command in terminal:

```
adb shell input keyevent 82
```

(You can find `adb` binary in your local Android SDK folder under `platform-tools`, eg. `/home/your_username/Android/Sdk/platform-tools`)

This should open a menu on the device. In that menu go to `Dev Settings` > `Debug server host & port for device`, and enter your local IP address with port 8081 (eg. `192.168.1.42:8081`). Restart the app, the error should disappear.