upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Staab <jstaab@protonmail.com>2023-05-12 05:10:45 -0700
committerGitHub <noreply@github.com>2023-05-12 05:10:45 -0700
commite5302f84c74cf42d878a3ed18257a16bc0d3b748 (patch)
treeb1a3ad9c0317bf7c38f34c500559b66ff7c0a22d
parent1c728516dfdc7508ce27eda222bde78466e3457d (diff)
parent4208652dc7a39c63c39559b13c656ec30400fcba (diff)
Merge branch 'master' into patch-1
-rw-r--r--01.md24
-rw-r--r--02.md3
-rw-r--r--03.md6
-rw-r--r--04.md16
-rw-r--r--06.md4
-rw-r--r--07.md11
-rw-r--r--08.md6
-rw-r--r--09.md2
-rw-r--r--10.md6
-rw-r--r--11.md242
-rw-r--r--13.md76
-rw-r--r--15.md215
-rw-r--r--16.md4
-rw-r--r--18.md12
-rw-r--r--19.md18
-rw-r--r--20.md2
-rw-r--r--21.md20
-rw-r--r--22.md16
-rw-r--r--23.md58
-rw-r--r--25.md4
-rw-r--r--26.md76
-rw-r--r--27.md54
-rw-r--r--28.md17
-rw-r--r--33.md25
-rw-r--r--39.md66
-rw-r--r--40.md2
-rw-r--r--42.md88
-rw-r--r--45.md39
-rw-r--r--46.md162
-rw-r--r--47.md137
-rw-r--r--50.md49
-rw-r--r--51.md112
-rw-r--r--56.md82
-rw-r--r--57.md183
-rw-r--r--58.md132
-rw-r--r--65.md76
-rw-r--r--78.md21
-rw-r--r--94.md51
-rw-r--r--README.md169
39 files changed, 2131 insertions, 155 deletions
diff --git a/01.md b/01.md
index d040666..e36f4f5 100644
--- a/01.md
+++ b/01.md
@@ -4,7 +4,7 @@ NIP-01
4Basic protocol flow description 4Basic protocol flow description
5------------------------------- 5-------------------------------
6 6
7`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` 7`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol`
8 8
9This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. 9This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here.
10 10
@@ -16,17 +16,17 @@ The only object type that exists is the `event`, which has the following format
16 16
17```json 17```json
18{ 18{
19 "id": <32-bytes sha256 of the the serialized event data> 19 "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>
20 "pubkey": <32-bytes hex-encoded public key of the event creator>, 20 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
21 "created_at": <unix timestamp in seconds>, 21 "created_at": <unix timestamp in seconds>,
22 "kind": <integer>, 22 "kind": <integer>,
23 "tags": [ 23 "tags": [
24 ["e", <32-bytes hex of the id of another event>, <recommended relay URL>], 24 ["e", <32-bytes hex of the id of another event>, <recommended relay URL>],
25 ["p", <32-bytes hex of the key>, <recommended relay URL>], 25 ["p", <32-bytes hex of a pubkey>, <recommended relay URL>],
26 ... // other kinds of tags may be included later 26 ... // other kinds of tags may be included later
27 ], 27 ],
28 "content": <arbitrary string>, 28 "content": <arbitrary string>,
29 "sig": <64-bytes signature of the sha256 hash of the serialized event data, which is the same as the "id" field> 29 "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field>
30} 30}
31``` 31```
32 32
@@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
55 * `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates. 55 * `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates.
56 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. 56 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions.
57 57
58`<subscription_id>` is a random string that should be used to represent a subscription. 58`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription.
59 59
60`<filters>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: 60`<filters>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes:
61 61
@@ -66,8 +66,8 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
66 "kinds": <a list of a kind numbers>, 66 "kinds": <a list of a kind numbers>,
67 "#e": <a list of event ids that are referenced in an "e" tag>, 67 "#e": <a list of event ids that are referenced in an "e" tag>,
68 "#p": <a list of pubkeys that are referenced in a "p" tag>, 68 "#p": <a list of pubkeys that are referenced in a "p" tag>,
69 "since": <a timestamp, events must be newer than this to pass>, 69 "since": <an integer unix timestamp, events must be newer than this to pass>,
70 "until": <a timestamp, events must be older than this to pass>, 70 "until": <an integer unix timestamp, events must be older than this to pass>,
71 "limit": <maximum number of events to be returned in the initial query> 71 "limit": <maximum number of events to be returned in the initial query>
72} 72}
73``` 73```
@@ -86,9 +86,10 @@ The `limit` property of a filter is only valid for the initial query and can be
86 86
87### From relay to client: sending events and notices 87### From relay to client: sending events and notices
88 88
89Relays can send 2 types of messages, which must also be JSON arrays, according to the following patterns: 89Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns:
90 90
91 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients. 91 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
92 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time.
92 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients. 93 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
93 94
94This NIP defines no rules for how `NOTICE` messages should be sent or treated. 95This NIP defines no rules for how `NOTICE` messages should be sent or treated.
@@ -98,7 +99,7 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated.
98## Basic Event Kinds 99## Basic Event Kinds
99 100
100 - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. 101 - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey.
101 - `1`: `text_note`: the `content` is set to the text content of a note (anything the user wants to say). Non-plaintext notes should instead use kind 1000-10000 as described in [NIP-16](16.md). 102 - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say). Do not use Markdown! Clients should not have to guess how to interpret content like `[]()`. Use different event kinds for parsable content.
102 - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. 103 - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers.
103 104
104A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. 105A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about.
@@ -106,5 +107,6 @@ A relay may choose to treat different message kinds differently, and it may or m
106## Other Notes: 107## Other Notes:
107 108
108- Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. 109- Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that.
109- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. 110- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](https://github.com/nostr-protocol/nips/blob/127d5518bfa9a4e4e7510490c0b8d95e342dfa4b/10.md) for a detailed description of "e" and "p" tags.
110- The `<recommended relay URL>` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. 111- The `<recommended relay URL>` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients.
112- Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events.
diff --git a/02.md b/02.md
index 624d33f..2f19908 100644
--- a/02.md
+++ b/02.md
@@ -22,6 +22,7 @@ For example:
22 ], 22 ],
23 "content": "", 23 "content": "",
24 ...other fields 24 ...other fields
25}
25``` 26```
26 27
27Every new contact list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past contact lists as soon as they receive a new one. 28Every new contact list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past contact lists as soon as they receive a new one.
@@ -38,7 +39,7 @@ A client may rely on the kind-3 event to display a list of followed people by pr
38 39
39### Relay sharing 40### Relay sharing
40 41
41A client may publish a full list of contacts with good relays for each of their contacts so other clients may use these to update their internal relay lists if needed, increasing censorship-resistant. 42A client may publish a full list of contacts with good relays for each of their contacts so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance.
42 43
43### Petname scheme 44### Petname scheme
44 45
diff --git a/03.md b/03.md
index 578c351..3c5d764 100644
--- a/03.md
+++ b/03.md
@@ -10,11 +10,11 @@ When there is an OTS available it MAY be included in the existing event body und
10 10
11``` 11```
12{ 12{
13 id: ..., 13 "id": ...,
14 kind: ..., 14 "kind": ...,
15 ..., 15 ...,
16 ..., 16 ...,
17 ots: <base64-encoded OTS file data> 17 "ots": <base64-encoded OTS file data>
18} 18}
19``` 19```
20 20
diff --git a/04.md b/04.md
index 723bd70..6e45b74 100644
--- a/04.md
+++ b/04.md
@@ -14,19 +14,21 @@ A special event with kind `4`, meaning "encrypted direct message". It is suppose
14 14
15**`tags`** MAY contain an entry identifying the previous message in a conversation or a message we are explicitly replying to (such that contextual, more organized conversations may happen), in the form `["e", "<event_id>"]`. 15**`tags`** MAY contain an entry identifying the previous message in a conversation or a message we are explicitly replying to (such that contextual, more organized conversations may happen), in the form `["e", "<event_id>"]`.
16 16
17**Note**: By default in the [libsecp256k1](https://github.com/bitcoin-core/secp256k1) ECDH implementation, the secret is the SHA256 hash of the shared point (both X and Y coordinates). In Nostr, only the X coordinate of the shared point is used as the secret and it is NOT hashed. If using libsecp256k1, a custom function that copies the X coordinate must be passed as the `hashfp` argument in `secp256k1_ecdh`. See [here](https://github.com/bitcoin-core/secp256k1/blob/master/src/modules/ecdh/main_impl.h#L29).
18
17Code sample for generating such an event in JavaScript: 19Code sample for generating such an event in JavaScript:
18 20
19```js 21```js
20import crypto from 'crypto' 22import crypto from 'crypto'
21import * as secp from 'noble-secp256k1' 23import * as secp from '@noble/secp256k1'
22 24
23let sharedPoint = secp.getSharedSecret(ourPrivateKey, '02' + theirPublicKey) 25let sharedPoint = secp.getSharedSecret(ourPrivateKey, '02' + theirPublicKey)
24let sharedX = sharedPoint.substr(2, 64) 26let sharedX = sharedPoint.slice(1, 33)
25 27
26let iv = crypto.randomFillSync(new Uint8Array(16)) 28let iv = crypto.randomFillSync(new Uint8Array(16))
27var cipher = crypto.createCipheriv( 29var cipher = crypto.createCipheriv(
28 'aes-256-cbc', 30 'aes-256-cbc',
29 Buffer.from(sharedX, 'hex'), 31 Buffer.from(sharedX),
30 iv 32 iv
31) 33)
32let encryptedMessage = cipher.update(text, 'utf8', 'base64') 34let encryptedMessage = cipher.update(text, 'utf8', 'base64')
@@ -41,3 +43,11 @@ let event = {
41 content: encryptedMessage + '?iv=' + ivBase64 43 content: encryptedMessage + '?iv=' + ivBase64
42} 44}
43``` 45```
46
47## Security Warning
48
49This standard does not go anywhere near what is considered the state-of-the-art in encrypted communication between peers, and it leaks metadata in the events, therefore it must not be used for anything you really need to keep secret, and only with relays that use `AUTH` to restrict who can fetch your `kind:4` events.
50
51## Client Implementation Warning
52
53Clients *should not* search and replace public key or note references from the `.content`. If processed like a regular text note (where `@npub...` is replaced with `#[0]` with a `["p", "..."]` tag) the tags are leaked and the mentioned user will receive the message in their inbox.
diff --git a/06.md b/06.md
index c1e66fe..4ae571f 100644
--- a/06.md
+++ b/06.md
@@ -8,8 +8,8 @@ Basic key derivation from mnemonic seed phrase
8 8
9[BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them. 9[BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them.
10 10
11[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/0'/0/0` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)). 11[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/<account>'/0/0` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)).
12 12
13This is the default for a basic, normal, single-key client. 13A basic client can simply use an `account` of `0` to derive a single key. For more advanced use-cases you can increment `account`, allowing generation of practically infinite keys from the 5-level path with hardened derivation.
14 14
15Other types of clients can still get fancy and use other derivation paths for their own other purposes. 15Other types of clients can still get fancy and use other derivation paths for their own other purposes.
diff --git a/07.md b/07.md
index 0bd3de6..3b7a1d2 100644
--- a/07.md
+++ b/07.md
@@ -12,7 +12,7 @@ That object must define the following methods:
12 12
13``` 13```
14async window.nostr.getPublicKey(): string // returns a public key as hex 14async window.nostr.getPublicKey(): string // returns a public key as hex
15async window.nostr.signEvent(event: Event): Event // takes an event object and returns it with the `sig` 15async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it
16``` 16```
17 17
18Aside from these two basic above, the following functions can also be implemented optionally: 18Aside from these two basic above, the following functions can also be implemented optionally:
@@ -24,6 +24,9 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext
24 24
25### Implementation 25### Implementation
26 26
27- [nos2x](https://github.com/fiatjaf/nos2x) is available as a Chromium extension that provides such capabilities. 27- [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives)
28- [Alby](https://getalby.com) is a Bitcoin extension that also provides a compatible `window.nostr`. 28- [nos2x](https://github.com/fiatjaf/nos2x) (Chrome and derivatives)
29- [Blockcore](https://www.blockcore.net/wallet) 29- [Alby](https://getalby.com) (Chrome and derivatives, Firefox, Safari)
30- [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives)
31- [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox)
32- [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives)
diff --git a/08.md b/08.md
index 5dbb695..6793e0b 100644
--- a/08.md
+++ b/08.md
@@ -1,10 +1,12 @@
1> __Warning__ `unrecommended`: deprecated in favor of [NIP-27](27.md)
2
1NIP-08 3NIP-08
2====== 4======
3 5
4Handling Mentions 6Handling Mentions
5----------------- 7-----------------
6 8
7`final` `optional` `author:fiatjaf` `author:scsibug` 9`final` `unrecommended` `optional` `author:fiatjaf` `author:scsibug`
8 10
9This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. 11This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s.
10 12
@@ -15,3 +17,5 @@ Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867ee
15The same process applies for mentioning event IDs. 17The same process applies for mentioning event IDs.
16 18
17A client that receives a `text_note` event with such `#[index]` mentions in its `.content` CAN do a search-and-replace using the actual contents from the `.tags` array with the actual pubkey or event ID that is mentioned, doing any desired context augmentation (for example, linking to the pubkey or showing a preview of the mentioned event contents) it wants in the process. 19A client that receives a `text_note` event with such `#[index]` mentions in its `.content` CAN do a search-and-replace using the actual contents from the `.tags` array with the actual pubkey or event ID that is mentioned, doing any desired context augmentation (for example, linking to the pubkey or showing a preview of the mentioned event contents) it wants in the process.
20
21Where `#[index]` has an `index` that is outside the range of the tags array or points to a tag that is not an `e` or `p` tag or a tag otherwise declared to support this notation, the client MUST NOT perform such replacement or augmentation, but instead display it as normal text.
diff --git a/09.md b/09.md
index 881eb8a..89781fb 100644
--- a/09.md
+++ b/09.md
@@ -33,7 +33,7 @@ Relays SHOULD continue to publish/share the deletion events indefinitely, as cli
33 33
34## Client Usage 34## Client Usage
35 35
36Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events own content, although a user interface should clearly indicate that this is a deletion reason, not the original content. 36Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion reason, not the original content.
37 37
38A client MUST validate that each event `pubkey` referenced in the `e` tag of the deletion request is identical to the deletion request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative. 38A client MUST validate that each event `pubkey` referenced in the `e` tag of the deletion request is identical to the deletion request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative.
39 39
diff --git a/10.md b/10.md
index 8b617f6..6494796 100644
--- a/10.md
+++ b/10.md
@@ -43,10 +43,10 @@ They are citings from this event. `root-id` and `reply-id` are as above.
43Where: 43Where:
44 44
45 * `<event-id>` is the id of the event being referenced. 45 * `<event-id>` is the id of the event being referenced.
46 * `<relay-url>` is the URL of a recommended relay associated with the reference. It is NOT optional. 46 * `<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 `""`.
47 * `<marker>` is optional and if present is one of `"reply"` or `"root"` 47 * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
48 48
49**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the `<reply-id>`. Those marked with `"root"` denote the root id of the reply thread. 49**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id.
50 50
51A direct reply to the root of a thread should have a single marked "e" tag of type "root". 51A direct reply to the root of a thread should have a single marked "e" tag of type "root".
52 52
diff --git a/11.md b/11.md
index 2b26823..b0d6003 100644
--- a/11.md
+++ b/11.md
@@ -4,7 +4,7 @@ NIP-11
4Relay Information Document 4Relay Information Document
5--------------------------- 5---------------------------
6 6
7`draft` `optional` `author:scsibug` 7`draft` `optional` `author:scsibug` `author:doc-hex` `author:cameri`
8 8
9Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. 9Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket.
10 10
@@ -12,13 +12,13 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application
12 12
13```json 13```json
14{ 14{
15 name: <string identifying relay>, 15 "name": <string identifying relay>,
16 description: <string with detailed information>, 16 "description": <string with detailed information>,
17 pubkey: <administrative contact pubkey>, 17 "pubkey": <administrative contact pubkey>,
18 contact: <administrative alternate contact>, 18 "contact": <administrative alternate contact>,
19 supported_nips: <a list of NIP numbers supported by the relay>, 19 "supported_nips": <a list of NIP numbers supported by the relay>,
20 software: <string identifying relay software URL>, 20 "software": <string identifying relay software URL>,
21 version: <string version identifier> 21 "version": <string version identifier>
22} 22}
23``` 23```
24 24
@@ -56,3 +56,229 @@ The relay server implementation MAY be provided in the `software` attribute. If
56### Version ### 56### Version ###
57 57
58The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. 58The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier.
59
60Extra Fields
61-----------------
62
63### Server Limitations ###
64
65These are limitations imposed by the relay on clients. Your client
66should expect that requests which exceed these *practical* limitations
67are rejected or fail immediately.
68
69```json
70{
71...
72 "limitation": {
73 "max_message_length": 16384,
74 "max_subscriptions": 20,
75 "max_filters": 100,
76 "max_limit": 5000,
77 "max_subid_length": 100,
78 "min_prefix": 4,
79 "max_event_tags": 100,
80 "max_content_length": 8196,
81 "min_pow_difficulty": 30,
82 "auth_required": true,
83 "payment_required": true,
84 }
85...
86}
87```
88
89- `max_message_length`: this is the maximum number of bytes for incoming JSON that the relay
90will attempt to decode and act upon. When you send large subscriptions, you will be
91limited by this value. It also effectively limits the maximum size of any event. Value is
92calculated from `[` to `]` and is after UTF-8 serialization (so some unicode characters
93will cost 2-3 bytes). It is equal to the maximum size of the WebSocket message frame.
94
95- `max_subscriptions`: total number of subscriptions that may be
96active on a single websocket connection to this relay. It's possible
97that authenticated clients with a (paid) relationship to the relay
98may have higher limits.
99
100- `max_filters`: maximum number of filter values in each subscription.
101Must be one or higher.
102
103- `max_subid_length`: maximum length of subscription id as a string.
104
105- `min_prefix`: for `authors` and `ids` filters which are to match against
106a hex prefix, you must provide at least this many hex digits in the prefix.
107
108- `max_limit`: the relay server will clamp each filter's `limit` value to this number.
109This means the client won't be able to get more than this number
110of events from a single subscription filter. This clamping is typically done silently
111by the relay, but with this number, you can know that there are additional results
112if you narrowed your filter's time range or other parameters.
113
114- `max_event_tags`: in any event, this is the maximum number of elements in the `tags` list.
115
116- `max_content_length`: maximum number of characters in the `content`
117field of any event. This is a count of unicode characters. After
118serializing into JSON it may be larger (in bytes), and is still
119subject to the `max_message_length`, if defined.
120
121- `min_pow_difficulty`: new events will require at least this difficulty of PoW,
122based on [NIP-13](13.md), or they will be rejected by this server.
123
124- `auth_required`: this relay requires [NIP-42](42.md) authentication
125to happen before a new connection may perform any other action.
126Even if set to False, authentication may be required for specific actions.
127
128- `payment_required`: this relay requires payment before a new connection may perform any action.
129
130### Event Retention ###
131
132There may be a cost associated with storing data forever, so relays
133may wish to state retention times. The values stated here are defaults
134for unauthenticated users and visitors. Paid users would likely have
135other policies.
136
137Retention times are given in seconds, with `null` indicating infinity.
138If zero is provided, this means the event will not be stored at
139all, and preferably an error will be provided when those are received.
140
141```json
142{
143...
144 "retention": [
145 { "kinds": [0, 1, [5, 7], [40, 49]], "time": 3600 },
146 { "kinds": [[40000, 49999]], "time": 100 },
147 { "kinds": [[30000, 39999]], "count": 1000 },
148 { "time": 3600, "count": 10000 }
149 ]
150...
151}
152```
153
154`retention` is a list of specifications: each will apply to either all kinds, or
155a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive
156start and end values. Events of indicated kind (or all) are then limited to a `count`
157and/or time period.
158
159It is possible to effectively blacklist Nostr-based protocols that rely on
160a specific `kind` number, by giving a retention time of zero for those `kind` values.
161While that is unfortunate, it does allow clients to discover servers that will
162support their protocol quickly via a single HTTP fetch.
163
164There is no need to specify retention times for _ephemeral events_ as defined
165in [NIP-16](16.md) since they are not retained.
166
167
168### Content Limitations ###
169
170Some relays may be governed by the arbitrary laws of a nation state. This
171may limit what content can be stored in cleartext on those relays. All
172clients are encouraged to use encryption to work around this limitation.
173
174It is not possible to describe the limitations of each country's laws
175and policies which themselves are typically vague and constantly shifting.
176
177Therefore, this field allows the relay operator to indicate which
178countries' laws might end up being enforced on them, and then
179indirectly on their users' content.
180
181Users should be able to avoid relays in countries they don't like,
182and/or select relays in more favourable zones. Exposing this
183flexibility is up to the client software.
184
185```json
186{
187...
188 "relay_countries": [ "CA", "US" ],
189...
190}
191```
192
193- `relay_countries`: a list of two-level ISO country codes (ISO 3166-1 alpha-2) whose
194 laws and policies may affect this relay. `EU` may be used for European Union countries.
195
196Remember that a relay may be hosted in a country which is not the
197country of the legal entities who own the relay, so it's very
198likely a number of countries are involved.
199
200
201### Community Preferences ###
202
203For public text notes at least, a relay may try to foster a
204local community. This would encourage users to follow the global
205feed on that relay, in addition to their usual individual follows.
206To support this goal, relays MAY specify some of the following values.
207
208```json
209{
210...
211 "language_tags": [ "en", "en-419" ],
212 "tags": [ "sfw-only", "bitcoin-only", "anime" ],
213 "posting_policy": "https://example.com/posting-policy.html",
214...
215}
216```
217
218- `language_tags` is an ordered list
219 of [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) indicating
220 the major languages spoken on the relay.
221
222- `tags` is a list of limitations on the topics to be discussed.
223 For example `sfw-only` indicates that only "Safe For Work" content
224 is encouraged on this relay. This relies on assumptions of what the
225 "work" "community" feels "safe" talking about. In time, a common
226 set of tags may emerge that allow users to find relays that suit
227 their needs, and client software will be able to parse these tags easily.
228 The `bitcoin-only` tag indicates that any *altcoin*, *"crypto"* or *blockchain*
229 comments will be ridiculed without mercy.
230
231- `posting_policy` is a link to a human-readable page which specifies the
232 community policies for the relay. In cases where `sfw-only` is True, it's
233 important to link to a page which gets into the specifics of your posting policy.
234
235The `description` field should be used to describe your community
236goals and values, in brief. The `posting_policy` is for additional
237detail and legal terms. Use the `tags` field to signify limitations
238on content, or topics to be discussed, which could be machine
239processed by appropriate client software.
240
241### Pay-To-Relay ###
242
243Relays that require payments may want to expose their fee schedules.
244
245```json
246{
247...
248 "payments_url": "https://my-relay/payments",
249 "fees": {
250 "admission": [{ "amount": 1000000, "unit": "msats" }],
251 "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }],
252 "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }],
253 },
254...
255}
256```
257
258### Examples ###
259As of 2 May 2023 the following `curl` command provided these results.
260
261 >curl -H "Accept: application/nostr+json" https://eden.nostr.land
262
263 {"name":"eden.nostr.land",
264 "description":"Eden Nostr Land - Toronto 1-01",
265 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700",
266 "contact":"me@ricardocabral.io",
267 "supported_nips":[1,2,4,9,11,12,15,16,20,22,26,28,33,40],
268 "supported_nip_extensions":["11a"],
269 "software":"git+https://github.com/Cameri/nostream.git",
270 "version":"1.22.6",
271 "limitation":{"max_message_length":1048576,
272 "max_subscriptions":10,
273 "max_filters":2500,
274 "max_limit":5000,
275 "max_subid_length":256,
276 "min_prefix":4,
277 "max_event_tags":2500,
278 "max_content_length":65536,
279 "min_pow_difficulty":0,
280 "auth_required":false,
281 "payment_required":true},
282 "payments_url":"https://eden.nostr.land/invoices",
283 "fees":{"admission":[{"amount":5000000,"unit":"msats"}],
284 "publication":[]}}
diff --git a/13.md b/13.md
index cf28d86..360bde6 100644
--- a/13.md
+++ b/13.md
@@ -10,13 +10,15 @@ This NIP defines a way to generate and interpret Proof of Work for nostr notes.
10 10
11`difficulty` is defined to be the number of leading zero bits in the `NIP-01` id. For example, an id of `000000000e9d97a1ab09fc381030b346cdd7a142ad57e6df0b46dc9bef6c7e2d` has a difficulty of `36` with `36` leading 0 bits. 11`difficulty` is defined to be the number of leading zero bits in the `NIP-01` id. For example, an id of `000000000e9d97a1ab09fc381030b346cdd7a142ad57e6df0b46dc9bef6c7e2d` has a difficulty of `36` with `36` leading 0 bits.
12 12
13`002f...` is `0000 0000 0010 1111...` in binary, which has 10 leading zeroes. Do not forget to count leading zeroes for hex digits <= `7`.
14
13Mining 15Mining
14------ 16------
15 17
16To generate PoW for a `NIP-01` note, a `nonce` tag is used: 18To generate PoW for a `NIP-01` note, a `nonce` tag is used:
17 19
18```json 20```json
19{"content": "It's just me mining my own business", "tags": [["nonce", "1", "20"]]} 21{"content": "It's just me mining my own business", "tags": [["nonce", "1", "21"]]}
20``` 22```
21 23
22When mining, the second entry to the nonce tag is updated, and then the id is recalculated (see [NIP-01](./01.md)). If the id has the desired number of leading zero bits, the note has been mined. It is recommended to update the `created_at` as well during this process. 24When mining, the second entry to the nonce tag is updated, and then the id is recalculated (see [NIP-01](./01.md)). If the id has the desired number of leading zero bits, the note has been mined. It is recommended to update the `created_at` as well during this process.
@@ -36,7 +38,7 @@ Example mined note
36 [ 38 [
37 "nonce", 39 "nonce",
38 "776797", 40 "776797",
39 "20" 41 "21"
40 ] 42 ]
41 ], 43 ],
42 "content": "It's just me mining my own business", 44 "content": "It's just me mining my own business",
@@ -47,33 +49,61 @@ Example mined note
47Validating 49Validating
48---------- 50----------
49 51
50Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr note id: 52Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id:
51 53
52```c 54```c
53int zero_bits(unsigned char b) 55#include <stdio.h>
54{ 56#include <stdlib.h>
55 int n = 0; 57#include <string.h>
58
59int countLeadingZeroes(const char *hex) {
60 int count = 0;
61
62 for (int i = 0; i < strlen(hex); i++) {
63 int nibble = (int)strtol((char[]){hex[i], '\0'}, NULL, 16);
64 if (nibble == 0) {
65 count += 4;
66 } else {
67 count += __builtin_clz(nibble) - 28;
68 break;
69 }
70 }
56 71
57 if (b == 0) 72 return count;
58 return 8; 73}
74
75int main(int argc, char *argv[]) {
76 if (argc != 2) {
77 fprintf(stderr, "Usage: %s <hex_string>\n", argv[0]);
78 return 1;
79 }
59 80
60 while (b >>= 1) 81 const char *hex_string = argv[1];
61 n++; 82 int result = countLeadingZeroes(hex_string);
83 printf("Leading zeroes in hex string %s: %d\n", hex_string, result);
62 84
63 return 7-n; 85 return 0;
64} 86}
87```
65 88
66/* find the number of leading zero bits in a hash */ 89Here is some JavaScript code for doing the same thing:
67int count_leading_zero_bits(unsigned char *hash) 90
68{ 91```javascript
69 int bits, total, i; 92// hex should be a hexadecimal string (with no 0x prefix)
70 for (i = 0, total = 0; i < 32; i++) { 93function countLeadingZeroes(hex) {
71 bits = zero_bits(hash[i]); 94 let count = 0;
72 total += bits; 95
73 if (bits != 8) 96 for (let i = 0; i < hex.length; i++) {
74 break; 97 const nibble = parseInt(hex[i], 16);
75 } 98 if (nibble === 0) {
76 return total; 99 count += 4;
100 } else {
101 count += Math.clz32(nibble) - 28;
102 break;
103 }
104 }
105
106 return count;
77} 107}
78``` 108```
79 109
@@ -90,4 +120,4 @@ $ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.c
90Delegated Proof of Work 120Delegated Proof of Work
91----------------------- 121-----------------------
92 122
93Since the `NIP-01` note id does not commit to any signature, PoW can be outsourced to PoW providers, perhaps for a fee. This provides a way for clients to get their messages out to PoW-restricted relays without having to do any work themselves, which is useful for energy constrained devices like on mobile 123Since the `NIP-01` note id does not commit to any signature, PoW can be outsourced to PoW providers, perhaps for a fee. This provides a way for clients to get their messages out to PoW-restricted relays without having to do any work themselves, which is useful for energy-constrained devices like mobile phones.
diff --git a/15.md b/15.md
index 081a97d..617c011 100644
--- a/15.md
+++ b/15.md
@@ -1,21 +1,214 @@
1NIP-15 1NIP-15
2====== 2======
3 3
4End of Stored Events Notice 4Nostr Marketplace (for resilient marketplaces)
5--------------------------- 5-----------------------------------
6 6
7`final` `optional` `author:Semisol` 7`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos`
8 8
9Relays may support notifying clients when all stored events have been sent. 9> Based on https://github.com/lnbits/Diagon-Alley
10 10
11If a relay supports this NIP, the relay SHOULD send the client a `EOSE` message in the format `["EOSE", <subscription_id>]` after it has sent all the events it has persisted and it indicates all the events that come after this message are newly published. 11> Implemented here https://github.com/lnbits/nostrmarket
12 12
13Client Behavior 13## Terms
14---------------
15 14
16Clients SHOULD use the `supported_nips` field to learn if a relay supports end of stored events notices. 15- `merchant` - seller of products with NOSTR key-pair
16- `customer` - buyer of products with NOSTR key-pair
17- `product` - item for sale by the `merchant`
18- `stall` - list of products controlled by `merchant` (a `merchant` can have multiple stalls)
19- `marketplace` - clientside software for searching `stalls` and purchasing `products`
17 20
18Motivation 21## Nostr Marketplace Clients
19----------
20 22
21The motivation for this proposal is to reduce uncertainty when all events have been sent by a relay to make client code possibly less complex. 23### Merchant admin
24
25Where the `merchant` creates, updates and deletes `stalls` and `products`, as well as where they manage sales, payments and communication with `customers`.
26
27The `merchant` admin software can be purely clientside, but for `convenience` and uptime, implementations will likely have a server client listening for NOSTR events.
28
29### Marketplace
30
31`Marketplace` software should be entirely clientside, either as a stand-alone app, or as a purely frontend webpage. A `customer` subscribes to different merchant NOSTR public keys, and those `merchants` `stalls` and `products` become listed and searchable. The marketplace client is like any other ecommerce site, with basket and checkout. `Marketplaces` may also wish to include a `customer` support area for direct message communication with `merchants`.
32
33## `Merchant` publishing/updating products (event)
34
35A merchant can publish these events:
36| Kind | | Description | NIP |
37|---------|------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------|
38| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | [NIP01 ](https://github.com/nostr-protocol/nips/blob/master/01.md) |
39| `30017` | `set_stall` | Create or update a stall. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) |
40| `30018` | `set_product` | Create or update a product. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) |
41| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) |
42| `5 ` | `delete` | Delete a product or a stall. | [NIP05](https://github.com/nostr-protocol/nips/blob/master/05.md) |
43
44### Event `30017`: Create or update a stall.
45
46**Event Content**:
47```json
48{
49 "id": <String, UUID generated by the merchant. Sequential IDs (`0`, `1`, `2`...) are discouraged>,
50 "name": <String, stall name>,
51 "description": <String (optional), stall description>,
52 "currency": <String, currency used>,
53 "shipping": [
54 {
55 "id": <String, UUID of the shipping zone, generated by the merchant>,
56 "name": <String (optional), zone name>,
57 "cost": <float, cost for shipping. The currency is defined at the stall level>,
58 "countries": [<String, countries included in this zone>],
59 }
60 ]
61}
62```
63
64Fields that are not self-explanatory:
65 - `shipping`:
66 - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone.
67 - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero.
68 - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection.
69
70**Event Tags**:
71```json
72 "tags": [["d", <String, id of stall]]
73```
74 - the `d` tag is required by [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md). Its value MUST be the same as the stall `id`.
75
76### Event `30018`: Create or update a product
77
78**Event Content**:
79```json
80{
81 "id": <String, UUID generated by the merchant.Sequential IDs (`0`, `1`, `2`...) are discouraged>,
82 "stall_id": <String, UUID of the stall to which this product belong to>,
83 "name": <String, product name>,
84 "description": <String (optional), product description>,
85 "images": <[String], array of image URLs, optional>,
86 "currency": <String, currency used>,
87 "price": <float, cost of product>,
88 "quantity": <int, available items>,
89 "specs": [
90 [ <String, spec key>, <String, spec value>]
91 ]
92}
93```
94
95Fields that are not self-explanatory:
96 - `specs`:
97 - an array of key pair values. It allows for the Customer UI to present present product specifications in a structure mode. It also allows comparison between products
98 - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]`
99
100_Open_: better to move `spec` in the `tags` section of the event?
101
102**Event Tags**:
103```json
104 "tags": [
105 ["d", <String, id of product],
106 ["t", <String (optional), product category],
107 ["t", <String (optional), product category],
108 ...
109 ]
110```
111
112 - the `d` tag is required by [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md). Its value MUST be the same as the product `id`.
113 - the `t` tag is as searchable tag ([NIP12](https://github.com/nostr-protocol/nips/blob/master/12.md)). It represents different categories that the product can be part of (`food`, `fruits`). Multiple `t` tags can be present.
114
115## Checkout events
116
117All checkout events are sent as JSON strings using ([NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md)).
118
119The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types:
120
121| Message Type | Sent By | Description |
122|--------------|----------|---------------------|
123| 0 | Customer | New Order |
124| 1 | Merchant | Payment Request |
125| 2 | Merchant | Order Status Update |
126
127
128### Step 1: `customer` order (event)
129The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md).
130
131```json
132{
133 "id": <String, UUID generated by the customer>,
134 "type": 0,
135 "name": <String (optional), ???>,
136 "address": <String (optional), for physical goods an address should be provided>
137 "message": "<String (optional), message for merchant>,
138 "contact": {
139 "nostr": <32-bytes hex of a pubkey>,
140 "phone": <String (optional), if the customer wants to be contacted by phone>,
141 "email": <String (optional), if the customer wants to be contacted by email>,
142 },
143 "items": [
144 {
145 "product_id": <String, UUID of the product>,
146 "quantity": <int, how many products the customer is ordering>
147 }
148 ],
149 "shipping_id": <String, UUID of the shipping zone>
150}
151
152```
153
154_Open_: is `contact.nostr` required?
155
156
157### Step 2: `merchant` request payment (event)
158
159Sent back from the merchant for payment. Any payment option is valid that the merchant can check.
160
161The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md).
162
163`payment_options`/`type` include:
164
165- `url` URL to a payment page, stripe, paypal, btcpayserver, etc
166- `btc` onchain bitcoin address
167- `ln` bitcoin lightning invoice
168- `lnurl` bitcoin lnurl-pay
169
170```json
171{
172 "id": <String, UUID of the order>,
173 "type": 1,
174 "message": <String, message to customer, optional>,
175 "payment_options": [
176 {
177 "type": <String, option type>,
178 "link": <String, url, btc address, ln invoice, etc>
179 },
180 {
181 "type": <String, option type>,
182 "link": <String, url, btc address, ln invoice, etc>
183 },
184 {
185 "type": <String, option type>,
186 "link": <String, url, btc address, ln invoice, etc>
187 }
188 ]
189}
190```
191
192### Step 3: `merchant` verify payment/shipped (event)
193
194Once payment has been received and processed.
195
196The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md).
197
198```json
199{
200 "id": <String, UUID of the order>,
201 "type": 2,
202 "message": <String, message to customer>,
203 "paid": <Bool, true/false has received payment>,
204 "shipped": <Bool, true/false has been shipped>,
205}
206```
207
208## Customer support events
209
210Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md.
211
212## Additional
213
214Standard data models can be found here <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a>
diff --git a/16.md b/16.md
index 80a6b3d..4d9481d 100644
--- a/16.md
+++ b/16.md
@@ -16,7 +16,9 @@ Upon a regular event being received, the relay SHOULD send it to all clients wit
16Replaceable Events 16Replaceable Events
17------------------ 17------------------
18A *replaceable event* is defined as an event with a kind `10000 <= n < 20000`. 18A *replaceable event* is defined as an event with a kind `10000 <= n < 20000`.
19Upon a replaceable event with a newer timestamp than the currently known latest replaceable event with the same kind being received, and signed by the same key, the old event SHOULD be discarded and replaced with the newer event. 19Upon a replaceable event with a newer timestamp than the currently known latest replaceable event with the same kind and author being received, the old event SHOULD be discarded,
20effectively replacing what gets returned when querying for
21`author:kind` tuples.
20 22
21Ephemeral Events 23Ephemeral Events
22---------------- 24----------------
diff --git a/18.md b/18.md
index 365de9c..422ad9c 100644
--- a/18.md
+++ b/18.md
@@ -4,16 +4,22 @@ NIP-18
4Reposts 4Reposts
5------- 5-------
6 6
7`draft` `optional` `author:jb55` 7`draft` `optional` `author:jb55` `author:fiatjaf` `author:arthurfranca`
8 8
9A repost is a `kind 6` note that is used to signal to followers 9A repost is a `kind 6` note that is used to signal to followers
10that another event is worth reading. 10that another event is worth reading.
11 11
12The `content` of a repost event is empty. 12The `content` of a repost event is empty. Optionally, it MAY contain
13the stringified JSON of the reposted note event for quick look up.
13 14
14The repost event MUST include an `e` tag with the `id` of the note that is 15The repost event MUST include an `e` tag with the `id` of the note that is
15being reposted. That tag SHOULD include a relay URL as its third entry 16being reposted. That tag MUST include a relay URL as its third entry
16to indicate where it can be fetched. 17to indicate where it can be fetched.
17 18
18The repost SHOULD include a `p` tag with the `pubkey` of the event being 19The repost SHOULD include a `p` tag with the `pubkey` of the event being
19reposted. 20reposted.
21
22## Quote Reposts
23
24Quote reposts are `kind 1` events with an embedded `e` tag (see [NIP-08](08.md) and [NIP-27](27.md)).
25Because a quote repost includes an `e` tag, it may show up along replies to the reposted note.
diff --git a/19.md b/19.md
index 577399c..6fc4523 100644
--- a/19.md
+++ b/19.md
@@ -34,6 +34,8 @@ These are the possible bech32 prefixes with `TLV`:
34 34
35 - `nprofile`: a nostr profile 35 - `nprofile`: a nostr profile
36 - `nevent`: a nostr event 36 - `nevent`: a nostr event
37 - `nrelay`: a nostr relay
38 - `naddr`: a nostr parameterized replaceable event coordinate (NIP-33)
37 39
38These possible standardized `TLV` types are indicated here: 40These possible standardized `TLV` types are indicated here:
39 41
@@ -41,13 +43,22 @@ These possible standardized `TLV` types are indicated here:
41 - depends on the bech32 prefix: 43 - depends on the bech32 prefix:
42 - for `nprofile` it will be the 32 bytes of the profile public key 44 - for `nprofile` it will be the 32 bytes of the profile public key
43 - for `nevent` it will be the 32 bytes of the event id 45 - for `nevent` it will be the 32 bytes of the event id
46 - for `nrelay`, this is the relay URL
47 - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced
44- `1`: `relay` 48- `1`: `relay`
45 - A relay in which the entity (profile or event) is more likely to be found, encoded as UTF-8. This may be included multiple times. 49 - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii
50 - this may be included multiple times
51- `2`: `author`
52 - for `naddr`, the 32 bytes of the pubkey of the event
53 - for `nevent`, _optionally_, the 32 bytes of the pubkey of the event
54- `3`: `kind`
55 - for `naddr`, the 32-bit unsigned integer of the kind, big-endian
56 - for `nevent`, _optionally_, the 32-bit unsigned integer of the kind, big-endian
46 57
47## Examples 58## Examples
48 59
49- `npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6` should decode into the public key hex `3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d` and vice-versa 60- `npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg` should decode into the public key hex `7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e` and vice-versa
50- `nsec180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsgyumg0` should decode into the private key hex `3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d` and vice-versa 61- `nsec1vl029mgpspedva04g90vltkh6fvh240zqtv9k0t9af8935ke9laqsnlfe5` should decode into the private key hex `67dea2ed018072d675f5415ecfaed7d2597555e202d85b3d65ea4e58d2d92ffa` and vice-versa
51- `nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p` should decode into a profile with the following TLV items: 62- `nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p` should decode into a profile with the following TLV items:
52 - pubkey: `3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d` 63 - pubkey: `3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d`
53 - relay: `wss://r.x.com` 64 - relay: `wss://r.x.com`
@@ -56,3 +67,4 @@ These possible standardized `TLV` types are indicated here:
56## Notes 67## Notes
57 68
58- `npub` keys MUST NOT be used in NIP-01 events or in NIP-05 JSON responses, only the hex format is supported there. 69- `npub` keys MUST NOT be used in NIP-01 events or in NIP-05 JSON responses, only the hex format is supported there.
70- When decoding a bech32-formatted string, TLVs that are not recognized or supported should be ignored, rather than causing an error.
diff --git a/20.md b/20.md
index 49e2396..7e97dd9 100644
--- a/20.md
+++ b/20.md
@@ -82,7 +82,7 @@ Client Handling
82 82
83For the `pow:` prefix it may query relay metadata to get the updated difficulty requirement and try again in the background. 83For the `pow:` prefix it may query relay metadata to get the updated difficulty requirement and try again in the background.
84 84
85For the `invalid:` and `blocked`: prefix the client may wish to show these as styled error popups. 85For the `invalid:` and `blocked:` prefix the client may wish to show these as styled error popups.
86 86
87The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it. 87The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it.
88 88
diff --git a/21.md b/21.md
new file mode 100644
index 0000000..6246eb4
--- /dev/null
+++ b/21.md
@@ -0,0 +1,20 @@
1NIP-21
2======
3
4`nostr:` URI scheme
5-------------------
6
7`draft` `optional` `author:fiatjaf`
8
9This NIP standardizes the usage of a common URI scheme for maximum interoperability and openness in the network.
10
11The scheme is `nostr:`.
12
13The identifiers that come after are expected to be the same as those defined in [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) (except `nsec`).
14
15## Examples
16
17- `nostr:npub1sn0wdenkukak0d9dfczzeacvhkrgz92ak56egt7vdgzn8pv2wfqqhrjdv9`
18- `nostr:nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p`
19- `nostr:note1fntxtkcy9pjwucqwa9mddn7v03wwwsu9j330jj350nvhpky2tuaspk6nqc`
20- `nostr:nevent1qqstna2yrezu5wghjvswqqculvvwxsrcvu7uc0f78gan4xqhvz49d9spr3mhxue69uhkummnw3ez6un9d3shjtn4de6x2argwghx6egpr4mhxue69uhkummnw3ez6ur4vgh8wetvd3hhyer9wghxuet5nxnepm`
diff --git a/22.md b/22.md
index 9ab601d..2172519 100644
--- a/22.md
+++ b/22.md
@@ -8,7 +8,7 @@ Event `created_at` Limits
8 8
9Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md). 9Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md).
10 10
11If a relay supports this NIP, the relay SHOULD send the client a `NOTICE` message saying the event was not stored for the `created_at` timestamp not being within the permitted limits. 11If a relay supports this NIP, the relay SHOULD send the client a [NIP-20](20.md) command result saying the event was not stored for the `created_at` timestamp not being within the permitted limits.
12 12
13Client Behavior 13Client Behavior
14--------------- 14---------------
@@ -22,24 +22,24 @@ This NIP formalizes restrictions on event timestamps as accepted by a relay and
22 22
23The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions. 23The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions.
24 24
25[Replaceable events](16.md#replaceable-events) can behave rather unexpected if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a `NOTICE` and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. 25[Replaceable events](16.md#replaceable-events) can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time.
26 26
27A wide adoption of this nip could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future. 27A wide adoption of this NIP could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future.
28 28
29Keep in mind that there is a use case where a user migrates their old posts onto a new relay. If a relay rejects events that were not recently created, it cannot serve this use case. 29Keep in mind that there is a use case where a user migrates their old posts onto a new relay. If a relay rejects events that were not recently created, it cannot serve this use case.
30 30
31 31
32Python Example 32Python (pseudocode) Example
33-------------- 33---------------------------
34 34
35```python 35```python
36import time 36import time
37 37
38TIME = int(time.now) 38TIME = int(time.time())
39LOWER_LIMIT = TIME - (60 * 60 * 24) # Define lower limit as 1 day into the past 39LOWER_LIMIT = TIME - (60 * 60 * 24) # Define lower limit as 1 day into the past
40UPPER_LIMIT = TIME + (60 * 15) # Define upper limit as 15 minutes into the future 40UPPER_LIMIT = TIME + (60 * 15) # Define upper limit as 15 minutes into the future
41 41
42if event.created_at not in range(LOWER_LIMIT, UPPER_LIMIT): 42if event.created_at not in range(LOWER_LIMIT, UPPER_LIMIT):
43 # NOTE: This is one example of a notice message. Relays can change this to notify clients however they like. 43 ws.send('["OK", event.id, False, "invalid: the event created_at field is out of the acceptable range (-24h, +15min) for this relay"]')
44 ws.send('["NOTICE", "The event created_at field is out of the acceptable range (-24h, +15min) for this relay and was not stored."]')
45``` 44```
45Note: These are just example limits, the relay operator can choose whatever limits they want.
diff --git a/23.md b/23.md
new file mode 100644
index 0000000..151a31b
--- /dev/null
+++ b/23.md
@@ -0,0 +1,58 @@
1NIP-23
2======
3
4Long-form Content
5-----------------
6
7`draft` `optional` `author:fiatjaf`
8
9This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts".
10
11"Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP.
12
13### Format
14
15The `.content` of these events should be a string text in Markdown syntax.
16
17### Metadata
18
19For 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"` event tag should be used, as per NIP-12.
20
21Other 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:
22
23- `"title"`, for the article title
24- `"image"`, for a URL pointing to an image to be shown along with the title
25- `"summary"`, for the article summary
26- `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the article was published
27
28### Editability
29
30These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 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.
31
32### Linking
33
34The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)).
35
36### References
37
38References to other Nostr notes, articles or profiles must be made according to [NIP-27](27.md), i.e. by using [NIP-21](21.md) `nostr:...` links and optionally adding tags for these (see example below).
39
40## Example Event
41
42```json
43{
44 "kind": 30023,
45 "created_at": 1675642635,
46 "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.",
47 "tags": [
48 ["d", "lorem-ipsum"],
49 ["title", "Lorem Ipsum"],
50 ["published_at", "1296962229"],
51 ["t", "placeholder"],
52 ["e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", "wss://relay.example.com"],
53 ["a", "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", "wss://relay.nostr.org"]
54 ],
55 "pubkey": "...",
56 "id": "..."
57}
58```
diff --git a/25.md b/25.md
index 8608ed8..f74bcc0 100644
--- a/25.md
+++ b/25.md
@@ -16,9 +16,9 @@ A reaction with `content` set to `-` SHOULD be interpreted as a "dislike" or
16"downvote". It SHOULD NOT be counted as a "like", and MAY be displayed as a 16"downvote". It SHOULD NOT be counted as a "like", and MAY be displayed as a
17downvote or dislike on a post. A client MAY also choose to tally likes against 17downvote or dislike on a post. A client MAY also choose to tally likes against
18dislikes in a reddit-like system of upvotes and downvotes, or display them as 18dislikes in a reddit-like system of upvotes and downvotes, or display them as
19separate tallys. 19separate tallies.
20 20
21The `content` MAY be an emoji, in this case it MAY be interpreted as a "like", 21The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike",
22or the client MAY display this emoji reaction on the post. 22or the client MAY display this emoji reaction on the post.
23 23
24Tags 24Tags
diff --git a/26.md b/26.md
index 4557875..b8fa902 100644
--- a/26.md
+++ b/26.md
@@ -19,48 +19,90 @@ This NIP introduces a new tag: `delegation` which is formatted as follows:
19 "delegation", 19 "delegation",
20 <pubkey of the delegator>, 20 <pubkey of the delegator>,
21 <conditions query string>, 21 <conditions query string>,
22 <64-bytes schnorr signature of the sha256 hash of the delegation token> 22 <delegation token: 64-byte Schnorr signature of the sha256 hash of the delegation string>
23] 23]
24``` 24```
25 25
26##### Delegation Token 26##### Delegation Token
27 27
28The **delegation token** should be a 64-bytes schnorr signature of the sha256 hash of the following string: 28The **delegation token** should be a 64-byte Schnorr signature of the sha256 hash of the following string:
29 29
30``` 30```
31nostr:delegation:<pubkey of publisher (delegatee)>:<conditions query string> 31nostr:delegation:<pubkey of publisher (delegatee)>:<conditions query string>
32``` 32```
33 33
34For example, the token `c33c88ba78ec3c760e49db591ac5f7b129e3887c8af7729795e85a0588007e5ac89b46549232d8f918eefd73e726cb450135314bfda419c030d0b6affe401ec1` is signed by `86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e` and consists of: 34##### Conditions Query String
35 35
36```json 36The following fields and operators are supported in the above query string:
37nostr:delegation:62903b1ff41559daf9ee98ef1ae67cc52f301bb5ce26d14baba3052f649c3f49:kind=1&created_at>1640995200 37
38``` 38*Fields*:
391. `kind`
40 - *Operators*:
41 - `=${KIND_NUMBER}` - delegatee may only sign events of this kind
422. `created_at`
43 - *Operators*:
44 - `<${TIMESTAMP}` - delegatee may only sign events created ***before*** the specified timestamp
45 - `>${TIMESTAMP}` - delegatee may only sign events created ***after*** the specified timestamp
46
47In order to create a single condition, you must use a supported field and operator. Multiple conditions can be used in a single query string, including on the same field. Conditions must be combined with `&`.
48
49For example, the following condition strings are valid:
50
51- `kind=1&created_at<1675721813`
52- `kind=0&kind=1&created_at>1675721813`
53- `kind=1&created_at>1674777689&created_at<1675721813`
54
55For the vast majority of use-cases, it is advisable that query strings should include a `created_at` ***after*** condition reflecting the current time, to prevent the delegatee from publishing historic notes on the delegator's behalf.
39 56
40#### Example 57#### Example
41 58
42Below is an example of an event published by `62903b1ff41559daf9ee98ef1ae67cc52f301bb5ce26d14baba3052f649c3f49`, on behalf of `86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e`. 59```
60# Delegator:
61privkey: ee35e8bb71131c02c1d7e73231daa48e9953d329a4b701f7133c8f46dd21139c
62pubkey: 8e0d3d3eb2881ec137a11debe736a9086715a8c8beeeda615780064d68bc25dd
63
64# Delegatee:
65privkey: 777e4f60b4aa87937e13acc84f7abcc3c93cc035cb4c1e9f7a9086dd78fffce1
66pubkey: 477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396
67```
43 68
69Delegation string to grant note publishing authorization to the delegatee (477318cf) from now, for the next 30 days, given the current timestamp is `1674834236`.
70```json
71nostr:delegation:477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396:kind=1&created_at>1674834236&created_at<1677426236
72```
73
74The delegator (8e0d3d3e) then signs a SHA256 hash of the above delegation string, the result of which is the delegation token:
75```
766f44d7fe4f1c09f3954640fb58bd12bae8bb8ff4120853c4693106c82e920e2b898f1f9ba9bd65449a987c39c0423426ab7b53910c0c6abfb41b30bc16e5f524
77```
78
79The delegatee (477318cf) can now construct an event on behalf of the delegator (8e0d3d3e). The delegatee then signs the event with its own private key and publishes.
44```json 80```json
45{ 81{
46 "id": "a080fd288b60ac2225ff2e2d815291bd730911e583e177302cc949a15dc2b2dc", 82 "id": "e93c6095c3db1c31d15ac771f8fc5fb672f6e52cd25505099f62cd055523224f",
47 "pubkey": "62903b1ff41559daf9ee98ef1ae67cc52f301bb5ce26d14baba3052f649c3f49", 83 "pubkey": "477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396",
48 "created_at": 1660896109, 84 "created_at": 1677426298,
49 "kind": 1, 85 "kind": 1,
50 "tags": [ 86 "tags": [
51 [ 87 [
52 "delegation", 88 "delegation",
53 "86f0689bd48dcd19c67a19d994f938ee34f251d8c39976290955ff585f2db42e", 89 "8e0d3d3eb2881ec137a11debe736a9086715a8c8beeeda615780064d68bc25dd",
54 "kind=1&created_at>1640995200", 90 "kind=1&created_at>1674834236&created_at<1677426236",
55 "c33c88ba78ec3c760e49db591ac5f7b129e3887c8af7729795e85a0588007e5ac89b46549232d8f918eefd73e726cb450135314bfda419c030d0b6affe401ec1" 91 "6f44d7fe4f1c09f3954640fb58bd12bae8bb8ff4120853c4693106c82e920e2b898f1f9ba9bd65449a987c39c0423426ab7b53910c0c6abfb41b30bc16e5f524"
56 ] 92 ]
57 ], 93 ],
58 "content": "Hello world", 94 "content": "Hello, world!",
59 "sig": "cd4a3cd20dc61dcbc98324de561a07fd23b3d9702115920c0814b5fb822cc5b7c5bcdaf3fa326d24ed50c5b9c8214d66c75bae34e3a84c25e4d122afccb66eb6" 95 "sig": "633db60e2e7082c13a47a6b19d663d45b2a2ebdeaf0b4c35ef83be2738030c54fc7fd56d139652937cdca875ee61b51904a1d0d0588a6acd6168d7be2909d693"
60} 96}
61``` 97```
62 98
99The event should be considered a valid delegation if the conditions are satisfied (`kind=1`, `created_at>1674834236` and `created_at<1677426236` in this example) and, upon validation of the delegation token, are found to be unchanged from the conditions in the original delegation string.
100
101Clients should display the delegated note as if it was published directly by the delegator (8e0d3d3e).
102
103
104#### Relay & Client Support
63 105
64#### Relay & Client Querying Support 106Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value.
65 107
66Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value. 108Relays SHOULD allow the delegator (8e0d3d3e) to delete the events published by the delegatee (477318cf). \ No newline at end of file
diff --git a/27.md b/27.md
new file mode 100644
index 0000000..6d76120
--- /dev/null
+++ b/27.md
@@ -0,0 +1,54 @@
1NIP-27
2======
3
4Text Note References
5--------------------
6
7`draft` `optional` `author:arthurfranca` `author:hodlbod` `author:fiatjaf`
8
9This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023).
10
11When creating an event, clients should include mentions to other profiles and to other events in the middle of the `.content` using [NIP-21](21.md) codes, such as `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`.
12
13Including [NIP-10](10.md)-style tags (`["e", <hex-id>, <relay-url>, <marker>]`) for each reference is optional, clients should do it whenever they want the profile being mentioned to be notified of the mention, or when they want the referenced event to recognize their mention as a reply.
14
15A reader client that receives an event with such `nostr:...` mentions in its `.content` can do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, [NIP-21](21.md) links or direct links to web clients that will handle these references.
16
17---
18
19## Example of a profile mention process
20
21Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`.
22
23As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://gateway.nostr.com/p/2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc), showing a picture and name.
24
25Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this:
26
27```json
28{
29 "content": "hello nostr:nprofile1qqszclxx9f5haga8sfjjrulaxncvkfekj097t6f3pu65f86rvg49ehqj6f9dh",
30 "created_at": 1679790774,
31 "id": "f39e9b451a73d62abc5016cffdd294b1a904e2f34536a208874fe5e22bbd47cf",
32 "kind": 1,
33 "pubkey": "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798",
34 "sig": "f8c8bab1b90cc3d2ae1ad999e6af8af449ad8bb4edf64807386493163e29162b5852a796a8f474d6b1001cddbaac0de4392838574f5366f03cc94cf5dfb43f4d",
35 "tags": [
36 [
37 "p",
38 "2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc"
39 ]
40 ]
41}
42```
43
44(Alternatively, the mention could have been a `nostr:npub1...` URL.)
45
46After Bob publishes this event and Carol sees it, her client will initially display the `.content` as it is, but later it will parse the `.content` and see that there is a `nostr:` URL in there, decode it, extract the public key from it (and possibly relay hints), fetch that profile from its internal database or relays, then replace the full URL with the name `@mattn`, with a link to the internal page view for that profile.
47
48## Verbose and probably unnecessary considerations
49
50- The example above was very concrete, but it doesn't mean all clients have to implement the same flow. There could be clients that do not support autocomplete at all, so they just allow users to paste raw [NIP-19](19.md) codes into the body of text, then prefix these with `nostr:` before publishing the event.
51- The flow for referencing other events is similar: a user could paste a `note1...` or `nevent1...` code and the client will turn that into a `nostr:note1...` or `nostr:nevent1...` URL. Then upon reading such references the client may show the referenced note in a preview box or something like that -- or nothing at all.
52- Other display procedures can be employed: for example, if a client that is designed for dealing with only `kind:1` text notes sees, for example, a [`kind:30023`](23.md) `nostr:naddr1...` URL reference in the `.content`, it can, for example, decide to turn that into a link to some hardcoded webapp capable of displaying such events.
53- Clients may give the user the option to include or not include tags for mentioned events or profiles. If someone wants to mention `mattn` without notifying them, but still have a nice augmentable/clickable link to their profile inside their note, they can instruct their client to _not_ create a `["p", ...]` tag for that specific mention.
54- In the same way, if someone wants to reference another note but their reference is not meant to show up along other replies to that same note, their client can choose to not include a corresponding `["e", ...]` tag for any given `nostr:nevent1...` URL inside `.content`. Clients may decide to expose these advanced functionalities to users or be more opinionated about things.
diff --git a/28.md b/28.md
index f37299e..169ae4f 100644
--- a/28.md
+++ b/28.md
@@ -9,7 +9,7 @@ Public Chat
9 9
10This NIP defines new event kinds for public chat channels, channel messages, and basic client-side moderation. 10This NIP defines new event kinds for public chat channels, channel messages, and basic client-side moderation.
11 11
12It reserves five event kinds (40-44) for immediate use and five event kinds (45-49) for future use. 12It reserves five event kinds (40-44) for immediate use:
13 13
14- `40 - channel create` 14- `40 - channel create`
15- `41 - channel metadata` 15- `41 - channel metadata`
@@ -54,7 +54,7 @@ Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
54```json 54```json
55{ 55{
56 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}", 56 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}",
57 "tags": [["e", <channel_create_event_id> <relay-url>]], 57 "tags": [["e", <channel_create_event_id>, <relay-url>]],
58 ... 58 ...
59} 59}
60``` 60```
@@ -73,7 +73,7 @@ Root message:
73```json 73```json
74{ 74{
75 "content": <string>, 75 "content": <string>,
76 "tags": [["e", <kind_40_event_id> <relay-url> "root"]], 76 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]],
77 ... 77 ...
78} 78}
79``` 79```
@@ -84,8 +84,9 @@ Reply to another message:
84{ 84{
85 "content": <string>, 85 "content": <string>,
86 "tags": [ 86 "tags": [
87 ["e", <kind_42_event_id> <relay-url> "reply"], 87 ["e", <kind_40_event_id>, <relay-url>, "root"],
88 ["p", <pubkey> <relay-url>], 88 ["e", <kind_42_event_id>, <relay-url>, "reply"],
89 ["p", <pubkey>, <relay-url>],
89 ... 90 ...
90 ], 91 ],
91 ... 92 ...
@@ -138,12 +139,6 @@ For [NIP-10](10.md) relay recommendations, clients generally SHOULD use the rela
138Clients MAY recommend any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay. 139Clients MAY recommend any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay.
139 140
140 141
141Future extensibility
142--------------------
143
144We reserve event kinds 45-49 for other events related to chat, to potentially include new types of media (photo/video), moderation, or support of private or group messaging.
145
146
147Motivation 142Motivation
148---------- 143----------
149If we're solving censorship-resistant communication for social media, we may as well solve it also for Telegram-style messaging. 144If we're solving censorship-resistant communication for social media, we may as well solve it also for Telegram-style messaging.
diff --git a/33.md b/33.md
index db572ad..10681fa 100644
--- a/33.md
+++ b/33.md
@@ -10,10 +10,14 @@ This NIP adds a new event range that allows for replacement of events that have
10 10
11Implementation 11Implementation
12-------------- 12--------------
13The value of a tag is defined as the first parameter of a tag after the tag name.
14
13A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`. 15A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`.
14Upon a parameterized replaceable event with a newer timestamp than the currently known latest 16Upon a parameterized replaceable event with a newer timestamp than the currently known latest
15replaceable event with the same kind and first `d` tag value being received, the old event 17replaceable event with the same kind, author and first `d` tag value being received, the old event
16SHOULD be discarded and replaced with the newer event. 18SHOULD be discarded, effectively replacing what gets returned when querying for
19`author:kind:d-tag` tuples.
20
17A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the 21A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the
18value as an empty string. Events from the same author with any of the following `tags` 22value as an empty string. Events from the same author with any of the following `tags`
19replace each other: 23replace each other:
@@ -24,6 +28,23 @@ replace each other:
24* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered 28* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered
25* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered 29* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered
26* `"tags":[["e"]]`: same as no tags 30* `"tags":[["e"]]`: same as no tags
31* `"tags":[["d","","1"]]`: only the first value is considered (`""`)
32
33Clients SHOULD NOT use `d` tags with multiple values and SHOULD include the `d` tag even if it has no value to allow querying using the `#d` filter.
34
35Referencing and tagging
36-----------------------
37
38Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the
39`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their
40equivalents for event tags (i.e. an `nprofile` is generally translated into a tag
41`["p", "<event hex id>", "<relay url>"]`).
42
43To support linking to parameterized replaceable events, the `naddr` code is introduced on
44NIP-19. It includes the public key of the event author and the `d` tag (and relays) such that
45the referenced combination of public key and `d` tag can be found.
46
47The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "<kind>:<pubkey>:<d-identifier>", "<relay url>"]`.
27 48
28Client Behavior 49Client Behavior
29--------------- 50---------------
diff --git a/39.md b/39.md
new file mode 100644
index 0000000..b84603c
--- /dev/null
+++ b/39.md
@@ -0,0 +1,66 @@
1NIP-39
2======
3
4External Identities in Profiles
5-------------------------------
6
7`draft` `optional` `author:pseudozach` `author:Semisol`
8
9## Abstract
10
11Nostr protocol users may have other online identities such as usernames, profile pages, keypairs etc. they control and they may want to include this data in their profile metadata so clients can parse, validate and display this information.
12
13## `i` tag on a metadata event
14
15A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md):
16```json
17{
18 "id": <id>,
19 "pubkey": <pubkey>,
20 ...
21 "tags": [
22 ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"],
23 ["i", "twitter:semisol_public", "1619358434134196225"],
24 ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"]
25 ["i", "telegram:1087295469", "nostrdirectory/770"]
26 ]
27}
28```
29
30An `i` tag will have two parameters, which are defined as the following:
311. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`.
322. `proof`: String or object that points to the proof of owning this identity.
33
34Clients SHOULD process any `i` tags with more than 2 values for future extensibility.
35Identity provider names SHOULD only include `a-z`, `0-9` and the characters `._-/` and MUST NOT include `:`.
36Identity names SHOULD be normalized if possible by replacing uppercase letters with lowercase letters, and if there are multiple aliases for an entity the primary one should be used.
37
38## Claim types
39
40### `github`
41
42Identity: A GitHub username.
43
44Proof: A GitHub Gist ID. This Gist should be created by `<identity>` with a single file that has the text `Verifying that I control the following Nostr public key: <npub encoded public key>`.
45This can be located at `https://gist.github.com/<identity>/<proof>`.
46
47### `twitter`
48
49Identity: A Twitter username.
50
51Proof: A Tweet ID. The tweet should be posted by `<identity>` and have the text `Verifying my account on nostr My Public Key: "<npub encoded public key>"`.
52This can be located at `https://twitter.com/<identity>/status/<proof>`.
53
54### `mastodon`
55
56Identity: A Mastodon instance and username in the format `<instance>/@<username>`.
57
58Proof: A Mastodon post ID. This post should be published by `<username>@<instance>` and have the text `Verifying that I control the following Nostr public key: "<npub encoded public key>"`.
59This can be located at `https://<identity>/<proof>`.
60
61### `telegram`
62
63Identity: A Telegram user ID.
64
65Proof: A string in the format `<ref>/<id>` which points to a message published in the public channel or group with name `<ref>` and message ID `<id>`. This message should be sent by user ID `<identity>` and have the text `Verifying that I control the following Nostr public key: "<npub encoded public key>"`.
66This can be located at `https://t.me/<proof>`.
diff --git a/40.md b/40.md
index 274ee80..32680db 100644
--- a/40.md
+++ b/40.md
@@ -43,7 +43,7 @@ Clients SHOULD ignore events that have expired.
43Relay Behavior 43Relay Behavior
44-------------- 44--------------
45 45
46Relays MAY NOT delete an expired message immediately on expiration and MAY persist them indefinitely. 46Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely.
47Relays SHOULD NOT send expired events to clients, even if they are stored. 47Relays SHOULD NOT send expired events to clients, even if they are stored.
48Relays SHOULD drop any events that are published to them if they are expired. 48Relays SHOULD drop any events that are published to them if they are expired.
49An expiration timestamp does not affect storage of ephemeral events. 49An expiration timestamp does not affect storage of ephemeral events.
diff --git a/42.md b/42.md
new file mode 100644
index 0000000..9b0c45b
--- /dev/null
+++ b/42.md
@@ -0,0 +1,88 @@
1NIP-42
2======
3
4Authentication of clients to relays
5-----------------------------------
6
7`draft` `optional` `author:Semisol` `author:fiatjaf`
8
9This NIP defines a way for clients to authenticate to relays by signing an ephemeral event.
10
11## Motivation
12
13A relay may want to require clients to authenticate to access restricted resources. For example,
14
15 - A relay may request payment or other forms of whitelisting to publish events -- this can naïvely be achieved by limiting publication
16 to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an
17 authenticated user;
18 - A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication
19 before clients can query for that kind.
20 - A relay may limit subscriptions of any kind to paying users or users whitelisted through any other means, and require authentication.
21
22## Definitions
23
24This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want
25to authenticate. When sent by relays, the message is of the following form:
26
27```
28["AUTH", <challenge-string>]
29```
30
31And, when sent by clients, of the following form:
32
33```
34["AUTH", <signed-event-json>]
35```
36
37The 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,
38one for the relay URL and one for the challenge string as received from the relay.
39Relays MUST exclude `kind: 22242` events from being broadcasted to any client.
40`created_at` should be the current time. Example:
41
42```json
43{
44 "id": "...",
45 "pubkey": "...",
46 "created_at": 1669695536,
47 "kind": 22242,
48 "tags": [
49 ["relay", "wss://relay.example.com/"],
50 ["challenge", "challengestringhere"]
51 ],
52 "content": "",
53 "sig": "..."
54}
55```
56
57## Protocol flow
58
59At any moment the relay may send an `AUTH` message to the client containing a challenge. After receiving that the client may decide to
60authenticate itself or not. The challenge is expected to be valid for the duration of the connection or until a next challenge is sent by
61the relay.
62
63The client may send an auth message right before performing an action for which it knows authentication will be required -- for example, right
64before requesting `kind: 4` chat messages --, or it may do right on connection start or at some other moment it deems best. The authentication
65is expected to last for the duration of the WebSocket connection.
66
67Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For
68that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example:
69
70```
71["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"]
72```
73
74or it can return an `OK` message noting the reason an event was not written using the same prefix:
75
76```
77["OK", <event-id>, false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"]
78```
79
80## Signed Event Verification
81
82To verify `AUTH` messages, relays must ensure:
83
84 - that the `kind` is `22242`;
85 - that the event `created_at` is close (e.g. within ~10 minutes) of the current time;
86 - that the `"challenge"` tag matches the challenge sent before;
87 - that the `"relay"` tag matches the relay URL:
88 - URL normalization techniques can be applied. For most cases just checking if the domain name is correct should be enough.
diff --git a/45.md b/45.md
new file mode 100644
index 0000000..a525391
--- /dev/null
+++ b/45.md
@@ -0,0 +1,39 @@
1NIP-45
2======
3
4Event Counts
5--------------
6
7`draft` `optional` `author:staab`
8
9Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts.
10
11## Motivation
12
13Some queries a client may want to execute against connected relays are prohibitively expensive, for example, in order to retrieve follower counts for a given pubkey, a client must query all kind-3 events referring to a given pubkey only to count them. The result may be cached, either by a client or by a separate indexing server as an alternative, but both options erode the decentralization of the network by creating a second-layer protocol on top of Nostr.
14
15## Filters and return values
16
17This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result.
18
19```
20["COUNT", <subscription_id>, <filters JSON>...]
21```
22
23Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
24
25```
26["COUNT", <subscription_id>, {"count": <integer>}]
27```
28
29Examples:
30
31```
32# Followers count
33["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
34["COUNT", <subscription_id>, {"count": 238}]
35
36# Count posts and reactions
37["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
38["COUNT", <subscription_id>, {"count": 5}]
39```
diff --git a/46.md b/46.md
new file mode 100644
index 0000000..90fa1a0
--- /dev/null
+++ b/46.md
@@ -0,0 +1,162 @@
1NIP-46
2======
3
4Nostr Connect
5------------------------
6
7`draft` `optional` `author:tiero` `author:giowe` `author:vforvalerio87`
8
9## Rationale
10
11Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface.
12
13Entering private keys can also be annoying and requires exposing them to even more systems such as the operating system's clipboard that might be monitored by malicious apps.
14
15
16## Terms
17
18* **App**: Nostr app on any platform that *requires* to act on behalf of a nostr account.
19* **Signer**: Nostr app that holds the private key of a nostr account and *can sign* on its behalf.
20
21
22## `TL;DR`
23
24
25**App** and **Signer** sends ephemeral encrypted messages to each other using kind `24133`, using a relay of choice.
26
27App prompts the Signer to do things such as fetching the public key or signing events.
28
29The `content` field must be an encrypted JSONRPC-ish **request** or **response**.
30
31## Signer Protocol
32
33### Messages
34
35#### Request
36
37```json
38{
39 "id": <random_string>,
40 "method": <one_of_the_methods>,
41 "params": [<anything>, <else>]
42}
43```
44
45#### Response
46
47```json
48{
49 "id": <request_id>,
50 "result": <anything>,
51 "error": <reason>
52}
53```
54
55### Methods
56
57
58#### Mandatory
59
60These are mandatory methods the remote signer app MUST implement:
61
62- **describe**
63 - params []
64 - result `["describe", "get_public_key", "sign_event", "connect", "disconnect", "delegate", ...]`
65- **get_public_key**
66 - params []
67 - result `pubkey`
68- **sign_event**
69 - params [`event`]
70 - result `event_with_signature`
71
72#### optional
73
74
75- **connect**
76 - params [`pubkey`]
77- **disconnect**
78 - params []
79- **delegate**
80 - params [`delegatee`, `{ kind: number, since: number, until: number }`]
81 - result `{ from: string, to: string, cond: string, sig: string }`
82- **get_relays**
83 - params []
84 - result `{ [url: string]: {read: boolean, write: boolean} }`
85- **nip04_encrypt**
86 - params [`pubkey`, `plaintext`]
87 - result `nip4 ciphertext`
88- **nip04_decrypt**
89 - params [`pubkey`, `nip4 ciphertext`]
90 - result [`plaintext`]
91
92
93NOTICE: `pubkey` and `signature` are hex-encoded strings.
94
95
96### Nostr Connect URI
97
98**Signer** discovers **App** by scanning a QR code, clicking on a deep link or copy-pasting an URI.
99
100The **App** generates a special URI with prefix `nostrconnect://` and base path the hex-encoded `pubkey` with the following querystring parameters **URL encoded**
101
102- `relay` URL of the relay of choice where the **App** is connected and the **Signer** must send and listen for messages.
103- `metadata` metadata JSON of the **App**
104 - `name` human-readable name of the **App**
105 - `url` (optional) URL of the website requesting the connection
106 - `description` (optional) description of the **App**
107 - `icons` (optional) array of URLs for icons of the **App**.
108
109#### JavaScript
110
111```js
112const uri = `nostrconnect://<pubkey>?relay=${encodeURIComponent("wss://relay.damus.io")}&metadata=${encodeURIComponent(JSON.stringify({"name": "Example"}))}`
113```
114
115#### Example
116```sh
117nostrconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&metadata=%7B%22name%22%3A%22Example%22%7D
118```
119
120
121
122## Flows
123
124The `content` field contains encrypted message as specified by [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). The `kind` chosen is `24133`.
125
126### Connect
127
1281. User clicks on **"Connect"** button on a website or scan it with a QR code
1292. It will show an URI to open a "nostr connect" enabled **Signer**
1303. In the URI there is a pubkey of the **App** ie. `nostrconnect://<pubkey>&relay=<relay>&metadata=<metadata>`
1314. The **Signer** will send a message to ACK the `connect` request, along with his public key
132
133### Disconnect (from App)
134
1351. User clicks on **"Disconnect"** button on the **App**
1362. The **App** will send a message to the **Signer** with a `disconnect` request
1373. The **Signer** will send a message to ACK the `disconnect` request
138
139### Disconnect (from Signer)
140
1411. User clicks on **"Disconnect"** button on the **Signer**
1422. The **Signer** will send a message to the **App** with a `disconnect` request
143
144
145### Get Public Key
146
1471. The **App** will send a message to the **Signer** with a `get_public_key` request
1483. The **Signer** will send back a message with the public key as a response to the `get_public_key` request
149
150### Sign Event
151
1521. The **App** will send a message to the **Signer** with a `sign_event` request along with the **event** to be signed
1532. The **Signer** will show a popup to the user to inspect the event and sign it
1543. The **Signer** will send back a message with the event including the `id` and the schnorr `signature` as a response to the `sign_event` request
155
156### Delegate
157
1581. The **App** will send a message with metadata to the **Signer** with a `delegate` request along with the **conditions** query string and the **pubkey** of the **App** to be delegated.
1592. The **Signer** will show a popup to the user to delegate the **App** to sign on his behalf
1603. The **Signer** will send back a message with the signed [NIP-26 delegation token](https://github.com/nostr-protocol/nips/blob/master/26.md) or reject it
161
162
diff --git a/47.md b/47.md
new file mode 100644
index 0000000..c884b97
--- /dev/null
+++ b/47.md
@@ -0,0 +1,137 @@
1NIP-47
2======
3
4Nostr Wallet Connect
5--------------------
6
7`draft` `optional` `author:kiwiidb` `author:bumi` `author:semisol` `author:vitorpamplona`
8
9## Rationale
10
11This 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.
12
13## Terms
14
15* **client**: Nostr app on any platform that wants to pay Lightning invoices.
16* **user**: The person using the **client**, and want's to connect their wallet app to their **client**.
17* **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.
18
19## Theory of Operation
20 1. **Users** who which 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.
21
22 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.
23
24 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.
25
26 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.
27
28## Events
29
30There are three event kinds:
31- `NIP-47 info event`: 13194
32- `NIP-47 request`: 23194
33- `NIP-47 response`: 23195
34
35The 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
36a plaintext string with the supported commands, space-seperated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs.
37
38Both 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.
39
40The content of requests and responses 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:
41
42Request:
43```jsonc
44{
45 "method": "pay_invoice", // method, string
46 "params": { // params, object
47 "invoice": "lnbc50n1..." // command-related data
48 }
49}
50```
51
52Response:
53```jsonc
54{
55 "result_type": "pay_invoice", //indicates the structure of the result field
56 "error": { //object, non-null in case of error
57 "code": "UNAUTHORIZED", //string error code, see below
58 "message": "human readable error message"
59 },
60 "result": { // result, object. null in case of error.
61 "preimage": "0123456789abcdef..." // command-related data
62 }
63}
64```
65
66The `result_type` field MUST contain the name of the method that this event is responding to.
67The `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 succesful.
68If the command was succesful, the `error` field must be null.
69
70### Error codes
71- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds.
72- `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented.
73- `INSUFFICIENT_BALANCE`: The wallet does not have enough funds to cover a fee reserve or the payment amount.
74- `QUOTA_EXCEEDED`: The wallet has exceeded its spending quota.
75- `RESTRICTED`: This public key is not allowed to do this operation.
76- `UNAUTHORIZED`: This public key has no wallet connected.
77- `INTERNAL`: An internal error.
78- `OTHER`: Other error.
79
80## Nostr Wallet Connect URI
81**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI.
82
83The **wallet service** generates this connection URI with protocol `nostr+walletconnect:` and base path it's hex-encoded `pubkey` with the following query string parameters:
84
85- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one.
86- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**.
87 - Authorization does not require passing keys back and forth.
88 - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets).
89 - The key is harder to leak since it is not shown to the user and backed up.
90 - It improves privacy because the user's main key would not be linked to their payments.
91- `lud16` Recommended. A lightning address that clients can use to automatically setup the `lud16` field on the user's profile if they have none configured.
92
93The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events.
94
95### Example connection string
96```sh
97nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c
98```
99
100## Commands
101
102### `pay_invoice`
103
104Description: Requests payment of an invoice.
105
106Request:
107```jsonc
108{
109 "method": "pay_invoice",
110 "params": {
111 "invoice": "lnbc50n1..." // bolt11 invoice
112 }
113}
114```
115
116Response:
117```jsonc
118{
119 "result_type": "pay_invoice",
120 "result": {
121 "preimage": "0123456789abcdef..." // preimage of the payment
122 }
123}
124```
125
126Errors:
127- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar.
128
129## Example pay invoice flow
130
1310. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually.
1321. **client** sends an event to the **wallet service** service with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above.
1332. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment.
1343. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage.
135
136## Using a dedicated relay
137This 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.
diff --git a/50.md b/50.md
new file mode 100644
index 0000000..5bda355
--- /dev/null
+++ b/50.md
@@ -0,0 +1,49 @@
1NIP-50
2======
3
4Search Capability
5-----------------
6
7`draft` `optional` `author:brugeman` `author:mikedilger` `author:fiatjaf`
8
9## Abstract
10
11Many Nostr use cases require some form of general search feature, in addition to structured queries by tags or ids.
12Specifics of the search algorithms will differ between event kinds, this NIP only describes a general
13extensible framework for performing such queries.
14
15## `search` filter field
16
17A new `search` field is introduced for `REQ` messages from clients:
18```json
19{
20 ...
21 "search": <string>
22}
23```
24`search` field is a string describing a query in a human-readable form, i.e. "best nostr apps".
25Relays SHOULD interpret the query to the best of their ability and return events that match it.
26Relays SHOULD perform matching against `content` event field, and MAY perform
27matching against other fields if that makes sense in the context of a specific kind.
28
29A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore
30extensions they don't support.
31
32Clients may specify several search filters, i.e. `["REQ", "", { "search": "orange" }, { "kinds": [1, 2], "search": "purple" }]`. Clients may
33include `kinds`, `ids` and other filter field to restrict the search results to particular event kinds.
34
35Clients SHOULD use the supported_nips field to learn if a relay supports `search` filter. Clients MAY send `search`
36filter queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP.
37
38Clients SHOULD query several relays supporting this NIP to compensate for potentially different
39implementation details between relays.
40
41Clients MAY verify that events returned by a relay match the specified query in a way that suits the
42client's use case, and MAY stop querying relays that have low precision.
43
44Relays SHOULD exclude spam from search results by default if they supports some form of spam filtering.
45
46## Extensions
47
48Relay MAY support these extensions:
49- `include:spam` - turn off spam filtering, if it was enabled by default
diff --git a/51.md b/51.md
new file mode 100644
index 0000000..80cc09e
--- /dev/null
+++ b/51.md
@@ -0,0 +1,112 @@
1NIP-51
2======
3
4Lists
5-------------------------
6
7`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `depends:33`
8
9A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created.
10
11If a list type should only be defined once per user (like the 'Mute' list), the list type's events should follow the specification for [NIP-16 - Replaceable Events](16.md). These lists may be referred to as 'replaceable lists'.
12
13Otherwise, the list type's events should follow the specification for [NIP-33 - Parameterized Replaceable Events](33.md), where the list name will be used as the 'd' parameter. These lists may be referred to as 'parameterized replaceable lists'.
14
15## Replaceable List Event Example
16
17Lets say a user wants to create a 'Mute' list and has keys:
18```
19priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
20pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
21```
22The user wants to publicly include these users:
23
24```json
25["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
26["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
27```
28and privately include these users (below is the JSON that would be encrypted and placed in the event content):
29
30```json
31[
32 ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"],
33 ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"]
34]
35```
36
37Then the user would create a 'Mute' list event like below:
38
39```json
40{
41 "kind": 10000,
42 "tags": [
43 ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
44 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
45 ],
46 "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==",
47 ...other fields
48}
49```
50
51
52## Parameterized Replaceable List Event Example
53
54Lets say a user wants to create a 'Categorized People' list of `nostr` people and has keys:
55```
56priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
57pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
58```
59The user wants to publicly include these users:
60
61```json
62["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
63["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
64```
65and privately include these users (below is the JSON that would be encrypted and placed in the event content):
66
67```json
68[
69 ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"],
70 ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"]
71]
72```
73
74Then the user would create a 'Categorized People' list event like below:
75
76```json
77{
78 "kind": 30000,
79 "tags": [
80 ["d", "nostr"],
81 ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
82 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
83 ],
84 "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==",
85 ...other fields
86}
87```
88
89## List Event Kinds
90
91| kind | list type |
92| ------ | ----------------------- |
93| 10000 | Mute |
94| 10001 | Pin |
95| 30000 | Categorized People |
96| 30001 | Categorized Bookmarks |
97
98### Mute List
99
100An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List.
101
102### Pin List
103
104An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standardized tag can be included in a Pin List.
105
106### Categorized People List
107
108An event with kind `30000` is defined as a parameterized replaceable list event for categorizing people. The 'd' parameter for this event holds the category name of the list. The tags included in these lists MUST follow the format of kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md).
109
110### Categorized Bookmarks List
111
112An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List.
diff --git a/56.md b/56.md
new file mode 100644
index 0000000..55ee1a2
--- /dev/null
+++ b/56.md
@@ -0,0 +1,82 @@
1
2NIP-56
3======
4
5Reporting
6---------
7
8`draft` `optional` `author:jb55`
9
10A report is a `kind 1984` note that is used to report other notes for spam,
11illegal and explicit content.
12
13The content MAY contain additional information submitted by the entity
14reporting the content.
15
16Tags
17----
18
19The report event MUST include a `p` tag referencing the pubkey of the user you
20are reporting.
21
22If reporting a note, an `e` tag MUST also be included referencing the note id.
23
24A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag
25being reported, which consists of the following report types:
26
27- `nudity` - depictions of nudity, porn, etc.
28- `profanity` - profanity, hateful speech, etc.
29- `illegal` - something which may be illegal in some jurisdiction
30- `spam` - spam
31- `impersonation` - someone pretending to be someone else
32
33Some report tags only make sense for profile reports, such as `impersonation`
34
35Example events
36--------------
37
38```json
39{
40 "kind": 1984,
41 "tags": [
42 [ "p", <pubkey>, "nudity"]
43 ],
44 "content": "",
45 ...
46}
47
48{
49 "kind": 1984,
50 "tags": [
51 [ "e", <eventId>, "illegal"],
52 [ "p", <pubkey>]
53 ],
54 "content": "He's insulting the king!",
55 ...
56}
57
58{
59 "kind": 1984,
60 "tags": [
61 [ "p", <impersonator pubkey>, "impersonation"],
62 [ "p", <victim pubkey>]
63 ],
64 "content": "Profile is imitating #[1]",
65 ...
66}
67```
68
69Client behavior
70---------------
71
72Clients can use reports from friends to make moderation decisions if they
73choose to. For instance, if 3+ of your friends report a profile as explicit,
74clients can have an option to automatically blur photos from said account.
75
76
77Relay behavior
78--------------
79
80It is not recommended that relays perform automatic moderation using reports,
81as they can be easily gamed. Admins could use reports from trusted moderators to
82takedown illegal or explicit content if the relay does not allow such things.
diff --git a/57.md b/57.md
new file mode 100644
index 0000000..17042ea
--- /dev/null
+++ b/57.md
@@ -0,0 +1,183 @@
1NIP-57
2======
3
4Lightning Zaps
5--------------
6
7`draft` `optional` `author:jb55` `author:kieran`
8
9This NIP defines two new event types for recording lightning payments between users. `9734` is a `zap request`, representing a payer's request to a recipient's lightning wallet for an invoice. `9735` is a `zap receipt`, representing the confirmation by the recipient's lightning wallet that the invoice issued in response to a zap request has been paid.
10
11Having lightning receipts on nostr allows clients to display lightning payments from entities on the network. These can be used for fun or for spam deterrence.
12
13## Protocol flow
14
151. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values.
162. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a zap receipt rather than a normal lnurl invoice.
173. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it.
184. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example.
195. The recipient's lnurl server will receive this request and validate it. See Appendix C for details on how to properly configure an lnurl server to support zaps, and Appendix D for details on how to validate the `nostr` query parameter.
206. If the request is valid, the server should fetch a description hash invoice where the description is this note and this note only. No additional lnurl metadata is included in the description. This will be returned in the response according to [LUD06](https://github.com/lnurl/luds/blob/luds/06.md).
217. On receiving the invoice, the client MAY pay it or pass it to an app that can pay the invoice.
228. Once the invoice is paid, the recipient's lnurl server MUST generate a `zap receipt` as described in Appendix E, and publish it to the `relays` specified in the `zap request`.
239. Clients MAY fetch zap notes on posts and profiles, but MUST authorize their validity as described in Appendix F. If the zap request note contains a non-empty `content`, it may display a zap comment. Generally clients should show users the `zap request` note, and use the `zap note` to show "zap authorized by ..." but this is optional.
24
25## Reference and examples
26
27### Appendix A: Zap Request Event
28
29A `zap request` is an event of kind `9734` that is _not_ published to relays, but is instead sent to a recipient's lnurl pay `callback` url. This event's `content` MAY be an optional message to send along with the payment. The event MUST include the following tags:
30
31- `relays` is a list of relays the recipient's wallet should publish its `zap receipt` to. Note that relays should not be nested in an additional list, but should be included as shown in the example below.
32- `amount` is the amount in _millisats_ the sender intends to pay, formatted as a string. This is recommended, but optional.
33- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl`. This is recommended, but optional.
34- `p` is the hex-encoded pubkey of the recipient.
35
36In addition, the event MAY include the following tags:
37
38- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person.
39- `a` is an optional NIP-33 event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes.
40
41Example:
42
43```json
44{
45 "kind": 9734,
46 "content": "Zap!",
47 "tags": [
48 ["relays", "wss://nostr-pub.wellorder.com"],
49 ["amount", "21000"],
50 ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"],
51 ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"],
52 ["e", "9ae37aa68f48645127299e9453eb5d908a0cbb6058ff340d528ed4d37c8994fb"]
53 ],
54 "pubkey": "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322",
55 "created_at": 1679673265,
56 "id": "30efed56a035b2549fcaeec0bf2c1595f9a9b3bb4b1a38abaf8ee9041c4b7d93",
57 "sig": "f2cb581a84ed10e4dc84937bd98e27acac71ab057255f6aa8dfa561808c981fe8870f4a03c1e3666784d82a9c802d3704e174371aa13d63e2aeaf24ff5374d9d"
58}
59```
60
61### Appendix B: Zap Request HTTP Request
62
63A signed zap request event is not published, but is instead sent using a HTTP GET request to the recipient's `callback` url, which was provided by the recipient's lnurl pay endpoint. This request should have the following query parameters defined:
64
65- `amount` is the amount in _millisats_ the sender intends to pay
66- `nostr` is the `9734` zap request event, JSON encoded then URI encoded
67- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl`
68
69This 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:
70
71```javascript
72const senderPubkey // The sender's pubkey
73const recipientPubkey = // The recipient's pubkey
74const callback = // The callback received from the recipients lnurl pay endpoint
75const lnurl = // The recipient's lightning address, encoded as a lnurl
76const sats = 21
77
78const amount = sats * 1000
79const relays = ['wss://nostr-pub.wellorder.net']
80const event = encodeURI(JSON.stringify(await signEvent({
81 kind: [9734],
82 content: "",
83 pubkey: senderPubkey,
84 created_at: Math.round(Date.now() / 1000),
85 tags: [
86 ["relays", ...relays],
87 ["amount", amount.toString()],
88 ["lnurl", lnurl],
89 ["p", recipientPubkey],
90 ],
91})))
92
93const {pr: invoice} = await fetchJson(`${callback}?amount=${amount}&nostr=${event}&lnurl=${lnurl}`)
94```
95
96### Appendix C: LNURL Server Configuration
97
98The lnurl server will need some additional pieces of information so that clients can know that zap invoices are supported:
99
1001. Add a `nostrPubkey` to the lnurl-pay static endpoint `/.well-known/lnurlp/<user>`, where `nostrPubkey` is the nostr pubkey your server will use to sign `zap receipt` events. Clients will use this to validate zap receipts.
1012. Add an `allowsNostr` field and set it to true.
102
103### Appendix D: LNURL Server Zap Request Validation
104
105When a client sends a zap request event to a server's lnurl-pay callback URL, there will be a `nostr` query parameter where the contents of the event are URI- and JSON-encoded. If present, the zap request event must be validated in the following ways:
106
1071. It MUST have a valid nostr signature
1082. It MUST have tags
1093. It MUST have only one `p` tag
1104. It MUST have 0 or 1 `e` tags
1115. There should be a `relays` tag with the relays to send the `zap` note to.
1126. If there is an `amount` tag, it MUST be equal to the `amount` query parameter.
1137. If there is an `a` tag, it MUST be a valid NIP-33 event coordinate
114
115The event MUST then be stored for use later, when the invoice is paid.
116
117### Appendix E: Zap Receipt Event
118
119A `zap receipt` is created by a lightning node when an invoice generated by a `zap request` is paid. Zap receipts are only created when the invoice description (committed to the description hash) contains a zap request note.
120
121When receiving a payment, the following steps are executed:
122
1231. Get the description for the invoice. This needs to be saved somewhere during the generation of the description hash invoice. It is saved automatically for you with CLN, which is the reference implementation used here.
1242. Parse the bolt11 description as a JSON nostr event. This SHOULD be validated based on the requirements in Appendix D, either when it is received, or before the invoice is paid.
1253. Create a nostr event of kind `9735` as described below, and publish it to the `relays` declared in the zap request.
126
127The following should be true of the zap receipt event:
128
129- The content SHOULD be empty.
130- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency.
131- `tags` MUST include the `p` tag AND optional `e` tag from the zap request.
132- The zap receipt MUST have a `bolt11` tag containing the description hash bolt11 invoice.
133- The zap receipt MUST contain a `description` tag which is the JSON-encoded invoice description.
134- `SHA256(description)` MUST match the description hash in the bolt11 invoice.
135- The zap receipt MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the zap receipt for the legitimacy of the payment.
136
137The zap receipt is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the zap receipt implies the invoice as paid, but it could be a lie given a rogue implementation.
138
139A reference implementation for a zap-enabled lnurl server can be found [here](https://github.com/jb55/cln-nostr-zapper).
140
141Example zap receipt:
142
143```json
144{
145 "id": "67b48a14fb66c60c8f9070bdeb37afdfcc3d08ad01989460448e4081eddda446",
146 "pubkey": "9630f464cca6a5147aa8a35f0bcdd3ce485324e732fd39e09233b1d848238f31",
147 "created_at": 1674164545,
148 "kind": 9735,
149 "tags": [
150 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
151 ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"],
152 ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"],
153 ["description", "{\"pubkey\":\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"],
154 ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"]
155 ],
156 "content": "",
157 "sig": "b0a3c5c984ceb777ac455b2f659505df51585d5fd97a0ec1fdb5f3347d392080d4b420240434a3afd909207195dac1e2f7e3df26ba862a45afd8bfe101c2b1cc"
158 }
159```
160
161### Appendix F: Validating Zap Receipts
162
163A client can retrieve `zap receipts` on events and pubkeys using a NIP-01 filter, for example `{"kinds": [9735], "#e": [...]}`. Zaps MUST be validated using the following steps:
164
165- The `zap receipt` event's `pubkey` MUST be the same as the recipient's lnurl provider's `nostrPubkey` (retrieved in step 1 of the protocol flow).
166- The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present).
167- The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`.
168
169### Appendix G: `zap` tag on zapped event
170
171When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay request based on it's value instead of the profile's field. An optional third argument on the tag specifies the type of value, either `lud06` or `lud16`.
172
173```json
174{
175 "tags": [
176 [ "zap", "pablo@f7z.io", "lud16" ]
177 ]
178}
179```
180
181## Future Work
182
183Zaps can be extended to be more private by encrypting zap request notes to the target user, but for simplicity it has been left out of this initial draft.
diff --git a/58.md b/58.md
new file mode 100644
index 0000000..2fa4406
--- /dev/null
+++ b/58.md
@@ -0,0 +1,132 @@
1NIP-58
2======
3
4Badges
5------
6
7`draft` `optional` `author:cameri`
8
9Three special events are used to define, award and display badges in
10user profiles:
11
121. A "Badge Definition" event is defined as a parameterized replaceable event
13with kind `30009` having a `d` tag with a value that uniquely identifies
14the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can
15be updated.
16
172. A "Badge Award" event is a kind `8` event with a single `a` tag referencing
18a "Define Badge" event and one or more `p` tags, one for each pubkey the
19badge issuer wishes to award. The value for the `a` tag MUST follow the format
20defined in [NIP-33](33.md). Awarded badges are immutable and non-transferrable.
21
223. A "Profile Badges" event is defined as a parameterized replaceable event
23with kind `30008` with a `d` tag with the value `profile_badges`.
24Profile 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.
25
26### Badge Definition event
27
28The following tags MUST be present:
29
30- `d` tag with the unique name of the badge.
31
32The following tags MAY be present:
33
34- A `name` tag with a short name for the badge.
35- `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels.
36- A `description` tag whose value MAY contain a textual representation of the
37image, the meaning behind the badge, or the reason of it's issuance.
38- One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels.
39
40### Badge Award event
41
42The following tags MUST be present:
43
44- An `a` tag referencing a kind `30009` Badge Definition event.
45- One or more `p` tags referencing each pubkey awarded.
46
47### Profile Badges Event
48
49The number of badges a pubkey can be awarded is unbounded. The Profile Badge
50event allows individual users to accept or reject awarded badges, as well
51as choose the display order of badges on their profiles.
52
53The following tags MUST be present:
54
55- A `d` tag with the unique identifier `profile_badges`
56
57The following tags MAY be present:
58
59- Zero or more ordered consecutive pairs of `a` and `e` tags referencing a kind `30009` Badge Definition and kind `8` Badge Award, respectively. Clients SHOULD
60ignore `a` without corresponding `e` tag and viceversa. Badge Awards referenced
61by the `e` tags should contain the same `a` tag.
62
63### Motivation
64
65Users MAY be awarded badges (but not limited to) in recognition, in gratitude, for participation, or in appreciation of a certain goal, task or cause.
66
67Users MAY choose to decorate their profiles with badges for fame, notoriety, recognition, support, etc., from badge issuers they deem reputable.
68
69### Recommendations
70
71Badge issuers MAY include some Proof of Work as per [NIP-13](13.md) when minting Badge Definitions or Badge Awards to embed them with a combined energy cost, arguably making them more special and valuable for users that wish to collect them.
72
73Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users.
74
75Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels.
76
77Badge thumbnail image recommended dimensions are: 512x512 (xl), 256x256 (l), 64x64 (m), 32x32 (s) and 16x16 (xs).
78
79Clients MAY choose to render less badges than those specified by users in the Profile Badges event or replace the badge image and thumbnails with ones that fits the theme of the client.
80
81Clients SHOULD attempt to render the most appropriate badge thumbnail according to the number of badges chosen by the user and space available. Clients SHOULD attempt render the high-res version on user action (click, tap, hover).
82
83### Example of a Badge Definition event
84
85```json
86{
87 "pubkey": "alice",
88 "kind": 30009,
89 "tags": [
90 ["d", "bravery"],
91 ["name", "Medal of Bravery"],
92 ["description", "Awarded to users demonstrating bravery"],
93 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
94 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"],
95 ],
96 ...
97}
98```
99
100### Example of Badge Award event
101
102```json
103{
104 "id": "<badge award event id>",
105 "kind": 8,
106 "pubkey": "alice",
107 "tags": [
108 ["a", "30009:alice:bravery"],
109 ["p", "bob", "wss://relay"],
110 ["p", "charlie", "wss://relay"],
111 ],
112 ...
113}
114```
115
116### Example of a Profile Badges event
117
118Honorable Bob The Brave:
119```json
120{
121 "kind": 30008,
122 "pubkey": "bob",
123 "tags": [
124 ["d", "profile_badges"],
125 ["a", "30009:alice:bravery"],
126 ["e", "<bravery badge award event id>", "wss://nostr.academy"],
127 ["a", "30009:alice:honor"],
128 ["e", "<honor badge award event id>", "wss://nostr.academy"],
129 ],
130 ...
131}
132```
diff --git a/65.md b/65.md
new file mode 100644
index 0000000..4c7a6a5
--- /dev/null
+++ b/65.md
@@ -0,0 +1,76 @@
1NIP-65
2======
3
4Relay List Metadata
5-------------------
6
7`draft` `optional` `author:mikedilger`
8
9A special replaceable event meaning "Relay List Metadata" is defined as an event with kind `10002` having a list of `r` tags, one for each relay the author uses to either read or write to.
10
11The primary purpose of this relay list is to advertise to others, not for configuring one's client.
12
13The content is not used and SHOULD be an empty string.
14
15The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes.
16
17Clients SHOULD, as with all replaceable events, use only the most recent kind-10002 event they can find.
18
19### The meaning of read and write
20
21Write relays are for events that are intended for anybody (e.g. your followers). Read relays are for events that address a particular person.
22
23Clients SHOULD write feed-related events created by their user to their user's write relays.
24
25Clients SHOULD read feed-related events created by another from at least some of that other person's write relays. Explicitly, they SHOULD NOT expect them to be available at their user's read relays. It SHOULD NOT be presumed that the user's read relays coincide with the write relays of the people the user follows.
26
27Clients SHOULD read events that tag their user from their user's read relays.
28
29Clients SHOULD write events that tag a person to at least some of that person's read relays. Explicitly, they SHOULD NOT expect that person will pick them up from their user's write relays. It SHOULD NOT be presumed that the user's write relays coincide with the read relays of the person being tagged.
30
31Clients SHOULD presume that if their user has a pubkey in their ContactList (kind 3) that it is because they wish to see that author's feed-related events. But clients MAY presume otherwise.
32
33### Motivation
34
35There is a common nostr use case where users wish to follow the content produced by other users. This is evidenced by the implicit meaning of the Contact List in [NIP-02](02.md)
36
37Because users don't often share the same sets of relays, ad-hoc solutions have arisen to get that content, but these solutions negatively impact scalability and decentralization:
38
39 - Most people are sending their posts to the same most popular relays in order to be more widely seen
40 - Many people are pulling from a large number of relays (including many duplicate events) in order to get more data
41 - Events are being copied between relays, oftentimes to many different relays
42
43### Purposes
44
45The purpose of this NIP is to help clients find the events of the people they follow, to help tagged events get to the people tagged, and to help nostr scale better.
46
47### Suggestions
48
49It is suggested that people spread their kind `10002` events to many relays, but write their normal feed-related events to a much smaller number of relays (between 2 to 6 relays). It is suggested that clients offer a way for users to spread their kind `10002` events to many more relays than they normally post to.
50
51Authors may post events outside of the feed that they wish their followers to follow by posting them to relays outside of those listed in their "Relay List Metadata". For example, an author may want to reply to someone without all of their followers watching.
52
53It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because
54
55 - finding where someone posts is rather important
56 - these events do not have content that needs management
57 - relays only need to store one replaceable event per pubkey to offer this service
58
59### Why not in kind `0` Metadata
60
61Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have content that may require moderation by relay operators so that it is more acceptable to relays.
62
63### Example
64
65```json
66{
67 "kind": 10002,
68 "tags": [
69 ["r", "wss://alicerelay.example.com"],
70 ["r", "wss://brando-relay.com"],
71 ["r", "wss://expensive-relay.example2.com", "write"],
72 ["r", "wss://nostr-relay.example.com", "read"],
73 ],
74 "content": "",
75 ...other fields
76```
diff --git a/78.md b/78.md
new file mode 100644
index 0000000..10ff535
--- /dev/null
+++ b/78.md
@@ -0,0 +1,21 @@
1NIP-78
2======
3
4Arbitrary custom app data
5-------------------------
6
7`draft` `optional` `author:sandwich` `author:fiatjaf`
8
9The goal of this NIP is to enable [remoteStorage](https://remotestorage.io/)-like capabilities for custom applications that do not care about interoperability.
10
11Even though interoperability is great, some apps do not want or do not need interoperability, and it wouldn't make sense for them. Yet Nostr can still serve as a generalized data storage for these apps in a "bring your own database" way, for example: a user would open an app and somehow input their preferred relay for storage, which would then enable these apps to store application-specific data there.
12
13## Nostr event
14
15This NIP specifies the use of event kind `30078` (parameterized replaceable event) with a `d` tag containing some reference to the app name and context -- or any other arbitrary string. `content` and other `tags` can be anything or in any format.
16
17## Some use cases
18
19 - User personal settings on Nostr clients (and other apps unrelated to Nostr)
20 - A way for client developers to propagate dynamic parameters to users without these having to update
21 - Personal private data generated by apps that have nothing to do with Nostr, but allow users to use Nostr relays as their personal database
diff --git a/94.md b/94.md
new file mode 100644
index 0000000..24dd346
--- /dev/null
+++ b/94.md
@@ -0,0 +1,51 @@
1NIP-94
2======
3
4File Metadata
5-------------
6
7`draft` `optional` `author:frbitten` `author:kieran` `author:lovvtide` `author:fiatjaf` `author:staab`
8
9The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with kind:1 notes or by longform clients that deal with kind:30023 articles.
10
11## Event format
12
13This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below:
14
15* `url` the url to download the file
16* `m` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types)
17* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits
18* `x` containing the SHA-256 hexencoded string of the file.
19* `size` (optional) size of file in bytes
20* `dim` (optional) size of file in pixels in the form `<width>x<height>`
21* `magnet` (optional) URI to magnet file
22* `i` (optional) torrent infohash
23* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client
24
25```json
26{
27 "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>,
28 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
29 "created_at": <unix timestamp in seconds>,
30 "kind": 1063,
31 "tags": [
32 ["url",<string with URI of file>],
33 ["aes-256-gcm",<key>, <iv>],
34 ["m", <MIME type>],
35 ["x",<Hash SHA-256>],
36 ["size", <size of file in bytes>],
37 ["dim", <size of file in pixels>],
38 ["magnet",<magnet URI> ],
39 ["i",<torrent infohash>],
40 ["blurhash", <value>]
41 ],
42 "content": <description>,
43 "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field>
44}
45```
46
47## Suggested use cases
48
49* A relay for indexing shared files. For example, to promote torrents.
50* A pinterest-like client where people can share their portfolio and inspire others.
51* A simple way to distribute configurations and software updates.
diff --git a/README.md b/README.md
index 10bb5ef..94e945c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,23 @@
1# NIPs 1# NIPs
2 2
3NIPs stand for **Nostr Implementation Possibilities**. They exist to document what MUST, what SHOULD and what MAY be implemented by [Nostr](https://github.com/fiatjaf/nostr)-compatible _relay_ and _client_ software. 3NIPs stand for **Nostr Implementation Possibilities**.
4They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software.
5
6---
7
8- [List](#list)
9- [Event Kinds](#event-kinds)
10 - [Event Kind Ranges](#event-kind-ranges)
11- [Message Types](#message-types)
12 - [Client to Relay](#client-to-relay)
13 - [Relay to Client](#relay-to-client)
14- [Standardized Tags](#standardized-tags)
15- [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips)
16- [License](#license)
17
18---
19
20## List
4 21
5- [NIP-01: Basic protocol flow description](01.md) 22- [NIP-01: Basic protocol flow description](01.md)
6- [NIP-02: Contact List and Petnames](02.md) 23- [NIP-02: Contact List and Petnames](02.md)
@@ -9,68 +26,150 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh
9- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) 26- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
10- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) 27- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md)
11- [NIP-07: `window.nostr` capability for web browsers](07.md) 28- [NIP-07: `window.nostr` capability for web browsers](07.md)
12- [NIP-08: Handling Mentions](08.md) 29- [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md)
13- [NIP-09: Event Deletion](09.md) 30- [NIP-09: Event Deletion](09.md)
14- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events.](10.md) 31- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md)
15- [NIP-11: Relay Information Document](11.md) 32- [NIP-11: Relay Information Document](11.md)
16- [NIP-12: Generic Tag Queries](12.md) 33- [NIP-12: Generic Tag Queries](12.md)
17- [NIP-13: Proof of Work](13.md) 34- [NIP-13: Proof of Work](13.md)
18- [NIP-14: Subject tag in text events.](14.md) 35- [NIP-14: Subject tag in text events.](14.md)
19- [NIP-15: End of Stored Events Notice](15.md) 36- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md)
20- [NIP-16: Event Treatment](16.md) 37- [NIP-16: Event Treatment](16.md)
21- [NIP-18: Reposts](18.md) 38- [NIP-18: Reposts](18.md)
22- [NIP-19: bech32-encoded entities](19.md) 39- [NIP-19: bech32-encoded entities](19.md)
23- [NIP-20: Command Results](20.md) 40- [NIP-20: Command Results](20.md)
24- [NIP-22: Event created_at Limits](22.md) 41- [NIP-21: `nostr:` URL scheme](21.md)
42- [NIP-22: Event `created_at` Limits](22.md)
43- [NIP-23: Long-form Content](23.md)
25- [NIP-25: Reactions](25.md) 44- [NIP-25: Reactions](25.md)
26- [NIP-26: Delegated Event Signing](26.md) 45- [NIP-26: Delegated Event Signing](26.md)
46- [NIP-27: Text Note References](27.md)
27- [NIP-28: Public Chat](28.md) 47- [NIP-28: Public Chat](28.md)
28- [NIP-33: Parameterized Replaceable Events](33.md) 48- [NIP-33: Parameterized Replaceable Events](33.md)
29- [NIP-36: Sensitive Content](36.md) 49- [NIP-36: Sensitive Content](36.md)
50- [NIP-39: External Identities in Profiles](39.md)
30- [NIP-40: Expiration Timestamp](40.md) 51- [NIP-40: Expiration Timestamp](40.md)
52- [NIP-42: Authentication of clients to relays](42.md)
53- [NIP-45: Counting results](45.md)
54- [NIP-46: Nostr Connect](46.md)
55- [NIP-47: Wallet Connect](47.md)
56- [NIP-50: Keywords filter](50.md)
57- [NIP-51: Lists](51.md)
58- [NIP-56: Reporting](56.md)
59- [NIP-57: Lightning Zaps](57.md)
60- [NIP-58: Badges](58.md)
61- [NIP-65: Relay List Metadata](65.md)
62- [NIP-78: Application-specific data](78.md)
63- [NIP-94: File Metadata](94.md)
31 64
32## Event Kinds 65## Event Kinds
33 66
34| kind | description | NIP | 67| kind | description | NIP |
35|-------------|-----------------------------|------------------------| 68| ------- | -------------------------- | ----------- |
36| 0 | Metadata | [1](01.md), [5](05.md) | 69| `0` | Metadata | [1](01.md) |
37| 1 | Text | [1](01.md) | 70| `1` | Short Text Note | [1](01.md) |
38| 2 | Recommend Relay | [1](01.md) | 71| `2` | Recommend Relay | [1](01.md) |
39| 3 | Contacts | [2](02.md) | 72| `3` | Contacts | [2](02.md) |
40| 4 | Encrypted Direct Messages | [4](04.md) | 73| `4` | Encrypted Direct Messages | [4](04.md) |
41| 5 | Event Deletion | [9](09.md) | 74| `5` | Event Deletion | [9](09.md) |
42| 6 | Repost | [18](18.md) | 75| `6` | Reposts | [18](18.md) |
43| 7 | Reaction | [25](25.md) | 76| `7` | Reaction | [25](25.md) |
44| 40 | Channel Creation | [28](28.md) | 77| `8` | Badge Award | [58](58.md) |
45| 41 | Channel Metadata | [28](28.md) | 78| `40` | Channel Creation | [28](28.md) |
46| 42 | Channel Message | [28](28.md) | 79| `41` | Channel Metadata | [28](28.md) |
47| 43 | Channel Hide Message | [28](28.md) | 80| `42` | Channel Message | [28](28.md) |
48| 44 | Channel Mute User | [28](28.md) | 81| `43` | Channel Hide Message | [28](28.md) |
49| 45-49 | Public Chat Reserved | [28](28.md) | 82| `44` | Channel Mute User | [28](28.md) |
50| 10000-19999 | Replaceable Events Reserved | [16](16.md) | 83| `1063` | File Metadata | [94](94.md) |
51| 20000-29999 | Ephemeral Events Reserved | [16](16.md) | 84| `1984` | Reporting | [56](56.md) |
85| `9734` | Zap Request | [57](57.md) |
86| `9735` | Zap | [57](57.md) |
87| `10000` | Mute List | [51](51.md) |
88| `10001` | Pin List | [51](51.md) |
89| `10002` | Relay List Metadata | [65](65.md) |
90| `13194` | Wallet Info | [47](47.md) |
91| `22242` | Client Authentication | [42](42.md) |
92| `23194` | Wallet Request | [47](47.md) |
93| `23195` | Wallet Response | [47](47.md) |
94| `24133` | Nostr Connect | [46](46.md) |
95| `30000` | Categorized People List | [51](51.md) |
96| `30001` | Categorized Bookmark List | [51](51.md) |
97| `30008` | Profile Badges | [58](58.md) |
98| `30009` | Badge Definition | [58](58.md) |
99| `30017` | Create or update a stall | [15](15.md) |
100| `30018` | Create or update a product | [15](15.md) |
101| `30023` | Long-form Content | [23](23.md) |
102| `30078` | Application-specific Data | [78](78.md) |
103
104### Event Kind Ranges
52 105
106| range | description | NIP |
107| ---------------- | -------------------------------- | ----------- |
108| `1000`--`9999` | Regular Events | [16](16.md) |
109| `10000`--`19999` | Replaceable Events | [16](16.md) |
110| `20000`--`29999` | Ephemeral Events | [16](16.md) |
111| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) |
53 112
54## Message types 113## Message types
55 114
56### Client to Relay 115### Client to Relay
57| type | description | NIP | 116
58|-------|-----------------------------------------------------|------------| 117| type | description | NIP |
59| EVENT | used to publish events | [1](01.md) | 118| ------- | --------------------------------------------------- | ----------- |
60| REQ | used to request events and subscribe to new updates | [1](01.md) | 119| `AUTH` | used to send authentication events | [42](42.md) |
61| CLOSE | used to stop previous subscriptions | [1](01.md) | 120| `CLOSE` | used to stop previous subscriptions | [1](01.md) |
121| `COUNT` | used to request event counts | [45](45.md) |
122| `EVENT` | used to publish events | [1](01.md) |
123| `REQ` | used to request events and subscribe to new updates | [1](01.md) |
62 124
63### Relay to Client 125### Relay to Client
64| type | description | NIP | 126
65|--------|---------------------------------------------------------|-------------| 127| type | description | NIP |
66| EVENT | used to send events requested to clients | [1](01.md) | 128| -------- | ------------------------------------------------------- | ----------- |
67| NOTICE | used to send human-readable messages to clients | [1](01.md) | 129| `AUTH` | used to send authentication challenges | [42](42.md) |
68| EOSE | used to notify clients all stored events have been sent | [15](15.md) | 130| `COUNT` | used to send requested event counts to clients | [45](45.md) |
69| OK | used to notify clients if an EVENT was successuful | [20](20.md) | 131| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) |
132| `EVENT` | used to send events requested to clients | [1](01.md) |
133| `NOTICE` | used to send human-readable messages to clients | [1](01.md) |
134| `OK` | used to notify clients if an EVENT was successful | [20](20.md) |
70 135
71Please update these lists when proposing NIPs introducing new event kinds. 136Please update these lists when proposing NIPs introducing new event kinds.
72 137
73When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md). 138When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md).
139
140## Standardized Tags
141
142| name | value | other parameters | NIP |
143| ----------------- | ------------------------------------ | -------------------- | ------------------------ |
144| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) |
145| `d` | identifier | -- | [33](33.md) |
146| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) |
147| `g` | geohash | -- | [12](12.md) |
148| `i` | identity | proof | [39](39.md) |
149| `p` | pubkey (hex) | relay URL | [1](01.md) |
150| `r` | a reference (URL, etc) | -- | [12](12.md) |
151| `t` | hashtag | -- | [12](12.md) |
152| `amount` | millisats | -- | [57](57.md) |
153| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
154| `challenge` | challenge string | -- | [42](42.md) |
155| `content-warning` | reason | -- | [36](36.md) |
156| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
157| `description` | badge description | -- | [58](58.md) |
158| `description` | invoice description | -- | [57](57.md) |
159| `expiration` | unix timestamp (string) | -- | [40](40.md) |
160| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
161| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
162| `name` | badge name | -- | [58](58.md) |
163| `nonce` | random | -- | [13](13.md) |
164| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
165| `published_at` | unix timestamp (string) | -- | [23](23.md) |
166| `relay` | relay url | -- | [42](42.md) |
167| `relays` | relay list | -- | [57](57.md) |
168| `subject` | subject | -- | [14](14.md) |
169| `summary` | article summary | -- | [23](23.md) |
170| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
171| `title` | article title | -- | [23](23.md) |
172| `zap` | profile name | type of value | [57](57.md) |
74 173
75## Criteria for acceptance of NIPs 174## Criteria for acceptance of NIPs
76 175