From c4d45dfc333a500cf1de8911c37fe07196c47415 Mon Sep 17 00:00:00 2001 From: Kilian <19181985+kilrau@users.noreply.github.com> Date: Mon, 16 Dec 2024 19:01:54 +0100 Subject: [PATCH] docs: add library and referral section --- docs/README.md | 16 ++++++---- docs/SUMMARY.md | 2 ++ docs/libraries.md | 64 ++++++++++++++++++++++++++++++++++++++++ docs/referral-program.md | 26 ++++++++++++++++ 4 files changed, 103 insertions(+), 5 deletions(-) create mode 100644 docs/libraries.md create mode 100644 docs/referral-program.md diff --git a/docs/README.md b/docs/README.md index eb2bc151..09c9f1ae 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,8 @@ --- description: >- Boltz exposes a RESTful HTTP API that can be used to query information like - supported pairs as well as to create and monitor swaps. + supported pairs as well as to create and monitor swaps. All swap clients, like + Boltz Web App, use Boltz API under the hood. cover: .gitbook/assets/boltz-backend_header.png coverY: 0 --- @@ -21,8 +22,9 @@ The corresponding REST APIs can be accessed at: - Mainnet via [Tor](https://www.torproject.org/): `http://boltzzzbnus4m7mta3cxmflnps4fp7dueu2tgurstbvrbt6xswzcocyd.onion/api/` -We operate several lightning nodes on testnet and mainnet, for reliable swapping -on testnet it's advisable to open a direct channel with us: +## Lightning Nodes + +We operate several lightning nodes on testnet and mainnet: - Testnet: [CLN](https://mempool.space/testnet/lightning/node/029040945df331e634fba152ce6a21e3dfca87b68d275e078caeee4753f43e9acb) @@ -33,5 +35,9 @@ on testnet it's advisable to open a direct channel with us: | [LND](https://mempool.space/lightning/node/026165850492521f4ac8abd9bd8088123446d126f648ca35e60f88177dc149ceb2) -In the following sections we'll describe the REST API, walk through swap types & -states, how to craft transactions, handle refunds and more. +For reliable swapping _on testnet_ it's advisable to open a direct channel with +us. + +In the following sections we'll describe the available libraries for our API, +the raw REST API itself, walk through swap types & states, how to craft +transactions, handle refunds and more. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 5fb4ea50..8695742a 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,6 +1,7 @@ # Table of contents - [👋 Introduction](README.md) +- [📙 Libraries](libraries.md) - [🤖 REST API v2](api-v2.md) - [🤖 REST API v1 (deprecated)](api-v1.md) - [🔁 Swap Types & States](lifecycle.md) @@ -12,6 +13,7 @@ - [⚠️ Common Mistakes](common-mistakes.md) - [🪝 Webhooks](webhooks.md) - [⚡ BOLT12](bolt12.md) +- [🤝 Referral Program](referral-program.md) - [🚢 Backend Deployment](deployment.md) - [🐳 Regtest Environment](regtest.md) - [🔙 Back to Docs Home](https://app.gitbook.com/o/SPM8mTvJyc7OIzGL3HD7/s/XUXMXrD8YTzvuqvAeom7/) diff --git a/docs/libraries.md b/docs/libraries.md new file mode 100644 index 00000000..58dfb525 --- /dev/null +++ b/docs/libraries.md @@ -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 %} diff --git a/docs/referral-program.md b/docs/referral-program.md new file mode 100644 index 00000000..eafe7a36 --- /dev/null +++ b/docs/referral-program.md @@ -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 %}