Merge pull request #36 from cbeams/manual

Publish Bisq Network documentation to https://docs.bisq.network

.gitignore

@@ -1,3 +1,7 @@
+# Gradle
+.gradle
+build
+
 # IDEA
 .idea
 *.iml

README.md

@@ -0,0 +1,19 @@
+# Bisq Network Documentation
+
+AsciiDoc sources for the docs hosted at <https://docs.bisq.network>.
+
+## Build
+
+To build locally, run `./gradlew build` and then open `build/asciidoc/html5/index.html` in your browser.
+
+## Deploy
+
+Commits pushed to the `master` branch of this repository are automatically built and deployed via Netlify at <https://app.netlify.com/sites/bisq-network-docs> (permission required).
+
+## Writing Tips
+
+ - Keep the [Asciidoctor user manual][1] handy as a reference when editing.
+ - Install the [Asciidoctor.js Live Preview][2] Chrome extension for instant in-browser rendering of `.adoc` files. This avoids the need to run `gradle build` and then refresh your browser to see the results of your changes.
+
+[1]: https://asciidoctor.org/docs/user-manual
+[2]: https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei

archive.adoc

@@ -0,0 +1,5 @@
+= Archive
+
+ * Original <<exchange/whitepaper#, Bisq whitepaper>>
+ * Original <<dao/overview#, Bisq DAO overview>>
+ * <<exchange/howto/add-alternative-base-currency#, How to add an alternative base currency>>

build.gradle

@@ -0,0 +1,22 @@
+plugins {
+    id 'org.asciidoctor.convert' version '1.5.7'
+}
+
+asciidoctor {
+    sourceDir = file('.')
+
+    resources {
+        from(sourceDir) {
+            include '**/*.png'
+            exclude 'build/**'
+        }
+    }
+
+    attributes 'source-highlighter': 'coderay',
+        icons               : 'font',
+        idprefix            : '',
+        idseparator         : '-',
+        docinfo1            : ''
+}
+
+build.dependsOn asciidoctor

dao/overview.adoc

@@ -2,7 +2,7 @@
 :toc:
 :toc-placement!:
 
-NOTE: This overview of the Bisq DAO has been superseded by a new paper released on October 19th, 2017 titled https://github.com/bisq-network/docs/blob/master/dao/phase-zero.adoc[Phase Zero: A plan for bootstrapping the Bisq DAO]. Please refer to that document for more up to date information; this one will likely be removed soon.
+NOTE: This overview of the Bisq DAO has been superseded by a new paper released on October 19th, 2017 titled <<phase-zero#, Phase Zero: A plan for bootstrapping the Bisq DAO>> Please refer to that document for more up to date information; this one will likely be removed soon.
 
 toc::[]
 
@@ -209,7 +209,7 @@ In short, we see no economic incentive for a majority attack on the Bisq DAO.
 
 == More details and technical specification
 
-More detailed description and technical specifications can be found in the https://docs.google.com/document/d/1jj7bABnf9apjhaa99VQUoRsIHa7I2nlcUu2sNnIReFs/[More details and technical specification] document.
+More detailed description and technical specifications can be found in the <<specification#, Bisq DAO specification>>.
 
 == Conclusion
 

dao/phase-zero.adoc

@@ -1,12 +1,7 @@
 = Phase Zero: A Plan for Bootstrapping the Bisq DAO
-
-Chris Beams  +
-mailto:[email protected][[email protected]]
-
-Manfred Karrer +
-mailto:[email protected][[email protected]]
-
-October 19, 2017
+:sectanchors:
+Chris Beams <chris@beams.io>; Manfred Karrer <mk@nucleo.io>
+v1.0, October 19, 2017
 
 [abstract]
 *Abstract.* We present an overview of Bisq, a peer-to-peer exchange network designed for secure, private and censorship-resistant trading of bitcoin for national currencies and other cryptocurrencies. We demonstrate that while Bisq already provides users with a high degree of security and privacy through decentralized architecture and other protections, the project cannot achieve the degree of censorship resistance it requires without first decentralizing its funding and governance. We review the Bisq DAO and BSQ token that have been designed to achieve this goal and we analyze the risks inherent to rolling them out. We conclude by presenting the _Phase Zero_ plan for a pre-release period in which each aspect of the Bisq DAO is operationalized in an incremental and risk-mitigating fashion. Compensation, voting, bonding and other DAO use cases commence immediately as high-trust operations in a testing environment and iterate toward trust-minimized operations in production. BSQ stake is tracked on Bitcoin testnet during Phase Zero such that BSQ may be earned but not traded or spent. Completion of Phase Zero is marked by a BSQ genesis distribution on Bitcoin mainnet and a Bisq application release supporting BSQ trading and other key DAO use cases.
@@ -38,7 +33,7 @@ Bisq's peer-to-peer bitcoin exchange network has been in operation for 18 months
 
  - Companion https://docs.google.com/presentation/d/1G5_6Kju2OoItZ5lD0jnskqLdOV2dAJpdB6WOjmq9hRk/edit#[slide deck] as delivered at the https://liberate.hcpp.cz/[Hackers Congress 2017] conference in Prague
  - 15-minute https://www.youtube.com/watch?v=AvXWToT-dcQ[video interview] with World Crypto Network covering Bisq, the Bisq DAO and the Phase Zero plan
- - Detailed https://github.com/bisq-network/docs/blob/master/dao/specification.adoc[technical specification] for the Bisq DAO and BSQ token
+ - Detailed <<specification#, technical specification>> for the Bisq DAO and BSQ token
 
 = Part I: Understanding Bisq and the Bisq DAO [[Part-I]]
 

dao/specification.adoc

@@ -1,10 +1,7 @@
 = Bisq DAO technical specification
-:toc:
-:toc-placement!:
+:toc: left
 
-NOTE: This document is a detailed technical specification for the Bisq DAO and BSQ token. For a high-level overview and rationale, please see https://github.com/bisq-network/docs/blob/master/dao/phase-zero.adoc[Phase Zero: A plan for bootstrapping the Bisq DAO].
-
-toc::[]
+NOTE: This document is a detailed technical specification for the Bisq DAO and BSQ token. For a high-level overview and rationale, please see <<phase-zero#, Phase Zero: A plan for bootstrapping the Bisq DAO>>.
 
 == BSQ token
 

docinfo-footer.html

@@ -0,0 +1,14 @@
+<script>
+
+    var link = document.createElement("a");
+    link.setAttribute("href", "index.html");
+    link.innerHTML = "← Back to index<br><br>";
+    var ul = document.createElement("ul");
+    var li = document.createElement("li");
+    ul.appendChild(li);
+    li.appendChild(link);
+    var toc = document.getElementById('toc')
+    var next = document.getElementById('toctitle').nextElementSibling;
+    toc.insertBefore(ul, next);
+
+</script>

getting-started.adoc

@@ -0,0 +1,3 @@
+= Getting Started with Bisq
+
+COMING SOON

gradle/wrapper/gradle-wrapper.properties

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

gradlew

@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  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=""
+
+# 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, switch paths to Windows format before running java
+if $cygwin ; 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=$((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"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,84 @@
+@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=
+
+@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