-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add library and referral section
- Loading branch information
Showing
4 changed files
with
103 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
description: >- | ||
Integrating Boltz API directly is involved and not to be underestimated. To | ||
save on time and resources, we highly recommend exploring the different Boltz | ||
library options below. | ||
--- | ||
|
||
# 📙 Libraries | ||
|
||
## TypeScript | ||
|
||
[Boltz Core](https://github.com/BoltzExchange/boltz-core): Our reference library | ||
in TypeScript. | ||
|
||
Used by e.g.: [Boltz Web App](https://github.com/BoltzExchange/boltz-web-app) | ||
and [Boltz Backend](https://github.com/BoltzExchange/boltz-backend) | ||
|
||
Supported currencies: Bitcoin, Lightning, Liquid, Rootstock | ||
|
||
## Go | ||
|
||
[Boltz Client](https://github.com/BoltzExchange/boltz-client/tree/master/boltz): | ||
Our reference client to accept Lightning payments and rebalance Lightning nodes; | ||
provides a fully fledged Go library for Boltz API. | ||
|
||
Used by e.g.: | ||
[Boltz BTCPay Plugin](https://github.com/BoltzExchange/boltz-btcpay-plugin/) | ||
|
||
Supported currencies: Bitcoin, Lightning, Liquid | ||
|
||
## Rust | ||
|
||
[Boltz Rust](https://github.com/SatoshiPortal/boltz-rust): Boltz API library in | ||
Rust, developed and maintained by the amazing folks at | ||
[Bull Bitcoin](https://www.bullbitcoin.com/). | ||
|
||
Used by e.g.: | ||
[Bull Bitcoin Mobile](https://github.com/SatoshiPortal/bullbitcoin-mobile) and | ||
[Aqua Wallet](https://github.com/AquaWallet/aqua-wallet) via | ||
[Boltz Dart](https://github.com/SatoshiPortal/boltz-dart) | ||
|
||
Supported currencies: Bitcoin, Lightning, Liquid | ||
|
||
[Breez Liquid SDK](https://github.com/breez/breez-sdk-liquid): End-to-end | ||
solution for developers with notification system and bindings for Kotlin, | ||
Flutter, Python, React Native, and Swift. | ||
|
||
Used by e.g.: [StashPay](https://github.com/onionmill/stashpay) | ||
|
||
Supported currencies: Bitcoin, Lightning, Liquid | ||
|
||
## Python | ||
|
||
[Boltz Client Python](https://github.com/BoltzExchange/boltz-client-python): | ||
Currently unmaintained Boltz API client in Python; based on the _deprecated_ | ||
Boltz API v1. | ||
|
||
Used by e.g.: [LNbits](https://github.com/lnbits/boltz) | ||
|
||
Supported currencies: Bitcoin, Lightning, Liquid | ||
|
||
{% hint style="info" %} Note: If Python is preferred, we recommend using the | ||
[Breez Liquid SDK](https://github.com/breez/breez-sdk-liquid) with Python | ||
bindings. {% endhint %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
description: >- | ||
Boltz operates a referral program which provides eligible partners with | ||
rewards for impactful, high quality integrations of Boltz API | ||
--- | ||
|
||
# 🤝 Referral Program | ||
|
||
Who is eligible: | ||
|
||
- Integrations that make Boltz Swaps natively available through their platform | ||
or service and actively maintain the integration, fixing Boltz-related bugs, | ||
keeping up with Boltz API updates etc. | ||
- Integrations maintaining Boltz's non-custodial property down to the end-user. | ||
More see [#client-side](common-mistakes.md#client-side 'mention') | ||
- Integrations reaching an agreed volume threshold | ||
|
||
Not eligible for the partner program are for instance: | ||
|
||
- Integrations using Boltz to accept payments for goods and services (e.g. | ||
[Boltz BTCPay Plugin](https://github.com/BoltzExchange/boltz-btcpay-plugin/)) | ||
- Simple linking or embedding of Boltz Web App | ||
|
||
{% hint style="info" %} Boltz reserves all rights to change conditions of the | ||
referral program at any time and to sovereignly decide which integrations to | ||
onboard and, in some cases, which to offboard. {% endhint %} |