Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Liquid SDK to Nodeless #64

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
language = "en"
multilingual = true
src = "src"
title = "Breez SDK - Liquid"
title = "Breez SDK - Nodeless"

[output.html]
theme = "theme"
Expand Down
4 changes: 2 additions & 2 deletions examples/python/cli/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/python/cli/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions src/guide/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 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)**
- **[Listening to events](/guide/events.md)**
- **[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 <a target="_blank" href="{{api_key_form_uri}}">here</a>.

**Note:** This is not the same as the Greenlight Breez API key, so it cannot be reused.
Expand Down
2 changes: 1 addition & 1 deletion src/guide/lnurl_pay_service.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/notifications/getting_started.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading