From fffe868a405c9283e0a7a6947326e8c00c12aee7 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Mon, 13 Mar 2023 04:43:17 +0300 Subject: [PATCH 01/89] NIP-39: minor readability changes adds newlines in some places to make it more readable --- 39.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/39.md b/39.md index cc3f796..b84603c 100644 --- a/39.md +++ b/39.md @@ -39,24 +39,28 @@ Identity names SHOULD be normalized if possible by replacing uppercase letters w ### `github` -Identity: A GitHub username. +Identity: A GitHub username. + Proof: A GitHub Gist ID. This Gist should be created by `` with a single file that has the text `Verifying that I control the following Nostr public key: `. This can be located at `https://gist.github.com//`. ### `twitter` -Identity: A Twitter username. +Identity: A Twitter username. + Proof: A Tweet ID. The tweet should be posted by `` and have the text `Verifying my account on nostr My Public Key: ""`. This can be located at `https://twitter.com//status/`. ### `mastodon` Identity: A Mastodon instance and username in the format `/@`. -Proof: A Mastodon post ID. This post should be published by `@` and have the text `Verifying that I control the following Nostr public key: ""`. + +Proof: A Mastodon post ID. This post should be published by `@` and have the text `Verifying that I control the following Nostr public key: ""`. This can be located at `https:///`. ### `telegram` Identity: A Telegram user ID. + Proof: A string in the format `/` which points to a message published in the public channel or group with name `` and message ID ``. This message should be sent by user ID `` and have the text `Verifying that I control the following Nostr public key: ""`. -This can be located at `https://t.me/`. \ No newline at end of file +This can be located at `https://t.me/`. From 8b70e83b377d835b5ae570c14b697da2881d40d9 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Mon, 13 Mar 2023 11:53:06 +0900 Subject: [PATCH 02/89] NIP-51: remove self-referential link --- 51.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/51.md b/51.md index 0bbb91f..b4143ad 100644 --- a/51.md +++ b/51.md @@ -97,16 +97,16 @@ Then the user would create a 'Categorized People' list event like below: ### Mute List -An event with kind `10000` is defined as a replaceable list event (see [NIP-51 - Lists](51.md) for listing content a user wants to mute. Any standarized tag can be included in a Mute List. +An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standarized tag can be included in a Mute List. ### Pin List -An event with kind `10001` is defined as a replaceable list event (see [NIP-51 - Lists](51.md) for listing content a user wants to pin. Any standarized tag can be included in a Pin List. +An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standarized tag can be included in a Pin List. ### Categorized People List -An event with kind `30000` is defined as a parameterized replaceable list event (see [NIP-51 - Lists](51.md)) for categorizing people. The 'd' parameter for this event holds the category name of the list. The tags included in these lists MUST follow the format of kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). +An event with kind `30000` is defined as a parameterized replaceable list event for categorizing people. The 'd' parameter for this event holds the category name of the list. The tags included in these lists MUST follow the format of kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). ### Categorized Bookmarks List -An event with kind `30001` is defined as a parameterized replaceable list event (see [NIP-51 - Lists](51.md)) for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standarized tag can be included in a Categorized Bookmarks List. +An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standarized tag can be included in a Categorized Bookmarks List. From b2c21ab10c06be0976a08920c07f5421d17c0654 Mon Sep 17 00:00:00 2001 From: fcked Date: Mon, 13 Mar 2023 16:59:29 +0100 Subject: [PATCH 03/89] NIP-04: fix bug in code sample The code sample assumed that a `Uint8Array` was actually a hex string. --- 04.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/04.md b/04.md index 1866970..350f9c0 100644 --- a/04.md +++ b/04.md @@ -23,12 +23,12 @@ import crypto from 'crypto' import * as secp from 'noble-secp256k1' let sharedPoint = secp.getSharedSecret(ourPrivateKey, '02' + theirPublicKey) -let sharedX = sharedPoint.slice(2, 67) +let sharedX = sharedPoint.slice(1, 33) let iv = crypto.randomFillSync(new Uint8Array(16)) var cipher = crypto.createCipheriv( 'aes-256-cbc', - Buffer.from(sharedX, 'hex'), + Buffer.from(sharedX), iv ) let encryptedMessage = cipher.update(text, 'utf8', 'base64') From a886b43b48d3e52441bf97e1aa0de39ac2560843 Mon Sep 17 00:00:00 2001 From: fcked Date: Mon, 13 Mar 2023 18:29:24 +0100 Subject: [PATCH 04/89] NIP-04 follow up: use new import in code sample --- 04.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/04.md b/04.md index 350f9c0..f34d09b 100644 --- a/04.md +++ b/04.md @@ -20,7 +20,7 @@ Code sample for generating such an event in JavaScript: ```js import crypto from 'crypto' -import * as secp from 'noble-secp256k1' +import * as secp from '@noble/secp256k1' let sharedPoint = secp.getSharedSecret(ourPrivateKey, '02' + theirPublicKey) let sharedX = sharedPoint.slice(1, 33) From e1004d3d4bca4542f1862886b20c6a1c8b4d9e0b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Mar 2023 08:06:33 -0300 Subject: [PATCH 05/89] mention possibility of pubkey on `nevent`. --- 19.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/19.md b/19.md index 45081b0..9d73458 100644 --- a/19.md +++ b/19.md @@ -46,14 +46,14 @@ These possible standardized `TLV` types are indicated here: - for `nrelay`, this is the relay URL - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced - `1`: `relay` - - for `nprofile`, `nevent` and `naddr`, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii + - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii - this may be included multiple times - `2`: `author` - for `naddr`, the 32 bytes of the pubkey of the event + - for `nevent`, _optionally_, the 32 bytes of the pubkey of the event - `3`: `kind` - for `naddr`, the 32-bit unsigned integer of the kind, big-endian - ## Examples - `npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg` should decode into the public key hex `7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e` and vice-versa From 4bb393735ea501f0bac3e2cb255ae9a3caab6a68 Mon Sep 17 00:00:00 2001 From: Marco Argentieri <3596602+tiero@users.noreply.github.com> Date: Wed, 15 Mar 2023 20:17:44 +0100 Subject: [PATCH 06/89] Update 46.md --- 46.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/46.md b/46.md index 6589fc0..90fa1a0 100644 --- a/46.md +++ b/46.md @@ -67,7 +67,7 @@ These are mandatory methods the remote signer app MUST implement: - result `pubkey` - **sign_event** - params [`event`] - - result `signature` + - result `event_with_signature` #### optional @@ -151,7 +151,7 @@ The `content` field contains encrypted message as specified by [NIP04](https://g 1. The **App** will send a message to the **Signer** with a `sign_event` request along with the **event** to be signed 2. The **Signer** will show a popup to the user to inspect the event and sign it -3. The **Signer** will send back a message with the schnorr `signature` of the event as a response to the `sign_event` request +3. The **Signer** will send back a message with the event including the `id` and the schnorr `signature` as a response to the `sign_event` request ### Delegate From 88009bea8509d004672551be7346a03c373491d0 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Thu, 16 Mar 2023 15:49:14 +0100 Subject: [PATCH 07/89] add NOTICE optional subscription_id --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 0e68de5..eead966 100644 --- a/01.md +++ b/01.md @@ -89,7 +89,7 @@ The `limit` property of a filter is only valid for the initial query and can be Relays can send 2 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. - * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. + * `["NOTICE", , ]`, used to send human-readable error messages or other things to clients. Relays might optionally send a `subscription_id` this notice was caused by. This NIP defines no rules for how `NOTICE` messages should be sent or treated. From b24eb78e048fad09233527cf62c6adf3628ded0d Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Thu, 16 Mar 2023 20:18:59 +0300 Subject: [PATCH 08/89] Revert 'add NOTICE optional subscription_id' Reverts 88009bea8509d004672551be7346a03c373491d0 --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index eead966..9f60a1d 100644 --- a/01.md +++ b/01.md @@ -89,7 +89,7 @@ The `limit` property of a filter is only valid for the initial query and can be Relays can send 2 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. - * `["NOTICE", , ]`, used to send human-readable error messages or other things to clients. Relays might optionally send a `subscription_id` this notice was caused by. + * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. This NIP defines no rules for how `NOTICE` messages should be sent or treated. From dbbf7902d9e11f3515961ff026daf961cd0d10bd Mon Sep 17 00:00:00 2001 From: Sepehr Safari Date: Wed, 15 Mar 2023 15:14:46 +0330 Subject: [PATCH 09/89] remove tiny duplicate text fixed "the the serialized event data" => "the serialized event data" --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 9f60a1d..4cfdd35 100644 --- a/01.md +++ b/01.md @@ -16,7 +16,7 @@ The only object type that exists is the `event`, which has the following format ```json { - "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data> + "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data> "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , "kind": , From f7b57e3735fc95482d9485d21c4439b9d21851ac Mon Sep 17 00:00:00 2001 From: nostr-wine <124309146+nostr-wine@users.noreply.github.com> Date: Sat, 18 Mar 2023 18:44:31 -0400 Subject: [PATCH 10/89] Add proposed extensions to NIP-11 Take the proposed changes from https://github.com/nostr-protocol/nips/pull/163 and put them in NIP-11 under "Extra Fields" --- 11.md | 197 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 197 insertions(+) diff --git a/11.md b/11.md index 8cdb85e..a8386ba 100644 --- a/11.md +++ b/11.md @@ -56,3 +56,200 @@ The relay server implementation MAY be provided in the `software` attribute. If ### Version ### The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. + +Extra Fields +----------------- + +### Server Limitations ### + +These are limitations imposed by the relay on clients. Your client +should expect that requests which exceed these *practical* limitations +are rejected or fail immediately. + +```json +{ +... + limitation: { + max_message_length: 16384, + max_subscriptions: 20, + max_filters: 100, + max_limit: 5000, + max_subid_length: 100, + min_prefix: 4, + max_event_tags: 100, + max_content_length: 8196, + min_pow_difficulty: 30, + auth_required: true, + payment_required: true, + } +... +} +``` + +- `max_message_length`: this is the maximum number of bytes for incoming JSON that the relay +will attempt to decode and act upon. When you send large subscriptions, you will be +limited by this value. It also effectively limits the maximum size of any event. Value is +calculated from `[` to `]` and is after UTF-8 serialization (so some unicode characters +will cost 2-3 bytes). It is equal to the maximum size of the WebSocket message frame. + +- `max_subscriptions`: total number of subscriptions that may be +active on a single websocket connection to this relay. It's possible +that authenticated clients with a (paid) relationship to the relay +may have higher limits. + +- `max_filters`: maximum number of filter values in each subscription. +Must be one or higher. + +- `max_subid_length`: maximum length of subscription id as a string. + +- `min_prefix`: for `authors` and `ids` filters which are to match against +a hex prefix, you must provide at least this many hex digits in the prefix. + +- `max_limit`: the relay server will clamp each filter's `limit` value to this number. +This means the client won't be able to get more than this number +of events from a single subscription filter. This clamping is typically done silently +by the relay, but with this number, you can know that there are additional results +if you narrowed your filter's time range or other parameters. + +- `max_event_tags`: in any event, this is the maximum number of elements in the `tags` list. + +- `max_content_length`: maximum number of characters in the `content` +field of any event. This is a count of unicode characters. After +serializing into JSON it may be larger (in bytes), and is still +subject to the `max_message_length`, if defined. + +- `min_pow_difficulty`: new events will require at least this difficulty of PoW, +based on [NIP-13](13.md), or they will be rejected by this server. + +- `auth_required`: this relay requires [NIP-42](42.md) authentication +to happen before a new connection may perform any other action. +Even if set to False, authentication may be required for specific actions. + +- `payment_required`: this relay requires payment before a new connection may perform any action. + +### Event Retention ### + +There may be a cost associated with storing data forever, so relays +may wish to state retention times. The values stated here are defaults +for unauthenticated users and visitors. Paid users would likely have +other policies. + +Retention times are given in seconds, with `null` indicating infinity. +If zero is provided, this means the event will not be stored at +all, and preferably an error will be provided when those are received. + +```json +{ +... + retention: [ + { kinds: [0, 1, [5, 7], [40, 49]], time: 3600 }, + { kinds: [[40000, 49999], time: 100 }, + { kinds: [[30000, 39999], count: 1000 }, + { time: 3600, count: 10000 } + ] +... +} +``` + +`retention` is a list of specifications: each will apply to either all kinds, or +a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive +start and end values. Events of indicated kind (or all) are then limited to a `count` +and or time period. + +It is possible to effectively blacklist Nostr-based protocols that rely on +a specific `kind` number, by giving a retention time of zero for those `kind` values. +While that is unfortunate, it does allow clients to discover servers that will +support their protocol quickly via a single HTTP fetch. + +There is no need to specify retention times for _ephemeral events_ as defined +in [NIP-16](16.md) since they are not retained. + + +### Content Limitations ### + +Some relays may be governed by the arbitrary laws of a nation state. This +may limit what content can be stored in cleartext on those relays. All +clients are encouraged to use encryption to work around this limitation. + +It is not possible to describe the limitations of each country's laws +and policies which themselves are typically vague and constantly shifting. + +Therefore, this field allows the relay operator to indicate which +country's' laws might end up being enforced on them, and then +indirectly on their users's content. + +Users should be able to avoid relays in countries they don't like, +and/or select relays in more favourable zones. Exposing this +flexibility is up to the client software. + +```json +{ +... + relay_countries: [ 'CA', 'US' ], +... +} +``` + +- `relay_countries`: a list of two-level ISO country codes (ISO 3166-1 alpha-2) whose + laws and policies may affect this relay. `EU` may be used for European Union countries. + +Remember that a relay may be hosted in a country which is not the +country of the legal entities who own the relay, so it's very +likely a number of countries are involved. + + +### Community Preferences ### + +For public text notes at least, a relay may try to foster a +local community. This would encourage users to follow the global +feed on that relay, in addition to their usual individual follows. +To support this goal, relays MAY specify some of the following values. + +```json +{ +... + language_tags: [ 'en', 'en-419' ], + tags: [ 'sfw-only', 'bitcoin-only', 'anime' ], + posting_policy: 'https://example.com/posting-policy.html', +... +} +``` + +- `language_tags` is an ordered list + of [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) indicating + the major languages spoken on the relay. + +- `tags` is a list of limitations on the topics to be discussed. + For example `sfw-only` indicates hat only "Safe For Work" content + is encouraged on this relay. This relies on assumptions of what the + "work" "community" feels "safe" talking about. In time, a common + set of tags may emerge that allow users to find relays that suit + their needs, and client software will be able to parse these tags easily. + The `bitcoin-only` tag indicates that any *altcoin*, *"crypto"* or *blockchain* + comments will be ridiculed without mercy. + +- `posting_policy` is a link to a human-readable page which specifies the + community policies for the relay. In cases where `sfw-only` is True, it's + important to link to a page which gets into the specifics of your posting policy. + +The `description` field should be used to describe your community +goals and values, in brief. The `posting_policy` is for additional +detail and legal terms. Use the `tags` field to signify limitations +on content, or topics to be discussed, which could be machine +processed by appropriate client software. + +### Pay-To-Relay ### + +Relays that require payments may want to expose their fee schedules. + +```json +{ +... + payments_url: "https://my-relay/payments", + fees: { + "admission": [{ amount: 1000000, unit: 'msats' }], + "subscription": [{ amount: 5000000, unit: 'msats', period: 2592000 }], + "publication": [{ kinds: [4], amount: 100, unit: 'msats' }], + }, +... +} From 92a41a284a55371e13f7155be0ba8a9ab4225561 Mon Sep 17 00:00:00 2001 From: nostr-wine <124309146+nostr-wine@users.noreply.github.com> Date: Sat, 18 Mar 2023 18:53:54 -0400 Subject: [PATCH 11/89] Add doc-hex as author --- 11.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/11.md b/11.md index a8386ba..c538326 100644 --- a/11.md +++ b/11.md @@ -4,7 +4,7 @@ NIP-11 Relay Information Document --------------------------- -`draft` `optional` `author:scsibug` +`draft` `optional` `author:scsibug` `author:doc-hex` Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. From 2394e5cc630741e036e6d0554e59a6611a123030 Mon Sep 17 00:00:00 2001 From: nostr-wine <124309146+nostr-wine@users.noreply.github.com> Date: Sat, 18 Mar 2023 18:57:02 -0400 Subject: [PATCH 12/89] Add cameri as author --- 11.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/11.md b/11.md index c538326..f97193c 100644 --- a/11.md +++ b/11.md @@ -4,7 +4,7 @@ NIP-11 Relay Information Document --------------------------- -`draft` `optional` `author:scsibug` `author:doc-hex` +`draft` `optional` `author:scsibug` `author:doc-hex` `author:cameri` Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. From 8b158e92279c08af812307ed7294378ddb8abbdd Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 21 Mar 2023 15:24:05 -0300 Subject: [PATCH 13/89] Add alternative mention handling NIP --- 08.md | 2 ++ 27.md | 17 +++++++++++++++++ README.md | 3 ++- 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 27.md diff --git a/08.md b/08.md index 113cb53..d82787d 100644 --- a/08.md +++ b/08.md @@ -1,3 +1,5 @@ +> __Warning__ `unrecommended`: discouraged in favor of NIP-27 + NIP-08 ====== diff --git a/27.md b/27.md new file mode 100644 index 0000000..b2d1e5a --- /dev/null +++ b/27.md @@ -0,0 +1,17 @@ +NIP-27 +====== + +Handling Mentions +----------------- + +`draft` `optional` `author:fiatjaf` `author:scsibug` `author:arthurfranca` + +This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. + +Clients that want to allow inline mentions they MUST show an autocomplete component or something analogous to that whenever the user starts typing a special key (for example, "@") or presses some button to include a mention etc -- or these clients can come up with other ways to unambiguously differentiate between mentions and normal text. + +Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867eefdfa9580434bc3e675be08d2acb526610d96fbe`, the client MUST replace its textual reference (inside `.content`) with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21. If client doesn't support NIP-21, it can instead use a regular http link to a nostr client such as `https://snort.social/p/nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. The client MAY add that pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. + +The same process applies for mentioning event IDs, except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. + +A client that receives a `text_note` event with such `nostr:...` mentions in its `.content` CAN do any desired context augmentation (for example, linking to the pubkey or showing a preview of the mentioned event contents) it wants in the process. diff --git a/README.md b/README.md index 37b2fe4..d93f5c2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) - [NIP-07: `window.nostr` capability for web browsers](07.md) -- [NIP-08: Handling Mentions](08.md) +- [NIP-08: Handling Mentions](08.md) – `unrecommended`: discouraged in favor of [NIP-27](27.md) - [NIP-09: Event Deletion](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) @@ -25,6 +25,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-23: Long-form Content](23.md) - [NIP-25: Reactions](25.md) - [NIP-26: Delegated Event Signing](26.md) +- [NIP-27: Handling Mentions](27.md) - [NIP-28: Public Chat](28.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) From a32ec25ecb5cb13754e435db01ef6bf2a749769c Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 22 Mar 2023 10:13:04 -0300 Subject: [PATCH 14/89] Make it clear why e tags are discouraged --- 27.md | 11 ++++++----- README.md | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/27.md b/27.md index b2d1e5a..237feaa 100644 --- a/27.md +++ b/27.md @@ -1,17 +1,18 @@ NIP-27 ====== -Handling Mentions ------------------ +Text Note References +-------------------- `draft` `optional` `author:fiatjaf` `author:scsibug` `author:arthurfranca` -This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. +This document standardizes the treatment given by clients of inline references of other events and pubkeys inside the content of `text notes` (currently kinds 1 and 30023). -Clients that want to allow inline mentions they MUST show an autocomplete component or something analogous to that whenever the user starts typing a special key (for example, "@") or presses some button to include a mention etc -- or these clients can come up with other ways to unambiguously differentiate between mentions and normal text. +Clients that want to allow inline mentions of profiles MUST show an autocomplete component or something analogous to that whenever the user starts typing a special key (for example, "@") or presses some button to include a mention etc -- or these clients can come up with other ways to unambiguously differentiate between mentions and normal text. Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867eefdfa9580434bc3e675be08d2acb526610d96fbe`, the client MUST replace its textual reference (inside `.content`) with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21. If client doesn't support NIP-21, it can instead use a regular http link to a nostr client such as `https://snort.social/p/nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. The client MAY add that pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. -The same process applies for mentioning event IDs, except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. +The same process applies for referencing event IDs, except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. +Because `e` tags on `text notes` are usually considered ancestor events used to build a conversarion thread (as per NIP-10), it is advised to use inline references when mentioning events and NOT adding corresponding `e` tag to the `.tags` event key. A client that receives a `text_note` event with such `nostr:...` mentions in its `.content` CAN do any desired context augmentation (for example, linking to the pubkey or showing a preview of the mentioned event contents) it wants in the process. diff --git a/README.md b/README.md index d93f5c2..6642e92 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-23: Long-form Content](23.md) - [NIP-25: Reactions](25.md) - [NIP-26: Delegated Event Signing](26.md) -- [NIP-27: Handling Mentions](27.md) +- [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) From 61a158caec1f8cfb3ffa98792640f0df807f35a8 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 22 Mar 2023 19:48:07 -0300 Subject: [PATCH 15/89] Replace specific client url --- 27.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/27.md b/27.md index 237feaa..26e29af 100644 --- a/27.md +++ b/27.md @@ -10,7 +10,7 @@ This document standardizes the treatment given by clients of inline references o Clients that want to allow inline mentions of profiles MUST show an autocomplete component or something analogous to that whenever the user starts typing a special key (for example, "@") or presses some button to include a mention etc -- or these clients can come up with other ways to unambiguously differentiate between mentions and normal text. -Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867eefdfa9580434bc3e675be08d2acb526610d96fbe`, the client MUST replace its textual reference (inside `.content`) with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21. If client doesn't support NIP-21, it can instead use a regular http link to a nostr client such as `https://snort.social/p/nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. The client MAY add that pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. +Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867eefdfa9580434bc3e675be08d2acb526610d96fbe`, the client MUST replace its textual reference (inside `.content`) with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21. If client doesn't support NIP-21, it can instead use a regular http link to a nostr client such as `https://a-nostr-client.com/nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. The client MAY add that pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. The same process applies for referencing event IDs, except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. Because `e` tags on `text notes` are usually considered ancestor events used to build a conversarion thread (as per NIP-10), it is advised to use inline references when mentioning events and NOT adding corresponding `e` tag to the `.tags` event key. From 9764a3b510c11719c76ec86240c67049981b8b45 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 22 Mar 2023 19:50:03 -0300 Subject: [PATCH 16/89] Replace discouraged with deprecated --- 08.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/08.md b/08.md index d82787d..2ab2b8f 100644 --- a/08.md +++ b/08.md @@ -1,4 +1,4 @@ -> __Warning__ `unrecommended`: discouraged in favor of NIP-27 +> __Warning__ `unrecommended`: deprecated in favor of NIP-27 NIP-08 ====== diff --git a/README.md b/README.md index 6642e92..9390916 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) - [NIP-07: `window.nostr` capability for web browsers](07.md) -- [NIP-08: Handling Mentions](08.md) – `unrecommended`: discouraged in favor of [NIP-27](27.md) +- [NIP-08: Handling Mentions](08.md) – `unrecommended`: deprecated in favor of [NIP-27](27.md) - [NIP-09: Event Deletion](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) From 2b926f54cdc6eb779de27510b1be20336c933ef9 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Thu, 23 Mar 2023 10:11:18 -0300 Subject: [PATCH 17/89] Improve the text --- 27.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/27.md b/27.md index 26e29af..235b4a5 100644 --- a/27.md +++ b/27.md @@ -6,13 +6,13 @@ Text Note References `draft` `optional` `author:fiatjaf` `author:scsibug` `author:arthurfranca` -This document standardizes the treatment given by clients of inline references of other events and pubkeys inside the content of `text notes` (currently kinds 1 and 30023). +This document standardizes the treatment given by clients of inline references of other events and profiles inside the content of `text notes` (currently kinds 1 and 30023). -Clients that want to allow inline mentions of profiles MUST show an autocomplete component or something analogous to that whenever the user starts typing a special key (for example, "@") or presses some button to include a mention etc -- or these clients can come up with other ways to unambiguously differentiate between mentions and normal text. +Once a mention is identified by a client, for example, when an user pastes a NIP-19 nostr profile string inside the event content input field (or optionally by any other means the client may wish to support, such as selecting an user from a context menu or autocompleter), the client MUST replace it with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21 before effectively creating the event. The client MAY add the corresponding pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. -Once a mention is identified, for example, the pubkey `27866e9d854c78ae625b867eefdfa9580434bc3e675be08d2acb526610d96fbe`, the client MUST replace its textual reference (inside `.content`) with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21. If client doesn't support NIP-21, it can instead use a regular http link to a nostr client such as `https://a-nostr-client.com/nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. The client MAY add that pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. - -The same process applies for referencing event IDs, except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. +The same process applies for referencing event IDs (using `nostr:nevent1...`), except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. Because `e` tags on `text notes` are usually considered ancestor events used to build a conversarion thread (as per NIP-10), it is advised to use inline references when mentioning events and NOT adding corresponding `e` tag to the `.tags` event key. -A client that receives a `text_note` event with such `nostr:...` mentions in its `.content` CAN do any desired context augmentation (for example, linking to the pubkey or showing a preview of the mentioned event contents) it wants in the process. +Note that the usage of `nostr:npub1...` for profile mentions or `nostr:note1...` for event mentions is discouraged due to their lack of embedded relay recommendation. + +A reader client that receives a `text_note` event with such `nostr:...` mentions in its `.content` CAN do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, NIP-21 links or direct links to web clients that will handle these references. From 56f84f79bd720912d08f5a7172011f7bf647b253 Mon Sep 17 00:00:00 2001 From: Bartholomew Joyce Date: Thu, 23 Mar 2023 08:54:22 -0600 Subject: [PATCH 18/89] Added NIP-04 metadata leak warning --- 04.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/04.md b/04.md index f34d09b..60ec5e0 100644 --- a/04.md +++ b/04.md @@ -47,3 +47,7 @@ let event = { ## Security Warning This standard does not go anywhere near what is considered the state-of-the-art in encrypted communication between peers, and it leaks metadata in the events, therefore it must not be used for anything you really need to keep secret, and only with relays that use `AUTH` to restrict who can fetch your `kind:4` events. + +## Client Implementation Warning + +Client's *should not* search and replace public key or note references from the `.content`. If processed like a regular text note (where `@npub...` is replaced with `#[0]` with a `["p", "..."]` tag) the tags are leaked and the mentioned user will receive the message in their inbox. From 23cec80e31f6b41df14f51533de6292d6cb8c9b0 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 23 Mar 2023 17:12:29 -0300 Subject: [PATCH 19/89] mention that the zap pubkey must be hex. --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index bbeb629..79f167c 100644 --- a/57.md +++ b/57.md @@ -26,7 +26,7 @@ Having lightning receipts on nostr allows clients to display lightning payments 1. Calculate the lnurl pay request url for a user from the lud06 or lud16 field on their profile -2. Fetch the lnurl pay request static endpoint (`https://host.com/.well-known/lnurlp/user`) and gather the `allowsNostr` and `nostrPubkey` fields. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key, associate this information with the user. The `nostrPubkey` is the `zapper`'s pubkey, and it is used to authorize zaps sent to that user. +2. Fetch the lnurl pay request static endpoint (`https://host.com/.well-known/lnurlp/user`) and gather the `allowsNostr` and `nostrPubkey` fields. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, associate this information with the user. The `nostrPubkey` is the `zapper`'s pubkey, and it is used to authorize zaps sent to that user. 3. Clients may choose to display a lightning zap button on each post or on the users profile, if the user's lnurl pay request endpoint supports nostr, the client SHOULD generate a `zap invoice` instead of a normal lnurl invoice. From 45b1860b52025182d6400fd804a5d376a183ee40 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Thu, 23 Mar 2023 19:37:10 -0300 Subject: [PATCH 20/89] Mention other nostr identifiers --- 27.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/27.md b/27.md index 235b4a5..f4e4629 100644 --- a/27.md +++ b/27.md @@ -13,6 +13,8 @@ Once a mention is identified by a client, for example, when an user pastes a NIP The same process applies for referencing event IDs (using `nostr:nevent1...`), except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. Because `e` tags on `text notes` are usually considered ancestor events used to build a conversarion thread (as per NIP-10), it is advised to use inline references when mentioning events and NOT adding corresponding `e` tag to the `.tags` event key. +Other nostr identifiers should be referenced similarly using NIP-21 URLs inside event content (e.g. `nostr:naddr1...` for parameterized replaceable events). + Note that the usage of `nostr:npub1...` for profile mentions or `nostr:note1...` for event mentions is discouraged due to their lack of embedded relay recommendation. A reader client that receives a `text_note` event with such `nostr:...` mentions in its `.content` CAN do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, NIP-21 links or direct links to web clients that will handle these references. From 9b575b151467b9eba055585820a4fa56822c6d64 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 25 Mar 2023 21:59:01 -0300 Subject: [PATCH 21/89] refactor NIP-27 for simplicity -- but also include very verbose considerations and an example. --- 08.md | 2 +- 27.md | 50 ++++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 43 insertions(+), 9 deletions(-) diff --git a/08.md b/08.md index 2ab2b8f..fb87b53 100644 --- a/08.md +++ b/08.md @@ -6,7 +6,7 @@ NIP-08 Handling Mentions ----------------- -`final` `optional` `author:fiatjaf` `author:scsibug` +`final` `unrecommended` `optional` `author:fiatjaf` `author:scsibug` This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. diff --git a/27.md b/27.md index f4e4629..e78058a 100644 --- a/27.md +++ b/27.md @@ -4,17 +4,51 @@ NIP-27 Text Note References -------------------- -`draft` `optional` `author:fiatjaf` `author:scsibug` `author:arthurfranca` +`draft` `optional` `author:arthurfranca` `author:hodlbod` `author:fiatjaf` -This document standardizes the treatment given by clients of inline references of other events and profiles inside the content of `text notes` (currently kinds 1 and 30023). +This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023). -Once a mention is identified by a client, for example, when an user pastes a NIP-19 nostr profile string inside the event content input field (or optionally by any other means the client may wish to support, such as selecting an user from a context menu or autocompleter), the client MUST replace it with the notation `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg` as per NIP-21 before effectively creating the event. The client MAY add the corresponding pubkey to the `.tags` with the tag `p` if it wishes to notify mentioned user. +When creating an event, clients should include mentions to other profiles and to other events in the middle of the `.content` using NIP-21 codes, such as `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. -The same process applies for referencing event IDs (using `nostr:nevent1...`), except that the client SHOULD NOT add the event id to the `.tags` with the tag `e` so to not negatively impact thread loading. -Because `e` tags on `text notes` are usually considered ancestor events used to build a conversarion thread (as per NIP-10), it is advised to use inline references when mentioning events and NOT adding corresponding `e` tag to the `.tags` event key. +Including [NIP-10](10.md)-style tags (`["e", , , ]`) for each reference is optional, clients should do it whenever they want the profile being mentioned to be notified of the mention, or when they want the referenced event to recognize their mention as a reply. -Other nostr identifiers should be referenced similarly using NIP-21 URLs inside event content (e.g. `nostr:naddr1...` for parameterized replaceable events). +A reader client that receives an event with such `nostr:...` mentions in its `.content` can do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, NIP-21 links or direct links to web clients that will handle these references. -Note that the usage of `nostr:npub1...` for profile mentions or `nostr:note1...` for event mentions is discouraged due to their lack of embedded relay recommendation. +--- -A reader client that receives a `text_note` event with such `nostr:...` mentions in its `.content` CAN do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, NIP-21 links or direct links to web clients that will handle these references. +## Example of a profile mention process + +Suppose a Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. + +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. + +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: + +```json +{ + "content": "hello nostr:nprofile1qqszclxx9f5haga8sfjjrulaxncvkfekj097t6f3pu65f86rvg49ehqj6f9dh", + "created_at": 1679790774, + "id": "f39e9b451a73d62abc5016cffdd294b1a904e2f34536a208874fe5e22bbd47cf", + "kind": 1, + "pubkey": "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798", + "sig": "f8c8bab1b90cc3d2ae1ad999e6af8af449ad8bb4edf64807386493163e29162b5852a796a8f474d6b1001cddbaac0de4392838574f5366f03cc94cf5dfb43f4d", + "tags": [ + [ + "e", + "2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc" + ] + ] +} +``` + +(Alternatively, the mention could have been a `nostr:npub1...` URL.) + +After Bob publishes this event and Carol sees it, her client will initially display the `.content` as it is, but later it will parse the `.content` and see that there is a `nostr:` URL in there, decode it, extract the public key from it (and possibly relay hints), fetch that profile from its internal database or relays, then replace the full URL with the name `@mattn`, with a link to the internal page view for that profile. + +## Verbose and probably unnecessary considerations + +- The example above was very concrete, but it doesn't mean all clients have to implement the same flow. There could be clients that do not support autocomplete at all, so they just allow users to paste raw [NIP-19](19.md) codes into the body of text, then prefix these with `nostr:` before publishing the event. +- The flow for referencing other events is similar: a user could paste a `note1...` or `nevent1...` code and the client will turn that into a `nostr:note1...` or `nostr:nevent1...` URL. Then upon reading such references the client may show the referenced note in a preview box or something like that -- or nothing at all. +- Other display procedures can be employed: for example, if a client that is designed for dealing with only `kind:1` text notes sees, for example, a [`kind:30023`](23.md) `nostr:naddr1...` URL reference in the `.content`, it can, for example, decide to turn that into a link to some hardcoded webapp capable of displaying such events. +- Clients may give the user the option to include or not include tags for mentioned events or profiles. If someone wants to mention `mattn` without notifying them, but still have a nice augmentable/clickable link to their profile inside their note, they can instruct their client to _not_ create a `["p", ...]` tag for that specific mention. +- In the same way, if someone wants to reference another note but their reference is not meant to show up along other replies to that same note, their client can choose to not include a corresponding `["e", ...]` tag for any given `nostr:nevent1...` URL inside `.content`. Clients may decide to expose these advanced functionalities to users or be more opinionated about things. From 2fd581f6928eb8cb3c53947a83b6950f8abc8f01 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 25 Mar 2023 22:17:48 -0300 Subject: [PATCH 22/89] adapt NIP-23 references to use NIP-27. --- 23.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/23.md b/23.md index 0648a35..5bf20cd 100644 --- a/23.md +++ b/23.md @@ -6,7 +6,7 @@ Long-form Content `draft` `optional` `author:fiatjaf` -This NIP defines `kind:30023` (a parameterized replaceable event according to NIP-33) for long-form text content, generally referred to as "articles" or "blog posts". +This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". "Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. @@ -31,17 +31,11 @@ These articles are meant to be editable, so they should make use of the replacea ### Linking -The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see NIP-33 and NIP-19). +The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33md) and [NIP-19](19.md)). ### References -Clients that support publishing NIP-23 events should implement support for parsing pasted NIP-19 `naddr` identifiers and adding them automatically to the list of `.tags` of the event, replacing the actual content with a string like `#[tag_index]` in the same way as NIP-08 -- or, if the reference is in the form of a URL (for example, `[click here](naddr1...)`) then they should be replaced with just the tag number directly as if link with that name existed at the bottom of the Markdown (for example, `[click here][0]`). - -Reader clients should parse the Markdown and replace these references with either internal links so the referenced events can be accessed directly, with NIP-21 `nostr:naddr1...` links or direct links to web clients that will handle these references. - -The idea here is that having these tags is that reader clients can display a list of backreferences at the bottom when one article mentions another. - -The same principles can be applied to `nevent1...`, `note1...`, `nprofile1...` or `npub1...`. +References to other Nostr notes, articles or profiles must be made according to [NIP-27](27.md), i.e. by using [NIP-21](21.md) `nostr:...` links and optionally adding tags for these (see example below). ## Example Event @@ -49,7 +43,7 @@ The same principles can be applied to `nevent1...`, `note1...`, `nprofile1...` o { "kind": 30023, "created_at": 1675642635, - "content": "Lorem [ipsum][4] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at #[3].", + "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.", "tags": [ ["d", "lorem-ipsum"], ["title", "Lorem Ipsum"], From 39e3c1b926bf1bf504eb8b2176a6403f9a6b2ab9 Mon Sep 17 00:00:00 2001 From: Yoji Shidara Date: Sun, 26 Mar 2023 16:45:47 +0900 Subject: [PATCH 23/89] Fix a typo in link to NIP-33 --- 23.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/23.md b/23.md index 5bf20cd..151a31b 100644 --- a/23.md +++ b/23.md @@ -31,7 +31,7 @@ These articles are meant to be editable, so they should make use of the replacea ### Linking -The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33md) and [NIP-19](19.md)). +The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)). ### References From dced433f9c6f7151121f28f3824b2ee11e446ca8 Mon Sep 17 00:00:00 2001 From: Leo Wandersleb Date: Sun, 26 Mar 2023 12:10:29 -0300 Subject: [PATCH 24/89] events cannot really be replaced clarifying what it means to "replace an event" --- 16.md | 4 +++- 33.md | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/16.md b/16.md index 80a6b3d..4d9481d 100644 --- a/16.md +++ b/16.md @@ -16,7 +16,9 @@ Upon a regular event being received, the relay SHOULD send it to all clients wit Replaceable Events ------------------ A *replaceable event* is defined as an event with a kind `10000 <= n < 20000`. -Upon a replaceable event with a newer timestamp than the currently known latest replaceable event with the same kind being received, and signed by the same key, the old event SHOULD be discarded and replaced with the newer event. +Upon a replaceable event with a newer timestamp than the currently known latest replaceable event with the same kind and author being received, the old event SHOULD be discarded, +effectively replacing what gets returned when querying for +`author:kind` tuples. Ephemeral Events ---------------- diff --git a/33.md b/33.md index 60f3da6..10681fa 100644 --- a/33.md +++ b/33.md @@ -14,8 +14,10 @@ The value of a tag is defined as the first parameter of a tag after the tag name A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`. Upon a parameterized replaceable event with a newer timestamp than the currently known latest -replaceable event with the same kind and first `d` tag value being received, the old event -SHOULD be discarded and replaced with the newer event. +replaceable event with the same kind, author and first `d` tag value being received, the old event +SHOULD be discarded, effectively replacing what gets returned when querying for +`author:kind:d-tag` tuples. + A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the value as an empty string. Events from the same author with any of the following `tags` replace each other: From 133faa07636fff9f8e91c69cb9e3a5cce459b241 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Sun, 26 Mar 2023 14:48:54 -0300 Subject: [PATCH 25/89] Fix typo in NIP-27 --- 27.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/27.md b/27.md index e78058a..028ee5e 100644 --- a/27.md +++ b/27.md @@ -18,7 +18,7 @@ A reader client that receives an event with such `nostr:...` mentions in its `.c ## Example of a profile mention process -Suppose a Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. +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 `@`. 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. @@ -34,7 +34,7 @@ Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` "sig": "f8c8bab1b90cc3d2ae1ad999e6af8af449ad8bb4edf64807386493163e29162b5852a796a8f474d6b1001cddbaac0de4392838574f5366f03cc94cf5dfb43f4d", "tags": [ [ - "e", + "p", "2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc" ] ] From 197b6ea206611e751cb73c2e04a12b371674a109 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Sat, 25 Mar 2023 11:58:31 -0300 Subject: [PATCH 26/89] Bring back NIP-18 --- 18.md | 19 +++++++++++++++++++ README.md | 1 + 2 files changed, 20 insertions(+) create mode 100644 18.md diff --git a/18.md b/18.md new file mode 100644 index 0000000..365de9c --- /dev/null +++ b/18.md @@ -0,0 +1,19 @@ +NIP-18 +====== + +Reposts +------- + +`draft` `optional` `author:jb55` + +A repost is a `kind 6` note that is used to signal to followers +that another event is worth reading. + +The `content` of a repost event is empty. + +The repost event MUST include an `e` tag with the `id` of the note that is +being reposted. That tag SHOULD include a relay URL as its third entry +to indicate where it can be fetched. + +The repost SHOULD include a `p` tag with the `pubkey` of the event being +reposted. diff --git a/README.md b/README.md index 9390916..947ca70 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-14: Subject tag in text events.](14.md) - [NIP-15: End of Stored Events Notice](15.md) - [NIP-16: Event Treatment](16.md) +- [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-20: Command Results](20.md) - [NIP-21: `nostr:` URL scheme](21.md) From 9a362c6df48953fdfefea9178d70f3656d75b1e8 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 29 Mar 2023 15:37:54 -0300 Subject: [PATCH 27/89] Add optional comment to content --- 18.md | 6 ++++-- README.md | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/18.md b/18.md index 365de9c..ef77fa6 100644 --- a/18.md +++ b/18.md @@ -4,16 +4,18 @@ NIP-18 Reposts ------- -`draft` `optional` `author:jb55` +`draft` `optional` `author:fiatjaf` `author:arthurfranca` A repost is a `kind 6` note that is used to signal to followers that another event is worth reading. -The `content` of a repost event is empty. +The `content` of a repost event is empty. Optionally, it MAY contain +a comment in the same format of a kind 1 note content. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag SHOULD include a relay URL as its third entry to indicate where it can be fetched. +When reposting a long-form content use an `a` tag instead. The repost SHOULD include a `p` tag with the `pubkey` of the event being reposted. diff --git a/README.md b/README.md index 947ca70..ba78113 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh | 3 | Contacts | [2](02.md) | | 4 | Encrypted Direct Messages | [4](04.md) | | 5 | Event Deletion | [9](09.md) | +| 6 | Reposts | [18](18.md) | | 7 | Reaction | [25](25.md) | | 8 | Badge Award | [58](58.md) | | 40 | Channel Creation | [28](28.md) | From 5b1640c64815d9c288dd30b7c690b1afecf48930 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 29 Mar 2023 15:43:11 -0300 Subject: [PATCH 28/89] Document Damus repost as Event Copy --- 30.md | 21 +++++++++++++++++++++ README.md | 3 +++ 2 files changed, 24 insertions(+) create mode 100644 30.md diff --git a/30.md b/30.md new file mode 100644 index 0000000..2c3c4ae --- /dev/null +++ b/30.md @@ -0,0 +1,21 @@ +NIP-30 +====== + +Event Copy +---------- + +`draft` `optional` `author:jb55` `author:arthurfranca` + +An event of `kind 9` is used to copy any event from another pubkey. A copy +allows its creator to keep content around even when the original gets deleted. + +The `content` of a copy event MUST be the stringified JSON of the whole original event. + +The copy event SHOULD include a `k` tag with the `kind` of the note that is +being copied. This enables subscribing to a subset of copies. + +The copy event SHOULD include an `e` tag with the `id` of the note that is +being copied. This allows the original author to know a specific event has been copied. + +The copy event SHOULD include a `p` tag with the `pubkey` of the event being +copied to notify original author. diff --git a/README.md b/README.md index ba78113..741a288 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) +- [NIP-30: Event Copy](30.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) @@ -55,6 +56,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh | 6 | Reposts | [18](18.md) | | 7 | Reaction | [25](25.md) | | 8 | Badge Award | [58](58.md) | +| 9 | Event Copy | [30](30.md) | | 40 | Channel Creation | [28](28.md) | | 41 | Channel Metadata | [28](28.md) | | 42 | Channel Message | [28](28.md) | @@ -114,6 +116,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | g | geohash | | [12](12.md) | | nonce | random | | [13](13.md) | | subject | subject | | [14](14.md) | +| k | referenced event kind | | [30](30.md) | | d | identifier | | [33](33.md) | | expiration | unix timestamp (string) | | [40](40.md) | From 800c0d0cd397eb4b043ef0cdaefd0bad18cb1cd5 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 29 Mar 2023 18:45:12 -0300 Subject: [PATCH 29/89] Drop event copy --- 18.md | 12 ++++++++---- 30.md | 21 --------------------- README.md | 3 --- 3 files changed, 8 insertions(+), 28 deletions(-) delete mode 100644 30.md diff --git a/18.md b/18.md index ef77fa6..422ad9c 100644 --- a/18.md +++ b/18.md @@ -4,18 +4,22 @@ NIP-18 Reposts ------- -`draft` `optional` `author:fiatjaf` `author:arthurfranca` +`draft` `optional` `author:jb55` `author:fiatjaf` `author:arthurfranca` A repost is a `kind 6` note that is used to signal to followers that another event is worth reading. The `content` of a repost event is empty. Optionally, it MAY contain -a comment in the same format of a kind 1 note content. +the stringified JSON of the reposted note event for quick look up. The repost event MUST include an `e` tag with the `id` of the note that is -being reposted. That tag SHOULD include a relay URL as its third entry +being reposted. That tag MUST include a relay URL as its third entry to indicate where it can be fetched. -When reposting a long-form content use an `a` tag instead. The repost SHOULD include a `p` tag with the `pubkey` of the event being reposted. + +## Quote Reposts + +Quote reposts are `kind 1` events with an embedded `e` tag (see [NIP-08](08.md) and [NIP-27](27.md)). +Because a quote repost includes an `e` tag, it may show up along replies to the reposted note. diff --git a/30.md b/30.md deleted file mode 100644 index 2c3c4ae..0000000 --- a/30.md +++ /dev/null @@ -1,21 +0,0 @@ -NIP-30 -====== - -Event Copy ----------- - -`draft` `optional` `author:jb55` `author:arthurfranca` - -An event of `kind 9` is used to copy any event from another pubkey. A copy -allows its creator to keep content around even when the original gets deleted. - -The `content` of a copy event MUST be the stringified JSON of the whole original event. - -The copy event SHOULD include a `k` tag with the `kind` of the note that is -being copied. This enables subscribing to a subset of copies. - -The copy event SHOULD include an `e` tag with the `id` of the note that is -being copied. This allows the original author to know a specific event has been copied. - -The copy event SHOULD include a `p` tag with the `pubkey` of the event being -copied to notify original author. diff --git a/README.md b/README.md index 741a288..ba78113 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,6 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) -- [NIP-30: Event Copy](30.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) @@ -56,7 +55,6 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh | 6 | Reposts | [18](18.md) | | 7 | Reaction | [25](25.md) | | 8 | Badge Award | [58](58.md) | -| 9 | Event Copy | [30](30.md) | | 40 | Channel Creation | [28](28.md) | | 41 | Channel Metadata | [28](28.md) | | 42 | Channel Message | [28](28.md) | @@ -116,7 +114,6 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | g | geohash | | [12](12.md) | | nonce | random | | [13](13.md) | | subject | subject | | [14](14.md) | -| k | referenced event kind | | [30](30.md) | | d | identifier | | [33](33.md) | | expiration | unix timestamp (string) | | [40](40.md) | From 60412bf7a55c32ed55eec2e9adda834f968fa00b Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Fri, 24 Mar 2023 12:02:35 -0500 Subject: [PATCH 30/89] Re-write nip 57 to consolidate flow and clarify terminology --- 57.md | 209 ++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 115 insertions(+), 94 deletions(-) diff --git a/57.md b/57.md index 79f167c..7887652 100644 --- a/57.md +++ b/57.md @@ -6,69 +6,139 @@ Lightning Zaps `draft` `optional` `author:jb55` `author:kieran` -This NIP defines a new note type called a lightning zap of kind `9735`. These represent paid lightning invoice receipts sent by a lightning node called the `zapper`. We also define another note type of kind `9734` which are `zap request` notes, which will be described in this document. +This NIP defines two new event types for recording lightning payments between users. `9734` is a `zap request`, representing a payer's request to a recipient's lightning wallet for an invoice. `9735` is a `zap receipt`, representing the confirmation by the recipient's lightning wallet that the invoice issued in response to a zap request has been paid. Having lightning receipts on nostr allows clients to display lightning payments from entities on the network. These can be used for fun or for spam deterrence. - -## Definitions - -`zapper` - the lightning node or service that sends zap notes (kind `9735`) - -`zap request` - a note of kind `9734` created by the person zapping - -`zap invoice` - the bolt11 invoice fetched from a custom lnurl endpoint which contains a `zap request` note - - ## Protocol flow -### Client side +1. Client calculates a recipient's lnurl pay request url by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. +2. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a zap receipt rather than a normal lnurl invoice. +3. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it. +4. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example. +5. The recipient's lnurl server will receive this request and validate it. See Appendix C for details on how to properly configure an lnurl server to support zaps, and Appendix D for details on how to validate the `nostr` query parameter. +6. If the request is valid, the server should fetch a description hash invoice where the description is this note and this note only. No additional lnurl metadata is included in the description. This will be returned in the response according to [LUD06](https://github.com/lnurl/luds/blob/luds/06.md). +7. On receiving the invoice, the client MAY pay it or pass it to an app that can pay the invoice. +8. Once the invoice is paid, the recipient's lnurl server MUST generate a `zap receipt` as described in Appendix E, and publish it to the `relays` specified in the `zap request`. +9. Clients MAY fetch zap notes on posts and profiles, but MUST authorize their validity as described in Appendix F. If the zap request note contains a non-empty `content`, it may display a zap comment. Generally clients should show users the `zap request` note, and use the `zap note` to show "zap authorized by ..." but this is optional. -1. Calculate the lnurl pay request url for a user from the lud06 or lud16 field on their profile +## Reference and examples -2. Fetch the lnurl pay request static endpoint (`https://host.com/.well-known/lnurlp/user`) and gather the `allowsNostr` and `nostrPubkey` fields. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, associate this information with the user. The `nostrPubkey` is the `zapper`'s pubkey, and it is used to authorize zaps sent to that user. +### Appendix A: Zap Request Event -3. Clients may choose to display a lightning zap button on each post or on the users profile, if the user's lnurl pay request endpoint supports nostr, the client SHOULD generate a `zap invoice` instead of a normal lnurl invoice. +A `zap request` is an event of kind `9734` that is _not_ published to relays, but is instead sent to a recipient's lnurl pay `callback` url. This event's `content` MAY be an optional message to send along with the payment. The event MUST include the following tags: -4. To generate a `zap invoice`, call the `callback` url with `amount` set to the milli-satoshi amount value. A `nostr` querystring value MUST be set as well. It is a uri-encoded `zap request` note signed by the user's key. The `zap request` note contains an `e` tag of the note it is zapping, and a `p` tag of the target user's pubkey. The `e` tag is optional which allows profile tipping. An optional `a` tag allows tipping parameterized replaceable events such as NIP-23 long-form notes. The `zap request` note must also have a `relays` tag, which is gathered from the user's configured relays. The `zap request` note SHOULD contain an `amount` tag, which is the milli-satoshi value of the zap which clients SHOULD verify being equal to the amount of the invoice. The `content` MAY be an additional comment from the user which can be displayed when listing zaps on posts and profiles. +- `relays` is a list of relays the recipient's wallet should publish its `zap receipt` to. Note that relays should not be nested in an additional list, but should be included as shown in the example below. +- `amount` is the amount in _millisats_ the sender intends to pay, formatted as a string. This is recommended, but optional. +- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl`. This is recommended, but optional. +- `p` is the hex-encoded pubkey of the recipient. -5. Pay this invoice or pass it to an app that can pay the invoice. Once it's paid, a `zap note` will be created by the `zapper`. +In addition, the event MAY include the following tags: -### LNURL Server side +- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. +- `a` is an optional NIP-33 event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes. + +Example: + +```json +{ + "kind": 9734, + "content": "Zap!", + "tags": [ + ["relays", "wss://nostr-pub.wellorder.com"], + ["amount", "21000"], + ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"], + ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"], + ["e", "9ae37aa68f48645127299e9453eb5d908a0cbb6058ff340d528ed4d37c8994fb"] + ], + "pubkey": "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322", + "created_at": 1679673265, + "id": "30efed56a035b2549fcaeec0bf2c1595f9a9b3bb4b1a38abaf8ee9041c4b7d93", + "sig": "f2cb581a84ed10e4dc84937bd98e27acac71ab057255f6aa8dfa561808c981fe8870f4a03c1e3666784d82a9c802d3704e174371aa13d63e2aeaf24ff5374d9d" +} +``` + +### Appendix B: Zap Request HTTP Request + +A signed zap request event is not published, but is instead sent using a HTTP GET request to the recipient's `callback` url, which was provided by the recipient's lnurl pay endpoint. This request should have the following query parameters defined: + +- `amount` is the amount in _millisats_ the sender intends to pay +- `nostr` is the `9734` zap request event, JSON encoded then URI encoded +- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl` + +This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize his zap. Here is an example flow: + +```javascript +const senderPubkey // The sender's pubkey +const recipientPubkey = // The recipient's pubkey +const callback = // The callback received from the recipients lnurl pay endpoint +const lnurl = // The recipient's lightning address, encoded as a lnurl +const sats = 21 + +const amount = sats * 1000 +const relays = ['wss://nostr-pub.wellorder.net'] +const event = encodeURI(JSON.stringify(await signEvent({ + kind: [9734], + content: "", + pubkey: senderPubkey, + created_at: Math.round(Date.now() / 1000), + tags: [ + ["relays", ...relays], + ["amount", amount.toString()], + ["lnurl", lnurl], + ["p", recipientPubkey], + ], +}))) + +const {pr: invoice} = await fetchJson(`${callback}?amount=${amount}&nostr=${event}&lnurl=${lnurl}`) +``` + +### Appendix C: LNURL Server Configuration The lnurl server will need some additional pieces of information so that clients can know that zap invoices are supported: -1. Add a `nostrPubkey` to the lnurl-pay static endpoint `/.well-known/lnurlp/user`, where `nostrPubkey` is the nostr pubkey of the `zapper`, the entity that creates zap notes. Clients will use this to authorize zaps. - +1. Add a `nostrPubkey` to the lnurl-pay static endpoint `/.well-known/lnurlp/`, where `nostrPubkey` is the nostr pubkey your server will use to sign `zap receipt` events. Clients will use this to validate zap receipts. 2. Add an `allowsNostr` field and set it to true. -3. In the lnurl-pay callback URL, watch for a `nostr` querystring, where the contents of the note is a uri-encoded `zap request` JSON. +### Appendix D: LNURL Server Zap Request Validation -4. If present, the zap request note must be validated: +When a client sends a zap request event to a server's lnurl-pay callback URL, there will be a `nostr` query parameter where the contents of the event are URI- and JSON-encoded. If present, the zap request event must be validated in the following ways: - a. It MUST have a valid nostr signature +1. It MUST have a valid nostr signature +2. It MUST have tags +3. It MUST have only one `p` tag +4. It MUST have 0 or 1 `e` tags +5. There should be a `relays` tag with the relays to send the `zap` note to. +6. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. +7. If there is an `a` tag, it MUST be a valid NIP-33 event coordinate - b. It MUST have tags +The event MUST then be stored for use later, when the invoice is paid. - c. It MUST have at least one p-tag +### Appendix E: Zap Receipt Event - d. It MUST have either 0 or 1 e-tag +A `zap receipt` is created by a lightning node when an invoice generated by a `zap request` is paid. Zap receipts are only created when the invoice description (committed to the description hash) contains a zap request note. - e. There should be a `relays` tag with the relays to send the `zap` note to. +When receiving a payment, the following steps are executed: - f. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. +1. Get the description for the invoice. This needs to be saved somewhere during the generation of the description hash invoice. It is saved automatically for you with CLN, which is the reference implementation used here. +2. Parse the bolt11 description as a JSON nostr event. This SHOULD be validated based on the requirements in Appendix D, either when it is received, or before the invoice is paid. +3. Create a nostr event of kind `9735` as described below, and publish it to the `relays` declared in the zap request. - g. If there is an `a` tag, it MUST be a valid NIP-33 event coordinate +The following should be true of the zap receipt event: -5. If valid, fetch a description hash invoice where the description is this note and this note only. No additional lnurl metadata is included in the description. +- The content SHOULD be empty. +- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. +- `tags` MUST include the `p` tag AND optional `e` tag from the zap request. +- The zap receipt MUST have a `bolt11` tag containing the description hash bolt11 invoice. +- The zap receipt MUST contain a `description` tag which is the JSON-encoded invoice description. +- `SHA256(description)` MUST match the description hash in the bolt11 invoice. +- 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. -At this point, the lightning node is ready to send the zap note once payment is received. +The zap receipt is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the zap receipt implies the invoice as paid, but it could be a lie given a rogue implementation. -## The zap note +A reference implementation for a zap-enabled lnurl server can be found [here](https://github.com/jb55/cln-nostr-zapper). -Zap notes are created by a lightning node reacting to paid invoices. Zap notes are only created when the invoice description (committed to the description hash) contains a `zap request` note. - -Example zap note: +Example zap receipt: ```json { @@ -77,73 +147,24 @@ Example zap note: "created_at": 1674164545, "kind": 9735, "tags": [ - [ - "p", - "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245" - ], - [ - "e", - "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8" - ], - [ - "bolt11", - "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0" - ], - [ - "description", - "{\"pubkey\":\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}" - ], - [ - "preimage", - "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f" - ] + ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], + ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"], + ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"], + ["description", "{\"pubkey\":\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], + ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"] ], "content": "", "sig": "b0a3c5c984ceb777ac455b2f659505df51585d5fd97a0ec1fdb5f3347d392080d4b420240434a3afd909207195dac1e2f7e3df26ba862a45afd8bfe101c2b1cc" } ``` -* The zap note MUST have a `bolt11` tag containing the description hash bolt11 invoice. +### Appendix F: Validating Zap Receipts -* The zap note MUST contain a `description` tag which is the invoice description. +A client can retrieve `zap receipts` on events and pubkeys using a NIP-01 filter, for example `{"kinds": [9735], "#e": [...]}`. Zaps MUST be validated using the following steps: -* `SHA256(description)` MUST match the description hash in the bolt11 invoice. - -* The zap note MAY contain a `preimage` 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 note for the legitimacy of the payment. - -The zap note is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the zap note implies the invoice as paid, but it could be a lie given a rogue implementation. - - -### Creating a zap note - -When receiving a payment, the following steps are executed: - -1. Get the description for the invoice. This needs to be saved somewhere during the generation of the description hash invoice. It is saved automatically for you with CLN, which is the reference implementation used here. - -2. Parse the bolt11 description as a JSON nostr note. You SHOULD check the signature of the parsed note to ensure that it is valid. This is the `zap request` note created by the entity who is zapping. - -4. The note MUST have only one `p` tag - -5. The note MUST have 0 or 1 `e` tag - -6. Create a nostr note of kind `9735` that includes the `p` tag AND optional `e` tag. The content SHOULD be empty. The created_at date SHOULD be set to the invoice paid_at date for idempotency. - -7. Send the note to the `relays` declared in the `zap request` note from the invoice description. - -A reference implementation for the zapper is here: [zapper][zapper] - -[zapper]: https://github.com/jb55/cln-nostr-zapper - - -## Client Behavior - -Clients MAY fetch zap notes on posts and profiles: - -`{"kinds": [9735], "#e": [...]}` - -To authorize these notes, clients MUST fetch the `nostrPubkey` from the users configured lightning address or lnurl and ensure that the zaps to their posts were created by this pubkey. If clients don't do this, anyone could forge unauthorized zaps. - -Once authorized, clients MAY tally zaps on posts, and list them on profiles. If the zap request note contains a non-empty `content`, it may display a zap comment. Generally clients should show users the `zap request` note, and use the `zap note` to show "zap authorized by ..." but this is optional. +- The `zap receipt` event's `pubkey` MUST be the same as the recipient's lnurl provider's `nostrPubkey` (retrieved in step 1 of the protocol flow). +- The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present). +- The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. ## Future Work From d74ac8654efeb85bd04555b5c334722394c7326c Mon Sep 17 00:00:00 2001 From: Vlad Stan Date: Mon, 13 Mar 2023 22:31:25 +0200 Subject: [PATCH 31/89] doc: add horse extension --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index ad26d2f..3b7a1d2 100644 --- a/07.md +++ b/07.md @@ -24,6 +24,7 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext ### Implementation +- [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives) - [nos2x](https://github.com/fiatjaf/nos2x) (Chrome and derivatives) - [Alby](https://getalby.com) (Chrome and derivatives, Firefox, Safari) - [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives) From 8b39976e78f90fe766ad7149e250777cddacbb5e Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Mon, 3 Apr 2023 16:53:27 +0300 Subject: [PATCH 32/89] Event-specific zap markers (#402) --- 57.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/57.md b/57.md index 7887652..17042ea 100644 --- a/57.md +++ b/57.md @@ -12,7 +12,7 @@ Having lightning receipts on nostr allows clients to display lightning payments ## Protocol flow -1. Client calculates a recipient's lnurl pay request url by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. +1. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. 2. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a zap receipt rather than a normal lnurl invoice. 3. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it. 4. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example. @@ -166,6 +166,18 @@ A client can retrieve `zap receipts` on events and pubkeys using a NIP-01 filter - The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present). - The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. +### Appendix G: `zap` tag on zapped event + +When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay request based on it's value instead of the profile's field. An optional third argument on the tag specifies the type of value, either `lud06` or `lud16`. + +```json +{ + "tags": [ + [ "zap", "pablo@f7z.io", "lud16" ] + ] +} +``` + ## Future Work Zaps can be extended to be more private by encrypting zap request notes to the target user, but for simplicity it has been left out of this initial draft. From c6e14c808775ec6ca0a721fe273b4de7124dd143 Mon Sep 17 00:00:00 2001 From: Seth For Privacy Date: Tue, 4 Apr 2023 13:43:59 -0400 Subject: [PATCH 33/89] Add address_index for NIP-06 generation I propose a change to NIP-06 that would allow the generation of infinite root keys by using the address_index field of the 5-level path used to derive Nostr keys under BIP32. The current 5-level path used for NIP-06 is "m/44'/1237'/0'/0/0", and only generates one private key. By changing it to "m/44'/1237'/0'/0/", we can generate multiple keys from a single parent bitcoin seed. --- 06.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/06.md b/06.md index c1e66fe..b731c49 100644 --- a/06.md +++ b/06.md @@ -8,8 +8,8 @@ Basic key derivation from mnemonic seed phrase [BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them. -[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/0'/0/0` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)). +[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/0'/0/` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)). -This is the default for a basic, normal, single-key client. +A basic client can simply use an `address_index` of `0` to derive a single key. For more advanced use-cases you can increment `address_index`, allowing generation of practically infinite keys from the 5-level path. Other types of clients can still get fancy and use other derivation paths for their own other purposes. From 59e51957842a46838901c5e48242cd3a9cfd3185 Mon Sep 17 00:00:00 2001 From: Seth For Privacy Date: Tue, 4 Apr 2023 14:11:50 -0400 Subject: [PATCH 34/89] Use account instead of address_index --- 06.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/06.md b/06.md index b731c49..4ae571f 100644 --- a/06.md +++ b/06.md @@ -8,8 +8,8 @@ Basic key derivation from mnemonic seed phrase [BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them. -[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/0'/0/` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)). +[BIP32](https://bips.xyz/32) is used to derive the path `m/44'/1237'/'/0/0` (according to the Nostr entry on [SLIP44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)). -A basic client can simply use an `address_index` of `0` to derive a single key. For more advanced use-cases you can increment `address_index`, allowing generation of practically infinite keys from the 5-level path. +A basic client can simply use an `account` of `0` to derive a single key. For more advanced use-cases you can increment `account`, allowing generation of practically infinite keys from the 5-level path with hardened derivation. Other types of clients can still get fancy and use other derivation paths for their own other purposes. From e219ec64701d89e6b2c3f3ca8fd426d0aefdcb9c Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 3 Jan 2023 20:11:17 -0800 Subject: [PATCH 35/89] Add NIP-45, which defines a COUNT verb --- 45.md | 31 +++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 34 insertions(+) create mode 100644 45.md diff --git a/45.md b/45.md new file mode 100644 index 0000000..cd81c11 --- /dev/null +++ b/45.md @@ -0,0 +1,31 @@ +NIP-45 +====== + +Event Counts +-------------- + +`draft` `optional` `author:staab` + +Relays may support the `COUNT` verb, which provide a mechanism for obtaining event counts. + +## Motivation + +Some queries a client may want to execute against connected relays are prohibitively expensive, for example, in order to retrieve follower counts for a given pubkey, a client must query all kind-3 events referring to a given pubkey and count them. The result may be cached, either by a client or by a separate indexing server as an alternative, but both options erode the decentralization of the network by creating a second-layer protocol on top of Nostr. + +## Filters and return values + +This NIP defines a verb called `COUNT`, which accepts a subscription id and a filter as specified in [NIP 01](01.md). + +Counts are returned using a `COUNT` response in the form `{count: }`. Relays may use probabilistic counts to reduce compute requirements. + +Examples: + +``` +# Followers count +["COUNT", "", {kinds: [3], '#p': []}] +["COUNT", "", {count: 238}] + +# Count posts and reactions +["COUNT", "", {kinds: [1, 7], authors: []}] +["COUNT", "", {count: 5}] +``` diff --git a/README.md b/README.md index ba78113..215e5cd 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) +- [NIP-45: Counting results](45.md) - [NIP-46: Nostr Connect](46.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) @@ -88,6 +89,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh | REQ | used to request events and subscribe to new updates | [1](01.md) | | CLOSE | used to stop previous subscriptions | [1](01.md) | | AUTH | used to send authentication events | [42](42.md) | +| COUNT | used to request event counts | [45](45.md) | ### Relay to Client | type | description | NIP | @@ -97,6 +99,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh | EOSE | used to notify clients all stored events have been sent | [15](15.md) | | OK | used to notify clients if an EVENT was successful | [20](20.md) | | AUTH | used to send authentication challenges | [42](42.md) | +| COUNT | used to send requested event counts to clients | [45](45.md) | Please update these lists when proposing NIPs introducing new event kinds. From 3cec80d99ebbee6b72aae31f1856181d04971244 Mon Sep 17 00:00:00 2001 From: vivganes Date: Fri, 7 Apr 2023 17:38:03 +0530 Subject: [PATCH 36/89] fix grammar and typos --- 04.md | 2 +- 05.md | 2 +- 11.md | 8 ++++---- 13.md | 2 +- 22.md | 2 +- 25.md | 2 +- 40.md | 2 +- 45.md | 2 +- 51.md | 2 +- 78.md | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) diff --git a/04.md b/04.md index 60ec5e0..6e45b74 100644 --- a/04.md +++ b/04.md @@ -50,4 +50,4 @@ This standard does not go anywhere near what is considered the state-of-the-art ## Client Implementation Warning -Client's *should not* search and replace public key or note references from the `.content`. If processed like a regular text note (where `@npub...` is replaced with `#[0]` with a `["p", "..."]` tag) the tags are leaked and the mentioned user will receive the message in their inbox. +Clients *should not* search and replace public key or note references from the `.content`. If processed like a regular text note (where `@npub...` is replaced with `#[0]` with a `["p", "..."]` tag) the tags are leaked and the mentioned user will receive the message in their inbox. diff --git a/05.md b/05.md index 992983f..a7b42b0 100644 --- a/05.md +++ b/05.md @@ -64,7 +64,7 @@ For example, if after finding that `bob@bob.com` has the public key `abc...def`, ### Public keys must be in hex format -Keys must be returned in hex format. Keys in NIP-19 `npub` format are are only meant to be used for display in client UIs, not in this NIP. +Keys must be returned in hex format. Keys in NIP-19 `npub` format are only meant to be used for display in client UIs, not in this NIP. ### User Discovery implementation suggestion diff --git a/11.md b/11.md index f97193c..1766320 100644 --- a/11.md +++ b/11.md @@ -154,7 +154,7 @@ all, and preferably an error will be provided when those are received. `retention` is a list of specifications: each will apply to either all kinds, or a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive start and end values. Events of indicated kind (or all) are then limited to a `count` -and or time period. +and/or time period. It is possible to effectively blacklist Nostr-based protocols that rely on a specific `kind` number, by giving a retention time of zero for those `kind` values. @@ -175,8 +175,8 @@ It is not possible to describe the limitations of each country's laws and policies which themselves are typically vague and constantly shifting. Therefore, this field allows the relay operator to indicate which -country's' laws might end up being enforced on them, and then -indirectly on their users's content. +countries' laws might end up being enforced on them, and then +indirectly on their users' content. Users should be able to avoid relays in countries they don't like, and/or select relays in more favourable zones. Exposing this @@ -220,7 +220,7 @@ To support this goal, relays MAY specify some of the following values. the major languages spoken on the relay. - `tags` is a list of limitations on the topics to be discussed. - For example `sfw-only` indicates hat only "Safe For Work" content + For example `sfw-only` indicates that only "Safe For Work" content is encouraged on this relay. This relies on assumptions of what the "work" "community" feels "safe" talking about. In time, a common set of tags may emerge that allow users to find relays that suit diff --git a/13.md b/13.md index cf28d86..e3662a5 100644 --- a/13.md +++ b/13.md @@ -90,4 +90,4 @@ $ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.c Delegated Proof of Work ----------------------- -Since the `NIP-01` note id does not commit to any signature, PoW can be outsourced to PoW providers, perhaps for a fee. This provides a way for clients to get their messages out to PoW-restricted relays without having to do any work themselves, which is useful for energy constrained devices like on mobile +Since the `NIP-01` note id does not commit to any signature, PoW can be outsourced to PoW providers, perhaps for a fee. This provides a way for clients to get their messages out to PoW-restricted relays without having to do any work themselves, which is useful for energy-constrained devices like mobile phones. diff --git a/22.md b/22.md index fb29e6a..2172519 100644 --- a/22.md +++ b/22.md @@ -22,7 +22,7 @@ This NIP formalizes restrictions on event timestamps as accepted by a relay and The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions. -[Replaceable events](16.md#replaceable-events) can behave rather unexpected if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. +[Replaceable events](16.md#replaceable-events) can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. A wide adoption of this NIP could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future. diff --git a/25.md b/25.md index 5ab1553..f74bcc0 100644 --- a/25.md +++ b/25.md @@ -16,7 +16,7 @@ A reaction with `content` set to `-` SHOULD be interpreted as a "dislike" or "downvote". It SHOULD NOT be counted as a "like", and MAY be displayed as a downvote or dislike on a post. A client MAY also choose to tally likes against dislikes in a reddit-like system of upvotes and downvotes, or display them as -separate tallys. +separate tallies. The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike", or the client MAY display this emoji reaction on the post. diff --git a/40.md b/40.md index 274ee80..32680db 100644 --- a/40.md +++ b/40.md @@ -43,7 +43,7 @@ Clients SHOULD ignore events that have expired. Relay Behavior -------------- -Relays MAY NOT delete an expired message immediately on expiration and MAY persist them indefinitely. +Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely. Relays SHOULD NOT send expired events to clients, even if they are stored. Relays SHOULD drop any events that are published to them if they are expired. An expiration timestamp does not affect storage of ephemeral events. diff --git a/45.md b/45.md index cd81c11..28e5e96 100644 --- a/45.md +++ b/45.md @@ -6,7 +6,7 @@ Event Counts `draft` `optional` `author:staab` -Relays may support the `COUNT` verb, which provide a mechanism for obtaining event counts. +Relays may support the `COUNT` verb, which provides a mechanism for obtaining event counts. ## Motivation diff --git a/51.md b/51.md index b4143ad..34a5def 100644 --- a/51.md +++ b/51.md @@ -10,7 +10,7 @@ A "list" event is defined as having a list of public and/or private tags. Public If a list type should only be defined once per user (like the 'Mute' list), the list type's events should follow the specification for [NIP-16 - Replaceable Events](16.md). These lists may be referred to as 'replaceable lists'. -Otherwise the list type's events should follow the specification for [NIP-33 - Parameterized Replaceable Events](33.md), where the list name will be used as the 'd' parameter. These lists may be referred to as 'parameterized replaceable lists'. +Otherwise, the list type's events should follow the specification for [NIP-33 - Parameterized Replaceable Events](33.md), where the list name will be used as the 'd' parameter. These lists may be referred to as 'parameterized replaceable lists'. ## Replaceable List Event Example diff --git a/78.md b/78.md index 175f66b..10ff535 100644 --- a/78.md +++ b/78.md @@ -8,7 +8,7 @@ Arbitrary custom app data The goal of this NIP is to enable [remoteStorage](https://remotestorage.io/)-like capabilities for custom applications that do not care about interoperability. -Even though interoperability is great, some apps do not want or do not need interoperability, and it that wouldn't make sense for them. Yet Nostr can still serve as a generalized data storage for these apps in a "bring your own database" way, for example: a user would open an app and somehow input their preferred relay for storage, which would then enable these apps to store application-specific data there. +Even though interoperability is great, some apps do not want or do not need interoperability, and it wouldn't make sense for them. Yet Nostr can still serve as a generalized data storage for these apps in a "bring your own database" way, for example: a user would open an app and somehow input their preferred relay for storage, which would then enable these apps to store application-specific data there. ## Nostr event From c7711aa8027b064b14236343dc9f287a5ecd3b2f Mon Sep 17 00:00:00 2001 From: Mike Dilger Date: Sat, 8 Apr 2023 14:13:18 +1200 Subject: [PATCH 37/89] JSON quoting (and other fixes) --- 11.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/11.md b/11.md index 1766320..a377364 100644 --- a/11.md +++ b/11.md @@ -69,18 +69,18 @@ are rejected or fail immediately. ```json { ... - limitation: { - max_message_length: 16384, - max_subscriptions: 20, - max_filters: 100, - max_limit: 5000, - max_subid_length: 100, - min_prefix: 4, - max_event_tags: 100, - max_content_length: 8196, - min_pow_difficulty: 30, - auth_required: true, - payment_required: true, + "limitation": { + "max_message_length": 16384, + "max_subscriptions": 20, + "max_filters": 100, + "max_limit": 5000, + "max_subid_length": 100, + "min_prefix": 4, + "max_event_tags": 100, + "max_content_length": 8196, + "min_pow_difficulty": 30, + "auth_required": true, + "payment_required": true, } ... } @@ -141,11 +141,11 @@ all, and preferably an error will be provided when those are received. ```json { ... - retention: [ - { kinds: [0, 1, [5, 7], [40, 49]], time: 3600 }, - { kinds: [[40000, 49999], time: 100 }, - { kinds: [[30000, 39999], count: 1000 }, - { time: 3600, count: 10000 } + "retention": [ + { "kinds": [0, 1, [5, 7], [40, 49]], "time": 3600 }, + { "kinds": [[40000, 49999]], "time": 100 }, + { "kinds": [[30000, 39999]], "count": 1000 }, + { "time": 3600, "count": 10000 } ] ... } @@ -185,7 +185,7 @@ flexibility is up to the client software. ```json { ... - relay_countries: [ 'CA', 'US' ], + "relay_countries": [ "CA", "US" ], ... } ``` @@ -208,9 +208,9 @@ To support this goal, relays MAY specify some of the following values. ```json { ... - language_tags: [ 'en', 'en-419' ], - tags: [ 'sfw-only', 'bitcoin-only', 'anime' ], - posting_policy: 'https://example.com/posting-policy.html', + "language_tags": [ "en", "en-419" ], + "tags": [ "sfw-only", "bitcoin-only", "anime" ], + "posting_policy": "https://example.com/posting-policy.html", ... } ``` @@ -245,11 +245,12 @@ Relays that require payments may want to expose their fee schedules. ```json { ... - payments_url: "https://my-relay/payments", - fees: { - "admission": [{ amount: 1000000, unit: 'msats' }], - "subscription": [{ amount: 5000000, unit: 'msats', period: 2592000 }], - "publication": [{ kinds: [4], amount: 100, unit: 'msats' }], + "payments_url": "https://my-relay/payments", + "fees": { + "admission": [{ "amount": 1000000, "unit": "msats" }], + "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], + "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], }, ... } +``` From dee546ed9ead06135522307c7effafb8e7095afd Mon Sep 17 00:00:00 2001 From: Mike Dilger Date: Sun, 9 Apr 2023 10:24:50 +1200 Subject: [PATCH 38/89] Indicate that TLVs that are not recognized or supported should be ignored --- 19.md | 1 + 1 file changed, 1 insertion(+) diff --git a/19.md b/19.md index 9d73458..91afaf7 100644 --- a/19.md +++ b/19.md @@ -66,3 +66,4 @@ These possible standardized `TLV` types are indicated here: ## Notes - `npub` keys MUST NOT be used in NIP-01 events or in NIP-05 JSON responses, only the hex format is supported there. +- When decoding a bech32-formatted string, TLVs that are not recognized or supported should be ignored, rather than causing an error. From fb5b7c739ff92cec4962990aa99c54fac9f5de81 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 9 Apr 2023 08:50:24 -0300 Subject: [PATCH 39/89] merge NIP-15 into NIP-01. --- 01.md | 5 +++-- 15.md | 21 --------------------- README.md | 3 +-- 3 files changed, 4 insertions(+), 25 deletions(-) delete mode 100644 15.md diff --git a/01.md b/01.md index 4cfdd35..8efb8ec 100644 --- a/01.md +++ b/01.md @@ -4,7 +4,7 @@ NIP-01 Basic protocol flow description ------------------------------- -`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` +`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. @@ -89,7 +89,8 @@ The `limit` property of a filter is only valid for the initial query and can be Relays can send 2 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. - * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. + * `["EOSE", ]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. + * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. This NIP defines no rules for how `NOTICE` messages should be sent or treated. diff --git a/15.md b/15.md deleted file mode 100644 index 081a97d..0000000 --- a/15.md +++ /dev/null @@ -1,21 +0,0 @@ -NIP-15 -====== - -End of Stored Events Notice ---------------------------- - -`final` `optional` `author:Semisol` - -Relays may support notifying clients when all stored events have been sent. - -If a relay supports this NIP, the relay SHOULD send the client a `EOSE` message in the format `["EOSE", ]` after it has sent all the events it has persisted and it indicates all the events that come after this message are newly published. - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports end of stored events notices. - -Motivation ----------- - -The motivation for this proposal is to reduce uncertainty when all events have been sent by a relay to make client code possibly less complex. diff --git a/README.md b/README.md index 215e5cd..ec55ab7 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh - [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events.](14.md) -- [NIP-15: End of Stored Events Notice](15.md) - [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) @@ -96,7 +95,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh |--------|---------------------------------------------------------|-------------| | EVENT | used to send events requested to clients | [1](01.md) | | NOTICE | used to send human-readable messages to clients | [1](01.md) | -| EOSE | used to notify clients all stored events have been sent | [15](15.md) | +| EOSE | used to notify clients all stored events have been sent | [1](01.md) | | OK | used to notify clients if an EVENT was successful | [20](20.md) | | AUTH | used to send authentication challenges | [42](42.md) | | COUNT | used to send requested event counts to clients | [45](45.md) | From 01f90d105d995df7308ef6bea46cc93cdef16ec3 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 9 Apr 2023 21:21:59 -0300 Subject: [PATCH 40/89] indicate optional kind TLV on nevent (@v0l). --- 19.md | 1 + 1 file changed, 1 insertion(+) diff --git a/19.md b/19.md index 91afaf7..6fc4523 100644 --- a/19.md +++ b/19.md @@ -53,6 +53,7 @@ These possible standardized `TLV` types are indicated here: - for `nevent`, _optionally_, the 32 bytes of the pubkey of the event - `3`: `kind` - for `naddr`, the 32-bit unsigned integer of the kind, big-endian + - for `nevent`, _optionally_, the 32-bit unsigned integer of the kind, big-endian ## Examples From 9d1d701285b7f6051160e8cd6890f8fe5239be70 Mon Sep 17 00:00:00 2001 From: Martin Dutra Date: Mon, 10 Apr 2023 23:40:06 -0300 Subject: [PATCH 41/89] Add links to NIP-21 --- 27.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/27.md b/27.md index 028ee5e..6d76120 100644 --- a/27.md +++ b/27.md @@ -8,11 +8,11 @@ Text Note References This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023). -When creating an event, clients should include mentions to other profiles and to other events in the middle of the `.content` using NIP-21 codes, such as `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. +When creating an event, clients should include mentions to other profiles and to other events in the middle of the `.content` using [NIP-21](21.md) codes, such as `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. Including [NIP-10](10.md)-style tags (`["e", , , ]`) for each reference is optional, clients should do it whenever they want the profile being mentioned to be notified of the mention, or when they want the referenced event to recognize their mention as a reply. -A reader client that receives an event with such `nostr:...` mentions in its `.content` can do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, NIP-21 links or direct links to web clients that will handle these references. +A reader client that receives an event with such `nostr:...` mentions in its `.content` can do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, [NIP-21](21.md) links or direct links to web clients that will handle these references. --- From 4b44453626dccd928952392fa8c6e7807b39a8ba Mon Sep 17 00:00:00 2001 From: Yoji Shidara Date: Tue, 11 Apr 2023 13:48:58 +0900 Subject: [PATCH 42/89] Fix a typo; now types are EVENT, EOSE and NOTICE --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 8efb8ec..ae13824 100644 --- a/01.md +++ b/01.md @@ -86,7 +86,7 @@ The `limit` property of a filter is only valid for the initial query and can be ### From relay to client: sending events and notices -Relays can send 2 types of messages, which must also be JSON arrays, according to the following patterns: +Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. * `["EOSE", ]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. From 9ef39553e464d1ecd656f57b615ce1aa72c39176 Mon Sep 17 00:00:00 2001 From: codytseng Date: Wed, 12 Apr 2023 23:18:22 +0800 Subject: [PATCH 43/89] feat: support counting by filters --- 45.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/45.md b/45.md index 28e5e96..87e8000 100644 --- a/45.md +++ b/45.md @@ -14,18 +14,26 @@ Some queries a client may want to execute against connected relays are prohibiti ## Filters and return values -This NIP defines a verb called `COUNT`, which accepts a subscription id and a filter as specified in [NIP 01](01.md). +This NIP defines a verb called `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md). + +``` +["COUNT", , ...] +``` Counts are returned using a `COUNT` response in the form `{count: }`. Relays may use probabilistic counts to reduce compute requirements. +``` +["COUNT", , {"count": }] +``` + Examples: ``` # Followers count -["COUNT", "", {kinds: [3], '#p': []}] -["COUNT", "", {count: 238}] +["COUNT", , {"kinds": [3], "#p": []}] +["COUNT", , {"count": 238}] # Count posts and reactions -["COUNT", "", {kinds: [1, 7], authors: []}] -["COUNT", "", {count: 5}] +["COUNT", , {"kinds": [1, 7], "authors": []}] +["COUNT", , {"count": 5}] ``` From bf0a0da6a48b96467172414d8e41dc72b0ca379c Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Thu, 13 Apr 2023 11:13:04 +0100 Subject: [PATCH 44/89] NIP-15 Nostr marketplace (#330) Co-authored-by: Andrew Camilleri Co-authored-by: Vlad Stan --- 15.md | 214 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 214 insertions(+) create mode 100644 15.md diff --git a/15.md b/15.md new file mode 100644 index 0000000..a3d105d --- /dev/null +++ b/15.md @@ -0,0 +1,214 @@ +NIP-15 +====== + +Nostr Marketplace (for resilient marketplaces) +----------------------------------- + +`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` + +> Based on https://github.com/lnbits/Diagon-Alley + +> Implemented here https://github.com/lnbits/nostrmarket + +## Terms + +- `merchant` - seller of products with NOSTR key-pair +- `customer` - buyer of products with NOSTR key-pair +- `product` - item for sale by the `merchant` +- `stall` - list of products controlled by `merchant` (a `merchant` can have multiple stalls) +- `marketplace` - clientside software for searching `stalls` and purchasing `products` + +## Nostr Marketplace Clients + +### Merchant admin + +Where the `merchant` creates, updates and deletes `stalls` and `products`, as well as where they manage sales, payments and communication with `customers`. + +The `merchant` admin software can be purely clientside, but for `convenience` and uptime, implementations will likely have a server client listening for NOSTR events. + +### Marketplace + +`Marketplace` software should be entirely clientside, either as a stand-alone app, or as a purely frontend webpage. A `customer` subscribes to different merchant NOSTR public keys, and those `merchants` `stalls` and `products` become listed and searchable. The marketplace client is like any other ecommerce site, with basket and checkout. `Marketplaces` may also wish to include a `customer` support area for direct message communication with `merchants`. + +## `Merchant` publishing/updating products (event) + +A merchant can publish these events: +| Kind | | Description | NIP | +|---------|------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------| +| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | [NIP01 ](https://github.com/nostr-protocol/nips/blob/master/01.md) | +| `30017` | `set_stall` | Create or update a stall. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | +| `30018` | `set_product` | Create or update a product. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | +| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) | +| `5 ` | `delete` | Delete a product or a stall. | [NIP05](https://github.com/nostr-protocol/nips/blob/master/05.md) | + +### Event `30017`: Create or update a stall. + +**Event Content**: +```json +{ + "id": , + "name": , + "description": , + "currency": , + "shipping": [ + { + "id": , + "name": , + "cost": , + "countries": [], + } + ] +} +``` + +Fields that are not self-explanatory: + - `shipping`: + - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone. + - shipping to different zones can have different costs. For some goods (digital for examle) the cost can be zero. + - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection. + +**Event Tags**: +```json + "tags": [["d", , + "stall_id": , + "name": , + "description": , + "images": <[String], array of image URLs, optional>, + "currency": , + "price": , + "quantity": , + "specs": [ + [ , ] + ] +} +``` + +Fields that are not self-explanatory: + - `specs`: + - an array of key pair values. It allows for the Customer UI to present present product specifications in a structure mode. It also allows comparison between products + - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` + +_Open_: better to move `spec` in the `tags` section of the event? + +**Event Tags**: +```json + "tags": [ + ["d", , + "type": 0, + "name": , + "address": + "message": ", + "contact": { + "nostr": <32-bytes hex of a pubkey>, + "phone": , + "email": , + }, + "items": [ + { + "product_id": , + "quantity": + } + ], + "shipping_id": +} + +``` + +_Open_: is `contact.nostr` required? + + +### Step 2: `merchant` request payment (event) + +Sent back from the merchant for payment. Any payment option is valid that the merchant can check. + +The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). + +`payment_options`/`type` include: + +- `url` URL to a payment page, stripe, paypal, btcpayserver, etc +- `btc` onchain bitcoin address +- `ln` bitcoin lightning invoice +- `lnurl` bitcoin lnurl-pay + +```json +{ + "id": , + "type": 1, + "message": , + "payment_options": [ + { + "type": , + "link": + }, + { + "type": , + "link": + }, + { + "type": , + "link": + } + ] +} +``` + +### Step 3: `merchant` verify payment/shipped (event) + +Once payment has been received and processed. + +The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). + +```json +{ + "id": , + "type": 2, + "message": , + "paid": , + "shipped": , +} +``` + +## Customer support events + +Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md. + +## Additional + +Standard data models can be found here here From ab93992948d1f3b8c05ef268ddc85d9f667424fa Mon Sep 17 00:00:00 2001 From: codytseng Date: Thu, 13 Apr 2023 20:31:35 +0800 Subject: [PATCH 45/89] NIP-26 allow the delegator to delete the events published by the delegatee --- 26.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/26.md b/26.md index 11468c0..b8fa902 100644 --- a/26.md +++ b/26.md @@ -101,6 +101,8 @@ The event should be considered a valid delegation if the conditions are satisfie Clients should display the delegated note as if it was published directly by the delegator (8e0d3d3e). -#### Relay & Client Querying Support +#### Relay & Client Support -Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value. \ No newline at end of file +Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value. + +Relays SHOULD allow the delegator (8e0d3d3e) to delete the events published by the delegatee (477318cf). \ No newline at end of file From ebf94668dbafe7fd2f52a77aabbd1f35bdf86bb6 Mon Sep 17 00:00:00 2001 From: Luis Miguel Date: Fri, 14 Apr 2023 10:47:36 +0200 Subject: [PATCH 46/89] nip-15 typo + micro-fix Fix for one typo and micro-improvement for a property description --- 15.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/15.md b/15.md index a3d105d..e8fe4af 100644 --- a/15.md +++ b/15.md @@ -137,13 +137,13 @@ The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips "message": ", "contact": { "nostr": <32-bytes hex of a pubkey>, - "phone": , - "email": , + "phone": , + "email": , }, "items": [ { "product_id": , - "quantity": + "quantity": } ], "shipping_id": From acaefe20fa4c9efde541ac352d9c44fe6c2fe790 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:28:03 -0300 Subject: [PATCH 47/89] Add missing tag descriptions --- README.md | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ec55ab7..9f31a36 100644 --- a/README.md +++ b/README.md @@ -106,18 +106,36 @@ When experimenting with kinds, keep in mind the classification introduced by [NI ## Standardized Tags -| name | value | other parameters | NIP | -| ---------- | ----------------------- | ----------------- | ------------------------ | -| e | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| p | pubkey (hex) | relay URL | [1](01.md) | -| a | coordinates to an event | relay URL | [33](33.md), [23](23.md) | -| r | a reference (URL, etc) | | [12](12.md) | -| t | hashtag | | [12](12.md) | -| g | geohash | | [12](12.md) | -| nonce | random | | [13](13.md) | -| subject | subject | | [14](14.md) | -| d | identifier | | [33](33.md) | -| expiration | unix timestamp (string) | | [40](40.md) | +| name | value | other parameters | NIP | +| -------------- | ------------------------------------ | -------------------- | ------------------------ | +| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | +| `d` | identifier | -- | [33](33.md) | +| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | +| `g` | geohash | -- | [12](12.md) | +| `i` | identity | proof | [39](39.md) | +| `p` | pubkey (hex) | relay URL | [1](01.md) | +| `r` | a reference (URL, etc) | -- | [12](12.md) | +| `t` | hashtag | -- | [12](12.md) | +| `amount` | millisats | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | badge description | -- | [58](58.md) | +| `description` | invoice description | -- | [57](57.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `name` | badge name | -- | [58](58.md) | +| `nonce` | random | -- | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `relay` | relay url | -- | [42](42.md) | +| `relays` | relay list | -- | [57](57.md) | +| `subject` | subject | -- | [14](14.md) | +| `summary` | article summary | -- | [23](23.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `zap` | profile name | type of value | [57](57.md) | ## Criteria for acceptance of NIPs From 6025b6fca0bb7cf7bb334365e92d7ae19f9e1d69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:28:38 -0300 Subject: [PATCH 48/89] Add reference to NIP-33 in note about kinds --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f31a36..406ad2f 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh Please update these lists when proposing NIPs introducing new event kinds. -When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md). +When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md). ## Standardized Tags From c29812001ae3b14aba1e3a913ce09e7c2fd8736f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:28:57 -0300 Subject: [PATCH 49/89] Tidy message lists --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 406ad2f..669ae3e 100644 --- a/README.md +++ b/README.md @@ -82,23 +82,25 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh ## Message types ### Client to Relay -| type | description | NIP | -|-------|-----------------------------------------------------|-------------| -| EVENT | used to publish events | [1](01.md) | -| REQ | used to request events and subscribe to new updates | [1](01.md) | -| CLOSE | used to stop previous subscriptions | [1](01.md) | -| AUTH | used to send authentication events | [42](42.md) | -| COUNT | used to request event counts | [45](45.md) | + +| type | description | NIP | +| ------- | --------------------------------------------------- | ----------- | +| `AUTH` | used to send authentication events | [42](42.md) | +| `CLOSE` | used to stop previous subscriptions | [1](01.md) | +| `COUNT` | used to request event counts | [45](45.md) | +| `EVENT` | used to publish events | [1](01.md) | +| `REQ` | used to request events and subscribe to new updates | [1](01.md) | ### Relay to Client -| type | description | NIP | -|--------|---------------------------------------------------------|-------------| -| EVENT | used to send events requested to clients | [1](01.md) | -| NOTICE | used to send human-readable messages to clients | [1](01.md) | -| EOSE | used to notify clients all stored events have been sent | [1](01.md) | -| OK | used to notify clients if an EVENT was successful | [20](20.md) | -| AUTH | used to send authentication challenges | [42](42.md) | -| COUNT | used to send requested event counts to clients | [45](45.md) | + +| type | description | NIP | +| -------- | ------------------------------------------------------- | ----------- | +| `AUTH` | used to send authentication challenges | [42](42.md) | +| `COUNT` | used to send requested event counts to clients | [45](45.md) | +| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) | +| `EVENT` | used to send events requested to clients | [1](01.md) | +| `NOTICE` | used to send human-readable messages to clients | [1](01.md) | +| `OK` | used to notify clients if an EVENT was successful | [20](20.md) | Please update these lists when proposing NIPs introducing new event kinds. From 3eb2d6e816cac7ff4a623133b1fef3c1872a2510 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:29:39 -0300 Subject: [PATCH 50/89] Extract kind ranges to their own table --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 669ae3e..b78f9dc 100644 --- a/README.md +++ b/README.md @@ -74,10 +74,15 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh | 30009 | Badge Definition | [58](58.md) | | 30023 | Long-form Content | [23](23.md) | | 30078 | Application-specific Data | [78](78.md) | -| 1000-9999 | Regular Events | [16](16.md) | -| 10000-19999 | Replaceable Events | [16](16.md) | -| 20000-29999 | Ephemeral Events | [16](16.md) | -| 30000-39999 | Parameterized Replaceable Events | [33](33.md) | + +### Event Kind Ranges + +| range | description | NIP | +| ---------------- | -------------------------------- | ----------- | +| `1000`--`9999` | Regular Events | [16](16.md) | +| `10000`--`19999` | Replaceable Events | [16](16.md) | +| `20000`--`29999` | Ephemeral Events | [16](16.md) | +| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) | ## Message types From 754bd26b188e1f7b871fcf3789db31ef14a6e826 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:29:58 -0300 Subject: [PATCH 51/89] Add missing kinds to list --- README.md | 62 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index b78f9dc..24ae2c9 100644 --- a/README.md +++ b/README.md @@ -44,36 +44,38 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document wh ## Event Kinds -| kind | description | NIP | -| ------------- | -------------------------------- | ----------- | -| 0 | Metadata | [1](01.md) | -| 1 | Short Text Note | [1](01.md) | -| 2 | Recommend Relay | [1](01.md) | -| 3 | Contacts | [2](02.md) | -| 4 | Encrypted Direct Messages | [4](04.md) | -| 5 | Event Deletion | [9](09.md) | -| 6 | Reposts | [18](18.md) | -| 7 | Reaction | [25](25.md) | -| 8 | Badge Award | [58](58.md) | -| 40 | Channel Creation | [28](28.md) | -| 41 | Channel Metadata | [28](28.md) | -| 42 | Channel Message | [28](28.md) | -| 43 | Channel Hide Message | [28](28.md) | -| 44 | Channel Mute User | [28](28.md) | -| 1984 | Reporting | [56](56.md) | -| 9734 | Zap Request | [57](57.md) | -| 9735 | Zap | [57](57.md) | -| 10000 | Mute List | [51](51.md) | -| 10001 | Pin List | [51](51.md) | -| 10002 | Relay List Metadata | [65](65.md) | -| 22242 | Client Authentication | [42](42.md) | -| 24133 | Nostr Connect | [46](46.md) | -| 30000 | Categorized People List | [51](51.md) | -| 30001 | Categorized Bookmark List | [51](51.md) | -| 30008 | Profile Badges | [58](58.md) | -| 30009 | Badge Definition | [58](58.md) | -| 30023 | Long-form Content | [23](23.md) | -| 30078 | Application-specific Data | [78](78.md) | +| kind | description | NIP | +| -------- | -------------------------- | ----------- | +| `0` | Metadata | [1](01.md) | +| `1` | Short Text Note | [1](01.md) | +| `2` | Recommend Relay | [1](01.md) | +| `3` | Contacts | [2](02.md) | +| `4` | Encrypted Direct Messages | [4](04.md) | +| `5` | Event Deletion | [9](09.md) | +| `6` | Reposts | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `1984` | Reporting | [56](56.md) | +| `9734` | Zap Request | [57](57.md) | +| `9735` | Zap | [57](57.md) | +| `10000` | Mute List | [51](51.md) | +| `10001` | Pin List | [51](51.md) | +| `10002` | Relay List Metadata | [65](65.md) | +| `22242` | Client Authentication | [42](42.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `30000` | Categorized People List | [51](51.md) | +| `30001` | Categorized Bookmark List | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30078` | Application-specific Data | [78](78.md) | ### Event Kind Ranges From 074b139a26e92262a5779be85f932e4c94412b35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:30:23 -0300 Subject: [PATCH 52/89] Add table of contents (and NIP list header) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 24ae2c9..7c002b3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ NIPs stand for **Nostr Implementation Possibilities**. They exist to document what may be implemented by [Nostr](https://github.com/fiatjaf/nostr)-compatible _relay_ and _client_ software. +--- + +- [List](#list) +- [Event Kinds](#event-kinds) + - [Event Kind Ranges](#event-kind-ranges) +- [Message Types](#message-types) + - [Client to Relay](#client-to-relay) + - [Relay to Client](#relay-to-client) +- [Standardized Tags](#standardized-tags) +- [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) +- [License](#license) + +--- + +## List + - [NIP-01: Basic protocol flow description](01.md) - [NIP-02: Contact List and Petnames](02.md) - [NIP-03: OpenTimestamps Attestations for Events](03.md) From ec884151b7ca85e3d348fa57a2188ca4e685bd44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:30:44 -0300 Subject: [PATCH 53/89] Ensure single sentence per line --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c002b3..a89f340 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # NIPs -NIPs stand for **Nostr Implementation Possibilities**. They exist to document what may be implemented by [Nostr](https://github.com/fiatjaf/nostr)-compatible _relay_ and _client_ software. +NIPs stand for **Nostr Implementation Possibilities**. +They exist to document what may be implemented by [Nostr](https://github.com/fiatjaf/nostr)-compatible _relay_ and _client_ software. --- From a07ac8c67116ced93e22d4a274156cacb4d5e019 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:31:09 -0300 Subject: [PATCH 54/89] Unrecommended notice style change --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a89f340..a3f5fc0 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) - [NIP-07: `window.nostr` capability for web browsers](07.md) -- [NIP-08: Handling Mentions](08.md) – `unrecommended`: deprecated in favor of [NIP-27](27.md) +- [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) - [NIP-09: Event Deletion](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) From 76d46b4859845a5a307f98ec32eab5d8c61abba6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Thu, 13 Apr 2023 19:33:02 -0300 Subject: [PATCH 55/89] Remove extra space --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index a3f5fc0..417a3c3 100644 --- a/README.md +++ b/README.md @@ -61,38 +61,38 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia ## Event Kinds -| kind | description | NIP | -| -------- | -------------------------- | ----------- | -| `0` | Metadata | [1](01.md) | -| `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | [1](01.md) | -| `3` | Contacts | [2](02.md) | -| `4` | Encrypted Direct Messages | [4](04.md) | -| `5` | Event Deletion | [9](09.md) | -| `6` | Reposts | [18](18.md) | -| `7` | Reaction | [25](25.md) | -| `8` | Badge Award | [58](58.md) | -| `40` | Channel Creation | [28](28.md) | -| `41` | Channel Metadata | [28](28.md) | -| `42` | Channel Message | [28](28.md) | -| `43` | Channel Hide Message | [28](28.md) | -| `44` | Channel Mute User | [28](28.md) | -| `1984` | Reporting | [56](56.md) | -| `9734` | Zap Request | [57](57.md) | -| `9735` | Zap | [57](57.md) | -| `10000` | Mute List | [51](51.md) | -| `10001` | Pin List | [51](51.md) | -| `10002` | Relay List Metadata | [65](65.md) | -| `22242` | Client Authentication | [42](42.md) | -| `24133` | Nostr Connect | [46](46.md) | -| `30000` | Categorized People List | [51](51.md) | -| `30001` | Categorized Bookmark List | [51](51.md) | -| `30008` | Profile Badges | [58](58.md) | -| `30009` | Badge Definition | [58](58.md) | -| `30017` | Create or update a stall | [15](15.md) | -| `30018` | Create or update a product | [15](15.md) | -| `30023` | Long-form Content | [23](23.md) | -| `30078` | Application-specific Data | [78](78.md) | +| kind | description | NIP | +| ------- | -------------------------- | ----------- | +| `0` | Metadata | [1](01.md) | +| `1` | Short Text Note | [1](01.md) | +| `2` | Recommend Relay | [1](01.md) | +| `3` | Contacts | [2](02.md) | +| `4` | Encrypted Direct Messages | [4](04.md) | +| `5` | Event Deletion | [9](09.md) | +| `6` | Reposts | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `1984` | Reporting | [56](56.md) | +| `9734` | Zap Request | [57](57.md) | +| `9735` | Zap | [57](57.md) | +| `10000` | Mute List | [51](51.md) | +| `10001` | Pin List | [51](51.md) | +| `10002` | Relay List Metadata | [65](65.md) | +| `22242` | Client Authentication | [42](42.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `30000` | Categorized People List | [51](51.md) | +| `30001` | Categorized Bookmark List | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30078` | Application-specific Data | [78](78.md) | ### Event Kind Ranges From 97b58ccc36a8360a099e4f905fc9bc616bc03f31 Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Fri, 14 Apr 2023 21:24:25 +0900 Subject: [PATCH 56/89] fix typos --- 15.md | 2 +- 51.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/15.md b/15.md index e8fe4af..617c011 100644 --- a/15.md +++ b/15.md @@ -64,7 +64,7 @@ A merchant can publish these events: Fields that are not self-explanatory: - `shipping`: - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone. - - shipping to different zones can have different costs. For some goods (digital for examle) the cost can be zero. + - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero. - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection. **Event Tags**: diff --git a/51.md b/51.md index 34a5def..80cc09e 100644 --- a/51.md +++ b/51.md @@ -97,11 +97,11 @@ Then the user would create a 'Categorized People' list event like below: ### Mute List -An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standarized tag can be included in a Mute List. +An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List. ### Pin List -An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standarized tag can be included in a Pin List. +An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standardized tag can be included in a Pin List. ### Categorized People List @@ -109,4 +109,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standarized tag can be included in a Categorized Bookmarks List. +An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List. From 45b539d5d502fd0b42c51b209464495d8c45cc95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariano=20P=C3=A9rez=20Rodr=C3=ADguez?= Date: Fri, 14 Apr 2023 19:57:52 -0300 Subject: [PATCH 57/89] Apply changes alluded to in https://github.com/nostr-protocol/nips/pull/443 --- README.md | 61 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 417a3c3..836a593 100644 --- a/README.md +++ b/README.md @@ -132,36 +132,37 @@ When experimenting with kinds, keep in mind the classification introduced by [NI ## Standardized Tags -| name | value | other parameters | NIP | -| -------------- | ------------------------------------ | -------------------- | ------------------------ | -| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | -| `d` | identifier | -- | [33](33.md) | -| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| `g` | geohash | -- | [12](12.md) | -| `i` | identity | proof | [39](39.md) | -| `p` | pubkey (hex) | relay URL | [1](01.md) | -| `r` | a reference (URL, etc) | -- | [12](12.md) | -| `t` | hashtag | -- | [12](12.md) | -| `amount` | millisats | -- | [57](57.md) | -| `bolt11` | `bolt11` invoice | -- | [57](57.md) | -| `challenge` | challenge string | -- | [42](42.md) | -| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | badge description | -- | [58](58.md) | -| `description` | invoice description | -- | [57](57.md) | -| `expiration` | unix timestamp (string) | -- | [40](40.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | -| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `name` | badge name | -- | [58](58.md) | -| `nonce` | random | -- | [13](13.md) | -| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | -| `published_at` | unix timestamp (string) | -- | [23](23.md) | -| `relay` | relay url | -- | [42](42.md) | -| `relays` | relay list | -- | [57](57.md) | -| `subject` | subject | -- | [14](14.md) | -| `summary` | article summary | -- | [23](23.md) | -| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | -| `title` | article title | -- | [23](23.md) | -| `zap` | profile name | type of value | [57](57.md) | +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | -------------------- | ------------------------ | +| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | +| `d` | identifier | -- | [33](33.md) | +| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | +| `g` | geohash | -- | [12](12.md) | +| `i` | identity | proof | [39](39.md) | +| `p` | pubkey (hex) | relay URL | [1](01.md) | +| `r` | a reference (URL, etc) | -- | [12](12.md) | +| `t` | hashtag | -- | [12](12.md) | +| `amount` | millisats | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | badge description | -- | [58](58.md) | +| `description` | invoice description | -- | [57](57.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `name` | badge name | -- | [58](58.md) | +| `nonce` | random | -- | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `relay` | relay url | -- | [42](42.md) | +| `relays` | relay list | -- | [57](57.md) | +| `subject` | subject | -- | [14](14.md) | +| `summary` | article summary | -- | [23](23.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `zap` | profile name | type of value | [57](57.md) | ## Criteria for acceptance of NIPs From a8e083d6d8e1fa0176bc5cfe96427ac37e4d6046 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Sun, 16 Apr 2023 00:25:53 +0300 Subject: [PATCH 58/89] NIP-09: Fix some things --- 09.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/09.md b/09.md index b0febc7..89781fb 100644 --- a/09.md +++ b/09.md @@ -27,13 +27,13 @@ For example: } ``` -Relays SHOULD delete or stop publishing any referenced events that have an identical `id` as the deletion request. Clients SHOULD hide or otherwise indicate a deletion status for referenced events. +Relays SHOULD delete or stop publishing any referenced events that have an identical `pubkey` as the deletion request. Clients SHOULD hide or otherwise indicate a deletion status for referenced events. 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. ## Client Usage -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 event's own content, although a user interface should clearly indicate that this is a deletion reason, not the original content. +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. A client MUST validate that each event `pubkey` referenced in the `e` tag of the deletion request is identical to the deletion request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative. From e1cda356a0d441875b9eafbc1e8769bb40648da1 Mon Sep 17 00:00:00 2001 From: Martin Dutra Date: Mon, 17 Apr 2023 15:20:25 -0300 Subject: [PATCH 59/89] Update 21.md Add link to NIP-19 --- 21.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/21.md b/21.md index 2525bf1..bfbb3ae 100644 --- a/21.md +++ b/21.md @@ -10,7 +10,7 @@ This NIP standardizes the usage of a common URL scheme for maximum interoperabil The scheme is `nostr:`. -The identifiers that come after are expected to be the same as those defined in NIP-19 (except `nsec`). +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`). ## Examples From b315d1adb7acb0a7465c5a5d9fefc8c2db45dfa6 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 19 Apr 2023 22:32:08 +0900 Subject: [PATCH 60/89] Update 08.md Add link to NIP-27. --- 08.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/08.md b/08.md index fb87b53..6793e0b 100644 --- a/08.md +++ b/08.md @@ -1,4 +1,4 @@ -> __Warning__ `unrecommended`: deprecated in favor of NIP-27 +> __Warning__ `unrecommended`: deprecated in favor of [NIP-27](27.md) NIP-08 ====== From a090de2b90f9fd83e49fa39ff4c7ef52750e904b Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:01:19 +0000 Subject: [PATCH 61/89] create draft NIP 94 and 95 --- 94.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 95.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 94.md create mode 100644 95.md diff --git a/94.md b/94.md new file mode 100644 index 0000000..06b03c8 --- /dev/null +++ b/94.md @@ -0,0 +1,43 @@ +NIP-94 - File Header +====== +`draft` `optional` `author:frbitten` + +The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. +Also the goal is to create a base on the protocol for this bountsr "Filesharing App" (https://bountsr.org/p2p-filesharing/) to be implemented. + +Nostr event +------------------ +This NIP specifies the use of the `30063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: +* `d` containing the name of the shared file to allow it to be overwritten in the future. +* `url` the url to download the file +* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file + +```json +{ + "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": 30063, + "tags": [ + ["d", ], + ["url",], + ["decrypt",,], + ["p", <32-bytes hex of a pubkey>, ], + ], + "content": "A beautiful picture of a wild toucan", + "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> +} + +Client Behavior +--------------- +The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: +To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image + +Suggested Use Cases +------------------- +* A relay for indexing shared files. For example to promote torrents +* A Pinterest-like relay and app where people can share their portfolio and inspire others. +* A simple way to distribute configurations and software updates. +* Specialized relays can provide collections of emojis, memes and animated gifs to be used in notes. diff --git a/95.md b/95.md new file mode 100644 index 0000000..680496c --- /dev/null +++ b/95.md @@ -0,0 +1,35 @@ +NIP-95 Base64 File +====== +`draft` `optional` `author:frbitten` + +This NIP allows users to send binary data to be stored in the relay. This data can be small pieces of information or even large files. + +Nostr event +------------------ +This NIP specifies the use of the `30064` event type (parameterized replaceable event), having in `content` the binary data that you want to be stored in Base64 format. +* `d` containing the name of the shared file to allow it to be overwritten in the future. +* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file + +This event must not be returned in generic searches. It should only be returned if specifically requested by your ID. This avoids bandwidth consumption and unnecessary overload on the relay and client. + +The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag referencing the event id, without having to send the full event which can be a lot of data. + +Relay Behavior +--------------- +Relays that use a relational database may have more difficulty implementing this NIP, but a possible solution is for this NIP not to be recorded in the database, but on disk, the file name being the event id. So it can be easily found and searched. And because it is not in the database, it does not interfere with the indexing of common events. + +Another solution is for Relays that want to implement this functionality and use a No-SQL database with mongodb that already supports large documents without harming performance. + +The relay can allow access to this data via URL, having its own URL pattern for these cases. And if you receive a `NIP-94` referring to a `NIP-95` you can include the URL in the proper `NIP-94` tag + +Client Behavior +--------------- +The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. + +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image + +Suggested Use Cases +------------------- +* Provide file storage service that is quickly integrable with nostr clients. +* Create an application similar to pinterest without the need for other protocols. From 342722963b5d6716410166c8e02d7d0b7cabb0f3 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:04:57 +0000 Subject: [PATCH 62/89] fixed json schema --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 06b03c8..0798d74 100644 --- a/94.md +++ b/94.md @@ -25,7 +25,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], ], - "content": "A beautiful picture of a wild toucan", + "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } From 0ef5486e569f3e9888cab1030edea96785c360e1 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:05:07 +0000 Subject: [PATCH 63/89] add json schema --- 95.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/95.md b/95.md index 680496c..ffb3906 100644 --- a/95.md +++ b/95.md @@ -15,6 +15,21 @@ This event must not be returned in generic searches. It should only be returned The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag referencing the event id, without having to send the full event which can be a lot of data. +```json +{ + "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": 30064, + "tags": [ + ["d", ], + ["decrypt",,], + ["p", <32-bytes hex of a pubkey>, ], + ], + "content": , + "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> +} + Relay Behavior --------------- Relays that use a relational database may have more difficulty implementing this NIP, but a possible solution is for this NIP not to be recorded in the database, but on disk, the file name being the event id. So it can be easily found and searched. And because it is not in the database, it does not interfere with the indexing of common events. From 8ea7c51f9b4fd81e4f5e390881bff43243455d16 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:08:52 +0000 Subject: [PATCH 64/89] add hash tag --- 94.md | 1 + 95.md | 1 + 2 files changed, 2 insertions(+) diff --git a/94.md b/94.md index 0798d74..7712171 100644 --- a/94.md +++ b/94.md @@ -24,6 +24,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["url",], ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], + ["hash",< SHA256 hexencoded string of the file> ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> diff --git a/95.md b/95.md index ffb3906..4c2dde8 100644 --- a/95.md +++ b/95.md @@ -25,6 +25,7 @@ The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag ["d", ], ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], + ["hash",< SHA256 hexencoded string of the raw data>] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From d212622ed113b9c19bab160c484c3c25fba6131f Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:04:00 +0000 Subject: [PATCH 65/89] fix format text in md --- 94.md | 3 ++- 95.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 7712171..feead69 100644 --- a/94.md +++ b/94.md @@ -29,11 +29,12 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } +``` Client Behavior --------------- The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: ![example](https://ibb.co/Fnj5TMg) To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases diff --git a/95.md b/95.md index 4c2dde8..755471f 100644 --- a/95.md +++ b/95.md @@ -30,6 +30,7 @@ The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } +``` Relay Behavior --------------- @@ -43,7 +44,7 @@ Client Behavior --------------- The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: ![example](https://ibb.co/Fnj5TMg). To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases ------------------- From 64797e7910a7dd143c22c28d29e7d6108db806b3 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:07:49 +0000 Subject: [PATCH 66/89] fix example image --- 94.md | 2 +- 95.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index feead69..5f5a14a 100644 --- a/94.md +++ b/94.md @@ -34,7 +34,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable Client Behavior --------------- The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: ![example](https://ibb.co/Fnj5TMg) +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases diff --git a/95.md b/95.md index 755471f..3653f2b 100644 --- a/95.md +++ b/95.md @@ -44,7 +44,7 @@ Client Behavior --------------- The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: ![example](https://ibb.co/Fnj5TMg). To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases ------------------- From 475bcb6314beafb29e480f70a114947e7c301776 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:09:38 +0000 Subject: [PATCH 67/89] minor fix --- 94.md | 3 ++- 95.md | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 5f5a14a..4963f85 100644 --- a/94.md +++ b/94.md @@ -34,7 +34,8 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable Client Behavior --------------- The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. +Example: To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases diff --git a/95.md b/95.md index 3653f2b..16536ab 100644 --- a/95.md +++ b/95.md @@ -44,7 +44,9 @@ Client Behavior --------------- The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc. +Example: . +To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases ------------------- From ac515573a0cf039174e850dd60ed79a60487cc2e Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:11:55 +0000 Subject: [PATCH 68/89] ajusts formt text --- 94.md | 6 +++++- 95.md | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index 4963f85..1b5d8db 100644 --- a/94.md +++ b/94.md @@ -33,11 +33,15 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable Client Behavior --------------- -The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings +The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings. + It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. + Example: + To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image + Suggested Use Cases ------------------- * A relay for indexing shared files. For example to promote torrents diff --git a/95.md b/95.md index 16536ab..6f7612f 100644 --- a/95.md +++ b/95.md @@ -45,7 +45,9 @@ Client Behavior The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc. + Example: . + To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases From 9d69bd05dcdaa1ee19078937a6150e2720bf9ba5 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:15:01 +0000 Subject: [PATCH 69/89] ajusts decrypt tag --- 94.md | 2 +- 95.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 1b5d8db..51ec1e2 100644 --- a/94.md +++ b/94.md @@ -22,7 +22,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "tags": [ ["d", ], ["url",], - ["decrypt",,], + ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], ["hash",< SHA256 hexencoded string of the file> ], diff --git a/95.md b/95.md index 6f7612f..292d04c 100644 --- a/95.md +++ b/95.md @@ -23,7 +23,7 @@ The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag "kind": 30064, "tags": [ ["d", ], - ["decrypt",,], + ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], ["hash",< SHA256 hexencoded string of the raw data>] ], From 747517f2c462ad603ee5b0b75c20693ef3913363 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:18:53 +0000 Subject: [PATCH 70/89] ajusts description of decrypt tag --- 94.md | 2 +- 95.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 51ec1e2..7051ee6 100644 --- a/94.md +++ b/94.md @@ -11,7 +11,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable * `d` containing the name of the shared file to allow it to be overwritten in the future. * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file ```json { diff --git a/95.md b/95.md index 292d04c..00132df 100644 --- a/95.md +++ b/95.md @@ -9,7 +9,7 @@ Nostr event This NIP specifies the use of the `30064` event type (parameterized replaceable event), having in `content` the binary data that you want to be stored in Base64 format. * `d` containing the name of the shared file to allow it to be overwritten in the future. * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file This event must not be returned in generic searches. It should only be returned if specifically requested by your ID. This avoids bandwidth consumption and unnecessary overload on the relay and client. From 564d06b8a213073e59195f56141b1e8f01903639 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 11:06:15 +0000 Subject: [PATCH 71/89] move nip-95 to other branch --- 95.md | 56 -------------------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 95.md diff --git a/95.md b/95.md deleted file mode 100644 index 00132df..0000000 --- a/95.md +++ /dev/null @@ -1,56 +0,0 @@ -NIP-95 Base64 File -====== -`draft` `optional` `author:frbitten` - -This NIP allows users to send binary data to be stored in the relay. This data can be small pieces of information or even large files. - -Nostr event ------------------- -This NIP specifies the use of the `30064` event type (parameterized replaceable event), having in `content` the binary data that you want to be stored in Base64 format. -* `d` containing the name of the shared file to allow it to be overwritten in the future. -* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file - -This event must not be returned in generic searches. It should only be returned if specifically requested by your ID. This avoids bandwidth consumption and unnecessary overload on the relay and client. - -The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag referencing the event id, without having to send the full event which can be a lot of data. - -```json -{ - "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, - "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": , - "kind": 30064, - "tags": [ - ["d", ], - ["decrypt",,], - ["p", <32-bytes hex of a pubkey>, ], - ["hash",< SHA256 hexencoded string of the raw data>] - ], - "content": , - "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> -} -``` - -Relay Behavior ---------------- -Relays that use a relational database may have more difficulty implementing this NIP, but a possible solution is for this NIP not to be recorded in the database, but on disk, the file name being the event id. So it can be easily found and searched. And because it is not in the database, it does not interfere with the indexing of common events. - -Another solution is for Relays that want to implement this functionality and use a No-SQL database with mongodb that already supports large documents without harming performance. - -The relay can allow access to this data via URL, having its own URL pattern for these cases. And if you receive a `NIP-94` referring to a `NIP-95` you can include the URL in the proper `NIP-94` tag - -Client Behavior ---------------- -The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. - -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc. - -Example: . - -To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image - -Suggested Use Cases -------------------- -* Provide file storage service that is quickly integrable with nostr clients. -* Create an application similar to pinterest without the need for other protocols. From 2b8f12caab99f465785d17e5ac3532e52ca9c93e Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:29:22 +0000 Subject: [PATCH 72/89] Update 94.md suggestion by arthurfranca Co-authored-by: arthurfranca --- 94.md | 1 - 1 file changed, 1 deletion(-) diff --git a/94.md b/94.md index 7051ee6..21eefc9 100644 --- a/94.md +++ b/94.md @@ -8,7 +8,6 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ This NIP specifies the use of the `30063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: -* `d` containing the name of the shared file to allow it to be overwritten in the future. * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file From fddce814a37e66ba9eaf1f1f1f089ce7761309ec Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:29:55 +0000 Subject: [PATCH 73/89] Update 94.md change tag hash with suggestion by arthurfranca Co-authored-by: arthurfranca --- 94.md | 1 + 1 file changed, 1 insertion(+) diff --git a/94.md b/94.md index 21eefc9..13cd231 100644 --- a/94.md +++ b/94.md @@ -11,6 +11,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file +* `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". ```json { From 6b9d93c2857dd4714675543f45e7f55a653d1ff5 Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:31:22 +0000 Subject: [PATCH 74/89] Update 94.md change hash tag with suggestion by arthutfranca Co-authored-by: arthurfranca --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 13cd231..13315e0 100644 --- a/94.md +++ b/94.md @@ -24,7 +24,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["url",], ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], - ["hash",< SHA256 hexencoded string of the file> + ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", "blurhash"] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From 088c3bba1d730dcc80b376153288f918005ca3ce Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:34:04 +0000 Subject: [PATCH 75/89] Update 94.md fixed by arthurfranca Co-authored-by: arthurfranca --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 13315e0..81e2bf2 100644 --- a/94.md +++ b/94.md @@ -23,7 +23,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["d", ], ["url",], ["decrypt",,], - ["p", <32-bytes hex of a pubkey>, ], + ["type", "image/webp"], ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", "blurhash"] ], "content": , From 40fa44b0fc0f358995bf8c162087a11173d912cc Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:34:21 +0000 Subject: [PATCH 76/89] Update 94.md change to regular event Co-authored-by: arthurfranca --- 94.md | 1 - 1 file changed, 1 deletion(-) diff --git a/94.md b/94.md index 81e2bf2..dfc77d9 100644 --- a/94.md +++ b/94.md @@ -20,7 +20,6 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "created_at": , "kind": 30063, "tags": [ - ["d", ], ["url",], ["decrypt",,], ["type", "image/webp"], From bd32adfc2aba90b3a3e486c7b856c93480301992 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 17 Mar 2023 13:41:46 +0000 Subject: [PATCH 77/89] change to regular event --- 94.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/94.md b/94.md index dfc77d9..533b49c 100644 --- a/94.md +++ b/94.md @@ -7,7 +7,7 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ -This NIP specifies the use of the `30063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: +This NIP specifies the use of the `1063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file @@ -18,12 +18,12 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": 30063, + "kind": 1063, "tags": [ ["url",], ["decrypt",,], - ["type", "image/webp"], - ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", "blurhash"] + ["type", ], + ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", <"blurhash" or "sha256">] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From f766a850cd6cc72f35681906b519031745cbc5a8 Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Tue, 28 Mar 2023 09:57:56 +0100 Subject: [PATCH 78/89] Apply suggestions from code review add sugestion of arthurfranca and nryo-o Co-authored-by: arthurfranca Co-authored-by: Ryo_o <127748188+nryo-o@users.noreply.github.com> --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 533b49c..005ef26 100644 --- a/94.md +++ b/94.md @@ -8,7 +8,7 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ This NIP specifies the use of the `1063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: -* `url` the url to download the file +* `r` the url to download the file, without trailing slash * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file * `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". @@ -20,7 +20,7 @@ This NIP specifies the use of the `1063` event type (parameterized replaceable e "created_at": , "kind": 1063, "tags": [ - ["url",], + ["r",], ["decrypt",,], ["type", ], ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", <"blurhash" or "sha256">] From bfd2a0fc38f85371a85f47891565f410ed0af48f Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Wed, 5 Apr 2023 15:11:59 +0100 Subject: [PATCH 79/89] fixed text description --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 005ef26..78c7056 100644 --- a/94.md +++ b/94.md @@ -7,8 +7,8 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ -This NIP specifies the use of the `1063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: -* `r` the url to download the file, without trailing slash +This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: +* `r` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file * `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". From 34af61df41f7e6c7668cd2c6fbce17042503751e Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Wed, 12 Apr 2023 14:03:52 +0100 Subject: [PATCH 80/89] nip update to reach consensus with other nips --- 94.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/94.md b/94.md index 78c7056..5c12565 100644 --- a/94.md +++ b/94.md @@ -8,10 +8,14 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: -* `r` the url to download the file -* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file -* `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". +* `url` the url to download the file +* `m` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits +* `x` containing the SHA-256 hexencoded string of the file. +* `size` (optional) size of file in bytes +* `magnet` (optional) URI to magnet file +* `i` (optional) torrent infohash +* `blurhash`(optional) for cosmetic purposes ```json { @@ -20,10 +24,14 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr "created_at": , "kind": 1063, "tags": [ - ["r",], - ["decrypt",,], - ["type", ], - ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", <"blurhash" or "sha256">] + ["url",], + ["aes-256-gcm",, ], + ["m", ], + ["x",], + ["size", ], + ["magnet", ], + ["i",], + ["blurhash", ] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From 92536d8b562d20a37aee92fc4e001937845f4ae7 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 21 Apr 2023 00:45:35 +0900 Subject: [PATCH 81/89] Add NIP-94 and kind 1063 to README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 836a593..d47bf76 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) +- [NIP-94: File Header](94.md) ## Event Kinds @@ -77,6 +78,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `1063` | File Header | [94](94.md) | | `1984` | Reporting | [56](56.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | From 4b9847802a9fb1a6d13b3967976bca78b5eacb0c Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Fri, 21 Apr 2023 13:04:48 +0900 Subject: [PATCH 82/89] fix: re-add NIP-15 to the list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d47bf76..fb0ddb7 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events.](14.md) +- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) - [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) From c5f43a8f9047184258f0e59f3e1fcd759acca4e2 Mon Sep 17 00:00:00 2001 From: michaelhall923 Date: Fri, 21 Apr 2023 09:04:20 -0400 Subject: [PATCH 83/89] Update 01.md Info on "e" and "p" tags is kind of hard to find so I added a link to it in the place that I intuitively looked for it. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index ae13824..a07a0df 100644 --- a/01.md +++ b/01.md @@ -107,5 +107,5 @@ A relay may choose to treat different message kinds differently, and it may or m ## Other Notes: - Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. +- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](https://github.com/nostr-protocol/nips/blob/127d5518bfa9a4e4e7510490c0b8d95e342dfa4b/10.md) for a detailed description of "e" and "p" tags. - The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. From bf8f8e2708ad8bd45c60429c161c0706f8cfdf14 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Mon, 24 Apr 2023 16:41:00 +0530 Subject: [PATCH 84/89] blurhash explanation --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 5c12565..87b0f3a 100644 --- a/94.md +++ b/94.md @@ -15,7 +15,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `size` (optional) size of file in bytes * `magnet` (optional) URI to magnet file * `i` (optional) torrent infohash -* `blurhash`(optional) for cosmetic purposes +* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client ```json { From 5d0cbcbebfde5b3a32bf8c6fda12cfde40c1bb65 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Mon, 24 Apr 2023 14:57:37 -0300 Subject: [PATCH 85/89] reword NIP-94 to remove confusion. --- 94.md | 36 ++++++++++++++---------------------- README.md | 2 +- 2 files changed, 15 insertions(+), 23 deletions(-) diff --git a/94.md b/94.md index 87b0f3a..d29548e 100644 --- a/94.md +++ b/94.md @@ -1,13 +1,17 @@ -NIP-94 - File Header +NIP-94 ====== -`draft` `optional` `author:frbitten` -The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. -Also the goal is to create a base on the protocol for this bountsr "Filesharing App" (https://bountsr.org/p2p-filesharing/) to be implemented. +File Metadata +------------- + +`draft` `optional` `author:frbitten` `author:kieran` `author:lovvtide` `author:fiatjaf` + +The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with kind:1 notes or by longform clients that deal with kind:30023 articles. + +## Event format -Nostr event ------------------- This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: + * `url` the url to download the file * `m` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits @@ -15,7 +19,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `size` (optional) size of file in bytes * `magnet` (optional) URI to magnet file * `i` (optional) torrent infohash -* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client +* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client ```json { @@ -38,20 +42,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr } ``` -Client Behavior ---------------- -The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings. +## Suggested use cases -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. - -Example: - -To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image - - -Suggested Use Cases -------------------- -* A relay for indexing shared files. For example to promote torrents -* A Pinterest-like relay and app where people can share their portfolio and inspire others. +* A relay for indexing shared files. For example, to promote torrents. +* A pinterest-like client where people can share their portfolio and inspire others. * A simple way to distribute configurations and software updates. -* Specialized relays can provide collections of emojis, memes and animated gifs to be used in notes. diff --git a/README.md b/README.md index fb0ddb7..0a00d0e 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) -- [NIP-94: File Header](94.md) +- [NIP-94: File Metadata](94.md) ## Event Kinds From 6fb9e54f7b4886272f7464aba2f0971543d8df40 Mon Sep 17 00:00:00 2001 From: arkin0x <99223753+arkin0x@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:34:02 -0500 Subject: [PATCH 86/89] example was incorrect the example event id had 21 leading zeroes, not 20 I provided new C code that has been tested to work (I couldn't get the original example code to work) and I provided some JavaScript code to test event ids as well. I did not re-compute the event id for the example event; I simply changed the nonce to be 21. Since it is an example, it may not matter that the event id is not correct. --- 13.md | 72 ++++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 51 insertions(+), 21 deletions(-) diff --git a/13.md b/13.md index e3662a5..2c60929 100644 --- a/13.md +++ b/13.md @@ -10,6 +10,8 @@ This NIP defines a way to generate and interpret Proof of Work for nostr notes. `difficulty` is defined to be the number of leading zero bits in the `NIP-01` id. For example, an id of `000000000e9d97a1ab09fc381030b346cdd7a142ad57e6df0b46dc9bef6c7e2d` has a difficulty of `36` with `36` leading 0 bits. +`002f...` is `0000 0000 0010 1111...` in binary, which has 10 leading zeroes. Do not forget to count leading zeroes for hex digits <= `7`. + Mining ------ @@ -36,7 +38,7 @@ Example mined note [ "nonce", "776797", - "20" + "21" ] ], "content": "It's just me mining my own business", @@ -47,33 +49,61 @@ Example mined note Validating ---------- -Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr note id: +Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id: ```c -int zero_bits(unsigned char b) -{ - int n = 0; +#include +#include +#include - if (b == 0) - return 8; +int countLeadingZeroes(const char *hex) { + int count = 0; - while (b >>= 1) - n++; + for (int i = 0; i < strlen(hex); i++) { + int nibble = (int)strtol((char[]){hex[i], '\0'}, NULL, 16); + if (nibble == 0) { + count += 4; + } else { + count += __builtin_clz(nibble) - 28; + break; + } + } - return 7-n; + return count; } -/* find the number of leading zero bits in a hash */ -int count_leading_zero_bits(unsigned char *hash) -{ - int bits, total, i; - for (i = 0, total = 0; i < 32; i++) { - bits = zero_bits(hash[i]); - total += bits; - if (bits != 8) - break; - } - return total; +int main(int argc, char *argv[]) { + if (argc != 2) { + fprintf(stderr, "Usage: %s \n", argv[0]); + return 1; + } + + const char *hex_string = argv[1]; + int result = countLeadingZeroes(hex_string); + printf("Leading zeroes in hex string %s: %d\n", hex_string, result); + + return 0; +} +``` + +Here is some JavaScript code for doing the same thing: + +```javascript +// hex should be a hexadecimal string (with no 0x prefix) +function countLeadingZeroes(hex) { + let count = 0; + + for (let i = 0; i < hex.length; i++) { + const nibble = parseInt(hex[i], 16); + if (nibble === 0) { + count += 4; + } else { + count += Math.clz32(nibble) - 28; + break; + } + } + + return count; } ``` From 61475db6f43068c535b275ef48e0faecf461ac76 Mon Sep 17 00:00:00 2001 From: arkin0x <99223753+arkin0x@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:43:15 -0500 Subject: [PATCH 87/89] forgot to update the initial nonce in the explanation --- 13.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/13.md b/13.md index 2c60929..360bde6 100644 --- a/13.md +++ b/13.md @@ -18,7 +18,7 @@ Mining To generate PoW for a `NIP-01` note, a `nonce` tag is used: ```json -{"content": "It's just me mining my own business", "tags": [["nonce", "1", "20"]]} +{"content": "It's just me mining my own business", "tags": [["nonce", "1", "21"]]} ``` When mining, the second entry to the nonce tag is updated, and then the id is recalculated (see [NIP-01](./01.md)). If the id has the desired number of leading zero bits, the note has been mined. It is recommended to update the `created_at` as well during this process. From badabd513e659964d5fb357fab97dd8319acc98a Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 25 Apr 2023 18:23:32 +0900 Subject: [PATCH 88/89] Reword description of kind 1063 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a00d0e..e7c8914 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | -| `1063` | File Header | [94](94.md) | +| `1063` | File Metadata | [94](94.md) | | `1984` | Reporting | [56](56.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | From 346036208ccca6f31313f1e909ff17ea3563fb46 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Fri, 28 Apr 2023 10:21:18 -0500 Subject: [PATCH 89/89] Add dim tag to NIP 94 --- 94.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index d29548e..24dd346 100644 --- a/94.md +++ b/94.md @@ -4,7 +4,7 @@ NIP-94 File Metadata ------------- -`draft` `optional` `author:frbitten` `author:kieran` `author:lovvtide` `author:fiatjaf` +`draft` `optional` `author:frbitten` `author:kieran` `author:lovvtide` `author:fiatjaf` `author:staab` The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with kind:1 notes or by longform clients that deal with kind:30023 articles. @@ -17,6 +17,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the file. * `size` (optional) size of file in bytes +* `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file * `i` (optional) torrent infohash * `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client @@ -33,6 +34,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["m", ], ["x",], ["size", ], + ["dim", ], ["magnet", ], ["i",], ["blurhash", ]