blip-10 cleanup

pull/535/head
Dave Jones 2023-05-11 08:56:28 -05:00
rodzic 2fb5b8875a
commit cf1fbd56bb
1 zmienionych plików z 42 dodań i 40 usunięć

Wyświetl plik

@ -18,7 +18,6 @@ a `boostagram`.
The payload is a simple JSON structure that is encoded as a TLV in the Lightning payment when it is sent. This The payload is a simple JSON structure that is encoded as a TLV in the Lightning payment when it is sent. This
structure is explained in this document. structure is explained in this document.
Simple Example: Simple Example:
```json ```json
@ -67,6 +66,7 @@ A more complex example:
``` ```
Treated as `utf-8`, the hex value of the above json record would be: Treated as `utf-8`, the hex value of the above json record would be:
```base64 ```base64
7b226170705f6e616d65223a202243617374616d61746963222c20226170705f76657273696f6e223a2022382e302e36222c202276616c75655f 7b226170705f6e616d65223a202243617374616d61746963222c20226170705f76657273696f6e223a2022382e302e36222c202276616c75655f
6d7361745f746f74616c223a2034393936302c202275726c223a202268747470733a2f2f66656564732e62757a7a7370726f75742e636f6d2f31 6d7361745f746f74616c223a2034393936302c202275726c223a202268747470733a2f2f66656564732e62757a7a7370726f75742e636f6d2f31
@ -89,7 +89,8 @@ a plain number.
Identifying the podcast **required**: use one or more of `podcast`, `guid`, `feedID` and/or `url`. **guid preferred** Identifying the podcast **required**: use one or more of `podcast`, `guid`, `feedID` and/or `url`. **guid preferred**
* `guid` (str) [The `<podcast:guid>` tag](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid). * `guid` (
str) [The `<podcast:guid>` tag](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid).
* `podcast` (str) Title of the podcast * `podcast` (str) Title of the podcast
* `feedID` (int) ID of podcast in PodcastIndex.org directory * `feedID` (int) ID of podcast in PodcastIndex.org directory
* `url` (str) RSS feed URL of podcast * `url` (str) RSS feed URL of podcast
@ -155,15 +156,16 @@ Other optional fields:
"[lightning address](https://github.com/andrerfneves/lightning-address/blob/master/README.md#tldr)". "[lightning address](https://github.com/andrerfneves/lightning-address/blob/master/README.md#tldr)".
* `reply_custom_key` (str) The custom key for routing a reply payment to the sender. This field should not be present * `reply_custom_key` (str) The custom key for routing a reply payment to the sender. This field should not be present
if it is not required for payment routing. if it is not required for payment routing.
* `reply_custom_value` (str) The custom value for routing a reply payment to the sender. This field should not be present * `reply_custom_value` (str) The custom value for routing a reply payment to the sender. This field should not be
if it is not required for payment routing. present if it is not required for payment routing.
* `remote_feed_guid` (str) Sometimes a payment will be sent to a feed's value block because a different feed referenced it in a `<podcast:valueTimeSplit>` tag. When that happens, this field will contain the guid of the referencing feed. * `remote_feed_guid` (str) Sometimes a payment will be sent to a feed's value block because a different feed referenced
* `remote_item_guid` (str) Sometimes a payment will be sent to an episode's value block because a different feed referenced it in a `<podcast:valueTimeSplit>` tag. When that happens, this field will contain the guid of the referencing feed's `<item>`. it in a `<podcast:valueTimeSplit>` tag. When that happens, this field will contain the guid of the referencing feed.
* `remote_item_guid` (str) Sometimes a payment will be sent to an episode's value block because a different feed
referenced it in a `<podcast:valueTimeSplit>` tag. When that happens, this field will contain the guid of the
referencing feed's `<item>`.
<br> <br>
## Reference Implementations ## Reference Implementations
* *