mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-02-22 22:36:34 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: Remove e2e dlc info from documentation, add some notes about using gui bundled with node (#1905)

Browse source
This commit is contained in:
Chris Stewart 2020-08-26 12:31:08 -05:00 • committed by GitHub
parent 265716c99d
commit 71e3fbabde
3 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/applications/gui.md
View file

@ -5,7 +5,8 @@ title: GUI
## Bitcoin-S Graphical User Interface
There is now a GUI built using [scalafx](https://www.scalafx.org/) to allow users who do not wish to use the [command line interface](cli.md) to interact with a Bitcoin-S wallet. This GUI is currently very minimal and looks something like this:
There is now a GUI built using [scalafx](https://www.scalafx.org/) to allow users who do not wish to use the [command line interface](cli.md) to interact with a Bitcoin-S wallet.
This GUI is currently very minimal and looks something like this:
![](gui-snapshot.png)
@ -13,7 +14,22 @@ At the time of writing this document, creating addresses and sending Bitcoin are
### Running the GUI
The GUI will only function properly if it can connect to the [bitcoin-s server](server.md) which must be running in the background before running the GUI.
> It is required to use java11 to run the GUI
There are two ways to run the GUI
#### Bundled version (easy)
This command will start both the [bitcoin-s server](server.md) and the GUI at the same time
```bashrc
sbt bundle/run
```
#### Standalone version (advanced)
The GUI will only function properly if it can connect to the [bitcoin-s server](server.md) which must be
running in the background before running the GUI.
To run the gui, simply execute
@ -21,7 +37,7 @@ To run the gui, simply execute
sbt gui/run
```
alternatively the gui can be built into an executable using the [sbt native packager](https://www.scala-sbt.org/sbt-native-packager/).
The gui can be built into an executable using the [sbt native packager](https://www.scala-sbt.org/sbt-native-packager/).
### ScalaFX

22
docs/getting-setup.md
View file

@ -108,28 +108,6 @@ git checkout adaptor-dlc
git submodule update
```
If you want to use the end-to-end DLC client you will need to checkout a separate branch instead:
```bashrc
git fetch origin pull/1389/head:end-to-end-dlc
git checkout end-to-end-dlc
git submodule update
```
if you are using the end-to-end DLC client you will need to make sure eclair is correctly paired with your bitcoind.
You will also need to add an eclair section to your `bitcoin-s.conf`, this needs to be placed inside of the `bitcoin-s` module.
```
eclair {
enabled = true
datadir = ${HOME}/.eclair
bitcoind {
version = "v0.18.99" #needs to be v0.18.99 for neutrino
datadir = ${HOME}/.bitcoin
}
}
```
and then finally test that `Secp256k1Context.isEnabled()` as in Step 2.
## Step 5: Setting Up A Bitcoin-S Server (Neutrino Node)

8
docs/wallet/dlc.md
View file

@ -79,7 +79,13 @@ Where you can replace the messages `WIN` and `LOSE` to have the oracle sign any
## Using the GUI
To first start up the GUI you first need to start your bitcoin-s server, after doing so you can run the gui by doing:
To first start up the GUI you first need to start your bitcoin-s server and gui with
```bashrc
sbt bundle/run
```
or if your bitcoin-s server is already running, you can run the standalone gui with
```bashrc
sbt gui/run