mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-10 14:19:08 -05:00
Apply minimal-ish changes to fit configuration
This commit is contained in:
Mariano Pérez Rodríguez
parent
3ce5c4566d
commit
ae3fdaf5ed
22
01.md
22
01.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-01
|
||||
======
|
||||
# NIP-01
|
||||
|
||||
Basic protocol flow description
|
||||
-------------------------------
|
||||
## Basic protocol flow description
|
||||
|
||||
`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol`
|
||||
|
||||
|
|
@ -51,9 +49,9 @@ Relays expose a websocket endpoint to which clients can connect.
|
|||
|
||||
Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns:
|
||||
|
||||
* `["EVENT", <event JSON as defined above>]`, used to publish events.
|
||||
* `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates.
|
||||
* `["CLOSE", <subscription_id>]`, used to stop previous subscriptions.
|
||||
- `["EVENT", <event JSON as defined above>]`, used to publish events.
|
||||
- `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates.
|
||||
- `["CLOSE", <subscription_id>]`, used to stop previous subscriptions.
|
||||
|
||||
`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription.
|
||||
|
||||
|
|
@ -88,9 +86,9 @@ The `limit` property of a filter is only valid for the initial query and can be
|
|||
|
||||
Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns:
|
||||
|
||||
* `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
|
||||
* `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time.
|
||||
* `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
|
||||
- `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
|
||||
- `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time.
|
||||
- `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
|
||||
|
||||
This NIP defines no rules for how `NOTICE` messages should be sent or treated.
|
||||
|
||||
|
|
@ -104,8 +102,8 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated.
|
|||
|
||||
A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about.
|
||||
|
||||
## Other Notes:
|
||||
## Other Notes
|
||||
|
||||
- Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that.
|
||||
- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow.
|
||||
- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` --- meaning "pubkey", which points to a pubkey of someone that is referred to in the event ---, and `"e"` --- meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow.
|
||||
- The `<recommended relay URL>` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients.
|
||||
|
|
|
|||
6
02.md
6
02.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-02
|
||||
======
|
||||
# NIP-02
|
||||
|
||||
Contact List and Petnames
|
||||
-------------------------
|
||||
## Contact List and Petnames
|
||||
|
||||
`final` `optional` `author:fiatjaf` `author:arcbtc`
|
||||
|
||||
|
|
|
|||
12
03.md
12
03.md
|
|
@ -1,14 +1,12 @@
|
|||
NIP-03
|
||||
======
|
||||
# NIP-03
|
||||
|
||||
OpenTimestamps Attestations for Events
|
||||
--------------------------------------
|
||||
## OpenTimestamps Attestations for Events
|
||||
|
||||
`draft` `optional` `author:fiatjaf`
|
||||
|
||||
When there is an OTS available it MAY be included in the existing event body under the `ots` key:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"id": ...,
|
||||
"kind": ...,
|
||||
|
|
@ -18,6 +16,6 @@ When there is an OTS available it MAY be included in the existing event body und
|
|||
}
|
||||
```
|
||||
|
||||
The _event id_ MUST be used as the raw hash to be included in the OpenTimestamps merkle tree.
|
||||
The _event id_ MUST be used as the raw hash to be included in the OpenTimestamps Merkle tree.
|
||||
|
||||
The attestation can be either provided by relays automatically (and the OTS binary contents just appended to the events it receives) or by clients themselves when they first upload the event to relays — and used by clients to show that an event is really "at least as old as [OTS date]".
|
||||
The attestation can be either provided by relays automatically (and the OTS binary contents just appended to the events it receives) or by clients themselves when they first upload the event to relays --- and used by clients to show that an event is really "at least as old as [OTS date]".
|
||||
|
|
|
|||
6
04.md
6
04.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-04
|
||||
======
|
||||
# NIP-04
|
||||
|
||||
Encrypted Direct Message
|
||||
------------------------
|
||||
## Encrypted Direct Message
|
||||
|
||||
`final` `optional` `author:arcbtc`
|
||||
|
||||
|
|
|
|||
6
05.md
6
05.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-05
|
||||
======
|
||||
# NIP-05
|
||||
|
||||
Mapping Nostr keys to DNS-based internet identifiers
|
||||
----------------------------------------------------
|
||||
## Mapping Nostr keys to DNS-based internet identifiers
|
||||
|
||||
`final` `optional` `author:fiatjaf` `author:mikedilger`
|
||||
|
||||
|
|
|
|||
6
06.md
6
06.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-06
|
||||
======
|
||||
# NIP-06
|
||||
|
||||
Basic key derivation from mnemonic seed phrase
|
||||
----------------------------------------------
|
||||
## Basic key derivation from mnemonic seed phrase
|
||||
|
||||
`draft` `optional` `author:fiatjaf`
|
||||
|
||||
|
|
|
|||
11
07.md
11
07.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-07
|
||||
======
|
||||
# NIP-07
|
||||
|
||||
`window.nostr` capability for web browsers
|
||||
------------------------------------------
|
||||
## `window.nostr` capability for web browsers
|
||||
|
||||
`draft` `optional` `author:fiatjaf`
|
||||
|
||||
|
|
@ -10,13 +8,14 @@ The `window.nostr` object may be made available by web browsers or extensions an
|
|||
|
||||
That object must define the following methods:
|
||||
|
||||
```
|
||||
```javascript
|
||||
async window.nostr.getPublicKey(): string // returns a public key as hex
|
||||
async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it
|
||||
```
|
||||
|
||||
Aside from these two basic above, the following functions can also be implemented optionally:
|
||||
```
|
||||
|
||||
```javascript
|
||||
async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies
|
||||
async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04
|
||||
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04
|
||||
|
|
|
|||
8
08.md
8
08.md
|
|
@ -1,10 +1,8 @@
|
|||
# NIP-08
|
||||
|
||||
> __Warning__ `unrecommended`: deprecated in favor of NIP-27
|
||||
|
||||
NIP-08
|
||||
======
|
||||
|
||||
Handling Mentions
|
||||
-----------------
|
||||
## Handling Mentions
|
||||
|
||||
`final` `unrecommended` `optional` `author:fiatjaf` `author:scsibug`
|
||||
|
||||
|
|
|
|||
8
09.md
8
09.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-09
|
||||
======
|
||||
# NIP-09
|
||||
|
||||
Event Deletion
|
||||
--------------
|
||||
## Event Deletion
|
||||
|
||||
`draft` `optional` `author:scsibug`
|
||||
|
||||
|
|
@ -14,7 +12,7 @@ The event's `content` field MAY contain a text note describing the reason for th
|
|||
|
||||
For example:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"kind": 5,
|
||||
"pubkey": <32-bytes hex-encoded public key of the event creator>,
|
||||
|
|
|
|||
34
10.md
34
10.md
|
|
@ -1,50 +1,54 @@
|
|||
NIP-10
|
||||
======
|
||||
# NIP-10
|
||||
|
||||
|
||||
On "e" and "p" tags in Text Events (kind 1).
|
||||
--------------------------------------------
|
||||
## On "e" and "p" tags in Text Events (kind 1)
|
||||
|
||||
`draft` `optional` `author:unclebobmartin`
|
||||
|
||||
## Abstract
|
||||
|
||||
This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event.
|
||||
|
||||
## Positional "e" tags (DEPRECATED)
|
||||
|
||||
> This scheme is in common use; but should be considered deprecated.
|
||||
|
||||
`["e", <event-id>, <relay-url>]` as per NIP-01.
|
||||
|
||||
Where:
|
||||
|
||||
* `<event-id>` is the id of the event being referenced.
|
||||
* `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional.
|
||||
- `<event-id>` is the id of the event being referenced.
|
||||
- `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional.
|
||||
|
||||
**The positions of the "e" tags within the event denote specific meanings as follows**:
|
||||
|
||||
* No "e" tag: <br>
|
||||
- No "e" tag:
|
||||
|
||||
This event is not a reply to, nor does it refer to, any other event.
|
||||
|
||||
* One "e" tag: <br>
|
||||
- One "e" tag:
|
||||
|
||||
`["e", <id>]`: The id of the event to which this event is a reply.
|
||||
|
||||
* Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br>
|
||||
- Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]`
|
||||
|
||||
`<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply.
|
||||
|
||||
* Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br>
|
||||
- Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`
|
||||
|
||||
There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain.
|
||||
They are citings from this event. `root-id` and `reply-id` are as above.
|
||||
|
||||
> This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply.
|
||||
|
||||
## Marked "e" tags (PREFERRED)
|
||||
|
||||
`["e", <event-id>, <relay-url>, <marker>]`
|
||||
|
||||
Where:
|
||||
|
||||
* `<event-id>` is the id of the event being referenced.
|
||||
* `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`.
|
||||
* `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
|
||||
- `<event-id>` is the id of the event being referenced.
|
||||
- `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`.
|
||||
- `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
|
||||
|
||||
**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id.
|
||||
|
||||
|
|
@ -52,8 +56,8 @@ A direct reply to the root of a thread should have a single marked "e" tag of ty
|
|||
|
||||
> This scheme is preferred because it allows events to mention others without confusing them with `<reply-id>` or `<root-id>`.
|
||||
|
||||
|
||||
## The "p" tag
|
||||
|
||||
Used in a text event contains a list of pubkeys used to record who is involved in a reply thread.
|
||||
|
||||
When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to.
|
||||
|
|
|
|||
40
11.md
40
11.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-11
|
||||
======
|
||||
# NIP-11
|
||||
|
||||
Relay Information Document
|
||||
---------------------------
|
||||
## Relay Information Document
|
||||
|
||||
`draft` `optional` `author:scsibug` `author:doc-hex` `author:cameri`
|
||||
|
||||
|
|
@ -24,43 +22,41 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application
|
|||
|
||||
Any field may be omitted, and clients MUST ignore any additional fields they do not understand. Relays MUST accept CORS requests by sending `Access-Control-Allow-Origin`, `Access-Control-Allow-Headers`, and `Access-Control-Allow-Methods` headers.
|
||||
|
||||
Field Descriptions
|
||||
-----------------
|
||||
## Field Descriptions
|
||||
|
||||
### Name ###
|
||||
### Name
|
||||
|
||||
A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation.
|
||||
|
||||
### Description ###
|
||||
### Description
|
||||
|
||||
Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length.
|
||||
|
||||
### Pubkey ###
|
||||
### Pubkey
|
||||
|
||||
An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See `NIP-04`) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance.
|
||||
|
||||
Relay operators have no obligation to respond to direct messages.
|
||||
|
||||
### Contact ###
|
||||
### Contact
|
||||
|
||||
An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact.
|
||||
|
||||
### Supported NIPs ###
|
||||
### Supported NIPs
|
||||
|
||||
As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients.
|
||||
|
||||
### Software ###
|
||||
### Software
|
||||
|
||||
The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage.
|
||||
|
||||
### Version ###
|
||||
### Version
|
||||
|
||||
The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier.
|
||||
|
||||
Extra Fields
|
||||
-----------------
|
||||
## Extra Fields
|
||||
|
||||
### Server Limitations ###
|
||||
### Server Limitations
|
||||
|
||||
These are limitations imposed by the relay on clients. Your client
|
||||
should expect that requests which exceed these *practical* limitations
|
||||
|
|
@ -127,7 +123,7 @@ Even if set to False, authentication may be required for specific actions.
|
|||
|
||||
- `payment_required`: this relay requires payment before a new connection may perform any action.
|
||||
|
||||
### Event Retention ###
|
||||
### Event Retention
|
||||
|
||||
There may be a cost associated with storing data forever, so relays
|
||||
may wish to state retention times. The values stated here are defaults
|
||||
|
|
@ -161,11 +157,10 @@ a specific `kind` number, by giving a retention time of zero for those `kind` va
|
|||
While that is unfortunate, it does allow clients to discover servers that will
|
||||
support their protocol quickly via a single HTTP fetch.
|
||||
|
||||
There is no need to specify retention times for _ephemeral events_ as defined
|
||||
There is no need to specify retention times for *ephemeral events* as defined
|
||||
in [NIP-16](16.md) since they are not retained.
|
||||
|
||||
|
||||
### Content Limitations ###
|
||||
### Content Limitations
|
||||
|
||||
Some relays may be governed by the arbitrary laws of a nation state. This
|
||||
may limit what content can be stored in cleartext on those relays. All
|
||||
|
|
@ -197,8 +192,7 @@ Remember that a relay may be hosted in a country which is not the
|
|||
country of the legal entities who own the relay, so it's very
|
||||
likely a number of countries are involved.
|
||||
|
||||
|
||||
### Community Preferences ###
|
||||
### Community Preferences
|
||||
|
||||
For public text notes at least, a relay may try to foster a
|
||||
local community. This would encourage users to follow the global
|
||||
|
|
@ -238,7 +232,7 @@ detail and legal terms. Use the `tags` field to signify limitations
|
|||
on content, or topics to be discussed, which could be machine
|
||||
processed by appropriate client software.
|
||||
|
||||
### Pay-To-Relay ###
|
||||
### Pay-To-Relay
|
||||
|
||||
Relays that require payments may want to expose their fee schedules.
|
||||
|
||||
|
|
|
|||
20
12.md
20
12.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-12
|
||||
======
|
||||
# NIP-12
|
||||
|
||||
Generic Tag Queries
|
||||
-------------------
|
||||
## Generic Tag Queries
|
||||
|
||||
`draft` `optional` `author:scsibug` `author:fiatjaf`
|
||||
|
||||
|
|
@ -10,30 +8,26 @@ Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays
|
|||
|
||||
The `<filters>` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries.
|
||||
|
||||
Example Subscription Filter
|
||||
---------------------------
|
||||
## Example Subscription Filter
|
||||
|
||||
The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`.
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"kinds": [1],
|
||||
"#r": ["foo", "bar"]
|
||||
}
|
||||
```
|
||||
|
||||
Client Behavior
|
||||
---------------
|
||||
## Client Behavior
|
||||
|
||||
Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP.
|
||||
|
||||
Rationale
|
||||
---------
|
||||
## Rationale
|
||||
|
||||
The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions.
|
||||
|
||||
Suggested Use Cases
|
||||
-------------------
|
||||
## Suggested Use Cases
|
||||
|
||||
Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose.
|
||||
|
||||
|
|
|
|||
23
13.md
23
13.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-13
|
||||
======
|
||||
# NIP-13
|
||||
|
||||
Proof of Work
|
||||
-------------
|
||||
## Proof of Work
|
||||
|
||||
`draft` `optional` `author:jb55` `author:cameri`
|
||||
|
||||
|
|
@ -10,8 +8,7 @@ This NIP defines a way to generate and interpret Proof of Work for nostr notes.
|
|||
|
||||
`difficulty` is defined to be the number of leading zero bits in the `NIP-01` id. For example, an id of `000000000e9d97a1ab09fc381030b346cdd7a142ad57e6df0b46dc9bef6c7e2d` has a difficulty of `36` with `36` leading 0 bits.
|
||||
|
||||
Mining
|
||||
------
|
||||
## Mining
|
||||
|
||||
To generate PoW for a `NIP-01` note, a `nonce` tag is used:
|
||||
|
||||
|
|
@ -23,8 +20,7 @@ When mining, the second entry to the nonce tag is updated, and then the id is re
|
|||
|
||||
The third entry to the nonce tag `SHOULD` contain the target difficulty. This allows clients to protect against situations where bulk spammers targeting a lower difficulty get lucky and match a higher difficulty. For example, if you require 40 bits to reply to your thread and see a committed target of 30, you can safely reject it even if the note has 40 bits difficulty. Without a committed target difficulty you could not reject it. Committing to a target difficulty is something all honest miners should be ok with, and clients `MAY` reject a note matching a target difficulty if it is missing a difficulty commitment.
|
||||
|
||||
Example mined note
|
||||
------------------
|
||||
## Example mined note
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -44,8 +40,7 @@ Example mined note
|
|||
}
|
||||
```
|
||||
|
||||
Validating
|
||||
----------
|
||||
## Validating
|
||||
|
||||
Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr note id:
|
||||
|
||||
|
|
@ -77,17 +72,15 @@ int count_leading_zero_bits(unsigned char *hash)
|
|||
}
|
||||
```
|
||||
|
||||
Querying relays for PoW notes
|
||||
-----------------------------
|
||||
## Querying relays for PoW notes
|
||||
|
||||
Since relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]'
|
||||
{"id":"000000000121637feeb68a06c8fa7abd25774bdedfa9b6ef648386fb3b70c387", ...}
|
||||
```
|
||||
|
||||
Delegated Proof of Work
|
||||
-----------------------
|
||||
## Delegated Proof of Work
|
||||
|
||||
Since the `NIP-01` note id does not commit to any signature, PoW can be outsourced to PoW providers, perhaps for a fee. This provides a way for clients to get their messages out to PoW-restricted relays without having to do any work themselves, which is useful for energy-constrained devices like mobile phones.
|
||||
|
|
|
|||
6
14.md
6
14.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-14
|
||||
======
|
||||
# NIP-14
|
||||
|
||||
Subject tag in Text events.
|
||||
---------------------------
|
||||
## Subject tag in Text events
|
||||
|
||||
`draft` `optional` `author:unclebobmartin`
|
||||
|
||||
|
|
|
|||
26
15.md
26
15.md
|
|
@ -1,14 +1,12 @@
|
|||
NIP-15
|
||||
======
|
||||
# NIP-15
|
||||
|
||||
Nostr Marketplace (for resilient marketplaces)
|
||||
-----------------------------------
|
||||
## Nostr Marketplace (for resilient marketplaces)
|
||||
|
||||
`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos`
|
||||
|
||||
> Based on https://github.com/lnbits/Diagon-Alley
|
||||
|
||||
> Implemented here https://github.com/lnbits/nostrmarket
|
||||
> Based on <https://github.com/lnbits/Diagon-Alley>
|
||||
>
|
||||
> Implemented here <https://github.com/lnbits/nostrmarket>
|
||||
|
||||
## Terms
|
||||
|
||||
|
|
@ -41,9 +39,10 @@ A merchant can publish these events:
|
|||
| `4` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) |
|
||||
| `5` | `delete` | Delete a product or a stall. | [NIP05](https://github.com/nostr-protocol/nips/blob/master/05.md) |
|
||||
|
||||
### Event `30017`: Create or update a stall.
|
||||
### Event `30017`: Create or update a stall
|
||||
|
||||
**Event Content**:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": <String, UUID generated by the merchant. Sequential IDs (`0`, `1`, `2`...) are discouraged>,
|
||||
|
|
@ -62,20 +61,24 @@ A merchant can publish these events:
|
|||
```
|
||||
|
||||
Fields that are not self-explanatory:
|
||||
|
||||
- `shipping`:
|
||||
- an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone.
|
||||
- shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero.
|
||||
- the `id` is an internal value used by the merchant. This value must be sent back as the customer selection.
|
||||
|
||||
**Event Tags**:
|
||||
|
||||
```json
|
||||
"tags": [["d", <String, id of stall]]
|
||||
```
|
||||
|
||||
- the `d` tag is required by [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md). Its value MUST be the same as the stall `id`.
|
||||
|
||||
### Event `30018`: Create or update a product
|
||||
|
||||
**Event Content**:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": <String, UUID generated by the merchant.Sequential IDs (`0`, `1`, `2`...) are discouraged>,
|
||||
|
|
@ -93,6 +96,7 @@ Fields that are not self-explanatory:
|
|||
```
|
||||
|
||||
Fields that are not self-explanatory:
|
||||
|
||||
- `specs`:
|
||||
- an array of key pair values. It allows for the Customer UI to present present product specifications in a structure mode. It also allows comparison between products
|
||||
- eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]`
|
||||
|
|
@ -100,6 +104,7 @@ Fields that are not self-explanatory:
|
|||
_Open_: better to move `spec` in the `tags` section of the event?
|
||||
|
||||
**Event Tags**:
|
||||
|
||||
```json
|
||||
"tags": [
|
||||
["d", <String, id of product],
|
||||
|
|
@ -124,8 +129,8 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff
|
|||
| 1 | Merchant | Payment Request |
|
||||
| 2 | Merchant | Order Status Update |
|
||||
|
||||
|
||||
### Step 1: `customer` order (event)
|
||||
|
||||
The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md).
|
||||
|
||||
```json
|
||||
|
|
@ -153,7 +158,6 @@ The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips
|
|||
|
||||
_Open_: is `contact.nostr` required?
|
||||
|
||||
|
||||
### Step 2: `merchant` request payment (event)
|
||||
|
||||
Sent back from the merchant for payment. Any payment option is valid that the merchant can check.
|
||||
|
|
@ -207,7 +211,7 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
|
|||
|
||||
## Customer support events
|
||||
|
||||
Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md.
|
||||
Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used <https://github.com/nostr-protocol/nips/blob/master/04.md>.
|
||||
|
||||
## Additional
|
||||
|
||||
|
|
|
|||
24
16.md
24
16.md
|
|
@ -1,37 +1,33 @@
|
|||
NIP-16
|
||||
======
|
||||
# NIP-16
|
||||
|
||||
Event Treatment
|
||||
---------------
|
||||
## Event Treatment
|
||||
|
||||
`draft` `optional` `author:Semisol`
|
||||
|
||||
Relays may decide to allow replaceable and/or ephemeral events.
|
||||
|
||||
Regular Events
|
||||
------------------
|
||||
## Regular Events
|
||||
|
||||
A *regular event* is defined as an event with a kind `1000 <= n < 10000`.
|
||||
Upon a regular event being received, the relay SHOULD send it to all clients with a matching filter, and SHOULD store it. New events of the same kind do not affect previous events in any way.
|
||||
|
||||
Replaceable Events
|
||||
------------------
|
||||
## Replaceable Events
|
||||
|
||||
A *replaceable event* is defined as an event with a kind `10000 <= n < 20000`.
|
||||
Upon a replaceable event with a newer timestamp than the currently known latest replaceable event with the same kind and author being received, the old event SHOULD be discarded,
|
||||
effectively replacing what gets returned when querying for
|
||||
`author:kind` tuples.
|
||||
|
||||
Ephemeral Events
|
||||
----------------
|
||||
## Ephemeral Events
|
||||
|
||||
An *ephemeral event* is defined as an event with a kind `20000 <= n < 30000`.
|
||||
Upon an ephemeral event being received, the relay SHOULD send it to all clients with a matching filter, and MUST NOT store it.
|
||||
|
||||
Client Behavior
|
||||
---------------
|
||||
## Client Behavior
|
||||
|
||||
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
|
||||
-------------------
|
||||
## Suggested Use Cases
|
||||
|
||||
* States: An application may create a state event that is replaced every time a new state is set (such as statuses)
|
||||
* Typing indicators: A chat application may use ephemeral events as a typing indicator.
|
||||
|
|
|
|||
6
18.md
6
18.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-18
|
||||
======
|
||||
# NIP-18
|
||||
|
||||
Reposts
|
||||
-------
|
||||
## Reposts
|
||||
|
||||
`draft` `optional` `author:jb55` `author:fiatjaf` `author:arthurfranca`
|
||||
|
||||
|
|
|
|||
6
19.md
6
19.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-19
|
||||
======
|
||||
# NIP-19
|
||||
|
||||
bech32-encoded entities
|
||||
-----------------------
|
||||
## bech32-encoded entities
|
||||
|
||||
`draft` `optional` `author:jb55` `author:fiatjaf` `author:Semisol`
|
||||
|
||||
|
|
|
|||
20
20.md
20
20.md
|
|
@ -1,9 +1,6 @@
|
|||
NIP-20
|
||||
======
|
||||
# NIP-20
|
||||
|
||||
|
||||
Command Results
|
||||
---------------
|
||||
## Command Results
|
||||
|
||||
`draft` `optional` `author:jb55`
|
||||
|
||||
|
|
@ -33,9 +30,7 @@ Ephemeral events are not acknowledged with OK responses, unless there is a failu
|
|||
|
||||
If the event or `EVENT` command is malformed and could not be parsed, a NOTICE message SHOULD be used instead of a command result. This NIP only applies to non-malformed EVENT commands.
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
## Examples
|
||||
|
||||
Event successfully written to the database:
|
||||
|
||||
|
|
@ -73,10 +68,7 @@ Event failed to save,
|
|||
|
||||
["OK", "b1a649ebe8...", false, "error: could not connect to the database"]
|
||||
|
||||
|
||||
|
||||
Client Handling
|
||||
---------------
|
||||
## Client Handling
|
||||
|
||||
`messages` are meant for humans, with `reason:` prefixes so that clients can be slightly more intelligent with what to do with them. For example, with a `rate-limited:` reason the client may not show anything and simply try again with a longer timeout.
|
||||
|
||||
|
|
@ -86,8 +78,6 @@ For the `invalid:` and `blocked:` prefix the client may wish to show these as st
|
|||
|
||||
The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it.
|
||||
|
||||
|
||||
Future Extensions
|
||||
-----------------
|
||||
## Future Extensions
|
||||
|
||||
This proposal SHOULD be extended to support further commands in the future, such as REQ and AUTH. They are left out of this initial version to keep things simpler.
|
||||
|
|
|
|||
6
21.md
6
21.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-21
|
||||
======
|
||||
# NIP-21
|
||||
|
||||
`nostr:` URL scheme
|
||||
-------------------
|
||||
## `nostr:` URL scheme
|
||||
|
||||
`draft` `optional` `author:fiatjaf`
|
||||
|
||||
|
|
|
|||
17
22.md
17
22.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-22
|
||||
======
|
||||
# NIP-22
|
||||
|
||||
Event `created_at` Limits
|
||||
---------------------------
|
||||
## Event `created_at` Limits
|
||||
|
||||
`draft` `optional` `author:jeffthibault` `author:Giszmo`
|
||||
|
||||
|
|
@ -10,13 +8,11 @@ Relays may define both upper and lower limits within which they will consider an
|
|||
|
||||
If a relay supports this NIP, the relay SHOULD send the client a [NIP-20](20.md) command result saying the event was not stored for the `created_at` timestamp not being within the permitted limits.
|
||||
|
||||
Client Behavior
|
||||
---------------
|
||||
## Client Behavior
|
||||
|
||||
Clients SHOULD use the [NIP-11](11.md) `supported_nips` field to learn if a relay uses event `created_at` time limits as defined by this NIP.
|
||||
|
||||
Motivation
|
||||
----------
|
||||
## Motivation
|
||||
|
||||
This NIP formalizes restrictions on event timestamps as accepted by a relay and allows clients to be aware of relays that have these restrictions.
|
||||
|
||||
|
|
@ -28,9 +24,7 @@ A wide adoption of this NIP could create a better user experience as it would de
|
|||
|
||||
Keep in mind that there is a use case where a user migrates their old posts onto a new relay. If a relay rejects events that were not recently created, it cannot serve this use case.
|
||||
|
||||
|
||||
Python (pseudocode) Example
|
||||
---------------------------
|
||||
## Python (pseudocode) Example
|
||||
|
||||
```python
|
||||
import time
|
||||
|
|
@ -42,4 +36,5 @@ UPPER_LIMIT = TIME + (60 * 15) # Define upper limit as 15 minutes into the
|
|||
if event.created_at not in range(LOWER_LIMIT, UPPER_LIMIT):
|
||||
ws.send('["OK", event.id, False, "invalid: the event created_at field is out of the acceptable range (-24h, +15min) for this relay"]')
|
||||
```
|
||||
|
||||
Note: These are just example limits, the relay operator can choose whatever limits they want.
|
||||
|
|
|
|||
6
23.md
6
23.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-23
|
||||
======
|
||||
# NIP-23
|
||||
|
||||
Long-form Content
|
||||
-----------------
|
||||
## Long-form Content
|
||||
|
||||
`draft` `optional` `author:fiatjaf`
|
||||
|
||||
|
|
|
|||
10
25.md
10
25.md
|
|
@ -1,9 +1,6 @@
|
|||
# NIP-25
|
||||
|
||||
NIP-25
|
||||
======
|
||||
|
||||
Reactions
|
||||
---------
|
||||
## Reactions
|
||||
|
||||
`draft` `optional` `author:jb55`
|
||||
|
||||
|
|
@ -21,8 +18,7 @@ separate tallies.
|
|||
The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike",
|
||||
or the client MAY display this emoji reaction on the post.
|
||||
|
||||
Tags
|
||||
----
|
||||
## 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
|
||||
|
|
|
|||
28
26.md
28
26.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP: 26
|
||||
=======
|
||||
# NIP: 26
|
||||
|
||||
Delegated Event Signing
|
||||
-----
|
||||
## Delegated Event Signing
|
||||
|
||||
`draft` `optional` `author:markharding` `author:minds`
|
||||
|
||||
|
|
@ -10,7 +8,7 @@ This NIP defines how events can be delegated so that they can be signed by other
|
|||
|
||||
Another application of this proposal is to abstract away the use of the 'root' keypairs when interacting with clients. For example, a user could generate new keypairs for each client they wish to use and authorize those keypairs to generate events on behalf of their root pubkey, where the root keypair is stored in cold storage.
|
||||
|
||||
#### Introducing the 'delegation' tag
|
||||
### Introducing the 'delegation' tag
|
||||
|
||||
This NIP introduces a new tag: `delegation` which is formatted as follows:
|
||||
|
||||
|
|
@ -23,23 +21,27 @@ This NIP introduces a new tag: `delegation` which is formatted as follows:
|
|||
]
|
||||
```
|
||||
|
||||
##### Delegation Token
|
||||
#### Delegation Token
|
||||
|
||||
The **delegation token** should be a 64-byte Schnorr signature of the sha256 hash of the following string:
|
||||
|
||||
```
|
||||
```text
|
||||
nostr:delegation:<pubkey of publisher (delegatee)>:<conditions query string>
|
||||
```
|
||||
|
||||
##### Conditions Query String
|
||||
#### Conditions Query String
|
||||
|
||||
The following fields and operators are supported in the above query string:
|
||||
|
||||
*Fields*:
|
||||
|
||||
1. `kind`
|
||||
|
||||
- *Operators*:
|
||||
- `=${KIND_NUMBER}` - delegatee may only sign events of this kind
|
||||
2. `created_at`
|
||||
|
||||
1. `created_at`
|
||||
|
||||
- *Operators*:
|
||||
- `<${TIMESTAMP}` - delegatee may only sign events created ***before*** the specified timestamp
|
||||
- `>${TIMESTAMP}` - delegatee may only sign events created ***after*** the specified timestamp
|
||||
|
|
@ -56,7 +58,7 @@ For the vast majority of use-cases, it is advisable that query strings should in
|
|||
|
||||
#### Example
|
||||
|
||||
```
|
||||
```yaml
|
||||
# Delegator:
|
||||
privkey: ee35e8bb71131c02c1d7e73231daa48e9953d329a4b701f7133c8f46dd21139c
|
||||
pubkey: 8e0d3d3eb2881ec137a11debe736a9086715a8c8beeeda615780064d68bc25dd
|
||||
|
|
@ -67,16 +69,19 @@ pubkey: 477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396
|
|||
```
|
||||
|
||||
Delegation string to grant note publishing authorization to the delegatee (477318cf) from now, for the next 30 days, given the current timestamp is `1674834236`.
|
||||
|
||||
```json
|
||||
nostr:delegation:477318cfb5427b9cfc66a9fa376150c1ddbc62115ae27cef72417eb959691396:kind=1&created_at>1674834236&created_at<1677426236
|
||||
```
|
||||
|
||||
The delegator (8e0d3d3e) then signs a SHA256 hash of the above delegation string, the result of which is the delegation token:
|
||||
```
|
||||
|
||||
```text
|
||||
6f44d7fe4f1c09f3954640fb58bd12bae8bb8ff4120853c4693106c82e920e2b898f1f9ba9bd65449a987c39c0423426ab7b53910c0c6abfb41b30bc16e5f524
|
||||
```
|
||||
|
||||
The delegatee (477318cf) can now construct an event on behalf of the delegator (8e0d3d3e). The delegatee then signs the event with its own private key and publishes.
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "e93c6095c3db1c31d15ac771f8fc5fb672f6e52cd25505099f62cd055523224f",
|
||||
|
|
@ -100,7 +105,6 @@ The event should be considered a valid delegation if the conditions are satisfie
|
|||
|
||||
Clients should display the delegated note as if it was published directly by the delegator (8e0d3d3e).
|
||||
|
||||
|
||||
#### Relay & Client Support
|
||||
|
||||
Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value.
|
||||
|
|
|
|||
6
27.md
6
27.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-27
|
||||
======
|
||||
# NIP-27
|
||||
|
||||
Text Note References
|
||||
--------------------
|
||||
## Text Note References
|
||||
|
||||
`draft` `optional` `author:arthurfranca` `author:hodlbod` `author:fiatjaf`
|
||||
|
||||
|
|
|
|||
17
28.md
17
28.md
|
|
@ -1,9 +1,6 @@
|
|||
# NIP-28
|
||||
|
||||
NIP-28
|
||||
======
|
||||
|
||||
Public Chat
|
||||
-----------
|
||||
## Public Chat
|
||||
|
||||
`draft` `optional` `author:ChristopherDavid` `author:fiatjaf` `author:jb55` `author:Cameri`
|
||||
|
||||
|
|
@ -32,7 +29,6 @@ In the channel creation `content` field, Client SHOULD include basic channel met
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Kind 41: Set channel metadata
|
||||
|
||||
Update a channel's public metadata.
|
||||
|
|
@ -59,7 +55,6 @@ Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Kind 42: Create channel message
|
||||
|
||||
Send a text message to a channel.
|
||||
|
|
@ -93,7 +88,6 @@ Reply to another message:
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Kind 43: Hide message
|
||||
|
||||
User no longer wants to see a certain message.
|
||||
|
|
@ -138,16 +132,13 @@ For [NIP-10](10.md) relay recommendations, clients generally SHOULD use the rela
|
|||
|
||||
Clients MAY recommend any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay.
|
||||
|
||||
## Motivation
|
||||
|
||||
Motivation
|
||||
----------
|
||||
If we're solving censorship-resistant communication for social media, we may as well solve it also for Telegram-style messaging.
|
||||
|
||||
We can bring the global conversation out from walled gardens into a true public square open to all.
|
||||
|
||||
|
||||
Additional info
|
||||
---------------
|
||||
## Additional info
|
||||
|
||||
- [Chat demo PR with fiatjaf+jb55 comments](https://github.com/ArcadeCity/arcade/pull/28)
|
||||
- [Conversation about NIP16](https://t.me/nostr_protocol/29566)
|
||||
|
|
|
|||
16
33.md
16
33.md
|
|
@ -1,15 +1,13 @@
|
|||
NIP-33
|
||||
======
|
||||
# NIP-33
|
||||
|
||||
Parameterized Replaceable Events
|
||||
--------------------------------
|
||||
## Parameterized Replaceable Events
|
||||
|
||||
`draft` `optional` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo`
|
||||
|
||||
This NIP adds a new event range that allows for replacement of events that have the same `d` tag and kind unlike NIP-16 which only replaced by kind.
|
||||
|
||||
Implementation
|
||||
--------------
|
||||
## Implementation
|
||||
|
||||
The value of a tag is defined as the first parameter of a tag after the tag name.
|
||||
|
||||
A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`.
|
||||
|
|
@ -32,8 +30,7 @@ replace each other:
|
|||
|
||||
Clients SHOULD NOT use `d` tags with multiple values and SHOULD include the `d` tag even if it has no value to allow querying using the `#d` filter.
|
||||
|
||||
Referencing and tagging
|
||||
-----------------------
|
||||
## Referencing and tagging
|
||||
|
||||
Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the
|
||||
`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their
|
||||
|
|
@ -46,8 +43,7 @@ the referenced combination of public key and `d` tag can be found.
|
|||
|
||||
The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "<kind>:<pubkey>:<d-identifier>", "<relay url>"]`.
|
||||
|
||||
Client Behavior
|
||||
---------------
|
||||
## Client Behavior
|
||||
|
||||
Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP.
|
||||
Clients MAY send parameterized 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 and are recommended to send a `#d` tag filter. Clients should account for the fact that missing `d` tags or ones with no value are not returned in tag filters, and are recommended to always include a `d` tag with a value.
|
||||
|
|
|
|||
12
36.md
12
36.md
|
|
@ -1,23 +1,21 @@
|
|||
NIP-36
|
||||
======
|
||||
# NIP-36
|
||||
|
||||
Sensitive Content / Content Warning
|
||||
-----------------------------------
|
||||
## Sensitive Content / Content Warning
|
||||
|
||||
`draft` `optional` `author:fernandolguevara`
|
||||
|
||||
The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown.
|
||||
Clients can hide the content until the user acts on it.
|
||||
|
||||
#### Spec
|
||||
### Spec
|
||||
|
||||
```
|
||||
```yaml
|
||||
tag: content-warning
|
||||
options:
|
||||
- [reason]: optional
|
||||
```
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
8
39.md
8
39.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-39
|
||||
======
|
||||
# NIP-39
|
||||
|
||||
External Identities in Profiles
|
||||
-------------------------------
|
||||
## External Identities in Profiles
|
||||
|
||||
`draft` `optional` `author:pseudozach` `author:Semisol`
|
||||
|
||||
|
|
@ -13,6 +11,7 @@ Nostr protocol users may have other online identities such as usernames, profile
|
|||
## `i` tag on a metadata event
|
||||
|
||||
A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md):
|
||||
|
||||
```json
|
||||
{
|
||||
"id": <id>,
|
||||
|
|
@ -28,6 +27,7 @@ A new optional `i` tag is introduced for `kind 0` metadata event contents in add
|
|||
```
|
||||
|
||||
An `i` tag will have two parameters, which are defined as the following:
|
||||
|
||||
1. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`.
|
||||
2. `proof`: String or object that points to the proof of owning this identity.
|
||||
|
||||
|
|
|
|||
24
40.md
24
40.md
|
|
@ -1,22 +1,20 @@
|
|||
NIP-40
|
||||
======
|
||||
# NIP-40
|
||||
|
||||
Expiration Timestamp
|
||||
-----------------------------------
|
||||
## Expiration Timestamp
|
||||
|
||||
`draft` `optional` `author:0xtlt`
|
||||
|
||||
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.
|
||||
|
||||
#### Spec
|
||||
### Spec
|
||||
|
||||
```
|
||||
```yaml
|
||||
tag: expiration
|
||||
values:
|
||||
- [UNIX timestamp in seconds]: required
|
||||
```
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -33,27 +31,25 @@ values:
|
|||
|
||||
Note: The timestamp should be in the same format as the created_at timestamp and should be interpreted as the time at which the message should be deleted by relays.
|
||||
|
||||
Client Behavior
|
||||
---------------
|
||||
## Client Behavior
|
||||
|
||||
Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. Clients SHOULD NOT send expiration events to relays that do not support this NIP.
|
||||
|
||||
Clients SHOULD ignore events that have expired.
|
||||
|
||||
Relay Behavior
|
||||
--------------
|
||||
## Relay Behavior
|
||||
|
||||
Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely.
|
||||
Relays SHOULD NOT send expired events to clients, even if they are stored.
|
||||
Relays SHOULD drop any events that are published to them if they are expired.
|
||||
An expiration timestamp does not affect storage of ephemeral events.
|
||||
|
||||
Suggested Use Cases
|
||||
-------------------
|
||||
## Suggested Use Cases
|
||||
|
||||
* Temporary announcements - This tag can be used to make temporary announcements. For example, an event organizer could use this tag to post announcements about an upcoming event.
|
||||
* Limited-time offers - This tag can be used by businesses to make limited-time offers that expire after a certain amount of time. For example, a business could use this tag to make a special offer that is only available for a limited time.
|
||||
|
||||
#### Warning
|
||||
### Warning
|
||||
|
||||
The events could be downloaded by third parties as they are publicly accessible all the time on the relays.
|
||||
So don't consider expiring messages as a security feature for your conversations or other uses.
|
||||
|
|
|
|||
14
42.md
14
42.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-42
|
||||
======
|
||||
# NIP-42
|
||||
|
||||
Authentication of clients to relays
|
||||
-----------------------------------
|
||||
## Authentication of clients to relays
|
||||
|
||||
`draft` `optional` `author:Semisol` `author:fiatjaf`
|
||||
|
||||
|
|
@ -24,13 +22,13 @@ A relay may want to require clients to authenticate to access restricted resourc
|
|||
This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want
|
||||
to authenticate. When sent by relays, the message is of the following form:
|
||||
|
||||
```
|
||||
```json
|
||||
["AUTH", <challenge-string>]
|
||||
```
|
||||
|
||||
And, when sent by clients, of the following form:
|
||||
|
||||
```
|
||||
```json
|
||||
["AUTH", <signed-event-json>]
|
||||
```
|
||||
|
||||
|
|
@ -67,13 +65,13 @@ is expected to last for the duration of the WebSocket connection.
|
|||
Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For
|
||||
that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example:
|
||||
|
||||
```
|
||||
```json
|
||||
["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"]
|
||||
```
|
||||
|
||||
or it can return an `OK` message noting the reason an event was not written using the same prefix:
|
||||
|
||||
```
|
||||
```json
|
||||
["OK", <event-id>, false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"]
|
||||
```
|
||||
|
||||
|
|
|
|||
12
45.md
12
45.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-45
|
||||
======
|
||||
# NIP-45
|
||||
|
||||
Event Counts
|
||||
--------------
|
||||
## Event Counts
|
||||
|
||||
`draft` `optional` `author:staab`
|
||||
|
||||
|
|
@ -16,19 +14,19 @@ Some queries a client may want to execute against connected relays are prohibiti
|
|||
|
||||
This NIP defines a verb called `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md).
|
||||
|
||||
```
|
||||
```json
|
||||
["COUNT", <subscription_id>, <filters JSON>...]
|
||||
```
|
||||
|
||||
Counts are returned using a `COUNT` response in the form `{count: <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
|
||||
|
||||
```
|
||||
```json
|
||||
["COUNT", <subscription_id>, {"count": <integer>}]
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
```json
|
||||
# Followers count
|
||||
["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
|
||||
["COUNT", <subscription_id>, {"count": 238}]
|
||||
|
|
|
|||
27
46.md
27
46.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-46
|
||||
======
|
||||
# NIP-46
|
||||
|
||||
Nostr Connect
|
||||
------------------------
|
||||
## Nostr Connect
|
||||
|
||||
`draft` `optional` `author:tiero` `author:giowe` `author:vforvalerio87`
|
||||
|
||||
|
|
@ -12,16 +10,13 @@ Private keys should be exposed to as few systems - apps, operating systems, devi
|
|||
|
||||
Entering private keys can also be annoying and requires exposing them to even more systems such as the operating system's clipboard that might be monitored by malicious apps.
|
||||
|
||||
|
||||
## Terms
|
||||
|
||||
* **App**: Nostr app on any platform that *requires* to act on behalf of a nostr account.
|
||||
* **Signer**: Nostr app that holds the private key of a nostr account and *can sign* on its behalf.
|
||||
|
||||
- **App**: Nostr app on any platform that *requires* to act on behalf of a nostr account.
|
||||
- **Signer**: Nostr app that holds the private key of a nostr account and *can sign* on its behalf.
|
||||
|
||||
## `TL;DR`
|
||||
|
||||
|
||||
**App** and **Signer** sends ephemeral encrypted messages to each other using kind `24133`, using a relay of choice.
|
||||
|
||||
App prompts the Signer to do things such as fetching the public key or signing events.
|
||||
|
|
@ -54,7 +49,6 @@ The `content` field must be an encrypted JSONRPC-ish **request** or **response**
|
|||
|
||||
### Methods
|
||||
|
||||
|
||||
#### Mandatory
|
||||
|
||||
These are mandatory methods the remote signer app MUST implement:
|
||||
|
|
@ -71,7 +65,6 @@ These are mandatory methods the remote signer app MUST implement:
|
|||
|
||||
#### optional
|
||||
|
||||
|
||||
- **connect**
|
||||
- params [`pubkey`]
|
||||
- **disconnect**
|
||||
|
|
@ -89,10 +82,8 @@ These are mandatory methods the remote signer app MUST implement:
|
|||
- params [`pubkey`, `nip4 ciphertext`]
|
||||
- result [`plaintext`]
|
||||
|
||||
|
||||
NOTICE: `pubkey` and `signature` are hex-encoded strings.
|
||||
|
||||
|
||||
### Nostr Connect URI
|
||||
|
||||
**Signer** discovers **App** by scanning a QR code, clicking on a deep link or copy-pasting an URI.
|
||||
|
|
@ -113,12 +104,11 @@ const uri = `nostrconnect://<pubkey>?relay=${encodeURIComponent("wss://relay.dam
|
|||
```
|
||||
|
||||
#### Example
|
||||
|
||||
```sh
|
||||
nostrconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&metadata=%7B%22name%22%3A%22Example%22%7D
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Flows
|
||||
|
||||
The `content` field contains encrypted message as specified by [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). The `kind` chosen is `24133`.
|
||||
|
|
@ -141,22 +131,19 @@ The `content` field contains encrypted message as specified by [NIP04](https://g
|
|||
1. User clicks on **"Disconnect"** button on the **Signer**
|
||||
2. The **Signer** will send a message to the **App** with a `disconnect` request
|
||||
|
||||
|
||||
### Get Public Key
|
||||
|
||||
1. The **App** will send a message to the **Signer** with a `get_public_key` request
|
||||
3. The **Signer** will send back a message with the public key as a response to the `get_public_key` request
|
||||
2. The **Signer** will send back a message with the public key as a response to the `get_public_key` request
|
||||
|
||||
### Sign Event
|
||||
|
||||
1. The **App** will send a message to the **Signer** with a `sign_event` request along with the **event** to be signed
|
||||
2. The **Signer** will show a popup to the user to inspect the event and sign it
|
||||
3. The **Signer** will send back a message with the event including the `id` and the schnorr `signature` as a response to the `sign_event` request
|
||||
3. The **Signer** will send back a message with the event including the `id` and the Schnorr `signature` as a response to the `sign_event` request
|
||||
|
||||
### Delegate
|
||||
|
||||
1. The **App** will send a message with metadata to the **Signer** with a `delegate` request along with the **conditions** query string and the **pubkey** of the **App** to be delegated.
|
||||
2. The **Signer** will show a popup to the user to delegate the **App** to sign on his behalf
|
||||
3. The **Signer** will send back a message with the signed [NIP-26 delegation token](https://github.com/nostr-protocol/nips/blob/master/26.md) or reject it
|
||||
|
||||
|
||||
|
|
|
|||
9
50.md
9
50.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-50
|
||||
======
|
||||
# NIP-50
|
||||
|
||||
Search Capability
|
||||
-----------------
|
||||
## Search Capability
|
||||
|
||||
`draft` `optional` `author:brugeman` `author:mikedilger` `author:fiatjaf`
|
||||
|
||||
|
|
@ -15,12 +13,14 @@ extensible framework for performing such queries.
|
|||
## `search` filter field
|
||||
|
||||
A new `search` field is introduced for `REQ` messages from clients:
|
||||
|
||||
```json
|
||||
{
|
||||
...
|
||||
"search": <string>
|
||||
}
|
||||
```
|
||||
|
||||
`search` field is a string describing a query in a human-readable form, i.e. "best nostr apps".
|
||||
Relays SHOULD interpret the query to the best of their ability and return events that match it.
|
||||
Relays SHOULD perform matching against `content` event field, and MAY perform
|
||||
|
|
@ -46,4 +46,5 @@ Relays SHOULD exclude spam from search results by default if they supports some
|
|||
## Extensions
|
||||
|
||||
Relay MAY support these extensions:
|
||||
|
||||
- `include:spam` - turn off spam filtering, if it was enabled by default
|
||||
|
|
|
|||
17
51.md
17
51.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-51
|
||||
======
|
||||
# NIP-51
|
||||
|
||||
Lists
|
||||
-------------------------
|
||||
## Lists
|
||||
|
||||
`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `depends:33`
|
||||
|
||||
|
|
@ -15,16 +13,19 @@ Otherwise, the list type's events should follow the specification for [NIP-33 -
|
|||
## Replaceable List Event Example
|
||||
|
||||
Lets say a user wants to create a 'Mute' list and has keys:
|
||||
```
|
||||
|
||||
```yaml
|
||||
priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
|
||||
pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
|
||||
```
|
||||
|
||||
The user wants to publicly include these users:
|
||||
|
||||
```json
|
||||
["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
|
||||
["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
|
||||
```
|
||||
|
||||
and privately include these users (below is the JSON that would be encrypted and placed in the event content):
|
||||
|
||||
```json
|
||||
|
|
@ -48,20 +49,22 @@ Then the user would create a 'Mute' list event like below:
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Parameterized Replaceable List Event Example
|
||||
|
||||
Lets say a user wants to create a 'Categorized People' list of `nostr` people and has keys:
|
||||
```
|
||||
|
||||
```yaml
|
||||
priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
|
||||
pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
|
||||
```
|
||||
|
||||
The user wants to publicly include these users:
|
||||
|
||||
```json
|
||||
["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
|
||||
["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
|
||||
```
|
||||
|
||||
and privately include these users (below is the JSON that would be encrypted and placed in the event content):
|
||||
|
||||
```json
|
||||
|
|
|
|||
20
56.md
20
56.md
|
|
@ -1,9 +1,6 @@
|
|||
# NIP-56
|
||||
|
||||
NIP-56
|
||||
======
|
||||
|
||||
Reporting
|
||||
---------
|
||||
## Reporting
|
||||
|
||||
`draft` `optional` `author:jb55`
|
||||
|
||||
|
|
@ -13,8 +10,7 @@ illegal and explicit content.
|
|||
The content MAY contain additional information submitted by the entity
|
||||
reporting the content.
|
||||
|
||||
Tags
|
||||
----
|
||||
## Tags
|
||||
|
||||
The report event MUST include a `p` tag referencing the pubkey of the user you
|
||||
are reporting.
|
||||
|
|
@ -32,8 +28,7 @@ being reported, which consists of the following report types:
|
|||
|
||||
Some report tags only make sense for profile reports, such as `impersonation`
|
||||
|
||||
Example events
|
||||
--------------
|
||||
## Example events
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -66,16 +61,13 @@ Example events
|
|||
}
|
||||
```
|
||||
|
||||
Client behavior
|
||||
---------------
|
||||
## Client behavior
|
||||
|
||||
Clients can use reports from friends to make moderation decisions if they
|
||||
choose to. For instance, if 3+ of your friends report a profile as explicit,
|
||||
clients can have an option to automatically blur photos from said account.
|
||||
|
||||
|
||||
Relay behavior
|
||||
--------------
|
||||
## Relay behavior
|
||||
|
||||
It is not recommended that relays perform automatic moderation using reports,
|
||||
as they can be easily gamed. Admins could use reports from trusted moderators to
|
||||
|
|
|
|||
6
57.md
6
57.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-57
|
||||
======
|
||||
# NIP-57
|
||||
|
||||
Lightning Zaps
|
||||
--------------
|
||||
## Lightning Zaps
|
||||
|
||||
`draft` `optional` `author:jb55` `author:kieran`
|
||||
|
||||
|
|
|
|||
7
58.md
7
58.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-58
|
||||
======
|
||||
# NIP-58
|
||||
|
||||
Badges
|
||||
------
|
||||
## Badges
|
||||
|
||||
`draft` `optional` `author:cameri`
|
||||
|
||||
|
|
@ -116,6 +114,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
|
|||
### Example of a Profile Badges event
|
||||
|
||||
Honorable Bob The Brave:
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 30008,
|
||||
|
|
|
|||
6
65.md
6
65.md
|
|
@ -1,8 +1,6 @@
|
|||
NIP-65
|
||||
======
|
||||
# NIP-65
|
||||
|
||||
Relay List Metadata
|
||||
-------------------
|
||||
## Relay List Metadata
|
||||
|
||||
`draft` `optional` `author:mikedilger`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user