mirror of
https://github.com/nostr-protocol/nips.git
synced 2025-12-08 16:18:50 +00:00
Compare commits
15 Commits
nip20-web-
...
26-relays-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
56cc238a41 | ||
|
|
a6ad8b9a13 | ||
|
|
90bcbafb43 | ||
|
|
be92d650b3 | ||
|
|
da3ae71589 | ||
|
|
9f848583a0 | ||
|
|
e8e3809432 | ||
|
|
418cd859fc | ||
|
|
dbbb66c6de | ||
|
|
7fe572ec5a | ||
|
|
6903ff5b2c | ||
|
|
89bb08ba86 | ||
|
|
dcbd504639 | ||
|
|
f2cc7bd86f | ||
|
|
1b94488742 |
2
16.md
2
16.md
@@ -21,7 +21,7 @@ Upon an ephemeral event being received, the relay SHOULD send it to all clients
|
||||
Client Behavior
|
||||
---------------
|
||||
|
||||
Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients SHOULD NOT send ephemeral events to relays that do not support this NIP; they will most likely be persisted. Clients MAY send replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one.
|
||||
Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. Clients SHOULD NOT send ephemeral events to relays that do not support this NIP; they will most likely be persisted. Clients MAY send replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one.
|
||||
|
||||
Suggested Use Cases
|
||||
-------------------
|
||||
|
||||
93
23.md
Normal file
93
23.md
Normal file
@@ -0,0 +1,93 @@
|
||||
NIP-23
|
||||
======
|
||||
|
||||
Relays List
|
||||
-----------
|
||||
|
||||
`draft` `optional` `author:fiatjaf` `author:cameri` `author:monlovesmango` `author:giszmo`
|
||||
|
||||
A special event with kind `10001`, meaning "relay list" is defined as having a list of tags, one for each relay the author uses.
|
||||
|
||||
The content is not used.
|
||||
|
||||
The tags consist of arrays of 3 elements: the first is the relay URL, the second is the _read_ condition, the third is the _write_ condition.
|
||||
|
||||
The _read_ condition consists of a string containing a rule that follows a subset of the [runes](https://pypi.org/project/runes/) language. Specifically only the `|`, `&`, `!`, `>`, `<`, `/` and `=` operators are allowed. When the rule is an empty string it evaluates to `true`. All the operators must be tested against all possible values in the case of filter values that consist of lists of values and also in the case of event tags that can have multiple values for the same tag -- in other words, the `=` may be interpreted as a `values.any(v => v == runeValue)` instead of an `values == runeValue` operator; the `<` may be interpreted as a `values.any(v => v < runeValue)` and so on. Event tags are identified just by their tag key (for example, `e` or `p`) without the `#` prefix used in filters.
|
||||
|
||||
The `read` rule operates on the values of the [NIP-01](01.md) **filter** object, while the `write` rule operates on the values of the **event** object.
|
||||
|
||||
When a `read` rule evaluates to `false` for a given **filter** the client SHOULD NOT send that filter in a `REQ` message to that relay.
|
||||
|
||||
When a `write` rule evaluates to `false` for a given **event** the client SHOULD NOT send that event in an `EVENT` message to that relay.
|
||||
|
||||
When a rule is malformed or the client is unable to parse it for any reason (for example, for not having implemented all the operators) it SHOULD treat it as `true` if it is a _read_ rule and `false` if it is a _write_ rule.
|
||||
|
||||
### Purposes
|
||||
|
||||
This NIP serves two purposes: (1) backup and interoperability of relay lists and relay specific rules between clients; and (2) sharing of relay URLs between users.
|
||||
|
||||
The first use case is meant to make it so users can open their client -- or different clients -- in different devices and have their list of relays automatically fetched from a default relay and start using their relays list without having to set everything up again.
|
||||
|
||||
For the second purpose, if any client decides to, they can show to the user what relays other users are using, suggest that or automatically add these to the user's relay list, this can take into account the rules or more likely not. The possibility of sharing a list of relays in standardized format is good for spreading information about relays and contributes to the censorship-resistance of the network.
|
||||
|
||||
### Use cases
|
||||
|
||||
A client can expose to the user a set of premade rule templates (the user doesn't have to see the rules) for common relay policies, for example:
|
||||
|
||||
- "do not use this relay for DMs": sets _write_ to `kind/4`
|
||||
- "only use this relay for DMs": sets _write_ to `kind=4` and _read_ to `kinds=4`
|
||||
- "this is Bob's personal relay, only use it to fetch Bob's events": sets _write_ to `!` and _read_ to `authors=<bob-pubkey>`
|
||||
- "this relay is full of spambots, do not get note replies from this relay": sets _read_ to `kinds=1&e!|kinds/1`
|
||||
- "this is my personal relay, only store my stuff in it": sets _read_ to `authors=<my-pubkey>` _write_ to `pubkey=<my-pubkey>`
|
||||
|
||||
### Examples
|
||||
|
||||
(Public keys are shortened to 4 characters for readability.)
|
||||
|
||||
- Rule evaluation examples:
|
||||
|
||||
- _read_
|
||||
|
||||
- for the filter `{"kinds": [0, 1, 2, 3], "authors": ["abcd", "1234"]}`
|
||||
|
||||
- `<empty>`: `true`
|
||||
- `!`: `invalid` -> `true`
|
||||
- `zjhcxb`: `invalid` -> `true`
|
||||
- `false`: `invalid` -> `true`
|
||||
- `true`: `invalid` -> `true`
|
||||
- `authors=7890`: `false`
|
||||
- `authors=7890|authors=1234`: `true`
|
||||
- `authors=7890&authors=1234`: `false`
|
||||
- `e!`: `true`
|
||||
- `e=5555`: `false`
|
||||
- `kinds=1|kinds=4`: `true`
|
||||
- `kinds<2`: `true`
|
||||
- `kinds>7`: `false`
|
||||
- `kinds=1|kinds=7&authors=8543|authors=1234`: `true`
|
||||
|
||||
- _write_
|
||||
|
||||
- for the event `{"kind": 7, "content": "banana", "tags": ["p", "6677"], "created_at": 123456789, "pubkey": "e3e3"}`
|
||||
|
||||
- `<empty>`: `true`
|
||||
- `!`: `invalid` -> `false`
|
||||
- `7237237`: `invalid` -> `false`
|
||||
- `****`: `invalid` -> `false`
|
||||
- `pubkey=7890`: `false`
|
||||
- `pubkey=e3e3`: `true`
|
||||
- `kind=7&p=6677`: `true`
|
||||
- `created_at>999999999|e=5a5a`: `false`
|
||||
|
||||
- Full example of a kind 10001 event:
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 10001,
|
||||
"tags": [
|
||||
["wss://alicerelay.com/", "", ""],
|
||||
["wss://bobrelay.com/", "authors=ef87", "!"],
|
||||
["wss://carolrelay.com/", "", ""],
|
||||
],
|
||||
"content": "",
|
||||
...other fields
|
||||
```
|
||||
49
25.md
Normal file
49
25.md
Normal file
@@ -0,0 +1,49 @@
|
||||
|
||||
NIP-25
|
||||
======
|
||||
|
||||
Reactions
|
||||
---------
|
||||
|
||||
`draft` `optional` `author:jb55`
|
||||
|
||||
A reaction is a `kind 7` note that is used to react to `kind 1` text notes.
|
||||
|
||||
The generic reaction, represented by the `content` set to a `+` string, SHOULD
|
||||
be interpreted as a "like" or "upvote".
|
||||
|
||||
A reaction with `content` set to `-` SHOULD be interepreted as a "dislike" or
|
||||
"downvote". It SHOULD NOT be counted as a "like", and MAY be displayed as a
|
||||
downvote or dislike on a post. A client MAY also choose to tally likes against
|
||||
dislikes in a reddit-like system of upvotes and downvotes, or display them as
|
||||
separate tallys.
|
||||
|
||||
The `content` MAY be an emoji, in this case it MAY be interpreted as a "like",
|
||||
or the client MAY display this emoji reaction on the post.
|
||||
|
||||
Tags
|
||||
----
|
||||
|
||||
The reaction event SHOULD include `e` and `p` tags from the note the user is
|
||||
reacting to. This allows users to be notified of reactions to posts they were
|
||||
mentioned in. Including the `e` tags enables clients to pull all the reactions
|
||||
associated with individual posts or all the posts in a thread.
|
||||
|
||||
The last `e` tag MUST be the `id` of the note that is being reacted to.
|
||||
|
||||
The last `p` tag MUST be the `pubkey` of the event being reacted to.
|
||||
|
||||
Example code
|
||||
|
||||
```swift
|
||||
func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent {
|
||||
var tags: [[String]] = liked.tags.filter {
|
||||
tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p")
|
||||
}
|
||||
tags.append(["e", liked.id])
|
||||
tags.append(["p", liked.pubkey])
|
||||
let ev = NostrEvent(content: "", pubkey: pubkey, kind: 7, tags: tags)
|
||||
ev.calculate_id()
|
||||
ev.sign(privkey: privkey)
|
||||
return ev
|
||||
}
|
||||
20
README.md
20
README.md
@@ -18,17 +18,21 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh
|
||||
- [NIP-14: Subject tag in text events.](14.md)
|
||||
- [NIP-15: End of Stored Events Notice](15.md)
|
||||
- [NIP-16: Event Treatment](16.md)
|
||||
- [NIP-23: Relays List](23.md)
|
||||
- [NIP-25: Reactions](25.md)
|
||||
|
||||
## Event Kinds
|
||||
|
||||
| kind | description | NIP |
|
||||
|------|---------------------------|------|
|
||||
| 0 | Metadata | 1, 5 |
|
||||
| 1 | Text | 1 |
|
||||
| 2 | Recommend Relay | 1 |
|
||||
| 3 | Contacts | 2 |
|
||||
| 4 | Encrypted Direct Messages | 4 |
|
||||
| 5 | Event Deletion | 9 |
|
||||
| kind | description | NIP |
|
||||
| ------ | --------------------------- | ------ |
|
||||
| 0 | Metadata | 1, 5 |
|
||||
| 1 | Text | 1 |
|
||||
| 2 | Recommend Relay | 1 |
|
||||
| 3 | Contacts | 2 |
|
||||
| 4 | Encrypted Direct Messages | 4 |
|
||||
| 5 | Event Deletion | 9 |
|
||||
| 7 | Reaction | 25 |
|
||||
| 10001 | Relays List | 23 |
|
||||
|
||||
Please update this list when proposing NIPs introducing new event kinds.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user