From 53afaaece61f02e92b5ef9c3e9c32945c7ebf522 Mon Sep 17 00:00:00 2001 From: kieran Date: Mon, 27 May 2024 12:18:27 +0100 Subject: [PATCH 01/95] nip71 imeta --- 71.md | 117 ++++++++++++++++++++++++++++++++-------------------------- 94.md | 13 ++++--- 2 files changed, 71 insertions(+), 59 deletions(-) diff --git a/71.md b/71.md index a811434..fa8faa9 100644 --- a/71.md +++ b/71.md @@ -20,21 +20,60 @@ The format uses a parameterized replaceable event kind `34235` for horizontal vi The `.content` of these events is a summary or description on the video content. -The list of tags are as follows: -* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. -* `url` (required) the url to the video file -* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. +The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md) + +Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties. + +Example: +```json +[ + ["imeta", + "dim 1920x1080", + "url https://myvideo.com/1080/12345.mp4", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", + "m video/mp4", + "image https://myvideo.com/1080/12345.jpg", + "image https://myotherserver.com/1080/12345.jpg", + "fallback https://myotherserver.com/1080/12345.mp4", + "fallback https://andanotherserver.com/1080/12345.mp4", + "service nip96", + ], + ["imeta", + "dim 1280x720", + "url https://myvideo.com/720/12345.mp4", + "x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d", + "m video/mp4", + "image https://myvideo.com/720/12345.jpg", + "image https://myotherserver.com/720/12345.jpg", + "fallback https://myotherserver.com/720/12345.mp4", + "fallback https://andanotherserver.com/720/12345.mp4", + "service nip96", + ], + ["imeta", + "dim 1280x720", + "url https://myvideo.com/720/12345.m3u8", + "x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f", + "m application/x-mpegURL", + "image https://myvideo.com/720/12345.jpg", + "image https://myotherserver.com/720/12345.jpg", + "fallback https://myotherserver.com/720/12345.m3u8", + "fallback https://andanotherserver.com/720/12345.m3u8", + "service nip96", + ], +] +``` + +Where `url` is the primary server url and `fallback` are other servers hosting the same file, both `url` and `fallback` should be weighted equally and clients are recommended to use any of the provided video urls. + +The `image` tag contains a preview image (at the same resolution). Multiple `image` tags may be used to specify fallback copies in the same way `fallback` is used for `url`. + +Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash. + +### Other tags: * `title` (required) title of the video -* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published -* `x` containing the SHA-256 hexencoded string of the file. -* `size` (optional) size of file in bytes -* `dim` (optional) size of file in pixels in the form `x` +* `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published * `duration` (optional) video duration in seconds -* `magnet` (optional) URI to magnet file -* `i` (optional) torrent infohash * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code -* `thumb` (optional) url of thumbnail with same aspect ratio -* `image` (optional) url of preview image with same dimensions * `content-warning` (optional) warning about content of NSFW video * `alt` (optional) description for accessibility * `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url @@ -53,19 +92,23 @@ The list of tags are as follows: ["d", ""], ["title", ""], - ["thumb", "<thumbnail image for video>"], ["published_at", "<unix timestamp>"], ["alt", <description>], // Video Data - ["url",<string with URI of file>], - ["m", <MIME type>], - ["x",<Hash SHA-256>], - ["size", <size of file in bytes>], + ["imeta", + "dim 1920x1080", + "url https://myvideo.com/1080/12345.mp4", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", + "m video/mp4", + "image https://myvideo.com/1080/12345.jpg", + "image https://myotherserver.com/1080/12345.jpg", + "fallback https://myotherserver.com/1080/12345.mp4", + "fallback https://andanotherserver.com/1080/12345.mp4", + "service nip96", + ], + ["duration", <duration of video in seconds>], - ["dim", <size of file in pixels>], - ["magnet",<magnet URI> ], - ["i",<torrent infohash>], ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], ["content-warning", "<reason>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], @@ -83,36 +126,4 @@ The list of tags are as follows: ["r", "<url>"] ] } -``` - -## Video View - -A video event view is a response to a video event to track a user's view or progress viewing the video. - -### Format - -The format uses a parameterized replaceable event kind `34237`. - -The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. - -The list of tags are as follows: -* `a` (required) reference tag to kind `34235` or `34236` video event being viewed -* `d` (required) same as `a` reference tag value -* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds - - -```json -{ - "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, - "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": <Unix timestamp in seconds>, - "kind": 34237, - "content": "<note>", - "tags": [ - ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], - ["e", "<event-id", "<relay-url>"] - ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"], - ["viewed", <start>, <end>], - ] -} -``` +``` \ No newline at end of file diff --git a/94.md b/94.md index e35dfa1..eb22393 100644 --- a/94.md +++ b/94.md @@ -26,6 +26,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `summary` (optional) text excerpt * `alt` (optional) description for accessibility * `fallback` (optional) zero or more fallback file sources in case `url` fails +* `service` (optional) service type which is serving the file (eg. [NIP-96](96.md)) ```json { @@ -33,15 +34,15 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr "tags": [ ["url",<string with URI of file>], ["m", <MIME type>], - ["x",<Hash SHA-256>], - ["ox",<Hash SHA-256>], + ["x", <Hash SHA-256>], + ["ox", <Hash SHA-256>], ["size", <size of file in bytes>], ["dim", <size of file in pixels>], - ["magnet",<magnet URI> ], - ["i",<torrent infohash>], + ["magnet", <magnet URI> ], + ["i", <torrent infohash>], ["blurhash", <value>], - ["thumb", <string with thumbnail URI>], - ["image", <string with preview URI>], + ["thumb", <string with thumbnail URI>, <Hash SHA-256>], + ["image", <string with preview URI>, <Hash SHA-256>], ["summary", <excerpt>], ["alt", <description>] ], From 32b9f3f40f2b7842fbcad08a041d9a2205b23de8 Mon Sep 17 00:00:00 2001 From: Roland Bewick <roland.bewick@gmail.com> Date: Fri, 21 Jun 2024 17:22:32 +0700 Subject: [PATCH 02/95] feat: NIP-47 notifications --- 47.md | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 116 insertions(+), 12 deletions(-) diff --git a/47.md b/47.md index 9033847..97b06ab 100644 --- a/47.md +++ b/47.md @@ -8,32 +8,42 @@ Nostr Wallet Connect ## Rationale -This NIP describes a way for clients to access a remote Lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol. +This NIP describes a way for clients to access a remote lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol. ## Terms -* **client**: Nostr app on any platform that wants to pay Lightning invoices. -* **user**: The person using the **client**, and want's to connect their wallet app to their **client**. +* **client**: Nostr app on any platform that wants to interact with a lightning wallet. +* **user**: The person using the **client**, and wants to connect their wallet to their **client**. * **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. ## Theory of Operation - 1. **Users** who wish to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. + 1. **Users** who wish to use this NIP to allow **client(s)** to interact with their wallet must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. - 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. + 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** (or the **client** on the user's behalf) wants to interact with the wallet. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. 3. When the **user** initiates a payment their nostr **client** create a `pay_invoice` request, encrypts it using a token from the URI, and sends it (kind 23194) to the relay(s) specified in the connection URI. The **wallet service** will be listening on those relays and will decrypt the request and then contact the **user's** wallet application to send the payment. The **wallet service** will know how to talk to the wallet application because the connection URI specified relay(s) that have access to the wallet app API. - 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. + 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. + + 5. The **wallet service** may send encrypted notifications (kind 23196) of wallet events (such as a received payment) to the **client**. ## Events -There are three event kinds: +There are four event kinds: - `NIP-47 info event`: 13194 - `NIP-47 request`: 23194 - `NIP-47 response`: 23195 +- `NIP-47 notification event`: 23196 -The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be -a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. +### Info Event + +The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which capabilities it supports. + +The content should be a plaintext string with the supported capabilities space-separated, eg. `pay_invoice get_balance notifications`. + +If the **wallet service** supports notifications, the info event SHOULD contain a `notifications` tag with the supported notification types space-separated, eg. `payment_received payment_sent`. + +### Request and Response Events Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. @@ -68,6 +78,22 @@ The `result_type` field MUST contain the name of the method that this event is r The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful. If the command was successful, the `error` field must be null. +### Notification Events + +The notification event SHOULD contain one `p` tag, the public key of the **user**. + +The content of notifications is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: + +```jsonc +{ + "notification_type": "payment_received", //indicates the structure of the notification field + "notification": { + "payment_hash": "0123456789abcdef..." // notification-related data + } +} +``` + + ### Error codes - `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. - `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented. @@ -120,7 +146,8 @@ Response: { "result_type": "pay_invoice", "result": { - "preimage": "0123456789abcdef..." // preimage of the payment + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -155,7 +182,8 @@ payment hash of the invoice should be used. { "result_type": "multi_pay_invoice", "result": { - "preimage": "0123456789abcdef..." // preimage of the payment + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -189,6 +217,7 @@ Response: "result_type": "pay_keysend", "result": { "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -225,7 +254,8 @@ pubkey should be used. { "result_type": "multi_pay_keysend", "result": { - "preimage": "0123456789abcdef..." // preimage of the payment + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -396,6 +426,59 @@ Response: "block_height": 1, "block_hash": "hex string", "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection + "notifications": ["payment_received", "payment_sent"], // list of supported notifications for this connection, optional. + } +} +``` + +## Notifications + +### `payment_received` + +Description: A payment was successfully received by the wallet. + +Notification: +```jsonc +{ + "notification_type": "payment_received", + "notification": { + "type": "incoming", + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +### `payment_sent` + +Description: A payment was successfully sent by the wallet. + +Notification: +```jsonc +{ + "notification_type": "payment_sent", + "notification": { + "type": "outgoing", + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. } } ``` @@ -409,3 +492,24 @@ Response: ## Using a dedicated relay This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. + +## Appendix + +### Example NIP-47 info event + +```jsonc +{ + "id": "df467db0a9f9ec77ffe6f561811714ccaa2e26051c20f58f33c3d66d6c2b4d1c", + "pubkey": "c04ccd5c82fc1ea3499b9c6a5c0a7ab627fbe00a0116110d4c750faeaecba1e2", + "created_at": 1713883677, + "kind": 13194, + "tags": [ + [ + "notifications", + "payment_received payment_sent" + ] + ], + "content": "pay_invoice pay_keysend get_balance get_info make_invoice lookup_invoice list_transactions multi_pay_invoice multi_pay_keysend sign_message notifications", + "sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8" +} +``` From 70f1be5866a69768e4cc63447e2268a15e70ad3f Mon Sep 17 00:00:00 2001 From: abhay-raizada <toabhayraizada@gmail.com> Date: Tue, 25 Jun 2024 14:08:23 +0530 Subject: [PATCH 03/95] Polls On Nostr --- 118.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 118.md diff --git a/118.md b/118.md new file mode 100644 index 0000000..86201c6 --- /dev/null +++ b/118.md @@ -0,0 +1,36 @@ +# NIP-118 + +## Polls + +`draft` `optional` + +The purpose of this nip is to create a mechanism for polling on nostr. +The NIP aims to have the following properties. + +1. Provide a method for gauging eligibility. Only eligible votes should be counted. +2. Provide a method for maintaining anonymity. Participants should be able to not reveal their identities to everyone, yet their votes should be counted. +3. Provide a mechanism for verifiability. Participants should be able to verify that their votes have been counted, under an eligibility criteria. + +## Events + +### Poll Content + +The poll event is defined as a `kind:1068` event. This event carries over the `name` , `description` and `field` tags as defined in [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files). +This event has no other tags and completely defines the poll content, which is uneditable. + +### Responses + +The response event is the same as the one on [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files) + +### Eligibilty + +Eligibility to a vote is determined by another `kind:30180` event that can be created by anyone and is essentially a reference to a list of pubkeys, the author of the eligibility event is interested in. The eligibility event MUST contain an "e" tag to the poll event, and +"list" tags which references either a `kind:3` (contact list) or a `kind:30000`(follow sets) containing a list of "p" tags. + +### Counting Results. + +Results can be counted for different eligibility events, by querying for `kind:1069` events only authored by the pubkeys mentioned in the eligibility event. + +### Anonymous Voting + +For people that wish to maintain anonymity, while still having their votes counted can do so by signing the response event with a random private key and sending over the corresponding pubkey to the author of a `kind:30180` eligibility event. The author of the eligibility event may demand "proofs of eligibility" before adding the pubkey in any of the lists. From f57d559dc08bf4b59ddefe9416f7569f751f75dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 27 Jun 2024 11:31:34 -0300 Subject: [PATCH 04/95] Proposal of a very simple spec for p2p events --- xx.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 xx.md diff --git a/xx.md b/xx.md new file mode 100644 index 0000000..2ab8fc4 --- /dev/null +++ b/xx.md @@ -0,0 +1,77 @@ +# NIP-XX + +## Peer-to-peer messages + +`draft` `optional` + +## Abstract + +Peer-to-peer (P2P) platforms have seen an upturn in recent years, while having more and more options is positive, in the specific case of p2p, having several options contributes to the liquidity split, meaning sometimes there's not enough assets available for trading. If we combine all these individual solutions into one big pool of orders, it will make them much more competitive compared to centralized systems, where a single authority controls the liquidity. + +This NIP defines a simple standard for peer-to-peer messages, which enables the creation of a big liquidity pool for all p2p platforms participating. + +## The event + +Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: + +```json +[ + "EVENT", + "RAND", + { + "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", + "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", + "created_at": 1702548701, + "kind": 38383, + "tags": [ + ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], + ["k", "sell"], + ["f", "VES"], + ["s", "pending"], + ["amt", "0"], + ["fa", "100"], + ["pm", "face to face"], + ["premium", "1"], + [ + "rating", + "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" + ], + ["network", "lightning"], + ["expiration", "1719391096"], + ["y", "mostrop2p"], + ["z", "order"] + ], + "content": "", + "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" + } +] +``` + +## Tags + +- `d` Order ID: A unique identifier for the order. +- `k` Order type: `sell` or `buy`. +- `f` Currency: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. +- `s` Status: `pending`, `canceled`, `in-progress`, `success`. +- `amt` Amount: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. +- `fa` Fiat amount: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. +- `pm` Payment method: The payment method used for the trade. +- `premium` Premium: The percentage of the premium the maker is willing to pay. +- `rating` Rating: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. +- `n` Network: The network used for the trade, it can be `lightning`, `liquid`, `onchain`, etc. +- `expiration` Expiration: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). +- `y` Platform: The platform that created the order. +- `z` Order type: `order`. + +## Implementations + +Currently implemented on the following platforms: + +- [Mostro](https://github.com/MostroP2P/mostro) +- [@lnp2pBot](https://github.com/lnp2pBot/bot) + +## References + +- [Mostro messages specification](https://mostro.network/messages/) +- [Messages specification for peer 2 peer NIP proposal](https://github.com/nostr-protocol/nips/blob/8250274a22f4882f621510df0054fd6167c10c9e/31001.md) +- [n3xB](https://github.com/nobu-maeda/n3xb) From df977f3874a98783633968ddd9e783b81e3c0ec1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 27 Jun 2024 11:40:56 -0300 Subject: [PATCH 05/95] Add source tag --- xx.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/xx.md b/xx.md index 2ab8fc4..16a0893 100644 --- a/xx.md +++ b/xx.md @@ -36,9 +36,10 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ "rating", "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" ], + ["source", "https://t.me/p2plightning/xxxxxxx"], ["network", "lightning"], ["expiration", "1719391096"], - ["y", "mostrop2p"], + ["y", "lnp2pbot"], ["z", "order"] ], "content": "", @@ -57,6 +58,7 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ - `fa` Fiat amount: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. - `pm` Payment method: The payment method used for the trade. - `premium` Premium: The percentage of the premium the maker is willing to pay. +- `source` Source: The source of the order, it can be a URL that redirects to the order. - `rating` Rating: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. - `n` Network: The network used for the trade, it can be `lightning`, `liquid`, `onchain`, etc. - `expiration` Expiration: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). From d546936073db03e2187e3a0d1eb68e563d82201a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 4 Jul 2024 12:07:59 -0300 Subject: [PATCH 06/95] Add more optional tags and small fixes --- xx.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/xx.md b/xx.md index 16a0893..0543e68 100644 --- a/xx.md +++ b/xx.md @@ -1,6 +1,6 @@ # NIP-XX -## Peer-to-peer messages +## Peer-to-peer Order events `draft` `optional` @@ -8,7 +8,7 @@ Peer-to-peer (P2P) platforms have seen an upturn in recent years, while having more and more options is positive, in the specific case of p2p, having several options contributes to the liquidity split, meaning sometimes there's not enough assets available for trading. If we combine all these individual solutions into one big pool of orders, it will make them much more competitive compared to centralized systems, where a single authority controls the liquidity. -This NIP defines a simple standard for peer-to-peer messages, which enables the creation of a big liquidity pool for all p2p platforms participating. +This NIP defines a simple standard for peer-to-peer order events, which enables the creation of a big liquidity pool for all p2p platforms participating. ## The event @@ -30,14 +30,18 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ ["s", "pending"], ["amt", "0"], ["fa", "100"], - ["pm", "face to face"], + ["pm", "face to face", "bank transfer"], ["premium", "1"], [ "rating", "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" ], ["source", "https://t.me/p2plightning/xxxxxxx"], - ["network", "lightning"], + ["network", "mainnet"], + ["layer", "lightning"], + ["name", "Nakamoto"], + ["g", "<geohash>"], + ["bond", "0"], ["expiration", "1719391096"], ["y", "lnp2pbot"], ["z", "order"] @@ -50,20 +54,26 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ ## Tags -- `d` Order ID: A unique identifier for the order. -- `k` Order type: `sell` or `buy`. -- `f` Currency: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. -- `s` Status: `pending`, `canceled`, `in-progress`, `success`. -- `amt` Amount: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. -- `fa` Fiat amount: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. -- `pm` Payment method: The payment method used for the trade. -- `premium` Premium: The percentage of the premium the maker is willing to pay. -- `source` Source: The source of the order, it can be a URL that redirects to the order. -- `rating` Rating: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. -- `n` Network: The network used for the trade, it can be `lightning`, `liquid`, `onchain`, etc. -- `expiration` Expiration: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). -- `y` Platform: The platform that created the order. -- `z` Order type: `order`. +- `d` < Order ID >: A unique identifier for the order. +- `k` < Order type >: `sell` or `buy`. +- `f` < Currency >: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. +- `s` < Status >: `pending`, `canceled`, `in-progress`, `success`. +- `amt` < Amount >: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. +- `fa` < Fiat amount >: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. +- `pm` < Payment method >: The payment method used for the trade, if the order has multiple payment methods, they should be separated by a comma. +- `premium` < Premium >: The percentage of the premium the maker is willing to pay. +- `source` [Source]: The source of the order, it can be a URL that redirects to the order. +- `rating` [Rating]: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. +- `network` < Network >: The network used for the trade, it can be `mainnet`, `testnet`, `signet`, etc. +- `layer` < Layer >: The layer used for the trade, it can be `onchain`, `lightning`, `liquid`, etc. +- `name` [Name]: The name of the maker. +- `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. +- `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. +- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). +- `y` < Platform >: The platform that created the order. +- `z` < Document >: `order`. + +Mandatory tags are enclosed with `<tag>`, optional tags are enclosed with `[tag]`. ## Implementations From 21587e236785616b6c0ca796c03a29a3ad5e69ea Mon Sep 17 00:00:00 2001 From: abhay-raizada <toabhayraizada@gmail.com> Date: Fri, 5 Jul 2024 08:07:13 +0530 Subject: [PATCH 07/95] Finalize Draft --- 118.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 68 insertions(+), 15 deletions(-) diff --git a/118.md b/118.md index 86201c6..15bc730 100644 --- a/118.md +++ b/118.md @@ -4,33 +4,86 @@ `draft` `optional` -The purpose of this nip is to create a mechanism for polling on nostr. -The NIP aims to have the following properties. +This NIP defines the event scheme that describe Polls on nostr. -1. Provide a method for gauging eligibility. Only eligible votes should be counted. -2. Provide a method for maintaining anonymity. Participants should be able to not reveal their identities to everyone, yet their votes should be counted. -3. Provide a mechanism for verifiability. Participants should be able to verify that their votes have been counted, under an eligibility criteria. +The NIP makes the following tradeoffs. + +1. All votes are public. +2. All responses are editable (latest by timestamp considered last response) ## Events ### Poll Content -The poll event is defined as a `kind:1068` event. This event carries over the `name` , `description` and `field` tags as defined in [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files). -This event has no other tags and completely defines the poll content, which is uneditable. +The poll event is defined as a `kind:1068` event. Major tags in the poll event are: + +- **label**: The accompanying text of the poll. +- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. +- **relays**: Set of relays that the poll is expecting respondents to respond on. +- **settings**: A JSON stringified object that may hold poll level configs and client specific configs. + +Example Event + +```json +{ + "content": "", + "created_at": 1719888496, + "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", + "kind": 1068, + "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", + "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", + "tags": [ + ["label", "Pineapple on Pizza"], + ["option", "qj518h583", "Yay"], + ["option", "gga6cdnqj", "Nay"], + ["relays", "<relay1 url>", "<relay 2 url>"], + ["settings", "{\"PollType\": \"singlechoice\" }"] + ] +} +``` ### Responses -The response event is the same as the one on [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files) +The response event is a `kind:1018` event. It contains an e tag referencing the poll event it is referencing, followed by one or more response tags. -### Eligibilty +- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. -Eligibility to a vote is determined by another `kind:30180` event that can be created by anyone and is essentially a reference to a list of pubkeys, the author of the eligibility event is interested in. The eligibility event MUST contain an "e" tag to the poll event, and -"list" tags which references either a `kind:3` (contact list) or a `kind:30000`(follow sets) containing a list of "p" tags. +Example Response Event -### Counting Results. +```json +{ + "content": "", + "created_at": 1720097117, + "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", + "kind": 1018, + "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", + "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", + "tags": [ + ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["response", "gga6cdnqj"] + ] +} +``` -Results can be counted for different eligibility events, by querying for `kind:1069` events only authored by the pubkeys mentioned in the eligibility event. +### Poll Types -### Anonymous Voting +Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:1018` event. -For people that wish to maintain anonymity, while still having their votes counted can do so by signing the response event with a random private key and sending over the corresponding pubkey to the author of a `kind:30180` eligibility event. The author of the eligibility event may demand "proofs of eligibility" before adding the pubkey in any of the lists. +- **PollType: singlechoice**: The first response tag is to be considered the actual response. +- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order. +- **PollType: rankedchoice**: The first response tag pointing to each id is the considered the actual response, while also taking into account the order of the response tags. + +### Counting Results + +Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +The results displayed should only be 1 vote per pubkey. +In case of multiple events for a pubkey, the event with the largest timestamp should be considered. + +### Curation + +The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. + +### Private Polls + +This nip does not cover private polling, Clients may follow [forms nip](https://github.com/nostr-protocol/nips/pull/1190) for private polling. From c258875395bfdc22c4e74669c5a7b0bde567a9d4 Mon Sep 17 00:00:00 2001 From: Abhay Raizada <toabhayraizada@gmail.com> Date: Tue, 16 Jul 2024 23:03:02 +0530 Subject: [PATCH 08/95] Remove settings, fine tuning --- 118.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/118.md b/118.md index 15bc730..b22b006 100644 --- a/118.md +++ b/118.md @@ -9,18 +9,23 @@ This NIP defines the event scheme that describe Polls on nostr. The NIP makes the following tradeoffs. 1. All votes are public. -2. All responses are editable (latest by timestamp considered last response) +2. All votes are editable (latest response by timestamp considered last vote) ## Events -### Poll Content +### Poll Event + +The poll event is defined as a `kind:1068` event. + +- **content** key holds the label for the poll. + +Major tags in the poll event are: -The poll event is defined as a `kind:1068` event. Major tags in the poll event are: -- **label**: The accompanying text of the poll. - **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. -- **relays**: Set of relays that the poll is expecting respondents to respond on. -- **settings**: A JSON stringified object that may hold poll level configs and client specific configs. +- **relay**: One or multiple tags that the poll is expecting respondents to respond on. +- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. + Example Event @@ -36,15 +41,16 @@ Example Event ["label", "Pineapple on Pizza"], ["option", "qj518h583", "Yay"], ["option", "gga6cdnqj", "Nay"], - ["relays", "<relay1 url>", "<relay 2 url>"], - ["settings", "{\"PollType\": \"singlechoice\" }"] + ["relay","<relay url1>"], + ["relay", "<relay url2>"], + ["polltype", "singlechoice"] ] } ``` ### Responses -The response event is a `kind:1018` event. It contains an e tag referencing the poll event it is referencing, followed by one or more response tags. +The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. - **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. @@ -60,7 +66,8 @@ Example Response Event "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", "tags": [ ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], - ["response", "gga6cdnqj"] + ["response", "gga6cdnqj"], + ["response", "m3agjsdq1"] ] } ``` @@ -70,20 +77,16 @@ Example Response Event Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:1018` event. - **PollType: singlechoice**: The first response tag is to be considered the actual response. -- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order. +- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. - **PollType: rankedchoice**: The first response tag pointing to each id is the considered the actual response, while also taking into account the order of the response tags. ### Counting Results Results can be queried by fetching `kind:1018` events from the relays specified in the poll. -The results displayed should only be 1 vote per pubkey. +The results displayed should only be 1 vote event per pubkey. In case of multiple events for a pubkey, the event with the largest timestamp should be considered. ### Curation The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. -Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. - -### Private Polls - -This nip does not cover private polling, Clients may follow [forms nip](https://github.com/nostr-protocol/nips/pull/1190) for private polling. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. \ No newline at end of file From 1002104ece1fe3de7a091084d97e031c7291c9c0 Mon Sep 17 00:00:00 2001 From: Paul Miller <paul@paulmillr.com> Date: Sun, 1 Sep 2024 00:44:30 +0200 Subject: [PATCH 09/95] nip44: clarify ecdh hashing --- 44.md | 1 + 1 file changed, 1 insertion(+) diff --git a/44.md b/44.md index f3071ea..339d300 100644 --- a/44.md +++ b/44.md @@ -142,6 +142,7 @@ validation rules, refer to BIP-340. The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. + Some libraries, like libsecp256k1, apply sha256 on the output. The hashing is unnecessary in NIP44. - Operators - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. From be17e5dcd9943c1d4854eccd5714241d4fe246e1 Mon Sep 17 00:00:00 2001 From: Paul Miller <paul@paulmillr.com> Date: Sun, 1 Sep 2024 16:13:12 +0200 Subject: [PATCH 10/95] Clarify function name in libsecp256k1 --- 44.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/44.md b/44.md index 339d300..ccd1f50 100644 --- a/44.md +++ b/44.md @@ -142,7 +142,8 @@ validation rules, refer to BIP-340. The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. - Some libraries, like libsecp256k1, apply sha256 on the output. The hashing is unnecessary in NIP44. + NIP44 doesn't do hashing of the output: keep this in mind, because some libraries hash it using sha256. + As an example, in libsecp256k1, unhashed version is available in `secp256k1_ec_pubkey_tweak_mul` - Operators - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. From d9eb17ce86e1f11d0919f192ed61ab23045cfc03 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 3 Sep 2024 01:16:36 +0900 Subject: [PATCH 11/95] NIP-65: add links to outbox model articles --- 65.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/65.md b/65.md index f32c965..c3efa1d 100644 --- a/65.md +++ b/65.md @@ -62,3 +62,7 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. 6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). + +## Related articles +- [Outbox model](https://mikedilger.com/gossip-model/) +- [What is the Outbox Model?](https://habla.news/u/hodlbod@coracle.social/8YjqXm4SKY-TauwjOfLXS) From 378dfaa5dbf44bd1f17fd70f8727b636b7c99239 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 3 Sep 2024 14:07:46 -0300 Subject: [PATCH 12/95] nip54: remove markdown leftovers. --- 54.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/54.md b/54.md index cf22544..39528cf 100644 --- a/54.md +++ b/54.md @@ -6,7 +6,7 @@ Wiki `draft` `optional` -This NIP defines `kind:30818` (an _addressable event_) for long-form text content similar to [NIP-23](23.md), but with one important difference: articles are meant to be descriptions, or encyclopedia entries, of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. +This NIP defines `kind:30818` (an _addressable event_) for descriptions (or encyclopedia entries) of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. Articles are identified by lowercase, normalized ascii `d` tags. @@ -26,21 +26,25 @@ Articles are identified by lowercase, normalized ascii `d` tags. - Any non-letter character MUST be converted to a `-`. - All letters MUST be converted to lowercase. -### Content rules +### Content -The content should be Asciidoc, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: +The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links. - - `title`: for when the display title should be different from the `d` tag. - - `summary`: for display in lists. - - `a` and `e`: for referencing the original event a wiki article was forked from. - -One extra functionality is added: **wikilinks**. Unlike normal Asciidoc links `[]()` that link to webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink. +Unlike normal Asciidoc links `http://example.com[]` that link to external webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink. Wikilinks can take these two forms: 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`; 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. +`nostr:...` links, as per [NIP-21](21.md), should link to profiles or arbitrary Nostr events. Although it is not recommended to link to specific versions of articles -- instead the _wikilink_ syntax should be preferred, since it should be left to the reader and their client to decide what version of any given article they want to read. + +### Optional extra tags + + - `title`: for when the display title should be different from the `d` tag. + - `summary`: for display in lists. + - `a` and `e`: for referencing the original event a wiki article was forked from. + ### Merge Requests Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event. From e6552476aa2e5ca7256be572a9aa226ec8a022ee Mon Sep 17 00:00:00 2001 From: kehiy <kehiiiiya@gmail.com> Date: Tue, 3 Sep 2024 20:41:31 +0330 Subject: [PATCH 13/95] format(all): json formatting --- 02.md | 4 ++-- 05.md | 4 ++-- 09.md | 4 ++-- 11.md | 26 +++++++++++++++----------- 15.md | 19 ++++++++++--------- 17.md | 10 +++++----- 25.md | 8 ++++---- 28.md | 26 +++++++++++++------------- 29.md | 28 ++++++++++++++-------------- 32.md | 26 +++++++++++++------------- 34.md | 7 ++++--- 35.md | 2 +- 38.md | 4 +++- 39.md | 5 +++-- 42.md | 8 ++++---- 46.md | 2 +- 47.md | 10 ++++------ 50.md | 4 ++-- 51.md | 2 +- 53.md | 10 +++++----- 54.md | 8 ++++---- 56.md | 12 ++++++++---- 57.md | 2 +- 58.md | 12 ++++++------ 59.md | 4 ++-- 64.md | 12 ++++++------ 65.md | 4 ++-- 71.md | 2 +- 72.md | 6 +++--- 75.md | 20 ++++++++++---------- 84.md | 4 ++-- 89.md | 22 ++++++++++++---------- 90.md | 26 +++++++++++++------------- 94.md | 4 ++-- 96.md | 51 +++++++++++++++++++++++++-------------------------- 99.md | 2 +- 36 files changed, 206 insertions(+), 194 deletions(-) diff --git a/02.md b/02.md index 4029b22..8354bf0 100644 --- a/02.md +++ b/02.md @@ -14,7 +14,7 @@ The `.content` is not used. For example: -```json +```jsonc { "kind": 3, "tags": [ @@ -23,7 +23,7 @@ For example: ["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"] ], "content": "", - ...other fields + // other fields... } ``` diff --git a/05.md b/05.md index eeca551..ca6da7b 100644 --- a/05.md +++ b/05.md @@ -16,12 +16,12 @@ The result should be a JSON document object with a key `"names"` that should the If a client sees an event like this: -```json +```jsonc { "pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9", "kind": 0, "content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}" - ... + // other fields... } ``` diff --git a/09.md b/09.md index b1a28ac..23ffeab 100644 --- a/09.md +++ b/09.md @@ -12,7 +12,7 @@ The event's `content` field MAY contain a text note describing the reason for th For example: -``` +```jsonc { "kind": 5, "pubkey": <32-bytes hex-encoded public key of the event creator>, @@ -24,7 +24,7 @@ For example: ["k", "30023"] ], "content": "these posts were published by accident", - ...other fields + // other fields... } ``` diff --git a/11.md b/11.md index 21c61e4..0ca5870 100644 --- a/11.md +++ b/11.md @@ -66,7 +66,7 @@ These are limitations imposed by the relay on clients. Your client should expect that requests which exceed these *practical* limitations are rejected or fail immediately. -```json +```jsonc { "limitation": { "max_message_length": 16384, @@ -83,7 +83,7 @@ are rejected or fail immediately. "created_at_lower_limit": 31536000, "created_at_upper_limit": 3 }, - ... + // other fields... } ``` @@ -146,14 +146,15 @@ Retention times are given in seconds, with `null` indicating infinity. If zero is provided, this means the event will not be stored at all, and preferably an error will be provided when those are received. -```json +```jsonc { "retention": [ {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600}, {"kinds": [[40000, 49999]], "time": 100}, {"kinds": [[30000, 39999]], "count": 1000}, {"time": 3600, "count": 10000} - ] + ], + // other fields... } ``` @@ -186,10 +187,10 @@ Users should be able to avoid relays in countries they don't like, and/or select relays in more favorable zones. Exposing this flexibility is up to the client software. -```json +```jsonc { "relay_countries": [ "CA", "US" ], - ... + // other fields... } ``` @@ -208,12 +209,12 @@ local community. This would encourage users to follow the global feed on that relay, in addition to their usual individual follows. To support this goal, relays MAY specify some of the following values. -```json +```jsonc { "language_tags": ["en", "en-419"], "tags": ["sfw-only", "bitcoin-only", "anime"], "posting_policy": "https://example.com/posting-policy.html", - ... + // other fields... } ``` @@ -260,10 +261,10 @@ Relays that require payments may want to expose their fee schedules. A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. -```json +```jsonc { "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", - ... + // other fields... } ``` @@ -271,9 +272,11 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b As of 2 May 2023 the following command provided these results: +```bash +$ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq ``` -~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq +```json { "description": "nostr.land family of relays (us-or-01)", "name": "nostr.land", @@ -312,3 +315,4 @@ As of 2 May 2023 the following command provided these results: ] }, } +``` diff --git a/15.md b/15.md index 2a4e2c2..b55b444 100644 --- a/15.md +++ b/15.md @@ -73,10 +73,10 @@ Fields that are not self-explanatory: **Event Tags** -```json +```jsonc { "tags": [["d", <string, id of stall]], - ... + // other fields... } ``` - the `d` tag is required, its value MUST be the same as the stall `id`. @@ -124,12 +124,12 @@ Fields that are not self-explanatory: **Event Tags** -```json +```jsonc "tags": [ ["d", <string, id of product], ["t", <string (optional), product category], ["t", <string (optional), product category], - ... + // other fields... ], ... ``` @@ -158,7 +158,7 @@ The below JSON goes in content of [NIP-04](04.md). "type": 0, "name": <string (optional), ???>, "address": <string (optional), for physical goods an address should be provided>, - "message": "<string (optional), message for merchant>, + "message": <string (optional), message for merchant>, "contact": { "nostr": <32-bytes hex of a pubkey>, "phone": <string (optional), if the customer wants to be contacted by phone>, @@ -237,7 +237,7 @@ Create a customized user experience using the `naddr` from [NIP-19](19.md#sharea **Event Content** -```json +```jsonc { "name": <string (optional), market name>, "about": <string (optional), market description>, @@ -248,7 +248,7 @@ Create a customized user experience using the `naddr` from [NIP-19](19.md#sharea "darkMode": <bool, true/false> }, "merchants": [array of pubkeys (optional)], - ... + // other fields... } ``` @@ -290,10 +290,11 @@ This event leverages naddr to enable comprehensive customization and sharing of ### Event `1021`: Bid -```json +```jsonc { "content": <int, amount of sats>, "tags": [["e", <event ID of the auction to bid on>]], + // other fields... } ``` @@ -335,4 +336,4 @@ Customer support is handled over whatever communication method was specified. If ## Additional -Standard data models can be found <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a> +Standard data models can be found [here](https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py) diff --git a/17.md b/17.md index d22dbde..4b96bce 100644 --- a/17.md +++ b/17.md @@ -12,18 +12,18 @@ This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encr Kind `14` is a chat message. `p` tags identify one or more receivers of the message. -```js +```jsonc { "id": "<usual hash>",   "pubkey": "<sender-pubkey>", - "created_at": now(), + "created_at": "<current-time>",   "kind": 14,   "tags": [     ["p", "<receiver-1-pubkey>", "<relay-url>"],     ["p", "<receiver-2-pubkey>", "<relay-url>"],     ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply ["subject", "<conversation-title>"], -    ... +    // rest of tags...   ],   "content": "<message-in-plain-text>", } @@ -86,7 +86,7 @@ Clients CAN offer disappearing messages by setting an `expiration` tag in the gi Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. -```js +```jsonc { "kind": 10050, "tags": [ @@ -94,7 +94,7 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS ["relay", "wss://myrelay.nostr1.com"], ], "content": "", - //...other fields + // other fields... } ``` diff --git a/25.md b/25.md index f038603..671c55f 100644 --- a/25.md +++ b/25.md @@ -57,14 +57,14 @@ Reactions to a website If the target of the reaction is a website, the reaction MUST be a `kind 17` event and MUST include an `r` tag with the website's URL. -```json +```jsonc { "kind": 17, "content": "⭐", "tags": [ ["r", "https://example.com/"] ], - ...other fields + // other fields... } ``` @@ -79,14 +79,14 @@ The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the reaction content. The client should refer to the emoji tag and render the content as an emoji if shortcode is specified. -```json +```jsonc { "kind": 7, "content": ":soapbox:", "tags": [ ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] ], - ...other fields + // other fields... } ``` diff --git a/28.md b/28.md index 1632088..73c76b2 100644 --- a/28.md +++ b/28.md @@ -25,10 +25,10 @@ Create a public chat channel. In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41). -```json +```jsonc { "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", - ... + // other fields... } ``` @@ -52,11 +52,11 @@ Clients MAY add additional metadata fields. Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. -```json +```jsonc { "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", "tags": [["e", <channel_create_event_id>, <relay-url>]], - ... + // other fields... } ``` @@ -71,26 +71,26 @@ Clients SHOULD append [NIP-10](10.md) "p" tags to replies. Root message: -```json +```jsonc { "content": <string>, "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]], - ... + // other fields... } ``` Reply to another message: -```json +```jsonc { "content": <string>, "tags": [ ["e", <kind_40_event_id>, <relay-url>, "root"], ["e", <kind_42_event_id>, <relay-url>, "reply"], ["p", <pubkey>, <relay-url>], - ... + // rest of tags... ], - ... + // other fields... } ``` @@ -107,11 +107,11 @@ Clients MAY hide event 42s for other users other than the user who sent the even (For example, if three users 'hide' an event giving a reason that includes the word 'pornography', a Nostr client that is an iOS app may choose to hide that message for all iOS clients.) -```json +```jsonc { "content": "{\"reason\": \"Dick pic\"}", "tags": [["e", <kind_42_event_id>]], - ... + // other fields... } ``` @@ -125,11 +125,11 @@ Clients SHOULD hide event 42s shown to a given user, if there is an event 44 fro Clients MAY hide event 42s for users other than the user who sent the event 44. -```json +```jsonc { "content": "{\"reason\": \"Posting dick pics\"}", "tags": [["p", <pubkey>]], - ... + // other fields... } ``` diff --git a/29.md b/29.md index f867268..6232f8b 100644 --- a/29.md +++ b/29.md @@ -42,14 +42,14 @@ Relays should prevent late publication (messages published now with a timestamp This is the basic unit of a "microblog" root text note sent to a group. -```js +```jsonc "kind": 11, "content": "hello my friends lovers of pizza", "tags": [ ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] ] - ... + // other fields... ``` - *threaded text reply* (`kind:12`) @@ -63,14 +63,14 @@ This is the basic unit of a "microblog" reply note sent to a group. It's the sam This is the basic unit of a _chat message_ sent to a group. -```js +```jsonc "kind": 9, "content": "hello my friends lovers of pizza", "tags": [ ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] ] - ... + // other fields... ``` - *chat message threaded reply* (`kind:10`) @@ -83,7 +83,7 @@ Similar to `kind:12`, this is the basic unit of a chat message sent to a group. Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them. -```js +```json { "kind": 9021, "content": "optional reason", @@ -97,7 +97,7 @@ Any user can send one of these events to the relay in order to be automatically Any user can send one of these events to the relay in order to be automatically removed from the group. The relay will automatically issue a `kind:9001` in response removing this user. -```js +```json { "kind": 9022, "content": "optional reason", @@ -111,13 +111,13 @@ Any user can send one of these events to the relay in order to be automatically Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action. The relay may discard the event after taking action or keep it as a moderation log. -```js +```json { "kind": 90xx, "content": "optional reason", "tags": [ ["h", "<group-id>"], - ["previous", ...] + ["previous", /*...*/] ] } ``` @@ -142,7 +142,7 @@ This event defines the metadata for the group -- basically how clients should di If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. -```js +```jsonc { "kind": 39000, "content": "", @@ -154,7 +154,7 @@ If the group is forked and hosted in multiple relays, there will be multiple ver ["public"], // or ["private"] ["open"] // or ["closed"] ] - ... + // other fields... } ``` @@ -177,7 +177,7 @@ The list of capabilities, as defined by this NIP, for now, is the following: - `edit-group-status` - `delete-group` -```js +```json { "kind": 39001, "content": "list of admins for the pizza lovers group", @@ -186,7 +186,7 @@ The list of capabilities, as defined by this NIP, for now, is the following: ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"], ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"] ] - ... + // other fields... } ``` diff --git a/32.md b/32.md index e06cad5..66f0283 100644 --- a/32.md +++ b/32.md @@ -57,7 +57,7 @@ Example events A suggestion that multiple pubkeys be associated with the `permies` topic. -```json +```jsonc { "kind": 1985, "tags": [ @@ -66,13 +66,13 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. ["p", <pubkey1>, <relay_url>], ["p", <pubkey2>, <relay_url>] ], - ... + // other fields... } ``` A report flagging violence toward a human being as defined by ontology.example.com. -```json +```jsonc { "kind": 1985, "tags": [ @@ -81,13 +81,13 @@ A report flagging violence toward a human being as defined by ontology.example.c ["p", <pubkey1>, <relay_url>], ["p", <pubkey2>, <relay_url>] ], - ... + // other fields... } ``` A moderation suggestion for a chat event. -```json +```jsonc { "kind": 1985, "tags": [ @@ -95,13 +95,13 @@ A moderation suggestion for a chat event. ["l", "approve", "nip28.moderation"], ["e", <kind40_event_id>, <relay_url>] ], - ... + // other fields... } ``` Assignment of a license to an event. -```json +```jsonc { "kind": 1985, "tags": [ @@ -109,14 +109,14 @@ Assignment of a license to an event. ["l", "MIT", "license"], ["e", <event_id>, <relay_url>] ], - ... + // other fields... } ``` Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author is labeling their note as being related to Milan, Italy using ISO 3166-2. -```json +```jsonc { "kind": 1, "tags": [ @@ -124,13 +124,13 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. ["l", "IT-MI", "ISO-3166-2"] ], "content": "It's beautiful here in Milan!", - ... + // other fields... } ``` Author is labeling their note language as English using ISO-639-1. -```json +```jsonc { "kind": 1, "tags": [ @@ -138,7 +138,7 @@ Author is labeling their note language as English using ISO-639-1. ["l", "en", "ISO-639-1"] ], "content": "English text", - ... + // other fields... } ``` @@ -169,7 +169,7 @@ be handled in some other way. Appendix: Known Ontologies -------------------------- +-------------------------- Below is a non-exhaustive list of ontologies currently in widespread use. diff --git a/34.md b/34.md index 69f460b..9363aeb 100644 --- a/34.md +++ b/34.md @@ -106,7 +106,7 @@ The first patch in a series MAY be a cover letter in the format produced by `git Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. -```jsonc +```json { "kind": 1621, "content": "<markdown text>", @@ -132,8 +132,9 @@ Replies are also Markdown text. The difference is that they MUST be issued as re // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10 ["p", "<patch-author-pubkey-hex>", "", "mention"], ["e", "<previous-reply-id-hex>", "", "reply"], - // ... - ] + // rest of tags... + ], + // other fields... } ``` diff --git a/35.md b/35.md index 980bc85..3891f6f 100644 --- a/35.md +++ b/35.md @@ -37,7 +37,7 @@ A second level prefix should be included where the database supports multiple me In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish. -```jsonc +```json { "kind": 2003, "content": "<long-description-pre-formatted>", diff --git a/38.md b/38.md index 684843a..8b22b2a 100644 --- a/38.md +++ b/38.md @@ -17,7 +17,7 @@ A special event with `kind:30315` "User Status" is defined as an *optionally exp For example: -```js +```json { "kind": 30315, "content": "Sign up for nostrasia!", @@ -26,7 +26,9 @@ For example: ["r", "https://nostr.world"] ], } +``` +```json { "kind": 30315, "content": "Intergalatic - Beastie Boys", diff --git a/39.md b/39.md index b7c3b9c..3777ac5 100644 --- a/39.md +++ b/39.md @@ -13,7 +13,8 @@ Nostr protocol users may have other online identities such as usernames, profile ## `i` tag on a metadata event A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): -```json + +```jsonc { "id": <id>, "pubkey": <pubkey>, @@ -23,7 +24,7 @@ A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] ["i", "telegram:1087295469", "nostrdirectory/770"] ], - ... + // other fields... } ``` diff --git a/42.md b/42.md index 8c70de4..fdc5d10 100644 --- a/42.md +++ b/42.md @@ -22,13 +22,13 @@ A relay may want to require clients to authenticate to access restricted resourc This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form: -```json +``` ["AUTH", <challenge-string>] ``` And, when sent by clients, the following form: -```json +``` ["AUTH", <signed-event-json>] ``` @@ -38,14 +38,14 @@ And, when sent by clients, the following form: The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example: -```json +```jsonc { "kind": 22242, "tags": [ ["relay", "wss://relay.example.com/"], ["challenge", "challengestringhere"] ], - ... + // other fields... } ``` diff --git a/46.md b/46.md index 389a3e8..e1675b0 100644 --- a/46.md +++ b/46.md @@ -94,7 +94,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata ## Request Events `kind: 24133` -```json +```jsonc { "id": <id>, "kind": 24133, diff --git a/47.md b/47.md index e4e432c..a19230f 100644 --- a/47.md +++ b/47.md @@ -173,7 +173,7 @@ Request: "amount": 123, // invoice amount in msats, required "pubkey": "03...", // payee pubkey, required "preimage": "0123456789abcdef...", // preimage of the payment, optional - "tlv_records: [ // tlv records, optional + "tlv_records": [ // tlv records, optional { "type": 5482373484, // tlv type "value": "0123456789abcdef" // hex encoded tlv value @@ -208,7 +208,7 @@ Request: "method": "multi_pay_keysend", "params": { "keysends": [ - {"id": "4c5b24a351", pubkey": "03...", "amount": 123}, + {"id": "4c5b24a351", "pubkey": "03...", "amount": 123}, {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]}, ], } @@ -358,8 +358,7 @@ Request: ```jsonc { "method": "get_balance", - "params": { - } + "params": {} } ``` @@ -379,8 +378,7 @@ Request: ```jsonc { "method": "get_info", - "params": { - } + "params": {} } ``` diff --git a/50.md b/50.md index 2a31cb1..9eea1f8 100644 --- a/50.md +++ b/50.md @@ -15,9 +15,9 @@ extensible framework for performing such queries. ## `search` filter field A new `search` field is introduced for `REQ` messages from clients: -```json +```jsonc { - ... + // other fields on filter object... "search": <string> } ``` diff --git a/51.md b/51.md index f7a468e..3792d7f 100644 --- a/51.md +++ b/51.md @@ -111,7 +111,7 @@ Some clients have used these lists in the past, but they should work on transiti ### A _release artifact set_ of an Example App -```json +```jsonc { "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", diff --git a/53.md b/53.md index 15bdbc9..ee12fef 100644 --- a/53.md +++ b/53.md @@ -16,7 +16,7 @@ A special event with `kind:30311` "Live Event" is defined as an _addressable eve For example: -```json +```jsonc { "kind": 30311, "tags": [ @@ -35,10 +35,10 @@ For example: ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"], ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], - ["relays", "wss://one.com", "wss://two.com", ...] + ["relays", "wss://one.com", "wss://two.com", /*...*/] ], "content": "", - ... + // other fields... } ``` @@ -64,14 +64,14 @@ This feature is important to avoid malicious event owners adding large account h Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. -```json +```jsonc { "kind": 1311, "tags": [ ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"], ], "content": "Zaps to live streams is beautiful.", - ... + // other fields... } ``` diff --git a/54.md b/54.md index cf22544..611ec7a 100644 --- a/54.md +++ b/54.md @@ -11,7 +11,7 @@ This NIP defines `kind:30818` (an _addressable event_) for long-form text conten Articles are identified by lowercase, normalized ascii `d` tags. ### Articles -```jsonc +```json { "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", "tags": [ @@ -96,13 +96,13 @@ Asciidoc has a strict spec, multiple implementations in many languages, and supp # Appendix 1: Merge requests Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. -```jsonc +```json { "content": "I added information about how to make hot ice-creams", "kind": 818, "tags": [ [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], - [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], + [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>" ], [ "p", "<destination-pubkey>" ], [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] ] @@ -114,4 +114,4 @@ Users can request other users to get their entries merged into someone else's en `e` tag: optional version of the article in which this modifications is based `e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP. -The destination-pubkey (the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-` +The destination-pubkey is the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-` diff --git a/56.md b/56.md index fc8d898..f7b1b1a 100644 --- a/56.md +++ b/56.md @@ -41,7 +41,7 @@ further qualification and querying. Example events -------------- -```json +```jsonc { "kind": 1984, "tags": [ @@ -50,9 +50,11 @@ Example events ["l", "NS-nud", "social.nos.ontology"] ], "content": "", - ... + // other fields... } +``` +```jsonc { "kind": 1984, "tags": [ @@ -60,16 +62,18 @@ Example events ["p", <pubkey>] ], "content": "He's insulting the king!", - ... + // other fields... } +``` +```jsonc { "kind": 1984, "tags": [ ["p", <impersonator pubkey>, "impersonation"] ], "content": "Profile is impersonating nostr:<victim bech32 pubkey>", - ... + // other fields... } ``` diff --git a/57.md b/57.md index 1c0b314..b533811 100644 --- a/57.md +++ b/57.md @@ -171,7 +171,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). -```js +```jsonc { "tags": [ [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% diff --git a/58.md b/58.md index 438574b..b6324f4 100644 --- a/58.md +++ b/58.md @@ -74,7 +74,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ### Example of a Badge Definition event -```json +```jsonc { "pubkey": "alice", "kind": 30009, @@ -85,13 +85,13 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"] ], - ... + // other fields... } ``` ### Example of Badge Award event -```json +```jsonc { "id": "<badge award event id>", "kind": 8, @@ -101,14 +101,14 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ["p", "bob", "wss://relay"], ["p", "charlie", "wss://relay"] ], - ... + // other fields... } ``` ### Example of a Profile Badges event Honorable Bob The Brave: -```json +```jsonc { "kind": 30008, "pubkey": "bob", @@ -119,6 +119,6 @@ Honorable Bob The Brave: ["a", "30009:alice:honor"], ["e", "<honor badge award event id>", "wss://nostr.academy"] ], - ... + // other fields... } ``` diff --git a/59.md b/59.md index 4dc857f..a4fc99d 100644 --- a/59.md +++ b/59.md @@ -41,7 +41,7 @@ A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for without the receiver's or the sender's private key. The only public information in this event is who is signing it. -```js +```json { "id": "<id>", "pubkey": "<real author's pubkey>", @@ -60,7 +60,7 @@ Tags MUST must always be empty in a `kind:13`. The inner event MUST always be un A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work. -```js +```json { "id": "<id>", "pubkey": "<random, one-time-use pubkey>", diff --git a/64.md b/64.md index 7c2329a..616c5d6 100644 --- a/64.md +++ b/64.md @@ -16,23 +16,23 @@ The `.content` of these notes is a string representing a [PGN-database][pgn_form ### Notes -```json +```jsonc { "kind": 64, "content": "1. e4 *", - ... + // other fields... } ``` -```json +```jsonc { "kind": 64, "tags": [ ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], - ... + // rest of tags... ], - "content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2" - ... + "content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2", + // other fields... } ``` diff --git a/65.md b/65.md index f32c965..71660d4 100644 --- a/65.md +++ b/65.md @@ -12,7 +12,7 @@ The event MUST include a list of `r` tags with relay URIs and a `read` or `write The `.content` is not used. -```json +```jsonc { "kind": 10002, "tags": [ @@ -22,7 +22,7 @@ The `.content` is not used. ["r", "wss://nostr-relay.example.com", "read"] ], "content": "", - ...other fields + // other fields... } ``` diff --git a/71.md b/71.md index 302bbbf..5cf3b36 100644 --- a/71.md +++ b/71.md @@ -42,7 +42,7 @@ The list of tags are as follows: * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `r` (optional, repeated) references / links to web pages -```json +```jsonc { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, diff --git a/72.md b/72.md index b2f523b..582410a 100644 --- a/72.md +++ b/72.md @@ -35,7 +35,7 @@ The goal of this NIP is to enable public communities. It defines the replaceable ["relay", "<relay where to send and receive approvals>", "approvals"], ["relay", "<relay where to post requests to and fetch approvals from>"] ], - ... + // other fields... } ``` @@ -50,7 +50,7 @@ Any Nostr event can be posted to a community. Clients MUST add one or more commu ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"], ], "content": "hello world", - // ... + // other fields... } ``` @@ -75,7 +75,7 @@ Moderators MAY request deletion of their approval of a post at any time using [N ["k", "<post-request-kind>"] ], "content": "<the full approved event, JSON-encoded>", - // ... + // other fields... } ``` diff --git a/75.md b/75.md index a6f2bff..885c391 100644 --- a/75.md +++ b/75.md @@ -21,15 +21,16 @@ The following tags are defined as REQUIRED. Example event: -```json +```jsonc { "kind": 9041, "tags": [ - ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/], ["amount", "210000"], ], "content": "Nostrasia travel expenses", - ... + // other fields... +} ``` The following tags are OPTIONAL. @@ -38,18 +39,18 @@ The following tags are OPTIONAL. - `image` - an image for the goal - `summary` - a brief description -```json +```jsonc { "kind": 9041, "tags": [ - ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/], ["amount", "210000"], ["closed_at", "<unix timestamp in seconds>"], ["image", "<image URL>"], ["summary", "<description of the goal>"], ], "content": "Nostrasia travel expenses", - ... + // other fields... } ``` @@ -59,15 +60,14 @@ The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57. Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. -```json +```jsonc { - ... "kind": 3xxxx, "tags": [ - ... ["goal", "<event id>", "<Relay URL (optional)>"], + // rest of tags... ], - ... + // other fields... } ``` diff --git a/84.md b/84.md index d5f54d4..e3063c2 100644 --- a/84.md +++ b/84.md @@ -26,14 +26,14 @@ useful when highlighting non-nostr content for which the client might be able to (e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the last value of the tag. -```json +```jsonc { "tags": [ ["p", "<pubkey-hex>", "<relay-url>", "author"], ["p", "<pubkey-hex>", "<relay-url>", "author"], ["p", "<pubkey-hex>", "<relay-url>", "editor"] ], - ... + // other fields... } ``` diff --git a/89.md b/89.md index 54aa30b..24aa3c5 100644 --- a/89.md +++ b/89.md @@ -27,7 +27,7 @@ There are three actors to this workflow: ## Events ### Recommendation event -```json +```jsonc { "kind": 31989, "pubkey": <recommender-user-pubkey>, @@ -35,7 +35,8 @@ There are three actors to this workflow: ["d", <supported-event-kind>], ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"], ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"] - ] + ], + // other fields... } ``` @@ -47,7 +48,7 @@ The second value of the tag SHOULD be a relay hint. The third value of the tag SHOULD be the platform where this recommendation might apply. ## Handler information -```json +```jsonc { "kind": 31990, "pubkey": "<application-pubkey>", @@ -59,7 +60,8 @@ The third value of the tag SHOULD be the platform where this recommendation migh ["web", "https://..../p/<bech32>", "nprofile"], ["web", "https://..../e/<bech32>"], ["ios", ".../<bech32>"] - ] + ], + // other fields... } ``` @@ -77,13 +79,13 @@ A tag without a second value in the array SHOULD be considered a generic handler # Client tag When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. -```json +```jsonc { "kind": 1, "tags": [ ["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"] ] - ... + // other fields... } ``` @@ -99,14 +101,14 @@ The client MIGHT query for the user's and the user's follows handler. ### User A recommends a `kind:31337`-handler User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler. -```json +```jsonc { "kind": 31989, "tags": [ ["d", "31337"], ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"] ], - ... + // other fields... } ``` @@ -115,7 +117,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`: -```json +``` ["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] ``` @@ -126,6 +128,6 @@ User B's client sees the application's `kind:31990` which includes the informati ### Alternative query bypassing `kind:31989` Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. -```json +``` ["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] ``` diff --git a/90.md b/90.md index 5a15ebb..696ebd5 100644 --- a/90.md +++ b/90.md @@ -36,7 +36,7 @@ There are two actors in the workflow described in this NIP: ## Job request (`kind:5000-5999`) A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute. -```json +```jsonc { "kind": 5xxx, // kind in 5000-5999 range "content": "", @@ -46,7 +46,8 @@ A request to process data, published by a customer. This event signals that a cu [ "relays", "wss://..." ], [ "bid", "<msat-amount>" ], [ "t", "bitcoin" ] - ] + ], + // other fields... } ``` @@ -81,19 +82,18 @@ If the user wants to keep the input parameters a secret, they can encrypt the `i ["param", "top-p", "0.7"], ["param", "frequency_penalty", "1"] ] - ``` This param data will be encrypted and added to the `content` field and `p` tag should be present -```json +```jsonc { "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", "tags": [ ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], ["encrypted"] ], - ... + // other fields... } ``` @@ -102,7 +102,7 @@ This param data will be encrypted and added to the `content` field and `p` tag s Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. -```json +```jsonc { "pubkey": "<service-provider pubkey>", "content": "<payload>", @@ -114,7 +114,7 @@ Service providers publish job results, providing the output of the job result. T ["p", "<customer's-pubkey>"], ["amount", "requested-payment-amount", "<optional-bolt11>"] ], - ... + // other fields... } ``` @@ -127,7 +127,7 @@ Service providers publish job results, providing the output of the job result. T If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text. Add a tag encrypted to mark the output content as `encrypted` -```json +```jsonc { "pubkey": "<service-provider pubkey>", "content": "<encrypted payload>", @@ -139,7 +139,7 @@ Add a tag encrypted to mark the output content as `encrypted` ["amount", "requested-payment-amount", "<optional-bolt11>"], ["encrypted"] ], - ... + // other fields... } ``` @@ -147,7 +147,7 @@ Add a tag encrypted to mark the output content as `encrypted` Service providers can give feedback about a job back to the customer. -```json +```jsonc { "kind": 7000, "content": "<empty-or-payload>", @@ -157,7 +157,7 @@ Service providers can give feedback about a job back to the customer. ["e", "<job-request-id>", "<relay-hint>"], ["p", "<customer's-pubkey>"], ], - ... + // other fields... } ``` @@ -211,7 +211,7 @@ This gives a higher level of flexibility to service providers (which sophisticat # Appendix 2: Service provider discoverability Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: -```js +```jsonc { "kind": 31990, "pubkey": "<pubkey>", @@ -223,7 +223,7 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo ["k", "5005"], // e.g. translation ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" ], - ... + // other fields... } ``` diff --git a/94.md b/94.md index e35dfa1..a057cb2 100644 --- a/94.md +++ b/94.md @@ -27,7 +27,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `alt` (optional) description for accessibility * `fallback` (optional) zero or more fallback file sources in case `url` fails -```json +```jsonc { "kind": 1063, "tags": [ @@ -46,7 +46,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["alt", <description>] ], "content": "<caption>", - ... + // other fields... } ``` diff --git a/96.md b/96.md index fab0c1a..75d7f1f 100644 --- a/96.md +++ b/96.md @@ -19,7 +19,7 @@ will not have to learn anything about nostr relays. File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`: -```js +```jsonc { // Required // File upload and deletion are served from this url @@ -59,7 +59,7 @@ File storage servers wishing to be accessible by nostr users should opt-in by ma "file_expiration": [14, 90], "media_transformations": { "image": [ - 'resizing' + "resizing" ] } } @@ -127,14 +127,14 @@ The `server` MUST link the user's `pubkey` string as the owner of the file so to The upload response is a json object as follows: -```js +```jsonc { // "success" if successful or "error" if not - status: "success", + "status": "success", // Free text success, failure or info message - message: "Upload successful.", + "message": "Upload successful.", // Optional. See "Delayed Processing" section - processing_url: "...", + "processing_url": "...", // This uses the NIP-94 event format but DO NOT need // to fill some fields like "id", "pubkey", "created_at" and "sig" // @@ -143,9 +143,9 @@ The upload response is a json object as follows: // and, optionally, all file metadata the server wants to make available // // nip94_event field is absent if unsuccessful upload - nip94_event: { + "nip94_event2":{ // Required tags: "url" and "ox" - tags: [ + "tags": [ // Can be same from /.well-known/nostr/nip96.json's "download_url" field // (or "api_url" field if "download_url" is absent or empty) with appended // original file hash. @@ -171,7 +171,7 @@ The upload response is a json object as follows: ["dim", "800x600"] // ... other optional NIP-94 tags ], - content: "" + "content": "" }, // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags) } @@ -202,12 +202,12 @@ the file processing is done. If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON: -``` +```jsonc { // It should be "processing". If "error" it would mean the processing failed. - status: "processing", - message: "Processing. Please check again later for updated status.", - percentage: 15 // Processing percentage. An integer between 0 and 100. + "status": "processing", + "message": "Processing. Please check again later for updated status.", + "percentage": 15 // Processing percentage. An integer between 0 and 100. } ``` @@ -270,10 +270,10 @@ in the same file hash). The successful response is a 200 OK one with just basic JSON fields: -``` +```json { - status: "success", - message: "File deleted." + "status": "success", + "message": "File deleted." } ``` @@ -287,7 +287,7 @@ Returns a list of files linked to the authenticated users pubkey. Example Response: -```js +```jsonc { "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) "total": 1, // total number of files @@ -295,17 +295,16 @@ Example Response: "files": [ { "tags": [ - ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], - ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], + ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + ["x", "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], ["size", "123456"], ["alt", "a meme that makes you laugh"], ["expiration", "1715691139"], // ...other metadata - ] + ], "content": "haha funny meme", // caption "created_at": 1715691130 // upload timestamp - }, - ... + } ] } ``` @@ -324,14 +323,14 @@ Note: HTTP File Storage Server developers may skip this section. This is meant f A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants to upload files to. Servers are listed as `server` tags: -```js -{ - // ... +```json +{. "kind": 10096, "content": "", "tags": [ ["server", "https://file.server.one"], ["server", "https://file.server.two"] - ] + ], + // other fields... } ``` diff --git a/99.md b/99.md index b1b7ce9..e2ffc3b 100644 --- a/99.md +++ b/99.md @@ -54,7 +54,7 @@ Other standard tags that might be useful. ## Example Event -```json +```jsonc { "kind": 30402, "created_at": 1675642635, From c8dc1eadffe0ff894ec39e291c5b28bb18e6db9e Mon Sep 17 00:00:00 2001 From: K <kehiiiiya@gmail.com> Date: Tue, 3 Sep 2024 23:47:11 +0330 Subject: [PATCH 14/95] Update 96.md --- 96.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/96.md b/96.md index 75d7f1f..4e9ce16 100644 --- a/96.md +++ b/96.md @@ -143,7 +143,7 @@ The upload response is a json object as follows: // and, optionally, all file metadata the server wants to make available // // nip94_event field is absent if unsuccessful upload - "nip94_event2":{ + "nip94_event2": { // Required tags: "url" and "ox" "tags": [ // Can be same from /.well-known/nostr/nip96.json's "download_url" field @@ -166,7 +166,7 @@ The upload response is a json object as follows: // The server can but does not need to store this value. ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"], // Optional. Recommended for helping clients to easily know file type before downloading it. - ["m", "image/png"] + ["m", "image/png"], // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it. ["dim", "800x600"] // ... other optional NIP-94 tags From 7edd3d23a953494bcce5def703a0d7a02a5ffa9c Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 10 Sep 2024 00:32:25 +0900 Subject: [PATCH 15/95] README: update kinds table --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ebd9d2..b22f1a3 100644 --- a/README.md +++ b/README.md @@ -142,8 +142,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7000` | Job Feedback | [90](90.md) | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | -| `9734` | Zap Request | [57](57.md) | | `9467` | Tidal login | [Tidal-nostr] | +| `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `9802` | Highlights | [84](84.md) | | `10000` | Mute list | [51](51.md) | @@ -174,6 +174,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30003` | Bookmark sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | | `30005` | Video sets | [51](51.md) | +| `30007` | Kind mute sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30015` | Interest sets | [51](51.md) | From e7eb776288b424e8cd43080b33b21506942f91e0 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 9 Sep 2024 12:38:51 -0700 Subject: [PATCH 16/95] Revert example code update --- 13.md | 45 +++++++++++++++++++-------------------------- 1 file changed, 19 insertions(+), 26 deletions(-) diff --git a/13.md b/13.md index 0900d2d..cf5b1ac 100644 --- a/13.md +++ b/13.md @@ -48,37 +48,30 @@ Validating Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id: ```c -#include <stdio.h> -#include <stdlib.h> -#include <string.h> +int zero_bits(unsigned char b) +{ + int n = 0; -int countLeadingZeroes(const char *hex) { - int count = 0; + if (b == 0) + return 8; - for (int i = 0; i < strlen(hex); i++) { - int nibble = (int)strtol((char[]){hex[i], '\0'}, NULL, 16); - if (nibble == 0) { - count += 4; - } else { - count += __builtin_clz(nibble) - 28; - break; - } - } + while (b >>= 1) + n++; - return count; + return 7-n; } -int main(int argc, char *argv[]) { - if (argc != 2) { - fprintf(stderr, "Usage: %s <hex_string>\n", argv[0]); - return 1; - } - - const char *hex_string = argv[1]; - int result = countLeadingZeroes(hex_string); - printf("Leading zeroes in hex string %s: %d\n", hex_string, result); - - return 0; +/* find the number of leading zero bits in a hash */ +int count_leading_zero_bits(unsigned char *hash) +{ + int bits, total, i; + for (i = 0, total = 0; i < 32; i++) { + bits = zero_bits(hash[i]); + total += bits; + if (bits != 8) + break; + } + return total; } ``` From c343175a32f492cd1a40749fdd7c523c083bdb19 Mon Sep 17 00:00:00 2001 From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com> Date: Tue, 10 Sep 2024 23:37:36 +0330 Subject: [PATCH 17/95] Update 10.md --- 10.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/10.md b/10.md index 67b01f2..94db4fa 100644 --- a/10.md +++ b/10.md @@ -43,7 +43,7 @@ They are citing from this event. `root-id` and `reply-id` are as above. Where: * `<event-id>` is the id of the event being referenced. - * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`. + * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-url>` field, but may instead leave it as `""`. * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event From d8ab9849b36f741ced25e40e9639c72b8062a38e Mon Sep 17 00:00:00 2001 From: kehiy <kehiiiiya@gmail.com> Date: Wed, 11 Sep 2024 13:17:16 +0330 Subject: [PATCH 18/95] make *.md linguist detectable. --- .gitattributes | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..a252d3d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.md linguist-detectable From 37a02e817b4b3e3ee7599fb1d28d97db133ef05c Mon Sep 17 00:00:00 2001 From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com> Date: Thu, 12 Sep 2024 16:45:47 +0330 Subject: [PATCH 19/95] custom emojis in reactions (#1492) --- 30.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/30.md b/30.md index c2f8bb0..54a8b37 100644 --- a/30.md +++ b/30.md @@ -54,3 +54,19 @@ In kind 1 events, the `content` should be emojified. "created_at": 1682630000 } ``` + +### Kind 7 events + +In kind 7 events, the `content` should be emojified. + +```json +{ + "kind": 7, + "content": ":dezh:", + "tags": [ + ["emoji", "dezh", "https://raw.githubusercontent.com/dezh-tech/brand-assets/main/dezh/logo/black-normal.svg"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682630000 +} +``` From e61651ac06c662b43817f85581b50e4254efbd7b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Fri, 13 Sep 2024 08:07:38 -0300 Subject: [PATCH 20/95] nip29: make @staab happier. --- 29.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 75 insertions(+), 15 deletions(-) diff --git a/29.md b/29.md index 6232f8b..f4a5436 100644 --- a/29.md +++ b/29.md @@ -22,6 +22,12 @@ Relays are supposed to generate the events that describe group metadata and grou A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`. +Group identifiers must be strings restricted to the characters `a-z0-9-_`. + +When encountering just the `<host>` without the `'<group-id>`, clients can choose to connect to the group with id `_`, which is a special top-level group dedicated to relay-local discussions. + +Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusiong and ensures they can be migrated or forked to other relays easily without risking conflicting with other groups using the same id in these new relays. This isn't a hard rule, as, for example, in `unmanaged` and/or ephemeral relays groups might not want to migrate ever, so they might not care about this. Notably, the `_` relay-local group isn't expected to be migrated ever. + ## The `h` tag Events sent by users to groups (chat messages, text notes, moderation events etc) must have an `h` tag with the value set to the group _id_. @@ -36,8 +42,22 @@ This is a hack to prevent messages from being broadcasted to external relays tha Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay. +## Unmanaged groups + +Unmanaged groups are impromptu groups that can be used in any public relay unaware of NIP-29 specifics. They piggyback on relays' natural white/blacklists (or lack of) but aside from that are not actively managed and won't have any admins, group state or metadata events. + +In `unmanaged` groups, everybody is considered to be a member. + +Unmanaged groups can transition to managed groups, in that case the relay master key just has to publish moderation events setting the state of all groups and start enforcing the rules they choose to. + ## Event definitions +These are the events expected to be found in NIP-29 groups. + +### Normal user-created events + +These events generally can be sent by all members of a group and they require the `h` tag to be present so they're attached to a specific group. + - *text root note* (`kind:11`) This is the basic unit of a "microblog" root text note sent to a group. @@ -79,6 +99,14 @@ Similar to `kind:12`, this is the basic unit of a chat message sent to a group. `kind:10` SHOULD use NIP-10 markers, just like `kind:12`. +- other events: + +Groups may also accept other events, like long-form articles, calendar, livestream, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. + +### User-related group management events + +These are events that can be sent my user to manage their situation in a group, they also require the `h` tag. + - *join request* (`kind:9021`) Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them. @@ -88,11 +116,14 @@ Any user can send one of these events to the relay in order to be automatically "kind": 9021, "content": "optional reason", "tags": [ - ["h", "<group-id>"] + ["h", "<group-id>"], + ["claim", "<optional-invite-code>"] ] } ``` +The optional `claim` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. + - *leave request* (`kind:9022`) Any user can send one of these events to the relay in order to be automatically removed from the group. The relay will automatically issue a `kind:9001` in response removing this user. @@ -107,6 +138,10 @@ Any user can send one of these events to the relay in order to be automatically } ``` +### Group state -- or moderation + +These are events expected to be sent by the relay master key or by group admins -- and relays should reject them if they don't come from an authorized admin. They also require the `h` tag. + - *moderation events* (`kinds:9000-9020`) (optional) Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action. The relay may discard the event after taking action or keep it as a moderation log. @@ -124,17 +159,24 @@ Clients can send these events to a relay in order to accomplish a moderation act Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: -| kind | name | tags | -| --- | --- | --- | -| 9000 | `add-user` | `p` (pubkey hex) | -| 9001 | `remove-user` | `p` (pubkey hex) | -| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | -| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | -| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | -| 9005 | `delete-event` | `e` (id hex) | -| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | -| 9007 | `create-group` | | -| 9008 | `delete-group` | | +| kind | name | tags | +| --- | --- | --- | +| 9000 | `add-user` | `p` (pubkey hex) | +| 9001 | `remove-user` | `p` (pubkey hex) | +| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | +| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | +| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | +| 9005 | `delete-event` | `e` (id hex) | +| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | +| 9007 | `create-group` | | +| 9008 | `delete-group` | | +| 9009 | `create-invite` | `code`, `uses` (how many times it can be used) | + +It's expected that the group state (of who is an allowed member or not, who is an admin and with which permission or not, what are the group name and picture etc) can be fully reconstructed from the canonical sequence of these events. + +### Group metadata events + +These events contain the group id in a `d` tag instead of the `h` tag. They are expected to be created by the relay master key only and a single instance of each (or none) should exist at all times for each group. They are merely informative but should reflect the latest group state (as it was changed by moderation events over time). - *group metadata* (`kind:39000`) (optional) @@ -142,6 +184,8 @@ This event defines the metadata for the group -- basically how clients should di If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. +When this event is not found, clients may still connect to the group, but treat it as having a different status, `unmanaged`, + ```jsonc { "kind": 39000, @@ -194,7 +238,9 @@ The list of capabilities, as defined by this NIP, for now, is the following: Similar to *group admins*, this event is supposed to be generated by relays that host the group. -It's a NIP-51-like list of pubkeys that are members of the group. Relays might choose to not to publish this information or to restrict what pubkeys can fetch it. +It's a list of pubkeys that are members of the group. Relays might choose to not to publish this information or to restrict what pubkeys can fetch it. + +Clients should not assume this will always be present or that it will contain a full list of members, as relays may opt to not publish it or publish a shortened version. ```json { @@ -209,6 +255,20 @@ It's a NIP-51-like list of pubkeys that are members of the group. Relays might c } ``` -## Storing the list of groups a user belongs to +## Implementation quirks -A definition for kind `10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in. +### Checking your own membership in a group + +The latest of either `kind:9000` or `kind:9001` events present in a group should tell a user that they are currently members of the group or if they were removed. In case none of these exist the user is assumed to not be a member of the group -- unless the group is `unmanaged`, in which case the user is assumed to be a member. + +### Adding yourself to a group + +When a group is `open`, anyone can send a `kind:9021` event to it in order to be added, then expect a `kind:9000` event to be emitted confirming that the user was added. The same happens with `closed` groups, except in that case a user may only send a `kind:9021` if it has an invite code. + +### Storing your list of groups + +A definition for `kind:10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in. + +### Using `unmanaged` relays + +To prevent event leakage, replay and confusion, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays. From efcc86950dd32721e00f868b480a74e9dbd9ca1b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Fri, 13 Sep 2024 16:17:35 -0300 Subject: [PATCH 21/95] remove this annoying file. --- .gitattributes | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index a252d3d..0000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -*.md linguist-detectable From d534bade7184966df7335a8867b97cd879ee58cd Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 17 Sep 2024 11:03:56 -0300 Subject: [PATCH 22/95] renumber polls NIP to 88. this one: https://github.com/nostr-protocol/nips/pull/1346 --- 118.md => 88.md | 8 ++++---- README.md | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) rename 118.md => 88.md (95%) diff --git a/118.md b/88.md similarity index 95% rename from 118.md rename to 88.md index b22b006..4318062 100644 --- a/118.md +++ b/88.md @@ -1,4 +1,4 @@ -# NIP-118 +# NIP-88 ## Polls @@ -15,7 +15,7 @@ The NIP makes the following tradeoffs. ### Poll Event -The poll event is defined as a `kind:1068` event. +The poll event is defined as a `kind:1068` event. - **content** key holds the label for the poll. @@ -24,7 +24,7 @@ Major tags in the poll event are: - **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. - **relay**: One or multiple tags that the poll is expecting respondents to respond on. -- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. +- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. Example Event @@ -89,4 +89,4 @@ In case of multiple events for a pubkey, the event with the largest timestamp sh ### Curation The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. -Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. \ No newline at end of file +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/README.md b/README.md index b22f1a3..5222e28 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) +- [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) @@ -118,11 +119,13 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | +| `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | +| `1068` | Poll | [88](88.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | From 3d8bf682b6f6f961a4c3609f9447907abaad9d0e Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Tue, 17 Sep 2024 09:22:40 -0500 Subject: [PATCH 23/95] NIP-88: make poll response a parameterized replaceable event --- 88.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/88.md b/88.md index 4318062..1e71ffa 100644 --- a/88.md +++ b/88.md @@ -50,7 +50,7 @@ Example Event ### Responses -The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. +The response event is a `kind:30068` event. It contains a d tag with the poll event it is referencing, followed by one or more response tags. - **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. @@ -61,11 +61,11 @@ Example Response Event "content": "", "created_at": 1720097117, "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", - "kind": 1018, + "kind": 30068, "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", "tags": [ - ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["d", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], ["response", "gga6cdnqj"], ["response", "m3agjsdq1"] ] @@ -74,7 +74,7 @@ Example Response Event ### Poll Types -Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:1018` event. +Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:30068` event. - **PollType: singlechoice**: The first response tag is to be considered the actual response. - **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. @@ -82,7 +82,7 @@ Poll Types can be configured in the settings object of the poll, the setting dic ### Counting Results -Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +Results can be queried by fetching `kind:30068` events from the relays specified in the poll. The results displayed should only be 1 vote event per pubkey. In case of multiple events for a pubkey, the event with the largest timestamp should be considered. From 6cd598d02cceec76f6c4df6e061c4135ca3e3fd3 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 17 Sep 2024 18:56:50 -0300 Subject: [PATCH 24/95] remove NIP-88 polls temporarily. due to some crazy fight happening at https://github.com/nostr-protocol/nips/pull/1501 I'm removing this until people can become more reasonable. --- 88.md | 92 ------------------------------------------------------- README.md | 3 -- 2 files changed, 95 deletions(-) delete mode 100644 88.md diff --git a/88.md b/88.md deleted file mode 100644 index 1e71ffa..0000000 --- a/88.md +++ /dev/null @@ -1,92 +0,0 @@ -# NIP-88 - -## Polls - -`draft` `optional` - -This NIP defines the event scheme that describe Polls on nostr. - -The NIP makes the following tradeoffs. - -1. All votes are public. -2. All votes are editable (latest response by timestamp considered last vote) - -## Events - -### Poll Event - -The poll event is defined as a `kind:1068` event. - -- **content** key holds the label for the poll. - -Major tags in the poll event are: - - -- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. -- **relay**: One or multiple tags that the poll is expecting respondents to respond on. -- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. - - -Example Event - -```json -{ - "content": "", - "created_at": 1719888496, - "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", - "kind": 1068, - "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", - "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", - "tags": [ - ["label", "Pineapple on Pizza"], - ["option", "qj518h583", "Yay"], - ["option", "gga6cdnqj", "Nay"], - ["relay","<relay url1>"], - ["relay", "<relay url2>"], - ["polltype", "singlechoice"] - ] -} -``` - -### Responses - -The response event is a `kind:30068` event. It contains a d tag with the poll event it is referencing, followed by one or more response tags. - -- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. - -Example Response Event - -```json -{ - "content": "", - "created_at": 1720097117, - "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", - "kind": 30068, - "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", - "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", - "tags": [ - ["d", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], - ["response", "gga6cdnqj"], - ["response", "m3agjsdq1"] - ] -} -``` - -### Poll Types - -Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:30068` event. - -- **PollType: singlechoice**: The first response tag is to be considered the actual response. -- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. -- **PollType: rankedchoice**: The first response tag pointing to each id is the considered the actual response, while also taking into account the order of the response tags. - -### Counting Results - -Results can be queried by fetching `kind:30068` events from the relays specified in the poll. -The results displayed should only be 1 vote event per pubkey. -In case of multiple events for a pubkey, the event with the largest timestamp should be considered. - -### Curation - -The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. -Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/README.md b/README.md index 5222e28..b22f1a3 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) -- [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) @@ -119,13 +118,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | -| `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | -| `1068` | Poll | [88](88.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | From 765daceaa1a25a0324864668cf977cbdcb30bbd4 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 18 Sep 2024 22:27:03 -0300 Subject: [PATCH 25/95] remove invites, simplify group metadata edits, rework fine-grained "permissions" into unspecified "roles". --- 29.md | 77 +++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 43 insertions(+), 34 deletions(-) diff --git a/29.md b/29.md index f4a5436..c0dbcef 100644 --- a/29.md +++ b/29.md @@ -144,7 +144,7 @@ These are events expected to be sent by the relay master key or by group admins - *moderation events* (`kinds:9000-9020`) (optional) -Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action. The relay may discard the event after taking action or keep it as a moderation log. +Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action based on its role and the relay's internal policy (see also the description of `kind:39003`). ```json { @@ -161,22 +161,21 @@ Each moderation action uses a different kind and requires different arguments, w | kind | name | tags | | --- | --- | --- | -| 9000 | `add-user` | `p` (pubkey hex) | -| 9001 | `remove-user` | `p` (pubkey hex) | -| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | -| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | -| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | -| 9005 | `delete-event` | `e` (id hex) | -| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | +| 9000 | `add-user` | `p` with pubkey hex | +| 9001 | `remove-user` | `p` with pubkey hex | +| 9002 | `edit-metadata` | fields from `kind:39000` to be modified | +| 9003 | | | +| 9004 | | | +| 9005 | `delete-event` | | +| 9006 | `set-role` | `p` with pubkey hex and roles | | 9007 | `create-group` | | | 9008 | `delete-group` | | -| 9009 | `create-invite` | `code`, `uses` (how many times it can be used) | It's expected that the group state (of who is an allowed member or not, who is an admin and with which permission or not, what are the group name and picture etc) can be fully reconstructed from the canonical sequence of these events. ### Group metadata events -These events contain the group id in a `d` tag instead of the `h` tag. They are expected to be created by the relay master key only and a single instance of each (or none) should exist at all times for each group. They are merely informative but should reflect the latest group state (as it was changed by moderation events over time). +These events contain the group id in a `d` tag instead of the `h` tag. They MUST be created by the relay master key only and a single instance of each (or none) should exist at all times for each group. They are merely informative but should reflect the latest group state (as it was changed by moderation events over time). - *group metadata* (`kind:39000`) (optional) @@ -206,43 +205,29 @@ When this event is not found, clients may still connect to the group, but treat - *group admins* (`kind:39001`) (optional) -Similar to the group metadata, this event is supposed to be generated by relays that host the group. +Each admin is listed along with one or more roles. These roles SHOULD have a correspondence with the roles supported by the relay, as advertised by the `kind:39003` event. -Each admin gets a label that is only used for display purposes, and a list of permissions it has are listed afterwards. These permissions can inform client building UI, but ultimately are evaluated by the relay in order to become effective. - -The list of capabilities, as defined by this NIP, for now, is the following: - -- `add-user` -- `edit-metadata` -- `delete-event` -- `remove-user` -- `add-permission` -- `remove-permission` -- `edit-group-status` -- `delete-group` - -```json +```jsonc { "kind": 39001, "content": "list of admins for the pizza lovers group", "tags": [ ["d", "<group-id>"], - ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"], - ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"] - ] + ["p", "<pubkey1-as-hex>", "ceo"], + ["p", "<pubkey2-as-hex>", "secretary", "gardener"], + // other pubkeys... + ], // other fields... } ``` - *group members* (`kind:39002`) (optional) -Similar to *group admins*, this event is supposed to be generated by relays that host the group. +It's a list of pubkeys that are members of the group. Relays might choose to not to publish this information, to restrict what pubkeys can fetch it or to only display a subset of the members in it. -It's a list of pubkeys that are members of the group. Relays might choose to not to publish this information or to restrict what pubkeys can fetch it. +Clients should not assume this will always be present or that it will contain a full list of members. -Clients should not assume this will always be present or that it will contain a full list of members, as relays may opt to not publish it or publish a shortened version. - -```json +```jsonc { "kind": 39002, "content": "list of members for the pizza lovers group", @@ -251,7 +236,31 @@ Clients should not assume this will always be present or that it will contain a ["p", "<admin1>"], ["p", "<member-pubkey1>"], ["p", "<member-pubkey2>"], - ] + // other pubkeys... + ], + // other fields... +} +``` + +- *group roles* (`kind:39003`) (optional) + +This is an event that MAY be published by the relay informing users and clients about what are the roles supported by this relay according to its internal logic. + +For example, a relay may choose to support the roles `"admin"` and `"moderator"`, in which the `"admin"` will be allowed to edit the group metadata, delete messages and remove users from the group, while the `"moderator"` can only delete messages (or the relay may choose to call these roles `"ceo"` and `"secretary"` instead, the exact role name is not relevant). + +The process through which the relay decides what roles to support and how to handle moderation events internally based on them is specific to each relay and not specified here. + +```jsonc +{ + "kind": 39003, + "content": "list of roles supported by this group", + "tags": [ + ["d", "<group-id>"], + ["role", "<role-name>", "<optional-description>"], + ["role", "<role-name>", "<optional-description>"], + // other roles... + ], + // other fields... } ``` From 79786bb7bbb32162c233d99850cb33b379c2fc7a Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Fri, 20 Sep 2024 16:21:15 +0100 Subject: [PATCH 26/95] Expand External Content IDs --- 73.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/73.md b/73.md index d50ab22..afed8d1 100644 --- a/73.md +++ b/73.md @@ -6,17 +6,29 @@ External Content IDs `draft` `optional` -There are certain established global content identifiers that would be useful to reference in nostr events so that clients can query all events assosiated with these ids. +There are certain established global content identifiers such as [Book ISBNs](https://en.wikipedia.org/wiki/ISBN), [Podcast GUIDs](https://podcastnamespace.org/tag/guid), and [Movie ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) that are useful to reference in nostr events so that clients can query all the events assosiated with these ids. -- Book [ISBNs](https://en.wikipedia.org/wiki/ISBN) -- Podcast [GUIDs](https://podcastnamespace.org/tag/guid) -- Movie [ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) - -Since the `i` tag is already used for similar references in kind-0 metadata events it makes sense to use it for these content ids as well. +`i` tags are used for referencing these external content ids, with `k` tags representing the external content id kind so that clients can query all the events for a specific kind. ## Supported IDs +| Type | `i` tag | `k` tag | +|- | - | - | +| URLs | "`<URL, normalized, no fragment>`" | "`<scheme-host, normalized>`" | +| Hashtags | "#`<topic, lowercase>`" | "#" | +| Geohashes| "geo:`<geohash, lowercase>`" | "geo" | +| Books | "isbn:`<id, without hyphens>`" | "isbn" | +| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | +| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | +| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | +| Movies | "isan:`<id, without version part>`" | "isan" | +| Papers | "doi:`<id, lowercase>`" | "doi" | + +--- + +## Examples + ### Books: - Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 From ea36ec9ed7596e49bf7f217b05954c1fecacad88 Mon Sep 17 00:00:00 2001 From: dluvian <133484344+dluvian@users.noreply.github.com> Date: Fri, 20 Sep 2024 14:08:47 -0600 Subject: [PATCH 27/95] Add `subject` and `t` tags to git issues (#1446) * Add subject and and l tags to git issues * Replace `l` with `t` tags * Add nip34 to tag table * List nip34 under subject instead of summary --- 34.md | 7 ++++++- README.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/34.md b/34.md index 9363aeb..35bc1be 100644 --- a/34.md +++ b/34.md @@ -104,7 +104,9 @@ The first patch in a series MAY be a cover letter in the format produced by `git ## Issues -Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. +Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. + +Issues may have a `subject` tag, which clients can utilize to display a header. Additionally, one or more `t` tags may be included to provide labels for the issue. ```json { @@ -113,6 +115,9 @@ Issues are Markdown text that is just human-readable conversational threads rela "tags": [ ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], ["p", "<repository-owner>"] + ["subject", "<issue-subject>"] + ["t", "<issue-label>"] + ["t", "<another-issue-label>"] ] } ``` diff --git a/README.md b/README.md index b22f1a3..a9318ee 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `q` | event id (hex) | relay URL | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | [24](24.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -289,7 +289,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `relay` | relay url | -- | [42](42.md), [17](17.md) | | `relays` | relay list | -- | [57](57.md) | | `server` | file storage server url | -- | [96](96.md) | -| `subject` | subject | -- | [14](14.md), [17](17.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | From d82f68aa2ea37324b7d185954cc530a17db45e93 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 21 Sep 2024 11:52:09 -0300 Subject: [PATCH 28/95] update link to blossom on README. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9318ee..758045d 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | -| `10063` | User server list | [blossom] | +| `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | @@ -166,7 +166,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `23194` | Wallet Request | [47](47.md) | | `23195` | Wallet Response | [47](47.md) | | `24133` | Nostr Connect | [46](46.md) | -| `24242` | Blobs stored on mediaservers | [blossom] | +| `24242` | Blobs stored on mediaservers | [Blossom][blossom] | | `27235` | HTTP Auth | [98](98.md) | | `30000` | Follow sets | [51](51.md) | | `30001` | Generic lists | [51](51.md) | @@ -216,7 +216,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md [NKBIP-01]: https://wikistr.com/nkbip-01 [NKBIP-02]: https://wikistr.com/nkbip-02 -[Blossom]: https://wikistr.com/blossom +[blossom]: https://github.com/hzrd149/blossom [Tidal-nostr]: https://wikistr.com/tidal-nostr ## Message types From 4e73e94d417f16fa3451e58ef921cb3b512c6f8e Mon Sep 17 00:00:00 2001 From: Lux <135403604+Spl0itable@users.noreply.github.com> Date: Sun, 22 Sep 2024 19:17:39 +0930 Subject: [PATCH 29/95] fix typo on nip96 (#1511) Fixing typo --- 96.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/96.md b/96.md index 4e9ce16..05c1b18 100644 --- a/96.md +++ b/96.md @@ -143,7 +143,7 @@ The upload response is a json object as follows: // and, optionally, all file metadata the server wants to make available // // nip94_event field is absent if unsuccessful upload - "nip94_event2": { + "nip94_event": { // Required tags: "url" and "ox" "tags": [ // Can be same from /.well-known/nostr/nip96.json's "download_url" field From a736e629be5c4c9125d98bdb4965851d8110c483 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 28 Sep 2024 12:26:48 -0300 Subject: [PATCH 30/95] complete renaming to "addressable" events. as noticed by @bezysoftware at https://github.com/nostr-protocol/nips/pull/1437#issuecomment-2380626514. I don't know how so many of these instances were left from the original PR at following ca3c52e3e74f0a4679f1c6c0d9ac6461ea748d2d. --- 01.md | 4 ++-- 23.md | 2 +- 32.md | 4 ++-- 38.md | 2 +- 52.md | 6 +++--- 58.md | 3 +-- 71.md | 6 +++--- 75.md | 2 +- 8 files changed, 14 insertions(+), 15 deletions(-) diff --git a/01.md b/01.md index 9e50204..c3c0991 100644 --- a/01.md +++ b/01.md @@ -77,7 +77,7 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` -- The `a` tag, used to refer to a (maybe parameterized) replaceable event +- The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` @@ -95,7 +95,7 @@ And also a convention for kind ranges that allow for easier experimentation and - for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays. - for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded. +- for kind `n` such that `30000 <= n < 40000`, events are **addressable** by their `kind`, `pubkey` and `d` tag value -- which means that, for each combination of `kind`, `pubkey` and the `d` tag value, only the latest event MUST be stored by relays, older versions MAY be discarded. In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. diff --git a/23.md b/23.md index d8fb51a..720f6d6 100644 --- a/23.md +++ b/23.md @@ -31,7 +31,7 @@ Other metadata fields can be added as tags to the event as necessary. Here we st ### Editability -These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. +These articles are meant to be editable, so they should include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. ### Linking diff --git a/32.md b/32.md index 66f0283..a99e52a 100644 --- a/32.md +++ b/32.md @@ -8,7 +8,7 @@ Labeling This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification. -New Tags: +New Tags: - `L` denotes a label namespace - `l` denotes a label @@ -146,7 +146,7 @@ Other Notes ----------- When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement -may be published. We have opted not to use parameterizable/replaceable events for this due to the +may be published. We have opted not to use addressable/replaceable events for this due to the complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, publishers SHOULD limit labeling events to a single namespace. diff --git a/38.md b/38.md index 8b22b2a..ece5e5f 100644 --- a/38.md +++ b/38.md @@ -46,7 +46,7 @@ Two common status types are defined: `general` and `music`. `general` represent Any other status types can be used but they are not defined by this NIP. -The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. +The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or addressable event. The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. diff --git a/52.md b/52.md index c6d6b96..cc2625a 100644 --- a/52.md +++ b/52.md @@ -20,7 +20,7 @@ This kind of calendar event starts on a date and ends before a different date in #### Format -The format uses a parameterized replaceable event kind `31922`. +The format uses an _addressable event_ of `kind:31922`. The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. @@ -79,7 +79,7 @@ This kind of calendar event spans between a start time and end time. #### Format -The format uses a parameterized replaceable event kind `31923`. +The format uses an _addressable event_ kind `31923`. The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. @@ -193,7 +193,7 @@ The RSVP MAY tag the author of the calendar event it is in response to using a ` ### Format -The format uses a parameterized replaceable event kind `31925`. +The format uses an _addressable event_ kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. diff --git a/58.md b/58.md index b6324f4..23921bd 100644 --- a/58.md +++ b/58.md @@ -13,8 +13,7 @@ user profiles: 2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. -3. A "Profile Badges" event is defined as a parameterized replaceable event -with kind `30008` with a `d` tag with the value `profile_badges`. +3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`. Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed. ### Badge Definition event diff --git a/71.md b/71.md index 5cf3b36..dd813e9 100644 --- a/71.md +++ b/71.md @@ -16,7 +16,7 @@ There are two types of video events represented by different kinds: horizontal a #### Format -The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. +The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos. The `.content` of these events is a summary or description on the video content. @@ -91,14 +91,14 @@ A video event view is a response to a video event to track a user's view or prog ### Format -The format uses a parameterized replaceable event kind `34237`. +The format uses an _addressable event_ kind `34237`. The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. The list of tags are as follows: * `a` (required) reference tag to kind `34235` or `34236` video event being viewed * `d` (required) same as `a` reference tag value -* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds +* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds ```json diff --git a/75.md b/75.md index 885c391..ad933d5 100644 --- a/75.md +++ b/75.md @@ -77,7 +77,7 @@ Clients MAY display funding goals on user profiles. When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. -When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. +When zapping an addressable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. ## Use cases From ce2234e0baac9d64f7044ec1c4a5cc7210fd2fc2 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 30 Sep 2024 09:17:22 -0700 Subject: [PATCH 31/95] Clarify tag filters --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index c3c0991..d62f317 100644 --- a/01.md +++ b/01.md @@ -81,7 +81,7 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` -As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": ["5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"]}` filter. +As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": ["5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"]}` filter. Only the first value in any given tag is indexed. ### Kinds From 344b0b9a7271d5f6ac9cf2e6c875a7108d22a1dc Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 2 Oct 2024 23:15:20 +0900 Subject: [PATCH 32/95] README: add NIP-73 link to `k` tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 758045d..789dcca 100644 --- a/README.md +++ b/README.md @@ -255,7 +255,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | | `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | -| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | +| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | From 7f67ce53fbc6f2994a53853fbd2f186cd5c5a94f Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 2 Oct 2024 23:19:35 +0900 Subject: [PATCH 33/95] Format tags table --- README.md | 100 +++++++++++++++++++++++++++--------------------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 789dcca..e5e31c6 100644 --- a/README.md +++ b/README.md @@ -245,56 +245,56 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Standardized Tags -| name | value | other parameters | NIP | -| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | -| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `a` | coordinates to an event | relay URL | [01](01.md) | -| `d` | identifier | -- | [01](01.md) | -| `-` | -- | -- | [70](70.md) | -| `g` | geohash | -- | [52](52.md) | -| `h` | group id | -- | [29](29.md) | -| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | -| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | -| `l` | label, label namespace | -- | [32](32.md) | -| `L` | label namespace | -- | [32](32.md) | -| `m` | MIME type | -- | [94](94.md) | -| `q` | event id (hex) | relay URL | [18](18.md) | -| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | -| `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | [24](24.md), [34](34.md) | -| `alt` | summary | -- | [31](31.md) | -| `amount` | millisatoshis, stringified | -- | [57](57.md) | -| `bolt11` | `bolt11` invoice | -- | [57](57.md) | -| `challenge` | challenge string | -- | [42](42.md) | -| `client` | name, address | relay URL | [89](89.md) | -| `clone` | git clone URL | -- | [34](34.md) | -| `content-warning` | reason | -- | [36](36.md) | -| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | -| `emoji` | shortcode, image URL | -- | [30](30.md) | -| `encrypted` | -- | -- | [90](90.md) | -| `expiration` | unix timestamp (string) | -- | [40](40.md) | -| `goal` | event id (hex) | relay URL | [75](75.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | -| `imeta` | inline metadata | -- | [92](92.md) | -| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | -| `nonce` | random | difficulty | [13](13.md) | -| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | -| `price` | price | currency, frequency | [99](99.md) | -| `proxy` | external ID | protocol | [48](48.md) | -| `published_at` | unix timestamp (string) | -- | [23](23.md) | -| `relay` | relay url | -- | [42](42.md), [17](17.md) | -| `relays` | relay list | -- | [57](57.md) | -| `server` | file storage server url | -- | [96](96.md) | -| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | -| `summary` | summary | -- | [23](23.md), [52](52.md) | -| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | -| `title` | article title | -- | [23](23.md) | -| `web` | webpage URL | -- | [34](34.md) | -| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | +| `-` | -- | -- | [70](70.md) | +| `g` | geohash | -- | [52](52.md) | +| `h` | group id | -- | [29](29.md) | +| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | +| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | +| `l` | label, label namespace | -- | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `q` | event id (hex) | relay URL | [18](18.md) | +| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | +| `r` | relay url | marker | [65](65.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md) | +| `alt` | summary | -- | [31](31.md) | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `client` | name, address | relay URL | [89](89.md) | +| `clone` | git clone URL | -- | [34](34.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `encrypted` | -- | -- | [90](90.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | +| `imeta` | inline metadata | -- | [92](92.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | +| `nonce` | random | difficulty | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `relay` | relay url | -- | [42](42.md), [17](17.md) | +| `relays` | relay list | -- | [57](57.md) | +| `server` | file storage server url | -- | [96](96.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | +| `summary` | summary | -- | [23](23.md), [52](52.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `web` | webpage URL | -- | [34](34.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | Please update these lists when proposing new NIPs. From 02e934acb725dc8a947e83e347a96c8f7ab9c219 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Wed, 2 Oct 2024 13:22:52 -0700 Subject: [PATCH 34/95] Clarify quote reposts --- 18.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/18.md b/18.md index 27c5915..9d0ce1c 100644 --- a/18.md +++ b/18.md @@ -18,13 +18,6 @@ to indicate where it can be fetched. The repost SHOULD include a `p` tag with the `pubkey` of the event being reposted. -## Quote Reposts - -Quote reposts are `kind 1` events with an embedded `q` tag of the note being -quote reposted. The `q` tag ensures quote reposts are not pulled and included -as replies in threads. It also allows you to easily pull and count all of the -quotes for a post. - ## Generic Reposts Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` @@ -33,3 +26,20 @@ as a "generic repost", that can include any kind of event inside other than `kind 16` reposts SHOULD contain a `k` tag with the stringified kind number of the reposted event as its value. + +## Quote Reposts + +Quote reposts are `kind 1` events with an embedded `q` tag of the note being +quote reposted. The `q` tag ensures quote reposts are not pulled and included +as replies in threads. It also allows you to easily pull and count all of the +quotes for a post. + +`q` tags should follow the same conventions as NIP 10 `e` tags, with the exception +of the `mark` argument. The first argument MAY be either an event id or an address. + +`["q", <event-id-or-address>, <relay-url>, <pubkey>]` + +Quote reposts MUST include the bech32-encoded `nevent`, `note`, or `naddr` of the +event in the content. The embedded entity should match the type of the tag (in +other words, if embedding a `naddr`, the `q` tag should contain an address, not +an event id). From 78b6615c211b83b4f09c3421ccd61c05e3d0264f Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Wed, 2 Oct 2024 14:50:10 -0700 Subject: [PATCH 35/95] recommend k tag for quotes --- 18.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/18.md b/18.md index 9d0ce1c..c8bf224 100644 --- a/18.md +++ b/18.md @@ -43,3 +43,6 @@ Quote reposts MUST include the bech32-encoded `nevent`, `note`, or `naddr` of th event in the content. The embedded entity should match the type of the tag (in other words, if embedding a `naddr`, the `q` tag should contain an address, not an event id). + +Quote reposts also SHOULD include a `k` tag matching the stringified `kind` of +the quoted note. From f5a6fb258fa235189303c8bf2c1132e9f81ac8c9 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 3 Oct 2024 09:31:17 -0700 Subject: [PATCH 36/95] Update 18.md Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --- 18.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/18.md b/18.md index c8bf224..784946a 100644 --- a/18.md +++ b/18.md @@ -39,7 +39,7 @@ of the `mark` argument. The first argument MAY be either an event id or an addre `["q", <event-id-or-address>, <relay-url>, <pubkey>]` -Quote reposts MUST include the bech32-encoded `nevent`, `note`, or `naddr` of the +Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the event in the content. The embedded entity should match the type of the tag (in other words, if embedding a `naddr`, the `q` tag should contain an address, not an event id). From 2053aee0c27e43c395706dee2706f2417c0ad268 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 3 Oct 2024 09:35:09 -0700 Subject: [PATCH 37/95] Remove addresses and tags from quote reposts --- 18.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/18.md b/18.md index 784946a..f1e3f8c 100644 --- a/18.md +++ b/18.md @@ -35,14 +35,9 @@ as replies in threads. It also allows you to easily pull and count all of the quotes for a post. `q` tags should follow the same conventions as NIP 10 `e` tags, with the exception -of the `mark` argument. The first argument MAY be either an event id or an address. +of the `mark` argument. -`["q", <event-id-or-address>, <relay-url>, <pubkey>]` +`["q", <event-id>, <relay-url>, <pubkey>]` Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the -event in the content. The embedded entity should match the type of the tag (in -other words, if embedding a `naddr`, the `q` tag should contain an address, not -an event id). - -Quote reposts also SHOULD include a `k` tag matching the stringified `kind` of -the quoted note. +event in the content. From 7df7deebf579fcf0c095fd6e974a4d54970cbec6 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 3 Oct 2024 09:39:03 -0700 Subject: [PATCH 38/95] Move generic reposts back to bottom for a simpler diff --- 18.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/18.md b/18.md index f1e3f8c..4bf39ef 100644 --- a/18.md +++ b/18.md @@ -18,15 +18,6 @@ to indicate where it can be fetched. The repost SHOULD include a `p` tag with the `pubkey` of the event being reposted. -## Generic Reposts - -Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` -as a "generic repost", that can include any kind of event inside other than -`kind 1`. - -`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number -of the reposted event as its value. - ## Quote Reposts Quote reposts are `kind 1` events with an embedded `q` tag of the note being @@ -41,3 +32,12 @@ of the `mark` argument. Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the event in the content. + +## Generic Reposts + +Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` +as a "generic repost", that can include any kind of event inside other than +`kind 1`. + +`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number +of the reposted event as its value. From 7bb8997be5f8cbe1004e7c75724feaa56ccd08de Mon Sep 17 00:00:00 2001 From: DASHU <385321165@qq.com> Date: Tue, 2 Jul 2024 16:02:31 +0800 Subject: [PATCH 39/95] fix some info of nip55 to be same as other nips --- 55.md | 124 +++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 89 insertions(+), 35 deletions(-) diff --git a/55.md b/55.md index c0ee957..d78bc8c 100644 --- a/55.md +++ b/55.md @@ -101,10 +101,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **npub** in the signature field + - If the user approved intent it will return the **pubkey** in the signature field ```kotlin - val npub = intent.data?.getStringExtra("signature") + val pubkey = intent.data?.getStringExtra("signature") // The package name of the signer application val packageName = intent.data?.getStringExtra("package") ``` @@ -118,8 +118,8 @@ launcher.launch(intent) intent.putExtra("type", "sign_event") // To handle results when not waiting between intents intent.putExtra("id", event.id) - // Send the current logged in user npub - intent.putExtra("current_user", npub) + // Send the current logged in user pubkey + intent.putExtra("current_user", pubkey) context.startActivity(intent) ``` @@ -142,10 +142,10 @@ launcher.launch(intent) intent.putExtra("type", "nip04_encrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for encrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for encrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -167,10 +167,10 @@ launcher.launch(intent) intent.putExtra("type", "nip44_encrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for encrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for encrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -192,10 +192,10 @@ launcher.launch(intent) intent.putExtra("type", "nip04_decrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for decrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for decrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -217,10 +217,10 @@ launcher.launch(intent) intent.putExtra("type", "nip04_decrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for decrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for decrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -233,6 +233,29 @@ launcher.launch(intent) val id = intent.data?.getStringExtra("id") ``` +- **get_relays** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "get_relays") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val relayJsonText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + - **decrypt_zap_event** - params: @@ -242,8 +265,8 @@ launcher.launch(intent) intent.putExtra("type", "decrypt_zap_event") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) context.startActivity(intent) ``` - result: @@ -259,7 +282,7 @@ launcher.launch(intent) To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. -If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null +If the user did not check the "remember my choice" option, the pubkey is not in Signer Application or the signer type is not recognized the `contentResolver` will return null For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json @@ -282,7 +305,7 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **npub** in the signature column + - Will return the **pubkey** in the signature column ```kotlin if (result == null) return @@ -290,7 +313,7 @@ If the user chose to always reject the event, signer application will return the if (result.moveToFirst()) { val index = it.getColumnIndex("signature") if (index < 0) return - val npub = it.getString(index) + val pubkey = it.getString(index) } ``` @@ -300,7 +323,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.SIGN_EVENT"), - listOf("$eventJson", "", "${logged_in_user_npub}"), + listOf("$eventJson", "", "${logged_in_user_pubkey}"), null, null, null @@ -326,7 +349,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), - listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -350,7 +373,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), - listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -374,7 +397,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP04_DECRYPT"), - listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -398,7 +421,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP44_DECRYPT"), - listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -416,13 +439,37 @@ If the user chose to always reject the event, signer application will return the } ``` +- **get_relays** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.GET_RELAYS"), + listOf("${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val relayJsonText = it.getString(index) + } + ``` + - **decrypt_zap_event** - params: ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), - listOf("$eventJson", "", "${logged_in_user_npub}"), + listOf("$eventJson", "", "${logged_in_user_pubkey}"), null, null, null @@ -472,28 +519,35 @@ Android intents and browser urls have limitations, so if you are using the `retu - params: ```js - window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; ``` - **nip44_encrypt** - params: ```js - window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; ``` - **nip04_decrypt** - params: ```js - window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; ``` - **nip44_decrypt** - params: ```js - window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **get_relays** + - params: + + ```js + window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_relays&callbackUrl=https://example.com/?event=`; ``` - **decrypt_zap_event** From db13d12eb6412d56e94e041d22cadf8ea757a91b Mon Sep 17 00:00:00 2001 From: Vic <88121568+vicariousdrama@users.noreply.github.com> Date: Mon, 7 Oct 2024 07:03:20 -0400 Subject: [PATCH 40/95] Add Corny Chat Slide Set and Link Set kinds (#1152) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 758045d..df1cc93 100644 --- a/README.md +++ b/README.md @@ -191,12 +191,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | +| `30388` | Slide Set | [Corny Chat][cornychat-slideset] | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | | `30618` | Repository state announcements | [34](34.md) | | `30818` | Wiki article | [54](54.md) | | `30819` | Redirects | [54](54.md) | +| `31388` | Link Set | [Corny Chat][cornychat-linkset] | | `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | @@ -213,6 +215,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md +[cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset +[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md [NKBIP-01]: https://wikistr.com/nkbip-01 [NKBIP-02]: https://wikistr.com/nkbip-02 From 4769b1658a226444e1c6d8d84b0bc6e00bca15a3 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 7 Oct 2024 08:56:52 -0700 Subject: [PATCH 41/95] Refer to nip 21 instead of 19 --- 18.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/18.md b/18.md index 4bf39ef..41c9442 100644 --- a/18.md +++ b/18.md @@ -30,7 +30,7 @@ of the `mark` argument. `["q", <event-id>, <relay-url>, <pubkey>]` -Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the +Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the event in the content. ## Generic Reposts From 10c112defe6d2c57ded96eb22e0b078ff962c92a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 8 Oct 2024 01:40:41 +0900 Subject: [PATCH 42/95] NIP-23, NIP-99: remove NIP-12 mention --- 23.md | 2 +- 99.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/23.md b/23.md index 720f6d6..e5e85ff 100644 --- a/23.md +++ b/23.md @@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma ### Metadata -For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12. +For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used. Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: diff --git a/99.md b/99.md index e2ffc3b..724ce5f 100644 --- a/99.md +++ b/99.md @@ -26,7 +26,7 @@ The `.pubkey` field of these events are treated as the party creating the listin ### Metadata -- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](12.md). +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used. - For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. From 22c11cb243e797c3f6c4b119bd13082eea505cc5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 8 Oct 2024 21:01:53 +0900 Subject: [PATCH 43/95] update `q` tag params. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df1cc93..e03cb3b 100644 --- a/README.md +++ b/README.md @@ -263,7 +263,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | -| `q` | event id (hex) | relay URL | [18](18.md) | +| `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | [24](24.md), [34](34.md) | From 79cc2ef215cc1fe1edb804f0bee010644bc14445 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 10 Oct 2024 00:28:12 +0900 Subject: [PATCH 44/95] add NIP-55 change. --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 83b104b..aba5b83 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | | 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc | | 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [NIP-45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted | | 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated | From 30f39d35d18f49adc86c483c34b232560772d75c Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 11 Oct 2024 07:29:54 -0300 Subject: [PATCH 45/95] Change return field from signature to result --- 55.md | 68 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/55.md b/55.md index d78bc8c..54dc44a 100644 --- a/55.md +++ b/55.md @@ -53,8 +53,8 @@ val launcher = rememberLauncherForActivityResult( Toast.LENGTH_SHORT ).show() } else { - val signature = activityResult.data?.getStringExtra("signature") - // Do something with signature ... + val result = activityResult.data?.getStringExtra("result") + // Do something with result ... } } ) @@ -101,10 +101,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **pubkey** in the signature field + - If the user approved intent it will return the **pubkey** in the result field ```kotlin - val pubkey = intent.data?.getStringExtra("signature") + val pubkey = intent.data?.getStringExtra("result") // The package name of the signer application val packageName = intent.data?.getStringExtra("package") ``` @@ -124,10 +124,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature**, **id** and **event** fields + - If the user approved intent it will return the **result**, **id** and **event** fields ```kotlin - val signature = intent.data?.getStringExtra("signature") + val signature = intent.data?.getStringExtra("result") // The id you sent val id = intent.data?.getStringExtra("id") val signedEventJson = intent.data?.getStringExtra("event") @@ -150,10 +150,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val encryptedText = intent.data?.getStringExtra("signature") + val encryptedText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -200,10 +200,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val plainText = intent.data?.getStringExtra("signature") + val plainText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -225,10 +225,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val plainText = intent.data?.getStringExtra("signature") + val plainText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -248,10 +248,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val relayJsonText = intent.data?.getStringExtra("signature") + val relayJsonText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -270,10 +270,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val eventJson = intent.data?.getStringExtra("signature") + val eventJson = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -284,9 +284,9 @@ To get the result back from Signer Application you should use contentResolver.qu If the user did not check the "remember my choice" option, the pubkey is not in Signer Application or the signer type is not recognized the `contentResolver` will return null -For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json +For the SIGN_EVENT type Signer Application returns two columns "result" and "event". The column event is the signed event json -For the other types Signer Application returns the column "signature" +For the other types Signer Application returns the column "result" If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application @@ -305,13 +305,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **pubkey** in the signature column + - Will return the **pubkey** in the result column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") if (index < 0) return val pubkey = it.getString(index) } @@ -330,13 +330,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** and the **event** columns + - Will return the **result** and the **event** columns ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val indexJson = it.getColumnIndex("event") val signature = it.getString(index) val eventJson = it.getString(indexJson) @@ -356,13 +356,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -380,13 +380,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -404,13 +404,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -428,13 +428,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -452,13 +452,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val relayJsonText = it.getString(index) } ``` @@ -476,13 +476,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val eventJson = it.getString(index) } ``` From e3cf02840d382360a604a7506e1b9608c63c4002 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Mon, 21 Oct 2024 13:45:51 -0300 Subject: [PATCH 46/95] rename "claim"=>"code", get rid of kind 9006 (just use 9000), add a paragraph explaining moderation. --- 29.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/29.md b/29.md index c0dbcef..c4ee495 100644 --- a/29.md +++ b/29.md @@ -42,6 +42,14 @@ This is a hack to prevent messages from being broadcasted to external relays tha Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay. +## Group management + +Groups can have any number of users with elevated access. These users are identified by role labels which are arbitrarily defined by the relays (see also the description of `kind:39003`). What each role is capable of not defined in this NIP either, it's a relay policy that can vary. Roles can be assigned by other users (as long as they have the capability to add roles) by publishing a `kind:9000` event with that user's pubkey in a `p` tag and the roles afterwards (even if the user is already a group member a `kind:9000` can be issued and the user roles must just be updated). + +The roles supported by the group as to having some special privilege assigned to them should be accessible on the event `kind:39003`, but the relay may also accept other role names, arbitrarily defined by clients, and just not do anything with them. + +Users with any roles that have any privilege can be considered _admins_ in a broad sense and be returned in the `kind:39001` event for a group. + ## Unmanaged groups Unmanaged groups are impromptu groups that can be used in any public relay unaware of NIP-29 specifics. They piggyback on relays' natural white/blacklists (or lack of) but aside from that are not actively managed and won't have any admins, group state or metadata events. @@ -117,12 +125,12 @@ Any user can send one of these events to the relay in order to be automatically "content": "optional reason", "tags": [ ["h", "<group-id>"], - ["claim", "<optional-invite-code>"] + ["code", "<optional-invite-code>"] ] } ``` -The optional `claim` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. +The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. - *leave request* (`kind:9022`) @@ -161,13 +169,10 @@ Each moderation action uses a different kind and requires different arguments, w | kind | name | tags | | --- | --- | --- | -| 9000 | `add-user` | `p` with pubkey hex | +| 9000 | `add-user` | `p` with pubkey hex and optional roles | | 9001 | `remove-user` | `p` with pubkey hex | | 9002 | `edit-metadata` | fields from `kind:39000` to be modified | -| 9003 | | | -| 9004 | | | | 9005 | `delete-event` | | -| 9006 | `set-role` | `p` with pubkey hex and roles | | 9007 | `create-group` | | | 9008 | `delete-group` | | From d4d040ee715a1f742a19e2c3a9e8697387725e46 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 22 Oct 2024 09:55:42 -0300 Subject: [PATCH 47/95] fix typo. --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index c4ee495..80e0f96 100644 --- a/29.md +++ b/29.md @@ -113,7 +113,7 @@ Groups may also accept other events, like long-form articles, calendar, livestre ### User-related group management events -These are events that can be sent my user to manage their situation in a group, they also require the `h` tag. +These are events that can be sent by users to manage their situation in a group, they also require the `h` tag. - *join request* (`kind:9021`) From e3afd7ac5b72c20fe209edf3ea84cd986d0bd4ef Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 23 Oct 2024 23:56:13 +0900 Subject: [PATCH 48/95] update related to NIP-71. --- BREAKING.md | 2 ++ README.md | 1 - 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index aba5b83..b4bd53d 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,8 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag | +| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped | | 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | | 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc | | 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [NIP-45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted | diff --git a/README.md b/README.md index 9566dff..2ef5629 100644 --- a/README.md +++ b/README.md @@ -208,7 +208,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31990` | Handler information | [89](89.md) | | `34235` | Video Event | [71](71.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) | -| `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | From ba46b23d95b186c9a8fedabf8324af2ae40e8ce4 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez <p@f7z.io> Date: Fri, 25 Oct 2024 17:54:49 +0100 Subject: [PATCH 49/95] Cashu wallet + Nutzaps (#1369) --- 60.md | 205 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 61.md | 132 +++++++++++++++++++++++++++++++++++ README.md | 9 +++ 3 files changed, 346 insertions(+) create mode 100644 60.md create mode 100644 61.md diff --git a/60.md b/60.md new file mode 100644 index 0000000..2f24841 --- /dev/null +++ b/60.md @@ -0,0 +1,205 @@ +# NIP-60 +## Cashu Wallet +`draft` `optional` + +This NIP defines the operations of a cashu-based wallet. + +A cashu wallet is a wallet which information is stored in relays to make it accessible across applications. + +The purpose of this NIP is: +* ease-of-use: new users immediately are able to receive funds without creating accounts with other services. +* interoperability: users' wallets follows them across applications. + +This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. + +# High-level flow +1. A user has a `kind:37375` event that represents a wallet. +2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. +3. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional. + +## Wallet Event +```jsonc +{ + "kind": 37375, + "content": nip44_encrypt([ + [ "balance", "100", "sat" ], + [ "privkey", "hexkey" ] // explained in NIP-61 + ]), + "tags": [ + [ "d", "my-wallet" ], + [ "mint", "https://mint1" ], + [ "mint", "https://mint2" ], + [ "mint", "https://mint3" ], + [ "name", "my shitposting wallet" ], + [ "unit", "sat" ], + [ "description", "a wallet for my day-to-day shitposting" ], + [ "relay", "wss://relay1" ], + [ "relay", "wss://relay2" ], + ] +} +``` + +The wallet event is a parameterized replaceable event `kind:37375`. + +Tags: +* `d` - wallet ID. +* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. +* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [[NIP-65]]. +* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). +* `name` - Optional human-readable name for the wallet. +* `description` - Optional human-readable description of the wallet. +* `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs. +* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's nostr private key** -- This is only used when receiving funds from others, described in NIP-61. + +Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. + +### Deleting a wallet event +Due to PRE being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. + +## Token Event +Token events are used to record the unspent proofs that come from the mint. + +There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. + +```jsonc +{ + "kind": 7375, + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { + "id": "005c2502034d4f12", + "amount": 1, + "secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=", + "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" + } + ] + }), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` + +`.content` is a [[NIP-44]] encrypted payload storing the mint and the unencoded proofs. +* `a` an optional tag linking the token to a specific wallet. + +### Spending proofs +When one or more proofs of a token are spent, the token event should be [[NIP-09]]-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event. + +## Spending History Event +Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. + +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "in" ], // in = received, out = sent + [ "amount", "1", "sat" ], + [ "e", "<event-id-of-spent-token>", "<relay-hint>", "created" ], + ]), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ], + ] +} +``` + +* `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. +* `a` - The wallet the transaction is related to. + +Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: +* `created` - A new token event was created. +* `destroyed` - A token event was destroyed. +* `redeemed` - A [[NIP-61]] nutzap was redeemed. + +All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. + +Multiple `e` tags can be added to a `kind:7376` event. + +# Flow +A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [[NIP-65]] relays. + +## Fetch wallet and token list +From those relays, the client should fetch wallet and token events. + +`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]` + +## Fetch proofs +While the client is fetching (and perhaps validating) proofs it can use the optional `balance` tag of the wallet event to display a estimate of the balance of the wallet. + +## Spending token +If Alice spends 4 sats from this token event +```jsonconc +{ + "kind": 7375, + "id": "event-id-1", + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { "id": "1", "amount": 1 }, + { "id": "2", "amount": 2 }, + { "id": "3", "amount": 4 }, + { "id": "4", "amount": 8 }, + ] + }), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` + +Her client: +* MUST roll over the unspent proofs: +```jsonconc +{ + "kind": 7375, + "id": "event-id-2", + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { "id": "1", "amount": 1 }, + { "id": "2", "amount": 2 }, + { "id": "8", "amount": 8 }, + ] + }), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` +* MUST delete event `event-id-1` +* SHOULD create a `kind:7376` event to record the spend +```jsonconc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "out" ], + [ "amount", "4", "sats" ], + [ "e", "<event-id-1>", "<relay-hint>", "destroyed" ], + [ "e", "<event-id-2>", "<relay-hint>", "created" ], + ]), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ], + ] +} +``` + +## Redeeming a quote (optional) +When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [[NIP-40]] matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. + +Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. + +```jsonc +{ + "kind": 7374, + "content": nip44_encrypt("quote-id"), + "tags": [ + [ "expiration", "<expiration-timestamp>" ], + [ "mint", "<mint-url>" ], + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` + +## Appendix 1: Validating proofs +Clients can optionally validate proofs to make sure they are not working from an old state; this logic is left up to particular implementations to decide when and why to do it, but if some proofs are checked and deemed to have been spent, the client should delete the token and roll over any unspent proof. diff --git a/61.md b/61.md new file mode 100644 index 0000000..33442a3 --- /dev/null +++ b/61.md @@ -0,0 +1,132 @@ +# NIP-61: +## Nut Zaps + +A Nut Zap is a P2PK cashu token where the payment itself is the receipt. + +# High-level flow +Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. + +## Alice nutzaps Bob +1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. +2. She mints a token at that mint (or swaps some tokens she already had in that mint) p2pk-locked to the pubkey Bob has listed in his `kind:10019`. +3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. + +## Bob receives the nutzap +1. At some point, Bob's client fetches `kind:9321` events p-tagging him from his relays. +2. Bob's client swaps the token into his wallet. + +# Nutzap informational event +```jsonc +{ + "kind": 10019, + "tags": [ + [ "relay", "wss://relay1" ], + [ "relay", "wss://relay2" ], + [ "mint", "https://mint1", "usd", "sat" ], + [ "mint", "https://mint2", "sat" ], + [ "pubkey", "<p2pk-pubkey>" ] + ] +} +``` + +`kind:10019` is an event that is useful for others to know how to send money to the user. + +* `relay` - Relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays. +* `mint` - Mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint. +* `pubkey` - Pubkey that SHOULD be used to P2PK-lock receiving nutzaps. If not present, clients SHOULD use the pubkey of the recipient. This is explained in Appendix 1. + +## Nutzap event +Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the pubkey the recipient indicated in their `kind:10019` event or to the recipient pubkey if the `kind:10019` event doesn't have a explicit pubkey. + +Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility). + +```jsonc +{ + kind: 9321, + content: "Thanks for this great idea.", + pubkey: "sender-pubkey", + tags: [ + [ "amount", "1" ], + [ "unit", "sat" ], + [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], + [ "u", "https://stablenut.umint.cash", ], + [ "e", "<zapped-event-id>", "<relay-hint>" ], + [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap + ] +} +``` + +* `.content` is an optional comment for the nutzap +* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches. +* `unit` is the base unit of the amount. +* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event. +* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. +* `e` zero or one event that is being nutzapped. +* `p` exactly one pubkey, specifying the recipient of the nutzap. + +WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint. + +# Sending a nutzap + +* The sender fetches the recipient's `kind:10019`. +* The sender mints/swaps ecash on one of the recipient's listed mints. +* The sender p2pk locks to the recipient's specified pubkey in their + +# Receiving nutzaps + +Clients should REQ for nut zaps: +* Filtering with `#u` for mints they expect to receive ecash from. + * this is to prevent even interacting with mints the user hasn't explicitly signaled. +* Filtering with `since` of the most recent `kind:7376` event the same user has created. + * this can be used as a marker of the nut zaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach. + +Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam. + +`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. + +Upon receiving a new nut zap, the client should swap the tokens into a wallet the user controls, either a [[NIP-60]] wallet, their own LN wallet or anything else. + +## Updating nutzap-redemption history +When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nut zap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed. + +Multiple `kind:9321` events can be tagged in the same `kind:7376` event. + +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "in" ], // in = received, out = sent + [ "amount", "1", "sat" ], + [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created + ]), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag + [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed + [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender) + ] +} +``` + +Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays. + +## Verifying a Cashu Zap +* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. +* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`. + +## Final Considerations + +1. Clients SHOULD guide their users to use NUT-11 (P2PK) compatible-mints in their `kind:10019` event to avoid receiving nut zaps anyone can spend + +2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. + +3. A nut zap MUST be sent to a mint the recipient has listed in their `kind:10019` event or to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event. + +## Appendix 1: Alternative P2PK pubkey +Clients might not have access to the user's private key (i.e. NIP-07, NIP-46 signing) and, as such, the private key to sign cashu spends might not be available, which would make spending the P2PK incoming nutzaps impossible. + +For this scenarios clients can: + +* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to) +* store the private key in the `kind:37375` event in the nip44-encrypted `content` field. + +This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. \ No newline at end of file diff --git a/README.md b/README.md index 2ef5629..ed5d753 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-59: Gift Wrap](59.md) +- [NIP-60: Cashu Wallet](60.md) +- [NIP-61: Nutzaps](61.md) +- [NIP-64: Chess (PGN)](64.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-70: Protected Events](70.md) @@ -140,8 +143,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `5000`-`5999` | Job Request | [90](90.md) | | `6000`-`6999` | Job Result | [90](90.md) | | `7000` | Job Feedback | [90](90.md) | +| `7374` | Reserved Cashu Wallet Tokens | [60](60.md) | +| `7375` | Cashu Wallet Tokens | [60](60.md) | +| `7376` | Cashu Wallet History | [60](60.md) | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | +| `9321` | Nutzap | [61](61.md) | | `9467` | Tidal login | [Tidal-nostr] | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | @@ -156,6 +163,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | | `10015` | Interests list | [51](51.md) | +| `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10063` | User server list | [Blossom][blossom] | @@ -209,6 +217,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34235` | Video Event | [71](71.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | +| `37375` | Cashu Wallet Event | [60](60.md) | | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ From dde8c81a87f01131ed2eec0dd653cd5b79900b82 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 26 Oct 2024 23:34:37 +0900 Subject: [PATCH 50/95] remove duplicate NIP-64 from list. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ed5d753..400f1ec 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-60: Cashu Wallet](60.md) - [NIP-61: Nutzaps](61.md) - [NIP-64: Chess (PGN)](64.md) -- [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) From f21aa981d4960dae858ce1da87b553598c5010e0 Mon Sep 17 00:00:00 2001 From: ilcompratoreconsapevole <ilcompratoreconsapevole@gmail.com> Date: Sun, 27 Oct 2024 22:56:40 +0100 Subject: [PATCH 51/95] Changed 'id value' at row 162 --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 2f24841..64cd282 100644 --- a/60.md +++ b/60.md @@ -159,7 +159,7 @@ Her client: "proofs": [ { "id": "1", "amount": 1 }, { "id": "2", "amount": 2 }, - { "id": "8", "amount": 8 }, + { "id": "4", "amount": 8 }, ] }), "tags": [ From 66c5cc637f118add2d2cade2210d21da7e25917b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sun, 27 Oct 2024 19:43:43 -0400 Subject: [PATCH 52/95] Instagram feeds --- 68.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 68.md diff --git a/68.md b/68.md new file mode 100644 index 0000000..22509e0 --- /dev/null +++ b/68.md @@ -0,0 +1,70 @@ +NIP-68 +====== + +Picture-first feeds +------------------- + +`draft` `optional` + +This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags + +Unlike a `kind 1` event with a pircture attached, Picture events are meant to contain all additional metadata concerning the subject media and to be surfaced in picture-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Instagram/Flickr/Snapshat/9gag like nostr client where the picture itself is at the center of the experience. + +## Picture Events + +Picture events contain a `title` tag and description in the `.content`. + +They may contain multiple images to be displayed as a single post. + +```jsonc +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <Unix timestamp in seconds>, + "kind": 20, + "content": "<description of post>", + "tags": [ + ["title", "<short title of post>"], + + // Picture Data + [ + "imeta", + "url https://nostr.build/i/my-image.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt A scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt1.jpg", + "fallback https://void.cat/alt1.jpg" + ], + [ + "imeta", + "url https://nostr.build/i/my-image2.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt Another scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt2.jpg", + "fallback https://void.cat/alt2.jpg", + + "annotate-user <32-bytes hex of a pubkey>:<posX>:<posY>" // Tag users in specific locations in the picture + ], + + ["content-warning", "<reason>"], // if NSFW + + // Tagged users + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // Hashtags + ["t", "<tag>"], + ["t", "<tag>"], + ] +} +``` + +The `imeta` tag `annotate-user` places a user link in the specific position in the image. + +Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. \ No newline at end of file From 9517ac6f5dfac58bd7237777680c557bd518dc84 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sun, 27 Oct 2024 20:30:27 -0400 Subject: [PATCH 53/95] Enforces certain media types --- 68.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/68.md b/68.md index 22509e0..dcc56f1 100644 --- a/68.md +++ b/68.md @@ -58,6 +58,9 @@ They may contain multiple images to be displayed as a single post. ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + // Specify the media type for filters to allow clients to filter by supported kinds + ["m", "image/jpeg"] + // Hashtags ["t", "<tag>"], ["t", "<tag>"], @@ -67,4 +70,12 @@ They may contain multiple images to be displayed as a single post. The `imeta` tag `annotate-user` places a user link in the specific position in the image. +Only the following media types are accepted: +- `image/apng`: Animated Portable Network Graphics (APNG) +- `image/avif`: AV1 Image File Format (AVIF) +- `image/gif`: Graphics Interchange Format (GIF) +- `image/jpeg`: Joint Photographic Expert Group image (JPEG) +- `image/png`: Portable Network Graphics (PNG) +- `image/webp`: Web Picture format (WEBP) + Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. \ No newline at end of file From 5c7aad212ea44605d64e360be89ea5a1d843a3f8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 28 Oct 2024 15:51:54 -0400 Subject: [PATCH 54/95] Adds language tag for images that contain text. --- 68.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/68.md b/68.md index dcc56f1..0ba4459 100644 --- a/68.md +++ b/68.md @@ -64,6 +64,10 @@ They may contain multiple images to be displayed as a single post. // Hashtags ["t", "<tag>"], ["t", "<tag>"], + + // When text is written in the image, add the tag to represent the language + ["L", "ISO-639-1"], + ["l", "en", "ISO-639-1"] ] } ``` From f1e8d2c4f764d66996c0c1fb2eeabfbc0c7b2528 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 24 Oct 2024 20:59:15 -0300 Subject: [PATCH 55/95] nip46: remove words, introduce distinction between bunker key and user key. --- 46.md | 85 +++++++++++++++++++++++++++-------------------------------- 1 file changed, 39 insertions(+), 46 deletions(-) diff --git a/46.md b/46.md index e1675b0..c356a9c 100644 --- a/46.md +++ b/46.md @@ -4,6 +4,10 @@ NIP-46 Nostr Remote Signing -------------------- +## Changes + +`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect. + ## Rationale Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface. @@ -12,51 +16,53 @@ This NIP describes a method for 2-way communication between a remote signer and ## Terminology -- **Local keypair**: A local public and private key-pair used to encrypt content and communicate with the remote signer. Usually created by the client application. -- **Remote user pubkey**: The public key that the user wants to sign as. The remote signer has control of the private key that matches this public key. -- **Remote signer pubkey**: This is the public key of the remote signer itself. This is needed in both `create_account` command because you don't yet have a remote user pubkey. +- **user**: A person that is trying to use Nostr. +- **client**: A user-facing application that _user_ is looking at and clicking buttons in. This application will send requests to _remote-signer_. +- **remote-signer**: A daemon or server running somewhere that will answer requests from _client_, also known as "bunker". +- **client-keypair/pubkey**: The keys generated by _client_. Used to encrypt content and communicate with _remote-signer_. +- **remote-signer-keypair/pubkey**: The keys used by _remote-signer_ to encrypt content and communicate with _client_. This keypair MAY be same as _user-keypair_, but not necessarily. +- **user-keypair/pubkey**: The actual keys representing _user_ (that will be used to sign events in response to `sign_event` requests, for example). The _remote-signer_ generally has control over these keys. All pubkeys specified in this NIP are in hex format. ## Initiating a connection -To initiate a connection between a client and a remote signer there are a few different options. +There are two ways to initiate a connection: -### Direct connection initiated by remote signer +### Direct connection initiated by _remote-signer_ -This is most common in a situation where you have your own nsecbunker or other type of remote signer and want to connect through a client that supports remote signing. - -The remote signer would provide a connection token in the form: +_remote-signer_ provides connection token in the form: ``` -bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> +bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old optional secret. +_user_ pastes this token on _client_, which then uses the details to connect to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old optional secret. ### Direct connection initiated by the client -In this case, basically the opposite direction of the first case, the client provides a connection token (or encodes the token in a QR code) and the signer initiates a connection to the client via the specified relay(s). +In this case, basically the opposite direction of the first case, _client_ provides a connection token (or encodes the token in a QR code) and _remote-signer_ initiates a connection via the specified relays. ``` -nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> +nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> ``` ## The flow -1. Client creates a local keypair. This keypair doesn't need to be communicated to the user since it's largely disposable (i.e. the user doesn't need to see this pubkey). Clients might choose to store it locally and they should delete it when the user logs out. -2. Client gets the remote user pubkey (either via a `bunker://` connection string or a NIP-05 login-flow; shown below) -3. Clients use the local keypair to send requests to the remote signer by `p`-tagging and encrypting to the remote user pubkey. -4. The remote signer responds to the client by `p`-tagging and encrypting to the local keypair pubkey. +1. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout; +2. _client_ gets `remote-signer-pubkey` (either via a `bunker://` connection string or a NIP-05 login-flow; shown below); +3. _client_ use `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; +4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. ### Example flow for signing an event -- Remote user pubkey (e.g. signing as) `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` -- Local pubkey is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` +- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` #### Signature request -```json +```js { "kind": 24133, "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", @@ -70,13 +76,13 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata created_at: 1714078911 }>)] }), - "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey + "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey } ``` #### Response event -```json +```js { "kind": 24133, "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", @@ -84,7 +90,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata "id": <random_string>, "result": json_stringified(<signed-event>) }), - "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the local keypair pubkey + "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey } ``` @@ -94,20 +100,18 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata ## Request Events `kind: 24133` -```jsonc +```js { - "id": <id>, "kind": 24133, "pubkey": <local_keypair_pubkey>, "content": <nip04(<request>)>, - "tags": [["p", <remote_user_pubkey>]], // NB: in the `create_account` event, the remote signer pubkey should be `p` tagged. - "created_at": <unix timestamp in seconds> + "tags": [["p", <remote-signer-pubkey>]], } ``` The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: -```json +```jsonc { "id": <random_string>, "method": <method_name>, @@ -125,15 +129,16 @@ Each of the following are methods that the client sends to the remote signer. | Command | Params | Result | | ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | +| `connect` | `[<user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | | `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | | `ping` | `[]` | "pong" | | `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | -| `get_public_key` | `[]` | `<hex-pubkey>` | +| `get_public_key` | `[]` | `<user-pubkey>` | | `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | | `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | | `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | | `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | +| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_user_pubkey>` | ### Requested permissions @@ -145,9 +150,9 @@ The `connect` method may be provided with `optional_requested_permissions` for u { "id": <id>, "kind": 24133, - "pubkey": <remote_signer_pubkey>, + "pubkey": <remote-signer-pubkey>, "content": <nip04(<response>)>, - "tags": [["p", <local_keypair_pubkey>]], + "tags": [["p", <client-pubkey>]], "created_at": <unix timestamp in seconds> } ``` @@ -184,18 +189,6 @@ Clients should display (in a popup or new tab) the URL from the `error` field an ![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png) -## Remote Signer Commands - -Remote signers might support additional commands when communicating directly with it. These commands follow the same flow as noted above, the only difference is that when the client sends a request event, the `p`-tag is the pubkey of the remote signer itself and the `content` payload is encrypted to the same remote signer pubkey. - -### Methods/Commands - -Each of the following are methods that the client sends to the remote signer. - -| Command | Params | Result | -| ---------------- | ------------------------------------------ | ------------------------------------ | -| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` | - ## Appendix ### NIP-05 Login Flow @@ -204,7 +197,7 @@ Clients might choose to present a more familiar login flow, so users can type a When the user types a NIP-05 the client: -- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the **remote user pubkey**) +- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the `user-pubkey`) - In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on. - Now the client has enough information to send commands to the remote signer on behalf of the user. @@ -216,9 +209,9 @@ In this last case, most often used to facilitate an OAuth-like signin flow, the First the client will query for `kind: 31990` events that have a `k` tag of `24133`. -These are generally shown to a user, and once the user selects which remote signer to use and provides the remote user pubkey they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the remote signer that is actually managing the remote key that they would like to use in this case. If the remote user pubkey is managed on another remote signer, the connection will fail. +These are generally shown to a user, and once the user selects which remote signer to use and provides the `user-pubkey` they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the _remote-signer_ that is actually managing the `user-keypair` that they would like to use in this case. If the `user-pubkey` is managed on another _remote-signer_ the connection will fail. -In addition, it's important that clients validate that the pubkey of the announced remote signer matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain. +In addition, it's important that clients validate that the pubkey of the announced _remote-signer_ matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain. Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username. From 82291c6afda8498ac6f4ddb1d14289f9edb8f8ae Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 30 Oct 2024 11:50:21 -0400 Subject: [PATCH 56/95] adds location --- 68.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/68.md b/68.md index 0ba4459..8a87848 100644 --- a/68.md +++ b/68.md @@ -65,6 +65,10 @@ They may contain multiple images to be displayed as a single post. ["t", "<tag>"], ["t", "<tag>"], + // location + ["location", "<location>"], // city name, state, country + ["g", "<geohash>"], + // When text is written in the image, add the tag to represent the language ["L", "ISO-639-1"], ["l", "en", "ISO-639-1"] From c0568fe8cc31961fbfc783805af8942060b455e2 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 31 Oct 2024 10:09:43 -0700 Subject: [PATCH 57/95] Add explicit support for address quotes --- 18.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/18.md b/18.md index 41c9442..448171f 100644 --- a/18.md +++ b/18.md @@ -30,6 +30,11 @@ of the `mark` argument. `["q", <event-id>, <relay-url>, <pubkey>]` +When quoting an event by address, `q` tags should follow conventions for `a` tags, +as described in [NIP 01](./01.md). + +`["q", <event-address>, <relay-url>]` + Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the event in the content. From 5bcb2d834a8533ae657606a42d91169661e06369 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 1 Nov 2024 08:22:50 +0900 Subject: [PATCH 58/95] Revert "Merge pull request #1558 from coracle-social/quote-a" This reverts commit 4aa46562eb6d2abc6127fa8c2c9f3da7a098e2f6, reversing changes made to 8e2523e331cbcc7f7247590497a0db607c45cf80. --- 18.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/18.md b/18.md index 448171f..41c9442 100644 --- a/18.md +++ b/18.md @@ -30,11 +30,6 @@ of the `mark` argument. `["q", <event-id>, <relay-url>, <pubkey>]` -When quoting an event by address, `q` tags should follow conventions for `a` tags, -as described in [NIP 01](./01.md). - -`["q", <event-address>, <relay-url>]` - Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the event in the content. From 061d2ac47d79819e0efa938f231f2511ac40b419 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 1 Nov 2024 08:03:10 -0300 Subject: [PATCH 59/95] Add intent flags --- 55.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/55.md b/55.md index 54dc44a..1f7972b 100644 --- a/55.md +++ b/55.md @@ -72,6 +72,12 @@ Set the Signer package name: intent.`package` = "com.example.signer" ``` +If you are sending multiple intents without awaiting you can add some intent flags to sign all events without opening multiple times the signer + +```kotlin +intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP) +``` + Send the Intent: ```kotlin From 93e6c3880beb3818b47d22c07fd11aa5f1356c41 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 1 Nov 2024 08:16:06 -0300 Subject: [PATCH 60/95] Add launchMode for signers --- 55.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/55.md b/55.md index 1f7972b..005e4f9 100644 --- a/55.md +++ b/55.md @@ -78,6 +78,12 @@ If you are sending multiple intents without awaiting you can add some intent fla intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP) ``` +If you are developing a signer application them you need to add this to your AndroidManifest.xml so clients can use the intent flags above + +```kotlin +android:launchMode="singleTop" +``` + Send the Intent: ```kotlin From 03a555beb58296bef326f6469bbcf2b73ea144f6 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 1 Nov 2024 08:24:52 -0300 Subject: [PATCH 61/95] Add result from multiple intents --- 55.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/55.md b/55.md index 005e4f9..afca0aa 100644 --- a/55.md +++ b/55.md @@ -84,6 +84,23 @@ If you are developing a signer application them you need to add this to your And android:launchMode="singleTop" ``` +Signer MUST answer multiple permissions with an array of results + +```kotlin + +val results = listOf( + Result( + package = signerPackageName, + result = eventSignture, + id = intentId + ) +) + +val json = results.toJson() + +intent.putExtra("results", json) +``` + Send the Intent: ```kotlin From 087437042be0dac04a5fce9ea243b6babd31fb63 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sun, 3 Nov 2024 22:33:48 +0100 Subject: [PATCH 62/95] Remove extra backticks in code blocks and change unnecessary gender-specific pronouns to be gender neutral --- 05.md | 4 ++-- 53.md | 2 +- 57.md | 2 +- 59.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/05.md b/05.md index ca6da7b..b914344 100644 --- a/05.md +++ b/05.md @@ -33,7 +33,7 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" } } -```` +``` or with the **recommended** `"relays"` attribute: @@ -46,7 +46,7 @@ or with the **recommended** `"relays"` attribute: "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ] } } -```` +``` If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed. diff --git a/53.md b/53.md index ee12fef..c3f15ea 100644 --- a/53.md +++ b/53.md @@ -119,4 +119,4 @@ Common use cases include meeting rooms/workshops, watch-together activities, or "content": "Zaps to live streams is beautiful.", "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" } -```` +``` diff --git a/57.md b/57.md index b533811..3f55e57 100644 --- a/57.md +++ b/57.md @@ -66,7 +66,7 @@ A signed `zap request` event is not published, but is instead sent using a HTTP - `nostr` is the `9734` `zap request` event, JSON encoded then URI encoded - `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl` -This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize his zap. Here is an example flow in javascript: +This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize their zap. Here is an example flow in javascript: ```javascript const senderPubkey // The sender's pubkey diff --git a/59.md b/59.md index a4fc99d..9bb5845 100644 --- a/59.md +++ b/59.md @@ -245,7 +245,7 @@ const rumor = createRumor( const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey) const wrap = createWrap(seal, recipientPublicKey) -// Recipient unwraps with his/her private key. +// Recipient unwraps with their private key. const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey) const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey) From f72a2f69ed93cf442e83bf9e7e16f6c06da40384 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Mon, 4 Nov 2024 11:27:17 -0300 Subject: [PATCH 63/95] Add NIP number and update README --- xx.md => 100.md | 71 +++++++++++++++++++++++-------------------------- README.md | 2 ++ 2 files changed, 36 insertions(+), 37 deletions(-) rename xx.md => 100.md (69%) diff --git a/xx.md b/100.md similarity index 69% rename from xx.md rename to 100.md index 0543e68..8a7aac5 100644 --- a/xx.md +++ b/100.md @@ -1,4 +1,4 @@ -# NIP-XX +# NIP-100 ## Peer-to-peer Order events @@ -12,44 +12,40 @@ This NIP defines a simple standard for peer-to-peer order events, which enables ## The event -Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: +Events are [addressable events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: ```json -[ - "EVENT", - "RAND", - { - "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", - "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", - "created_at": 1702548701, - "kind": 38383, - "tags": [ - ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], - ["k", "sell"], - ["f", "VES"], - ["s", "pending"], - ["amt", "0"], - ["fa", "100"], - ["pm", "face to face", "bank transfer"], - ["premium", "1"], - [ - "rating", - "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" - ], - ["source", "https://t.me/p2plightning/xxxxxxx"], - ["network", "mainnet"], - ["layer", "lightning"], - ["name", "Nakamoto"], - ["g", "<geohash>"], - ["bond", "0"], - ["expiration", "1719391096"], - ["y", "lnp2pbot"], - ["z", "order"] +{ + "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", + "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", + "created_at": 1702548701, + "kind": 38383, + "tags": [ + ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], + ["k", "sell"], + ["f", "VES"], + ["s", "pending"], + ["amt", "0"], + ["fa", "100"], + ["pm", "face to face", "bank transfer"], + ["premium", "1"], + [ + "rating", + "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" ], - "content": "", - "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" - } -] + ["source", "https://t.me/p2plightning/xxxxxxx"], + ["network", "mainnet"], + ["layer", "lightning"], + ["name", "Nakamoto"], + ["g", "<geohash>"], + ["bond", "0"], + ["expiration", "1719391096"], + ["y", "lnp2pbot"], + ["z", "order"] + ], + "content": "", + "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" +} ``` ## Tags @@ -81,9 +77,10 @@ Currently implemented on the following platforms: - [Mostro](https://github.com/MostroP2P/mostro) - [@lnp2pBot](https://github.com/lnp2pBot/bot) +- [Robosats](https://github.com/RoboSats/robosats/pull/1362) ## References -- [Mostro messages specification](https://mostro.network/messages/) +- [Mostro protocol specification](https://mostro.network/protocol/) - [Messages specification for peer 2 peer NIP proposal](https://github.com/nostr-protocol/nips/blob/8250274a22f4882f621510df0054fd6167c10c9e/31001.md) - [n3xB](https://github.com/nobu-maeda/n3xb) diff --git a/README.md b/README.md index 02773a5..2d7f71f 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-100: Peer-to-peer Order events](100.md) ## Event Kinds | kind | description | NIP | @@ -193,6 +194,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | +| `38383` | Peer-to-peer Order events | [100](100.md) | | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 From bff61dd310828758651389940dbcebb7fb9ef0ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Mon, 4 Nov 2024 16:38:09 -0300 Subject: [PATCH 64/95] Changes NIP number --- 100.md => 69.md | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) rename 100.md => 69.md (99%) diff --git a/100.md b/69.md similarity index 99% rename from 100.md rename to 69.md index 8a7aac5..330d6e5 100644 --- a/100.md +++ b/69.md @@ -1,4 +1,4 @@ -# NIP-100 +# NIP-69 ## Peer-to-peer Order events diff --git a/README.md b/README.md index 7c19bd5..32fbd78 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-61: Nutzaps](61.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-69: Peer-to-peer Order events](69.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) - [NIP-72: Moderated Communities](72.md) @@ -91,7 +92,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-100: Peer-to-peer Order events](100.md) ## Event Kinds @@ -218,7 +218,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | | `37375` | Cashu Wallet Event | [60](60.md) | -| `38383` | Peer-to-peer Order events | [100](100.md) | +| `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ From 4c0f9632925eb0ffe94453e45a7bed77c0ab1e6b Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:34:24 -0600 Subject: [PATCH 65/95] Update 11.md with banner, and icon fields (#1555) * Update 11.md with banner field Added banner relay metadata field. If nostr relay management is not to be relegated to PhD or protocol developers only, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay. * Update 11.md with icon added icon field * Update 11.md updated banner language * Update 11.md updated icon link examples updated icon link examples * Update 11.md grammar * Update 11.md remove .ICO format removed .ICO format * Update 11.md - moved, and merged icon examples Moved up previous Icon section, and removed overlapping/duplication of icon example link content. --- 11.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/11.md b/11.md index 0ca5870..8efd0f0 100644 --- a/11.md +++ b/11.md @@ -14,6 +14,8 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application { "name": <string identifying relay>, "description": <string with detailed information>, + "banner": <a link to an image (e.g. in .jpg, or .png format)>, + "icon": <a link to an icon (e.g. in .jpg, or .png format>, "pubkey": <administrative contact pubkey>, "contact": <administrative alternate contact>, "supported_nips": <a list of NIP numbers supported by the relay>, @@ -35,6 +37,21 @@ A relay may select a `name` for use in client software. This is a string, and S Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. +### Banner + +To make nostr relay management more user friendly, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay, complementing the text `Description`. [Here is an example banner](https://image.nostr.build/232ddf6846e8aea5a61abcd70f9222ab521f711aa545b7ab02e430248fa3a249.png) mockup as visualized in Damus iOS relay view of the Damus relay. + +### Icon + +Icon is a compact visual representation of the relay for use in UI with limited real estate such as a nostr user's relay list view. Below is an example URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. + +```jsonc +{ + "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", + // other fields... +} +``` + ### Pubkey An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. @@ -257,17 +274,6 @@ Relays that require payments may want to expose their fee schedules. } ``` -### Icon - -A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. - -```jsonc -{ - "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", - // other fields... -} -``` - ### Examples As of 2 May 2023 the following command provided these results: From ec8eb9af0b43e42e974877f539940894e84f4847 Mon Sep 17 00:00:00 2001 From: arthurfranca <arthur.a.franca@gmail.com> Date: Thu, 7 Nov 2024 10:41:00 -0300 Subject: [PATCH 66/95] NIP-22 - Comment (#1233) Co-authored-by: dluvian <133484344+dluvian@users.noreply.github.com> Co-authored-by: Vitor Pamplona <vitor@vitorpamplona.com> --- 22.md | 184 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 184 insertions(+) create mode 100644 22.md diff --git a/22.md b/22.md new file mode 100644 index 0000000..3706aec --- /dev/null +++ b/22.md @@ -0,0 +1,184 @@ +NIP-22 +====== + +Comment +------- + +`draft` `optional` + +A comment is a threading note always scoped to a root event or an `I`-tag. + +It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting). + +Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`) +and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`). + +```js +{ + kind: 1111, + content: '<comment>', + tags: [ + // root scope: event addresses, event ids, or I-tags. + ["<A, E, I>", "<address, id or I-value>", "<relay or web page hint>", "<root event's pubkey, if an E tag>"], + // the root item kind + ["K", "<root kind>"], + + // parent item: event addresses, event ids, or i-tags. + ["<a, e, i>", "<address, id or i-value>", "<relay or web page hint>", "<parent event's pubkey, if an e tag>"], + // parent item kind + ["k", "<parent comment kind>"] + ] + // other fields +} +``` + +Tags `K` and `k` MUST be present to define the event kind of the root and the parent items. + +`I` and `i` tags create scopes for hashtags, geohashes, URLs, and other external identifiers. + +The possible values for `i` tags – and `k` tags, when related to an extenal identity – are listed on [NIP-73](73.md). +Their uppercase versions use the same type of values but relate to the root item instead of the parent one. + +`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). + +```json +["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"] +``` + +`p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md). +If the parent item is an event, a `p` tag set to the parent event's author SHOULD be added. + +```json +["p", "<pubkey>", "<relay-url>"] +``` + +## Examples + +A comment on a blog post looks like this: + +```js +{ + kind: 1111, + content: 'Great blog post!', + tags: [ + // top-level comments scope to event addresses or ids + ["A", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], + // the root kind + ["K", "30023"], + + // the parent event address (same as root for top-level comments) + ["a", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], + // when the parent event is replaceable or addressable, also include an `e` tag referencing its id + ["e", "5b4fc7fed15672fefe65d2426f67197b71ccc82aa0cc8a9e94f683eb78e07651", "wss://example.relay"], + // the parent event kind + ["k", "30023"] + ] + // other fields +} +``` + +A comment on a [NIP-94](94.md) file looks like this: + +```js +{ + kind: 1111, + content: 'Great file!', + tags: [ + // top-level comments have the same scope and reply to addresses or ids + ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], + // the root kind + ["K", "1063"], + + // the parent event id (same as root for top-level comments) + ["e", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], + // the parent kind + ["k", "1063"] + ] + // other fields +} +``` + +A reply to a comment looks like this: + +```js +{ + kind: 1111, + content: 'This is a reply to "Great file!"', + tags: [ + // nip-94 file event id + ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], + // the root kind + ["K", "1063"], + + // the parent event + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://example.relay", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"], + // the parent kind + ["k", "1111"] + ] + // other fields +} +``` + +A comment on a website's url looks like this: + +```js +{ + kind: 1111, + content: 'Nice article!', + tags: [ + // referencing the root url + ["I", "https://abc.com/articles/1"], + // the root "kind": for an url, the kind is its domain + ["K", "https://abc.com"], + + // the parent reference (same as root for top-level comments) + ["i", "https://abc.com/articles/1"], + // the parent "kind": for an url, the kind is its domain + ["k", "https://abc.com"] + ] + // other fields +} +``` + +A podcast comment example: + +```js +{ + id: "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", + pubkey: "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111", + kind: 1111, + content: "This was a great episode!", + tags: [ + // podcast episode reference + ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"], + // podcast episode type + ["K", "podcast:item:guid"], + + // same value as "I" tag above, because it is a top-level comment (not a reply to a comment) + ["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"], + ["k", "podcast:item:guid"] + ] + // other fields +} +``` + +A reply to a podcast comment: + +```js +{ + kind: 1111, + content: "I'm replying to the above comment.", + tags: [ + // podcast episode reference + ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"], + // podcast episode type + ["K", "podcast:item:guid"], + + // this is a reference to the above comment + ["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"], + // the parent comment kind + ["k", "1111"] + ] + // other fields +} +``` From 690e1b065ca789b04edce220d23bf6e39f6891bd Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 6 Nov 2024 22:40:46 +0900 Subject: [PATCH 67/95] nip29: add kind 9009 to moderation events table. --- 29.md | 1 + 1 file changed, 1 insertion(+) diff --git a/29.md b/29.md index 80e0f96..885dae4 100644 --- a/29.md +++ b/29.md @@ -175,6 +175,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9005 | `delete-event` | | | 9007 | `create-group` | | | 9008 | `delete-group` | | +| 9009 | `create-invite` | | It's expected that the group state (of who is an allowed member or not, who is an admin and with which permission or not, what are the group name and picture etc) can be fully reconstructed from the canonical sequence of these events. From b0840be3124ee04abadc68155d71dbd6abaa6bde Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 8 Nov 2024 09:45:19 +0900 Subject: [PATCH 68/95] add NIP-22 to index. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 32fbd78..fc53a0a 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-21: `nostr:` URI scheme](21.md) +- [NIP-22: Comment](22.md) - [NIP-23: Long-form Content](23.md) - [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) From 29696eb364d8a0cd609efa85b450c174c5806eda Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 08:53:01 -0300 Subject: [PATCH 69/95] rename kind:11 as "forum thread root". --- 29.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/29.md b/29.md index 885dae4..ed57e51 100644 --- a/29.md +++ b/29.md @@ -66,9 +66,9 @@ These are the events expected to be found in NIP-29 groups. These events generally can be sent by all members of a group and they require the `h` tag to be present so they're attached to a specific group. -- *text root note* (`kind:11`) +- *thread root post* (`kind:11`) -This is the basic unit of a "microblog" root text note sent to a group. +This is the basic unit of a forum-like root thread post sent to a group. ```jsonc "kind": 11, From 39154346bb691191a1fc734e53d5eda08a1eec79 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 08:56:29 -0300 Subject: [PATCH 70/95] remove kind:10 and note that kind:1111 could be used. --- 29.md | 41 ++++++++++++++--------------------------- 1 file changed, 14 insertions(+), 27 deletions(-) diff --git a/29.md b/29.md index ed57e51..b02cad2 100644 --- a/29.md +++ b/29.md @@ -66,28 +66,7 @@ These are the events expected to be found in NIP-29 groups. These events generally can be sent by all members of a group and they require the `h` tag to be present so they're attached to a specific group. -- *thread root post* (`kind:11`) - -This is the basic unit of a forum-like root thread post sent to a group. - -```jsonc - "kind": 11, - "content": "hello my friends lovers of pizza", - "tags": [ - ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] - ] - // other fields... -``` - -- *threaded text reply* (`kind:12`) - -This is the basic unit of a "microblog" reply note sent to a group. It's the same as `kind:11`, except for the fact that it must be used whenever it's in reply to some other note (either in reply to a `kind:11` or a `kind:12`). `kind:12` events SHOULD use NIP-10 markers, leaving an empty relay url: - -* `["e", "<kind-11-root-id>", "", "root"]` -* `["e", "<kind-12-event-id>", "", "reply"]` - -- *chat message* (`kind:9`) +- _chat message_ (`kind:9`) This is the basic unit of a _chat message_ sent to a group. @@ -101,15 +80,23 @@ This is the basic unit of a _chat message_ sent to a group. // other fields... ``` -- *chat message threaded reply* (`kind:10`) +- _thread root post_ (`kind:11`) -Similar to `kind:12`, this is the basic unit of a chat message sent to a group. This is intended for in-chat threads that may be hidden by default. Not all in-chat replies MUST use `kind:10`, only when the intention is to create a hidden thread that isn't part of the normal flow of the chat (although clients are free to display those by default too). +This is the basic unit of a forum-like root thread post sent to a group. -`kind:10` SHOULD use NIP-10 markers, just like `kind:12`. +```jsonc + "kind": 11, + "content": "hello my friends lovers of pizza", + "tags": [ + ["h", "<group-id>"], + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] + ] + // other fields... +``` -- other events: +- _other events_: -Groups may also accept other events, like long-form articles, calendar, livestream, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. +Groups may also accept other events, like [NIP-22](22.md) comments as threaded replies to both chats messages and threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. ### User-related group management events From b58f02925e7ea05e9f104041cb6e42d146ab4c54 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 08:56:43 -0300 Subject: [PATCH 71/95] rename kind:9000 to "put-user" instead of "add-user". --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index b02cad2..5526b74 100644 --- a/29.md +++ b/29.md @@ -156,7 +156,7 @@ Each moderation action uses a different kind and requires different arguments, w | kind | name | tags | | --- | --- | --- | -| 9000 | `add-user` | `p` with pubkey hex and optional roles | +| 9000 | `put-user` | `p` with pubkey hex and optional roles | | 9001 | `remove-user` | `p` with pubkey hex | | 9002 | `edit-metadata` | fields from `kind:39000` to be modified | | 9005 | `delete-event` | | From b79e46d33cdbe275080a0cb6c7db8e84c685bdb4 Mon Sep 17 00:00:00 2001 From: laanwj <126646+laanwj@users.noreply.github.com> Date: Sat, 9 Nov 2024 14:34:29 +0100 Subject: [PATCH 72/95] readme: Add standardized tags for NIP-35 (torrents) (#1575) --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc53a0a..73e3f18 100644 --- a/README.md +++ b/README.md @@ -268,7 +268,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `-` | -- | -- | [70](70.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | -| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | +| `i` | external identity | proof, url hint | [35](35.md), [39](39.md), [73](73.md) | | `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | @@ -276,7 +276,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | [24](24.md), [34](34.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) | +| `x` | infohash | -- | [35](35.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -289,6 +290,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `emoji` | shortcode, image URL | -- | [30](30.md) | | `encrypted` | -- | -- | [90](90.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `file` | full path (string) | -- | [35](35.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | @@ -307,6 +309,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | +| `tracker` | torrent tracker URL | -- | [35](35.md) | | `web` | webpage URL | -- | [34](34.md) | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | From 18bdc0ce8c80b68cd8e2c30c0dfd12c43e8b8bc0 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 15:41:25 -0300 Subject: [PATCH 73/95] nip29: add missing "e" tag in kind:9005. --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index 5526b74..e4673dd 100644 --- a/29.md +++ b/29.md @@ -159,7 +159,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9000 | `put-user` | `p` with pubkey hex and optional roles | | 9001 | `remove-user` | `p` with pubkey hex | | 9002 | `edit-metadata` | fields from `kind:39000` to be modified | -| 9005 | `delete-event` | | +| 9005 | `delete-event` | `e` with event id hex | | 9007 | `create-group` | | | 9008 | `delete-group` | | | 9009 | `create-invite` | | From b8a5447e264333f1fb009fce9ea631c3d1009db9 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sat, 9 Nov 2024 15:37:10 -0500 Subject: [PATCH 74/95] adds missing single letter tags --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 73e3f18..9bc2599 100644 --- a/README.md +++ b/README.md @@ -261,23 +261,32 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | -| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | +| `A` | root address | relay URL | [22](22.md) | | `d` | identifier | -- | [01](01.md) | -| `-` | -- | -- | [70](70.md) | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | +| `E` | root event i | relay URL | [22](22.md) | +| `f` | currency code | -- | [69](69.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | | `i` | external identity | proof, url hint | [35](35.md), [39](39.md), [73](73.md) | +| `I` | root external identity | -- | [22](22.md) | | `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | +| `K` | root scope | -- | [22](22.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | +| `s` | status | -- | [69](69.md) | | `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) | +| `u` | url | -- | [61](61.md), [98](98.md) | | `x` | infohash | -- | [35](35.md) | +| `y` | platform | -- | [69](69.md) | +| `z` | order number | -- | [69](69.md) | +| `-` | -- | -- | [70](70.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | From 926a51e72206dfa71b9950a0ce58b54a7422aad2 Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Tue, 12 Nov 2024 01:35:42 +0100 Subject: [PATCH 75/95] Nip46 upgrade part2: remove nip05 and create_account, clarify nostrconnect, cleanup, add nip05 signer metadata (#1553) --- 46.md | 173 ++++++++++++++++++++++++++++------------------------------ 1 file changed, 83 insertions(+), 90 deletions(-) diff --git a/46.md b/46.md index c356a9c..60850aa 100644 --- a/46.md +++ b/46.md @@ -6,7 +6,7 @@ Nostr Remote Signing ## Changes -`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect. +`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect, nip05 login is removed, create_account moved to another NIP. ## Rationale @@ -25,6 +25,14 @@ This NIP describes a method for 2-way communication between a remote signer and All pubkeys specified in this NIP are in hex format. +## Overview + +1. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout; +2. A connection is established (see below), _remote-signer_ learns `client-pubkey`, _client_ learns `remote-signer-pubkey`. +3. _client_ uses `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; +4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. +5. _client_ requests `get_public_key` to learn `user-pubkey`. + ## Initiating a connection There are two ways to initiate a connection: @@ -37,66 +45,16 @@ _remote-signer_ provides connection token in the form: bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -_user_ pastes this token on _client_, which then uses the details to connect to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old optional secret. +_user_ passes this token to _client_, which then sends `connect` request to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old secret. -### Direct connection initiated by the client +### Direct connection initiated by the _client_ -In this case, basically the opposite direction of the first case, _client_ provides a connection token (or encodes the token in a QR code) and _remote-signer_ initiates a connection via the specified relays. +_client_ provides a connection token in the form: ``` -nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> +nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata: {"name":"...", "url": "...", "description": "...", "perms": "..."}>&secret=<required-secret-value> ``` - -## The flow - -1. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout; -2. _client_ gets `remote-signer-pubkey` (either via a `bunker://` connection string or a NIP-05 login-flow; shown below); -3. _client_ use `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; -4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. - -### Example flow for signing an event - -- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` -- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` -- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` - -#### Signature request - -```js -{ - "kind": 24133, - "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", - "content": nip04({ - "id": <random_string>, - "method": "sign_event", - "params": [json_stringified(<{ - content: "Hello, I'm signing remotely", - kind: 1, - tags: [], - created_at: 1714078911 - }>)] - }), - "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey -} -``` - -#### Response event - -```js -{ - "kind": 24133, - "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - "content": nip04({ - "id": <random_string>, - "result": json_stringified(<signed-event>) - }), - "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey -} -``` - -#### Diagram - -![signing-example](https://i.nostr.build/P3gW.png) +_user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response. ## Request Events `kind: 24133` @@ -125,11 +83,11 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted ### Methods/Commands -Each of the following are methods that the client sends to the remote signer. +Each of the following are methods that the _client_ sends to the _remote-signer_. | Command | Params | Result | | ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | +| `connect` | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" OR `<required-secret-value>` | | `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | | `ping` | `[]` | "pong" | | `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | @@ -138,11 +96,10 @@ Each of the following are methods that the client sends to the remote signer. | `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | | `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | | `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | -| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_user_pubkey>` | ### Requested permissions -The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. +The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. ## Response Events `kind:24133` @@ -171,9 +128,54 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted - `results` is a string of the result of the call (this can be either a string or a JSON stringified object) - `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request. -### Auth Challenges +## Example flow for signing an event -An Auth Challenge is a response that a remote signer can send back when it needs the user to authenticate via other means. This is currently used in the OAuth-like flow enabled by signers like [Nsecbunker](https://github.com/kind-0/nsecbunkerd/). The response `content` object will take the following form: +- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` + +### Signature request + +```js +{ + "kind": 24133, + "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", + "content": nip04({ + "id": <random_string>, + "method": "sign_event", + "params": [json_stringified(<{ + content: "Hello, I'm signing remotely", + kind: 1, + tags: [], + created_at: 1714078911 + }>)] + }), + "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey +} +``` + +### Response event + +```js +{ + "kind": 24133, + "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", + "content": nip04({ + "id": <random_string>, + "result": json_stringified(<signed-event>) + }), + "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey +} +``` + +### Diagram + +![signing-example](https://i.nostr.build/P3gW.png) + + +## Auth Challenges + +An Auth Challenge is a response that a _remote-signer_ can send back when it needs the _user_ to authenticate via other means. The response `content` object will take the following form: ```json { @@ -183,42 +185,33 @@ An Auth Challenge is a response that a remote signer can send back when it needs } ``` -Clients should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the remote signer (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). It's also possible to add a `redirect_uri` url parameter to the auth_url, which is helpful in situations when a client cannot open a new window or tab to display the auth challenge. +_client_ should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the _remote-signer_ (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). -#### Example event signing request with auth challenge +### Example event signing request with auth challenge ![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png) ## Appendix -### NIP-05 Login Flow +### Announcing _remote-signer_ metadata -Clients might choose to present a more familiar login flow, so users can type a NIP-05 address instead of a `bunker://` string. +_remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this: +``` +{ + "names":{ + "_": <remote-signer-app-pubkey>, + }, + "nip46": { + "relays": ["wss://relay1","wss://relay2"...], + "nostrconnect_url": "https://remote-signer-domain.com/<nostrconnect>" + } +} +``` -When the user types a NIP-05 the client: +The `<remote-signer-app-pubkey>` MAY be used to verify the domain from _remote-signer_'s NIP-89 event (see below). `relays` SHOULD be used to construct a more precise `nostrconnect://` string for the specific `remote-signer`. `nostrconnect_url` template MAY be used to redirect users to _remote-signer_'s connection flow by replacing `<nostrconnect>` placeholder with an actual `nostrconnect://` string. -- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the `user-pubkey`) -- In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on. -- Now the client has enough information to send commands to the remote signer on behalf of the user. +### Remote signer discovery via NIP-89 -### OAuth-like Flow +_remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above. -#### Remote signer discovery via NIP-89 - -In this last case, most often used to facilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events. - -First the client will query for `kind: 31990` events that have a `k` tag of `24133`. - -These are generally shown to a user, and once the user selects which remote signer to use and provides the `user-pubkey` they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the _remote-signer_ that is actually managing the `user-keypair` that they would like to use in this case. If the `user-pubkey` is managed on another _remote-signer_ the connection will fail. - -In addition, it's important that clients validate that the pubkey of the announced _remote-signer_ matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain. - -Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username. - -#### Example Oauth-like flow to create a new user account with Nsecbunker - -Coming soon... - -## References - -- [NIP-04 - Encryption](04.md) +_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`. From 3e540a38e2da3e4ce93f50b2fb6f9009721db10d Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 14 Nov 2024 22:43:44 +0900 Subject: [PATCH 76/95] update kinds table. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bc2599..ffda69c 100644 --- a/README.md +++ b/README.md @@ -108,9 +108,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | | `9` | Group Chat Message | [29](29.md) | -| `10` | Group Chat Threaded Reply | [29](29.md) | +| `10` | Group Chat Threaded Reply | 29 (deprecated) | | `11` | Group Thread | [29](29.md) | -| `12` | Group Thread Reply | [29](29.md) | +| `12` | Group Thread Reply | 29 (deprecated) | | `13` | Seal | [59](59.md) | | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | @@ -127,6 +127,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | +| `1111` | Comment | [22](22.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | From 8f112857a256f2a6af943a28d45f30b363d1627a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 15 Nov 2024 08:34:58 +0900 Subject: [PATCH 77/95] fix typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ffda69c..cbd45cf 100644 --- a/README.md +++ b/README.md @@ -266,7 +266,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `A` | root address | relay URL | [22](22.md) | | `d` | identifier | -- | [01](01.md) | | `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `E` | root event i | relay URL | [22](22.md) | +| `E` | root event id | relay URL | [22](22.md) | | `f` | currency code | -- | [69](69.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | From eca0a83d097e274bc1c4b416315b5f2e924f7e02 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 14 Nov 2024 16:53:33 -0500 Subject: [PATCH 78/95] Moves deprecated stuff to the bottom --- 10.md | 57 ++++++++++++++++++++++++++++++--------------------------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/10.md b/10.md index 94db4fa..c1d5068 100644 --- a/10.md +++ b/10.md @@ -10,33 +10,6 @@ On "e" and "p" tags in Text Events (kind 1) ## Abstract This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. -## Positional "e" tags (DEPRECATED) ->This scheme is in common use; but should be considered deprecated. - -`["e", <event-id>, <relay-url>]` as per NIP-01. - -Where: - - * `<event-id>` is the id of the event being referenced. - * `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. - -**The positions of the "e" tags within the event denote specific meanings as follows**: - - * No "e" tag: <br> - This event is not a reply to, nor does it refer to, any other event. - - * One "e" tag: <br> - `["e", <id>]`: The id of the event to which this event is a reply. - - * Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br> - `<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply. - - * Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br> -There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain. -They are citing from this event. `root-id` and `reply-id` are as above. - ->This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. - ## Marked "e" tags (PREFERRED) `["e", <event-id>, <relay-url>, <marker>, <pubkey>]` @@ -62,3 +35,33 @@ When replying to a text event E the reply event's "p" tags should contain all of Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] in no particular order. + +## Deprecated Positional "e" tags + +This scheme is not in common use anymore and is here just to keep backward compatibility with older events on the network. + +Positional `e` tags are deprecated because they create ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. + +They use simple `e` tags without any marker. + +`["e", <event-id>, <relay-url>]` as per NIP-01. + +Where: + + * `<event-id>` is the id of the event being referenced. + * `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. + +**The positions of the "e" tags within the event denote specific meanings as follows**: + + * No "e" tag: <br> + This event is not a reply to, nor does it refer to, any other event. + + * One "e" tag: <br> + `["e", <id>]`: The id of the event to which this event is a reply. + + * Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br> + `<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply. + + * Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br> +There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain. +They are citing from this event. `root-id` and `reply-id` are as above. \ No newline at end of file From a8dfdff753a30f0845d6b9729cdbae3ad37a3f8e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 15 Nov 2024 08:15:30 -0500 Subject: [PATCH 79/95] Adds x tag to index by sha256 Co-authored-by: Pablo Fernandez <pfer@me.com> --- 68.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/68.md b/68.md index 8a87848..2950712 100644 --- a/68.md +++ b/68.md @@ -59,7 +59,8 @@ They may contain multiple images to be displayed as a single post. ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], // Specify the media type for filters to allow clients to filter by supported kinds - ["m", "image/jpeg"] + ["m", "image/jpeg"], + ["x", "<sha256>"] // Hashtags ["t", "<tag>"], From dfd2c2b8ca86821485f9bbcd3b1397e211c294e5 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 15 Nov 2024 08:28:54 -0500 Subject: [PATCH 80/95] Minor changes to simplify the text --- 68.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/68.md b/68.md index 2950712..6c1e7d2 100644 --- a/68.md +++ b/68.md @@ -6,9 +6,9 @@ Picture-first feeds `draft` `optional` -This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags +This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags. -Unlike a `kind 1` event with a pircture attached, Picture events are meant to contain all additional metadata concerning the subject media and to be surfaced in picture-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Instagram/Flickr/Snapshat/9gag like nostr client where the picture itself is at the center of the experience. +The idea is for this type of event to cater to Nostr clients resembling platforms like Instagram, Flickr, Snapchat, or 9GAG, where the picture itself takes center stage in the user experience. ## Picture Events @@ -60,6 +60,8 @@ They may contain multiple images to be displayed as a single post. // Specify the media type for filters to allow clients to filter by supported kinds ["m", "image/jpeg"], + + // Hashes of each image to make them queryable ["x", "<sha256>"] // Hashtags @@ -87,4 +89,4 @@ Only the following media types are accepted: - `image/png`: Portable Network Graphics (PNG) - `image/webp`: Web Picture format (WEBP) -Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. \ No newline at end of file +Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. From 8794be6775a6264a82ed8044b14f3c5e4eb01122 Mon Sep 17 00:00:00 2001 From: Josh Brown <josh@roadfiresoftware.com> Date: Fri, 15 Nov 2024 11:14:19 -0500 Subject: [PATCH 81/95] Fix typo in NIP-29 --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index e4673dd..f0ba8ab 100644 --- a/29.md +++ b/29.md @@ -26,7 +26,7 @@ Group identifiers must be strings restricted to the characters `a-z0-9-_`. When encountering just the `<host>` without the `'<group-id>`, clients can choose to connect to the group with id `_`, which is a special top-level group dedicated to relay-local discussions. -Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusiong and ensures they can be migrated or forked to other relays easily without risking conflicting with other groups using the same id in these new relays. This isn't a hard rule, as, for example, in `unmanaged` and/or ephemeral relays groups might not want to migrate ever, so they might not care about this. Notably, the `_` relay-local group isn't expected to be migrated ever. +Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusion and ensures they can be migrated or forked to other relays easily without risking conflicting with other groups using the same id in these new relays. This isn't a hard rule, as, for example, in `unmanaged` and/or ephemeral relays groups might not want to migrate ever, so they might not care about this. Notably, the `_` relay-local group isn't expected to be migrated ever. ## The `h` tag From 108b6314299f71540190a7abf37074787fa6d698 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= <haruta@s3-odara.net> Date: Sun, 17 Nov 2024 15:22:47 +0000 Subject: [PATCH 82/95] "user matadata" --- 05.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/05.md b/05.md index b914344..7e823fb 100644 --- a/05.md +++ b/05.md @@ -10,7 +10,7 @@ On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with a Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user's metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example From f3244a0903b1fedbd8aa89596c658c9529e19ea6 Mon Sep 17 00:00:00 2001 From: hakkadaikon <hakkadaikon@yahoo.co.jp> Date: Mon, 18 Nov 2024 02:33:29 +0900 Subject: [PATCH 83/95] js,json -> jsonc --- 11.md | 4 ++-- 17.md | 2 +- 22.md | 14 +++++++------- 29.md | 2 +- 46.md | 8 ++++---- 96.md | 4 ++-- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/11.md b/11.md index 8efd0f0..8af4f31 100644 --- a/11.md +++ b/11.md @@ -262,7 +262,7 @@ processed by appropriate client software. Relays that require payments may want to expose their fee schedules. -```json +```jsonc { "payments_url": "https://my-relay/payments", "fees": { @@ -270,7 +270,7 @@ Relays that require payments may want to expose their fee schedules. "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], }, - ... + // other fields... } ``` diff --git a/17.md b/17.md index 4b96bce..72f40c4 100644 --- a/17.md +++ b/17.md @@ -47,7 +47,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. -```js +```jsonc { "id": "<usual hash>",   "pubkey": randomPublicKey, diff --git a/22.md b/22.md index 3706aec..f11925f 100644 --- a/22.md +++ b/22.md @@ -13,7 +13,7 @@ It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other forma Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`) and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`). -```js +```jsonc { kind: 1111, content: '<comment>', @@ -56,7 +56,7 @@ If the parent item is an event, a `p` tag set to the parent event's author SHOUL A comment on a blog post looks like this: -```js +```jsonc { kind: 1111, content: 'Great blog post!', @@ -79,7 +79,7 @@ A comment on a blog post looks like this: A comment on a [NIP-94](94.md) file looks like this: -```js +```jsonc { kind: 1111, content: 'Great file!', @@ -100,7 +100,7 @@ A comment on a [NIP-94](94.md) file looks like this: A reply to a comment looks like this: -```js +```jsonc { kind: 1111, content: 'This is a reply to "Great file!"', @@ -121,7 +121,7 @@ A reply to a comment looks like this: A comment on a website's url looks like this: -```js +```jsonc { kind: 1111, content: 'Nice article!', @@ -142,7 +142,7 @@ A comment on a website's url looks like this: A podcast comment example: -```js +```jsonc { id: "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", pubkey: "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111", @@ -164,7 +164,7 @@ A podcast comment example: A reply to a podcast comment: -```js +```jsonc { kind: 1111, content: "I'm replying to the above comment.", diff --git a/29.md b/29.md index f0ba8ab..a116433 100644 --- a/29.md +++ b/29.md @@ -141,7 +141,7 @@ These are events expected to be sent by the relay master key or by group admins Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action based on its role and the relay's internal policy (see also the description of `kind:39003`). -```json +```jsonc { "kind": 90xx, "content": "optional reason", diff --git a/46.md b/46.md index 60850aa..ce6764d 100644 --- a/46.md +++ b/46.md @@ -58,7 +58,7 @@ _user_ passes this token to _remote-signer_, which then sends `connect` *respons ## Request Events `kind: 24133` -```js +```jsonc { "kind": 24133, "pubkey": <local_keypair_pubkey>, @@ -136,7 +136,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted ### Signature request -```js +```jsonc { "kind": 24133, "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", @@ -156,7 +156,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted ### Response event -```js +```jsonc { "kind": 24133, "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", @@ -196,7 +196,7 @@ _client_ should display (in a popup or new tab) the URL from the `error` field a ### Announcing _remote-signer_ metadata _remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this: -``` +```jsonc { "names":{ "_": <remote-signer-app-pubkey>, diff --git a/96.md b/96.md index 05c1b18..3828e76 100644 --- a/96.md +++ b/96.md @@ -323,8 +323,8 @@ Note: HTTP File Storage Server developers may skip this section. This is meant f A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants to upload files to. Servers are listed as `server` tags: -```json -{. +```jsonc +{ "kind": 10096, "content": "", "tags": [ From bbcea0c86175fd344132964345944d3479c3d4d0 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 19 Nov 2024 21:20:20 -0500 Subject: [PATCH 84/95] adds pronouns --- 24.md | 1 + 1 file changed, 1 insertion(+) diff --git a/24.md b/24.md index 1afa7c7..d65d9ce 100644 --- a/24.md +++ b/24.md @@ -17,6 +17,7 @@ These are extra fields not specified in NIP-01 that may be present in the string - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. + - `pronouns`: a string representing the preferred way to refer to this person. ### Deprecated fields From 1e47fd75572704b84cf484ce52394fc7ea7d4067 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 21 Nov 2024 06:55:23 -0800 Subject: [PATCH 85/95] Break out chat and threads from nip 29 (#1591) --- 29.md | 34 +--------------------------------- 7D.md | 34 ++++++++++++++++++++++++++++++++++ C7.md | 29 +++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+), 33 deletions(-) create mode 100644 7D.md create mode 100644 C7.md diff --git a/29.md b/29.md index a116433..a2c8ef2 100644 --- a/29.md +++ b/29.md @@ -64,39 +64,7 @@ These are the events expected to be found in NIP-29 groups. ### Normal user-created events -These events generally can be sent by all members of a group and they require the `h` tag to be present so they're attached to a specific group. - -- _chat message_ (`kind:9`) - -This is the basic unit of a _chat message_ sent to a group. - -```jsonc - "kind": 9, - "content": "hello my friends lovers of pizza", - "tags": [ - ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] - ] - // other fields... -``` - -- _thread root post_ (`kind:11`) - -This is the basic unit of a forum-like root thread post sent to a group. - -```jsonc - "kind": 11, - "content": "hello my friends lovers of pizza", - "tags": [ - ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] - ] - // other fields... -``` - -- _other events_: - -Groups may also accept other events, like [NIP-22](22.md) comments as threaded replies to both chats messages and threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. +Groups may accept any event kind, including chats, threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. ### User-related group management events diff --git a/7D.md b/7D.md new file mode 100644 index 0000000..d8509a6 --- /dev/null +++ b/7D.md @@ -0,0 +1,34 @@ +NIP-7D +====== + +Threads +------- + +`draft` `optional` + +A thread is a `kind 11` event. Threads SHOULD include a `subject` with a summary +of the thread's topic. + +```json +{ + "kind": 11, + "content": "Good morning", + "tags": [ + ["subject", "GM"] + ] +} +``` + +Replies to `kind 11` MUST use [NIP-22](./22.md) `kind 1111` comments. Replies should +always be to the root `kind 11` to avoid arbitrarily nested reply hierarchies. + +```json +{ + "kind": 1111, + "content": "Cool beans", + "tags": [ + ["K", "11"], + ["E", <event-id>, <relay-url>, <pubkey>] + ] +} +``` diff --git a/C7.md b/C7.md new file mode 100644 index 0000000..0d94f18 --- /dev/null +++ b/C7.md @@ -0,0 +1,29 @@ +NIP-C7 +====== + +Chats +----- + +`draft` `optional` + +A chat message is a `kind 9` event. + +```json +{ + "kind": 9, + "content": "GM", + "tags": [] +} +``` + +A reply to a `kind 9` is an additional `kind 9` which quotes the parent using a `q` tag. + +```json +{ + "kind": 9, + "content": "nostr:nevent1...\nyes", + "tags": [ + ["q", <event-id>, <relay-url>, <pubkey>] + ] +} +``` From 03c64a6e959ae91b727bcaea8198d08ee4860359 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 21 Nov 2024 12:11:13 -0300 Subject: [PATCH 86/95] nip24: revert improperly merged joke. this reverts https://github.com/nostr-protocol/nips/pull/1590 --- 24.md | 1 - 1 file changed, 1 deletion(-) diff --git a/24.md b/24.md index d65d9ce..1afa7c7 100644 --- a/24.md +++ b/24.md @@ -17,7 +17,6 @@ These are extra fields not specified in NIP-01 that may be present in the string - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. - - `pronouns`: a string representing the preferred way to refer to this person. ### Deprecated fields From ef1746dd2cea9ec5d62d00f16f0fd5695d895d0b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 21 Nov 2024 12:11:32 -0300 Subject: [PATCH 87/95] nip24: clarify nip purpose. --- 24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/24.md b/24.md index 1afa7c7..df3a932 100644 --- a/24.md +++ b/24.md @@ -6,7 +6,7 @@ Extra metadata fields and tags `draft` `optional` -This NIP defines extra optional fields added to events. +This NIP keeps track of extra optional fields that can added to events which are not defined anywhere else but have become _de facto_ standards and other minor implementation possibilities that do not deserve their own NIP and do not have a place in other NIPs. kind 0 ====== From 7976f8ab777a2bb6359ed64171309b4a0663bdf4 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 21 Nov 2024 08:48:32 -0800 Subject: [PATCH 88/95] Clarify nostrconnect metadata --- 46.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/46.md b/46.md index ce6764d..824059c 100644 --- a/46.md +++ b/46.md @@ -45,15 +45,25 @@ _remote-signer_ provides connection token in the form: bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -_user_ passes this token to _client_, which then sends `connect` request to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old secret. +_user_ passes this token to _client_, which then sends `connect` request to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old secret. ### Direct connection initiated by the _client_ -_client_ provides a connection token in the form: +_client_ provides a connection token using `nostrconnect://` as the protocol, and `client-pubkey` as the origin. Additional information should be passed as query parameters: + +- `relay` (required) - one or more relay urls on which the _client_ is listening for responses from the _remote-signer_. +- `secret` (required) - a short random string that the _remote-signer_ should return as the `result` field of its response. +- `perms` (optional) - a comma-separated list of permissions the _client_ is requesting be approved by the _remote-signer_ +- `name` (optional) - the name of the _client_ application +- `url` (optional) - the canonical url of the _client_ application +- `image` (optional) - a small image representing the _client_ application + +Here's an example: ``` -nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata: {"name":"...", "url": "...", "description": "...", "perms": "..."}>&secret=<required-secret-value> +nostrconnect://83f3b2ae6aa368e8275397b9c26cf550101d63ebaab900d19dd4a4429f5ad8f5?relay=wss%3A%2F%2Frelay1.example.com&perms=nip44_encrypt%2Cnip44_decrypt%2Csign_event%3A13%2Csign_event%3A14%2Csign_event%3A1059&name=My+Client&secret=0s8j2djs&relay=wss%3A%2F%2Frelay2.example2.com ``` + _user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response. ## Request Events `kind: 24133` From 43767e1e531de51874889b4eab905409192c404e Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Fri, 22 Nov 2024 13:55:23 -0800 Subject: [PATCH 89/95] Add support for naming unmanaged groups --- 29.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/29.md b/29.md index a2c8ef2..331047f 100644 --- a/29.md +++ b/29.md @@ -22,15 +22,15 @@ Relays are supposed to generate the events that describe group metadata and grou A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`. -Group identifiers must be strings restricted to the characters `a-z0-9-_`. +Group identifiers must be strings restricted to the characters `a-z0-9-_`, and SHOULD be random in order to avoid name collisions. -When encountering just the `<host>` without the `'<group-id>`, clients can choose to connect to the group with id `_`, which is a special top-level group dedicated to relay-local discussions. - -Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusion and ensures they can be migrated or forked to other relays easily without risking conflicting with other groups using the same id in these new relays. This isn't a hard rule, as, for example, in `unmanaged` and/or ephemeral relays groups might not want to migrate ever, so they might not care about this. Notably, the `_` relay-local group isn't expected to be migrated ever. +When encountering just the `<host>` without the `'<group-id>`, clients MAY infer `_` as the group id, which is a special top-level group dedicated to relay-local discussions. ## The `h` tag -Events sent by users to groups (chat messages, text notes, moderation events etc) must have an `h` tag with the value set to the group _id_. +Events sent by users to groups (chat messages, text notes, moderation events etc) MUST have an `h` tag with the value set to the group _id_. + +`h` tags MAY include the group's name as the second argument. This allows `unmanaged` groups to be assigned human-readable names without relay support. ## Timeline references @@ -241,4 +241,4 @@ A definition for `kind:10009` was included in [NIP-51](51.md) that allows client ### Using `unmanaged` relays -To prevent event leakage, replay and confusion, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays. +To prevent event leakage, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays. From 0e44178961b36909338d3dca37ed3cba4a41e7f6 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 26 Nov 2024 00:34:00 +0900 Subject: [PATCH 90/95] update related to NIP-29. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cbd45cf..5d1a47d 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-7D: Threads](7D.md) +- [NIP-C7: Chats](C7.md) ## Event Kinds @@ -107,9 +109,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | -| `9` | Group Chat Message | [29](29.md) | +| `9` | Chat Message | [C7](C7.md) | | `10` | Group Chat Threaded Reply | 29 (deprecated) | -| `11` | Group Thread | [29](29.md) | +| `11` | Thread | [7D](7D.md) | | `12` | Group Thread Reply | 29 (deprecated) | | `13` | Seal | [59](59.md) | | `14` | Direct Message | [17](17.md) | From 73f65133fcdcbf9f4d27cc7097963797c6250cd7 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 25 Nov 2024 13:21:47 -0300 Subject: [PATCH 91/95] add NIP-86: Relay Management API (#1325) Co-authored-by: Alex Gleason <alex@alexgleason.me> --- 86.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 91 insertions(+) create mode 100644 86.md diff --git a/86.md b/86.md new file mode 100644 index 0000000..6f64eee --- /dev/null +++ b/86.md @@ -0,0 +1,90 @@ +NIP-86 +====== + +Relay Management API +-------------------- + +`draft` `optional` + +Relays may provide an API for performing management tasks. This is made available as a JSON-RPC-like request-response protocol over HTTP, on the same URI as the relay's websocket. + +When a relay receives an HTTP(s) request with a `Content-Type` header of `application/nostr+json+rpc` to a URI supporting WebSocket upgrades, it should parse the request as a JSON document with the following fields: + +```json +{ + "method": "<method-name>", + "params": ["<array>", "<of>", "<parameters>"] +} +``` + +Then it should return a response in the format + +```json +{ + "result": {"<arbitrary>": "<value>"}, + "error": "<optional error message, if the call has errored>" +} +``` + +This is the list of **methods** that may be supported: + +* `supportedmethods`: + - params: `[]` + - result: `["<method-name>", "<method-name>", ...]` (an array with the names of all the other supported methods) +* `banpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listbannedpubkeys`: + - params: `[]` + - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `allowpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listallowedpubkeys`: + - params: `[]` + - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `listeventsneedingmoderation`: + - params: `[]` + - result: `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}]`, an array of objects +* `allowevent`: + - params: `["<32-byte-hex-event-id>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `banevent`: + - params: `["<32-byte-hex-event-id>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listbannedevents`: + - params: `[]` + - result: `[{"id": "<32-byte hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `changerelayname`: + - params: `["<new-name>"]` + - result: `true` (a boolean always set to `true`) +* `changerelaydescription`: + - params: `["<new-description>"]` + - result: `true` (a boolean always set to `true`) +* `changerelayicon`: + - params: `["<new-icon-url>"]` + - result: `true` (a boolean always set to `true`) +* `allowkind`: + - params: `[<kind-number>]` + - result: `true` (a boolean always set to `true`) +* `disallowkind`: + - params: `[<kind-number>]` + - result: `true` (a boolean always set to `true`) +* `listallowedkinds`: + - params: `[]` + - result: `[<kind-number>, ...]`, an array of numbers +* `blockip`: + - params: `["<ip-address>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `unblockip`: + - params: `["<ip-address>"]` + - result: `true` (a boolean always set to `true`) +* `listblockedips`: + - params: `[]` + - result: `[{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...]`, an array of objects + +### Authorization + +The request must contain an `Authorization` header with a valid [NIP-98](./98.md) event, except the `payload` tag is required. The `u` tag is the relay URL. + +If `Authorization` is not provided or is invalid, the endpoint should return a 401 response. diff --git a/README.md b/README.md index 5d1a47d..9ef9fec 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) +- [NIP-86: Relay Management API](86.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) From 64624a62eac4b2ee3e6b9da34c1aa77a33e20852 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Fri, 22 Nov 2024 13:58:49 -0800 Subject: [PATCH 92/95] Add r to kind 10009 --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index 3792d7f..4c0b1f4 100644 --- a/51.md +++ b/51.md @@ -29,7 +29,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL), `"r"` for each relay in use | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | From 821614aee1f0d7e6f618c5df6e626ea5981a906b Mon Sep 17 00:00:00 2001 From: Jesus Christ <120573631+Gudnessuche@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:43:00 +0000 Subject: [PATCH 93/95] multi_pay_invoice method Response error (grammatical) The response section that explained how the multi_pay_invoice method worked had a grammatical error of explaining the differentiation between requests. changed ".....contains an d tag" to "...contains a d tag" --- 47.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/47.md b/47.md index 71cd076..d1030a4 100644 --- a/47.md +++ b/47.md @@ -175,7 +175,7 @@ Request: Response: For every invoice in the request, a separate response event is sent. To differentiate between the responses, each -response event contains an `d` tag with the id of the invoice it is responding to, if no id was given, then the +response event contains a `d` tag with the id of the invoice it is responding to, if no id was given, then the payment hash of the invoice should be used. ```jsonc From 6acf1c780a3fb348c6e5684f9eef3e98ffb3d156 Mon Sep 17 00:00:00 2001 From: stl1988 <35177539+stl1988@users.noreply.github.com> Date: Wed, 27 Nov 2024 23:28:50 +0100 Subject: [PATCH 94/95] Update README.md Add NIP-68 to the list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9ef9fec..d362e6a 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-61: Nutzaps](61.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-68: Picture-first feeds](68.md) - [NIP-69: Peer-to-peer Order events](69.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) From aa2342bd9da9dcef382fbaf4c73060767b3eeab1 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 28 Nov 2024 20:24:01 +0900 Subject: [PATCH 95/95] Update BREAKING.md (#1615) --- BREAKING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index b4bd53d..c7ae2df 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,11 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [NIP-29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | NIP-05 login was removed | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `create_account` method was removed | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `connect` params and result were changed | +| 2024-10-29 | [f1e8d2c4](https://github.com/nostr-protocol/nips/commit/f1e8d2c4) | [NIP-46](46.md) | bunker URL should use `remote-signer-key` | | 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag | | 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped | | 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | @@ -60,4 +65,3 @@ Breaking changes prior to 2023-03-01 are not yet documented. - If it isn't clear that a change is breaking or not, we list it. - The date is the date it was merged, not necessarily the date of the commit. -