Renamed project from 'cold' to 'burrow'

.gitignore

@@ -129,4 +129,6 @@ gradle-app.setting
 ### Gradle Patch ###
 **/build/
 
+gradle.properties
+
 # End of https://www.gitignore.io/api/java,gradle,intellij

README.md

@@ -1,14 +1,38 @@
-# Rudefox Cold
+# Rudefox Burrow
 
-Rudefox is a pair of command line tools for the creation and management of Bitcoin wallets.
+Rudefox provides a pair of command line tools for the creation and management of Bitcoin wallets.
 
-+ Use `rudefox-cold` on an air-gapped single-board computer, like a Raspberry Pi, to generate new wallets, obtain addresses and extended public keys from existing wallets and sign transactions offline.
++ 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 `rudefox-hot` on a connected device to view your balance and utxo's and to create new, unsigned transactions.
++ Use `reynard` on a connected ("hot") device to view your balance and utxo's and to create new, unsigned transactions.
 
-## Mnemonic Generation
+## 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
-[email protected]:~$ rudefox-cold mnemonic --interactive --dice-entropy --bits 128
+[email protected]:~$ 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
+```
+
+## Menemonic Generation
+
+```bash
+[email protected]:~$ 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
@@ -17,7 +41,7 @@ Mnemonic Sentence: mountain tilt wing silk rude fox almost volume wine media ver
 ### Mnemonic Options
 
 ```bash
-usage: rudefox-cold mnemonic
+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
@@ -28,14 +52,14 @@ usage: rudefox-cold mnemonic
 ## Xpub Export
 
 ```bash
-[email protected]:~$ rudefox-cold wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
+[email protected]:~$ burrow wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
 guilt great" --passphrase apple
 xpub6CKy5SECeJipZid8dF3bopoMGdRzd7hMJuPzMGesZCobrMSssZyASexzXuzRTPVLcqqdyAEZJKPMGvDthgZW2Z3mPHLohxEAVbkvGKAXjqx
 ```
 ### QR Code Generation
 
 ```bash-qrcode
-[email protected]:~$ rudefox-cold wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
+[email protected]:~$ burrow wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
 guilt great" --passphrase apple -q
 
 █▀▀▀▀▀█ ▄█   █▄█ ▀▄▀ ▀▄▄▄██▄  █▀▄ █▀▀▀▀▀█
@@ -65,13 +89,9 @@ [email protected]:~$
 ### Wallet Options
 
 ```bash
-usage: rudefox-cold wallet
+usage: burrow wallet
  -h,--help                      display help message
  -p,--passphrase <PASSPHRASE>   optional seed passphrase
  -s,--sentence <SENTENCE>       mnemonic sentence
  -q,--qrcode                    optional seed passphrase
 ```
-
-# Pending Use Cases
-
-- verify seed in interactive mode

build.gradle

@@ -8,7 +8,7 @@ plugins {
 repositories {
 
     maven {
-        url "https://repo.rudefox.io/maven-public"
+        url "https://repo.rudefox.io/repository/maven-public/"
     }
 	
     mavenCentral()
@@ -23,14 +23,17 @@ group 'io.rudefox'
 version isRelease ? gitVersion.call() : gitVersion.call() + "-SNAPSHOT"
 
 application {
-    applicationName 'rudefox-cold'
+    mainClassName = 'io.rudefox.burrow.RudefoxBurrow'
-    mainClassName = 'io.rudefox.cold.RudefoxCold'
 }
 
 run {
     standardInput = System.in
 }
 
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+}
+
 def junitVersion = "5.6.2"
 
 tasks.withType(Test) {
@@ -50,12 +53,14 @@ dependencies {
 publishing {
 
     publications {
-        jar(MavenPublication) {
+        distro(MavenPublication) {
             from components.java
+            artifact distZip
+            artifact distTar
             pom {
                 name = 'Rudefox Burrow'
                 description = 'Bitcoin offline seed generation and tools'
-                url = 'https://rudefox.io'
+                url = 'https://rudefox.io/burrow'
                 developers {
                     developer {
                         name = 'B.J. Dweck'

gradle.properties.sample

@@ -1,15 +1,2 @@
-# bitcoind connection info for integration testing
+rudefox_maven_username=john
-bitcoind_host=backend.sample.com
+rudefox_maven_password=mypassword
-bitcoind_port=8332
-bitcoind_username=admin
-bitcoind_password=l6RYSFfGHosjvHDfK_f7GSBkdGHk26fjHchZrJ87dSH=
-
-# public esplora URL for integration testing
-esplora_url=http://backend.sample.com:8080
-esplora_testnet_url=http://backend.sample.com:8081/testnet/
-
-# web server credentials for website deployment (use in the ':deployWebsite' task)
-webserver_host=web.sample.com
-webserver_user=http_admin
-webserver_password=mycrazypassword
-webserver_target_dir=/path/to/webroot/without-ending-slash

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,183 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=`expr $i + 1`
+    done
+    case $i in
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,100 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.bitcoin.mnemonic.Entropy;
 

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.bitcoin.mnemonic.Entropy;
 import com.bjdweck.math.UnsignedInt;

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.bitcoin.mnemonic.Entropy;
 import picocli.CommandLine;

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.google.zxing.BarcodeFormat;
 import com.google.zxing.EncodeHintType;

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

@@ -1,16 +1,16 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.bitcoin.params.INetworkParameters;
 import com.bjdweck.bitcoin.params.NetworkParameters;
 import picocli.CommandLine;
 
 @CommandLine.Command(
-        name = "rudefox-cold",
+        name = "burrow",
         synopsisSubcommandLabel = "COMMAND",
         description = "Offline wallet tool",
         subcommands = {MnemonicCommand.class, WalletCommand.class}
 )
-public class RudefoxCold implements Runnable {
+public class RudefoxBurrow implements Runnable {
 
     @CommandLine.Option(names = "--testnet", description = "run on Bitcoin Testnet (default: Mainnet)")
     boolean testnet = false;
@@ -20,7 +20,7 @@ public class RudefoxCold implements Runnable {
     }
 
     public static void main(String[] args) {
-        new CommandLine(new RudefoxCold()).execute(args);
+        new CommandLine(new RudefoxBurrow()).execute(args);
     }
 
     @CommandLine.Spec

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import java.nio.charset.Charset;
 

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.bitcoin.address.BitcoinAddress;
 import com.bjdweck.bitcoin.extendedkey.AddressChain;
@@ -19,7 +19,7 @@ import picocli.CommandLine;
 public class WalletCommand implements Runnable {
 
     @CommandLine.ParentCommand
-    private RudefoxCold globalOptions;
+    private RudefoxBurrow globalOptions;
 
     @CommandLine.Option(names = {"-s", "--sentence"}, description = "mnemonic sentence", required = true)
     String sentence;

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.test.CliTestFixture;
 import org.junit.jupiter.api.Test;
@@ -59,6 +59,6 @@ class mnemonic_8_sided_dice_tests extends CliTestFixture {
 
         setInput();
 
-        RudefoxCold.main(getArgs());
+        RudefoxBurrow.main(getArgs());
     }
 }

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.test.CliTestFixture;
 import org.junit.jupiter.api.Test;
@@ -66,6 +66,6 @@ class mnemonic_command_tests extends CliTestFixture {
 
         setInput();
 
-        RudefoxCold.main(getArgs());
+        RudefoxBurrow.main(getArgs());
     }
 }

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

@@ -1,4 +1,4 @@
-package io.rudefox.cold;
+package io.rudefox.burrow;
 
 import com.bjdweck.test.CliTestFixture;
 import org.junit.jupiter.api.Test;
@@ -140,6 +140,6 @@ class wallet_command_tests extends CliTestFixture {
 
         ServiceLocator.DEFAULT_CHARSET = StandardCharsets.UTF_8;
 
-        RudefoxCold.main(getArgs());
+        RudefoxBurrow.main(getArgs());
     }
 }