diff options
| -rw-r--r-- | 01.md | 28 | ||||
| -rw-r--r-- | 05.md | 4 | ||||
| -rw-r--r-- | 07.md | 4 | ||||
| -rw-r--r-- | 09.md | 10 | ||||
| -rw-r--r-- | 15.md | 14 | ||||
| -rw-r--r-- | 19.md | 3 | ||||
| -rw-r--r-- | 21.md | 2 | ||||
| -rw-r--r-- | 24.md | 2 | ||||
| -rw-r--r-- | 25.md | 17 | ||||
| -rw-r--r-- | 27.md | 2 | ||||
| -rw-r--r-- | 28.md | 2 | ||||
| -rw-r--r-- | 29.md | 1 | ||||
| -rw-r--r-- | 32.md | 29 | ||||
| -rw-r--r-- | 34.md | 2 | ||||
| -rw-r--r-- | 39.md | 4 | ||||
| -rw-r--r-- | 46.md | 8 | ||||
| -rw-r--r-- | 47.md | 2 | ||||
| -rw-r--r-- | 50.md | 2 | ||||
| -rw-r--r-- | 55.md | 538 | ||||
| -rw-r--r-- | 57.md | 2 | ||||
| -rw-r--r-- | 65.md | 2 | ||||
| -rw-r--r-- | 70.md | 45 | ||||
| -rw-r--r-- | 89.md | 4 | ||||
| -rw-r--r-- | 96.md | 126 | ||||
| -rw-r--r-- | 98.md | 3 | ||||
| -rw-r--r-- | 99.md | 8 | ||||
| -rw-r--r-- | BREAKING.md | 14 | ||||
| -rw-r--r-- | README.md | 14 |
28 files changed, 776 insertions, 116 deletions
| @@ -43,16 +43,16 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is | |||
| 43 | ``` | 43 | ``` |
| 44 | 44 | ||
| 45 | To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: | 45 | To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: |
| 46 | - No whitespace, line breaks or other unnecessary formatting should be included in the output JSON. | ||
| 47 | - No characters except the following should be escaped, and instead should be included verbatim: | ||
| 48 | - A line break, `0x0A`, as `\n` | ||
| 49 | - A double quote, `0x22`, as `\"` | ||
| 50 | - A backslash, `0x5C`, as `\\` | ||
| 51 | - A carriage return, `0x0D`, as `\r` | ||
| 52 | - A tab character, `0x09`, as `\t` | ||
| 53 | - A backspace, `0x08`, as `\b` | ||
| 54 | - A form feed, `0x0C`, as `\f` | ||
| 55 | - UTF-8 should be used for encoding. | 46 | - UTF-8 should be used for encoding. |
| 47 | - Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON. | ||
| 48 | - The following characters in the content field must be escaped as shown, and all other characters must be included verbatim: | ||
| 49 | - A line break (`0x0A`), use `\n` | ||
| 50 | - A double quote (`0x22`), use `\"` | ||
| 51 | - A backslash (`0x5C`), use `\\` | ||
| 52 | - A carriage return (`0x0D`), use `\r` | ||
| 53 | - A tab character (`0x09`), use `\t` | ||
| 54 | - A backspace, (`0x08`), use `\b` | ||
| 55 | - A form feed, (`0x0C`), use `\f` | ||
| 56 | 56 | ||
| 57 | ### Tags | 57 | ### Tags |
| 58 | 58 | ||
| @@ -87,12 +87,12 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key | |||
| 87 | 87 | ||
| 88 | Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: | 88 | Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: |
| 89 | 89 | ||
| 90 | - `0`: **metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. | 90 | - `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. |
| 91 | - `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. | 91 | - `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. |
| 92 | 92 | ||
| 93 | And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: | 93 | And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: |
| 94 | 94 | ||
| 95 | - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. | 95 | - for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays. |
| 96 | - for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. | 96 | - for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. |
| 97 | - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. | 97 | - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. |
| 98 | - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded. | 98 | - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded. |
| @@ -125,8 +125,8 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th | |||
| 125 | "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, | 125 | "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, |
| 126 | "kinds": <a list of a kind numbers>, | 126 | "kinds": <a list of a kind numbers>, |
| 127 | "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of pubkeys, etc.>, | 127 | "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of pubkeys, etc.>, |
| 128 | "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, | 128 | "since": <an integer unix timestamp in seconds. Events must have a created_at >= to this to pass>, |
| 129 | "until": <an integer unix timestamp in seconds, events must be older than this to pass>, | 129 | "until": <an integer unix timestamp in seconds. Events must have a created_at <= to this to pass>, |
| 130 | "limit": <maximum number of events relays SHOULD return in the initial query> | 130 | "limit": <maximum number of events relays SHOULD return in the initial query> |
| 131 | } | 131 | } |
| 132 | ``` | 132 | ``` |
| @@ -143,7 +143,7 @@ All conditions of a filter that are specified must match for an event for it to | |||
| 143 | 143 | ||
| 144 | A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. | 144 | A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. |
| 145 | 145 | ||
| 146 | The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. | 146 | The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. Newer events should appear first, and in the case of ties the event with the lowest id (first in lexical order) should be first. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. |
| 147 | 147 | ||
| 148 | ### From relay to client: sending events and notices | 148 | ### From relay to client: sending events and notices |
| 149 | 149 | ||
| @@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers | |||
| 6 | 6 | ||
| 7 | `final` `optional` | 7 | `final` `optional` |
| 8 | 8 | ||
| 9 | On events of kind `0` (`metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. | 9 | On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. |
| 10 | 10 | ||
| 11 | Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. | 11 | Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. |
| 12 | 12 | ||
| 13 | The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. | 13 | The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user's metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. |
| 14 | 14 | ||
| 15 | ### Example | 15 | ### Example |
| 16 | 16 | ||
| @@ -24,6 +24,10 @@ async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertex | |||
| 24 | async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44 | 24 | async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44 |
| 25 | ``` | 25 | ``` |
| 26 | 26 | ||
| 27 | ### Recommendation to Extension Authors | ||
| 28 | To make sure that the `window.nostr` is available to nostr clients on page load, the authors who create Chromium and Firefox extensions should load their scripts by specifying `"run_at": "document_end"` in the extension's manifest. | ||
| 29 | |||
| 30 | |||
| 27 | ### Implementation | 31 | ### Implementation |
| 28 | 32 | ||
| 29 | See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions. | 33 | See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions. |
| @@ -6,9 +6,7 @@ Event Deletion | |||
| 6 | 6 | ||
| 7 | `draft` `optional` | 7 | `draft` `optional` |
| 8 | 8 | ||
| 9 | A special event with kind `5`, meaning "deletion" is defined as having a list of one or more `e` tags, each referencing an event the author is requesting to be deleted. | 9 | A special event with kind `5`, meaning "deletion" 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 deleted. |
| 10 | |||
| 11 | Each tag entry must contain an "e" event id and/or `a` tags intended for deletion. | ||
| 12 | 10 | ||
| 13 | The event's `content` field MAY contain a text note describing the reason for the deletion. | 11 | The event's `content` field MAY contain a text note describing the reason for the deletion. |
| 14 | 12 | ||
| @@ -21,7 +19,9 @@ For example: | |||
| 21 | "tags": [ | 19 | "tags": [ |
| 22 | ["e", "dcd59..464a2"], | 20 | ["e", "dcd59..464a2"], |
| 23 | ["e", "968c5..ad7a4"], | 21 | ["e", "968c5..ad7a4"], |
| 24 | ["a", "<kind>:<pubkey>:<d-identifier>"] | 22 | ["a", "<kind>:<pubkey>:<d-identifier>"], |
| 23 | ["k", "1"], | ||
| 24 | ["k", "30023"] | ||
| 25 | ], | 25 | ], |
| 26 | "content": "these posts were published by accident", | 26 | "content": "these posts were published by accident", |
| 27 | ...other fields | 27 | ...other fields |
| @@ -32,6 +32,8 @@ Relays SHOULD delete or stop publishing any referenced events that have an ident | |||
| 32 | 32 | ||
| 33 | Relays SHOULD continue to publish/share the deletion events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion events to other relays which don't have it. | 33 | Relays SHOULD continue to publish/share the deletion events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion events to other relays which don't have it. |
| 34 | 34 | ||
| 35 | When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion event. | ||
| 36 | |||
| 35 | ## Client Usage | 37 | ## Client Usage |
| 36 | 38 | ||
| 37 | Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion reason, not the original content. | 39 | Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion reason, not the original content. |
| @@ -6,7 +6,7 @@ Nostr Marketplace | |||
| 6 | 6 | ||
| 7 | `draft` `optional` | 7 | `draft` `optional` |
| 8 | 8 | ||
| 9 | Based on https://github.com/lnbits/Diagon-Alley. | 9 | Based on [Diagon-Alley](https://github.com/lnbits/Diagon-Alley). |
| 10 | 10 | ||
| 11 | Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). | 11 | Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). |
| 12 | 12 | ||
| @@ -139,7 +139,7 @@ Fields that are not self-explanatory: | |||
| 139 | 139 | ||
| 140 | ## Checkout events | 140 | ## Checkout events |
| 141 | 141 | ||
| 142 | All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md)). | 142 | All checkout events are sent as JSON strings using [NIP-04](04.md). |
| 143 | 143 | ||
| 144 | The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types: | 144 | The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types: |
| 145 | 145 | ||
| @@ -150,7 +150,7 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff | |||
| 150 | | 2 | Merchant | Order Status Update | | 150 | | 2 | Merchant | Order Status Update | |
| 151 | 151 | ||
| 152 | ### Step 1: `customer` order (event) | 152 | ### Step 1: `customer` order (event) |
| 153 | The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). | 153 | The below JSON goes in content of [NIP-04](04.md). |
| 154 | 154 | ||
| 155 | ```json | 155 | ```json |
| 156 | { | 156 | { |
| @@ -182,7 +182,7 @@ _Open_: is `contact.nostr` required? | |||
| 182 | 182 | ||
| 183 | Sent back from the merchant for payment. Any payment option is valid that the merchant can check. | 183 | Sent back from the merchant for payment. Any payment option is valid that the merchant can check. |
| 184 | 184 | ||
| 185 | The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). | 185 | The below JSON goes in `content` of [NIP-04](04.md). |
| 186 | 186 | ||
| 187 | `payment_options`/`type` include: | 187 | `payment_options`/`type` include: |
| 188 | 188 | ||
| @@ -217,7 +217,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n | |||
| 217 | 217 | ||
| 218 | Once payment has been received and processed. | 218 | Once payment has been received and processed. |
| 219 | 219 | ||
| 220 | The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). | 220 | The below JSON goes in `content` of [NIP-04](04.md). |
| 221 | 221 | ||
| 222 | ```json | 222 | ```json |
| 223 | { | 223 | { |
| @@ -231,7 +231,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n | |||
| 231 | 231 | ||
| 232 | ## Customize Marketplace | 232 | ## Customize Marketplace |
| 233 | 233 | ||
| 234 | Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. | 234 | Create a customized user experience using the `naddr` from [NIP-19](19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. |
| 235 | 235 | ||
| 236 | ### Event `30019`: Create or update marketplace UI/UX | 236 | ### Event `30019`: Create or update marketplace UI/UX |
| 237 | 237 | ||
| @@ -331,7 +331,7 @@ Another thing that can happen is - if bids happen very close to the end date of | |||
| 331 | 331 | ||
| 332 | ## Customer support events | 332 | ## Customer support events |
| 333 | 333 | ||
| 334 | 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. | 334 | Customer support is handled over whatever communication method was specified. If communicating via nostr, [NIP-04](04.md) is used. |
| 335 | 335 | ||
| 336 | ## Additional | 336 | ## Additional |
| 337 | 337 | ||
| @@ -34,8 +34,8 @@ These are the possible bech32 prefixes with `TLV`: | |||
| 34 | 34 | ||
| 35 | - `nprofile`: a nostr profile | 35 | - `nprofile`: a nostr profile |
| 36 | - `nevent`: a nostr event | 36 | - `nevent`: a nostr event |
| 37 | - `nrelay`: a nostr relay | ||
| 38 | - `naddr`: a nostr _replaceable event_ coordinate | 37 | - `naddr`: a nostr _replaceable event_ coordinate |
| 38 | - `nrelay`: a nostr relay (deprecated) | ||
| 39 | 39 | ||
| 40 | These possible standardized `TLV` types are indicated here: | 40 | These possible standardized `TLV` types are indicated here: |
| 41 | 41 | ||
| @@ -43,7 +43,6 @@ These possible standardized `TLV` types are indicated here: | |||
| 43 | - depends on the bech32 prefix: | 43 | - depends on the bech32 prefix: |
| 44 | - for `nprofile` it will be the 32 bytes of the profile public key | 44 | - for `nprofile` it will be the 32 bytes of the profile public key |
| 45 | - for `nevent` it will be the 32 bytes of the event id | 45 | - for `nevent` it will be the 32 bytes of the event id |
| 46 | - for `nrelay`, this is the relay URL | ||
| 47 | - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. | 46 | - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. |
| 48 | - `1`: `relay` | 47 | - `1`: `relay` |
| 49 | - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii | 48 | - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii |
| @@ -10,7 +10,7 @@ This NIP standardizes the usage of a common URI scheme for maximum interoperabil | |||
| 10 | 10 | ||
| 11 | The scheme is `nostr:`. | 11 | The scheme is `nostr:`. |
| 12 | 12 | ||
| 13 | The identifiers that come after are expected to be the same as those defined in [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) (except `nsec`). | 13 | The identifiers that come after are expected to be the same as those defined in [NIP-19](19.md) (except `nsec`). |
| 14 | 14 | ||
| 15 | ## Examples | 15 | ## Examples |
| 16 | 16 | ||
| @@ -28,7 +28,7 @@ These are fields that should be ignored or removed when found in the wild: | |||
| 28 | kind 3 | 28 | kind 3 |
| 29 | ====== | 29 | ====== |
| 30 | 30 | ||
| 31 | These are extra fields not specified in NIP-02 that may be present in the stringified JSON of contacts events: | 31 | These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events: |
| 32 | 32 | ||
| 33 | ### Deprecated fields | 33 | ### Deprecated fields |
| 34 | 34 | ||
| @@ -25,24 +25,23 @@ consider it a "+". | |||
| 25 | Tags | 25 | Tags |
| 26 | ---- | 26 | ---- |
| 27 | 27 | ||
| 28 | The reaction event SHOULD include `a`, `e` and `p` tags pointing to the note the user is | 28 | The reaction event SHOULD include `e` and `p` tags from the note the user is reacting to (and optionally `a` tags if the target is a replaceable event). This allows users to be notified of reactions to posts they were mentioned in. Including the `e` tags enables clients to pull all the reactions associated with individual posts or all the posts in a thread. `a` tags enables clients to seek reactions for all versions of a replaceable event. |
| 29 | reacting to. The `p` tag allows authors to be notified. The `e` tags enables clients | ||
| 30 | to pull all the reactions to individual events and `a` tags enables clients to seek reactions | ||
| 31 | for all versions of a replaceable event. | ||
| 32 | 29 | ||
| 33 | The `e` tag MUST be the `id` of the note that is being reacted to. | 30 | The last `e` tag MUST be the `id` of the note that is being reacted to. |
| 34 | 31 | ||
| 35 | The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. | 32 | The last `p` tag MUST be the `pubkey` of the event being reacted to. |
| 36 | 33 | ||
| 37 | The `p` tag MUST be the `pubkey` of the event being reacted to. | 34 | The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. |
| 38 | 35 | ||
| 39 | The reaction event MAY include a `k` tag with the stringified kind number | 36 | The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. |
| 40 | of the reacted event as its value. | ||
| 41 | 37 | ||
| 42 | Example code | 38 | Example code |
| 43 | 39 | ||
| 44 | ```swift | 40 | ```swift |
| 45 | func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { | 41 | func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { |
| 42 | var tags: [[String]] = liked.tags.filter { | ||
| 43 | tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") | ||
| 44 | } | ||
| 46 | tags.append(["e", liked.id]) | 45 | tags.append(["e", liked.id]) |
| 47 | tags.append(["p", liked.pubkey]) | 46 | tags.append(["p", liked.pubkey]) |
| 48 | tags.append(["k", liked.kind]) | 47 | tags.append(["k", liked.kind]) |
| @@ -20,7 +20,7 @@ A reader client that receives an event with such `nostr:...` mentions in its `.c | |||
| 20 | 20 | ||
| 21 | Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. | 21 | Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. |
| 22 | 22 | ||
| 23 | As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://gateway.nostr.com/p/2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc), showing a picture and name. | 23 | As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://njump.me/npub1937vv2nf06360qn9y8el6d8sevnndy7tuh5nzre4gj05xc32tnwqauhaj6), showing a picture and name. |
| 24 | 24 | ||
| 25 | Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this: | 25 | Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this: |
| 26 | 26 | ||
| @@ -37,7 +37,7 @@ In the channel creation `content` field, Client SHOULD include basic channel met | |||
| 37 | 37 | ||
| 38 | Update a channel's public metadata. | 38 | Update a channel's public metadata. |
| 39 | 39 | ||
| 40 | Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel.Only the most recent kind 41 is needed to be stored. | 40 | Kind 41 is used to update the metadata without modifying the event id for the channel. Only the most recent kind 41 per `e` tag value MAY be available. |
| 41 | 41 | ||
| 42 | Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. | 42 | Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. |
| 43 | 43 | ||
| @@ -119,6 +119,7 @@ Each moderation action uses a different kind and requires different arguments, w | |||
| 119 | | 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | | 119 | | 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | |
| 120 | | 9005 | `delete-event` | `e` (id hex) | | 120 | | 9005 | `delete-event` | `e` (id hex) | |
| 121 | | 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | | 121 | | 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | |
| 122 | | 9007 | `create-group` | | | ||
| 122 | 123 | ||
| 123 | - *group metadata* (`kind:39000`) (optional) | 124 | - *group metadata* (`kind:39000`) (optional) |
| 124 | 125 | ||
| @@ -6,10 +6,9 @@ Labeling | |||
| 6 | 6 | ||
| 7 | `draft` `optional` | 7 | `draft` `optional` |
| 8 | 8 | ||
| 9 | A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, | 9 | This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification. |
| 10 | including distributed moderation, collection management, license assignment, and content classification. | ||
| 11 | 10 | ||
| 12 | This NIP introduces two new tags: | 11 | New Tags: |
| 13 | 12 | ||
| 14 | - `L` denotes a label namespace | 13 | - `L` denotes a label namespace |
| 15 | - `l` denotes a label | 14 | - `l` denotes a label |
| @@ -20,7 +19,7 @@ Label Namespace Tag | |||
| 20 | An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace | 19 | An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace |
| 21 | (such as an ISO standard) or reverse domain name notation. | 20 | (such as an ISO standard) or reverse domain name notation. |
| 22 | 21 | ||
| 23 | `L` tags are REQUIRED in order to support searching by namespace rather than by a specific tag. The special `ugc` | 22 | `L` tags are RECOMMENDED in order to support searching by namespace rather than by a specific tag. The special `ugc` |
| 24 | ("user generated content") namespace MAY be used when the label content is provided by an end user. | 23 | ("user generated content") namespace MAY be used when the label content is provided by an end user. |
| 25 | 24 | ||
| 26 | `L` tags starting with `#` indicate that the label target should be associated with the label's value. | 25 | `L` tags starting with `#` indicate that the label target should be associated with the label's value. |
| @@ -29,7 +28,9 @@ This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, | |||
| 29 | Label Tag | 28 | Label Tag |
| 30 | ---- | 29 | ---- |
| 31 | 30 | ||
| 32 | An `l` tag's value can be any string. `l` tags MUST include a `mark` matching an `L` tag value in the same event. | 31 | An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a mark matching an `L` |
| 32 | tag value in the same event. If no `L` tag is included, a mark SHOULD still be included. If none is | ||
| 33 | included, `ugc` is implied. | ||
| 33 | 34 | ||
| 34 | Label Target | 35 | Label Target |
| 35 | ---- | 36 | ---- |
| @@ -42,7 +43,7 @@ or topics respectively. As with NIP-01, a relay hint SHOULD be included when usi | |||
| 42 | Content | 43 | Content |
| 43 | ------- | 44 | ------- |
| 44 | 45 | ||
| 45 | Labels should be short, meaningful strings. Longer discussions, such as for a review, or an | 46 | Labels should be short, meaningful strings. Longer discussions, such as for an |
| 46 | explanation of why something was labeled the way it was, should go in the event's `content` field. | 47 | explanation of why something was labeled the way it was, should go in the event's `content` field. |
| 47 | 48 | ||
| 48 | Self-Reporting | 49 | Self-Reporting |
| @@ -127,6 +128,20 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. | |||
| 127 | } | 128 | } |
| 128 | ``` | 129 | ``` |
| 129 | 130 | ||
| 131 | Author is labeling their note language as English using ISO-639-1. | ||
| 132 | |||
| 133 | ```json | ||
| 134 | { | ||
| 135 | "kind": 1, | ||
| 136 | "tags": [ | ||
| 137 | ["L", "ISO-639-1"], | ||
| 138 | ["l", "en", "ISO-639-1"] | ||
| 139 | ], | ||
| 140 | "content": "English text", | ||
| 141 | ... | ||
| 142 | } | ||
| 143 | ``` | ||
| 144 | |||
| 130 | Other Notes | 145 | Other Notes |
| 131 | ----------- | 146 | ----------- |
| 132 | 147 | ||
| @@ -158,4 +173,4 @@ Appendix: Known Ontologies | |||
| 158 | 173 | ||
| 159 | Below is a non-exhaustive list of ontologies currently in widespread use. | 174 | Below is a non-exhaustive list of ontologies currently in widespread use. |
| 160 | 175 | ||
| 161 | - (social.ontolo.categories)[https://ontolo.social/] | 176 | - [social.ontolo.categories](https://ontolo.social/) |
| @@ -53,7 +53,7 @@ The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` | |||
| 53 | ["p", "<repository-owner>"], | 53 | ["p", "<repository-owner>"], |
| 54 | ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention | 54 | ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention |
| 55 | 55 | ||
| 56 | ["t", "root"], // ommited for additional patches in a series | 56 | ["t", "root"], // omitted for additional patches in a series |
| 57 | // for the first patch in a revision | 57 | // for the first patch in a revision |
| 58 | ["t", "root-revision"], | 58 | ["t", "root-revision"], |
| 59 | 59 | ||
| @@ -12,9 +12,11 @@ Nostr protocol users may have other online identities such as usernames, profile | |||
| 12 | 12 | ||
| 13 | ## `i` tag on a metadata event | 13 | ## `i` tag on a metadata event |
| 14 | 14 | ||
| 15 | 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): | 15 | A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): |
| 16 | ```json | 16 | ```json |
| 17 | { | 17 | { |
| 18 | "id": <id>, | ||
| 19 | "pubkey": <pubkey>, | ||
| 18 | "tags": [ | 20 | "tags": [ |
| 19 | ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], | 21 | ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], |
| 20 | ["i", "twitter:semisol_public", "1619358434134196225"], | 22 | ["i", "twitter:semisol_public", "1619358434134196225"], |
| @@ -28,7 +28,7 @@ The remote signer would provide a connection token in the form: | |||
| 28 | bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> | 28 | bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> |
| 29 | ``` | 29 | ``` |
| 30 | 30 | ||
| 31 | This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s). | 31 | This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old optional secret. |
| 32 | 32 | ||
| 33 | ### Direct connection initiated by the client | 33 | ### Direct connection initiated by the client |
| 34 | 34 | ||
| @@ -101,7 +101,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata | |||
| 101 | } | 101 | } |
| 102 | ``` | 102 | ``` |
| 103 | 103 | ||
| 104 | The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure: | 104 | The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: |
| 105 | 105 | ||
| 106 | ```json | 106 | ```json |
| 107 | { | 107 | { |
| @@ -148,7 +148,7 @@ The `connect` method may be provided with `optional_requested_permissions` for u | |||
| 148 | } | 148 | } |
| 149 | ``` | 149 | ``` |
| 150 | 150 | ||
| 151 | The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure: | 151 | The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: |
| 152 | 152 | ||
| 153 | ```json | 153 | ```json |
| 154 | { | 154 | { |
| @@ -224,4 +224,4 @@ Coming soon... | |||
| 224 | 224 | ||
| 225 | ## References | 225 | ## References |
| 226 | 226 | ||
| 227 | - [NIP-04 - Encryption](https://github.com/nostr-protocol/nips/blob/master/04.md) | 227 | - [NIP-04 - Encryption](04.md) |
| @@ -38,7 +38,7 @@ a plaintext string with the supported commands, space-separated, eg. `pay_invoic | |||
| 38 | Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. | 38 | Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. |
| 39 | Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. | 39 | Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. |
| 40 | 40 | ||
| 41 | The content of requests and responses is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: | 41 | The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: |
| 42 | 42 | ||
| 43 | Request: | 43 | Request: |
| 44 | ```jsonc | 44 | ```jsonc |
| @@ -26,6 +26,8 @@ Relays SHOULD interpret the query to the best of their ability and return events | |||
| 26 | Relays SHOULD perform matching against `content` event field, and MAY perform | 26 | Relays SHOULD perform matching against `content` event field, and MAY perform |
| 27 | matching against other fields if that makes sense in the context of a specific kind. | 27 | matching against other fields if that makes sense in the context of a specific kind. |
| 28 | 28 | ||
| 29 | Results SHOULD be returned in descending order by quality of search result (as defined by the implementation), | ||
| 30 | not by the usual `.created_at`. The `limit` filter SHOULD be applied after sorting by matching score. | ||
| 29 | A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore | 31 | A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore |
| 30 | extensions they don't support. | 32 | extensions they don't support. |
| 31 | 33 | ||
| @@ -0,0 +1,538 @@ | |||
| 1 | # NIP-55 | ||
| 2 | |||
| 3 | ## Android Signer Application | ||
| 4 | |||
| 5 | `draft` `optional` | ||
| 6 | |||
| 7 | This NIP describes a method for 2-way communication between an Android signer and any Nostr client on Android. The Android signer is an Android Application and the client can be a web client or an Android application. | ||
| 8 | |||
| 9 | # Usage for Android applications | ||
| 10 | |||
| 11 | The Android signer uses Intents and Content Resolvers to communicate between applications. | ||
| 12 | |||
| 13 | To be able to use the Android signer in your application you should add this to your AndroidManifest.xml: | ||
| 14 | |||
| 15 | ```xml | ||
| 16 | <queries> | ||
| 17 | <intent> | ||
| 18 | <action android:name="android.intent.action.VIEW" /> | ||
| 19 | <category android:name="android.intent.category.BROWSABLE" /> | ||
| 20 | <data android:scheme="nostrsigner" /> | ||
| 21 | </intent> | ||
| 22 | </queries> | ||
| 23 | ``` | ||
| 24 | |||
| 25 | Then you can use this function to check if there's a signer application installed: | ||
| 26 | |||
| 27 | ```kotlin | ||
| 28 | fun isExternalSignerInstalled(context: Context): Boolean { | ||
| 29 | val intent = | ||
| 30 | Intent().apply { | ||
| 31 | action = Intent.ACTION_VIEW | ||
| 32 | data = Uri.parse("nostrsigner:") | ||
| 33 | } | ||
| 34 | val infos = context.packageManager.queryIntentActivities(intent, 0) | ||
| 35 | return infos.size > 0 | ||
| 36 | } | ||
| 37 | ``` | ||
| 38 | |||
| 39 | ## Using Intents | ||
| 40 | |||
| 41 | To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. | ||
| 42 | |||
| 43 | ```kotlin | ||
| 44 | val launcher = rememberLauncherForActivityResult( | ||
| 45 | contract = ActivityResultContracts.StartActivityForResult(), | ||
| 46 | onResult = { result -> | ||
| 47 | if (result.resultCode != Activity.RESULT_OK) { | ||
| 48 | Toast.makeText( | ||
| 49 | context, | ||
| 50 | "Sign request rejected", | ||
| 51 | Toast.LENGTH_SHORT | ||
| 52 | ).show() | ||
| 53 | } else { | ||
| 54 | val signature = activityResult.data?.getStringExtra("signature") | ||
| 55 | // Do something with signature ... | ||
| 56 | } | ||
| 57 | } | ||
| 58 | ) | ||
| 59 | ``` | ||
| 60 | |||
| 61 | Create the Intent using the **nostrsigner** scheme: | ||
| 62 | |||
| 63 | ```kotlin | ||
| 64 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content")) | ||
| 65 | ``` | ||
| 66 | |||
| 67 | Set the Signer package name: | ||
| 68 | |||
| 69 | ```kotlin | ||
| 70 | intent.`package` = "com.example.signer" | ||
| 71 | ``` | ||
| 72 | |||
| 73 | Send the Intent: | ||
| 74 | |||
| 75 | ```kotlin | ||
| 76 | launcher.launch(intent) | ||
| 77 | ``` | ||
| 78 | |||
| 79 | ### Methods | ||
| 80 | |||
| 81 | - **get_public_key** | ||
| 82 | - params: | ||
| 83 | |||
| 84 | ```kotlin | ||
| 85 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) | ||
| 86 | intent.`package` = "com.example.signer" | ||
| 87 | intent.putExtra("type", "get_public_key") | ||
| 88 | // You can send some default permissions for the user to authorize for ever | ||
| 89 | val permissions = listOf( | ||
| 90 | Permission( | ||
| 91 | type = "sign_event", | ||
| 92 | kind = 22242 | ||
| 93 | ), | ||
| 94 | Permission( | ||
| 95 | type = "nip44_decrypt" | ||
| 96 | ) | ||
| 97 | ) | ||
| 98 | intent.putExtra("permissions", permissions.toJson()) | ||
| 99 | context.startActivity(intent) | ||
| 100 | ``` | ||
| 101 | - result: | ||
| 102 | - If the user approved intent it will return the **npub** in the signature field | ||
| 103 | |||
| 104 | ```kotlin | ||
| 105 | val npub = intent.data?.getStringExtra("signature") | ||
| 106 | // The package name of the signer application | ||
| 107 | val packageName = intent.data?.getStringExtra("package") | ||
| 108 | ``` | ||
| 109 | |||
| 110 | - **sign_event** | ||
| 111 | - params: | ||
| 112 | |||
| 113 | ```kotlin | ||
| 114 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) | ||
| 115 | intent.`package` = "com.example.signer" | ||
| 116 | intent.putExtra("type", "sign_event") | ||
| 117 | // To handle results when not waiting between intents | ||
| 118 | intent.putExtra("id", event.id) | ||
| 119 | // Send the current logged in user npub | ||
| 120 | intent.putExtra("current_user", npub) | ||
| 121 | |||
| 122 | context.startActivity(intent) | ||
| 123 | ``` | ||
| 124 | - result: | ||
| 125 | - If the user approved intent it will return the **signature**, **id** and **event** fields | ||
| 126 | |||
| 127 | ```kotlin | ||
| 128 | val signature = intent.data?.getStringExtra("signature") | ||
| 129 | // The id you sent | ||
| 130 | val id = intent.data?.getStringExtra("id") | ||
| 131 | val signedEventJson = intent.data?.getStringExtra("event") | ||
| 132 | ``` | ||
| 133 | |||
| 134 | - **nip04_encrypt** | ||
| 135 | - params: | ||
| 136 | |||
| 137 | ```kotlin | ||
| 138 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) | ||
| 139 | intent.`package` = "com.example.signer" | ||
| 140 | intent.putExtra("type", "nip04_encrypt") | ||
| 141 | // to control the result in your application in case you are not waiting the result before sending another intent | ||
| 142 | intent.putExtra("id", "some_id") | ||
| 143 | // Send the current logged in user npub | ||
| 144 | intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) | ||
| 145 | // Send the hex pubKey that will be used for encrypting the data | ||
| 146 | intent.putExtra("pubKey", pubKey) | ||
| 147 | |||
| 148 | context.startActivity(intent) | ||
| 149 | ``` | ||
| 150 | - result: | ||
| 151 | - If the user approved intent it will return the **signature** and **id** fields | ||
| 152 | |||
| 153 | ```kotlin | ||
| 154 | val encryptedText = intent.data?.getStringExtra("signature") | ||
| 155 | // the id you sent | ||
| 156 | val id = intent.data?.getStringExtra("id") | ||
| 157 | ``` | ||
| 158 | |||
| 159 | - **nip44_encrypt** | ||
| 160 | - params: | ||
| 161 | |||
| 162 | ```kotlin | ||
| 163 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) | ||
| 164 | intent.`package` = "com.example.signer" | ||
| 165 | intent.putExtra("type", "nip44_encrypt") | ||
| 166 | // to control the result in your application in case you are not waiting the result before sending another intent | ||
| 167 | intent.putExtra("id", "some_id") | ||
| 168 | // Send the current logged in user npub | ||
| 169 | intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) | ||
| 170 | // Send the hex pubKey that will be used for encrypting the data | ||
| 171 | intent.putExtra("pubKey", pubKey) | ||
| 172 | |||
| 173 | context.startActivity(intent) | ||
| 174 | ``` | ||
| 175 | - result: | ||
| 176 | - If the user approved intent it will return the **signature** and **id** fields | ||
| 177 | |||
| 178 | ```kotlin | ||
| 179 | val encryptedText = intent.data?.getStringExtra("signature") | ||
| 180 | // the id you sent | ||
| 181 | val id = intent.data?.getStringExtra("id") | ||
| 182 | ``` | ||
| 183 | |||
| 184 | - **nip04_decrypt** | ||
| 185 | - params: | ||
| 186 | |||
| 187 | ```kotlin | ||
| 188 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) | ||
| 189 | intent.`package` = "com.example.signer" | ||
| 190 | intent.putExtra("type", "nip04_decrypt") | ||
| 191 | // to control the result in your application in case you are not waiting the result before sending another intent | ||
| 192 | intent.putExtra("id", "some_id") | ||
| 193 | // Send the current logged in user npub | ||
| 194 | intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) | ||
| 195 | // Send the hex pubKey that will be used for decrypting the data | ||
| 196 | intent.putExtra("pubKey", pubKey) | ||
| 197 | |||
| 198 | context.startActivity(intent) | ||
| 199 | ``` | ||
| 200 | - result: | ||
| 201 | - If the user approved intent it will return the **signature** and **id** fields | ||
| 202 | |||
| 203 | ```kotlin | ||
| 204 | val plainText = intent.data?.getStringExtra("signature") | ||
| 205 | // the id you sent | ||
| 206 | val id = intent.data?.getStringExtra("id") | ||
| 207 | ``` | ||
| 208 | |||
| 209 | - **nip44_decrypt** | ||
| 210 | - params: | ||
| 211 | |||
| 212 | ```kotlin | ||
| 213 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) | ||
| 214 | intent.`package` = "com.example.signer" | ||
| 215 | intent.putExtra("type", "nip04_decrypt") | ||
| 216 | // to control the result in your application in case you are not waiting the result before sending another intent | ||
| 217 | intent.putExtra("id", "some_id") | ||
| 218 | // Send the current logged in user npub | ||
| 219 | intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) | ||
| 220 | // Send the hex pubKey that will be used for decrypting the data | ||
| 221 | intent.putExtra("pubKey", pubKey) | ||
| 222 | |||
| 223 | context.startActivity(intent) | ||
| 224 | ``` | ||
| 225 | - result: | ||
| 226 | - If the user approved intent it will return the **signature** and **id** fields | ||
| 227 | |||
| 228 | ```kotlin | ||
| 229 | val plainText = intent.data?.getStringExtra("signature") | ||
| 230 | // the id you sent | ||
| 231 | val id = intent.data?.getStringExtra("id") | ||
| 232 | ``` | ||
| 233 | |||
| 234 | - **decrypt_zap_event** | ||
| 235 | - params: | ||
| 236 | |||
| 237 | ```kotlin | ||
| 238 | val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) | ||
| 239 | intent.`package` = "com.example.signer" | ||
| 240 | intent.putExtra("type", "decrypt_zap_event") | ||
| 241 | // to control the result in your application in case you are not waiting the result before sending another intent | ||
| 242 | intent.putExtra("id", "some_id") | ||
| 243 | // Send the current logged in user npub | ||
| 244 | intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) | ||
| 245 | context.startActivity(intent) | ||
| 246 | ``` | ||
| 247 | - result: | ||
| 248 | - If the user approved intent it will return the **signature** and **id** fields | ||
| 249 | |||
| 250 | ```kotlin | ||
| 251 | val eventJson = intent.data?.getStringExtra("signature") | ||
| 252 | // the id you sent | ||
| 253 | val id = intent.data?.getStringExtra("id") | ||
| 254 | ``` | ||
| 255 | |||
| 256 | ## Using Content Resolver | ||
| 257 | |||
| 258 | To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. | ||
| 259 | |||
| 260 | If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null | ||
| 261 | |||
| 262 | For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json | ||
| 263 | |||
| 264 | For the other types Signer Application returns the column "signature" | ||
| 265 | |||
| 266 | If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application | ||
| 267 | |||
| 268 | ### Methods | ||
| 269 | |||
| 270 | - **get_public_key** | ||
| 271 | - params: | ||
| 272 | |||
| 273 | ```kotlin | ||
| 274 | val result = context.contentResolver.query( | ||
| 275 | Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"), | ||
| 276 | listOf("login"), | ||
| 277 | null, | ||
| 278 | null, | ||
| 279 | null | ||
| 280 | ) | ||
| 281 | ``` | ||
| 282 | - result: | ||
| 283 | - Will return the **npub** in the signature column | ||
| 284 | |||
| 285 | ```kotlin | ||
| 286 | if (result == null) return | ||
| 287 | |||
| 288 | if (result.moveToFirst()) { | ||
| 289 | val index = it.getColumnIndex("signature") | ||
| 290 | if (index < 0) return | ||
| 291 | val npub = it.getString(index) | ||
| 292 | } | ||
| 293 | ``` | ||
| 294 | |||
| 295 | - **sign_event** | ||
| 296 | - params: | ||
| 297 | |||
| 298 | ```kotlin | ||
| 299 | val result = context.contentResolver.query( | ||
| 300 | Uri.parse("content://com.example.signer.SIGN_EVENT"), | ||
| 301 | listOf("$eventJson", "", "${logged_in_user_npub}"), | ||
| 302 | null, | ||
| 303 | null, | ||
| 304 | null | ||
| 305 | ) | ||
| 306 | ``` | ||
| 307 | - result: | ||
| 308 | - Will return the **signature** and the **event** columns | ||
| 309 | |||
| 310 | ```kotlin | ||
| 311 | if (result == null) return | ||
| 312 | |||
| 313 | if (result.moveToFirst()) { | ||
| 314 | val index = it.getColumnIndex("signature") | ||
| 315 | val indexJson = it.getColumnIndex("event") | ||
| 316 | val signature = it.getString(index) | ||
| 317 | val eventJson = it.getString(indexJson) | ||
| 318 | } | ||
| 319 | ``` | ||
| 320 | |||
| 321 | - **nip04_encrypt** | ||
| 322 | - params: | ||
| 323 | |||
| 324 | ```kotlin | ||
| 325 | val result = context.contentResolver.query( | ||
| 326 | Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), | ||
| 327 | listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), | ||
| 328 | null, | ||
| 329 | null, | ||
| 330 | null | ||
| 331 | ) | ||
| 332 | ``` | ||
| 333 | - result: | ||
| 334 | - Will return the **signature** column | ||
| 335 | |||
| 336 | ```kotlin | ||
| 337 | if (result == null) return | ||
| 338 | |||
| 339 | if (result.moveToFirst()) { | ||
| 340 | val index = it.getColumnIndex("signature") | ||
| 341 | val encryptedText = it.getString(index) | ||
| 342 | } | ||
| 343 | ``` | ||
| 344 | |||
| 345 | - **nip44_encrypt** | ||
| 346 | - params: | ||
| 347 | |||
| 348 | ```kotlin | ||
| 349 | val result = context.contentResolver.query( | ||
| 350 | Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), | ||
| 351 | listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), | ||
| 352 | null, | ||
| 353 | null, | ||
| 354 | null | ||
| 355 | ) | ||
| 356 | ``` | ||
| 357 | - result: | ||
| 358 | - Will return the **signature** column | ||
| 359 | |||
| 360 | ```kotlin | ||
| 361 | if (result == null) return | ||
| 362 | |||
| 363 | if (result.moveToFirst()) { | ||
| 364 | val index = it.getColumnIndex("signature") | ||
| 365 | val encryptedText = it.getString(index) | ||
| 366 | } | ||
| 367 | ``` | ||
| 368 | |||
| 369 | - **nip04_decrypt** | ||
| 370 | - params: | ||
| 371 | |||
| 372 | ```kotlin | ||
| 373 | val result = context.contentResolver.query( | ||
| 374 | Uri.parse("content://com.example.signer.NIP04_DECRYPT"), | ||
| 375 | listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), | ||
| 376 | null, | ||
| 377 | null, | ||
| 378 | null | ||
| 379 | ) | ||
| 380 | ``` | ||
| 381 | - result: | ||
| 382 | - Will return the **signature** column | ||
| 383 | |||
| 384 | ```kotlin | ||
| 385 | if (result == null) return | ||
| 386 | |||
| 387 | if (result.moveToFirst()) { | ||
| 388 | val index = it.getColumnIndex("signature") | ||
| 389 | val encryptedText = it.getString(index) | ||
| 390 | } | ||
| 391 | ``` | ||
| 392 | |||
| 393 | - **nip44_decrypt** | ||
| 394 | - params: | ||
| 395 | |||
| 396 | ```kotlin | ||
| 397 | val result = context.contentResolver.query( | ||
| 398 | Uri.parse("content://com.example.signer.NIP44_DECRYPT"), | ||
| 399 | listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), | ||
| 400 | null, | ||
| 401 | null, | ||
| 402 | null | ||
| 403 | ) | ||
| 404 | ``` | ||
| 405 | - result: | ||
| 406 | - Will return the **signature** column | ||
| 407 | |||
| 408 | ```kotlin | ||
| 409 | if (result == null) return | ||
| 410 | |||
| 411 | if (result.moveToFirst()) { | ||
| 412 | val index = it.getColumnIndex("signature") | ||
| 413 | val encryptedText = it.getString(index) | ||
| 414 | } | ||
| 415 | ``` | ||
| 416 | |||
| 417 | - **decrypt_zap_event** | ||
| 418 | - params: | ||
| 419 | |||
| 420 | ```kotlin | ||
| 421 | val result = context.contentResolver.query( | ||
| 422 | Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), | ||
| 423 | listOf("$eventJson", "", "${logged_in_user_npub}"), | ||
| 424 | null, | ||
| 425 | null, | ||
| 426 | null | ||
| 427 | ) | ||
| 428 | ``` | ||
| 429 | - result: | ||
| 430 | - Will return the **signature** column | ||
| 431 | |||
| 432 | ```kotlin | ||
| 433 | if (result == null) return | ||
| 434 | |||
| 435 | if (result.moveToFirst()) { | ||
| 436 | val index = it.getColumnIndex("signature") | ||
| 437 | val eventJson = it.getString(index) | ||
| 438 | } | ||
| 439 | ``` | ||
| 440 | |||
| 441 | # Usage for Web Applications | ||
| 442 | |||
| 443 | Since web applications can't receive a result from the intent, you should add a modal to paste the signature or the event json or create a callback url. | ||
| 444 | |||
| 445 | If you send the callback url parameter, Signer Application will send the result to the url. | ||
| 446 | |||
| 447 | If you don't send a callback url, Signer Application will copy the result to the clipboard. | ||
| 448 | |||
| 449 | You can configure the `returnType` to be **signature** or **event**. | ||
| 450 | |||
| 451 | Android intents and browser urls have limitations, so if you are using the `returnType` of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base64 gzip encoded event json | ||
| 452 | |||
| 453 | ## Methods | ||
| 454 | |||
| 455 | - **get_public_key** | ||
| 456 | - params: | ||
| 457 | |||
| 458 | ```js | ||
| 459 | window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_public_key&callbackUrl=https://example.com/?event=`; | ||
| 460 | ``` | ||
| 461 | |||
| 462 | - **sign_event** | ||
| 463 | - params: | ||
| 464 | |||
| 465 | ```js | ||
| 466 | window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; | ||
| 467 | ``` | ||
| 468 | |||
| 469 | - **nip04_encrypt** | ||
| 470 | - params: | ||
| 471 | |||
| 472 | ```js | ||
| 473 | window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; | ||
| 474 | ``` | ||
| 475 | |||
| 476 | - **nip44_encrypt** | ||
| 477 | - params: | ||
| 478 | |||
| 479 | ```js | ||
| 480 | window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; | ||
| 481 | ``` | ||
| 482 | |||
| 483 | - **nip04_decrypt** | ||
| 484 | - params: | ||
| 485 | |||
| 486 | ```js | ||
| 487 | window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; | ||
| 488 | ``` | ||
| 489 | |||
| 490 | - **nip44_decrypt** | ||
| 491 | - params: | ||
| 492 | |||
| 493 | ```js | ||
| 494 | window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; | ||
| 495 | ``` | ||
| 496 | |||
| 497 | - **decrypt_zap_event** | ||
| 498 | - params: | ||
| 499 | |||
| 500 | ```js | ||
| 501 | window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`; | ||
| 502 | ``` | ||
| 503 | |||
| 504 | ## Example | ||
| 505 | |||
| 506 | ```js | ||
| 507 | <!DOCTYPE html> | ||
| 508 | <html lang="en"> | ||
| 509 | <head> | ||
| 510 | <meta charset="UTF-8"> | ||
| 511 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| 512 | <title>Document</title> | ||
| 513 | </head> | ||
| 514 | <body> | ||
| 515 | <h1>Test</h1> | ||
| 516 | |||
| 517 | <script> | ||
| 518 | window.onload = function() { | ||
| 519 | var url = new URL(window.location.href); | ||
| 520 | var params = url.searchParams; | ||
| 521 | if (params) { | ||
| 522 | var param1 = params.get("event"); | ||
| 523 | if (param1) alert(param1) | ||
| 524 | } | ||
| 525 | let json = { | ||
| 526 | kind: 1, | ||
| 527 | content: "test" | ||
| 528 | } | ||
| 529 | let encodedJson = encodeURIComponent(JSON.stringify(json)) | ||
| 530 | var newAnchor = document.createElement("a"); | ||
| 531 | newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; | ||
| 532 | newAnchor.textContent = "Open External Signer"; | ||
| 533 | document.body.appendChild(newAnchor) | ||
| 534 | } | ||
| 535 | </script> | ||
| 536 | </body> | ||
| 537 | </html> | ||
| 538 | ``` | ||
| @@ -131,7 +131,7 @@ The following should be true of the `zap receipt` event: | |||
| 131 | - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. | 131 | - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. |
| 132 | - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). | 132 | - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). |
| 133 | - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. | 133 | - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. |
| 134 | - The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description. | 134 | - The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. |
| 135 | - `SHA256(description)` MUST match the description hash in the bolt11 invoice. | 135 | - `SHA256(description)` MUST match the description hash in the bolt11 invoice. |
| 136 | - The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. | 136 | - The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. |
| 137 | 137 | ||
| @@ -37,7 +37,7 @@ When seeking events **about** a user, where the user was tagged, Clients SHOULD | |||
| 37 | When broadcasting an event, Clients SHOULD: | 37 | When broadcasting an event, Clients SHOULD: |
| 38 | 38 | ||
| 39 | - Broadcast the event to the WRITE relays of the author | 39 | - Broadcast the event to the WRITE relays of the author |
| 40 | - Broadcast the event all READ relays of each tagged user | 40 | - Broadcast the event to all READ relays of each tagged user |
| 41 | 41 | ||
| 42 | ## Motivation | 42 | ## Motivation |
| 43 | 43 | ||
| @@ -0,0 +1,45 @@ | |||
| 1 | NIP-70 | ||
| 2 | ====== | ||
| 3 | |||
| 4 | Protected Events | ||
| 5 | ---------------- | ||
| 6 | |||
| 7 | `draft` `optional` | ||
| 8 | |||
| 9 | When the `"-"` tag is present, that means the event is "protected". | ||
| 10 | |||
| 11 | A protected event is an event that can only be published to relays by its author. This is achieved by relays ensuring that the author is [authenticated](42.md) before publishing their own events or by just rejecting events with `["-"]` outright. | ||
| 12 | |||
| 13 | The default behavior of a relay MUST be to reject any event that contains `["-"]`. | ||
| 14 | |||
| 15 | Relays that want to accept such events MUST first require that the client perform the [NIP-42](42.md) `AUTH` flow and then check if the authenticated client has the same pubkey as the event being published and only accept the event in that case. | ||
| 16 | |||
| 17 | ## The tag | ||
| 18 | |||
| 19 | The tag is a simple tag with a single item: `["-"]`. It may be added to any event. | ||
| 20 | |||
| 21 | ## Example flow | ||
| 22 | |||
| 23 | - User `79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798` connects to relay `wss://example.com`: | ||
| 24 | |||
| 25 | ```jsonc | ||
| 26 | /* client: */ | ||
| 27 | ["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] | ||
| 28 | /* relay: */ | ||
| 29 | ["AUTH", "<challenge>"] | ||
| 30 | ["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", false, "auth-required: this event may only be published by its author"] | ||
| 31 | /* client: */ | ||
| 32 | ["AUTH", {}] | ||
| 33 | ["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] | ||
| 34 | ["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", true, ""] | ||
| 35 | ``` | ||
| 36 | |||
| 37 | ## Why | ||
| 38 | |||
| 39 | There are multiple circumstances in which it would be beneficial to prevent the unlimited spreading of an event through all relays imaginable and restrict some to only a certain demographic or to a semi-closed community relay. Even when the information is public it may make sense to keep it compartimentalized across different relays. | ||
| 40 | |||
| 41 | It's also possible to create closed access feeds with this when the publisher has some relationship with the relay and trusts the relay to not release their published events to anyone. | ||
| 42 | |||
| 43 | Even though it's ultimately impossible to restrict the spread of information on the internet (for example, one of the members of the closed group may want to take an event intended to be restricted and republish it to other relays), most relays would be happy to not facilitate the acts of these so-called "pirates", in respect to the original decision of the author and therefore gladly reject these republish acts if given the means to. | ||
| 44 | |||
| 45 | This NIP gives these authors and relays the means to clearly signal when a given event is not intended to be republished by third parties. | ||
| @@ -116,7 +116,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e | |||
| 116 | User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`: | 116 | User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`: |
| 117 | 117 | ||
| 118 | ```json | 118 | ```json |
| 119 | ["REQ", <id>, '[{ "kinds": [31989], "#d": ["31337"], 'authors': [<user>, <users-contact-list>] }]'] | 119 | ["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] |
| 120 | ``` | 120 | ``` |
| 121 | 121 | ||
| 122 | User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. | 122 | User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. |
| @@ -127,5 +127,5 @@ User B's client sees the application's `kind:31990` which includes the informati | |||
| 127 | Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. | 127 | Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. |
| 128 | 128 | ||
| 129 | ```json | 129 | ```json |
| 130 | ["REQ", <id>, '[{ "kinds": [31990], "#k": [<desired-event-kind>], 'authors': [...] }]'] | 130 | ["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] |
| 131 | ``` | 131 | ``` |
| @@ -1,8 +1,6 @@ | |||
| 1 | NIP-96 | 1 | # NIP-96 |
| 2 | ====== | ||
| 3 | 2 | ||
| 4 | HTTP File Storage Integration | 3 | ## HTTP File Storage Integration |
| 5 | ----------------------------- | ||
| 6 | 4 | ||
| 7 | `draft` `optional` | 5 | `draft` `optional` |
| 8 | 6 | ||
| @@ -84,46 +82,46 @@ it must use the "api_url" field instead. | |||
| 84 | 82 | ||
| 85 | See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. | 83 | See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. |
| 86 | 84 | ||
| 85 | ## Auth | ||
| 86 | |||
| 87 | When indicated, `clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). | ||
| 88 | |||
| 87 | ## Upload | 89 | ## Upload |
| 88 | 90 | ||
| 89 | A file can be uploaded one at a time to `https://your-file-server.example/custom-api-path` (route from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) as `multipart/form-data` content type using `POST` method with the file object set to the `file` form data field. | 91 | `POST $api_url` as `multipart/form-data`. |
| 90 | 92 | ||
| 91 | `Clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). | 93 | **AUTH required** |
| 92 | If using an html form, use an `Authorization` form data field instead. | ||
| 93 | 94 | ||
| 94 | These following **optional** form data fields MAY be used by `servers` and SHOULD be sent by `clients`: | 95 | List of form fields: |
| 95 | - `expiration`: string of the UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this; | ||
| 96 | - `size`: string of the file byte size. This is just a value the server can use to reject early if the file size exceeds the server limits; | ||
| 97 | - `alt`: (recommended) strict description text for visibility-impaired users; | ||
| 98 | - `caption`: loose description; | ||
| 99 | - `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment; | ||
| 100 | - `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. | ||
| 101 | 96 | ||
| 97 | - `file`: **REQUIRED** the file to upload | ||
| 98 | - `caption`: **RECOMMENDED** loose description; | ||
| 99 | - `expiration`: UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this. | ||
| 100 | - `size`: File byte size. This is just a value the server can use to reject early if the file size exceeds the server limits. | ||
| 101 | - `alt`: **RECOMMENDED** strict description text for visibility-impaired users. | ||
| 102 | - `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment. | ||
| 103 | - `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. | ||
| 104 | - `no_transform`: "true" asks server not to transform the file and serve the uploaded file as is, may be rejected. | ||
| 102 | 105 | ||
| 103 | Others custom form data fields may be used depending on specific `server` support. | 106 | Others custom form data fields may be used depending on specific `server` support. |
| 104 | The `server` isn't required to store any metadata sent by `clients`. | 107 | The `server` isn't required to store any metadata sent by `clients`. |
| 105 | 108 | ||
| 106 | Note for `clients`: if using an HTML form, it is important for the `file` form field to be the **last** one, or be re-ordered right before sending or be appended as the last field of XHR2's FormData object. | ||
| 107 | |||
| 108 | The `filename` embedded in the file may not be honored by the `server`, which could internally store just the SHA-256 hash value as the file name, ignoring extra metadata. | 109 | The `filename` embedded in the file may not be honored by the `server`, which could internally store just the SHA-256 hash value as the file name, ignoring extra metadata. |
| 109 | The hash is enough to uniquely identify a file, that's why it will be used on the "download" and "delete" routes. | 110 | The hash is enough to uniquely identify a file, that's why it will be used on the `download` and `delete` routes. |
| 110 | |||
| 111 | The `server` MUST link the user's `pubkey` string (which is embedded in the decoded header value) as the owner of the file so to later allow them to delete the file. | ||
| 112 | Note that if a file with the same hash of a previously received file (so the same file) is uploaded by another user, the server doesn't need to store the new file. | ||
| 113 | It should just add the new user's `pubkey` to the list of the owners of the already stored file with said hash (if it wants to save space by keeping just one copy of the same file, because multiple uploads of the same file results in the same file hash). | ||
| 114 | |||
| 115 | The `server` MAY also store the `Authorization` header/field value (decoded or not) for accountability purpose as this proves that the user with the unique pubkey did ask for the upload of the file with a specific hash. However, storing the pubkey is sufficient to establish ownership. | ||
| 116 | 111 | ||
| 117 | The `server` MUST reject with 413 Payload Too Large if file size exceeds limits. | 112 | The `server` MUST link the user's `pubkey` string as the owner of the file so to later allow them to delete the file. |
| 118 | 113 | ||
| 119 | The `server` MUST reject with 400 Bad Request status if some fields are invalid. | 114 | `no_transform` can be used to replicate a file to multiple servers for redundancy, clients can use the [server list](#selecting-a-server) to find alternative servers which might contain the same file. When uploading a file and requesting `no_transform` clients should check that the hash matches in the response in order to detect if the file was modified. |
| 120 | 115 | ||
| 121 | The `server` MUST reply to the upload with 200 OK status if the `payload` tag value contains an already used SHA-256 hash (if file is already owned by the same pubkey) or reject the upload with 403 Forbidden status if it isn't the same of the received file. | 116 | ### Response codes |
| 122 | 117 | ||
| 123 | The `server` MAY reject the upload with 402 Payment Required status if the user has a pending payment (Payment flow is not strictly required. Server owners decide if the storage is free or not. Monetization schemes may be added later to correlated NIPs.). | 118 | - `200 OK`: File upload exists, but is successful (Existing hash) |
| 124 | 119 | - `201 Created`: File upload successful (New hash) | |
| 125 | On successful uploads the `server` MUST reply with **201 Created** HTTP status code or **202 Accepted** if a `processing_url` field is added | 120 | - `202 Accepted`: File upload is awaiting processing, see [Delayed Processing](#delayed-processing) section |
| 126 | to the response so that the `client` can follow the processing status (see [Delayed Processing](#delayed-processing) section). | 121 | - `413 Payload Too Large`: File size exceeds limit |
| 122 | - `400 Bad Request`: Form data is invalid or not supported. | ||
| 123 | - `403 Forbidden`: User is not allowed to upload or the uploaded file hash didnt match the hash included in the `Authorization` header `payload` tag. | ||
| 124 | - `402 Payment Required`: Payment is required by the server, **this flow is undefined**. | ||
| 127 | 125 | ||
| 128 | The upload response is a json object as follows: | 126 | The upload response is a json object as follows: |
| 129 | 127 | ||
| @@ -179,11 +177,13 @@ The upload response is a json object as follows: | |||
| 179 | 177 | ||
| 180 | Note that if the server didn't apply any transformation to the received file, both `nip94_event.tags.*.ox` and `nip94_event.tags.*.x` fields will have the same value. The server MUST link the saved file to the SHA-256 hash of the **original** file before any server transformations (the `nip94_event.tags.*.ox` tag value). The **original** file's SHA-256 hash will be used to identify the saved file when downloading or deleting it. | 178 | Note that if the server didn't apply any transformation to the received file, both `nip94_event.tags.*.ox` and `nip94_event.tags.*.x` fields will have the same value. The server MUST link the saved file to the SHA-256 hash of the **original** file before any server transformations (the `nip94_event.tags.*.ox` tag value). The **original** file's SHA-256 hash will be used to identify the saved file when downloading or deleting it. |
| 181 | 179 | ||
| 182 | `Clients` may upload the same file to one or many `servers`. | 180 | `clients` may upload the same file to one or many `servers`. |
| 183 | After successful upload, the `client` may optionally generate and send to any set of nostr `relays` a [NIP-94](94.md) event by including the missing fields. | 181 | After successful upload, the `client` may optionally generate and send to any set of nostr `relays` a [NIP-94](94.md) event by including the missing fields. |
| 184 | 182 | ||
| 185 | Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url. | 183 | Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url. |
| 186 | 184 | ||
| 185 | `clients` may also use the tags from the `nip94_event` to construct an `imeta` tag | ||
| 186 | |||
| 187 | ### Delayed Processing | 187 | ### Delayed Processing |
| 188 | 188 | ||
| 189 | Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing. | 189 | Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing. |
| @@ -219,7 +219,7 @@ However, for all file actions, such as download and deletion, the **original** f | |||
| 219 | 219 | ||
| 220 | ## Download | 220 | ## Download |
| 221 | 221 | ||
| 222 | `Servers` must make available the route `https://your-file-server.example/custom-api-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" or "download_url" field) with `GET` method for file download. | 222 | `GET $api_url/<sha256-hash>(.ext)` |
| 223 | 223 | ||
| 224 | The primary file download url informed at the upload's response field `nip94_event.tags.*.url` | 224 | The primary file download url informed at the upload's response field `nip94_event.tags.*.url` |
| 225 | can be that or not (it can be any non-standard url the server wants). | 225 | can be that or not (it can be any non-standard url the server wants). |
| @@ -227,17 +227,17 @@ If not, the server still MUST also respond to downloads at the standard url | |||
| 227 | mentioned on the previous paragraph, to make it possible for a client | 227 | mentioned on the previous paragraph, to make it possible for a client |
| 228 | to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash. | 228 | to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash. |
| 229 | 229 | ||
| 230 | Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. | 230 | Note that the "\<sha256-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. |
| 231 | 231 | ||
| 232 | Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path. | 232 | Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path. |
| 233 | When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension). | 233 | When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension). |
| 234 | The file extension may be absent because the hash is the only needed string to uniquely identify a file. | 234 | The file extension may be absent because the hash is the only needed string to uniquely identify a file. |
| 235 | 235 | ||
| 236 | Example: `https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` | 236 | Example: `$api_url/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` |
| 237 | 237 | ||
| 238 | ### Media Transformations | 238 | ### Media Transformations |
| 239 | 239 | ||
| 240 | `Servers` may respond to some media transformation query parameters and ignore those they don't support by serving | 240 | `servers` may respond to some media transformation query parameters and ignore those they don't support by serving |
| 241 | the original media file without transformations. | 241 | the original media file without transformations. |
| 242 | 242 | ||
| 243 | #### Image Transformations | 243 | #### Image Transformations |
| @@ -245,23 +245,23 @@ the original media file without transformations. | |||
| 245 | ##### Resizing | 245 | ##### Resizing |
| 246 | 246 | ||
| 247 | Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio. | 247 | Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio. |
| 248 | `Clients` may use the `w` query parameter to request an image version with the desired pixel width. | 248 | `clients` may use the `w` query parameter to request an image version with the desired pixel width. |
| 249 | `Servers` can then serve the variant with the closest width to the parameter value | 249 | `servers` can then serve the variant with the closest width to the parameter value |
| 250 | or an image variant generated on the fly. | 250 | or an image variant generated on the fly. |
| 251 | 251 | ||
| 252 | Example: `https://your-file-server.example/custom-api-path/<sha256-file-hash>.png?w=32` | 252 | Example: `$api_url/<sha256-hash>.png?w=32` |
| 253 | 253 | ||
| 254 | ## Deletion | 254 | ## Deletion |
| 255 | 255 | ||
| 256 | `Servers` must make available the route `https://deletion.domain/deletion-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) with `DELETE` method for file deletion. | 256 | `DELETE $api_url/<sha256-hash>(.ext)` |
| 257 | 257 | ||
| 258 | Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. | 258 | **AUTH required** |
| 259 | 259 | ||
| 260 | The extension is optional as the file hash is the only needed file identification. | 260 | Note that the `/<sha256-hash>` part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. |
| 261 | 261 | ||
| 262 | `Clients` should send a `DELETE` request to the server deletion route in the above format. It must include a NIP-98 `Authorization` header. | 262 | The extension is optional as the file hash is the only needed file identification. |
| 263 | 263 | ||
| 264 | The `server` should reject deletes from users other than the original uploader. The `pubkey` encoded on the header value identifies the user. | 264 | The `server` should reject deletes from users other than the original uploader with the appropriate http response code (403 Forbidden). |
| 265 | 265 | ||
| 266 | It should be noted that more than one user may have uploaded the same file (with the same hash). In this case, a delete must not really delete the file but just remove the user's `pubkey` from the file owners list (considering the server keeps just one copy of the same file, because multiple uploads of the same file results | 266 | It should be noted that more than one user may have uploaded the same file (with the same hash). In this case, a delete must not really delete the file but just remove the user's `pubkey` from the file owners list (considering the server keeps just one copy of the same file, because multiple uploads of the same file results |
| 267 | in the same file hash). | 267 | in the same file hash). |
| @@ -275,6 +275,46 @@ The successful response is a 200 OK one with just basic JSON fields: | |||
| 275 | } | 275 | } |
| 276 | ``` | 276 | ``` |
| 277 | 277 | ||
| 278 | ## Listing files | ||
| 279 | |||
| 280 | `GET $api_url?page=x&count=y` | ||
| 281 | |||
| 282 | **AUTH required** | ||
| 283 | |||
| 284 | Returns a list of files linked to the authenticated users pubkey. | ||
| 285 | |||
| 286 | Example Response: | ||
| 287 | |||
| 288 | ```js | ||
| 289 | { | ||
| 290 | "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) | ||
| 291 | "total": 1, // total number of files | ||
| 292 | "page": 0, // the current page number | ||
| 293 | "files": [ | ||
| 294 | { | ||
| 295 | "tags": [ | ||
| 296 | ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], | ||
| 297 | ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], | ||
| 298 | ["size", "123456"], | ||
| 299 | ["alt", "a meme that makes you laugh"], | ||
| 300 | ["expiration", "1715691139"], | ||
| 301 | // ...other metadata | ||
| 302 | ] | ||
| 303 | "content": "haha funny meme", // caption | ||
| 304 | "created_at": 1715691130 // upload timestamp | ||
| 305 | }, | ||
| 306 | ... | ||
| 307 | ] | ||
| 308 | } | ||
| 309 | ``` | ||
| 310 | |||
| 311 | `files` contains an array of NIP-94 events | ||
| 312 | |||
| 313 | ### Query args | ||
| 314 | |||
| 315 | - `page` page number (`offset=page*count`) | ||
| 316 | - `count` number of items per page | ||
| 317 | |||
| 278 | ## Selecting a Server | 318 | ## Selecting a Server |
| 279 | 319 | ||
| 280 | Note: HTTP File Storage Server developers may skip this section. This is meant for client developers. | 320 | Note: HTTP File Storage Server developers may skip this section. This is meant for client developers. |
| @@ -55,7 +55,8 @@ Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` e | |||
| 55 | 55 | ||
| 56 | Example HTTP Authorization header: | 56 | Example HTTP Authorization header: |
| 57 | ``` | 57 | ``` |
| 58 | Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1cmwiLCJodHRwczovL2FwaS5zbm9ydC5zb2NpYWwvYXBpL3YxL241c3AvbGlzdCJdLFsibWV0aG9kIiwiR0VUIl1dLCJzaWciOiI1ZWQ5ZDhlYzk1OGJjODU0Zjk5N2JkYzI0YWMzMzdkMDA1YWYzNzIzMjQ3NDdlZmU0YTAwZTI0ZjRjMzA0MzdmZjRkZDgzMDg2ODRiZWQ0NjdkOWQ2YmUzZTVhNTE3YmI0M2IxNzMyY2M3ZDMzOTQ5YTNhYWY4NjcwNWMyMjE4NCJ9 | 58 | Authorization: Nostr |
| 59 | eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1IiwiaHR0cHM6Ly9hcGkuc25vcnQuc29jaWFsL2FwaS92MS9uNXNwL2xpc3QiXSxbIm1ldGhvZCIsIkdFVCJdXSwic2lnIjoiNWVkOWQ4ZWM5NThiYzg1NGY5OTdiZGMyNGFjMzM3ZDAwNWFmMzcyMzI0NzQ3ZWZlNGEwMGUyNGY0YzMwNDM3ZmY0ZGQ4MzA4Njg0YmVkNDY3ZDlkNmJlM2U1YTUxN2JiNDNiMTczMmNjN2QzMzk0OWEzYWFmODY3MDVjMjIxODQifQ | ||
| 59 | ``` | 60 | ``` |
| 60 | 61 | ||
| 61 | ## Reference Implementations | 62 | ## Reference Implementations |
| @@ -8,9 +8,9 @@ Classified Listings | |||
| 8 | 8 | ||
| 9 | This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful. | 9 | This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful. |
| 10 | 10 | ||
| 11 | The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) that often sell many units of specific products through very specific channels. | 11 | The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](15.md) that often sell many units of specific products through very specific channels. |
| 12 | 12 | ||
| 13 | The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events. | 13 | The structure of these events is very similar to [NIP-23](23.md) long-form content events. |
| 14 | 14 | ||
| 15 | ### Draft / Inactive Listings | 15 | ### Draft / Inactive Listings |
| 16 | 16 | ||
| @@ -26,8 +26,8 @@ The `.pubkey` field of these events are treated as the party creating the listin | |||
| 26 | 26 | ||
| 27 | ### Metadata | 27 | ### Metadata |
| 28 | 28 | ||
| 29 | - For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md). | 29 | - For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](12.md). |
| 30 | - For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](https://github.com/nostr-protocol/nips/blob/master/58.md). This allows clients to display images in carousel format more easily. | 30 | - For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily. |
| 31 | 31 | ||
| 32 | The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. | 32 | The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. |
| 33 | 33 | ||
diff --git a/BREAKING.md b/BREAKING.md index 7b48ee0..dab94ed 100644 --- a/BREAKING.md +++ b/BREAKING.md | |||
| @@ -5,6 +5,12 @@ reverse chronological order. | |||
| 5 | 5 | ||
| 6 | | Date | Commit | NIP | Change | | 6 | | Date | Commit | NIP | Change | |
| 7 | | ----------- | --------- | -------- | ------ | | 7 | | ----------- | --------- | -------- | ------ | |
| 8 | | 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated | | ||
| 9 | | 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [NIP-01](01.md) | events should be sorted by id after created_at | | ||
| 10 | | 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [NIP-25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | | ||
| 11 | | 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | | ||
| 12 | | 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | | ||
| 13 | | 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [NIP-25](25.md) | e-tags were changed to not include entire thread | | ||
| 8 | | 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [NIP-34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) | | 14 | | 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [NIP-34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) | |
| 9 | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | | 15 | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | |
| 10 | | 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | | 16 | | 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | |
| @@ -19,8 +25,9 @@ reverse chronological order. | |||
| 19 | | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed | | 25 | | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed | |
| 20 | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [NIP-01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | | 26 | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [NIP-01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | |
| 21 | | 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed | | 27 | | 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed | |
| 22 | | 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | | 28 | | 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | |
| 23 | | 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed | | 29 | | 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed | |
| 30 | | 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [NIP-32](32.md) | 'l' tag annotations was removed | | ||
| 24 | | 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items | | 31 | | 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items | |
| 25 | | 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed | | 32 | | 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed | |
| 26 | | 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` | | 33 | | 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` | |
| @@ -33,10 +40,10 @@ reverse chronological order. | |||
| 33 | | 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 40 | | 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | |
| 34 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" | | 41 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" | |
| 35 | | 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed | | 42 | | 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed | |
| 36 | | 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | | 43 | | 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | |
| 37 | | 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported | | 44 | | 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported | |
| 38 | | 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | | 45 | | 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | |
| 39 | | 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | | 46 | | 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | |
| 40 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | | 47 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | |
| 41 | | 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | | 48 | | 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | |
| 42 | 49 | ||
| @@ -46,3 +53,4 @@ Breaking changes prior to 2023-03-01 are not yet documented. | |||
| 46 | 53 | ||
| 47 | - If it isn't clear that a change is breaking or not, we list it. | 54 | - If it isn't clear that a change is breaking or not, we list it. |
| 48 | - The date is the date it was merged, not necessarily the date of the commit. | 55 | - The date is the date it was merged, not necessarily the date of the commit. |
| 56 | |||
| @@ -68,11 +68,13 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 68 | - [NIP-52: Calendar Events](52.md) | 68 | - [NIP-52: Calendar Events](52.md) |
| 69 | - [NIP-53: Live Activities](53.md) | 69 | - [NIP-53: Live Activities](53.md) |
| 70 | - [NIP-54: Wiki](54.md) | 70 | - [NIP-54: Wiki](54.md) |
| 71 | - [NIP-55: Android Signer Application](55.md) | ||
| 71 | - [NIP-56: Reporting](56.md) | 72 | - [NIP-56: Reporting](56.md) |
| 72 | - [NIP-57: Lightning Zaps](57.md) | 73 | - [NIP-57: Lightning Zaps](57.md) |
| 73 | - [NIP-58: Badges](58.md) | 74 | - [NIP-58: Badges](58.md) |
| 74 | - [NIP-59: Gift Wrap](59.md) | 75 | - [NIP-59: Gift Wrap](59.md) |
| 75 | - [NIP-65: Relay List Metadata](65.md) | 76 | - [NIP-65: Relay List Metadata](65.md) |
| 77 | - [NIP-70: Protected Events](70.md) | ||
| 76 | - [NIP-71: Video Events](71.md) | 78 | - [NIP-71: Video Events](71.md) |
| 77 | - [NIP-72: Moderated Communities](72.md) | 79 | - [NIP-72: Moderated Communities](72.md) |
| 78 | - [NIP-75: Zap Goals](75.md) | 80 | - [NIP-75: Zap Goals](75.md) |
| @@ -89,7 +91,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 89 | ## Event Kinds | 91 | ## Event Kinds |
| 90 | | kind | description | NIP | | 92 | | kind | description | NIP | |
| 91 | | ------------- | -------------------------- | ------------------------ | | 93 | | ------------- | -------------------------- | ------------------------ | |
| 92 | | `0` | Metadata | [01](01.md) | | 94 | | `0` | User Metadata | [01](01.md) | |
| 93 | | `1` | Short Text Note | [01](01.md) | | 95 | | `1` | Short Text Note | [01](01.md) | |
| 94 | | `2` | Recommend Relay | 01 (deprecated) | | 96 | | `2` | Recommend Relay | 01 (deprecated) | |
| 95 | | `3` | Follows | [02](02.md) | | 97 | | `3` | Follows | [02](02.md) | |
| @@ -223,8 +225,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 223 | | `AUTH` | used to send authentication challenges | [42](42.md) | | 225 | | `AUTH` | used to send authentication challenges | [42](42.md) | |
| 224 | | `COUNT` | used to send requested event counts to clients | [45](45.md) | | 226 | | `COUNT` | used to send requested event counts to clients | [45](45.md) | |
| 225 | 227 | ||
| 226 | Please update these lists when proposing NIPs introducing new event kinds. | ||
| 227 | |||
| 228 | ## Standardized Tags | 228 | ## Standardized Tags |
| 229 | 229 | ||
| 230 | | name | value | other parameters | NIP | | 230 | | name | value | other parameters | NIP | |
| @@ -233,14 +233,16 @@ Please update these lists when proposing NIPs introducing new event kinds. | |||
| 233 | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | 233 | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | |
| 234 | | `a` | coordinates to an event | relay URL | [01](01.md) | | 234 | | `a` | coordinates to an event | relay URL | [01](01.md) | |
| 235 | | `d` | identifier | -- | [01](01.md) | | 235 | | `d` | identifier | -- | [01](01.md) | |
| 236 | | `-` | -- | -- | [70](70.md) | | ||
| 236 | | `g` | geohash | -- | [52](52.md) | | 237 | | `g` | geohash | -- | [52](52.md) | |
| 238 | | `h` | group id | -- | [29](29.md) | | ||
| 237 | | `i` | identity | proof | [39](39.md) | | 239 | | `i` | identity | proof | [39](39.md) | |
| 238 | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | | 240 | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | |
| 239 | | `l` | label, label namespace | annotations | [32](32.md) | | 241 | | `l` | label, label namespace | -- | [32](32.md) | |
| 240 | | `L` | label namespace | -- | [32](32.md) | | 242 | | `L` | label namespace | -- | [32](32.md) | |
| 241 | | `m` | MIME type | -- | [94](94.md) | | 243 | | `m` | MIME type | -- | [94](94.md) | |
| 242 | | `q` | event id (hex) | relay URL | [18](18.md) | | 244 | | `q` | event id (hex) | relay URL | [18](18.md) | |
| 243 | | `r` | a reference (URL, etc) | petname | | | 245 | | `r` | a reference (URL, etc) | petname | [24](24.md) | |
| 244 | | `r` | relay url | marker | [65](65.md) | | 246 | | `r` | relay url | marker | [65](65.md) | |
| 245 | | `t` | hashtag | -- | | | 247 | | `t` | hashtag | -- | | |
| 246 | | `alt` | summary | -- | [31](31.md) | | 248 | | `alt` | summary | -- | [31](31.md) | |
| @@ -276,6 +278,8 @@ Please update these lists when proposing NIPs introducing new event kinds. | |||
| 276 | | `web` | webpage URL | -- | [34](34.md) | | 278 | | `web` | webpage URL | -- | [34](34.md) | |
| 277 | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | | 279 | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | |
| 278 | 280 | ||
| 281 | Please update these lists when proposing new NIPs. | ||
| 282 | |||
| 279 | ## Criteria for acceptance of NIPs | 283 | ## Criteria for acceptance of NIPs |
| 280 | 284 | ||
| 281 | 1. They should be fully implemented in at least two clients and one relay -- when applicable. | 285 | 1. They should be fully implemented in at least two clients and one relay -- when applicable. |