mirror of
https://github.com/nostr-protocol/nips.git
synced 2026-01-25 19:48:51 +00:00
Compare commits
11 Commits
profile-hy
...
f34e98c73f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f34e98c73f | ||
|
|
d7db75fc69 | ||
|
|
2f71cf74ae | ||
|
|
aa30111d2f | ||
|
|
fa9281af8b | ||
|
|
f5a15ea27e | ||
|
|
c1ff79f1c6 | ||
|
|
3afdad183e | ||
|
|
fb18d4c74f | ||
|
|
65a827dab3 | ||
|
|
7cafdbb0cf |
2
01.md
2
01.md
@@ -4,7 +4,7 @@ NIP-01
|
||||
Basic protocol flow description
|
||||
-------------------------------
|
||||
|
||||
`draft` `mandatory`
|
||||
`draft` `mandatory` `relay`
|
||||
|
||||
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`
|
||||
`final` `unrecommended` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
This NIP defines an encrypted chat scheme which uses [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps.
|
||||
|
||||
|
||||
2
26.md
2
26.md
@@ -6,7 +6,7 @@ NIP-26
|
||||
Delegated Event Signing
|
||||
-----------------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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 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`)
|
||||
|
||||
@@ -153,14 +153,18 @@ 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"],
|
||||
["public"], // or ["private"]
|
||||
["open"] // or ["closed"]
|
||||
["private"],
|
||||
["closed"]
|
||||
]
|
||||
// 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)
|
||||
|
||||
@@ -231,7 +235,7 @@ The latest of either `kind:9000` or `kind:9001` events present in a group should
|
||||
|
||||
### 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
|
||||
|
||||
|
||||
2
40.md
2
40.md
@@ -4,7 +4,7 @@ NIP-40
|
||||
Expiration Timestamp
|
||||
--------------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts.
|
||||
|
||||
|
||||
2
46.md
2
46.md
@@ -204,7 +204,7 @@ _client_ should display (in a popup or new tab) the URL from the `error` field a
|
||||
|
||||
### Announcing _remote-signer_ metadata
|
||||
|
||||
_remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this:
|
||||
_remote-signer_ MAY publish its metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this:
|
||||
```jsonc
|
||||
{
|
||||
"names":{
|
||||
|
||||
2
50.md
2
50.md
@@ -4,7 +4,7 @@ NIP-50
|
||||
Search Capability
|
||||
-----------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
## Abstract
|
||||
|
||||
|
||||
1
51.md
1
51.md
@@ -55,6 +55,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti
|
||||
| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) |
|
||||
| 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)) |
|
||||
|
||||
30
54.md
30
54.md
@@ -8,7 +8,7 @@ Wiki
|
||||
|
||||
This NIP defines `kind:30818` (an _addressable event_) for descriptions (or encyclopedia entries) of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content.
|
||||
|
||||
Articles are identified by lowercase, normalized ascii `d` tags.
|
||||
Articles are identified by lowercase, normalized `d` tags.
|
||||
|
||||
## Articles
|
||||
```json
|
||||
@@ -16,15 +16,30 @@ Articles are identified by lowercase, normalized ascii `d` tags.
|
||||
"content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
|
||||
"tags": [
|
||||
["d", "wiki"],
|
||||
["title", "Wiki"],
|
||||
["title", "Wiki"]
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `d` tag normalization rules
|
||||
|
||||
- Any non-letter character MUST be converted to a `-`.
|
||||
- All letters MUST be converted to lowercase.
|
||||
- All letters with uppercase/lowercase variants MUST be converted to lowercase.
|
||||
- Whitespace MUST be converted to `-`.
|
||||
- Punctuation and symbols SHOULD be removed.
|
||||
- Multiple consecutive `-` SHOULD be collapsed to a single `-`.
|
||||
- Leading and trailing `-` SHOULD be removed.
|
||||
- Non-ASCII letters (e.g., Japanese, Chinese, Arabic, Cyrillic) MUST be preserved as UTF-8.
|
||||
- Numbers MUST be preserved.
|
||||
|
||||
For example:
|
||||
- `"Wiki Article"` → `"wiki-article"`
|
||||
- `"What's Up?"` → `"whats-up"`
|
||||
- `" Hello World "` → `"hello-world"`
|
||||
- `"Article 1"` → `"article-1"`
|
||||
- `"ウィキペディア"` → `"ウィキペディア"` (Japanese, no case change)
|
||||
- `"Ñoño"` → `"ñoño"` (Spanish, lowercased)
|
||||
- `"Москва"` → `"москва"` (Russian, lowercased)
|
||||
- `"日本語 Article"` → `"日本語-article"` (mixed scripts)
|
||||
|
||||
## Content
|
||||
|
||||
@@ -32,10 +47,11 @@ The `content` should be Asciidoc with two extra functionalities: **wikilinks** a
|
||||
|
||||
Unlike normal Asciidoc links `http://example.com[]` that link to external webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink.
|
||||
|
||||
Wikilinks can take these two forms:
|
||||
Wikilinks can take these forms:
|
||||
|
||||
1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`;
|
||||
2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`.
|
||||
1. `[[Target Page]]` -- links to `target-page` and displays as `Target Page`;
|
||||
2. `[[target page|see this]]` -- links to `target-page` but displays as `see this`;
|
||||
3. `[[日本語 Topic|Japanese Topic]]` -- links to `日本語-topic` and displays as `Japanese Topic`.
|
||||
|
||||
`nostr:...` links, as per [NIP-21](21.md), should link to profiles or arbitrary Nostr events. Although it is not recommended to link to specific versions of articles -- instead the _wikilink_ syntax should be preferred, since it should be left to the reader and their client to decide what version of any given article they want to read.
|
||||
|
||||
|
||||
38
55.md
38
55.md
@@ -107,6 +107,13 @@ 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**
|
||||
@@ -203,10 +210,10 @@ launcher.launch(intent)
|
||||
context.startActivity(intent)
|
||||
```
|
||||
- result:
|
||||
- If the user approved intent it will return the **signature** and **id** fields
|
||||
- If the user approved intent it will return the **result** and **id** fields
|
||||
|
||||
```kotlin
|
||||
val encryptedText = intent.data?.getStringExtra("signature")
|
||||
val encryptedText = intent.data?.getStringExtra("result")
|
||||
// the id you sent
|
||||
val id = intent.data?.getStringExtra("id")
|
||||
```
|
||||
@@ -299,33 +306,6 @@ 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
59.md
2
59.md
@@ -4,7 +4,7 @@ NIP-59
|
||||
Gift Wrap
|
||||
---------
|
||||
|
||||
`optional`
|
||||
`optional` `relay`
|
||||
|
||||
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.
|
||||
|
||||
2
62.md
2
62.md
@@ -4,7 +4,7 @@ NIP-62
|
||||
Request to Vanish
|
||||
-----------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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.
|
||||
|
||||
|
||||
4
66.md
4
66.md
@@ -4,7 +4,7 @@ NIP-66
|
||||
Relay Discovery and Liveness Monitoring
|
||||
-------------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
This NIP defines events for relay discovery and the announcement of relay monitors.
|
||||
|
||||
@@ -67,7 +67,7 @@ Tags include:
|
||||
- `frequency` - The frequency in seconds at which the monitor publishes events.
|
||||
- `timeout` (optional) - The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests.
|
||||
- `c` - a lowercase string describing the checks conducted by a monitor. Examples include `open`, `read`, `write`, `auth`, `nip11`, `dns`, and `geo`.
|
||||
- `g` - [NIP-52](https://github.com/nostr-protocol/nips/blob/master/11.md) geohash tag
|
||||
- `g` - [NIP-52](https://github.com/nostr-protocol/nips/blob/master/52.md) geohash tag
|
||||
|
||||
Monitors SHOULD also publish a `kind 0` profile and a `kind 10002` relay selections event.
|
||||
|
||||
|
||||
2
70.md
2
70.md
@@ -4,7 +4,7 @@ NIP-70
|
||||
Protected Events
|
||||
----------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
When the `"-"` tag is present, that means the event is "protected".
|
||||
|
||||
|
||||
75
71.md
75
71.md
@@ -20,13 +20,27 @@ Nothing except cavaliership and common sense prevents a _short_ video from being
|
||||
|
||||
The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos.
|
||||
|
||||
## Addressable Video Events
|
||||
|
||||
For content that may need updates after publication (such as correcting metadata, descriptions, or handling URL migrations), addressable versions are available:
|
||||
|
||||
- Kind `34235` for _addressable normal videos_
|
||||
- Kind `34236` for _addressable short videos_
|
||||
|
||||
These addressable events follow the same format as their regular counterparts but include a `d` tag as a unique identifier and can be updated while maintaining the same addressable reference. This is particularly useful for:
|
||||
|
||||
- Metadata corrections (descriptions, titles, tags) without republishing
|
||||
- Preservation of imported content IDs from legacy platforms
|
||||
- URL migration when hosting changes
|
||||
- Platform migration tracking
|
||||
|
||||
The `.content` of these events is a summary or description on the video content.
|
||||
|
||||
The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md)
|
||||
|
||||
Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties.
|
||||
|
||||
This NIP defines the following additional `imeta` properties aside form those listen in [NIP-92](92.md) & [NIP-94](94.md):
|
||||
This NIP defines the following additional `imeta` properties aside from those listed in [NIP-92](92.md) & [NIP-94](94.md):
|
||||
|
||||
* `duration` (recommended) the duration of the video/audio in seconds (floating point number)
|
||||
* `bitrate` (recommended) the average bitrate of the video/audio in bits/sec
|
||||
@@ -81,6 +95,9 @@ The `image` tag contains a preview image (at the same resolution). Multiple `ima
|
||||
|
||||
Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash.
|
||||
|
||||
### Required tags for addressable events:
|
||||
* `d` - Unique identifier for this video (user-chosen string, required for kinds 34235, 34236)
|
||||
|
||||
### Other tags:
|
||||
* `title` (required) title of the video
|
||||
* `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published
|
||||
@@ -92,6 +109,9 @@ Additionally `service nip96` may be included to allow clients to search the auth
|
||||
* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL
|
||||
* `r` (optional, repeated) references / links to web pages
|
||||
|
||||
### Optional tags for imported content:
|
||||
* `origin` - Track original platform and ID: `["origin", "<platform>", "<external-id>", "<original-url>", "<optional-metadata>"]`
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>",
|
||||
@@ -135,3 +155,56 @@ Additionally `service nip96` may be included to allow clients to search the auth
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Addressable Event Example
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
|
||||
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
|
||||
"created_at": <Unix timestamp in seconds>,
|
||||
"kind": 34235 | 34236,
|
||||
"content": "<summary / description of video>",
|
||||
"tags": [
|
||||
["d", "<unique-identifier>"],
|
||||
["title", "<title of video>"],
|
||||
["published_at", "<unix timestamp>"],
|
||||
["alt", "<description for accessibility>"],
|
||||
|
||||
// video data
|
||||
["imeta",
|
||||
"url https://example.com/media.mp4",
|
||||
"m video/mp4",
|
||||
"dim 480x480",
|
||||
"blurhash eVF$^OI:${M{%LRjWBoLoLaeR*",
|
||||
"image https://example.com/thumb.jpg",
|
||||
"x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc"
|
||||
],
|
||||
|
||||
["duration", <duration in seconds>],
|
||||
["content-warning", "<reason>"],
|
||||
|
||||
// origin tracking for imported content
|
||||
["origin", "<platform>", "<external-id>", "<original-url>", "<optional-metadata>"],
|
||||
|
||||
// participants
|
||||
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
|
||||
|
||||
// hashtags
|
||||
["t", "<tag>"],
|
||||
["t", "<tag>"],
|
||||
|
||||
// reference links
|
||||
["r", "<url>"]
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Referencing Addressable Events
|
||||
|
||||
To reference an addressable video:
|
||||
|
||||
```
|
||||
["a", "34235:<pubkey>:<d-tag-value>", "<relay-url>"] // for normal videos
|
||||
["a", "34236:<pubkey>:<d-tag-value>", "<relay-url>"] // for short videos
|
||||
```
|
||||
|
||||
2
72.md
2
72.md
@@ -41,7 +41,7 @@ The goal of this NIP is to enable public communities. It defines the replaceable
|
||||
|
||||
## Posting to a community
|
||||
|
||||
[NIP-22](NIP-22) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition.
|
||||
[NIP-22](22.md) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition.
|
||||
|
||||
### Top-level posts
|
||||
|
||||
|
||||
2
77.md
2
77.md
@@ -4,7 +4,7 @@ NIP-77
|
||||
Negentropy Syncing
|
||||
------------------
|
||||
|
||||
`draft` `optional`
|
||||
`draft` `optional` `relay`
|
||||
|
||||
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).
|
||||
|
||||
|
||||
2
88.md
2
88.md
@@ -48,7 +48,7 @@ Example Event
|
||||
|
||||
The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags.
|
||||
|
||||
- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected.
|
||||
- **response** : The tag contains "response" as its first positional argument followed by the option Id selected.
|
||||
|
||||
The responses are meant to be published to the relays specified in the poll event.
|
||||
|
||||
|
||||
2
90.md
2
90.md
@@ -58,7 +58,7 @@ All tags are optional.
|
||||
* `<input-type>`: The way this argument should be interpreted. MUST be one of:
|
||||
* `url`: A URL to be fetched of the data that should be processed.
|
||||
* `event`: A Nostr event ID.
|
||||
* `job`: The output of a previous job with the specified event ID. The dermination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.)
|
||||
* `job`: The output of a previous job with the specified event ID. The determination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.)
|
||||
* `text`: `<data>` is the value of the input, no resolution is needed
|
||||
* `<relay>`: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string
|
||||
* `<marker>`: An optional field indicating how this input should be used within the context of the job
|
||||
|
||||
56
A4.md
Normal file
56
A4.md
Normal 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
2
C0.md
@@ -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")
|
||||
- `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)
|
||||
- `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. This MUST be either a 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
|
||||
|
||||
|
||||
38
F1.md
38
F1.md
@@ -1,38 +0,0 @@
|
||||
NIP-F1
|
||||
======
|
||||
|
||||
Profile Hypercustomization
|
||||
--------------------------
|
||||
|
||||
`draft` `optional`
|
||||
|
||||
This NIP describes a new event `kind:19999` that can be used for multiple optional and weird forms of profile customization, such as extra colors, extra pictures, preferences and background music.
|
||||
|
||||
It's completely optional and clients may choose to fulfill only some of these tags, or none. Clients may also allow users to turn off these customizations or not.
|
||||
|
||||
## Tags
|
||||
|
||||
| Name | Value type | Description |
|
||||
| --- | ---- | ----------- |
|
||||
| `background-color` | hex value | To be used by clients when displaying the user profile page |
|
||||
| `foreground-color` | hex value | Idem |
|
||||
| `background-music` | URL | Music that optionally plays when the profile is opened |
|
||||
| `priority_kinds` | stringified kind number (variadic) | Kinds to be displayed by default in the user profile page (rather than `kind:1` always) |
|
||||
| `custom` | string name, then value | An arbitrary field to be displayed along with the profile |
|
||||
|
||||
## Example
|
||||
|
||||
```yaml
|
||||
{
|
||||
"kind": 19999,
|
||||
"tags": [
|
||||
["background-color", "#1a1a2e"],
|
||||
["foreground-color", "#eee444"],
|
||||
["background-music", "https://example.com/music/profile-theme.mp3"],
|
||||
["priority_kinds", "20", "30023", "21", "10009"],
|
||||
["custom", "favorite fruit", "banana"],
|
||||
["custom", "pets?", "no"]
|
||||
],
|
||||
// ...other fields
|
||||
}
|
||||
```
|
||||
@@ -103,6 +103,7 @@ 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)
|
||||
@@ -134,6 +135,7 @@ 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] |
|
||||
@@ -236,6 +238,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `30003` | Bookmark sets | [51](51.md) |
|
||||
| `30004` | Curation sets | [51](51.md) |
|
||||
| `30005` | Video sets | [51](51.md) |
|
||||
| `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) |
|
||||
@@ -276,6 +279,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||
| `32267` | Software Application | |
|
||||
| `32388` | User Room Favorites | [Corny Chat][cornychat-roomfavorites] |
|
||||
| `33388` | High Scores | [Corny Chat][cornychat-highscores] |
|
||||
| `34235` | Addressable Video Event | [71](71.md) |
|
||||
| `34236` | Addressable Short Video Event | [71](71.md) |
|
||||
| `34388` | Sound Effects | [Corny Chat][cornychat-soundeffects] |
|
||||
| `34550` | Community Definition | [72](72.md) |
|
||||
| `38172` | Cashu Mint Announcement | [87](87.md) |
|
||||
|
||||
Reference in New Issue
Block a user