mirror of
https://github.com/nostr-protocol/nips.git
synced 2025-12-23 15:08:51 +00:00
Compare commits
1 Commits
relay-tag
...
nip34-thin
| Author | SHA1 | Date | |
|---|---|---|---|
|
614223dd2e |
2
01.md
2
01.md
@@ -4,7 +4,7 @@ NIP-01
|
||||
Basic protocol flow description
|
||||
-------------------------------
|
||||
|
||||
`draft` `mandatory` `relay`
|
||||
`draft` `mandatory`
|
||||
|
||||
This 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.
|
||||
|
||||
|
||||
2
04.md
2
04.md
@@ -6,7 +6,7 @@ NIP-04
|
||||
Encrypted Direct Message
|
||||
------------------------
|
||||
|
||||
`final` `unrecommended` `optional` `relay`
|
||||
`final` `unrecommended` `optional`
|
||||
|
||||
A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes:
|
||||
|
||||
|
||||
2
09.md
2
09.md
@@ -4,7 +4,7 @@ NIP-09
|
||||
Event Deletion Request
|
||||
----------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
A special event with kind `5`, meaning "deletion request" is defined as having a list of one or more `e` or `a` tags, each referencing an event the author is requesting to be deleted. Deletion requests SHOULD include a `k` tag for the kind of each event being requested for deletion.
|
||||
|
||||
|
||||
2
11.md
2
11.md
@@ -4,7 +4,7 @@ NIP-11
|
||||
Relay Information Document
|
||||
--------------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
Relays 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.
|
||||
|
||||
|
||||
2
13.md
2
13.md
@@ -4,7 +4,7 @@ NIP-13
|
||||
Proof of Work
|
||||
-------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines a way to generate and interpret Proof of Work for nostr notes. Proof of Work (PoW) is a way to add a proof of computational work to a note. This is a bearer proof that all relays and clients can universally validate with a small amount of code. This proof can be used as a means of spam deterrence.
|
||||
|
||||
|
||||
2
17.md
2
17.md
@@ -4,7 +4,7 @@ NIP-17
|
||||
Private Direct Messages
|
||||
-----------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines an encrypted chat scheme which uses [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps.
|
||||
|
||||
|
||||
13
18.md
13
18.md
@@ -21,9 +21,9 @@ reposted.
|
||||
|
||||
## Quote Reposts
|
||||
|
||||
Mentions to [NIP-21](21.md) entities like `nevent`, `note` and `naddr` on any
|
||||
event must be converted into `q` tags. The `q` tag ensures quote reposts are
|
||||
not pulled and included as replies in threads. It also allows you to easily
|
||||
Mentions to [NIP-21](21.md) entities like `nevent`, `note` and `naddr` on any
|
||||
event must be converted into `q` tags. The `q` tag ensures quote reposts are
|
||||
not pulled and included as replies in threads. It also allows you to easily
|
||||
pull and count all of the quotes for a post. The syntax follows
|
||||
|
||||
`["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]`
|
||||
@@ -36,10 +36,3 @@ as a "generic repost", that can include any kind of event inside other than
|
||||
|
||||
`kind 16` reposts SHOULD contain a `"k"` tag with the stringified kind number
|
||||
of the reposted event as its value.
|
||||
|
||||
When reposting a replaceable event, the repost SHOULD include an `"a"` tag with
|
||||
the event coordinate (`kind:pubkey:d-tag`) of the reposted event.
|
||||
|
||||
If the `"a"` tag is not present, it indicates that a specific version of a replaceable
|
||||
event is being reposted, in which case the `content` field must contain the full
|
||||
JSON string of the reposted event.
|
||||
|
||||
2
26.md
2
26.md
@@ -6,7 +6,7 @@ NIP-26
|
||||
Delegated Event Signing
|
||||
-----------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines how events can be delegated so that they can be signed by other keypairs.
|
||||
|
||||
|
||||
16
29.md
16
29.md
@@ -4,7 +4,7 @@ NIP-29
|
||||
Relay-based Groups
|
||||
------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines a standard for groups that are only writable by a closed set of users. They can be public for reading by external users or not.
|
||||
|
||||
@@ -83,7 +83,7 @@ Any user can send a kind `9021` event to the relay in order to request admission
|
||||
}
|
||||
```
|
||||
|
||||
The optional `code` tag may be used by the relay to preauthorize acceptance, together with the `kind:9009` `create-invite` moderation event.
|
||||
The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event.
|
||||
|
||||
- *leave request* (`kind:9022`)
|
||||
|
||||
@@ -153,18 +153,14 @@ When this event is not found, clients may still connect to the group, but treat
|
||||
["name", "Pizza Lovers"],
|
||||
["picture", "https://pizza.com/pizza.png"],
|
||||
["about", "a group for people who love pizza"],
|
||||
["private"],
|
||||
["closed"]
|
||||
["public"], // or ["private"]
|
||||
["open"] // or ["closed"]
|
||||
]
|
||||
// other fields...
|
||||
}
|
||||
```
|
||||
|
||||
- `name`, `picture` and `about` are basic metadata for the group for display purposes.
|
||||
- `private` indicates that only members can _read_ group messages. Omitting this tag indicates that anyone can read group messages.
|
||||
- `restricted` indicates that only members can _write_ messages to the group. Omitting this tag indicates that anyone can send messages to the group.
|
||||
- `hidden` indicates that relays should hide group metadata from non-members. Omitting this tag indicates that anyone can request group metadata events.
|
||||
- `closed` indicates that join requests are ignored. Omitting this tag indicates that users can expect join requests to be honored.
|
||||
`name`, `picture` and `about` are basic metadata for the group for display purposes. `public` signals the group can be _read_ by anyone, while `private` signals that only AUTHed users can read. `open` signals that anyone can request to join and the request will be automatically granted, while `closed` signals that members must be pre-approved or that requests to join will be manually handled.
|
||||
|
||||
- *group admins* (`kind:39001`) (optional)
|
||||
|
||||
@@ -235,7 +231,7 @@ The latest of either `kind:9000` or `kind:9001` events present in a group should
|
||||
|
||||
### Adding yourself to a group
|
||||
|
||||
Anyone can send a `kind:9021` join request to a group. The relay may then generate a `kind:9000` event immediately, or defer that decision to an administator. If a group is `closed`, join requests are not honored unless they include an invite code.
|
||||
When a group is `open`, anyone can send a `kind:9021` event to it in order to be added, then expect a `kind:9000` event to be emitted confirming that the user was added. The same happens with `closed` groups, except in that case a user may only send a `kind:9021` if it has an invite code.
|
||||
|
||||
### Storing your list of groups
|
||||
|
||||
|
||||
4
34.md
4
34.md
@@ -10,7 +10,7 @@ This NIP defines all the ways code collaboration using and adjacent to [`git`](h
|
||||
|
||||
## Repository announcements
|
||||
|
||||
Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events. By doing so the author asserts themselves as a maintainer and expresses a willingness to receive patches, bug reports and comments in general, unless `t` tag `personal-fork` is included.
|
||||
Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events. By doing so the author asserts themselves as a maintainer and expresses a willingness to receive patches, bug reports and comments in general, unless tag `personal-fork` is included (in which case these repositories should be treated as temporary and created only such that they could be used to open a pull request to some other repository).
|
||||
|
||||
```jsonc
|
||||
{
|
||||
@@ -25,7 +25,7 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a
|
||||
["relays", "<relay-url>", ...], // relays that this repository will monitor for patches and issues
|
||||
["r", "<earliest-unique-commit-id>", "euc"],
|
||||
["maintainers", "<other-recognized-maintainer>", ...],
|
||||
["t","personal-fork"], // optionally indicate author isn't a maintainer
|
||||
["personal-fork"], // optionally indicate author isn't a maintainer
|
||||
["t", "<arbitrary string>"], // hashtags labelling the repository
|
||||
]
|
||||
}
|
||||
|
||||
2
40.md
2
40.md
@@ -4,7 +4,7 @@ NIP-40
|
||||
Expiration Timestamp
|
||||
--------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
The `expiration` tag enables users to specify a unix timestamp at which the message SHOULD be considered expired (by relays and clients) and SHOULD be deleted by relays.
|
||||
|
||||
|
||||
2
42.md
2
42.md
@@ -4,7 +4,7 @@ NIP-42
|
||||
Authentication of clients to relays
|
||||
-----------------------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines a way for clients to authenticate to relays by signing an ephemeral event.
|
||||
|
||||
|
||||
2
43.md
2
43.md
@@ -4,7 +4,7 @@ NIP-43
|
||||
Relay Access Metadata and Requests
|
||||
----------------------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines a way for relays to advertise membership lists, and for clients to request admission to relays on behalf of users.
|
||||
|
||||
|
||||
2
45.md
2
45.md
@@ -4,7 +4,7 @@ NIP-45
|
||||
Event Counts
|
||||
------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts.
|
||||
|
||||
|
||||
2
46.md
2
46.md
@@ -41,7 +41,7 @@ There are two ways to initiate a connection:
|
||||
|
||||
_remote-signer_ provides connection token in the form:
|
||||
|
||||
`relay`
|
||||
```
|
||||
bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
|
||||
```
|
||||
|
||||
|
||||
2
50.md
2
50.md
@@ -4,7 +4,7 @@ NIP-50
|
||||
Search Capability
|
||||
-----------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
5
51.md
5
51.md
@@ -26,7 +26,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors
|
||||
| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) |
|
||||
| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) |
|
||||
| Read/write relays | 10002 | where a user publishes to and where they expect mentions | see [NIP-65](65.md) |
|
||||
| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) |
|
||||
| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
|
||||
| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) |
|
||||
| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) |
|
||||
| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) |
|
||||
@@ -52,10 +52,9 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti
|
||||
| --- | --- | --- | --- |
|
||||
| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) |
|
||||
| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) |
|
||||
| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) |
|
||||
| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
|
||||
| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) |
|
||||
| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"e"` (kind:21 videos) |
|
||||
| Curation sets | 30006 | groups of pictures picked by users as interesting and/or belonging to the same category | `"e"` (kind:20 pictures) |
|
||||
| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) |
|
||||
| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) |
|
||||
| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) |
|
||||
|
||||
2
52.md
2
52.md
@@ -56,7 +56,7 @@ Example:
|
||||
|
||||
```yaml
|
||||
{
|
||||
"id": <32-bytes lowercase hex-encoded SHA-256 of the serialized event data>,
|
||||
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
|
||||
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
|
||||
"created_at": <unix timestamp in seconds>,
|
||||
"kind": 31922,
|
||||
|
||||
34
55.md
34
55.md
@@ -107,13 +107,6 @@ Send the Intent:
|
||||
launcher.launch(intent)
|
||||
```
|
||||
|
||||
### Initiating a connection
|
||||
|
||||
- Client send a get_public_key `Intent`
|
||||
- Signer responds with the user `pubkey` and it's `packageName`
|
||||
- Client saves the `pubkey` and `packageName` somewhere and NEVER calls `get_public_key` again
|
||||
- Client now can send `content resolvers` and `Intents` for the other methods
|
||||
|
||||
#### Methods
|
||||
|
||||
- **get_public_key**
|
||||
@@ -306,6 +299,33 @@ Clients SHOULD save the user pubkey locally and avoid calling the `get_public_ke
|
||||
|
||||
#### Methods
|
||||
|
||||
- **get_public_key**
|
||||
- params:
|
||||
|
||||
```kotlin
|
||||
val result = context.contentResolver.query(
|
||||
Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"),
|
||||
listOf(hex_pub_key),
|
||||
null,
|
||||
null,
|
||||
null
|
||||
)
|
||||
```
|
||||
- result:
|
||||
- Will return the **pubkey** in the result column
|
||||
|
||||
```kotlin
|
||||
if (result == null) return
|
||||
|
||||
if (it.getColumnIndex("rejected") > -1) return
|
||||
|
||||
if (result.moveToFirst()) {
|
||||
val index = it.getColumnIndex("result")
|
||||
if (index < 0) return
|
||||
val pubkey = it.getString(index)
|
||||
}
|
||||
```
|
||||
|
||||
- **sign_event**
|
||||
- params:
|
||||
|
||||
|
||||
2
58.md
2
58.md
@@ -11,7 +11,7 @@ user profiles:
|
||||
|
||||
1. A "Badge Definition" event is defined as an addressable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated.
|
||||
|
||||
2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferable.
|
||||
2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable.
|
||||
|
||||
3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`.
|
||||
Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed.
|
||||
|
||||
4
59.md
4
59.md
@@ -4,7 +4,7 @@ NIP-59
|
||||
Gift Wrap
|
||||
---------
|
||||
|
||||
`optional` `relay`
|
||||
`optional`
|
||||
|
||||
This NIP defines a protocol for encapsulating any nostr event. This makes it possible to obscure most metadata
|
||||
for a given event, perform collaborative signing, and more.
|
||||
@@ -99,8 +99,6 @@ AUTH, and refuse to serve wrapped events to non-recipients.
|
||||
|
||||
When adding expiration tags to both `seal` and `gift wrap` layers, implementations SHOULD use independent random timestamps for each layer. Using different `created_at` values increases timing variance and helps protect against metadata correlation attacks.
|
||||
|
||||
Since signing keys are random, relays SHOULD delete `kind 1059` events whose p-tag matches the signer of
|
||||
[NIP-09](09.md) deletions or [NIP-62](62.md) vanish requests.
|
||||
|
||||
## An Example
|
||||
|
||||
|
||||
2
62.md
2
62.md
@@ -4,7 +4,7 @@ NIP-62
|
||||
Request to Vanish
|
||||
-----------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP offers a Nostr-native way to request a complete reset of a key's fingerprint on the web. This procedure is legally binding in some jurisdictions, and thus, supporters of this NIP should truly delete events from their database.
|
||||
|
||||
|
||||
2
66.md
2
66.md
@@ -4,7 +4,7 @@ NIP-66
|
||||
Relay Discovery and Liveness Monitoring
|
||||
-------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines events for relay discovery and the announcement of relay monitors.
|
||||
|
||||
|
||||
2
70.md
2
70.md
@@ -4,7 +4,7 @@ NIP-70
|
||||
Protected Events
|
||||
----------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
When the `"-"` tag is present, that means the event is "protected".
|
||||
|
||||
|
||||
2
77.md
2
77.md
@@ -4,7 +4,7 @@ NIP-77
|
||||
Negentropy Syncing
|
||||
------------------
|
||||
|
||||
`draft` `optional` `relay`
|
||||
`draft` `optional`
|
||||
|
||||
This document describes a protocol extension for syncing events. It works for both client-relay and relay-relay scenarios. If both sides of the sync have events in common, then this protocol will use less bandwidth than transferring the full set of events (or even just their IDs).
|
||||
|
||||
|
||||
56
A4.md
56
A4.md
@@ -1,56 +0,0 @@
|
||||
NIP-A4
|
||||
======
|
||||
|
||||
Public Messages
|
||||
---------------
|
||||
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines kind `24` as a simple plaintext message to one or more Nostr users.
|
||||
|
||||
The `.content` contains the message. `p` tags identify one or more receivers.
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"pubkey": "<sender-pubkey>",
|
||||
"kind": 24,
|
||||
"tags": [
|
||||
["p", "<receiver>", "<relay-url>"],
|
||||
],
|
||||
"content": "<message-in-plain-text>",
|
||||
}
|
||||
```
|
||||
|
||||
Messages MUST be sent to the [NIP-65](65.md) inbox relays of each receiver and the outbox relay of the sender.
|
||||
|
||||
Kind `24` is designed to be shown and replied to from notification screens. The goal is to allow clients to
|
||||
support this feature without having to worry about chat history. There are no message chains. The concept of a
|
||||
"thread", a "thread root", or a "chatroom" does not exist in this system, as messages can start and continue
|
||||
without any syntactic connection to each other. `e` tags must not be used.
|
||||
|
||||
This kind is not designed to be displayed on feeds, but anyone can see and reply to messages that may not be for them.
|
||||
|
||||
## Advanced Support
|
||||
|
||||
[NIP-40](40.md) `expiration` tags are recommended. Since there is no concept of a chatroom, it is unlikely that these messages will
|
||||
make sense as time goes on.
|
||||
|
||||
[NIP-18](18.md) quote repost `q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md).
|
||||
|
||||
```json
|
||||
["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]
|
||||
```
|
||||
|
||||
[NIP-25](25.md) reactions MUST add a `k` tag to `24`.
|
||||
|
||||
[NIP-57](57.md) zaps MUST include the `k` tag to `24`
|
||||
|
||||
[NIP-21](21.md) links that use [NIP-19](19.md)'s `nevent1` MUST include a `kind` of `24`. Links that are not `kind:24` are not expected to be rendered natively by the client.
|
||||
|
||||
[NIP-92](92.md) `imeta` tags SHOULD be added for image and video links.
|
||||
|
||||
## Warnings
|
||||
|
||||
There MUST be no expectation of privacy in this kind. It is just a public reply, but without a root note.
|
||||
|
||||
Avoid confusing this kind with Kind `14` rumors in [NIP-17](17.md) DMs. This kind is signed and designed for public consumption.
|
||||
4
C0.md
4
C0.md
@@ -23,9 +23,9 @@ The `.content` field contains the actual code snippet text.
|
||||
- `extension` - File extension (without the dot). Examples: "js", "py", "rs"
|
||||
- `description` - Brief description of what the code does
|
||||
- `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11")
|
||||
- `license` - License under which the code (along with any related data contained within the event, when available, such as the description) is shared. This MUST be a standard [SPDX](https://spdx.org/licenses/) short identifier (e.g., "MIT", "GPL-3.0-or-later", "Apache-2.0") when available. An additional parameter containing a reference to the actual text of the license MAY be provided. This tag can be repeated, to indicate multi-licensing, allowing recipients to use the code under any license of choosing among the referenced ones
|
||||
- `license` - License under which the code is shared (e.g., "MIT", "GPL-3.0", "Apache-2.0")
|
||||
- `dep` - Dependency required for the code to run (can be repeated)
|
||||
- `repo` - Reference to a repository where this code originates. This MUST be a either standard URL or, alternatively, the address of a [NIP-34](34.md) Git repository announcement event in the form `"30617:<32-bytes hex a pubkey>:<d tag value>"`. If a repository announcement is referenced, a recommended relay URL where to find the event should be provided as an additional parameter
|
||||
- `repo` - Reference to a repository where this code originates
|
||||
|
||||
## Format
|
||||
|
||||
|
||||
10
EE.md
10
EE.md
@@ -1,12 +1,8 @@
|
||||
> __Warning__ `unrecommended`: superseded by the [Marmot Protocol](https://github.com/marmot-protocol/marmot)
|
||||
# NIP-EE
|
||||
|
||||
NIP-EE
|
||||
======
|
||||
## E2EE Messaging using the Messaging Layer Security (MLS) Protocol
|
||||
|
||||
E2EE Messaging using the Messaging Layer Security (MLS) Protocol
|
||||
----------------------------------------------------------------
|
||||
|
||||
`final` `unrecommended` `optional`
|
||||
`draft` `optional`
|
||||
|
||||
This NIP standardizes how to use the [MLS Protocol](https://www.rfc-editor.org/rfc/rfc9420.html) with Nostr for efficient and E2EE (end-to-end encrypted) direct and group messaging.
|
||||
|
||||
|
||||
30
README.md
30
README.md
@@ -103,13 +103,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
- [NIP-98: HTTP Auth](98.md)
|
||||
- [NIP-99: Classified Listings](99.md)
|
||||
- [NIP-A0: Voice Messages](A0.md)
|
||||
- [NIP-A4: Public Messages](A4.md)
|
||||
- [NIP-B0: Web Bookmarks](B0.md)
|
||||
- [NIP-B7: Blossom](B7.md)
|
||||
- [NIP-BE: Nostr BLE Communications Protocol](BE.md)
|
||||
- [NIP-C0: Code Snippets](C0.md)
|
||||
- [NIP-C7: Chats](C7.md)
|
||||
- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) --- **unrecommended**: superseded by the [Marmot Protocol](https://github.com/marmot-protocol/marmot)
|
||||
- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md)
|
||||
|
||||
## Event Kinds
|
||||
| kind | description | NIP |
|
||||
@@ -135,11 +134,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `20` | Picture | [68](68.md) |
|
||||
| `21` | Video Event | [71](71.md) |
|
||||
| `22` | Short-form Portrait Video Event | [71](71.md) |
|
||||
| `24` | Public Message | [A4](A4.md) |
|
||||
| `30` | internal reference | [NKBIP-03] |
|
||||
| `31` | external web reference | [NKBIP-03] |
|
||||
| `32` | hardcopy reference | [NKBIP-03] |
|
||||
| `33` | prompt reference | [NKBIP-03] |
|
||||
| `31` | external web reference | [NKBIP-03] |
|
||||
| `32` | hardcopy reference | [NKBIP-03] |
|
||||
| `33` | prompt reference | [NKBIP-03] |
|
||||
| `40` | Channel Creation | [28](28.md) |
|
||||
| `41` | Channel Metadata | [28](28.md) |
|
||||
| `42` | Channel Message | [28](28.md) |
|
||||
@@ -147,9 +145,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `44` | Channel Mute User | [28](28.md) |
|
||||
| `62` | Request to Vanish | [62](62.md) |
|
||||
| `64` | Chess (PGN) | [64](64.md) |
|
||||
| `443` | KeyPackage | [Marmot](marmot) |
|
||||
| `444` | Welcome Message | [Marmot](marmot) |
|
||||
| `445` | Group Event | [Marmot](marmot) |
|
||||
| `443` | KeyPackage | [EE](EE.md) |
|
||||
| `444` | Welcome Message | [EE](EE.md) |
|
||||
| `445` | Group Event | [EE](EE.md) |
|
||||
| `818` | Merge Requests | [54](54.md) |
|
||||
| `1018` | Poll Response | [88](88.md) |
|
||||
| `1021` | Bid | [15](15.md) |
|
||||
@@ -211,7 +209,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `10020` | Media follows | [51](51.md) |
|
||||
| `10030` | User emoji list | [51](51.md) |
|
||||
| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) |
|
||||
| `10051` | KeyPackage Relays List | [Marmot](marmot) |
|
||||
| `10051` | KeyPackage Relays List | [EE](EE.md) |
|
||||
| `10063` | User server list | [Blossom][blossom] |
|
||||
| `10096` | File storage server list | [96](96.md) (deprecated) |
|
||||
| `10166` | Relay Monitor Announcement | [66](66.md) |
|
||||
@@ -220,7 +218,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] |
|
||||
| `13194` | Wallet Info | [47](47.md) |
|
||||
| `13534` | Membership Lists | [43](43.md) |
|
||||
| `14388` | User Sound Effect Lists | [Corny Chat][cornychat-usersoundlist] |
|
||||
| `17375` | Cashu Wallet Event | [60](60.md) |
|
||||
| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
|
||||
| `22242` | Client Authentication | [42](42.md) |
|
||||
@@ -238,7 +235,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `30003` | Bookmark sets | [51](51.md) |
|
||||
| `30004` | Curation sets | [51](51.md) |
|
||||
| `30005` | Video sets | [51](51.md) |
|
||||
| `30006` | Picture sets | [51](51.md) |
|
||||
| `30007` | Kind mute sets | [51](51.md) |
|
||||
| `30008` | Profile Badges | [58](58.md) |
|
||||
| `30009` | Badge Definition | [58](58.md) |
|
||||
@@ -277,9 +273,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `31989` | Handler recommendation | [89](89.md) |
|
||||
| `31990` | Handler information | [89](89.md) |
|
||||
| `32267` | Software Application | |
|
||||
| `32388` | User Room Favorites | [Corny Chat][cornychat-roomfavorites] |
|
||||
| `33388` | High Scores | [Corny Chat][cornychat-highscores] |
|
||||
| `34388` | Sound Effects | [Corny Chat][cornychat-soundeffects] |
|
||||
| `34550` | Community Definition | [72](72.md) |
|
||||
| `38172` | Cashu Mint Announcement | [87](87.md) |
|
||||
| `38173` | Fedimint Announcement | [87](87.md) |
|
||||
@@ -293,12 +286,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/
|
||||
[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
|
||||
[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
|
||||
[cornychat-usersoundlist]: https://cornychat.com/datatypes#kind14388usersoundeffectslist
|
||||
[cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset
|
||||
[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset
|
||||
[cornychat-roomfavorites]: https://cornychat.com/datatypes#kind32388roomfavorites
|
||||
[cornychat-highscores]: https://cornychat.com/datatypes#kind33388highscores
|
||||
[cornychat-soundeffects]: https://cornychat.com/datatypes#kind34388soundeffectsets
|
||||
[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md
|
||||
[NKBIP-01]: https://wikistr.com/nkbip-01*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1
|
||||
[NKBIP-02]: https://wikistr.com/nkbip-02*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1
|
||||
@@ -307,8 +296,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
[Tidal-nostr]: https://wikistr.com/tidal-nostr
|
||||
[geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5
|
||||
[nostr-epoxy]: https://github.com/Origami74/nostr-epoxy-reverse-proxy
|
||||
[marmot]: https://github.com/marmot-protocol/marmot
|
||||
|
||||
|
||||
## Message types
|
||||
|
||||
@@ -401,7 +388,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `repo` | Reference to the origin repository | -- | [C0](C0.md) |
|
||||
| `runtime` | Runtime or environment specification | -- | [C0](C0.md) |
|
||||
| `server` | file storage server url | -- | [96](96.md) |
|
||||
| `sound` | shortcode, sound url, image url | -- | [51](51.md) |
|
||||
| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) |
|
||||
| `summary` | summary | -- | [23](23.md), [52](52.md) |
|
||||
| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
|
||||
|
||||
Reference in New Issue
Block a user