You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

114 lines
4.1 KiB

6 years ago
# BlueWallet - A Bitcoin & Lightning Wallet
7 years ago
6 years ago
[![GitHub tag](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/BlueWallet/BlueWallet/master/package.json&query=$.version&label=Version)](https://github.com/BlueWallet/BlueWallet)
6 years ago
[![CircleCI](https://circleci.com/gh/BlueWallet/BlueWallet.svg?style=svg)](https://circleci.com/gh/BlueWallet/BlueWallet)
[![e2e on master](https://travis-ci.com/BlueWallet/BlueWallet.svg?branch=master)](https://travis-ci.com/BlueWallet/BlueWallet)
6 years ago
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
6 years ago
![](https://img.shields.io/github/license/BlueWallet/BlueWallet.svg)
7 years ago
7 years ago
Thin Bitcoin Wallet.
5 years ago
Built with React Native and Electrum.
7 years ago
6 years ago
[![Appstore](https://bluewallet.io/img/app-store-badge.svg)](https://itunes.apple.com/us/app/bluewallet-bitcoin-wallet/id1376878040?l=ru&ls=1&mt=8)
[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=io.bluewallet.bluewallet)
7 years ago
6 years ago
Website: [bluewallet.io](http://bluewallet.io)
6 years ago
Community: [telegram group](https://t.me/bluewallet)
6 years ago
7 years ago
* Private keys never leave your device
6 years ago
* Lightning Network supported
7 years ago
* SegWit-first. Replace-By-Fee support
7 years ago
* Encryption. Plausible deniability
6 years ago
* And many more [features...](https://bluewallet.io/features.html)
7 years ago
7 years ago
6 years ago
<img src="https://i.imgur.com/hHYJnMj.png" width="100%">
7 years ago
## BUILD & RUN IT
7 years ago
Please refer to the engines field in package.json file for the minimum required versions of Node and npm. It is preferred that you use an even-numbered version of Node as these are LTS versions.
7 years ago
To view the version of Node and npm in your environment, run the following in your console:
7 years ago
```
node --version && npm --version
```
7 years ago
* In your console:
```
git clone https://github.com/BlueWallet/BlueWallet.git
7 years ago
cd BlueWallet
npm install
```
Please make sure that your console is running the most stable versions of npm and node (even-numbered versions).
* To run on Android:
You will now need to either connect an Android device to your computer or run an emulated Android device using AVD Manager which comes shipped with Android Studio. To run an emulator using AVD Manager:
1. Download and run Android Studio
2. Click on "Open an existing Android Studio Project"
3. Open `build.gradle` file under `BlueWallet/android/` folder
4. Android Studio will take some time to set things up. Once everything is set up, go to `Tools` -> `AVD Manager`
5. Click on "Create Virtual Device..." and go through the steps to create a virtual device
6. Launch your newly created virtual device by clicking the `Play` button under `Actions` column
Once you connected an Android device or launched an emulator, run this:
```
npx react-native run-android
```
The above command will build the app and install it. Once you launch the app it will take some time for all of the dependencies to load. Once everything loads up, you should have the built app running.
* To run on iOS:
```
cd ios
pod install
cd ..
npm start ios
```
6 years ago
## TESTS
```bash
npm run test
```
## QA
Builds automated and tested with BrowserStack
<a href="https://www.browserstack.com/"><img src="https://i.imgur.com/syscHCN.png" width="160px"></a>
6 years ago
7 years ago
## MOTIVATION TO BUILD IT
I was not satisfied with existing iOS Bitcoin apps, especially with BreadWallet (the one I mainly used) where development stalled and they could not even deliver such features as SegWit, RBF and custom fees (at the times where custom fees were especially needed).
So I knew I could create one to use myself and let others use it.
I had experience with awesome bitcoin-js lib (javascript), and since I dont own any Macs, don't plan to and not going to learn ObjC/Swift - ReactNative (where you also write in javascript) was an obvious choice.
7 years ago
## LICENSE
MIT
6 years ago
## WANT TO CONTRIBUTE?
7 years ago
6 years ago
Grab an issue from [the backlog](https://github.com/BlueWallet/BlueWallet/projects/1), try to start or submit a PR, any doubts we will try to guide you.
6 years ago
Join us at our [telegram group](https://t.me/bluewallet) where we hangout :+1:
6 years ago
## Responsible disclosure
Found critical bugs/vulnerabilities? Please email them bluewallet@bluewallet.io
Thanks!