Skip to content

Commit 3a0e716

Browse files
authored
docs: add Boltz Client to Pro docs (#936)
1 parent 9dbb7bc commit 3a0e716

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

docs/pro.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
description:
3-
Boltz Pro is an experimental service designed to dynamically adjust swap fees based on our liquidity needs, helping to maintain our wallet and Lightning channel balances.
2+
description: >-
3+
Boltz Pro is a service designed to dynamically adjust swap fees based on
4+
Boltz's liquidity needs, helping to maintain wallet and Lightning channel
5+
balances.
46
---
57

68
# 🏅 Pro
79

8-
Boltz Pro temporarily offers incentives, like 0% or even negative fees, to encourage users to conduct swaps that work in favor of our liquidity needs. It has much stricter limits, e.g. the available fee budget for routing on Lightning, or the time limit to fund swaps and is not designed to be used for e.g. regular payments.
10+
Boltz Pro temporarily offers incentives, like 0% or even negative fees, to encourage users to conduct swaps that work in favor of our liquidity needs. It has much stricter limits, e.g. the available fee budget for routing on Lightning, or the time limit to fund swaps and is **not designed for regular payments**.
911

1012
## Web Usage
1113

@@ -15,9 +17,16 @@ A web app for Boltz Pro is available at [pro.boltz.exchange](https://pro.boltz.e
1517

1618
Boltz Pro can be accessed via API using the [same endpoints and methods](api-v2.md) as the regular Boltz API. To switch to Boltz Pro, API consumers need to:
1719

18-
- add a `Referral` header to all pair related `GET` requests and set it to `pro`
19-
- set the `referralId` to `pro` when creating swaps
20+
* add a `Referral` header to all pair related `GET` requests and set it to `pro`
21+
* set the `referralId` to `pro` when creating swaps
22+
23+
## API Client
24+
25+
We recommend using [Boltz Client](https://github.com/BoltzExchange/boltz-client) as API consumer for Boltz Pro, as it safely handles key generation and storage, refunds and many common edge cases. Boltz Client is our battle-tested swap client, powering e.g. the popular [Boltz BTCPay Plugin](https://github.com/BoltzExchange/boltz-btcpay-plugin).
26+
27+
28+
Check [this section](https://docs.boltz.exchange/boltz-client/boltz-pro) for details on how to set up Boltz Client for usage with Boltz Pro.
2029

2130
{% hint style="info" %}
22-
We stronly recommend using [Boltz Client](https://github.com/BoltzExchange/boltz-client) as API consumer, which we are continuously expanding for usage with Pro. Please [open an issue](https://github.com/BoltzExchange/boltz-client/issues/new), if you are missing a feature. We advise against using Boltz Web App for automation, as updates might break integrations.
31+
We strongly advise _against_ using Boltz Web App for automation of Boltz Pro, as updates might break integrations.
2332
{% endhint %}

0 commit comments

Comments
 (0)