mirror of
https://github.com/bisq-network/bisq.git
synced 2025-01-18 21:35:03 +01:00
Fix typos
This commit is contained in:
parent
884f6f62b2
commit
e81a665f9b
@ -18,7 +18,7 @@ Status
|
||||
------
|
||||
Bisq has released the beta version on the 27th of April 2016. It is operational since that time without any major incident.
|
||||
Please follow the current development state at our [road map]( https://bisq.network/roadmap).
|
||||
For the latest version checkout our [releases page](https://github.com/bisq-network/exchange/releases) at Github.
|
||||
For the latest version checkout our [releases page](https://github.com/bisq-network/exchange/releases) at GitHub.
|
||||
|
||||
Building from source
|
||||
--------------------
|
||||
|
@ -1,4 +1,4 @@
|
||||
Contributing to bisq
|
||||
Contributing to Bisq
|
||||
============================
|
||||
|
||||
Pull requests
|
||||
|
@ -1,5 +1,5 @@
|
||||
#!/bin/sh
|
||||
# Restart bisq seed node daemons whose resident memory (RSS)
|
||||
# Restart Bisq seed node daemons whose resident memory (RSS)
|
||||
# is over MAX_RSS_MiB.
|
||||
#
|
||||
# Scripts in the INITDIR must contain a ``SN_ADDRESS=<host:port>``
|
||||
@ -13,7 +13,7 @@ MAX_RSS_MiB=400
|
||||
PIDDIR=/var/run/bisq-sn
|
||||
INITDIR=/etc/init.d
|
||||
|
||||
# Restart de daemon with the given address.
|
||||
# Restart the daemon with the given address.
|
||||
restart() {
|
||||
rcscript=$(grep -El "^SN_ADDRESS=['\"]?$1['\"]?" $INITDIR/*)
|
||||
if [ "$rcscript" ]; then
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
# Here are the typical locations for the data directory:
|
||||
|
||||
# Mac OSX: /Users/username/Library/Application Support/bisq/
|
||||
# macOS: /Users/username/Library/Application Support/bisq/
|
||||
# Linux: /home/username/.bisq/
|
||||
# Windows XP: C:\Documents and Settings\username\Application Data\bisq\
|
||||
# Windows Vista or 7: %appdata%/bisq/
|
||||
|
@ -103,7 +103,7 @@ If you want to build the binaries check out the build scripts under the package
|
||||
DAO full node
|
||||
-----------------
|
||||
If you want to run your own BSQ transaction verification node you have to run Bitcoin Core with RPC enabled and
|
||||
use dedicated program arguments for the bisq node.
|
||||
use dedicated program arguments for the Bisq node.
|
||||
See https://github.com/bisq-network/bisq-desktop/blob/master/doc/rpc.md for more details.
|
||||
|
||||
|
||||
|
@ -10,7 +10,7 @@ JAVA_HOME=/usr/lib/jvm/java-8-oracle
|
||||
# and add JAVA_HOME to .bashrc
|
||||
# export JAVA_HOME=/usr/lib/jvm/java-8-oracle
|
||||
|
||||
echo "Install bisq"
|
||||
echo "Install Bisq"
|
||||
cd ~/bisq
|
||||
./gradlew build
|
||||
cd ..
|
||||
|
@ -6,25 +6,25 @@ NOTE: this doc is out of date and should probably be deleted. Protobuffer stuff
|
||||
|
||||
Protobuffer is installed automatically via the Gradle build.
|
||||
|
||||
## Why protobuffer?
|
||||
## Why Protobuffer?
|
||||
|
||||
There are a number of reasons why protobuffer was chosen, here are some of them:
|
||||
* avoids java serialisation security issues
|
||||
* smaller in size than java serialisation (less network usage)
|
||||
* All P2P network messages are described in a clear protobuffer schema
|
||||
* All P2P network messages are described in a clear Protobuffer schema
|
||||
* allows to evolve your schema in a backward compatible way
|
||||
* can generate code in many languages, making alternative bisq clients or monitoring tools easier
|
||||
|
||||
## Which classes are transformed to protobuffer?
|
||||
## Which classes are transformed to Protobuffer?
|
||||
|
||||
All classes in the 'wire' module. This module contains the following classes:
|
||||
|
||||
* classes sent over the wire (P2P network)
|
||||
* classes serialized to disk
|
||||
|
||||
## Where are the protobuffer related files?
|
||||
## Where are the Protobuffer related files?
|
||||
|
||||
The protobuffer schema file(s), generated classes and domain classes are in the 'wire' module.
|
||||
The Protobuffer schema file(s), generated classes and domain classes are in the 'wire' module.
|
||||
Look for *.proto for the schema files.
|
||||
|
||||
## How is serialisation done (Java -> Protobuffer)
|
||||
@ -36,7 +36,7 @@ Some interfaces have a 'toProtobuf' method to force all extending classes to imp
|
||||
Some interfaces have a 'toProtobuf' method to force all extending classes to implement that method.
|
||||
|
||||
|
||||
## If fields are not filled in, what are protobuffer's default values?
|
||||
## If fields are not filled in, what are Protobuffer's default values?
|
||||
|
||||
Read this very carefully:
|
||||
|
||||
@ -82,7 +82,7 @@ https://ruedigermoeller.github.io/fast-serialization/
|
||||
* Try to use value objects for data which gets serialized with PB
|
||||
* Use toProto and a static fromProto in the class which gets serialized
|
||||
* Use proto as name for the PB param in the fromProto method
|
||||
* If a constructor is used only for PB make it private and put it to the PB section, so its clear it is used only in that context
|
||||
* If a constructor is used only for PB make it private and put it to the PB section, so it's clear it is used only in that context
|
||||
* Use same name for classes and fields in PB definition as in the java code base
|
||||
* Use final
|
||||
* Use Lombok Annotations
|
||||
|
@ -20,7 +20,7 @@ For mainnet:
|
||||
--fullDaoNode=true --rpcUser=bisq --rpcPassword=bisqPW --rpcPort=8332 --rpcBlockNotificationPort=4159
|
||||
|
||||
If you use mainnet it is recommended to use a Bitcoin node with no funds in the wallet to avoid security risks when
|
||||
enabling rpc or take sufficient precautions from your network setup.
|
||||
enabling RPC or take sufficient precautions from your network setup.
|
||||
|
||||
In the bitcoin.conf file you need to set txindex=1.
|
||||
That causes a re-index of the whole data base which takes considerable time with a
|
||||
@ -31,6 +31,6 @@ If you want to dump the blockchain data to json add: --dumpBlockchainData=true (
|
||||
If you use RegTest in development environment you need to create the genesis transaction.
|
||||
Create one Bitcoin transaction from Bitcoin Core to one or 2 Bisq instances using the BSQ receive addresses from those apps (1 tx with 2 or more outputs to the Bisq app).
|
||||
If you copy the BSQ address and use that in Bitcoin Core you need to remove the "B" at the beginning. This is only for protection to mix up BTC and BSQ addresses but without the B it is a native Bitcoin address.
|
||||
Create one block with the debug commandline inside Bitcoin Core (generate 1). Look up the block height in the info screen in the debug window.
|
||||
Create one block with the debug command line inside Bitcoin Core (generate 1). Look up the block height in the info screen in the debug window.
|
||||
Set the block height and transaction ID at BsqBlockChain.BTC_REG_TEST_GENESIS_TX_ID and BsqBlockChain.BTC_REG_TEST_GENESIS_BLOCK_HEIGHT.
|
||||
Restart the Bisq apps. After that the app will recognize the received Bitcoin as BSQ.
|
||||
|
@ -1,4 +1,4 @@
|
||||
## UI Architecure pattern:
|
||||
## UI Architecture pattern:
|
||||
We use a variant of the **Presentation Model** pattern which has some similarities with the **Model View ViewModel**
|
||||
(MVVM used in Silverlight and WPF) as we use data bindings, though there are differences in the way the view and
|
||||
the "code behind" is organized (due to different framework features/support).
|
||||
@ -25,7 +25,7 @@ For prototyping the UI we stick first with a more rapid development style approa
|
||||
* View/CB is responsible for the visual representation. No logic. No state.
|
||||
* Presentation model holds the view/CB state.
|
||||
* Presentation model handles view specific logic.
|
||||
* Presentation model does validation of user in put and formatting of domain data.
|
||||
* Presentation model does validation of user input and formatting of domain data.
|
||||
* Model is the domain specific representation of the view. It holds domain data and handles domain logic.
|
||||
|
||||
|
||||
|
2
gradlew
vendored
2
gradlew
vendored
@ -164,7 +164,7 @@ 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
|
||||
# by default we should be in the correct project dir, but when run from Finder on macOS, the cwd is wrong
|
||||
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
|
||||
cd "$(dirname "$0")"
|
||||
fi
|
||||
|
@ -10,7 +10,7 @@ version=0.6.7
|
||||
|
||||
dir="/media/sf_vm_shared_ubuntu14_32bit"
|
||||
|
||||
# Note: fakeroot needs to be installed on linux
|
||||
# Note: fakeroot needs to be installed on Linux
|
||||
$JAVA_HOME/bin/javapackager \
|
||||
-deploy \
|
||||
-Bruntime="$JAVA_HOME/jre" \
|
||||
|
@ -10,7 +10,7 @@ version=0.6.7
|
||||
|
||||
dir="/media/sf_vm_shared_ubuntu"
|
||||
|
||||
# Note: fakeroot needs to be installed on linux
|
||||
# Note: fakeroot needs to be installed on Linux
|
||||
$JAVA_HOME/bin/javapackager \
|
||||
-deploy \
|
||||
-Bruntime="$JAVA_HOME/jre" \
|
||||
|
@ -22,7 +22,7 @@
|
||||
<string>APPL</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>1</string>
|
||||
<!-- CFBundleSignature exists only for compatibility with Classic Mac OS apps and documents. Modern Mac OS X apps don't need to worry about assigning a Bundle Signature.-->
|
||||
<!-- CFBundleSignature exists only for compatibility with Classic macOS apps and documents. Modern macOS apps don't need to worry about assigning a Bundle Signature.-->
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>LSApplicationCategoryType</key>
|
||||
|
@ -21,7 +21,7 @@ cp build/libs/bisq-desktop.jar "deploy/Bisq-$version.jar"
|
||||
# copy app jar to VM shared folders
|
||||
cp build/libs/bisq-desktop.jar "$linux32/Bisq-$version.jar"
|
||||
cp build/libs/bisq-desktop.jar "$linux64/Bisq-$version.jar"
|
||||
# At windows we don't add the version nr as it would keep multiple versions of jar files in app dir
|
||||
# On Windows we don't add the version nr as it would keep multiple versions of jar files in app dir
|
||||
cp build/libs/bisq-desktop.jar "$win32/Bisq.jar"
|
||||
cp build/libs/bisq-desktop.jar "$win64/Bisq.jar"
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
:: Invoke from bisq home directory
|
||||
:: Invoke from Bisq home directory
|
||||
:: edit iss file -> AppVersion
|
||||
:: edit -> -BappVersion and -srcfiles
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
:: Invoke from bisq home directory
|
||||
:: Invoke from Bisq home directory
|
||||
:: edit iss file -> AppVersion
|
||||
:: edit -> -BappVersion and -srcfiles
|
||||
|
||||
|
@ -106,7 +106,7 @@ public class SystemTray {
|
||||
BufferedImage trayIconImage = ImageIO.read(getClass().getResource(path));
|
||||
TrayIcon trayIcon = new TrayIcon(trayIconImage);
|
||||
// On Windows and Linux the icon needs to be scaled
|
||||
// On OSX we get the correct size from the provided image
|
||||
// On macOS we get the correct size from the provided image
|
||||
if (!Utilities.isOSX()) {
|
||||
int trayIconWidth = trayIcon.getSize().width;
|
||||
trayIcon = new TrayIcon(trayIconImage.getScaledInstance(trayIconWidth, -1, Image.SCALE_SMOOTH));
|
||||
|
@ -161,7 +161,7 @@ public class BisqApp extends Application implements UncaughtExceptionHandler {
|
||||
public void handleUncaughtException(Throwable throwable, boolean doShutDown) {
|
||||
if (!shutDownRequested) {
|
||||
if (scene == null) {
|
||||
log.warn("Scene not available yet, we create a new scene. The bug might be caused by an exception in a constructor or by a circular dependency in guice. throwable=" + throwable.toString());
|
||||
log.warn("Scene not available yet, we create a new scene. The bug might be caused by an exception in a constructor or by a circular dependency in Guice. throwable=" + throwable.toString());
|
||||
scene = new Scene(new StackPane(), 1000, 650);
|
||||
scene.getStylesheets().setAll(
|
||||
"/bisq/desktop/bisq.css",
|
||||
@ -225,7 +225,7 @@ public class BisqApp extends Application implements UncaughtExceptionHandler {
|
||||
stage.setMinWidth(1020);
|
||||
stage.setMinHeight(620);
|
||||
|
||||
// on windows the title icon is also used as task bar icon in a larger size
|
||||
// on Windows the title icon is also used as task bar icon in a larger size
|
||||
// on Linux no title icon is supported but also a large task bar icon is derived from that title icon
|
||||
String iconPath;
|
||||
if (Utilities.isOSX())
|
||||
|
Loading…
Reference in New Issue
Block a user