From fe31479822c2fffd56a7b049c81d236339dd0ff2 Mon Sep 17 00:00:00 2001 From: Christian Moss Date: Tue, 2 May 2023 21:49:11 +0100 Subject: [PATCH 1/5] Create NIP-XXXX --- NIP-XXXX | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 NIP-XXXX diff --git a/NIP-XXXX b/NIP-XXXX new file mode 100644 index 00000000..84eb4d14 --- /dev/null +++ b/NIP-XXXX @@ -0,0 +1,46 @@ + +# NIP-XXXX: Nostr Data Sharing URI Scheme + +**Author**: Christian Moss +**Status**: Draft +**Type**: Standards Track +**Created**: 2023-05-02 + +## Abstract + +This NIP proposes a new URI scheme for apps to share data, such as text or images, between Nostr clients. + +## Motivation + +It is commonplace in apps, such as games or photo libraries, to share one's achievements and moments on social network platforms like Twitter or Facebook in order to receive recognition and/or interaction from a community. Given the culture of "zapping" and gifting sats in Nostr, it would make sense to create a protocol that allows users to frictionlessly share an image and/or text with a Nostr client. For example, a user could achieve a high score on a mobile game, click a button in the game, which would then open up the user's Nostr client on their mobile device, allowing them to post a screenshot and caption of their achievement. Other players could then zap the user sats in recognition of this achievement. + +## Specification + +The proposed URI scheme format is as follows: + +``nostr-share://?parameter=value¶meter2=value2`` + +The parameters supported in this URI scheme include: 1. `msg`: A string of the message to be shared. 2. `img`: A URL to an image hosted elsewhere (URL encoded) or an image represented as a Base64 encoded string. ### Usage To share a text message, the URI would look like this: + +``nostr-share://?msg=Hello%20World`` + +To share an image (in Base64 format), the URI would look like this: + +``nostr-share://?img=data:image/png;base64,iVBORw0KG...`` +or +``nostr-share://?msg=Hello%20World&img=https%3A%2F%2Fi.imgur.com%2FaI24Z3F.jpeg`` + +To share both, it would look like this: + +``nostr-share://?msg=Hello%20World&img=data:image/png;base64,iVBORw0KG...`` +or +``nostr-share://?msg=Hello%20World&img=https%3A%2F%2Fi.imgur.com%2FaI24Z3F.jpeg`` + + +Applications that support this URI scheme should be able to parse the `msg` parameter and display the data accordingly. For text, the application should display the message as plain text, and for binary data, the application should decode the Base64 string and display the appropriate content. + +Clients implementing this NIP should register the `nostr-share` URI scheme with the operating system, enabling other applications to share data directly with the client. + +## Copyright + +This NIP is licensed under the Creative Commons Attribution 4.0 International License. From fa95a31defe4774e45010f98386693768b7fa17d Mon Sep 17 00:00:00 2001 From: Christian Moss Date: Tue, 2 May 2023 21:57:35 +0100 Subject: [PATCH 2/5] Rename NIP-XXXX to NIP-XXXX.md --- NIP-XXXX => NIP-XXXX.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename NIP-XXXX => NIP-XXXX.md (100%) diff --git a/NIP-XXXX b/NIP-XXXX.md similarity index 100% rename from NIP-XXXX rename to NIP-XXXX.md From de2ea2b4ee63dbd487a95e7d8ecc6b5e84f1a69d Mon Sep 17 00:00:00 2001 From: mandelmonkey Date: Tue, 6 Jun 2023 21:09:04 +0100 Subject: [PATCH 3/5] updated to use new json based scheme --- NIP-XXXX.md | 74 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 52 insertions(+), 22 deletions(-) diff --git a/NIP-XXXX.md b/NIP-XXXX.md index 84eb4d14..f102d22f 100644 --- a/NIP-XXXX.md +++ b/NIP-XXXX.md @@ -1,46 +1,76 @@ - # NIP-XXXX: Nostr Data Sharing URI Scheme -**Author**: Christian Moss -**Status**: Draft -**Type**: Standards Track +**Author**: Christian Moss +**Status**: Draft +**Type**: Standards Track **Created**: 2023-05-02 ## Abstract - This NIP proposes a new URI scheme for apps to share data, such as text or images, between Nostr clients. ## Motivation - -It is commonplace in apps, such as games or photo libraries, to share one's achievements and moments on social network platforms like Twitter or Facebook in order to receive recognition and/or interaction from a community. Given the culture of "zapping" and gifting sats in Nostr, it would make sense to create a protocol that allows users to frictionlessly share an image and/or text with a Nostr client. For example, a user could achieve a high score on a mobile game, click a button in the game, which would then open up the user's Nostr client on their mobile device, allowing them to post a screenshot and caption of their achievement. Other players could then zap the user sats in recognition of this achievement. +It is commonplace in apps, such as games or photo libraries, to share one's achievements and moments on social network platforms like Twitter or Facebook to receive recognition and/or interaction from a community. Given the culture of "zapping" and gifting sats in Nostr, it would make sense to create a protocol that allows users to share an image and/or text with a Nostr client frictionlessly. For example, a user could achieve a high score on a mobile game, click a button in the game, which would then open up the user's Nostr client on their mobile device, allowing them to post a screenshot and caption of their achievement. Other players could then zap the user sats in recognition of this achievement. ## Specification - -The proposed URI scheme format is as follows: - +It was previously proposed to use a URI scheme such as ``nostr-share://?parameter=value¶meter2=value2`` -The parameters supported in this URI scheme include: 1. `msg`: A string of the message to be shared. 2. `img`: A URL to an image hosted elsewhere (URL encoded) or an image represented as a Base64 encoded string. ### Usage To share a text message, the URI would look like this: +Where parameter1 and parameter2 would be something like img, msg, etc., denoting the type of media to be shared. -``nostr-share://?msg=Hello%20World`` +However, after feedback, it was considered a better approach to keep it more generic and include a single JSON blob as the main parameter in line with Nostr notes. -To share an image (in Base64 format), the URI would look like this: +An additional "hint" parameter would also be added to allow the recommendation for a particular relay. -``nostr-share://?img=data:image/png;base64,iVBORw0KG...`` -or -``nostr-share://?msg=Hello%20World&img=https%3A%2F%2Fi.imgur.com%2FaI24Z3F.jpeg`` +Resulting in -To share both, it would look like this: +``nostr-share://?msg={urlEscapedJSON}&hint={urlEscapedRelayUrl}`` -``nostr-share://?msg=Hello%20World&img=data:image/png;base64,iVBORw0KG...`` -or -``nostr-share://?msg=Hello%20World&img=https%3A%2F%2Fi.imgur.com%2FaI24Z3F.jpeg`` +The JSON by default should include at least the following parameters: +``text`` contains a message to be displayed analogous to a tweet or post. +``imageUrl`` contains an image URL to be loaded by the receiving Nostr client. +``videoUrl`` contains a video URL to be loaded by the receiving Nostr client. +``imageBase64`` contains an image encoded as a base64 string to be displayed by the receiving Nostr client. -Applications that support this URI scheme should be able to parse the `msg` parameter and display the data accordingly. For text, the application should display the message as plain text, and for binary data, the application should decode the Base64 string and display the appropriate content. + +In order to contain more images and messages, the JSON could be expanded to contain ``text2`` ``imageUrl2`` + +Example JSON: +``{ +"text": "What sounds does an ostrich make?", +"imgUrl": "https://pbs.twimg.com/profile_images/1604195803748306944/LxHDoJ7P_400x400.jpg", +"videoUrl": "https://i.imgur.com/WC7LW4t.mp4", +"imageBase64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAbElEQVQYGWOc6nznPwMOkLVHmWGay12wLBMONWBhmCIQhwVF4T9Ghqx9SihCMMUIE//jVgTSiVDI+B/uHhQjoRwUq5n/s+JUjDARqPMv429shoHF4CaCggIbwPQMFlVz3J7AReEmwnTCZdAYAGPIHXIm/AOjAAAAAElFTkSuQmCC" +}`` + +Example encoded URI: +``nostr-share://?msg=%7B%22text%22%3A%22What+sounds+does+an+ostrich+make%3F%22%2C%22imgUrl%22%3A%22https%3A%2F%2Fpbs.twimg.com%2Fprofile_images%2F1604195803748306944%2FLxHDoJ7P_400x400.jpg%22%2C%22videoUrl%22%3A%22https%3A%2F%2Fi.imgur.com%2FWC7LW4t.mp4%22%2C%22imageBase64%22%3A%22%22%7D&hint=wss%3A%2F%2Fnostr.zebedee.cloud`` + Clients implementing this NIP should register the `nostr-share` URI scheme with the operating system, enabling other applications to share data directly with the client. +## Example Implementation + +I have develop a sample integration in the form of 2 apps. + +The first app is an example game that generates the nostr-share URI containing a message, imageUrl, base64 encoded image, a video URL, as well as a route hint. + +https://github.com/mandelmonkey/nostr-share-sample-game + +![Nostr Game](https://i.imgur.com/ym6azwT.jpg) + +The second app is an Android app which receives the nostr-share data and displays the media. + +![Nostr Client](https://i.imgur.com/qmFYUmz.jpg) + +![Nostr Client](https://i.imgur.com/MCItlcV.jpg) + +https://github.com/mandelmonkey/nostr-share-wallet-demo + +## Cavaets + +In practice as long as any base64image is small or replaced with an image url this is not a major limitation + ## Copyright -This NIP is licensed under the Creative Commons Attribution 4.0 International License. +This NIP is licensed under the Creative Commons Attribution 4.0 International License. \ No newline at end of file From c8edb06a667167f4fcded0177d4feb0b8047af70 Mon Sep 17 00:00:00 2001 From: mandelmonkey Date: Tue, 6 Jun 2023 21:14:40 +0100 Subject: [PATCH 4/5] formatting --- NIP-XXXX.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/NIP-XXXX.md b/NIP-XXXX.md index f102d22f..5cd9bf5b 100644 --- a/NIP-XXXX.md +++ b/NIP-XXXX.md @@ -51,19 +51,19 @@ Clients implementing this NIP should register the `nostr-share` URI scheme with ## Example Implementation -I have develop a sample integration in the form of 2 apps. +I have developed a sample integration in the form of 2 android apps. The first app is an example game that generates the nostr-share URI containing a message, imageUrl, base64 encoded image, a video URL, as well as a route hint. https://github.com/mandelmonkey/nostr-share-sample-game -![Nostr Game](https://i.imgur.com/ym6azwT.jpg) + The second app is an Android app which receives the nostr-share data and displays the media. + + -![Nostr Client](https://i.imgur.com/qmFYUmz.jpg) - -![Nostr Client](https://i.imgur.com/MCItlcV.jpg) + https://github.com/mandelmonkey/nostr-share-wallet-demo From 611b714cef6c480b0d76ebe8372fafe46e6909c6 Mon Sep 17 00:00:00 2001 From: mandelmonkey Date: Wed, 7 Jun 2023 11:54:05 +0100 Subject: [PATCH 5/5] assigned nip number and added video link --- NIP-XXXX.md => 77.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) rename NIP-XXXX.md => 77.md (95%) diff --git a/NIP-XXXX.md b/77.md similarity index 95% rename from NIP-XXXX.md rename to 77.md index 5cd9bf5b..81f05338 100644 --- a/NIP-XXXX.md +++ b/77.md @@ -1,4 +1,4 @@ -# NIP-XXXX: Nostr Data Sharing URI Scheme +# NIP-0077: Nostr Data Sharing URI Scheme **Author**: Christian Moss **Status**: Draft @@ -49,6 +49,11 @@ Example encoded URI: Clients implementing this NIP should register the `nostr-share` URI scheme with the operating system, enabling other applications to share data directly with the client. +## Explainer Video + +I created a short video explaining the NIP and showing the sample apps +https://youtu.be/VAH_g_Nhq0Y + ## Example Implementation I have developed a sample integration in the form of 2 android apps.