commit 61ca488a6a5e087df7e921ea92b2a1f8107cc9ef Author: Craig Raw Date: Wed Oct 14 13:07:00 2020 +0200 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3dcdd50 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.idea +.gradle +*iml +build +/*.properties +out +*.log +build-*.sh +.DS_Store \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f433b1a --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/LICENSE (URKit) b/LICENSE (URKit) new file mode 100644 index 0000000..cc351b2 --- /dev/null +++ b/LICENSE (URKit) @@ -0,0 +1,19 @@ +BSD-2-Clause Plus Patent License + +SPDX-License-Identifier: [BSD-2-Clause-Patent](https://spdx.org/licenses/BSD-2-Clause-Patent.html) + +Copyright © 2020 Blockchain Commons, LLC + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by: + +(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or +(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution. +Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise. + +DISCLAIMER + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..cdc57c5 --- /dev/null +++ b/build.gradle @@ -0,0 +1,15 @@ +plugins { + id 'java-library' +} + +group 'com.sparrowwallet' +version '1.1' + +repositories { + mavenCentral() +} + +dependencies { + implementation('co.nstant.in:cbor:0.9') + testCompile group: 'junit', name: 'junit', version: '4.12' +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..62d4c05 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a4b4429 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..fbd7c51 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..a9f778a --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,104 @@ +@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 Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@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 diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..47bef39 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'hummingbird' + diff --git a/src/main/java/com/sparrowwallet/hummingbird/Bytewords.java b/src/main/java/com/sparrowwallet/hummingbird/Bytewords.java new file mode 100644 index 0000000..34b9d70 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/Bytewords.java @@ -0,0 +1,153 @@ +package com.sparrowwallet.hummingbird; + +import java.io.ByteArrayOutputStream; +import java.nio.ByteBuffer; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.StringJoiner; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.zip.CRC32; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class Bytewords { + public static final String BYTEWORDS = "ableacidalsoapexaquaarchatomauntawayaxisbackbaldbarnbeltbetabiasbluebodybragbrewbulbbuzzcalmcashcatschefcityclawcodecolacookcostcruxcurlcuspcyandarkdatadaysdelidicedietdoordowndrawdropdrumdulldutyeacheasyechoedgeepicevenexamexiteyesfactfairfernfigsfilmfishfizzflapflewfluxfoxyfreefrogfuelfundgalagamegeargemsgiftgirlglowgoodgraygrimgurugushgyrohalfhanghardhawkheathelphighhillholyhopehornhutsicedideaidleinchinkyintoirisironitemjadejazzjoinjoltjowljudojugsjumpjunkjurykeepkenokeptkeyskickkilnkingkitekiwiknoblamblavalazyleaflegsliarlimplionlistlogoloudloveluaulucklungmainmanymathmazememomenumeowmildmintmissmonknailnavyneednewsnextnoonnotenumbobeyoboeomitonyxopenovalowlspaidpartpeckplaypluspoempoolposepuffpumapurrquadquizraceramprealredorichroadrockroofrubyruinrunsrustsafesagascarsetssilkskewslotsoapsolosongstubsurfswantacotasktaxitenttiedtimetinytoiltombtoystriptunatwinuglyundouniturgeuservastveryvetovialvibeviewvisavoidvowswallwandwarmwaspwavewaxywebswhatwhenwhizwolfworkyankyawnyellyogayurtzapszerozestzinczonezoom"; + private static final List bytewordsList; + private static final List minimalBytewordsList; + + static { + bytewordsList = getBytewords(); + minimalBytewordsList = getMinimalBytewords(); + } + + public enum Style { + STANDARD, URI, MINIMAL + } + + public static int getEncodedLength(int length, Style style) { + if(style == Style.STANDARD || style == Style.URI) { + return length * 4 + (length - 1); + } + + return length * 2; + } + + public static String encode(byte[] data, Style style) { + if(style == Style.STANDARD) { + return encode(data, " "); + } + if(style == Style.URI) { + return encode(data, "-"); + } + + return encodeMinimal(data); + } + + public static byte[] decode(String encoded, Style style) { + if(style == Style.STANDARD) { + return decode(encoded, " "); + } + if(style == Style.URI) { + return decode(encoded, "-"); + } + + return decodeMinimal(encoded); + } + + private static String encode(byte[] data, String separator) { + byte[] dataAndChecksum = appendChecksum(data); + List words = IntStream.range(0, dataAndChecksum.length).map(index -> dataAndChecksum[index] & 0xFF).mapToObj(Bytewords::getByteword).collect(Collectors.toList()); + StringJoiner joiner = new StringJoiner(separator); + words.forEach(joiner::add); + return joiner.toString(); + } + + private static String encodeMinimal(byte[] data) { + byte[] dataAndChecksum = appendChecksum(data); + List words = IntStream.range(0, dataAndChecksum.length).map(index -> dataAndChecksum[index] & 0xFF).mapToObj(Bytewords::getMinimalByteword).collect(Collectors.toList()); + StringBuilder buffer = new StringBuilder(); + words.forEach(buffer::append); + return buffer.toString(); + } + + private static byte[] decode(String encoded, String separator) { + String[] words = encoded.split(separator); + byte[] data = toByteArray(Arrays.stream(words).mapToInt(word -> getBytewords().indexOf(word))); + return stripChecksum(data); + } + + private static byte[] decodeMinimal(String encoded) { + List words = splitStringBySize(encoded, 2); + byte[] data = toByteArray(words.stream().mapToInt(word -> getMinimalBytewords().indexOf(word))); + return stripChecksum(data); + } + + private static byte[] appendChecksum(byte[] data) { + CRC32 crc = new CRC32(); + crc.update(data); + + ByteBuffer checksum = ByteBuffer.allocate(Long.BYTES); + checksum.putLong(crc.getValue()); + + byte[] result = new byte[data.length + 4]; + System.arraycopy(data, 0, result, 0, data.length); + System.arraycopy(checksum.array(), 4, result, data.length, 4); + + return result; + } + + private static byte[] stripChecksum(byte[] dataAndChecksum) { + byte[] data = Arrays.copyOfRange(dataAndChecksum, 0, dataAndChecksum.length - 4); + byte[] checksum = Arrays.copyOfRange(dataAndChecksum, dataAndChecksum.length - 4, dataAndChecksum.length); + + CRC32 crc = new CRC32(); + crc.update(data); + + ByteBuffer calculedChecksum = ByteBuffer.allocate(Long.BYTES); + calculedChecksum.putLong(crc.getValue()); + if(!Arrays.equals(Arrays.copyOfRange(calculedChecksum.array(), 4, 8), checksum)) { + throw new InvalidChecksumException("Invalid checksum"); + } + + return data; + } + + private static String getByteword(int dataByte) { + return bytewordsList.get(dataByte); + } + + private static String getMinimalByteword(int dataByte) { + return minimalBytewordsList.get(dataByte); + } + + private static List getBytewords() { + return IntStream.range(0, 256).mapToObj(i -> BYTEWORDS.substring(i * 4, (i * 4) + 4)).collect(Collectors.toList()); + } + + private static List getMinimalBytewords() { + return IntStream.range(0, 256).mapToObj(i -> Character.toString(BYTEWORDS.charAt(i * 4)) + BYTEWORDS.charAt((i * 4) + 3)).collect(Collectors.toList()); + } + + public static byte[] toByteArray(IntStream stream) { + return stream.collect(ByteArrayOutputStream::new, (baos, i) -> baos.write((byte) i), + (baos1, baos2) -> baos1.write(baos2.toByteArray(), 0, baos2.size())) + .toByteArray(); + } + + private static List splitStringBySize(String str, int size) { + List split = new ArrayList<>(); + for(int i = 0; i < str.length() / size; i++) { + split.add(str.substring(i * size, Math.min((i + 1) * size, str.length()))); + } + return split; + } + + public static class InvalidChecksumException extends RuntimeException { + public InvalidChecksumException(String message) { + super(message); + } + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/ResultType.java b/src/main/java/com/sparrowwallet/hummingbird/ResultType.java new file mode 100644 index 0000000..b426f2a --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/ResultType.java @@ -0,0 +1,5 @@ +package com.sparrowwallet.hummingbird; + +public enum ResultType { + SUCCESS, FAILURE; +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/UR.java b/src/main/java/com/sparrowwallet/hummingbird/UR.java new file mode 100644 index 0000000..d74bdd2 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/UR.java @@ -0,0 +1,137 @@ +package com.sparrowwallet.hummingbird; + +import co.nstant.in.cbor.CborBuilder; +import co.nstant.in.cbor.CborDecoder; +import co.nstant.in.cbor.CborEncoder; +import co.nstant.in.cbor.CborException; +import co.nstant.in.cbor.model.ByteString; +import co.nstant.in.cbor.model.DataItem; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.util.Arrays; +import java.util.List; +import java.util.Objects; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class UR { + public static final String UR_PREFIX = "ur"; + public static final String BYTES_TYPE = "bytes"; + public static final String CRYPTO_PSBT_TYPE = "crypto-psbt"; + + private final String type; + private final byte[] data; + + public UR(String type, byte[] data) throws InvalidTypeException { + if(!isURType(type)) { + throw new InvalidTypeException("Invalid UR type: " + type); + } + + this.type = type; + this.data = data; + } + + public String getType() { + return type; + } + + public byte[] getCbor() { + return data; + } + + public byte[] toBytes() throws InvalidTypeException, CborException { + if(!BYTES_TYPE.equals(getType())) { + throw new InvalidTypeException("Not a " + BYTES_TYPE + " type"); + } + + ByteArrayInputStream bais = new ByteArrayInputStream(getCbor()); + List dataItems = new CborDecoder(bais).decode(); + return ((ByteString)dataItems.get(0)).getBytes(); + } + + public static boolean isURType(String type) { + for(char c : type.toCharArray()) { + if('a' <= c && c <= 'z') { + return true; + } + if('0' <= c && c <= '9') { + return true; + } + if(c == '-') { + return true; + } + } + + return false; + } + + public static UR fromBytes(byte[] data) { + try { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + new CborEncoder(baos).encode(new CborBuilder() + .add(data) + .build()); + byte[] cbor = baos.toByteArray(); + + return new UR("bytes", cbor); + } catch(InvalidTypeException | CborException e) { + return null; + } + } + + public String toString() { + return UREncoder.encode(this); + } + + @Override + public boolean equals(Object o) { + if(this == o) { + return true; + } + if(o == null || getClass() != o.getClass()) { + return false; + } + UR ur = (UR) o; + return type.equals(ur.type) && + Arrays.equals(data, ur.data); + } + + @Override + public int hashCode() { + int result = Objects.hash(type); + result = 31 * result + Arrays.hashCode(data); + return result; + } + + public static class URException extends Exception { + public URException(String message) { + super(message); + } + } + + public static class InvalidTypeException extends URException { + public InvalidTypeException(String message) { + super(message); + } + } + + public static class InvalidSchemeException extends URException { + public InvalidSchemeException(String message) { + super(message); + } + } + + public static class InvalidPathLengthException extends URException { + public InvalidPathLengthException(String message) { + super(message); + } + } + + public static class InvalidSequenceComponentException extends URException { + public InvalidSequenceComponentException(String message) { + super(message); + } + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/URDecoder.java b/src/main/java/com/sparrowwallet/hummingbird/URDecoder.java new file mode 100644 index 0000000..0007af3 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/URDecoder.java @@ -0,0 +1,191 @@ +package com.sparrowwallet.hummingbird; + +import co.nstant.in.cbor.CborException; +import com.sparrowwallet.hummingbird.fountain.FountainDecoder; +import com.sparrowwallet.hummingbird.fountain.FountainEncoder; + +import java.util.Arrays; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class URDecoder { + private static final Pattern SEQUENCE_COMPONENT_PATTERN = Pattern.compile("(\\d+)-(\\d+)"); + + private final FountainDecoder fountainDecoder; + + private String expectedType; + private Result result; + + public URDecoder() { + this.fountainDecoder = new FountainDecoder(); + } + + public int getExpectedPartCount() { + return fountainDecoder.getExpectedPartCount(); + } + + public Set getReceivedPartIndexes() { + return fountainDecoder.getRecievedPartIndexes(); + } + + public Set getLastPartIndexes() { + return fountainDecoder.getLastPartIndexes(); + } + + public int getProcessedPartsCount() { + return fountainDecoder.getProcessedPartsCount(); + } + + public double getEstimatedPercentComplete() { + return fountainDecoder.getEstimatedPercentComplete(); + } + + public Result getResult() { + return result; + } + + public static UR decode(String string) throws UR.URException { + ParsedURString parsedURString = parse(string); + + if(parsedURString.components.length < 1) { + throw new UR.InvalidPathLengthException("Invalid path length"); + } + + String body = parsedURString.components[0]; + return decode(parsedURString.type, body); + } + + public static UR decode(String type, String body) throws UR.InvalidTypeException { + byte[] cbor = Bytewords.decode(body, Bytewords.Style.MINIMAL); + return new UR(type, cbor); + } + + public boolean receivePart(String string) { + try { + // Don't process the part if we're already done + if(getResult() != null) { + return false; + } + + // Don't continue if this part doesn't validate + ParsedURString parsedURString = parse(string); + if(!validatePart(parsedURString.type)) { + return false; + } + + // If this is a single-part UR then we're done + if(parsedURString.components.length == 1) { + String body = parsedURString.components[0]; + result = new Result(ResultType.SUCCESS, decode(parsedURString.type, body), null); + return true; + } + + // Multi-part URs must have two path components: seq/fragment + if(parsedURString.components.length != 2) { + throw new UR.InvalidPathLengthException("Invalid path length"); + } + + String seq = parsedURString.components[0]; + String fragment = parsedURString.components[1]; + + // Parse the sequence component and the fragment, and + // make sure they agree. + Matcher matcher = SEQUENCE_COMPONENT_PATTERN.matcher(seq); + if(matcher.matches()) { + int seqNum = Integer.parseInt(matcher.group(1)); + int seqLen = Integer.parseInt(matcher.group(2)); + + byte[] cbor = Bytewords.decode(fragment, Bytewords.Style.MINIMAL); + FountainEncoder.Part part = FountainEncoder.Part.fromCborBytes(cbor); + + if(seqNum != part.getSeqNum() || seqLen != part.getSeqLen()) { + return false; + } + + if(!fountainDecoder.receivePart(part)) { + return false; + } + + if(fountainDecoder.getResult() == null) { + //Not done yet + } else if(fountainDecoder.getResult().type == ResultType.SUCCESS) { + result = new Result(ResultType.SUCCESS, new UR(parsedURString.type, fountainDecoder.getResult().data), null); + } else if(fountainDecoder.getResult().type == ResultType.FAILURE) { + result = new Result(ResultType.FAILURE, null, fountainDecoder.getResult().error); + } + + return true; + } else { + throw new UR.InvalidSequenceComponentException("Invalid sequence " + seq); + } + } catch(UR.URException | CborException e) { + return false; + } + } + + private boolean validatePart(String type) { + if(expectedType == null) { + if(!UR.isURType(type)) { + return false; + } + expectedType = type; + } else { + return expectedType.equals(type); + } + + return true; + } + + static ParsedURString parse(String string) throws UR.URException { + // Don't consider case + String lowercased = string.toLowerCase(); + + // Validate URI scheme + if(!lowercased.startsWith("ur:")) { + throw new UR.InvalidSchemeException("Invalid scheme"); + } + String path = lowercased.substring(3); + + // Split the remainder into path components + String[] components = path.split("/"); + + // Make sure there are at least two path components + if(components.length <= 1) { + throw new UR.InvalidPathLengthException("Invalid path length"); + } + + // Validate the type + String type = components[0]; + if(!UR.isURType(type)) { + throw new UR.InvalidTypeException("Invalid type: " + type); + } + + return new ParsedURString(type, Arrays.copyOfRange(components, 1, components.length)); + } + + private static class ParsedURString { + public final String type; + public final String[] components; + + public ParsedURString(String type, String[] components) { + this.type = type; + this.components = components; + } + } + + public static class Result { + public final ResultType type; + public final UR ur; + public final String error; + + public Result(ResultType type, UR ur, String error) { + this.type = type; + this.ur = ur; + this.error = error; + } + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/UREncoder.java b/src/main/java/com/sparrowwallet/hummingbird/UREncoder.java new file mode 100644 index 0000000..8117184 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/UREncoder.java @@ -0,0 +1,72 @@ +package com.sparrowwallet.hummingbird; + +import com.sparrowwallet.hummingbird.fountain.FountainEncoder; + +import java.util.Arrays; +import java.util.List; +import java.util.StringJoiner; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class UREncoder { + private final UR ur; + private final FountainEncoder fountainEncoder; + + public UREncoder(UR ur, int maxFragmentLen, int minFragmentLen, long firstSeqNum) { + this.ur = ur; + this.fountainEncoder = new FountainEncoder(ur.getCbor(), maxFragmentLen, minFragmentLen, firstSeqNum); + } + + public boolean isComplete() { + return fountainEncoder.isComplete(); + } + + public boolean isSinglePart() { + return fountainEncoder.isSinglePart(); + } + + public String nextPart() { + FountainEncoder.Part part = fountainEncoder.nextPart(); + if(isSinglePart()) { + return encode(ur); + } else { + return encodePart(ur.getType(), part); + } + } + + public long getSeqNum() { + return fountainEncoder.getSeqNum(); + } + + public int getSeqLen() { + return fountainEncoder.getSeqLen(); + } + + public List getPartIndexes() { + return fountainEncoder.getPartIndexes(); + } + + public static String encode(UR ur) { + String encoded = Bytewords.encode(ur.getCbor(), Bytewords.Style.MINIMAL); + return encodeUR(ur.getType(), encoded); + } + + private static String encodeUR(String... pathComponents) { + return encodeURI(UR.UR_PREFIX, pathComponents); + } + + private static String encodeURI(String scheme, String... pathComponents) { + StringJoiner joiner = new StringJoiner("/"); + Arrays.stream(pathComponents).forEach(joiner::add); + String path = joiner.toString(); + + return scheme + ":" + path; + } + + private static String encodePart(String type, FountainEncoder.Part part) { + String seq = part.getSeqNum() + "-" + part.getSeqLen(); + String body = Bytewords.encode(part.toCborBytes(), Bytewords.Style.MINIMAL); + return encodeUR(type, seq, body); + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainDecoder.java b/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainDecoder.java new file mode 100644 index 0000000..12e8c23 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainDecoder.java @@ -0,0 +1,277 @@ +package com.sparrowwallet.hummingbird.fountain; + +import com.sparrowwallet.hummingbird.ResultType; + +import java.io.ByteArrayOutputStream; +import java.util.*; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.zip.CRC32; + +import static com.sparrowwallet.hummingbird.fountain.FountainUtils.chooseFragments; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class FountainDecoder { + private final Set recievedPartIndexes = new TreeSet<>(); + private Set lastPartIndexes; + private int processedPartsCount = 0; + private Result result; + private long checksum; + + private Set expectedPartIndexes; + private int expectedFragmentLen; + private int expectedMessageLen; + private long expectedChecksum; + + private final Map, Part> simpleParts = new HashMap<>(); + private Map, Part> mixedParts = new HashMap<>(); + private final List queuedParts = new ArrayList<>(); + + public int getExpectedPartCount() { + return expectedPartIndexes.size(); + } + + public Set getRecievedPartIndexes() { + return recievedPartIndexes; + } + + public Set getLastPartIndexes() { + return lastPartIndexes; + } + + public int getProcessedPartsCount() { + return processedPartsCount; + } + + public double getEstimatedPercentComplete() { + double estimatedInputParts = (double)getExpectedPartCount() * 1.75; + return Math.min(0.99, (double)processedPartsCount / estimatedInputParts); + } + + public Result getResult() { + return result; + } + + private static class Part { + private final List partIndexes; + private final byte[] data; + + private int getIndex() { + return partIndexes.get(0); + } + + Part(FountainEncoder.Part part) { + this.partIndexes = chooseFragments(part.getSeqNum(), part.getSeqLen(), part.getChecksum()); + this.data = part.getData(); + } + + Part(List indexes, byte[] data) { + this.partIndexes = indexes; + this.data = data; + } + + public boolean isSimple() { + return partIndexes.size() == 1; + } + } + + public static class Result { + public final ResultType type; + public final byte[] data; + public final String error; + + public Result(ResultType type, byte[] data, String error) { + this.type = type; + this.data = data; + this.error = error; + } + } + + public boolean receivePart(FountainEncoder.Part encoderPart) { + // Don't process the part if we're already done + if(result != null) { + return false; + } + + // Don't continue if this part doesn't validate + if(!validatePart(encoderPart)) { + return false; + } + + // Add this part to the queue + Part part = new Part(encoderPart); + lastPartIndexes = new HashSet<>(part.partIndexes); + enqueue(part); + + // Process the queue until we're done or the queue is empty + while(result == null && !queuedParts.isEmpty()) { + processQueueItem(); + } + + // Keep track of how many parts we've processed + processedPartsCount += 1; + //printPartEnd(); + + return true; + } + + private void enqueue(Part part) { + queuedParts.add(part); + } + + private void printPartEnd() { + int percent = (int)Math.round(getEstimatedPercentComplete() * 100); + System.out.println("processed: " + processedPartsCount + " expected: " + getExpectedPartCount() + " received: " + recievedPartIndexes.size() + " percent: " + percent + "%"); + } + + private void printPart(Part part) { + List sorted = part.partIndexes.stream().sorted().collect(Collectors.toList()); + System.out.println("part indexes: " + sorted); + } + + private void printState() { + List sortedReceived = recievedPartIndexes.stream().sorted().collect(Collectors.toList()); + List> mixed = mixedParts.keySet().stream().map(list -> { + list.sort(Comparator.naturalOrder()); + return list; + }).collect(Collectors.toList()); + + System.out.println("parts: " + getExpectedPartCount() + ", received: " + sortedReceived + ", mixed: " + mixed + ", queued: " + queuedParts.size() + ", result: " + result); + } + + private void processQueueItem() { + Part part = queuedParts.remove(0); + + //printPart(part); + + if(part.isSimple()) { + processSimplePart(part); + } else { + processMixedPart(part); + } + + //printState(); + } + + private void reduceMixed(Part by) { + // Reduce all the current mixed parts by the given part + List reducedParts = mixedParts.values().stream().map(part -> reducePart(part, by)).collect(Collectors.toList()); + + // Collect all the remaining mixed parts + Map, Part> newMixed = new HashMap<>(); + reducedParts.forEach(reducedPart -> { + // If this reduced part is now simple + if(reducedPart.isSimple()) { + // Add it to the queue + enqueue(reducedPart); + } else { + // Otherwise, add it to the list of current mixed parts + newMixed.put(reducedPart.partIndexes, reducedPart); + } + }); + + mixedParts = newMixed; + } + + // Reduce part `a` by part `b` + private Part reducePart(Part a, Part b) { + // If the fragments mixed into `b` are a strict (proper) subset of those in `a`... + if(a.partIndexes.containsAll(b.partIndexes)) { + // The new fragments in the revised part are `a` - `b`. + List newIndexes = new ArrayList<>(a.partIndexes); + newIndexes.removeAll(b.partIndexes); + + // The new data in the revised part are `a` XOR `b` + byte[] newdata = FountainEncoder.xor(a.data, b.data); + return new Part(newIndexes, newdata); + } else { + // `a` is not reducable by `b`, so return a + return a; + } + } + + private void processSimplePart(Part part) { + // Don't process duplicate parts + Integer fragmentIndex = part.partIndexes.get(0); + if(recievedPartIndexes.contains(fragmentIndex)) { + return; + } + + // Record this part + simpleParts.put(part.partIndexes, part); + recievedPartIndexes.add(fragmentIndex); + + // If we've received all the parts + if(recievedPartIndexes.equals(expectedPartIndexes)) { + // Reassemble the message from its fragments + List sortedParts = simpleParts.values().stream().sorted(Comparator.comparingInt(Part::getIndex)).collect(Collectors.toList()); + List fragments = sortedParts.stream().map(part1 -> part1.data).collect(Collectors.toList()); + byte[] message = joinFragments(fragments, expectedMessageLen); + + // Verify the message checksum and note success or failure + CRC32 crc32 = new CRC32(); + crc32.update(message); + checksum = crc32.getValue(); + + if(checksum == expectedChecksum) { + result = new Result(ResultType.SUCCESS, message, null); + } else { + result = new Result(ResultType.FAILURE, null, "Invalid checksum"); + } + } else { + // Reduce all the mixed parts by this part + reduceMixed(part); + } + } + + private void processMixedPart(Part part) { + // Don't process duplicate parts + if(mixedParts.containsKey(part.partIndexes)) { + return; + } + + // Reduce this part by all the others + List allParts = new ArrayList<>(simpleParts.values()); + allParts.addAll(mixedParts.values()); + Part p = allParts.stream().reduce(part, this::reducePart); + + // If the part is now simple + if(p.isSimple()) { + // Add it to the queue + enqueue(p); + } else { + // Reduce all the mixed parts by this one + reduceMixed(p); + // Record this new mixed part + mixedParts.put(p.partIndexes, p); + } + } + + private boolean validatePart(FountainEncoder.Part part) { + // If this is the first part we've seen + if(expectedPartIndexes == null) { + // Record the things that all the other parts we see will have to match to be valid. + expectedPartIndexes = IntStream.range(0, part.getSeqLen()).boxed().collect(Collectors.toSet()); + expectedMessageLen = part.getMessageLen(); + expectedChecksum = part.getChecksum(); + expectedFragmentLen = part.getData().length; + + return true; + } else { + return getExpectedPartCount() == part.getSeqLen() && expectedMessageLen == part.getMessageLen() && expectedChecksum == part.getChecksum() && expectedFragmentLen == part.getData().length; + } + } + + static byte[] joinFragments(List fragments, int messageLen) { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + fragments.forEach(baos::writeBytes); + byte[] message = baos.toByteArray(); + + byte[] unpaddedMessage = new byte[messageLen]; + System.arraycopy(message, 0, unpaddedMessage, 0, messageLen); + + return unpaddedMessage; + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainEncoder.java b/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainEncoder.java new file mode 100644 index 0000000..9b20859 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainEncoder.java @@ -0,0 +1,185 @@ +package com.sparrowwallet.hummingbird.fountain; + +import co.nstant.in.cbor.CborBuilder; +import co.nstant.in.cbor.CborDecoder; +import co.nstant.in.cbor.CborEncoder; +import co.nstant.in.cbor.CborException; +import co.nstant.in.cbor.model.Array; +import co.nstant.in.cbor.model.ByteString; +import co.nstant.in.cbor.model.DataItem; +import co.nstant.in.cbor.model.UnsignedInteger; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.zip.CRC32; + +import static com.sparrowwallet.hummingbird.fountain.FountainUtils.chooseFragments; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class FountainEncoder { + private final int messageLen; + private final long checksum; + private final int fragmentLen; + private final List fragments; + private final int seqLen; + private List partIndexes; + private long seqNum; + + public FountainEncoder(byte[] message, int maxFragmentLen, int minFragmentLen, long firstSeqNum) { + if(message.length >= Integer.MAX_VALUE) { + throw new IllegalArgumentException("Message too long"); + } + + this.messageLen = message.length; + + CRC32 crc32 = new CRC32(); + crc32.update(message); + this.checksum = crc32.getValue(); + + this.fragmentLen = findNominalFragmentLength(messageLen, minFragmentLen, maxFragmentLen); + this.fragments = partitionMessage(message, fragmentLen); + this.seqLen = fragments.size(); + this.seqNum = firstSeqNum; + } + + public Part nextPart() { + seqNum += 1; + partIndexes = chooseFragments(seqNum, seqLen, checksum); + byte[] mixed = mix(partIndexes); + return new Part(seqNum, seqLen, messageLen, checksum, mixed); + } + + private byte[] mix(List partIndexes) { + return partIndexes.stream().reduce(new byte[fragmentLen], (result, index) -> xor(fragments.get(index), result), FountainEncoder::xor); + } + + public static byte[] xor(byte[] a, byte[] b) { + byte[] result = new byte[a.length]; + for (int i = 0; i < result.length; i++) { + result[i] = (byte) (((int) a[i]) ^ ((int) b[i])); + } + + return result; + } + + public boolean isComplete() { + return seqNum >= seqLen; + } + + public boolean isSinglePart() { + return seqLen == 1; + } + + public long getSeqNum() { + return seqNum; + } + + public int getSeqLen() { + return seqLen; + } + + public List getPartIndexes() { + return partIndexes; + } + + static List partitionMessage(byte[] message, int fragmentLen) { + int fragmentCount = (int)Math.ceil(message.length / (double)fragmentLen); + List fragments = new ArrayList<>(); + + int start = 0; + for(int i = 0; i < fragmentCount; i++) { + fragments.add(Arrays.copyOfRange(message, start, start + fragmentLen)); + start += fragmentLen; + } + + return fragments; + } + + static int findNominalFragmentLength(int messageLen, int minFragmentLen, int maxFragmentLen) { + int maxFragmentCount = messageLen / minFragmentLen; + int fragmentLen = 0; + for(int fragmentCount = 1; fragmentCount <= maxFragmentCount; fragmentCount++) { + fragmentLen = (int)Math.ceil((double)messageLen / (double)fragmentCount); + if(fragmentLen <= maxFragmentLen) { + break; + } + } + + return fragmentLen; + } + + public static class Part { + private final long seqNum; + private final int seqLen; + private final int messageLen; + private final long checksum; + private final byte[] data; + + public Part(long seqNum, int seqLen, int messageLen, long checksum, byte[] data) { + this.seqNum = seqNum; + this.seqLen = seqLen; + this.messageLen = messageLen; + this.checksum = checksum; + this.data = data; + } + + public long getSeqNum() { + return seqNum; + } + + public int getSeqLen() { + return seqLen; + } + + public int getMessageLen() { + return messageLen; + } + + public long getChecksum() { + return checksum; + } + + public byte[] getData() { + return data; + } + + public byte[] toCborBytes() { + try { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + new CborEncoder(baos).encode(new CborBuilder() + .addArray() + .add(new UnsignedInteger(seqNum)) + .add(new UnsignedInteger(seqLen)) + .add(new UnsignedInteger(messageLen)) + .add(new UnsignedInteger(checksum)) + .add(data) + .end() + .build()); + + return baos.toByteArray(); + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + public static Part fromCborBytes(byte[] cborData) throws CborException { + ByteArrayInputStream bais = new ByteArrayInputStream(cborData); + List arrayDataItems = new CborDecoder(bais).decode(); + Array array = (Array)arrayDataItems.get(0); + List dataItems = array.getDataItems(); + + UnsignedInteger seqNum = (UnsignedInteger)dataItems.get(0); + UnsignedInteger seqLen = (UnsignedInteger)dataItems.get(1); + UnsignedInteger messageLen = (UnsignedInteger)dataItems.get(2); + UnsignedInteger checksum = (UnsignedInteger)dataItems.get(3); + ByteString data = (ByteString)dataItems.get(4); + + return new Part(seqNum.getValue().longValue(), seqLen.getValue().intValue(), messageLen.getValue().intValue(), checksum.getValue().longValue(), data.getBytes()); + } + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainUtils.java b/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainUtils.java new file mode 100644 index 0000000..47e3acf --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/fountain/FountainUtils.java @@ -0,0 +1,50 @@ +package com.sparrowwallet.hummingbird.fountain; + +import java.nio.ByteBuffer; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.IntStream; + +/** + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class FountainUtils { + static List chooseFragments(long seqNum, int seqLen, long checkSum) { + // The first `seqLen` parts are the "pure" fragments, not mixed with any + // others. This means that if you only generate the first `seqLen` parts, + // then you have all the parts you need to decode the message. + if(seqNum <= seqLen) { + return List.of((int)seqNum - 1); + } else { + ByteBuffer buffer = ByteBuffer.allocate(Integer.BYTES * 2); + buffer.putInt((int)(seqNum)); + buffer.putInt((int)(checkSum)); + + RandomXoshiro256StarStar rng = new RandomXoshiro256StarStar(buffer.array()); + int degree = chooseDegree(seqLen, rng); + List indexes = IntStream.range(0, seqLen).boxed().collect(Collectors.toList()); + List shuffledIndexes = shuffled(indexes, rng); + return new ArrayList<>(shuffledIndexes.subList(0, degree)); + } + } + + static int chooseDegree(int seqLen, RandomXoshiro256StarStar rng) { + List degreeProbabilties = IntStream.range(1, seqLen + 1).mapToObj(i -> 1 / (double)i).collect(Collectors.toList()); + RandomSampler randomSampler = new RandomSampler(degreeProbabilties); + return randomSampler.next(rng) + 1; + } + + static List shuffled(List indexes, RandomXoshiro256StarStar rng) { + List remaining = new ArrayList<>(indexes); + List shuffled = new ArrayList<>(indexes.size()); + + while(!remaining.isEmpty()) { + int index = rng.nextInt(0, remaining.size()); + Integer item = remaining.remove(index); + shuffled.add(item); + } + + return shuffled; + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/fountain/RandomSampler.java b/src/main/java/com/sparrowwallet/hummingbird/fountain/RandomSampler.java new file mode 100644 index 0000000..ce599ec --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/fountain/RandomSampler.java @@ -0,0 +1,84 @@ +package com.sparrowwallet.hummingbird.fountain; + +import java.util.ArrayList; +import java.util.List; +import java.util.Random; +import java.util.stream.Collectors; + +/** + * Random-number sampling using the Walker-Vose alias method, + * as described by Keith Schwarz (2011) + * http://www.keithschwarz.com/darts-dice-coins + * + * Based on C implementation: + * https://jugit.fz-juelich.de/mlz/ransampl + * + * Ported from https://github.com/BlockchainCommons/URKit + */ +public class RandomSampler { + /* The probability and alias tables. */ + private final double[] probs; + private final int[] aliases; + + public RandomSampler(List probabilities) { + if(probabilities.stream().anyMatch(prob -> prob < 0)) { + throw new IllegalArgumentException("Probabilties must be > 0"); + } + + // Normalize given probabilities + double sum = probabilities.stream().reduce(0d, Double::sum); + + int n = probabilities.size(); + List P = probabilities.stream().map(prob -> prob * (double)n / sum).collect(Collectors.toList()); + + List S = new ArrayList<>(); + List L = new ArrayList<>(); + + // Set separate index lists for small and large probabilities: + for(int i = n - 1; i >= 0; i--) { + // at variance from Schwarz, we reverse the index order + if(P.get(i) < 1d) { + S.add(i); + } else { + L.add(i); + } + } + + // Work through index lists + double[] probs = new double[n]; + int[] aliases = new int[n]; + + while(!S.isEmpty() && !L.isEmpty()) { + int a = S.remove(S.size() - 1); + int g = L.remove(L.size() - 1); + probs[a] = P.get(a); + aliases[a] = g; + P.set(g, P.get(g) + P.get(a) - 1); + if(P.get(g) < 1) { + S.add(g); + } else { + L.add(g); + } + } + + while(!L.isEmpty()) { + probs[L.remove(L.size() - 1)] = 1; + } + + while(!S.isEmpty()) { + // can only happen through numeric instability + probs[S.remove(S.size() - 1)] = 1; + } + + this.probs = probs; + this.aliases = aliases; + } + + public int next(Random random) { + double r1 = random.nextDouble(); + double r2 = random.nextDouble(); + int n = probs.length; + int i = (int)((double)n * r1); + return r2 < probs[i] ? i : aliases[i]; + } +} diff --git a/src/main/java/com/sparrowwallet/hummingbird/fountain/RandomXoshiro256StarStar.java b/src/main/java/com/sparrowwallet/hummingbird/fountain/RandomXoshiro256StarStar.java new file mode 100644 index 0000000..ed680e2 --- /dev/null +++ b/src/main/java/com/sparrowwallet/hummingbird/fountain/RandomXoshiro256StarStar.java @@ -0,0 +1,255 @@ +package com.sparrowwallet.hummingbird.fountain; + +/* + * To the extent possible under law, the author has dedicated all copyright + * and related and neighboring rights to this software to the public domain + * worldwide. This software is distributed without any warranty. + * + * See + */ + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Random; +import java.util.concurrent.atomic.AtomicLong; + +/** + * Implementation of Random based on the xoshiro256** RNG. No-dependencies + * Java port of the original C code, + * which is public domain. This Java port is similarly dedicated to the public + * domain. + *

+ * Individual instances are not thread-safe. Each thread must have its own + * instance which is not shared. + * + * @author David Blackman and Sebastiano Vigna <vigna@acm.org> (original C code) + * @author Una Thompson <una@unascribed.com> (Java port) + * @see http://xoshiro.di.unimi.it/ + */ +public class RandomXoshiro256StarStar extends Random { + private static final long serialVersionUID = -2837799889588687855L; + + private static final AtomicLong uniq = new AtomicLong(System.nanoTime()); + + private static final long nextUniq() { + return splitmix64_2(uniq.addAndGet(SPLITMIX1_MAGIC)); + } + + private long seed; + + public RandomXoshiro256StarStar() { + this(System.nanoTime() ^ nextUniq()); + } + + public RandomXoshiro256StarStar(long seed) { + super(seed); + // super will call setSeed + } + + public RandomXoshiro256StarStar(String seed) { + this(seed.getBytes(StandardCharsets.UTF_8)); + } + + public RandomXoshiro256StarStar(byte[] seed) { + long[] s = new long[4]; + byte[] digestBytes = hash(seed, 0, seed.length); + + for(int i = 0; i < 4; i++) { + int o = i * 8; + long v = 0L; + for(int n = 0; n < 8; n++) { + v = v << 8; + v |= digestBytes[o + n] & 0xFF; + } + s[i] = v; + } + + setState(s[0], s[1], s[2], s[3]); + } + + public RandomXoshiro256StarStar(long s1, long s2, long s3, long s4) { + setState(s1, s2, s3, s4); + } + + // used to "stretch" seeds into a full 256-bit state; also makes + // it safe to pass in zero as a seed + //// + // what generator is used here is unimportant, as long as it's + // from a different family, but splitmix64 happens to be an + // incredibly simple high-quality generator of a completely + // different family (and is recommended by the xoshiro authors) + + private static final long SPLITMIX1_MAGIC = 0x9E3779B97F4A7C15L; + + private static long splitmix64_1(long x) { + return (x + SPLITMIX1_MAGIC); + } + + private static long splitmix64_2(long z) { + z = (z ^ (z >> 30)) * 0xBF58476D1CE4E5B9L; + z = (z ^ (z >> 27)) * 0x94D049BB133111EBL; + return z ^ (z >> 31); + } + + @Override + public void setSeed(long seed) { + this.seed = seed; + + // update haveNextNextGaussian flag in super + super.setSeed(seed); + long sms = splitmix64_1(seed); + s0 = splitmix64_2(sms); + sms = splitmix64_1(sms); + s1 = splitmix64_2(sms); + sms = splitmix64_1(sms); + s2 = splitmix64_2(sms); + sms = splitmix64_1(sms); + s3 = splitmix64_2(sms); + } + + public void setState(long s0, long s1, long s2, long s4) { + if(s0 == 0 && s1 == 0 && s2 == 0 && s4 == 0) { + throw new IllegalArgumentException("xoshiro256** state cannot be all zeroes"); + } + this.s0 = s0; + this.s1 = s1; + this.s2 = s2; + this.s3 = s4; + } + + // not called, implemented instead of just throwing for completeness + @Override + protected int next(int bits) { + return (int) (nextLong() & ((1L << bits) - 1)); + } + + @Override + public int nextInt() { + return (int) nextLong(); + } + + @Override + public int nextInt(int bound) { + return (int) nextLong(bound); + } + + public long nextLong(long bound) { + if(bound <= 0) { + throw new IllegalArgumentException("bound must be positive"); + } + // clear sign bit for positive-only, modulo to bound + return (nextLong() & Long.MAX_VALUE) % bound; + } + + @Override + public double nextDouble() { + return (nextLong() >>> 11) * 0x1.0P-53; + } + + @Override + public float nextFloat() { + return (nextLong() >>> 40) * 0x1.0P-24f; + } + + @Override + public boolean nextBoolean() { + return (nextLong() & 1) != 0; + } + + @Override + public void nextBytes(byte[] buf) { + nextBytes(buf, 0, buf.length); + } + + public void nextBytes(byte[] buf, int ofs, int len) { + if(ofs < 0) { + throw new ArrayIndexOutOfBoundsException("Offset " + ofs + " is negative"); + } + if(ofs >= buf.length) { + throw new ArrayIndexOutOfBoundsException("Offset " + ofs + " is greater than buffer length"); + } + if(ofs + len > buf.length) { + throw new ArrayIndexOutOfBoundsException("Length " + len + " with offset " + ofs + " is past end of buffer"); + } + int j = 8; + long l = 0; + for(int i = ofs; i < ofs + len; i++) { + if(j >= 8) { + l = nextLong(); + j = 0; + } + buf[i] = (byte) (l & 0xFF); + l = l >>> 8L; + j++; + } + } + + public void nextData(byte[] data) { + for(int i = 0; i < data.length; i++) { + data[i] = (byte)(nextInt(0, 256) & 0xFF); + } + } + + public int nextInt(int lowerBound, int count) { + double next = nextDouble(); + double dou = (next * count); + return (int)(dou) + lowerBound; + } + + /* This is xoshiro256** 1.0, our all-purpose, rock-solid generator. It has + excellent (sub-ns) speed, a state (256 bits) that is large enough for + any parallel application, and it passes all tests we are aware of. + + For generating just floating-point numbers, xoshiro256+ is even faster. + + The state must be seeded so that it is not everywhere zero. If you have + a 64-bit seed, we suggest to seed a splitmix64 generator and use its + output to fill s. */ + + private static long rotl(long x, int k) { + return (x << k) | (x >>> (64 - k)); + } + + + private long s0; + private long s1; + private long s2; + private long s3; + + @Override + public long nextLong() { + long result_starstar = rotl(s1 * 5, 7) * 9; + + long t = s1 << 17; + + s2 ^= s0; + s3 ^= s1; + s1 ^= s2; + s0 ^= s3; + + s2 ^= t; + + s3 = rotl(s3, 45); + + return result_starstar; + } + + /** + * Calculates the SHA-256 hash of the given byte range. + * + * @param input the array containing the bytes to hash + * @param offset the offset within the array of the bytes to hash + * @param length the number of bytes to hash + * @return the hash (in big-endian order) + */ + public static byte[] hash(byte[] input, int offset, int length) { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + digest.update(input, offset, length); + return digest.digest(); + } catch (NoSuchAlgorithmException e) { + throw new RuntimeException(e); // Can't happen. + } + } +} diff --git a/src/test/java/com/sparrowwallet/hummingbird/BytewordsTest.java b/src/test/java/com/sparrowwallet/hummingbird/BytewordsTest.java new file mode 100644 index 0000000..8f82f84 --- /dev/null +++ b/src/test/java/com/sparrowwallet/hummingbird/BytewordsTest.java @@ -0,0 +1,23 @@ +package com.sparrowwallet.hummingbird; + +import org.junit.Assert; +import org.junit.Test; + +public class BytewordsTest { + @Test + public void test() { + byte[] data = TestUtils.hexToBytes("d9012ca20150c7098580125e2ab0981253468b2dbc5202d8641947da"); + String encoded = Bytewords.encode(data, Bytewords.Style.STANDARD); + Assert.assertEquals("tuna acid draw oboe acid good slot axis limp lava brag holy door puff monk brag guru frog luau drop roof grim also trip idle chef fuel twin tied draw grim ramp", encoded); + byte[] data2 = Bytewords.decode(encoded, Bytewords.Style.STANDARD); + Assert.assertArrayEquals(data, data2); + + encoded = Bytewords.encode(data, Bytewords.Style.URI); + Assert.assertEquals("tuna-acid-draw-oboe-acid-good-slot-axis-limp-lava-brag-holy-door-puff-monk-brag-guru-frog-luau-drop-roof-grim-also-trip-idle-chef-fuel-twin-tied-draw-grim-ramp", encoded); + + encoded = Bytewords.encode(data, Bytewords.Style.MINIMAL); + Assert.assertEquals("taaddwoeadgdstaslplabghydrpfmkbggufgludprfgmaotpiecffltntddwgmrp", encoded); + data2 = Bytewords.decode(encoded, Bytewords.Style.MINIMAL); + Assert.assertArrayEquals(data, data2); + } +} diff --git a/src/test/java/com/sparrowwallet/hummingbird/TestUtils.java b/src/test/java/com/sparrowwallet/hummingbird/TestUtils.java new file mode 100644 index 0000000..9e885bf --- /dev/null +++ b/src/test/java/com/sparrowwallet/hummingbird/TestUtils.java @@ -0,0 +1,24 @@ +package com.sparrowwallet.hummingbird; + +public class TestUtils { + public static byte[] hexToBytes(String s) { + int len = s.length(); + byte[] data = new byte[len / 2]; + for (int i = 0; i < len; i += 2) { + data[i / 2] = (byte) ((Character.digit(s.charAt(i), 16) << 4) + + Character.digit(s.charAt(i+1), 16)); + } + return data; + } + + private static final char[] HEX_ARRAY = "0123456789abcdef".toCharArray(); + public static String bytesToHex(byte[] bytes) { + char[] hexChars = new char[bytes.length * 2]; + for (int j = 0; j < bytes.length; j++) { + int v = bytes[j] & 0xFF; + hexChars[j * 2] = HEX_ARRAY[v >>> 4]; + hexChars[j * 2 + 1] = HEX_ARRAY[v & 0x0F]; + } + return new String(hexChars); + } +} diff --git a/src/test/java/com/sparrowwallet/hummingbird/URTest.java b/src/test/java/com/sparrowwallet/hummingbird/URTest.java new file mode 100644 index 0000000..d427d6b --- /dev/null +++ b/src/test/java/com/sparrowwallet/hummingbird/URTest.java @@ -0,0 +1,106 @@ +package com.sparrowwallet.hummingbird; + +import co.nstant.in.cbor.CborBuilder; +import co.nstant.in.cbor.CborEncoder; +import com.sparrowwallet.hummingbird.fountain.RandomXoshiro256StarStar; +import org.junit.Assert; +import org.junit.Test; + +import java.io.ByteArrayOutputStream; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.IntStream; + +public class URTest { + @Test + public void testSinglePartUR() { + UR ur = makeMessageUR(50, "Wolf"); + String encoded = UREncoder.encode(ur); + Assert.assertEquals("ur:bytes/hdeymejtswhhylkepmykhhtsytsnoyoyaxaedsuttydmmhhpktpmsrjtgwdpfnsboxgwlbaawzuefywkdplrsrjynbvygabwjldapfcsdwkbrkch", encoded); + } + + @Test + public void testEncode() { + UR ur = makeMessageUR(256, "Wolf"); + UREncoder urEncoder = new UREncoder(ur, 30, 10, 0); + List parts = IntStream.range(0, 20).mapToObj(i -> urEncoder.nextPart()).collect(Collectors.toList()); + String[] expectedParts = new String[] { + "ur:bytes/1-9/lpadascfadaxcywenbpljkhdcahkadaemejtswhhylkepmykhhtsytsnoyoyaxaedsuttydmmhhpktpmsrjtdkgslpgh", + "ur:bytes/2-9/lpaoascfadaxcywenbpljkhdcagwdpfnsboxgwlbaawzuefywkdplrsrjynbvygabwjldapfcsgmghhkhstlrdcxaefz", + "ur:bytes/3-9/lpaxascfadaxcywenbpljkhdcahelbknlkuejnbadmssfhfrdpsbiegecpasvssovlgeykssjykklronvsjksopdzmol", + "ur:bytes/4-9/lpaaascfadaxcywenbpljkhdcasotkhemthydawydtaxneurlkosgwcekonertkbrlwmplssjtammdplolsbrdzcrtas", + "ur:bytes/5-9/lpahascfadaxcywenbpljkhdcatbbdfmssrkzmcwnezelennjpfzbgmuktrhtejscktelgfpdlrkfyfwdajldejokbwf", + "ur:bytes/6-9/lpamascfadaxcywenbpljkhdcackjlhkhybssklbwefectpfnbbectrljectpavyrolkzczcpkmwidmwoxkilghdsowp", + "ur:bytes/7-9/lpatascfadaxcywenbpljkhdcavszmwnjkwtclrtvaynhpahrtoxmwvwatmedibkaegdosftvandiodagdhthtrlnnhy", + "ur:bytes/8-9/lpayascfadaxcywenbpljkhdcadmsponkkbbhgsoltjntegepmttmoonftnbuoiyrehfrtsabzsttorodklubbuyaetk", + "ur:bytes/9-9/lpasascfadaxcywenbpljkhdcajskecpmdckihdyhphfotjojtfmlnwmadspaxrkytbztpbauotbgtgtaeaevtgavtny", + "ur:bytes/10-9/lpbkascfadaxcywenbpljkhdcahkadaemejtswhhylkepmykhhtsytsnoyoyaxaedsuttydmmhhpktpmsrjtwdkiplzs", + "ur:bytes/11-9/lpbdascfadaxcywenbpljkhdcahelbknlkuejnbadmssfhfrdpsbiegecpasvssovlgeykssjykklronvsjkvetiiapk", + "ur:bytes/12-9/lpbnascfadaxcywenbpljkhdcarllaluzmdmgstospeyiefmwejlwtpedamktksrvlcygmzemovovllarodtmtbnptrs", + "ur:bytes/13-9/lpbtascfadaxcywenbpljkhdcamtkgtpknghchchyketwsvwgwfdhpgmgtylctotzopdrpayoschcmhplffziachrfgd", + "ur:bytes/14-9/lpbaascfadaxcywenbpljkhdcapazewnvonnvdnsbyleynwtnsjkjndeoldydkbkdslgjkbbkortbelomueekgvstegt", + "ur:bytes/15-9/lpbsascfadaxcywenbpljkhdcaynmhpddpzmversbdqdfyrehnqzlugmjzmnmtwmrouohtstgsbsahpawkditkckynwt", + "ur:bytes/16-9/lpbeascfadaxcywenbpljkhdcawygekobamwtlihsnpalnsghenskkiynthdzotsimtojetprsttmukirlrsbtamjtpd", + "ur:bytes/17-9/lpbyascfadaxcywenbpljkhdcamklgftaxykpewyrtqzhydntpnytyisincxmhtbceaykolduortotiaiaiafhiaoyce", + "ur:bytes/18-9/lpbgascfadaxcywenbpljkhdcahkadaemejtswhhylkepmykhhtsytsnoyoyaxaedsuttydmmhhpktpmsrjtntwkbkwy", + "ur:bytes/19-9/lpbwascfadaxcywenbpljkhdcadekicpaajootjzpsdrbalpeywllbdsnbinaerkurspbncxgslgftvtsrjtksplcpeo", + "ur:bytes/20-9/lpbbascfadaxcywenbpljkhdcayapmrleeleaxpasfrtrdkncffwjyjzgyetdmlewtkpktgllepfrltataztksmhkbot" + }; + Assert.assertArrayEquals("", expectedParts, parts.toArray()); + } + + @Test + public void testMultipartUR() { + UR ur = makeMessageUR(32767, "Wolf"); + int maxFragmentLen = 1000; + UREncoder urEncoder = new UREncoder(ur, maxFragmentLen, 10, 100); + URDecoder urDecoder = new URDecoder(); + + do { + String part = urEncoder.nextPart(); + urDecoder.receivePart(part); + } while(urDecoder.getResult() == null); + + Assert.assertEquals(ResultType.SUCCESS, urDecoder.getResult().type); + + UR decodedUR = urDecoder.getResult().ur; + Assert.assertEquals(ur, decodedUR); + } + + public static byte[] makeMessage(int len, String seed) { + RandomXoshiro256StarStar rng = new RandomXoshiro256StarStar(seed); + byte[] message = new byte[len]; + rng.nextData(message); + return message; + } + + private UR makeMessageUR(int len, String seed) { + try { + byte[] message = makeMessage(len, seed); + + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + new CborEncoder(baos).encode(new CborBuilder() + .add(message) + .build()); + byte[] cbor = baos.toByteArray(); + return new UR("bytes", cbor); + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + @Test + public void testCbor() throws Exception { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + new CborEncoder(baos).encode(new CborBuilder() + .add(TestUtils.hexToBytes("00112233445566778899aabbccddeeff")) + .build()); + + byte[] cbor = baos.toByteArray(); + Assert.assertEquals("5000112233445566778899aabbccddeeff", TestUtils.bytesToHex(cbor)); + + UR ur = new UR("bytes", cbor); + String encoded = UREncoder.encode(ur); + Assert.assertEquals("ur:bytes/gdaebycpeofygoiyktlonlpkrksfutwyzmwmfyeozs", encoded); + } +} diff --git a/src/test/java/com/sparrowwallet/hummingbird/fountain/FountainCodesTest.java b/src/test/java/com/sparrowwallet/hummingbird/fountain/FountainCodesTest.java new file mode 100644 index 0000000..be6d98d --- /dev/null +++ b/src/test/java/com/sparrowwallet/hummingbird/fountain/FountainCodesTest.java @@ -0,0 +1,240 @@ +package com.sparrowwallet.hummingbird.fountain; + +import co.nstant.in.cbor.CborException; +import com.sparrowwallet.hummingbird.*; +import org.junit.Assert; +import org.junit.Test; + +import java.util.Arrays; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.zip.CRC32; + +public class FountainCodesTest { + @Test + public void testRNG3() { + RandomXoshiro256StarStar rng = new RandomXoshiro256StarStar("Wolf"); + int[] numbers = IntStream.range(0, 100).map(i -> rng.nextInt(1, 10)).toArray(); + int[] expectedNumbers = new int[] {6, 5, 8, 4, 10, 5, 7, 10, 4, 9, 10, 9, 7, 7, 1, 1, 2, 9, 9, 2, 6, 4, 5, 7, 8, 5, 4, 2, 3, 8, 7, 4, 5, 1, 10, 9, 3, 10, 2, 6, 8, 5, 7, 9, 3, 1, 5, 2, 7, 1, 4, 4, 4, 4, 9, 4, 5, 5, 6, 9, 5, 1, 2, 8, 3, 3, 2, 8, 4, 3, 2, 1, 10, 8, 9, 3, 10, 8, 5, 5, 6, 7, 10, 5, 8, 9, 4, 6, 4, 2, 10, 2, 1, 7, 9, 6, 7, 4, 2, 5}; + + Assert.assertArrayEquals(expectedNumbers, numbers); + } + + @Test + public void testRandomSampler() { + RandomXoshiro256StarStar rng = new RandomXoshiro256StarStar("Wolf"); + RandomSampler randomSampler = new RandomSampler(List.of(1d, 2d, 4d, 8d)); + int[] numbers = IntStream.range(0, 500).map(i -> randomSampler.next(rng)).toArray(); + int[] expectedNumbers = new int[] {3, 3, 3, 3, 3, 3, 3, 0, 2, 3, 3, 3, 3, 1, 2, 2, 1, 3, 3, 2, 3, 3, 1, 1, 2, 1, 1, 3, 1, 3, 1, 2, 0, 2, 1, 0, 3, 3, 3, 1, 3, 3, 3, 3, 1, 3, 2, 3, 2, 2, 3, 3, 3, 3, 2, 3, 3, 0, 3, 3, 3, 3, 1, 2, 3, 3, 2, 2, 2, 1, 2, 2, 1, 2, 3, 1, 3, 0, 3, 2, 3, 3, 3, 3, 3, 3, 3, 3, 2, 3, 1, 3, 3, 2, 0, 2, 2, 3, 1, 1, 2, 3, 2, 3, 3, 3, 3, 2, 3, 3, 3, 3, 3, 2, 3, 1, 2, 1, 1, 3, 1, 3, 2, 2, 3, 3, 3, 1, 3, 3, 3, 3, 3, 3, 3, 3, 2, 3, 2, 3, 3, 1, 2, 3, 3, 1, 3, 2, 3, 3, 3, 2, 3, 1, 3, 0, 3, 2, 1, 1, 3, 1, 3, 2, 3, 3, 3, 3, 2, 0, 3, 3, 1, 3, 0, 2, 1, 3, 3, 1, 1, 3, 1, 2, 3, 3, 3, 0, 2, 3, 2, 0, 1, 3, 3, 3, 2, 2, 2, 3, 3, 3, 3, 3, 2, 3, 3, 3, 3, 2, 3, 3, 2, 0, 2, 3, 3, 3, 3, 2, 1, 1, 1, 2, 1, 3, 3, 3, 2, 2, 3, 3, 1, 2, 3, 0, 3, 2, 3, 3, 3, 3, 0, 2, 2, 3, 2, 2, 3, 3, 3, 3, 1, 3, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1, 3, 0, 2, 1, 3, 3, 3, 3, 3, 3, 3, 3, 1, 3, 3, 3, 3, 2, 2, 2, 3, 1, 1, 3, 2, 2, 0, 3, 2, 1, 2, 1, 0, 3, 3, 3, 2, 2, 3, 2, 1, 2, 0, 0, 3, 3, 2, 3, 3, 2, 3, 3, 3, 3, 3, 2, 2, 2, 3, 3, 3, 3, 3, 1, 1, 3, 2, 2, 3, 1, 1, 0, 1, 3, 2, 3, 3, 2, 3, 3, 2, 3, 3, 2, 2, 2, 2, 3, 2, 2, 2, 2, 2, 1, 2, 3, 3, 2, 2, 2, 2, 3, 3, 2, 0, 2, 1, 3, 3, 3, 3, 0, 3, 3, 3, 3, 2, 2, 3, 1, 3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3, 3, 2, 3, 2, 1, 3, 3, 3, 3, 2, 2, 0, 1, 2, 3, 2, 0, 3, 3, 3, 3, 3, 3, 1, 3, 3, 2, 3, 2, 2, 3, 3, 3, 3, 3, 2, 2, 3, 3, 2, 2, 2, 1, 3, 3, 3, 3, 1, 2, 3, 2, 3, 3, 2, 3, 2, 3, 3, 3, 2, 3, 1, 2, 3, 2, 1, 1, 3, 3, 2, 3, 3, 2, 3, 3, 0, 0, 1, 3, 3, 2, 3, 3, 3, 3, 1, 3, 3, 0, 3, 2, 3, 3, 1, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 2}; + + Assert.assertArrayEquals(expectedNumbers, numbers); + } + + @Test + public void testShuffle() { + RandomXoshiro256StarStar rng = new RandomXoshiro256StarStar("Wolf"); + List numbers = IntStream.range(1, 11).boxed().collect(Collectors.toList()); + numbers = FountainUtils.shuffled(numbers, rng); + List expectedNumbers = List.of(6, 4, 9, 3, 10, 5, 7, 8, 1, 2); + + Assert.assertEquals(expectedNumbers, numbers); + } + + @Test + public void testPartitionAndJoin() { + byte[] message = URTest.makeMessage(1024, "Wolf"); + int fragmentLen = FountainEncoder.findNominalFragmentLength(message.length, 10, 100); + List fragments = FountainEncoder.partitionMessage(message, fragmentLen); + List fragmentsHex = fragments.stream().map(TestUtils::bytesToHex).collect(Collectors.toList()); + String[] expectedFragmentsHex = new String[] { + "916ec65cf77cadf55cd7f9cda1a1030026ddd42e905b77adc36e4f2d3ccba44f7f04f2de44f42d84c374a0e149136f25b01852545961d55f7f7a8cde6d0e2ec43f3b2dcb644a2209e8c9e34af5c4747984a5e873c9cf5f965e25ee29039f", + "df8ca74f1c769fc07eb7ebaec46e0695aea6cbd60b3ec4bbff1b9ffe8a9e7240129377b9d3711ed38d412fbb4442256f1e6f595e0fc57fed451fb0a0101fb76b1fb1e1b88cfdfdaa946294a47de8fff173f021c0e6f65b05c0a494e50791", + "270a0050a73ae69b6725505a2ec8a5791457c9876dd34aadd192a53aa0dc66b556c0c215c7ceb8248b717c22951e65305b56a3706e3e86eb01c803bbf915d80edcd64d4d41977fa6f78dc07eecd072aae5bc8a852397e06034dba6a0b570", + "797c3a89b16673c94838d884923b8186ee2db5c98407cab15e13678d072b43e406ad49477c2e45e85e52ca82a94f6df7bbbe7afbed3a3a830029f29090f25217e48d1f42993a640a67916aa7480177354cc7440215ae41e4d02eae9a1912", + "33a6d4922a792c1b7244aa879fefdb4628dc8b0923568869a983b8c661ffab9b2ed2c149e38d41fba090b94155adbed32f8b18142ff0d7de4eeef2b04adf26f2456b46775c6c20b37602df7da179e2332feba8329bbb8d727a138b4ba7a5", + "03215eda2ef1e953d89383a382c11d3f2cad37a4ee59a91236a3e56dcf89f6ac81dd4159989c317bd649d9cbc617f73fe10033bd288c60977481a09b343d3f676070e67da757b86de27bfca74392bac2996f7822a7d8f71a489ec6180390", + "089ea80a8fcd6526413ec6c9a339115f111d78ef21d456660aa85f790910ffa2dc58d6a5b93705caef1091474938bd312427021ad1eeafbd19e0d916ddb111fabd8dcab5ad6a6ec3a9c6973809580cb2c164e26686b5b98cfb017a337968", + "c7daaa14ae5152a067277b1b3902677d979f8e39cc2aafb3bc06fcf69160a853e6869dcc09a11b5009f91e6b89e5b927ab1527a735660faa6012b420dd926d940d742be6a64fb01cdc0cff9faa323f02ba41436871a0eab851e7f5782d10", + "fbefde2a7e9ae9dc1e5c2c48f74f6c824ce9ef3c89f68800d44587bedc4ab417cfb3e7447d90e1e417e6e05d30e87239d3a5d1d45993d4461e60a0192831640aa32dedde185a371ded2ae15f8a93dba8809482ce49225daadfbb0fec629e", + "23880789bdf9ed73be57fa84d555134630e8d0f7df48349f29869a477c13ccca9cd555ac42ad7f568416c3d61959d0ed568b2b81c7771e9088ad7fd55fd4386bafbf5a528c30f107139249357368ffa980de2c76ddd9ce4191376be0e6b5", + "170010067e2e75ebe2d2904aeb1f89d5dc98cd4a6f2faaa8be6d03354c990fd895a97feb54668473e9d942bb99e196d897e8f1b01625cf48a7b78d249bb4985c065aa8cd1402ed2ba1b6f908f63dcd84b66425df00000000000000000000" + }; + + Assert.assertEquals(Arrays.asList(expectedFragmentsHex), fragmentsHex); + + byte[] rejoinedMessage = FountainDecoder.joinFragments(fragments, message.length); + Assert.assertArrayEquals(message, rejoinedMessage); + } + + @Test + public void testChooseDegree() { + byte[] message = URTest.makeMessage(1024, "Wolf"); + int fragmentLen = FountainEncoder.findNominalFragmentLength(message.length, 10, 100); + List fragments = FountainEncoder.partitionMessage(message, fragmentLen); + List degrees = IntStream.rangeClosed(1, 200).mapToObj( nonce -> { + RandomXoshiro256StarStar partRng = new RandomXoshiro256StarStar("Wolf-" + nonce); + return FountainUtils.chooseDegree(fragments.size(), partRng); + }).collect(Collectors.toList()); + Integer[] expectedDegrees = new Integer[] { + 11, 3, 6, 5, 2, 1, 2, 11, 1, 3, 9, 10, 10, 4, 2, 1, 1, 2, 1, 1, 5, 2, 4, 10, 3, 2, 1, 1, 3, 11, 2, 6, 2, 9, 9, 2, 6, 7, 2, 5, 2, 4, 3, 1, 6, 11, 2, 11, 3, 1, 6, 3, 1, 4, 5, 3, 6, 1, 1, 3, 1, 2, 2, 1, 4, 5, 1, 1, 9, 1, 1, 6, 4, 1, 5, 1, 2, 2, 3, 1, 1, 5, 2, 6, 1, 7, 11, 1, 8, 1, 5, 1, 1, 2, 2, 6, 4, 10, 1, 2, 5, 5, 5, 1, 1, 4, 1, 1, 1, 3, 5, 5, 5, 1, 4, 3, 3, 5, 1, 11, 3, 2, 8, 1, 2, 1, 1, 4, 5, 2, 1, 1, 1, 5, 6, 11, 10, 7, 4, 7, 1, 5, 3, 1, 1, 9, 1, 2, 5, 5, 2, 2, 3, 10, 1, 3, 2, 3, 3, 1, 1, 2, 1, 3, 2, 2, 1, 3, 8, 4, 1, 11, 6, 3, 1, 1, 1, 1, 1, 3, 1, 2, 1, 10, 1, 1, 8, 2, 7, 1, 2, 1, 9, 2, 10, 2, 1, 3, 4, 10 + }; + Assert.assertEquals(Arrays.asList(expectedDegrees), degrees); + } + + @Test + public void testChooseFragment() { + byte[] message = URTest.makeMessage(1024, "Wolf"); + CRC32 crc32 = new CRC32(); + crc32.update(message); + long checksum = crc32.getValue(); + int fragmentLen = FountainEncoder.findNominalFragmentLength(message.length, 10, 100); + List fragments = FountainEncoder.partitionMessage(message, fragmentLen); + List> partIndexes = IntStream.rangeClosed(1, 30).mapToObj(nonce -> { + return FountainUtils.chooseFragments(nonce, fragments.size(), checksum).stream().sorted().collect(Collectors.toList()); + }).collect(Collectors.toList()); + + Integer[][] expectedFragmentIndexes = new Integer[][] { + {0}, + {1}, + {2}, + {3}, + {4}, + {5}, + {6}, + {7}, + {8}, + {9}, + {10}, + {9}, + {2, 5, 6, 8, 9, 10}, + {8}, + {1, 5}, + {1}, + {0, 2, 4, 5, 8, 10}, + {5}, + {2}, + {2}, + {0, 1, 3, 4, 5, 7, 9, 10}, + {0, 1, 2, 3, 5, 6, 8, 9, 10}, + {0, 2, 4, 5, 7, 8, 9, 10}, + {3, 5}, + {4}, + {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10}, + {0, 1, 3, 4, 5, 6, 7, 9, 10}, + {6}, + {5, 6}, + {7} + }; + + List> expectedPartIndexes = Arrays.stream(expectedFragmentIndexes).map(Arrays::asList).collect(Collectors.toList()); + Assert.assertEquals(expectedPartIndexes, partIndexes); + } + + @Test + public void testXOR() { + RandomXoshiro256StarStar rng = new RandomXoshiro256StarStar("Wolf"); + byte[] data1 = new byte[10]; + rng.nextData(data1); + Assert.assertEquals("916ec65cf77cadf55cd7", TestUtils.bytesToHex(data1)); + + byte[] data2 = new byte[10]; + rng.nextData(data2); + Assert.assertEquals("f9cda1a1030026ddd42e", TestUtils.bytesToHex(data2)); + + byte[] data3 = FountainEncoder.xor(data1, data2); + Assert.assertEquals("68a367fdf47c8b2888f9", TestUtils.bytesToHex(data3)); + } + + @Test + public void testEncoderCBOR() { + byte[] message = URTest.makeMessage(256, "Wolf"); + FountainEncoder encoder = new FountainEncoder(message, 30, 10, 0); + List parts = IntStream.range(0, 20).mapToObj(i -> encoder.nextPart()).collect(Collectors.toList()); + List partsHex = parts.stream().map(part -> TestUtils.bytesToHex(part.toCborBytes())).collect(Collectors.toList()); + String[] expectedPartsHex = new String[] { + "8501091901001a0167aa07581d916ec65cf77cadf55cd7f9cda1a1030026ddd42e905b77adc36e4f2d3c", + "8502091901001a0167aa07581dcba44f7f04f2de44f42d84c374a0e149136f25b01852545961d55f7f7a", + "8503091901001a0167aa07581d8cde6d0e2ec43f3b2dcb644a2209e8c9e34af5c4747984a5e873c9cf5f", + "8504091901001a0167aa07581d965e25ee29039fdf8ca74f1c769fc07eb7ebaec46e0695aea6cbd60b3e", + "8505091901001a0167aa07581dc4bbff1b9ffe8a9e7240129377b9d3711ed38d412fbb4442256f1e6f59", + "8506091901001a0167aa07581d5e0fc57fed451fb0a0101fb76b1fb1e1b88cfdfdaa946294a47de8fff1", + "8507091901001a0167aa07581d73f021c0e6f65b05c0a494e50791270a0050a73ae69b6725505a2ec8a5", + "8508091901001a0167aa07581d791457c9876dd34aadd192a53aa0dc66b556c0c215c7ceb8248b717c22", + "8509091901001a0167aa07581d951e65305b56a3706e3e86eb01c803bbf915d80edcd64d4d0000000000", + "850a091901001a0167aa07581d330f0f33a05eead4f331df229871bee733b50de71afd2e5a79f196de09", + "850b091901001a0167aa07581d3b205ce5e52d8c24a52cffa34c564fa1af3fdffcd349dc4258ee4ee828", + "850c091901001a0167aa07581ddd7bf725ea6c16d531b5f03254783803048ca08b87148daacd1cd7a006", + "850d091901001a0167aa07581d760be7ad1c6187902bbc04f539b9ee5eb8ea6833222edea36031306c01", + "850e091901001a0167aa07581d5bf4031217d2c3254b088fa7553778b5003632f46e21db129416f65b55", + "850f091901001a0167aa07581d73f021c0e6f65b05c0a494e50791270a0050a73ae69b6725505a2ec8a5", + "8510091901001a0167aa07581db8546ebfe2048541348910267331c643133f828afec9337c318f71b7df", + "8511091901001a0167aa07581d23dedeea74e3a0fb052befabefa13e2f80e4315c9dceed4c8630612e64", + "8512091901001a0167aa07581dd01a8daee769ce34b6b35d3ca0005302724abddae405bdb419c0a6b208", + "8513091901001a0167aa07581d3171c5dc365766eff25ae47c6f10e7de48cfb8474e050e5fe997a6dc24", + "8514091901001a0167aa07581de055c2433562184fa71b4be94f262e200f01c6f74c284b0dc6fae6673f" + }; + + Assert.assertEquals(Arrays.asList(expectedPartsHex), partsHex); + } + + @Test + public void testEncoderIsComplete() { + byte[] message = URTest.makeMessage(256, "Wolf"); + FountainEncoder encoder = new FountainEncoder(message, 30, 10, 0); + int generatedPartsCount = 0; + while(!encoder.isComplete()) { + encoder.nextPart(); + generatedPartsCount++; + } + + Assert.assertEquals(encoder.getSeqLen(), generatedPartsCount); + } + + @Test + public void testDecoder() { + String messageSeed = "Wolf"; + int messageSize = 32767; + int maxFragmentLen = 1000; + + byte[] message = URTest.makeMessage(messageSize, messageSeed); + FountainEncoder encoder = new FountainEncoder(message, maxFragmentLen, 10, 0); + FountainDecoder decoder = new FountainDecoder(); + + do { + FountainEncoder.Part part = encoder.nextPart(); + decoder.receivePart(part); + } while(decoder.getResult() == null); + + Assert.assertEquals(ResultType.SUCCESS, decoder.getResult().type); + Assert.assertArrayEquals(message, decoder.getResult().data); + } + + @Test + public void testDecoderHighFirstSeq() { + String messageSeed = "Wolf"; + int messageSize = 32767; + int maxFragmentLen = 1000; + + byte[] message = URTest.makeMessage(messageSize, messageSeed); + FountainEncoder encoder = new FountainEncoder(message, maxFragmentLen, 10, 100); + FountainDecoder decoder = new FountainDecoder(); + + do { + FountainEncoder.Part part = encoder.nextPart(); + decoder.receivePart(part); + } while(decoder.getResult() == null); + + Assert.assertEquals(ResultType.SUCCESS, decoder.getResult().type); + Assert.assertArrayEquals(message, decoder.getResult().data); + } + + @Test + public void testCBOR() throws CborException { + FountainEncoder.Part part = new FountainEncoder.Part(12, 8, 100, 0x12345678, new byte[] {1,5,3,3,5}); + byte[] cbor = part.toCborBytes(); + FountainEncoder.Part part2 = FountainEncoder.Part.fromCborBytes(cbor); + + Assert.assertArrayEquals(cbor, part2.toCborBytes()); + } +}