burrow/README.md

65 lines
2.5 KiB
Markdown
Raw Normal View History

2020-09-01 13:13:05 +00:00
# Rudefox Burrow
2020-09-01 12:18:32 +00:00
2020-09-02 21:58:01 +00:00
*Offline Bitcoin Seed Generation and Wallet Tool*
2020-09-01 12:18:32 +00:00
2020-09-02 21:58:01 +00:00
Use [Rudefox](https://rudefox.io/) Burrow on an air-gapped, single-board computer, like a Raspberry Pi, to generate new seed words, derive addresses and extended public keys from existing seed words or sign PSBT transactions offline.
2020-09-01 12:18:32 +00:00
2020-09-01 13:13:05 +00:00
## Unique Feature: ShowMyWork
[**Rudefox ShowMyWork**](https://rudefox.io/blog/2020-07-16-show-my-work.html) is a feature of Burrow that enables non-technical end-users to audit the seed generation process in order to verify that the generated seed is derived directly from [8-sided dice](https://www.amazon.com/dp/B07XPMV4DQ/) rolls and a set of lookup-tables. Read more [here](https://rudefox.io/blog/2020-07-16-show-my-work.html).
```bash
alice@cold.machine:~$ burrow mnemonic -i8 --bits 128
Input 11 x 8-sided dice rolls [1-8]: 12345678123
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 1 | 2 | 3 |
|000 001 010 01 | 1 100 101 110 1 | 11 000 001 010|
| 1. ahead | 2. slight | 3. scout |
Input 11 x 8-sided dice rolls [1-8]: 12345678123
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 1 | 2 | 3 |
|000 001 010 01 | 1 100 101 110 1 | 11 000 001 010|
| 4. ahead | 5. slight | 6. scout |
...
ahead slight scout ahead slight scout ahead slight scout ahead slight scan
```
2020-09-02 21:58:01 +00:00
## Build Instructions
2020-09-01 12:18:32 +00:00
2020-09-02 21:58:01 +00:00
#### Linux
2020-09-01 12:18:32 +00:00
2020-09-02 21:58:01 +00:00
* Install dependencies: Java 8
2020-09-01 12:18:32 +00:00
```bash
2020-09-02 21:58:01 +00:00
apt install openjdk-8-jdk
2020-09-01 12:18:32 +00:00
```
2020-09-02 21:58:01 +00:00
* Clone the repository and build
2020-09-01 12:18:32 +00:00
```bash
2020-09-02 21:58:01 +00:00
bob@hot.machine:~$ git clone https://git.rudefox.io/rudefox/burrow.git
bob@hot.machine:~$ cd burrow
bob@hot.machine:~$ ./gradlew build distTar
2020-09-01 12:18:32 +00:00
```
2020-09-02 21:58:01 +00:00
* Find the distribution `.tar` file in `build/distributions/`
2020-09-01 12:18:32 +00:00
2020-09-02 21:58:01 +00:00
## Quick Raspbery Pi Install
* Download the latest image [here](https://repo.rudefox.io/service/rest/v1/search/assets/download?sort=version&group=io.rudefox&name=burrow-pi-img&maven.extension=zip)
* Unzip the image file
* Flash it onto an SD Card
* [Linux](https://www.raspberrypi.org/documentation/installation/installing-images/linux.md)
* [Mac OS](https://www.raspberrypi.org/documentation/installation/installing-images/mac.md)
* [Windows](https://www.raspberrypi.org/documentation/installation/installing-images/windows.md)
* [Chrome OS](https://www.raspberrypi.org/documentation/installation/installing-images/chromeos.md)
* Insert the SD card into the Rasberry Pi and power it up
* **IMPORTANT**: Wait for the device to boot and then wait for it to automatically reboot **TWICE** (once to expand the filesystem and again to activate the read-only filesystem)