mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2024-11-19 09:52:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
e0e2da618e
bisq/docs/dao-setup.md

84 lines
4.9 KiB
Markdown
Raw Normal View History

Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
# Bisq DAO setup guide
## Configure Bitcoin Core
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
If you want to run Bisq with DAO mode enabled you need to configure the `bitcoin.conf` file inside the Bitcoin Core data directory as well adding the `blocknotify` file.
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
bitcoin.conf:
regtest=1
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
# The default rpcPort for regtest from Bitcoin Core 0.16 and higher is: 18443
# The default rpcPort for testnet is: 18332
# For mainnet: 8332
rpcport=18443
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
server=1
txindex=1
rpcuser=YOUR_USER_NAME
rpcpassword=YOUR_PW
blocknotify=bash [PATH TO DATA DIR]/blocknotify %s
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
_Please note that `txindex` triggers a resync of the entire blockchain (be aware if you set that on mainnet as that it will take a while). Also take care if you use that setting for mainnet. Extra settings for more security are recommended in mainnet mode._
The `blocknotify` file need to be added to the Bitcoin Core data directory as well:
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
#!/bin/bash
echo $1 | nc -w 1 127.0.0.1 5120
echo $1 | nc -w 1 127.0.0.1 5121
echo $1 | nc -w 1 127.0.0.1 5122
echo $1 | nc -w 1 127.0.0.1 5123
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
It defines the ports where a new block event gets forwarded. Bisq will listen on that port and each Bisq node need to use a different port. You can add or remove ports from the list inside the file if needed.
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
## Program arguments for DAO mode
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
`--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 enables 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.
`--rpcUser`: RPC user as defined in bitcoin.conf
`--rpcPassword`: RPC pw as defined in bitcoin.conf
`--rpcPort`: RPC port. For regtest 18443
`--rpcBlockNotificationPort`: One of the ports defined in the `blocknotify` file inside the Bitcoin data directory (see: DAO setup for Bitcoin Core).
## DAO mode
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
If you want to run any instance in DAO mode use those program arguments:
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._
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
## DAO genesis transaction
### Use the predefined setup
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
Rename Bisq_DAO_regtest_setup.zip => dao-setup.zip For concision, idiomatic naming and to sort well with dao-setup.md.
2018-11-11 13:21:32 +01:00
The creation of the genesis tx is a bit cumbersome. To make it easier to get started you can use the [dao-setup.zip](dao-setup.zip) file.
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
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._
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
### Setup a custom DAO genesis transaction
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
To create your own genesis transaction follow those steps:
Revise dao-setup.md - Reword headings for clarity and consistency - Polish Markdown syntax
2018-11-11 16:20:00 +01:00
- 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 Bitcoin Core remove the `B` prefix - that prefix is marking a BSQ address but technically it is a BTC address.
- Do the same with Bob.
- You send in sum exactly 2.5 BTC to both Alice and Bob. You can choose how to distribute it (e.g. 1 BTC to Alice 1.5 BTC to Bob).
- Set the miner fee so that it is exactly the remaining 0.00010000 BTC. That might be the tricky part as miner fee selection is not very convenient in Bitcoin Core. In worst case if you cannot get the right miner fee you can add the difference to one of the receivers (e.g. send 1.0000234 BTC instead of 1 BTC).
Extract dao-setup.md from dev-setup.md Prior to this change, DAO setup instructions and information were interspersed within dev-setup.md, making it confusing to the uninitiated reader what they need to do in order to get up and running with a basic local dev environment. All the DAO setup stuff is essentially optional, so separating it out into its own doc makes sense. Now, dev-setup.md is dedicated to the task of getting set up with a self-contained local development environment, and readers can follow the DAO setup instructions separately if and when they need to. Both docs need to be further revised and cleaned up, but that will come in subsequent commits.
2018-11-11 13:16:51 +01:00
_Note: It is important that there is exactly 2.5 BTC spent entirely as described, otherwise the genesis tx is invalid._
Reference in New Issue Copy Permalink