Creating new release

BUGFIX: Implemented non-interactive entropy for D8 and Binary

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 B.J. Dweck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,97 +1,31 @@
 # Rudefox Burrow
 
-Rudefox provides a pair of command line tools for the creation and management of Bitcoin wallets.
+*Offline Bitcoin Seed Generation and Wallet Tool*
 
-+ Use `burrow` on an air-gapped single-board computer, like a Raspberry Pi, to generate new seed words, obtain addresses and extended public keys from existing seed words and sign PSBT transactions offline.
-+ Use `reynard` on a connected ("hot") device to view your balance and utxo's and to create new, unsigned transactions.
+Use 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.  Check out the self-audited seed generation feature: [ShowMyWork](https://rudefox.io/blog/2020-07-16-show-my-work.html).
 
-## Unique Feature: ShowMyWork
+[Rudefox Burrow](https://rudefox.io/burrow/) is released under the [MIT License](LICENSE.md) by B.J. Dweck
 
-[**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).
+## Getting Started
+
+If you simply want to dive in and try your hand at generating a self-audited seed, see the [Burrow Quick Start](https://www.rudefox.io/burrow/quick-start.html) guide.
+
+## Build
+
+### Linux
+
+* Install the Java 8 SDK (Java 8+ is not already installed)
 
 ```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
+sudo apt-get install -y openjdk-8-jdk-headless
 ```
 
-## Menemonic Generation
+* Clone the repository and build
 
 ```bash
-alice@cold.machine:~$ burrow mnemonic --interactive --dice-entropy --bits 128
-Input 50 dice rolls [1-6]: 234322343242422344161254151
-Input 23 more dice rolls [1-6]: 33116265515343114314456
-Mnemonic Sentence: mountain tilt wing silk rude fox almost volume wine media verify card
+git clone https://git.rudefox.io/rudefox/burrow.git
+cd burrow
+./gradlew build distTar
 ```
 
-### Mnemonic Options
-
-```bash
-usage: burrow mnemonic
- -b,--bits <128|160|192|224|256>   bits of entropy (default: 256)
- -d,--dice-entropy                 use dice entropy source
- -e,--events <EVENT_STRING>        string representing events from entropy source
- -h,--help                         display help message
- -i,--interactive                  use interactive command line mode
-```
-
-## Xpub Export
-
-```bash
-alice@cold.machine:~$ burrow wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
-guilt great" --passphrase apple
-xpub6CKy5SECeJipZid8dF3bopoMGdRzd7hMJuPzMGesZCobrMSssZyASexzXuzRTPVLcqqdyAEZJKPMGvDthgZW2Z3mPHLohxEAVbkvGKAXjqx
-```
-### QR Code Generation
-
-```bash-qrcode
-alice@cold.machine:~$ burrow wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
-guilt great" --passphrase apple -q
-
-█▀▀▀▀▀█ ▄█   █▄█ ▀▄▀ ▀▄▄▄██▄  █▀▄ █▀▀▀▀▀█
-█ ███ █ ▀  ▀▄█▄▄▄▄██▄▄▄█  █  █▄   █ ███ █
-█ ▀▀▀ █ █▄▀ █▄█▄▄▄▀█▀▄  ▄▀▀█▀ ▄▄▄ █ ▀▀▀ █
-▀▀▀▀▀▀▀ █▄▀▄█ ▀▄█▄▀ ▀▄█ █ █▄▀▄▀ ▀ ▀▀▀▀▀▀▀
-██ █  ▀█    ███ ██  ▄█▄▀▄▀▀██ █▀▄▄▀▀▀ ▀▀▄
-██ ▀ █▀█▄▀█▄██▀ ▀ █▀ ▄▄▄▀██ █▀▀▀█ █▀  █▀
-█▀█▄  ▀█▀▀ ▄█▄█▄▀ █▀█  ██▀▄█▀ ▄██▀█ ▀   ▀
-▀██   ▀▄▄▀▄ ██ ▀██▄▀▄█▀▀█▄▀▄▀█▀▄▄▀▀█▄▀ █▀
-▀█▄▄ ▀▀▄ ▀▀▀▄▀ ██▄▄ ▀ ▀ █▀ ▀▄▀ █ █ █▀█▄ ▄
-███ █ ▀██ ▀▄▀█ ▄▄▀ ▄ ▄█▄▄ ▀▄██▄ ▀▄█▀▀  ▀▀
-▀█▄█▄ ▀ ▀▄▄█  ▀▄ █ ▄▀▀  ▄▄▀▄█▄█ ██▀▀▀▀▀ █
-▀ ▀▀▄ ▀▄█ ▄  ██▄▀▀██▄▄█▄ ▄█▄   █▀ ▄ ▄▀██
-█ ▀▄▄▄▀█▀██▄▄▀▄▄▀█▄ █ ▄██▀▄  ▄ ▄▄█▀█ █ ▄
-▀ ██ ▀▀▀▄ ▀██▄▄▄ ██  █▀█▀▄█ ▄▄▀▄▀▀ ▄█ ▀█▀
-▀▄▄█ █▀ █▄▀ ██▀█▄ █▄▀████▀▄██ ▄▄▀█ █▀█▀▀█
-▀  ▄▄ ▀▄▄▄▄▀█ ▄▀▀█████  ▀▀▀▄ █ ▄█▀█▀▀█▀▀▀
-▀ ▀▀  ▀▀▄▀▀▄▄▀█▀▄ ▄███ ▀██▀▀█ █▄█▀▀▀█▄ █
-█▀▀▀▀▀█ ▀▄█▄▀ ▄  █ ▀▄▄▄▄▄█▀  ▀▀ █ ▀ █ ▄█▄
-█ ███ █ ▄ █▄ ▄ █▄▄  ▀█  █ ▄ ▀██ █▀█▀█ ▀█▀
-█ ▀▀▀ █ ▄▄▀█ █ ▄ ▄█▄ ▄▄▀█▄▀  ▄█ █ ▀ █▀ █▀
-▀▀▀▀▀▀▀ ▀▀   ▀  ▀    ▀▀   ▀  ▀  ▀▀▀  ▀▀▀
-alice@cold.machine:~$ 
-```
-
-### Wallet Options
-
-```bash
-usage: burrow wallet
- -h,--help                      display help message
- -p,--passphrase <PASSPHRASE>   optional seed passphrase
- -s,--sentence <SENTENCE>       mnemonic sentence
- -q,--qrcode                    optional seed passphrase
-```
+* Find the distribution `.tar` file in `build/distributions/`

build.gradle

@@ -8,7 +8,7 @@ plugins {
 repositories {
 
     maven {
-        url "https://repo.rudefox.io/repository/maven-public/"
+        url "https://repo.rudefox.io/repository/maven-releases/"
     }
 	
     mavenCentral()
@@ -17,15 +17,20 @@ repositories {
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
-def isRelease = versionDetails().commitDistance == 0
-
 group 'io.rudefox'
-version isRelease ? gitVersion.call() : gitVersion.call() + "-SNAPSHOT"
 
 application {
     mainClassName = 'io.rudefox.burrow.RudefoxBurrow'
 }
 
+def isRelease = versionDetails().commitDistance == 0 &&
+        versionDetails().isCleanTag &&
+        ((versionDetails().branchName == 'master') || (versionDetails().branchName == 'null'))
+
+version isRelease ? gitVersion.call() : gitVersion.call() + "-${versionDetails().branchName}-SNAPSHOT"
+
+println "${group}:${project.name}:${version}" + ' ' + (isRelease ? '(RELEASE)' : '(SNAPSHOT)')
+
 run {
     standardInput = System.in
 }
@@ -41,9 +46,10 @@ tasks.withType(Test) {
 }
 
 dependencies {
-    compile 'io.rudefox:vixen:0.0.2'
-    compile 'info.picocli:picocli:4.0.4'
+    compile 'io.rudefox:vixen:0.0.3'
+    compile 'info.picocli:picocli:4.5.1'
     compile 'com.google.zxing:core:3.4.0'
+    compile 'com.diogonunes:JColor:5.0.0'
     testCompile 'com.bjdweck.test:commons-test:0.0.1'
     testCompile "org.junit.jupiter:junit-jupiter-params:$junitVersion"
     testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"

src/main/java/io/rudefox/burrow/Dice8EntropyGenerator.java

@@ -1,115 +0,0 @@
-package io.rudefox.burrow;
-
-import com.bjdweck.bitcoin.mnemonic.Entropy;
-
-import java.util.Scanner;
-import java.util.regex.Pattern;
-
-public class Dice8EntropyGenerator {
-
-    public static final int DICE_PER_ROLL = 11;
-
-    private final int targetBitsOfEntropy;
-    private final Scanner inputScanner;
-
-    private Entropy entropy = new Entropy();
-
-    public Dice8EntropyGenerator(int targetBitsOfEntropy, Scanner inputScanner) {
-
-        this.targetBitsOfEntropy = targetBitsOfEntropy;
-        this.inputScanner = inputScanner;
-    }
-
-    Entropy generate() {
-
-        entropy = new Entropy();
-
-        for (int rollSetCount = 0; entropy.getBitLength() < targetBitsOfEntropy; rollSetCount++)
-            doDiceRoll(rollSetCount);
-
-        return entropy.truncate(targetBitsOfEntropy).appendChecksum();
-    }
-
-    private void doDiceRoll(int currentRollSet) {
-
-        String eventString = scanNextRollSetString();
-
-        StringBuilder rollValuesLine = new StringBuilder("|");
-
-        for (int rollNumber = 0; rollNumber < DICE_PER_ROLL; rollNumber++) {
-
-            int rollValue = Integer.parseInt(eventString.charAt(rollNumber) + "");
-
-            String formatString =
-                    rollNumber == 3 || rollNumber == 7 ? "  %d   |" : " %d |";
-
-            rollValuesLine.append(String.format(formatString, rollValue));
-
-            entropy = entropy.appendBits(rollValue - 1, 3);
-        }
-
-        System.out.printf("%n%s%n%s%n%s%n%n",
-                rollValuesLine,
-                getBitsLine(),
-                getSeedWordsLine(currentRollSet)
-        );
-    }
-
-    private String scanNextRollSetString() {
-
-        String rollSetString = "";
-        Pattern rollSetPattern = Pattern.compile(String.format("[1-8]{%d}", DICE_PER_ROLL));
-
-        while (!rollSetPattern.matcher(rollSetString).matches()) {
-            System.out.print("Input 11 x 8-sided dice rolls [1-8]: ");
-            rollSetString = inputScanner.next();
-        }
-
-        return rollSetString;
-    }
-
-    private StringBuilder getBitsLine() {
-
-        String entropyBitString = entropy.toString();
-
-        String currentRollSetBitString =
-                entropyBitString.substring(entropyBitString.length() - (DICE_PER_ROLL * 3));
-
-        StringBuilder rollSetBitsLine = new StringBuilder("|");
-        for (int rollSetBitIndex = 0; rollSetBitIndex < currentRollSetBitString.length(); rollSetBitIndex++) {
-
-            int entropyBitIndex = entropyBitString.length() - currentRollSetBitString.length() + rollSetBitIndex;
-
-            if (entropyBitIndex < targetBitsOfEntropy)
-                rollSetBitsLine.append(currentRollSetBitString.charAt(rollSetBitIndex));
-            else
-                rollSetBitsLine.append("-");
-
-            if (rollSetBitIndex == 32) rollSetBitsLine.append("|");
-            else if (rollSetBitIndex % 3 == 2) rollSetBitsLine.append(" ");
-            else if (rollSetBitIndex % 11 == 10) rollSetBitsLine.append(" | ");
-        }
-
-        return rollSetBitsLine;
-    }
-
-    private String getSeedWordsLine(int rollSet) {
-
-        int baseIndex = rollSet * 3;
-
-        return String.format(
-                "|%-15s|%-17s|%-15s|",
-                getFormattedSeedWord(baseIndex),
-                getFormattedSeedWord(baseIndex + 1),
-                getFormattedSeedWord(baseIndex + 2));
-    }
-
-    private String getFormattedSeedWord(int index) {
-
-        int lastWordIndex = (3 * targetBitsOfEntropy / 32) - 1;
-
-        String seedWord = index != lastWordIndex ? entropy.getWord(index) : "CHECKWORD";
-
-        return String.format(" %2d. %s", index + 1, seedWord);
-    }
-}

src/main/java/io/rudefox/burrow/EventBuffer.java

@@ -3,31 +3,43 @@ package io.rudefox.burrow;
 import com.bjdweck.bitcoin.mnemonic.Entropy;
 import com.bjdweck.math.UnsignedInt;
 
-class DiceEventBuffer {
+class EventBuffer {
 
-    private final int diceBase;
+    private final int eventBase;
     private final StringBuilder buffer;
     private final int targetBitsOfEntropy;
 
-    DiceEventBuffer(int targetBitsOfEntropy, int diceBase) {
+    EventBuffer(int targetBitsOfEntropy, int eventBase) {
 
-        this.diceBase = diceBase;
+        this.eventBase = eventBase;
         this.targetBitsOfEntropy = targetBitsOfEntropy;
         this.buffer = new StringBuilder(getRequiredEvents());
     }
 
     int getRequiredEvents() {
-        return (int) Math.ceil(this.targetBitsOfEntropy * Math.log(2) / Math.log(diceBase));
+        return (int) Math.ceil(this.targetBitsOfEntropy * Math.log(2) / Math.log(eventBase));
     }
 
-    void appendEvents(String eventString) {
+    void appendBinaryEvents(String eventString) {
+        for (char inChar : eventString.toCharArray())
+            if (inChar >= '0' && inChar <= '1' && events() < getRequiredEvents())
+                append(inChar);
+    }
+
+    void appendD6Events(String eventString) {
         for (char inChar : eventString.toCharArray())
             if (inChar >= '1' && inChar <= '6' && events() < getRequiredEvents())
                 append((char) (inChar - 1));
     }
 
+    void appendD8Events(String eventString) {
+        for (char inChar : eventString.toCharArray())
+            if (inChar >= '1' && inChar <= '8' && events() < getRequiredEvents())
+                append((char) (inChar - 1));
+    }
+
     Entropy toEntropy() {
-        UnsignedInt entropy = new UnsignedInt(toString(), diceBase);
+        UnsignedInt entropy = new UnsignedInt(toString(), eventBase);
         byte[] entropyBytes = entropy.getLowestOrderBits(this.targetBitsOfEntropy).toBigEndianByteArray();
         return Entropy.fromRawEntropy(entropyBytes);
     }

src/main/java/io/rudefox/burrow/InteractiveBinaryEntropyGenerator.java

@@ -0,0 +1,74 @@
+package io.rudefox.burrow;
+
+import java.util.Scanner;
+import java.util.regex.Pattern;
+
+public class InteractiveBinaryEntropyGenerator extends InteractiveEntropyGenerator {
+
+    public InteractiveBinaryEntropyGenerator(int targetBitsOfEntropy, Scanner inputScanner, boolean ansiColorOutput) {
+        super(inputScanner, ansiColorOutput, targetBitsOfEntropy, 1);
+    }
+
+    @Override
+    protected String readNextEventSetString() {
+
+        StringBuilder eventSetBuffer = new StringBuilder();
+        int remainingEvents = eventsPerEventSet;
+        Pattern eventSetPattern = Pattern.compile("[01]+");
+
+        while (remainingEvents > 0) {
+
+            System.out.printf("Input %d coin tosses [0-1]: ", remainingEvents);
+
+            String nextInput = inputScanner.next();
+
+            if (!eventSetPattern.matcher(nextInput).matches()) {
+                System.out.printf(
+                        "Invalid input! Enter %d-digit sequence of 1's and 0's (for example, 1011101010)" + System.lineSeparator(),
+                        remainingEvents);
+                continue;
+            }
+
+            eventSetBuffer.append(nextInput);
+            remainingEvents -= nextInput.length();
+        }
+
+        if (remainingEvents < 0)
+            System.out.printf("NOTE: Discarding the %d extra coin toss(es) entered" + System.lineSeparator(), -remainingEvents);
+
+        return eventSetBuffer.substring(0, eventsPerEventSet);
+    }
+
+    @Override
+    protected String getEventValueFormatString(int eventIndexWithinSet) {
+        return "";
+    }
+
+    @Override
+    protected int toZeroBasedInteger(int eventDecimalValue) {
+        return eventDecimalValue;
+    }
+
+    @Override
+    protected void outputEventValuesLine(StringBuilder eventValuesLine) { }
+
+    @Override
+    protected StringBuilder getInitialBitsLine() {
+        return new StringBuilder("| ");
+    }
+
+    @Override
+    protected void padBitsLine(StringBuilder eventSetBitsLine, int bitIndexWithinEventSet, int bitIndexWithinEntropy) {
+        if (bitIndexWithinEventSet == BITS_PER_EVENT_SET - 1)
+            eventSetBitsLine.append(" |");
+        else if (bitIndexWithinEventSet % BITS_PER_WORD == 0 || bitIndexWithinEventSet % BITS_PER_WORD == 6)
+            eventSetBitsLine.append(styleBit(" ", bitIndexWithinEntropy, bitIndexWithinEventSet));
+        else if (bitIndexWithinEventSet % BITS_PER_WORD == BITS_PER_WORD - 1)
+            eventSetBitsLine.append(" | ");
+    }
+
+    @Override
+    protected String getSeedWordLineFormatString() {
+        return "|%-15s|%-15s|%-15s|";
+    }
+}

src/main/java/io/rudefox/burrow/InteractiveDice8EntropyGenerator.java

@@ -0,0 +1,76 @@
+package io.rudefox.burrow;
+
+import java.util.Scanner;
+import java.util.regex.Pattern;
+
+public class InteractiveDice8EntropyGenerator extends InteractiveEntropyGenerator {
+
+    public InteractiveDice8EntropyGenerator(int targetBitsOfEntropy, Scanner inputScanner, boolean ansiColorOutput) {
+        super(inputScanner, ansiColorOutput, targetBitsOfEntropy, 3);
+    }
+
+    @Override
+    protected String readNextEventSetString() {
+
+        StringBuilder eventSetBuffer = new StringBuilder();
+        int remainingEvents = eventsPerEventSet;
+        Pattern eventSetPattern = Pattern.compile("[1-8]+");
+
+        while (remainingEvents > 0) {
+
+            System.out.printf("Input %d x 8-sided dice rolls [1-8]: ", remainingEvents);
+
+            String nextInput = inputScanner.next();
+
+            if (!eventSetPattern.matcher(nextInput).matches()) {
+                System.out.printf(
+                        "Invalid input! Enter %d-digit sequence of digits from 1 to 8 (for example, 8765375812)" + System.lineSeparator(),
+                        remainingEvents);
+                continue;
+            }
+
+            eventSetBuffer.append(nextInput);
+            remainingEvents -= nextInput.length();
+        }
+
+        if (remainingEvents < 0)
+            System.out.printf("NOTE: Discarding the %d extra dice roll(s) entered" + System.lineSeparator(), -remainingEvents);
+
+        return eventSetBuffer.substring(0, eventsPerEventSet);
+    }
+
+    @Override
+    protected String getEventValueFormatString(int eventIndexWithinSet) {
+        return eventIndexWithinSet == bitsPerEvent || eventIndexWithinSet == 7 ? "  %d   |" : " %d |";
+    }
+
+    @Override
+    protected int toZeroBasedInteger(int eventDecimalValue) {
+        return eventDecimalValue - 1;
+    }
+
+    @Override
+    protected void outputEventValuesLine(StringBuilder eventValuesLine) {
+        System.out.println(eventValuesLine);
+    }
+
+    @Override
+    protected StringBuilder getInitialBitsLine() {
+        return new StringBuilder("|");
+    }
+
+    @Override
+    protected void padBitsLine(StringBuilder eventSetBitsLine, int bitIndexWithinEventSet, int bitIndexWithinEntropy) {
+        if (bitIndexWithinEventSet == BITS_PER_EVENT_SET - 1)
+            eventSetBitsLine.append("|");
+        else if (bitIndexWithinEventSet % bitsPerEvent == bitsPerEvent - 1)
+            eventSetBitsLine.append(styleBit(" ", bitIndexWithinEntropy, bitIndexWithinEventSet));
+        else if (bitIndexWithinEventSet % BITS_PER_WORD == BITS_PER_WORD - 1)
+            eventSetBitsLine.append(" | ");
+    }
+
+    @Override
+    protected String getSeedWordLineFormatString() {
+        return "|%-15s|%-17s|%-15s|";
+    }
+}

src/main/java/io/rudefox/burrow/InteractiveEntropyGenerator.java

@@ -0,0 +1,154 @@
+package io.rudefox.burrow;
+
+import com.bjdweck.bitcoin.mnemonic.Entropy;
+import com.diogonunes.jcolor.AnsiFormat;
+
+import java.util.Scanner;
+
+import static com.diogonunes.jcolor.Attribute.*;
+
+public abstract class InteractiveEntropyGenerator {
+
+    public static final int WORDS_PER_EVENT_SET = 3;
+    public static final int BITS_PER_WORD = 11;
+    public static final int BITS_PER_EVENT_SET = WORDS_PER_EVENT_SET * BITS_PER_WORD;
+
+    public static final AnsiFormat RED_STYLE = new AnsiFormat(WHITE_TEXT(), RED_BACK(), BOLD());
+    public static final AnsiFormat GREEN_STYLE = new AnsiFormat(BLACK_TEXT(), GREEN_BACK(), BOLD());
+    public static final AnsiFormat BLUE_STYLE = new AnsiFormat(WHITE_TEXT(), BLUE_BACK(), BOLD());
+
+    private Entropy entropy = new Entropy();
+
+    protected final int targetBitsOfEntropy;
+    protected final int bitsPerEvent;
+    protected final int eventsPerEventSet;
+
+    protected final Scanner inputScanner;
+    protected final boolean ansiColorOutput;
+
+    protected InteractiveEntropyGenerator(Scanner inputScanner, boolean ansiColorOutput, int targetBitsOfEntropy, int bitsPerEvent) {
+
+        this.targetBitsOfEntropy = targetBitsOfEntropy;
+        this.bitsPerEvent = bitsPerEvent;
+        this.eventsPerEventSet = BITS_PER_EVENT_SET / this.bitsPerEvent;
+
+        this.inputScanner = inputScanner;
+        this.ansiColorOutput = ansiColorOutput;
+    }
+
+    Entropy generate() {
+
+        entropy = new Entropy();
+
+        for (int eventSetIndex = 0; entropy.getBitLength() < targetBitsOfEntropy; eventSetIndex++) {
+
+            String eventString = readNextEventSetString();
+            StringBuilder eventValuesLine = processEventSetString(eventString);
+
+            System.out.println();
+
+            outputEventValuesLine(eventValuesLine);
+
+            System.out.println(getBitsLine());
+            System.out.println(getSeedWordsLine(eventSetIndex));
+            System.out.println();
+        }
+
+        Entropy truncatedEntropy = entropy.truncate(targetBitsOfEntropy);
+        return truncatedEntropy.appendChecksum();
+    }
+
+    private StringBuilder processEventSetString(String eventString) {
+
+        StringBuilder eventValuesLine = new StringBuilder("|");
+
+        for (int eventIndexWithinSet = 0; eventIndexWithinSet < eventsPerEventSet; eventIndexWithinSet++) {
+
+            int eventDecimalValue = Integer.parseInt(eventString.charAt(eventIndexWithinSet) + "");
+
+            eventValuesLine.append(String.format(getEventValueFormatString(eventIndexWithinSet), eventDecimalValue));
+
+            entropy = entropy.appendBits(toZeroBasedInteger(eventDecimalValue), bitsPerEvent);
+        }
+
+        return eventValuesLine;
+    }
+
+    private StringBuilder getBitsLine() {
+
+        String entropyBitString = entropy.toString();
+
+        String eventSetBitString = entropyBitString.substring(entropyBitString.length() - BITS_PER_EVENT_SET);
+
+        StringBuilder bitsLine = getInitialBitsLine();
+
+        for (int bitIndexWithinEventSet = 0; bitIndexWithinEventSet < eventSetBitString.length(); bitIndexWithinEventSet++) {
+
+            int binIndexWithinEntropy = entropyBitString.length() - eventSetBitString.length() + bitIndexWithinEventSet;
+
+            if (binIndexWithinEntropy < targetBitsOfEntropy)
+                bitsLine.append(styleBit("" + eventSetBitString.charAt(bitIndexWithinEventSet), binIndexWithinEntropy, bitIndexWithinEventSet));
+            else
+                bitsLine.append("-");
+
+            padBitsLine(bitsLine, bitIndexWithinEventSet, binIndexWithinEntropy);
+        }
+
+        return bitsLine;
+    }
+
+    String styleBit(String bit, int bitIndexWithinEntropy, int bitIndexWithinEventSet) {
+
+        if (!ansiColorOutput || bitIndexWithinEntropy >= targetBitsOfEntropy)
+            return bit;
+
+        return getBitColor(bitIndexWithinEventSet).format(bit);
+    }
+
+    private AnsiFormat getBitColor(int bitIndexWithinEventSet) {
+
+        int bitIndexWithinWord = bitIndexWithinEventSet % BITS_PER_WORD;
+
+        if (bitIndexWithinWord == 0)
+            return RED_STYLE;
+
+        if (bitIndexWithinWord <= 6)
+            return GREEN_STYLE;
+
+        return BLUE_STYLE;
+    }
+
+    private String getSeedWordsLine(int eventSetIndex) {
+
+        int firstWordIndex = eventSetIndex * WORDS_PER_EVENT_SET;
+
+        return String.format(
+                getSeedWordLineFormatString(),
+                getFormattedSeedWord(firstWordIndex),
+                getFormattedSeedWord(firstWordIndex + 1),
+                getFormattedSeedWord(firstWordIndex + 2));
+    }
+
+    private String getFormattedSeedWord(int wordIndex) {
+
+        int lastWordIndex = WORDS_PER_EVENT_SET * targetBitsOfEntropy / (BITS_PER_EVENT_SET - 1) - 1;
+
+        String seedWord = wordIndex != lastWordIndex ? entropy.getWord(wordIndex) : "CHECKWORD";
+
+        return String.format(" %2d. %s", wordIndex + 1, seedWord);
+    }
+
+    protected abstract String readNextEventSetString();
+
+    protected abstract String getEventValueFormatString(int eventIndexWithinSet);
+
+    protected abstract int toZeroBasedInteger(int eventDecimalValue);
+
+    protected abstract void outputEventValuesLine(StringBuilder eventValuesLine);
+
+    protected abstract void padBitsLine(StringBuilder eventSetBitsLine, int bitIndexWithinEventSet, int bitIndexWithinEntropy);
+
+    protected abstract StringBuilder getInitialBitsLine();
+
+    protected abstract String getSeedWordLineFormatString();
+}

src/main/java/io/rudefox/burrow/MnemonicCommand.java

@@ -11,14 +11,19 @@ public class MnemonicCommand implements Runnable {
 
     private static final int DEFAULT_BITS_OF_ENTROPY = 256;
 
-    private boolean isDiceEntropy() {
-        return entropyOptions != null && (entropyOptions.isDice6Entropy || entropyOptions.isDice8Entropy);
+    private boolean isCustomEntropy() {
+        return entropyOptions != null &&
+                (entropyOptions.isDice6Entropy || entropyOptions.isDice8Entropy || entropyOptions.isBinaryEntropy);
     }
 
     private boolean isInteractiveMode() {
         return entropyOptions != null && entropyOptions.eventMethod.isInteractiveMode;
     }
 
+    private boolean isBinaryInteractiveMode() {
+        return isInteractiveMode() && entropyOptions.isBinaryEntropy;
+    }
+
     private boolean isDice6InteractiveMode() {
         return isInteractiveMode() && entropyOptions.isDice6Entropy;
     }
@@ -32,6 +37,10 @@ public class MnemonicCommand implements Runnable {
 
     static class EntropyOptions {
 
+        @CommandLine.Option(names = {"-2", "--binary-entropy"},
+                description = "use a coin toss or other binary entropy source")
+        boolean isBinaryEntropy;
+
         @CommandLine.Option(names = {"-6", "--dice6-entropy"},
                 description = "use 6-sided dice entropy source")
         boolean isDice6Entropy;
@@ -45,7 +54,7 @@ public class MnemonicCommand implements Runnable {
 
         static class EventMethod {
 
-            @CommandLine.Option(names = {"-e", "--events"}, paramLabel = "[1-6]{100}|[1-8]{86}",
+            @CommandLine.Option(names = {"-e", "--events"}, paramLabel = "[0-1]{256} | [1-6]{100} | [1-8]{86}",
                     description = "string representing events from entropy source",
                     required = true)
             String getEventString;
@@ -71,50 +80,58 @@ public class MnemonicCommand implements Runnable {
 
     Entropy getEntropy() {
 
-        if (!isDiceEntropy())
-            return getGeneratedEntropy();
+        if (!isCustomEntropy())
+            return generateEntropy();
 
-        DiceEventBuffer diceEventBuffer;
-
-        if (entropyOptions.isDice6Entropy)
-            diceEventBuffer = new DiceEventBuffer(this.targetBitsOfEntropy, 6);
-        else
-            diceEventBuffer = new DiceEventBuffer(this.targetBitsOfEntropy, 8);
+        if (isBinaryInteractiveMode())
+            return new InteractiveBinaryEntropyGenerator(targetBitsOfEntropy, new Scanner(System.in), CommandLine.Help.Ansi.AUTO.enabled()).generate();
 
         if (isDice6InteractiveMode())
-            return getDice6EntropyInteractive(diceEventBuffer);
+            return getDice6EntropyInteractive(new EventBuffer(this.targetBitsOfEntropy, 6));
 
         if (isDice8InteractiveMode())
-            return new Dice8EntropyGenerator(targetBitsOfEntropy, new Scanner(System.in)).generate();
+            return new InteractiveDice8EntropyGenerator(targetBitsOfEntropy, new Scanner(System.in), CommandLine.Help.Ansi.AUTO.enabled()).generate();
 
-        diceEventBuffer.appendEvents(entropyOptions.eventMethod.getEventString);
-        return diceEventBuffer.toEntropy();
+        EventBuffer eventBuffer;
+
+        if (entropyOptions.isBinaryEntropy) {
+            eventBuffer = new EventBuffer(this.targetBitsOfEntropy, 2);
+            eventBuffer.appendBinaryEvents(entropyOptions.eventMethod.getEventString);
+        } else if (entropyOptions.isDice6Entropy) {
+            eventBuffer = new EventBuffer(this.targetBitsOfEntropy, 6);
+            eventBuffer.appendD6Events(entropyOptions.eventMethod.getEventString);
+        } else {
+            eventBuffer = new EventBuffer(this.targetBitsOfEntropy, 8);
+            eventBuffer.appendD8Events(entropyOptions.eventMethod.getEventString);
+        }
+
+        return eventBuffer.toEntropy();
     }
 
-    private Entropy getDice6EntropyInteractive(DiceEventBuffer diceEventBuffer) {
+    private Entropy getDice6EntropyInteractive(EventBuffer eventBuffer) {
 
-        int requiredEvents = diceEventBuffer.getRequiredEvents();
+        int requiredEvents = eventBuffer.getRequiredEvents();
 
         Scanner scanner = new Scanner(System.in);
 
         boolean firstIteration = true;
 
-        while (diceEventBuffer.events() < requiredEvents) {
+        while (eventBuffer.events() < requiredEvents) {
 
-            int remainingEvents = requiredEvents - diceEventBuffer.events();
-            System.out.print(String.format("Input %d %sdice rolls [1-6]: ", remainingEvents, (firstIteration ? "" : "more ")));
+            int remainingEvents = requiredEvents - eventBuffer.events();
+            System.out.printf("Input %d %sdice rolls [1-6]: ", remainingEvents, (firstIteration ? "" : "more "));
 
             String inputString = scanner.next();
 
-            diceEventBuffer.appendEvents(inputString);
+            eventBuffer.appendD6Events(inputString);
 
             firstIteration = false;
         }
 
-        return diceEventBuffer.toEntropy();
+        return eventBuffer.toEntropy();
     }
 
-    private Entropy getGeneratedEntropy() {
+    private Entropy generateEntropy() {
 
         SecureRandom random = new SecureRandom();
         int byteLength = targetBitsOfEntropy / 8;

src/main/java/io/rudefox/burrow/RudefoxBurrow.java

@@ -2,13 +2,14 @@ package io.rudefox.burrow;
 
 import com.bjdweck.bitcoin.params.INetworkParameters;
 import com.bjdweck.bitcoin.params.NetworkParameters;
+import picocli.AutoComplete;
 import picocli.CommandLine;
 
 @CommandLine.Command(
         name = "burrow",
         synopsisSubcommandLabel = "COMMAND",
         description = "Offline wallet tool",
-        subcommands = {MnemonicCommand.class, WalletCommand.class}
+        subcommands = {MnemonicCommand.class, WalletCommand.class, AutoComplete.GenerateCompletion.class}
 )
 public class RudefoxBurrow implements Runnable {
 

src/test/java/io/rudefox/burrow/coin_entropy_tests.java

@@ -0,0 +1,62 @@
+package io.rudefox.burrow;
+
+import com.bjdweck.test.CliTestFixture;
+import org.junit.jupiter.api.Test;
+
+import java.io.UnsupportedEncodingException;
+
+class coin_entropy_tests extends CliTestFixture {
+
+    @Test
+    void with_arguments_interactive_coin_should_generate_mnemonic_sentence() throws UnsupportedEncodingException {
+
+        System.setProperty("picocli.ansi", "false");
+
+        withArgs("mnemonic -i2 --bits 128");
+
+        expectedOutput("Input 33 coin tosses [0-1]: ");
+        provideInput("000001010011100101110111000001010" + EOL);
+
+        expectedOutput(EOL);
+        expectedOutput("| 0 000010 1001 | 1 100101 1101 | 1 100000 1010 |" + EOL);
+        expectedOutput("|  1. ahead     |  2. slight    |  3. scout     |" + EOL);
+        expectedOutput(EOL);
+
+        expectedOutput("Input 33 coin tosses [0-1]: ");
+        provideInput("000001010011100101110111000001010" + EOL);
+
+        expectedOutput(EOL);
+        expectedOutput("| 0 000010 1001 | 1 100101 1101 | 1 100000 1010 |" + EOL);
+        expectedOutput("|  4. ahead     |  5. slight    |  6. scout     |" + EOL);
+        expectedOutput(EOL);
+
+        expectedOutput("Input 33 coin tosses [0-1]: ");
+        provideInput("000001010011100101110111000001010" + EOL);
+
+        expectedOutput(EOL);
+        expectedOutput("| 0 000010 1001 | 1 100101 1101 | 1 100000 1010 |" + EOL);
+        expectedOutput("|  7. ahead     |  8. slight    |  9. scout     |" + EOL);
+        expectedOutput(EOL);
+
+        expectedOutput("Input 33 coin tosses [0-1]: ");
+        provideInput("000001010011100101110111000001010" + EOL);
+
+        expectedOutput(EOL);
+        expectedOutput("| 0 000010 1001 | 1 100101 1101 | 1 100000 ---- |" + EOL);
+        expectedOutput("| 10. ahead     | 11. slight    | 12. CHECKWORD |" + EOL);
+        expectedOutput(EOL);
+
+        expectedOutput("ahead slight scout ahead slight scout ahead slight scout ahead slight scan" + EOL);
+
+        doMain();
+
+        verifyOutput();
+    }
+
+    private void doMain() {
+
+        setInput();
+
+        RudefoxBurrow.main(getArgs());
+    }
+}

src/test/java/io/rudefox/burrow/mnemonic_8_sided_dice_tests.java

@@ -10,6 +10,8 @@ class mnemonic_8_sided_dice_tests extends CliTestFixture {
     @Test
     void with_arguments_interactive_8_sided_dice_should_generate_mnemonic_sentence() throws UnsupportedEncodingException {
 
+        System.setProperty("picocli.ansi", "false");
+
         withArgs("mnemonic -i8 --bits 128");
 
         expectedOutput("Input 11 x 8-sided dice rolls [1-8]: ");

src/test/java/io/rudefox/burrow/mnemonic_command_tests.java

@@ -49,6 +49,18 @@ class mnemonic_command_tests extends CliTestFixture {
         verifyOutput();
     }
 
+    @Test
+    void with_arguments_non_interactive_binary_entropy_should_generate_mnemonic_sentence() throws UnsupportedEncodingException {
+
+        withArgs("mnemonic --binary-entropy --events 10100101010010101010101000101010101001010100101010101010001010101010010101001010101010100010101010100101010010101010101000101010 --bits 128");
+
+        expectedOutput("pipe fetch melt enhance primary best news fetch click clean pride feed" + EOL);
+
+        doMain();
+
+        verifyOutput();
+    }
+
     @Test
     void with_arguments_without_interactive_dice_should_generate_mnemonic_sentence() throws UnsupportedEncodingException {
 
@@ -62,6 +74,18 @@ class mnemonic_command_tests extends CliTestFixture {
         verifyOutput();
     }
 
+    @Test
+    void with_arguments_without_interactive_d8_dice_should_generate_mnemonic_sentence() throws UnsupportedEncodingException {
+
+        withArgs("mnemonic --dice8-entropy --events 23438688738737812541514768125415147632873218 --bits 128");
+
+        expectedOutput("fashion wave tourist notice alert marine vote alert marine vocal dish aware" + EOL);
+
+        doMain();
+
+        verifyOutput();
+    }
+
     private void doMain() {
 
         setInput();