Skip to content

Commit

Permalink
docs: update autoswap emoji
Browse files Browse the repository at this point in the history
  • Loading branch information
kilrau authored and gitbook-bot committed Feb 5, 2024
1 parent edbb48e commit 327c51f
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
24 changes: 12 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Boltz Client connects to [CLN](https://github.com/ElementsProject/lightning/) or

Design principles:

- CLI-first, fine-grained control and enhanced setup UX via `boltzcli`
- CLN-first: full support of all features
- [Liquid](https://liquid.net/)-first: optimized for Lightning -> Liquid -> mainchain swaps
- Create or import Liquid/mainchain wallets, swap to read-only wallets
- Fully backwards compatible with last [boltz-lnd release](https://github.com/BoltzExchange/boltz-client/releases/tag/v1.2.7)
* CLI-first, fine-grained control and enhanced setup UX via `boltzcli`
* CLN-first: first-class citizen support
* [Liquid](https://liquid.net/)-first: optimized for Lightning -> Liquid -> mainchain swaps
* Create or import Liquid/mainchain wallets, swap to read-only wallets
* Fully backwards compatible with last [boltz-lnd release](https://github.com/BoltzExchange/boltz-client/releases/tag/v1.2.7)

It consists of two main components:

Expand Down Expand Up @@ -67,10 +67,10 @@ To view all CLI flags use `--help`.

The LND node to which the daemon connects has to be version `v0.10.0-beta` or higher. Also, LND needs to be compiled with these build flags (official binaries from Lightning Labs releases include them):

- `invoicerpc` (hold invoices)
- `routerrpc` (multi path payments)
- `chainrpc` (block listener)
- `walletrpc` (fee estimations)
* `invoicerpc` (hold invoices)
* `routerrpc` (multi path payments)
* `chainrpc` (block listener)
* `walletrpc` (fee estimations)

By default, boltzd will attempt to connect to lnd running at `localhost:10009` (`lnd.host` and `lnd.port`) and looking for certificate and macaroon inside the data directory `~/.lnd` (`lnd.datadir`).

Expand All @@ -80,9 +80,9 @@ You can manually set the location of the tls certificate (`lnd.certificate`) and

The daemon connects to CLN through [gRPC](https://docs.corelightning.org/docs/grpc). You need start CLN with the `--grpc-port` CLI flag, or set it in your config:

- `--cln.port` same port as used for `--grpc-port`
- `--cln.host` host of the machine CLN is running on
- `--cln.datadir` data directory of cln (`~/.lightning` by default)
* `--cln.port` same port as used for `--grpc-port`
* `--cln.host` host of the machine CLN is running on
* `--cln.datadir` data directory of cln (`~/.lightning` by default)

You can manually set the paths of `cln.rootcert`, `cln.privatekey` and `cln.certchain` instead of speciyfing the data directory aswell.

Expand Down
12 changes: 6 additions & 6 deletions docs/autoswap.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Autoswap
# 🔁 Autoswap

The autoswap feature of `boltz-client` allows for automated channel rebalancing.

Expand All @@ -8,23 +8,23 @@ The `boltzcli autoswap setup` command will guide you through the initial configu

## Advanced Configuration

Advanced configuration that is not covered in the setup process can be managed using `boltzcli autoswap config`. For instance, run `boltzcli autoswap config AcceptZeroConf true` to enable [0-conf swaps](https://docs.boltz.exchange/v/api/0-conf). Optionally, you can instead edit the `autoswap.toml` file inside your data directory. To apply changes while the daemon is running, reload the config file via `boltzcli autoswap config --reload`.
Advanced configuration that is not covered in the setup process can be managed using `boltzcli autoswap config`. For instance, run `boltzcli autoswap config AcceptZeroConf true` to enable [0-conf swaps](https://docs.boltz.exchange/v/api/0-conf). Optionally, you can instead edit the autoswap-specific `autoswap.toml` file inside your data directory. To apply changes while the daemon is running, reload the config file via `boltzcli autoswap config --reload`.

While autoswap won't create any swaps if `Enabled` is set to false, you can still view swap "recommendations" using `boltzcli autoswap recommendations`, which were to be executed using the current configuration.
While autoswap won't create any swaps if `Enabled` is set to false, you can still view swap recommendations, swaps which were to be executed with the current configuration, using `boltzcli autoswap recommendations.`

Autoswap can either rebalance individual channels or only look at the total balance of your node. This behaviour can be controlled with the `PerChannel` parameter.
Autoswap can either rebalance individual channels or only look at the total balance of your node. This behavior can be controlled with the `PerChannel` parameter.

### Thresholds

Autoswap will create normal swaps when the local balance goes below the minimum balance and reverse swaps when it exceeds the max balance. These thresholds can be set as absolute amounts of sats (`MaxBalance` and `MinBalance`) or as percentage of total channel capacity (`MaxBalancePercent` and `MinBalancePercent`).

### Wallet

Autoswap needs access to a wallet (specified by name) which normal swaps use to send funds from and reverse swaps to send funds to. You can see a list of available wallets using `boltzcli wallet list`. Note that the wallet currency has to match the autoswap currency.
Autoswap needs access to a wallet (specified by name) which normal swaps use to send funds from and reverse swaps to send funds to. You can see a list of available wallets using `boltzcli wallet list`. Note that the wallet currency has to match the autoswap currency.

### Swap Types

You can choose to only create one type of swap. If set to `reverse`, only the max threshold has to be configured while the min will be set to 0. If set to `normal`, only the min threshold needs to be configured and the max will be set to the channel capacity. If left empty, both reverse and normal swaps will be created.
You can choose to only create one type of swap. If set to `reverse`, only the max threshold has to be configured while the min will be set to 0. If set to `normal`, only the min threshold needs to be configured and the max will be set to the channel capacity. If left empty, both reverse and normal swaps will be created and both thresholds will be considered.

### Budget

Expand Down
6 changes: 3 additions & 3 deletions docs/wallets.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Wallets
# 💰 Wallets

`boltz-client` allows you to manage Bitcoin and [Liquid](https://liquid.net/) wallets using [GDK](https://github.com/Blockstream/gdk).

Expand All @@ -8,10 +8,10 @@ To create a new Liquid called "MyLiquidWallet" run:

`boltzcli wallet create MyLiquidWallet L-BTC`

Existing wallets can be **imported**. This can be done as hot wallet via mnemonic or cold read-only wallet via xpub or core descriptor. Read-only wallets serve as a swap target for reverse swaps.
Existing wallets can be **imported**. This can be done as hot wallet via mnemonic or cold read-only wallet via xpub or core descriptor. Read-only wallets can serve as a swap target for reverse swaps.

To import a Bitcoin wallet called "cold" run:

`boltzcli wallet import cold BTC`

A list of available wallets can be generated using `boltzcli wallet list`. The connected lighnting node's internal wallet is available by default. All listed wallets can be used for manual swaps (e.g. `createreverseswap`) or [autoswap](autoswap.md).
A list of available wallets can be generated using `boltzcli wallet list`. The connected lightning node's internal wallet is available by default. All listed wallets can be used for manual swaps (e.g. `createreverseswap`) or [autoswap](autoswap.md).

0 comments on commit 327c51f

Please sign in to comment.