From f458fdd6c8e08104b74c5e26fb4c1a9b49b9b316 Mon Sep 17 00:00:00 2001 From: Ross Savage Date: Wed, 15 Jan 2025 09:30:00 +0100 Subject: [PATCH] Rename Liquid SDK to Nodeless --- book.toml | 2 +- examples/python/cli/README.md | 4 ++-- examples/python/cli/cli.py | 2 +- src/SUMMARY.md | 2 +- src/guide/getting_started.md | 4 ++-- src/guide/lnurl_pay_service.md | 2 +- src/notifications/getting_started.md | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/book.toml b/book.toml index cb826ae0..615512c5 100644 --- a/book.toml +++ b/book.toml @@ -2,7 +2,7 @@ language = "en" multilingual = true src = "src" -title = "Breez SDK - Liquid" +title = "Breez SDK - Nodeless" [output.html] theme = "theme" diff --git a/examples/python/cli/README.md b/examples/python/cli/README.md index 4b3bb013..08d71ccc 100644 --- a/examples/python/cli/README.md +++ b/examples/python/cli/README.md @@ -1,7 +1,7 @@ -# Breez SDK - *Liquid* +# Breez SDK - Nodeless *(Liquid Implementation)* ## Python CLI Example -This is a basic CLI to send and receive payments in Python using Breez SDK - *Liquid* +This is a basic CLI to send and receive payments in Python using Breez SDK - Nodeless *(Liquid Implementation)* ### Setup diff --git a/examples/python/cli/cli.py b/examples/python/cli/cli.py index 24290fd2..ae96814a 100644 --- a/examples/python/cli/cli.py +++ b/examples/python/cli/cli.py @@ -26,7 +26,7 @@ class Sdk: def __init__(self, network: Optional[LiquidNetwork] = None): api_key = os.getenv('BREEZ_API_KEY') if api_key is None: - raise Exception("Cannot start Breez SDK Liquid without a Breez API key. You can request one here: https://breez.technology/request-api-key/#contact-us-form-sdk") + raise Exception("Cannot start SDK without a Breez API key. You can request one here: https://breez.technology/request-api-key/#contact-us-form-sdk") mnemonic = self.read_mnemonic() config = breez_sdk_liquid.default_config(network or LiquidNetwork.TESTNET, api_key) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index cab99b9d..1f2708d6 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,7 +2,7 @@ # API Overview -- [About Breez SDK - Liquid](guide/about_breez_sdk_liquid.md) +- [About Breez SDK - Nodeless](guide/about_breez_sdk_liquid.md) - [Getting started](guide/getting_started.md) - [Installing the SDK](guide/install.md) - [Connecting and disconnecting](guide/connecting.md) diff --git a/src/guide/getting_started.md b/src/guide/getting_started.md index 244305ca..6f4673a5 100644 --- a/src/guide/getting_started.md +++ b/src/guide/getting_started.md @@ -1,6 +1,6 @@ # Getting started -Integrating Breez SDK - *Liquid* into your application takes just a few minutes. Follow these steps to get started: +Integrating Breez SDK - Nodeless *(Liquid Implementation)* into your application takes just a few minutes. Follow these steps to get started: - **[Installing the SDK](/guide/install.md)** - **[Connecting](/guide/connecting.md)** - **[Fetching the Wallet State](/guide/wallet_state.md)** @@ -8,7 +8,7 @@ Integrating Breez SDK - *Liquid* into your application takes just a few minutes. - **[Adding logging](/guide/logging.md)** ## API Key -The _Liquid_ Breez API key must be set in order for the SDK to work. +The _Nodeless_ Breez API key must be set in order for the SDK to work. You can request one for free by filling our form here. **Note:** This is not the same as the Greenlight Breez API key, so it cannot be reused. diff --git a/src/guide/lnurl_pay_service.md b/src/guide/lnurl_pay_service.md index 4fc368f7..1fcaaf83 100644 --- a/src/guide/lnurl_pay_service.md +++ b/src/guide/lnurl_pay_service.md @@ -1,6 +1,6 @@ # Receiving payments using LNURL-Pay -Breez SDK - *Liquid* users have the ability to receive Lightning payments using [LNURL-Pay](https://github.com/lnurl/luds/blob/luds/06.md). +Breez SDK - Nodeless *(Liquid Implementation)* users have the ability to receive Lightning payments using [LNURL-Pay](https://github.com/lnurl/luds/blob/luds/06.md). LNURL-Pay requires a web service that serves LNURL-Pay requests. This service needs to communicate with the SDK in order to fetch the necessary metadata data and the associated payment request. To interact with the SDK, the service uses a simple protocol over push notifications: diff --git a/src/notifications/getting_started.md b/src/notifications/getting_started.md index f135e42c..18aa0315 100644 --- a/src/notifications/getting_started.md +++ b/src/notifications/getting_started.md @@ -1,12 +1,12 @@ # Implementing mobile notifications -The Breez SDK - *Liquid* Notification Plugin provides developers a simple solution to improve the payment experience on a mobile device. No longer does the application need to be in foreground when receiving payments. When the Notification Plugin is added to process push notifications, the application can be in the background or even closed. +The Breez SDK - Nodeless *(Liquid Implementation)* Notification Plugin provides developers a simple solution to improve the payment experience on a mobile device. No longer does the application need to be in foreground when receiving payments. When the Notification Plugin is added to process push notifications, the application can be in the background or even closed. ## How it works The process involves using a Notification Delivery Service (NDS) acting as an intermediary host by the application developer. The NDS must provide a public facing webhook URL where a POST request can be sent to when a notification needs to be delivered to the application. The NDS then forwards the data sent in the webhook POST request via push notification to the application. When the application then receives the push notification, the SDK Notification Plugin can be used to process the event. -![Breez SDK - Liquid Notifications](../images/BreezSDK_Liquid_Notifications.png) +![Breez SDK - Notifications](../images/BreezSDK_Liquid_Notifications.png) ### Push notification data