mirror of
https://github.com/lightninglabs/pool.git
synced 2026-08-13 12:33:04 +02:00
Merge pull request #130 from wpaulino/gitbook-render-fixes
docs: gitbook render fixes
This commit is contained in:
commit
e5b147c697
4 changed files with 14 additions and 29 deletions
|
|
@ -36,10 +36,10 @@ If you’d prefer to compile from source code, you’ll need at least `go 1.14`
|
|||
|
||||
Run the following commands to download the code, compile and install Pool:
|
||||
|
||||
```shell script
|
||||
git clone https://github.com/lightninglabs/pool
|
||||
cd pool
|
||||
make install
|
||||
```shell
|
||||
$ git clone https://github.com/lightninglabs/pool
|
||||
$ cd pool
|
||||
$ make install
|
||||
```
|
||||
|
||||
This will install the binaries into your `$GOPATH/bin` directory.
|
||||
|
|
|
|||
|
|
@ -33,18 +33,3 @@ Here we can see I sold a channel for 40k satoshis, and ended up paying 5k satosh
|
|||
In the alpha version of Pool, _script level enforcement_ isn't yet implemented. Script level enforcement would lock the maker's funds in the channel for the lease period. This ensures that they can't just collect the premium \(before coupon channels\) and close out the channel instantly. With script enforcement, they would be able to close the channel \(force close it\), but their funds would be unavailable until the maturity period has passed.
|
||||
|
||||
Instead, we've implemented a feature in `lnd` to prevent channels from being _cooperatively closed_ by the maker until the expiry height \(what we call the `thaw_height`\). Additionally, if we detect a force close by the maker of that channel, then we'll ban them from the market for a set period of time.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To build and run LLM, the following tools/binaries must be installed on your system:
|
||||
|
||||
* Go `1.13` or later
|
||||
* `make`
|
||||
* `lnd` version `v0.11.1-beta` or later with the build tags `signrpc`,
|
||||
|
||||
`walletrpc`, `chainrpc` and `invoicesrpc` enabled \(or the current `master`
|
||||
|
||||
branch built with `make install tags="signrpc walletrpc chainrpc invoicesrpc"`
|
||||
|
||||
if version`v0.11.1-beta` is not yet released\).
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ To build both the `poold` and `pool` binaries from the source code, at least the
|
|||
To download the code, compile and install it, the following commands can then
|
||||
be run:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ git clone https://github.com/lightninglabs/pool
|
||||
$ cd pool
|
||||
$ make install
|
||||
|
|
@ -47,7 +47,7 @@ later to work. It is recommended to run an
|
|||
is also possible but needs to be done **with all sub-server build flags
|
||||
enabled**:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ make install tags="signrpc walletrpc chainrpc invoicesrpc"
|
||||
```
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ If `lnd` is configured with the default values and is running on the same
|
|||
machine, `poold` will be able to connect to it automatically and can be started
|
||||
by simply running:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ poold
|
||||
|
||||
# Or if you want to do everything in the same terminal and run poold in the
|
||||
|
|
@ -76,7 +76,7 @@ machine where `poold` is running.
|
|||
The daemon can then be configured to connect to the remote `lnd` node by using
|
||||
the following command line flags:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ poold --lnd.host=<the_remote_host_IP_address>:10009 \
|
||||
--lnd.macaroondir=/some/directory/with/lnd/data/macaroons \
|
||||
--lnd.tlspath=/some/directory/with/lnd/data/tls.cert
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ BTC that's been burning a hole in our SD card for the past year. We'll place a
|
|||
single order for 10 million satoshis, wanting to receive 0.3% \(30 bps\) over a
|
||||
2016 block period \(approximately 2 weeks\):
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ pool orders submit ask 10000000 0288096be9917f8ebdfc6eb2701635fe658f4eae1e0274dcce41418b3fb5145732 --interest_rate_percent=0.3 --lease_duration_blocks=2016
|
||||
|
||||
-- Order Details --
|
||||
|
|
@ -80,7 +80,7 @@ and also for authentication purposes.
|
|||
|
||||
We can then check out the order we just placed with the following command:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ pool orders list
|
||||
|
||||
{
|
||||
|
|
@ -124,7 +124,7 @@ available.
|
|||
|
||||
Command for submitting an ask order:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ pool orders submit ask
|
||||
```
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ below for more information.
|
|||
|
||||
Command for submitting a bid order:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ pool orders submit bid
|
||||
```
|
||||
|
||||
|
|
@ -236,7 +236,7 @@ possible lease durations are fixed and defined by the auctioneer. The current
|
|||
list of possible lease durations can be queried by running the following
|
||||
command:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ pool auction leasedurations
|
||||
|
||||
{
|
||||
|
|
@ -266,7 +266,7 @@ The fee is set by the server and can change depending on demand, chain fee
|
|||
climate or other operational costs. The current fee can be queried by running
|
||||
the following command:
|
||||
|
||||
```shell script
|
||||
```shell
|
||||
$ pool auction fee
|
||||
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue