[bisq-network/bisq] Add dev setup guide (#1852)

Thu Nov 1 10:17:39 UTC 2018

ripcurlx approved this pull request.

utACK - 
besides smaller typos (see comments) all is looking good. Thanks for putting this together @ManfredKarrer!

> +
+Here is an overview:
+
+- --baseCurrencyNetwork: The BTC network to use. Possible values are: BTC_REGTEST, BTC_TESTNET, BTC_MAINNET (default)
+- --useLocalhostForP2P: Uses localhost instead of Tor for Bisq P2P network
+- --nodePort: Port number for localhost mode. For seed nodes there is a convention with the last digit is marking the network type and there is a list of hard coded seed nodes addresses (see: DefaultSeedNodeAddresses.java). For regtest: 2002 and 3002. For testnet 2001, 3001 and 4001 and for mainnet:  2000, 3000 and 4000. For normal nodes the port can be chosen freely.
+- --myAddress: Needed for seed nodes only (e.g.: `localhost:3002`) 
+- --useDevPrivilegeKeys: Important for dev testing to allow the developer key for arbitration registration
+- --appName: Custom application name which is used for the data directory. It is important to separate your nodes to not interfere... If not set is uses the default `Bisq` directory.
+
+#### Program arguments for DAO mode
+
+--daoActivated: If set to true it enables the DAO mode. For testnet and regtest it is enabled by default.   
+--genesisBlockHeight: If set it overrides the hard coded block height of the genesis tx. Set it to your local genesis tx height.  
+--genesisTxId: If set it overrides the hard coded genesis tx ID. Set it to your local genesis tx ID.  
+--fullDaoNode: If true it enabled full DAO node mode (in contrast to default lite node mode). At least one seed node must be running as a full DAO node to support other lite nodes.  

If true it **enables**...

> +
+Full node mode:
+
+`--daoActivated=true --genesisBlockHeight=111 --genesisTxId=30af0050040befd8af25068cc697e418e09c2d8ebd8d411d2240591b9ec203cf --baseCurrencyNetwork=BTC_REGTEST --useDevPrivilegeKeys=true --useLocalhostForP2P=true --nodePort=7777 --appName=bisq-BTC_REGTEST_Alice_dao --fullDaoNode=true --rpcUser=YOUR_USER_NAME --rpcPassword=YOUR_PW --rpcPort=18443 --rpcBlockNotificationPort=5120`
+
+Lite node mode:
+
+`--daoActivated=true --genesisBlockHeight=111 --genesisTxId=30af0050040befd8af25068cc697e418e09c2d8ebd8d411d2240591b9ec203cf --baseCurrencyNetwork=BTC_REGTEST --useDevPrivilegeKeys=true --useLocalhostForP2P=true --nodePort=8888 --appName=bisq-BTC_REGTEST_Bob_dao`
+
+_Don't forget to use different rpcBlockNotificationPorts for different full node instances, otherwise only one node will receive the new block event forwarded to that port._
+
+### DAO genesis transaction
+
+#### Use the predefined setup
+
+The creation of the genesis tx is a bit cumbersome. To make it easier to get started you can use the [Bisq_DAO_regtest_setup.zip](https://github.com/bisq-network/bisq/tree/master/doc/Bisq_DAO_regtest_setup.zip) file which you find here in the same directory.

> ...file which you find here in the same directory.

Not sure if wee need the "which your find...."

> +### DAO genesis transaction
+
+#### Use the predefined setup
+
+The creation of the genesis tx is a bit cumbersome. To make it easier to get started you can use the [Bisq_DAO_regtest_setup.zip](https://github.com/bisq-network/bisq/tree/master/doc/Bisq_DAO_regtest_setup.zip) file which you find here in the same directory.
+Extract the file and use those data directories for the Bitcoin Core as well as the Alice and Bob instances which are configured to have the genesis tx as defined in the above program arguments (`30af0050040befd8af25068cc697e418e09c2d8ebd8d411d2240591b9ec203cf` at height `111`).
+
+_You need to adjust the path to the `blocknotify` file inside of `bitcoin.conf` before starting Bitcoin Core._
+
+#### Setup a custom DAO genesis transaction
+
+To create your own genesis transaction follow those steps:
+
+- Send 2.50010000 BTC from Bitcoin Core to another address inside Bitcoin Core (label it with `Genesis funding address`).
+- Go to the send screen and open the coin control feature. Select the labeled transaction output of the address labeled with `Genesis funding address`. Use that as the only input source for the genesis tx.
+- Start Alice in full or lite node mode and go to the DAO/Wallet/Receive screen. Copy the BSQ address and use it for one of the receivers of the genesis tx. When pasting into Bitcoiin Core remove the `B` prefix - that prefix is marking a BSQ address but technically it is a BTC address.

Typo: **Bitcoiin** Core  should be Bitcoin Core

> @@ -0,0 +1,63 @@
+## Hosted Bisq using VPS
+
+
+From: https://github.com/bisq-network/exchange/issues/511
+
+It's possible to install and view Bisq using a Google Compute Engine instance. This is handy and allows offers to always be visible, as well as the possibility to inspect the status of the client.
+
+This is how to host Bisq:
+
+Go to Google compute engine (https://cloud.google.com/compute/) and start an instance using the free trial. One gets $300 credit and 60 days trial period. I used one CPU, 40 GByte of boot disk, and the default value of RAM, 3.75 GB.
+I chose Ubuntu 16.04 LTS as the operating system.
+
+How to make a project and start an instance is explained in: https://goo.gl/1Ljy7O which also explains how to install a vnc-server. In short, ssh to your instance, which can be done from the google compute engine (gce) console, then execute the following script:

In short, **add** ssh to 

> @@ -0,0 +1,63 @@
+## Hosted Bisq using VPS
+
+
+From: https://github.com/bisq-network/exchange/issues/511
+
+It's possible to install and view Bisq using a Google Compute Engine instance. This is handy and allows offers to always be visible, as well as the possibility to inspect the status of the client.
+
+This is how to host Bisq:
+
+Go to Google compute engine (https://cloud.google.com/compute/) and start an instance using the free trial. One gets $300 credit and 60 days trial period. I used one CPU, 40 GByte of boot disk, and the default value of RAM, 3.75 GB.
+I chose Ubuntu 16.04 LTS as the operating system.
+
+How to make a project and start an instance is explained in: https://goo.gl/1Ljy7O which also explains how to install a vnc-server. In short, ssh to your instance, which can be done from the google compute engine (gce) console, then execute the following script:

Google should be uppercase (being picky now ;-))

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq/pull/1852#pullrequestreview-170621809
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20181101/b4d9beca/attachment.html>