Compare commits

...

9 Commits

Author SHA1 Message Date
hodlbod
fb18d4c74f Clarify closed/private, add hidden to nip 29 (#2106)
Co-authored-by: Jon Staab <shtaab@gmail.com>
2025-12-19 10:50:19 -03:00
Vitor Pamplona
65a827dab3 Public Messages (#1988) 2025-12-18 23:30:04 -03:00
greenart7c3
7cafdbb0cf NIP-55: Try to explain how to correctly initiate a connection (#2166) 2025-12-18 08:18:54 -05:00
Vic
862c7c0fe9 Update README.md (#2162) 2025-12-16 08:47:05 -08:00
Henrique Albuquerque
19f7d66526 Fix typo (#2158) 2025-12-13 21:49:19 +09:00
JeffG
247205a155 Replace NIP-EE with Marmot (#2154) 2025-12-11 11:54:19 -03:00
mattn
5d64d57fc5 fix typos (#2152) 2025-12-08 07:59:59 -03:00
Awiteb
a6db7917f2 Update NIP-EE header formatting (#2145) 2025-12-03 08:35:23 -08:00
Awiteb
97d3531c44 update NIP-18 headings (#2144) 2025-12-04 00:59:58 +09:00
9 changed files with 105 additions and 48 deletions

6
18.md
View File

@@ -1,6 +1,8 @@
# NIP-18 NIP-18
======
## Reposts Reposts
-------
`draft` `optional` `draft` `optional`

14
29.md
View File

@@ -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 acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. The optional `code` tag may be used by the relay to preauthorize acceptance, together with the `kind:9009` `create-invite` moderation event.
- *leave request* (`kind:9022`) - *leave request* (`kind:9022`)
@@ -153,14 +153,18 @@ When this event is not found, clients may still connect to the group, but treat
["name", "Pizza Lovers"], ["name", "Pizza Lovers"],
["picture", "https://pizza.com/pizza.png"], ["picture", "https://pizza.com/pizza.png"],
["about", "a group for people who love pizza"], ["about", "a group for people who love pizza"],
["public"], // or ["private"] ["private"],
["open"] // or ["closed"] ["closed"]
] ]
// other fields... // other fields...
} }
``` ```
`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. - `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.
- *group admins* (`kind:39001`) (optional) - *group admins* (`kind:39001`) (optional)
@@ -231,7 +235,7 @@ The latest of either `kind:9000` or `kind:9001` events present in a group should
### Adding yourself to a group ### Adding yourself to a group
When a group is `open`, anyone can send a `kind:9021` event to it in order to be added, then expect a `kind:9000` event to be emitted confirming that the user was added. The same happens with `closed` groups, except in that case a user may only send a `kind:9021` if it has an invite code. 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.
### Storing your list of groups ### Storing your list of groups

2
52.md
View File

@@ -56,7 +56,7 @@ Example:
```yaml ```yaml
{ {
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "id": <32-bytes lowercase hex-encoded SHA-256 of the serialized event data>,
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
"created_at": <unix timestamp in seconds>, "created_at": <unix timestamp in seconds>,
"kind": 31922, "kind": 31922,

34
55.md
View File

@@ -107,6 +107,13 @@ Send the Intent:
launcher.launch(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 #### Methods
- **get_public_key** - **get_public_key**
@@ -299,33 +306,6 @@ Clients SHOULD save the user pubkey locally and avoid calling the `get_public_ke
#### Methods #### 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** - **sign_event**
- params: - params:

2
58.md
View File

@@ -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. 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-transferrable. 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.
3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`. 3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`.
Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed. 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.

56
A4.md Normal file
View File

@@ -0,0 +1,56 @@
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.

2
C0.md
View File

@@ -25,7 +25,7 @@ The `.content` field contains the actual code snippet text.
- `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11") - `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 (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
- `dep` - Dependency required for the code to run (can be repeated) - `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 annoucement 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. 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
## Format ## Format

10
EE.md
View File

@@ -1,8 +1,12 @@
# NIP-EE > __Warning__ `unrecommended`: superseded by the [Marmot Protocol](https://github.com/marmot-protocol/marmot)
## E2EE Messaging using the Messaging Layer Security (MLS) Protocol NIP-EE
======
`draft` `optional` E2EE Messaging using the Messaging Layer Security (MLS) Protocol
----------------------------------------------------------------
`final` `unrecommended` `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. 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.

View File

@@ -108,7 +108,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
- [NIP-BE: Nostr BLE Communications Protocol](BE.md) - [NIP-BE: Nostr BLE Communications Protocol](BE.md)
- [NIP-C0: Code Snippets](C0.md) - [NIP-C0: Code Snippets](C0.md)
- [NIP-C7: Chats](C7.md) - [NIP-C7: Chats](C7.md)
- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) - [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) --- **unrecommended**: superseded by the [Marmot Protocol](https://github.com/marmot-protocol/marmot)
## Event Kinds ## Event Kinds
| kind | description | NIP | | kind | description | NIP |
@@ -135,9 +135,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `21` | Video Event | [71](71.md) | | `21` | Video Event | [71](71.md) |
| `22` | Short-form Portrait Video Event | [71](71.md) | | `22` | Short-form Portrait Video Event | [71](71.md) |
| `30` | internal reference | [NKBIP-03] | | `30` | internal reference | [NKBIP-03] |
| `31` | external web reference | [NKBIP-03] | | `31` | external web reference | [NKBIP-03] |
| `32` | hardcopy reference | [NKBIP-03] | | `32` | hardcopy reference | [NKBIP-03] |
| `33` | prompt reference | [NKBIP-03] | | `33` | prompt reference | [NKBIP-03] |
| `40` | Channel Creation | [28](28.md) | | `40` | Channel Creation | [28](28.md) |
| `41` | Channel Metadata | [28](28.md) | | `41` | Channel Metadata | [28](28.md) |
| `42` | Channel Message | [28](28.md) | | `42` | Channel Message | [28](28.md) |
@@ -145,9 +145,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `44` | Channel Mute User | [28](28.md) | | `44` | Channel Mute User | [28](28.md) |
| `62` | Request to Vanish | [62](62.md) | | `62` | Request to Vanish | [62](62.md) |
| `64` | Chess (PGN) | [64](64.md) | | `64` | Chess (PGN) | [64](64.md) |
| `443` | KeyPackage | [EE](EE.md) | | `443` | KeyPackage | [Marmot](marmot) |
| `444` | Welcome Message | [EE](EE.md) | | `444` | Welcome Message | [Marmot](marmot) |
| `445` | Group Event | [EE](EE.md) | | `445` | Group Event | [Marmot](marmot) |
| `818` | Merge Requests | [54](54.md) | | `818` | Merge Requests | [54](54.md) |
| `1018` | Poll Response | [88](88.md) | | `1018` | Poll Response | [88](88.md) |
| `1021` | Bid | [15](15.md) | | `1021` | Bid | [15](15.md) |
@@ -209,7 +209,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `10020` | Media follows | [51](51.md) | | `10020` | Media follows | [51](51.md) |
| `10030` | User emoji list | [51](51.md) | | `10030` | User emoji list | [51](51.md) |
| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) |
| `10051` | KeyPackage Relays List | [EE](EE.md) | | `10051` | KeyPackage Relays List | [Marmot](marmot) |
| `10063` | User server list | [Blossom][blossom] | | `10063` | User server list | [Blossom][blossom] |
| `10096` | File storage server list | [96](96.md) (deprecated) | | `10096` | File storage server list | [96](96.md) (deprecated) |
| `10166` | Relay Monitor Announcement | [66](66.md) | | `10166` | Relay Monitor Announcement | [66](66.md) |
@@ -218,6 +218,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] | | `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] |
| `13194` | Wallet Info | [47](47.md) | | `13194` | Wallet Info | [47](47.md) |
| `13534` | Membership Lists | [43](43.md) | | `13534` | Membership Lists | [43](43.md) |
| `14388` | User Sound Effect Lists | [Corny Chat][cornychat-usersoundlist] |
| `17375` | Cashu Wallet Event | [60](60.md) | | `17375` | Cashu Wallet Event | [60](60.md) |
| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
| `22242` | Client Authentication | [42](42.md) | | `22242` | Client Authentication | [42](42.md) |
@@ -273,6 +274,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `31989` | Handler recommendation | [89](89.md) | | `31989` | Handler recommendation | [89](89.md) |
| `31990` | Handler information | [89](89.md) | | `31990` | Handler information | [89](89.md) |
| `32267` | Software Application | | | `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) | | `34550` | Community Definition | [72](72.md) |
| `38172` | Cashu Mint Announcement | [87](87.md) | | `38172` | Cashu Mint Announcement | [87](87.md) |
| `38173` | Fedimint Announcement | [87](87.md) | | `38173` | Fedimint Announcement | [87](87.md) |
@@ -286,8 +290,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/
[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.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-slideset]: https://cornychat.com/datatypes#kind30388slideset
[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset [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 [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md
[NKBIP-01]: https://wikistr.com/nkbip-01*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 [NKBIP-01]: https://wikistr.com/nkbip-01*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1
[NKBIP-02]: https://wikistr.com/nkbip-02*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 [NKBIP-02]: https://wikistr.com/nkbip-02*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1
@@ -296,6 +304,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
[Tidal-nostr]: https://wikistr.com/tidal-nostr [Tidal-nostr]: https://wikistr.com/tidal-nostr
[geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5 [geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5
[nostr-epoxy]: https://github.com/Origami74/nostr-epoxy-reverse-proxy [nostr-epoxy]: https://github.com/Origami74/nostr-epoxy-reverse-proxy
[marmot]: https://github.com/marmot-protocol/marmot
## Message types ## Message types
@@ -388,6 +398,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `repo` | Reference to the origin repository | -- | [C0](C0.md) | | `repo` | Reference to the origin repository | -- | [C0](C0.md) |
| `runtime` | Runtime or environment specification | -- | [C0](C0.md) | | `runtime` | Runtime or environment specification | -- | [C0](C0.md) |
| `server` | file storage server url | -- | [96](96.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) | | `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) |
| `summary` | summary | -- | [23](23.md), [52](52.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) |
| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |