README.md 3.06 KiB
Newer Older
Thibaut S's avatar
Thibaut S committed
# Parity Fether - a fast and decentralized wallet based on a light-client
Amaury Martiny's avatar
Amaury Martiny committed

Amaury Martiny's avatar
Amaury Martiny committed
## Get the latest binary

Thibaut S's avatar
Thibaut S committed
[» Download the latest release «](https://github.com/paritytech/fether/releases)
Thibaut S's avatar
Thibaut S committed

### Join the chat!

Get in touch with us on Gitter:
Thibaut S's avatar
Thibaut S committed
[![Gitter](https://img.shields.io/badge/Gitter-Fether-brightgreen.svg)](https://gitter.im/paritytech/fether)
Thibaut S's avatar
Thibaut S committed


Official website: https://parity.io | Be sure to check out [our Wiki](https://wiki.parity.io) for more information.

----

## About Parity Fether

Thibaut S's avatar
Thibaut S committed
Fether aims to be the lightest and simplest decentralized wallet. It supports Ether and ERC-20 tokens and runs on top of [Parity Ethereum](https://github.com/paritytech/parity-ethereum) light client allowing smooth synchronization and interaction with the Ethereum blockchain, in a decentralized manner.
Thibaut S's avatar
Thibaut S committed

By default, Parity Fether alpha runs on the Kovan test network. You can receive free Kovan Ether by posting your address in the [Kovan Faucet](https://gitter.im/kovan-testnet/faucet) Gitter channel. Fether will download and launch Parity Ethereum node at startup if it's not found on the computer. You can also separately launch your Ethereum client, Fether will automatically connect to it.

If you run into problems while using Parity Fether, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](https://github.com/paritytech/parity/blob/master/SECURITY.md).

Parity Fether connects to the light node using light.js, a Javascript library specifically crafted for Wallets to connect with light clients. It is licensed under the BSD 3-Clause, and can be used for all your Ethereum needs.

----

## Start Parity Fether

Thibaut S's avatar
Thibaut S committed
### Using the command line
Thibaut S's avatar
Thibaut S committed

Thibaut S's avatar
Thibaut S committed
To start Parity Fether manually, simply run:
Amaury Martiny's avatar
Amaury Martiny committed

Amaury Martiny's avatar
Amaury Martiny committed
```bash
Thibaut S's avatar
Thibaut S committed
$ fether
Amaury Martiny's avatar
Amaury Martiny committed
```
Thibaut S's avatar
Thibaut S committed
Fether will launch a Partity Ethereum light node and print its output in the command line.
Thibaut S's avatar
Thibaut S committed

Thibaut S's avatar
Thibaut S committed
### Passing config flags to the underlying Parity Ethereum node
Thibaut S's avatar
Thibaut S committed

You can pass specific flags for fether to launch the underlying Parity Ethereum with:
```bash
Thibaut S's avatar
Thibaut S committed
# Launching Parity Ethereum light client on Ropsten instead of Kovan (default) and connect Fether to it
Thibaut S's avatar
Thibaut S committed
$ fether --chain ropsten --light
```
### Separately launch Parity Ethereum node

Thibaut S's avatar
Thibaut S committed
You can also launch Parity Ethereum node before, with any flag you want:
Thibaut S's avatar
Thibaut S committed
```bash
Thibaut S's avatar
Thibaut S committed
# Launching Parity Ethereum lieght client on Ropsten instead of Kovan (default)
Thibaut S's avatar
Thibaut S committed
$ parity --chain ropsten --light
```
In another console launch Fether:
```bash
# Fether will connect to the running node
$ fether
Thibaut S's avatar
Thibaut S committed
```

## Build from sources
Amaury Martiny's avatar
Amaury Martiny committed

Thibaut S's avatar
Thibaut S committed

### Dependencies
Amaury Martiny's avatar
Amaury Martiny committed
Make sure you have at least `yarn` version 1.4.2
Amaury Martiny's avatar
Amaury Martiny committed

Amaury Martiny's avatar
Amaury Martiny committed
```bash
yarn --version // Should be at least 1.4.2
Amaury Martiny's avatar
Amaury Martiny committed
```
Thibaut S's avatar
Thibaut S committed
### Clone this repo

```bash
git clone https://github.com/paritytech/fether
cd ./fether
yarn install
```
Amaury Martiny's avatar
Amaury Martiny committed

Thibaut S's avatar
Thibaut S committed
### Build this repo and run
Amaury Martiny's avatar
Amaury Martiny committed

```bash
Amaury Martiny's avatar
Amaury Martiny committed
yarn electron
```

Thibaut S's avatar
Thibaut S committed
### Build binaries
Amaury Martiny's avatar
Amaury Martiny committed

Amaury Martiny's avatar
Amaury Martiny committed
```bash
Amaury Martiny's avatar
Amaury Martiny committed
yarn package
```

Thibaut S's avatar
Thibaut S committed
### Run with live reload for development
Amaury Martiny's avatar
Amaury Martiny committed

Amaury Martiny's avatar
Amaury Martiny committed
```bash
Amaury Martiny's avatar
Amaury Martiny committed
yarn start
```