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

Correct typos #168

Merged
merged 1 commit into from
Jun 6, 2024
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 src/guide/lnurlpay.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The service receives the response from the app and forwards it to the sender.

### Step 4: Fetching a bolt11 invoice

The sender fetchs a bolt11 invoice by invoking a GET request to the callback_url with adding a specific amount as a query parameter. For example:
The sender fetches a bolt11 invoice by invoking a GET request to the callback_url with adding a specific amount as a query parameter. For example:
```
https://app.domain.com/lnurlpay/invoice?amount=1000
```
Expand Down
4 changes: 2 additions & 2 deletions src/guide/payment_notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The process involves using a Notification Delivery Service (NDS) acting as an in

### Push notification data

When receiving POST request data on the webhook URL, the NDS should get the `token`, `platform` and optional `app_data` from the URL params. If neccessary, convert the token to a token that can be sent to the push notification service. Then format the data to be sent to the push notification service, which includes converting any json data into a string format.
When receiving POST request data on the webhook URL, the NDS should get the `token`, `platform` and optional `app_data` from the URL params. If necessary, convert the token to a token that can be sent to the push notification service. Then format the data to be sent to the push notification service, which includes converting any JSON data into a string format.

By default the Notification Plugin should receive the push notification data in the following format:

Expand Down Expand Up @@ -57,7 +57,7 @@ The `address_txs_confirmed` notification type will be received by the webhook in

#### Handling LNURL pay requests

Having the ability to process push notifications when the application is in the background or closed also opens up the ability to handle payment requests from a static LNURL address. To do this the application also needs to register a webook with an [LNURL-pay service](lnurlpay.md), then when the LNURL service receives a request on the static LNURL address, it will forward it via the NDS to the application. The Notification Plugin handles the two-step flow for fulfilling these requests.
Having the ability to process push notifications when the application is in the background or closed also opens up the ability to handle payment requests from a static LNURL address. To do this the application also needs to register a webhook with an [LNURL-pay service](lnurlpay.md), then when the LNURL service receives a request on the static LNURL address, it will forward it via the NDS to the application. The Notification Plugin handles the two-step flow for fulfilling these requests.

Firstly the LNURL service receives a request for LNURL-pay information to get the min/max amount that can be received. The LNURL service calls the registered webhook and when receiving this notification, the Notification Plugin will connect to the Breez SDK and send a response back to the LNURL service based on the node info.

Expand Down
2 changes: 1 addition & 1 deletion src/guide/send_spontaneous_payment.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ They can even be spontaneous payments to a node without a bolt11 invoice.

## Adding Extra TLVs to a Spontaneous Payment

A list of extra TLV data can also be sent with the sponaneous payment.
A list of extra TLV data can also be sent with the spontaneous payment.

<custom-tabs category="lang">
<div slot="title">Rust</div>
Expand Down
2 changes: 1 addition & 1 deletion src/guide/service_status.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Retrieving service status

You can check the general health status of the services provided by the Breez SDK.
The response status will inform you if there is maintenance occurring, a service distruption or the services are operational.
The response status will inform you if there is maintenance occurring, a service disruption or the services are operational.

<custom-tabs category="lang">
<div slot="title">Rust</div>
Expand Down
2 changes: 1 addition & 1 deletion src/notifications/android_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class ExampleFcmService : MessagingService, FirebaseMessagingService() {
}
```

Now lets add the foreground service implementation. This should implement the notification plugin `ForegroundService` class, which handles the incoming notification intent and processes the event. To properly implement this, your class needs to override the `onCreate`, `getConnectRequest` and `getServiceConfig` functions. The `getConnectRequest` function is called by the `ForegroundService` to get a BreezSDK `ConnectRequest` which contains the data necessary to connect the SDK to the node. This data includes the Breez API key, the `Config` with it's workingDir and the node seed.
Now lets add the foreground service implementation. This should implement the notification plugin `ForegroundService` class, which handles the incoming notification intent and processes the event. To properly implement this, your class needs to override the `onCreate`, `getConnectRequest` and `getServiceConfig` functions. The `getConnectRequest` function is called by the `ForegroundService` to get a BreezSDK `ConnectRequest` which contains the data necessary to connect the SDK to the node. This data includes the Breez API key, the `Config` with it's `workingDir` and the node seed.

<div class="warning">
<h4>Developer note</h4>
Expand Down
4 changes: 2 additions & 2 deletions src/notifications/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The process involves using a Notification Delivery Service (NDS) acting as an in

### Push notification data

When receiving POST request data on the webhook URL, the NDS should get the `token`, `platform` and optional `app_data` from the URL params. If neccessary, convert the token to a token that can be sent to the push notification service. Then format the data to be sent to the push notification service, which includes converting any json data into a string format.
When receiving POST request data on the webhook URL, the NDS should get the `token`, `platform` and optional `app_data` from the URL params. If necessary, convert the token to a token that can be sent to the push notification service. Then format the data to be sent to the push notification service, which includes converting any JSON data into a string format.

By default the Notification Plugin should receive the push notification data in the following format:

Expand Down Expand Up @@ -57,7 +57,7 @@ The `address_txs_confirmed` notification type will be received by the webhook in

#### Handling LNURL pay requests

Having the ability to process push notifications when the application is in the background or closed also opens up the ability to handle payment requests from a static LNURL address. To do this the application also needs to register a webook with an [LNURL-pay service](/guide/lnurlpay.md), then when the LNURL service receives a request on the static LNURL address, it will forward it via the NDS to the application. The Notification Plugin handles the two-step flow for fulfilling these requests.
Having the ability to process push notifications when the application is in the background or closed also opens up the ability to handle payment requests from a static LNURL address. To do this the application also needs to register a webhook with an [LNURL-pay service](/guide/lnurlpay.md), then when the LNURL service receives a request on the static LNURL address, it will forward it via the NDS to the application. The Notification Plugin handles the two-step flow for fulfilling these requests.

Firstly the LNURL service receives a request for LNURL-pay information to get the min/max amount that can be received. The LNURL service calls the registered webhook and when receiving this notification, the Notification Plugin will connect to the Breez SDK and send a response back to the LNURL service based on the node info.

Expand Down
4 changes: 2 additions & 2 deletions src/notifications/ios_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ More installation methods, including with the Swift Package Manager, can be foun

You're ready to add some Swift code to implement the Notification Plugin in your NotificationService target. In Xcode, in the `NotificationService` folder, open the Swift file named `NotificationService.swift`.

This Swift file should implement the Notification Plugin's `SDKNotificationService` class. The `SDKNotificationService` class handles the incoming notification content and processes the event. To properly implement this class the NotificationService needs to override at least the `getConnectRequest` function. The `getConnectRequest` function is called by the `SDKNotificationService` to get a BreezSDK `ConnectRequest` which contains the data necessary to connect the SDK to the node. This data includes the Breez API key, the `Config` with it's workingDir and the node seed.
This Swift file should implement the Notification Plugin's `SDKNotificationService` class. The `SDKNotificationService` class handles the incoming notification content and processes the event. To properly implement this class the NotificationService needs to override at least the `getConnectRequest` function. The `getConnectRequest` function is called by the `SDKNotificationService` to get a BreezSDK `ConnectRequest` which contains the data necessary to connect the SDK to the node. This data includes the Breez API key, the `Config` with it's `workingDir` and the node seed.

<div class="warning">
<h4>Developer note</h4>
When using the Notification Plugin in iOS, it is important to note that the <code>Config</code> workingDir needs to be set to the app group's shared directory in both the <code>NotificationService</code> target and in the main application target, wheather that is a Swift, Flutter or React Native based application.
When using the Notification Plugin in iOS, it is important to note that the <code>Config</code> <code>workingDir</code> needs to be set to the app group's shared directory in both the <code>NotificationService</code> target and in the main application target, whether that is a Swift, Flutter or React Native based application.
</div>
<div class="warning">
<h4>Developer note</h4>
Expand Down
4 changes: 2 additions & 2 deletions src/notifications/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ You can override the default logger used by the Notification Plugin to use your
<custom-tabs category="lang">
<div slot="title">Swift</div>
<section>
In iOS lets use the <code>XCGLogger</code> to handle logging to a seperate log file in the app group's shared directory.
In iOS lets use the <code>XCGLogger</code> to handle logging to a separate log file in the app group's shared directory.

```swift,ignore
import BreezSDK
Expand Down Expand Up @@ -103,7 +103,7 @@ class ExampleFcmService : MessagingService, FirebaseMessagingService() {
}
```

When the foreground service is created, initialise the Breek SDK log stream and subscribe to log entries
When the foreground service is created, initialise the Breez SDK log stream and subscribe to log entries

```kotlin,ignore
package com.example.application
Expand Down
Loading