From 1c728516dfdc7508ce27eda222bde78466e3457d Mon Sep 17 00:00:00 2001 From: VictorieeMan <59509525+VictorieeMan@users.noreply.github.com> Date: Sat, 7 Jan 2023 11:11:19 +0100 Subject: [PATCH 001/314] NIP-05: Fixed some typos line 9: Added a hyphen line 53: Fixed the typo by a context appropriate reformulation. line 67: Removed an "are" line 79: Added a comma Great project, looking forward to more nostr :) --- 05.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/05.md b/05.md index a67f530e..56b9156b 100644 --- a/05.md +++ b/05.md @@ -6,7 +6,7 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` `author:fiatjaf` `author:mikedilger` -On events of kind `0` (`set_metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case insensitive. +On events of kind `0` (`set_metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. Upon seeing that, the client splits the identifier into `` and `` and use these values to make a GET request to `https:///.well-known/nostr.json?name=`. @@ -50,7 +50,7 @@ or with the **optional** `"relays"` attribute: If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed. -The optional `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays a that user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available. +The optional `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays the specific user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available. ## Finding users from their NIP-05 identifier @@ -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 @@ -76,7 +76,7 @@ Clients may treat the identifier `_@domain` as the "root" identifier, and choose ### Reasoning for the `/.well-known/nostr.json?name=` format -By adding the `` as a query string instead of as part of the path the protocol can support both dynamic servers that can generate JSON on-demand and static servers with a JSON file in it that may contain multiple names. +By adding the `` as a query string instead of as part of the path, the protocol can support both dynamic servers that can generate JSON on-demand and static servers with a JSON file in it that may contain multiple names. ### Allowing access from JavaScript apps From e1004d3d4bca4542f1862886b20c6a1c8b4d9e0b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Mar 2023 08:06:33 -0300 Subject: [PATCH 002/314] 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 45081b0e..9d73458d 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 003/314] Update 46.md --- 46.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/46.md b/46.md index 6589fc00..90fa1a06 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 004/314] add NOTICE optional subscription_id --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 0e68de5e..eead9664 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 005/314] 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 eead9664..9f60a1d5 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 006/314] 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 9f60a1d5..4cfdd359 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 007/314] 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 8cdb85e4..a8386ba3 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 008/314] Add doc-hex as author --- 11.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/11.md b/11.md index a8386ba3..c5383262 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 009/314] Add cameri as author --- 11.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/11.md b/11.md index c5383262..f97193c2 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 010/314] 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 113cb539..d82787db 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 00000000..b2d1e5aa --- /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 37b2fe44..d93f5c2d 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 011/314] 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 b2d1e5aa..237feaaf 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 d93f5c2d..6642e926 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 012/314] Replace specific client url --- 27.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/27.md b/27.md index 237feaaf..26e29af8 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 013/314] 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 d82787db..2ab2b8fc 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 6642e926..9390916a 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 014/314] Improve the text --- 27.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/27.md b/27.md index 26e29af8..235b4a59 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 015/314] Added NIP-04 metadata leak warning --- 04.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/04.md b/04.md index f34d09ba..60ec5e04 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 016/314] 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 bbeb629d..79f167c6 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 017/314] Mention other nostr identifiers --- 27.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/27.md b/27.md index 235b4a59..f4e4629d 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 018/314] 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 2ab2b8fc..fb87b536 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 f4e4629d..e78058ab 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 019/314] 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 0648a354..5bf20cdb 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 020/314] 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 5bf20cdb..151a31b5 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 021/314] 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 80a6b3d9..4d9481d4 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 60f3da66..10681fac 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 022/314] Fix typo in NIP-27 --- 27.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/27.md b/27.md index e78058ab..028ee5ea 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 023/314] 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 00000000..365de9c3 --- /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 9390916a..947ca702 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 024/314] 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 365de9c3..ef77fa66 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 947ca702..ba78113d 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 025/314] 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 00000000..2c3c4ae0 --- /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 ba78113d..741a2883 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 e2f088286fcd324bb4754dcdf5ff10f4dc823b5b Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Thu, 30 Mar 2023 00:35:13 +0300 Subject: [PATCH 026/314] NIP-47 Wallet Connect --- 47.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 47.md diff --git a/47.md b/47.md new file mode 100644 index 00000000..326100de --- /dev/null +++ b/47.md @@ -0,0 +1,112 @@ +NIP-47 +====== + +Nostr Wallet Connect +-------------------- + +`draft` `optional` `author:kiwiidb` `author:bumi` `author:semisol` `author:vitorpamplona` + +## Rationale + +Paying zaps should be possible without the user needing to open a different app to only pay a Lightning invoice. +This NIP describes a way for users to control a remote Lightning node or a custodial Lightning wallet. When self-hosting, this setup does not require the user to run their own server, thereby bypassing certain hurdles that are commonly encountered when trying to connect to a Lightning node remotely. + +## Terms + +* **client**: Nostr app on any platform that wants to pay Lightning invoices +* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). + +## Events + +There are two event kinds: +- `NIP-47 request`: 23194 +- `NIP-47 response`: 23195 + +Both the request and response events SHOULD only contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **client** if this is a response. + +The content is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON object. The content depends on the kind. + +Request: +```jsonc +{ + "cmd": "pay_invoice", // command, string + "data": { // data, object + "invoice": "lnbc50n1..." // command-related data + } +} +``` + +Response: +```jsonc +{ + "status": "ok", // status, "ok" | "error" + "event": "0123456789abcdef...", // event the command is in response to, string + "data": { // response data + "preimage": "0123456789abcdef..." // command-related data + } +} +``` + +The data field SHOULD contain a `message` field with a human readable error message if the status is `error`. + +## Nostr Wallet Connect URI +**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. + +The **wallet service** generates this connection URI with protocol `nostr+walletconnect:` and base path it's hex-encoded `pubkey` with the following query string parameters: + +- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. +- `secret` Required. 32-byte randomly generated hex encoded string. The **client** should use this to sign events when communicating with the **wallet service**. + - Authorization does not require passing keys back and forth. + - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets). + - The key is harder to leak since it is not shown to the user and backed up. + - It improves privacy because the user's main key would not be linked to their payments. + +The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Optionally it can display metadata about the connected **wallet service** from it's profile (name, image, url). + +### Example connection string +```sh +nostrwalletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c +``` + +## Commands + +### `pay_invoice` + +Description: Requests payment of an invoice. + +Request: +```jsonc +{ + "invoice": "lnbc50n1..." // BOLT11 invoice, string +} +``` + +Response: +```jsonc +{ + "preimage": "0123456789abcdef..." // preimage after payment, string +} +``` + +### `balance` + +Description: Requests the balance of the wallet. + +Request: an empty JSON object. + +Response: +```jsonc +{ + "balance": 100000 // balance in msat, int +} +``` + +## Example pay invoice flow + +0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostrwalletconnect:` deeplink or configure the connection details manually. +1. **client** sends an event to with **wallet service** service with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. +2. **nostr-wallet-connect-service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. +3. **nostr-wallet-connect-service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. + +## Using a dedicated relay +This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. From 800c0d0cd397eb4b043ef0cdaefd0bad18cb1cd5 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 29 Mar 2023 18:45:12 -0300 Subject: [PATCH 027/314] 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 ef77fa66..422ad9ca 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 2c3c4ae0..00000000 --- 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 741a2883..ba78113d 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 961f28285a739000277f489573f5b4c22053f27c Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Thu, 30 Mar 2023 01:23:04 +0300 Subject: [PATCH 028/314] NIP-47: Fix up some things --- 47.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/47.md b/47.md index 326100de..96bf906b 100644 --- a/47.md +++ b/47.md @@ -65,7 +65,7 @@ The **client** should then store this connection and use it when the user wants ### Example connection string ```sh -nostrwalletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c +nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c ``` ## Commands @@ -103,10 +103,10 @@ Response: ## Example pay invoice flow -0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostrwalletconnect:` deeplink or configure the connection details manually. +0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. 1. **client** sends an event to with **wallet service** service with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. -2. **nostr-wallet-connect-service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. -3. **nostr-wallet-connect-service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. +2. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. +3. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. ## Using a dedicated relay This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. From 60412bf7a55c32ed55eec2e9adda834f968fa00b Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Fri, 24 Mar 2023 12:02:35 -0500 Subject: [PATCH 029/314] 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 79f167c6..78876524 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 030/314] doc: add horse extension --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index ad26d2fd..3b7a1d29 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 031/314] Event-specific zap markers (#402) --- 57.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/57.md b/57.md index 78876524..17042ea4 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 c232c9a46a279883f7d8e07db9f2ae6a79a784c6 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Mon, 3 Apr 2023 22:18:11 +0300 Subject: [PATCH 032/314] NIP-47: feedbacj --- 47.md | 69 ++++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 52 insertions(+), 17 deletions(-) diff --git a/47.md b/47.md index 96bf906b..fd85e133 100644 --- a/47.md +++ b/47.md @@ -8,8 +8,7 @@ Nostr Wallet Connect ## Rationale -Paying zaps should be possible without the user needing to open a different app to only pay a Lightning invoice. -This NIP describes a way for users to control a remote Lightning node or a custodial Lightning wallet. When self-hosting, this setup does not require the user to run their own server, thereby bypassing certain hurdles that are commonly encountered when trying to connect to a Lightning node remotely. +This NIP describes a way for clients to access a remote Lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol. ## Terms @@ -47,7 +46,17 @@ Response: } ``` -The data field SHOULD contain a `message` field with a human readable error message if the status is `error`. +The data field SHOULD contain a `message` field with a human readable error message and a `code` field with the error code if the status is `error`. + +### Error codes +- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. +- `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented. +- `INSUFFICIENT_BALANCE`: The wallet does not have enough funds to cover a fee reserve or the payment amount. +- `QUOTA_EXCEEDED`: The wallet has exceeded +- `RESTRICTED`: This public key is not allowed to do this operation. +- `UNAUTHORIZED`: This public key has no wallet connected. +- `INTERNAL`: An internal error. +- `OTHER`: Other error. ## Nostr Wallet Connect URI **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. @@ -61,7 +70,7 @@ The **wallet service** generates this connection URI with protocol `nostr+wallet - The key is harder to leak since it is not shown to the user and backed up. - It improves privacy because the user's main key would not be linked to their payments. -The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Optionally it can display metadata about the connected **wallet service** from it's profile (name, image, url). +The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events. ### Example connection string ```sh @@ -70,6 +79,45 @@ nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558 ## Commands +### `get_info` + +Description: Get information about the wallet and service. + +Request: Empty object. + +Response: +```jsonc +{ + "balance": 100000, // balance in msat, int + // this should be capped at the quota allowed for this client + // to not report unspendable balance. + "implemented_commands": ["get_info", "pay_invoice"] // commands supported, string array + // extensions can be specified via command+extension: + // get_info+node_info +} +``` + +### `create_invoice` + +Description: Requests creation of an invoice. + +Request: +```jsonc +{ + "amount": 1000, // amount in msat, int + // must be a whole number of sats unless + // create_invoice+msat_amount is implemented. + "description": "memo" // a description, string, optional +} +``` + +Response: +```jsonc +{ + "invoice": "lnbc50n1..." // BOLT11 invoice, string +} +``` + ### `pay_invoice` Description: Requests payment of an invoice. @@ -88,19 +136,6 @@ Response: } ``` -### `balance` - -Description: Requests the balance of the wallet. - -Request: an empty JSON object. - -Response: -```jsonc -{ - "balance": 100000 // balance in msat, int -} -``` - ## Example pay invoice flow 0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. From c6e14c808775ec6ca0a721fe273b4de7124dd143 Mon Sep 17 00:00:00 2001 From: Seth For Privacy Date: Tue, 4 Apr 2023 13:43:59 -0400 Subject: [PATCH 033/314] 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 c1e66fe8..b731c497 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 034/314] 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 b731c497..4ae571f7 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 035/314] 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 00000000..cd81c116 --- /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 ba78113d..215e5cd4 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 036/314] 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 60ec5e04..6e45b74b 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 992983f7..a7b42b06 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 f97193c2..17663204 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 cf28d867..e3662a57 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 fb29e6ac..2172519e 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 5ab1553c..f74bcc08 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 274ee801..32680db8 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 cd81c116..28e5e969 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 b4143ada..34a5def8 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 175f66b1..10ff5358 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 037/314] JSON quoting (and other fixes) --- 11.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/11.md b/11.md index 17663204..a3773642 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 038/314] 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 9d73458d..91afaf75 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 039/314] 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 4cfdd359..8efb8ecf 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 081a97d9..00000000 --- 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 215e5cd4..ec55ab7e 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 040/314] indicate optional kind TLV on nevent (@v0l). --- 19.md | 1 + 1 file changed, 1 insertion(+) diff --git a/19.md b/19.md index 91afaf75..6fc4523e 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 041/314] Add links to NIP-21 --- 27.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/27.md b/27.md index 028ee5ea..6d761206 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 042/314] 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 8efb8ecf..ae138246 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 043/314] feat: support counting by filters --- 45.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/45.md b/45.md index 28e5e969..87e80002 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 044/314] 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 00000000..a3d105da --- /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 045/314] 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 11468c07..b8fa9028 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 046/314] 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 a3d105da..e8fe4af3 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 047/314] Add missing tag descriptions --- README.md | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ec55ab7e..9f31a36f 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 048/314] 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 9f31a36f..406ad2fa 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 049/314] Tidy message lists --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 406ad2fa..669ae3ec 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 050/314] 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 669ae3ec..b78f9dc9 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 051/314] Add missing kinds to list --- README.md | 62 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index b78f9dc9..24ae2c9b 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 052/314] 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 24ae2c9b..7c002b30 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 053/314] Ensure single sentence per line --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c002b30..a89f3402 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 054/314] Unrecommended notice style change --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a89f3402..a3f5fc0a 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 055/314] Remove extra space --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index a3f5fc0a..417a3c3e 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 056/314] fix typos --- 15.md | 2 +- 51.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/15.md b/15.md index e8fe4af3..617c0115 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 34a5def8..80cc09ef 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 057/314] 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 417a3c3e..836a5930 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 058/314] NIP-09: Fix some things --- 09.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/09.md b/09.md index b0febc74..89781fbf 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 059/314] 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 2525bf10..bfbb3ae5 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 060/314] 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 fb87b536..6793e0bb 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 061/314] 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 00000000..06b03c8c --- /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 00000000..680496c9 --- /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 062/314] fixed json schema --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 06b03c8c..0798d743 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 063/314] add json schema --- 95.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/95.md b/95.md index 680496c9..ffb3906a 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 064/314] add hash tag --- 94.md | 1 + 95.md | 1 + 2 files changed, 2 insertions(+) diff --git a/94.md b/94.md index 0798d743..7712171e 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 ffb3906a..4c2dde8c 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 065/314] 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 7712171e..feead69e 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 4c2dde8c..755471f2 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 066/314] 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 feead69e..5f5a14ae 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 755471f2..3653f2ba 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 067/314] minor fix --- 94.md | 3 ++- 95.md | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 5f5a14ae..4963f857 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 3653f2ba..16536abe 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 068/314] 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 4963f857..1b5d8db1 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 16536abe..6f7612fb 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 069/314] 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 1b5d8db1..51ec1e25 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 6f7612fb..292d04c8 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 070/314] 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 51ec1e25..7051ee6c 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 292d04c8..00132df1 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 071/314] 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 00132df1..00000000 --- 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 072/314] 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 7051ee6c..21eefc95 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 073/314] 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 21eefc95..13cd2310 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 074/314] 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 13cd2310..13315e0c 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 075/314] 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 13315e0c..81e2bf27 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 076/314] 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 81e2bf27..dfc77d93 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 077/314] change to regular event --- 94.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/94.md b/94.md index dfc77d93..533b49cb 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 078/314] 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 533b49cb..005ef267 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 079/314] fixed text description --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 005ef267..78c7056c 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 080/314] 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 78c7056c..5c125651 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 081/314] 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 836a5930..d47bf76a 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 082/314] 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 d47bf76a..fb0ddb78 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 083/314] 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 ae138246..a07a0dff 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 084/314] blurhash explanation --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 5c125651..87b0f3a7 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 085/314] 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 87b0f3a7..d29548e9 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 fb0ddb78..0a00d0ee 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 086/314] 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 e3662a57..2c60929c 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 087/314] 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 2c60929c..360bde6c 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 088/314] Reword description of kind 1063 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a00d0ee..e7c89144 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 de095e47580e63d91faf541e6a0c84ae5c0ca8fd Mon Sep 17 00:00:00 2001 From: kiwiidb <33457577+kiwiidb@users.noreply.github.com> Date: Thu, 27 Apr 2023 16:21:15 +0200 Subject: [PATCH 089/314] NIP-47: Implement feedback Co-authored-by: Semisol --- 47.md | 79 ++++++++++++++++++++--------------------------------------- 1 file changed, 27 insertions(+), 52 deletions(-) diff --git a/47.md b/47.md index fd85e133..083dabe2 100644 --- a/47.md +++ b/47.md @@ -17,19 +17,22 @@ This NIP describes a way for clients to access a remote Lightning wallet through ## Events -There are two event kinds: +There are three event kinds: +- `NIP-47 info event`: 13194 - `NIP-47 request`: 23194 - `NIP-47 response`: 23195 -Both the request and response events SHOULD only contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **client** if this is a response. +The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be +a plaintext string with the supported commands, space-seperated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. +Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **client** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. -The content is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON object. The content depends on the kind. +The content of requests and responses is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: Request: ```jsonc { - "cmd": "pay_invoice", // command, string - "data": { // data, object + "method": "pay_invoice", // method, string + "params": { // params, object "invoice": "lnbc50n1..." // command-related data } } @@ -38,21 +41,26 @@ Request: Response: ```jsonc { - "status": "ok", // status, "ok" | "error" - "event": "0123456789abcdef...", // event the command is in response to, string - "data": { // response data + "result_type": "pay_invoice", //indicates the structure of the result field + "error": { //object, non-null in case of error + "code": "UNAUTHORIZED", //string error code, see below + "message": "human readable error message" + }, + "result": { // result, object. null in case of error. "preimage": "0123456789abcdef..." // command-related data } } ``` -The data field SHOULD contain a `message` field with a human readable error message and a `code` field with the error code if the status is `error`. +The `result_type` field MUST contain the name of the method that this event is responding to. +The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not succesful. +If the command was succesful, the `error` field must be null. ### Error codes - `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. - `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented. - `INSUFFICIENT_BALANCE`: The wallet does not have enough funds to cover a fee reserve or the payment amount. -- `QUOTA_EXCEEDED`: The wallet has exceeded +- `QUOTA_EXCEEDED`: The wallet has exceeded its spending quota. - `RESTRICTED`: This public key is not allowed to do this operation. - `UNAUTHORIZED`: This public key has no wallet connected. - `INTERNAL`: An internal error. @@ -64,7 +72,7 @@ The data field SHOULD contain a `message` field with a human readable error mess The **wallet service** generates this connection URI with protocol `nostr+walletconnect:` and base path it's hex-encoded `pubkey` with the following query string parameters: - `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. -- `secret` Required. 32-byte randomly generated hex encoded string. The **client** should use this to sign events when communicating with the **wallet service**. +- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. - Authorization does not require passing keys back and forth. - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets). - The key is harder to leak since it is not shown to the user and backed up. @@ -79,45 +87,6 @@ nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558 ## Commands -### `get_info` - -Description: Get information about the wallet and service. - -Request: Empty object. - -Response: -```jsonc -{ - "balance": 100000, // balance in msat, int - // this should be capped at the quota allowed for this client - // to not report unspendable balance. - "implemented_commands": ["get_info", "pay_invoice"] // commands supported, string array - // extensions can be specified via command+extension: - // get_info+node_info -} -``` - -### `create_invoice` - -Description: Requests creation of an invoice. - -Request: -```jsonc -{ - "amount": 1000, // amount in msat, int - // must be a whole number of sats unless - // create_invoice+msat_amount is implemented. - "description": "memo" // a description, string, optional -} -``` - -Response: -```jsonc -{ - "invoice": "lnbc50n1..." // BOLT11 invoice, string -} -``` - ### `pay_invoice` Description: Requests payment of an invoice. @@ -125,14 +94,20 @@ Description: Requests payment of an invoice. Request: ```jsonc { - "invoice": "lnbc50n1..." // BOLT11 invoice, string + "method": "pay_invoice", + "params": { + "invoice": "lnbc50n1..." // bolt11 invoice + } } ``` Response: ```jsonc { - "preimage": "0123456789abcdef..." // preimage after payment, string + "result_type": "pay_invoice", + "result": { + "preimage": "0123456789abcdef..." // preimage of the payment + } } ``` From 5a8c463641b3dbaf927f7e0479ff046f0f6fb646 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Thu, 27 Apr 2023 17:24:20 +0300 Subject: [PATCH 090/314] NIP-47: Add error for payment failed --- 47.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/47.md b/47.md index 083dabe2..aa58b5c4 100644 --- a/47.md +++ b/47.md @@ -111,6 +111,9 @@ Response: } ``` +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + ## Example pay invoice flow 0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. From 346036208ccca6f31313f1e909ff17ea3563fb46 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Fri, 28 Apr 2023 10:21:18 -0500 Subject: [PATCH 091/314] 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 d29548e9..24dd346f 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", ] From e91ce3409e1ce8267fc07a21784d2538621267c3 Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Sat, 29 Apr 2023 13:16:58 -0500 Subject: [PATCH 092/314] NIP-30: Custom Emoji --- 30.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 57 insertions(+) create mode 100644 30.md diff --git a/30.md b/30.md new file mode 100644 index 00000000..04689d0f --- /dev/null +++ b/30.md @@ -0,0 +1,56 @@ +NIP-30 +====== + +Custom Emoji +------------ + +`draft` `optional` `author:alexgleason` + +Custom emoji may be added to **kind 0** and **kind 1** events by including one or more `"emoji"` tags, in the form: + +``` +["emoji", , ] +``` + +Where: + +- `` is a name given for the emoji, which MUST be comprised of only alphanumeric characters. +- `` is a URL to the corresponding image file of the emoji. + +For each emoji tag, clients should parse emoji shortcodes (aka "emojify") like `:shortcode:` in the event to display custom emoji. + +Clients may allow users to add custom emoji to an event by including `:shortcode:` identifier in the event, and adding the relevant `"emoji"` tags. + +### Kind 0 events + +In kind 0 events, the `name` and `about` fields should be emojified. + +```json +{ + "kind": 0, + "content": "{\"name\":\"Alex Gleason :soapbox:\"}", + "tags": [ + ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682790000 +} +``` + +### Kind 1 events + +In kind 1 events, the `content` should be emojified. + +```json +{ + "kind": 1, + "content": "Hello :gleasonator: 😂 :ablobcatrainbow: :disputed: yolo", + "tags": [ + ["emoji", "ablobcatrainbow", "https://gleasonator.com/emoji/blobcat/ablobcatrainbow.png"], + ["emoji", "disputed", "https://gleasonator.com/emoji/Fun/disputed.png"], + ["emoji", "gleasonator", "https://gleasonator.com/emoji/Gleasonator/gleasonator.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682630000 +} +``` \ No newline at end of file diff --git a/README.md b/README.md index e7c89144..92be9a5a 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) +- [NIP-30: Custom Emoji](30.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) From 7f75d0db33435fe9fcb6c04f18d0e610b17cebb4 Mon Sep 17 00:00:00 2001 From: mplorentz Date: Mon, 1 May 2023 14:15:06 -0400 Subject: [PATCH 093/314] Change NIP-21 URL->URI I think the `nostr:...` scheme is not actually a Uniform Resource Locator, because it doesn't tell you where the data is located. For instance if I see the string `nostr:npub1sn0wdenkukak0d9dfczzeacvhkrgz92ak56egt7vdgzn8pv2wfqqhrjdv9` I understand that this identifies a Nostr keypair but I don't know where to find data for that keypair. The scheme does fall under the definition of a Uniform Resource Identifier, or maybe even the stricter class Uniform Resource Name. But nobody talks about URNs, so maybe best to just use the less-specific term "URI" here. --- 21.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/21.md b/21.md index bfbb3ae5..6246eb49 100644 --- a/21.md +++ b/21.md @@ -1,12 +1,12 @@ NIP-21 ====== -`nostr:` URL scheme +`nostr:` URI scheme ------------------- `draft` `optional` `author:fiatjaf` -This NIP standardizes the usage of a common URL scheme for maximum interoperability and openness in the network. +This NIP standardizes the usage of a common URI scheme for maximum interoperability and openness in the network. The scheme is `nostr:`. From d7c189d70bd1f9489a388920bc325576bd9cf8e4 Mon Sep 17 00:00:00 2001 From: "Robert C. Martin" Date: Tue, 2 May 2023 09:41:59 -0500 Subject: [PATCH 094/314] NIP11 example using curl. (#490) --- 11.md | 88 +++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 58 insertions(+), 30 deletions(-) diff --git a/11.md b/11.md index a3773642..89518354 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 } ] ... } @@ -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 -countries' laws might end up being enforced on them, and then -indirectly on their users' content. +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 @@ -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', ... } ``` @@ -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 that only "Safe For Work" content + 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 @@ -245,12 +245,40 @@ 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' }], }, ... } ``` + +### Examples ### +As of 2 May 2023 the following `curl` command provided these results. + + >curl -H "Accept: application/nostr+json" https://eden.nostr.land + + {"name":"eden.nostr.land", + "description":"Eden Nostr Land - Toronto 1-01", + "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", + "contact":"me@ricardocabral.io", + "supported_nips":[1,2,4,9,11,12,15,16,20,22,26,28,33,40], + "supported_nip_extensions":["11a"], + "software":"git+https://github.com/Cameri/nostream.git", + "version":"1.22.6", + "limitation":{"max_message_length":1048576, + "max_subscriptions":10, + "max_filters":2500, + "max_limit":5000, + "max_subid_length":256, + "min_prefix":4, + "max_event_tags":2500, + "max_content_length":65536, + "min_pow_difficulty":0, + "auth_required":false, + "payment_required":true}, + "payments_url":"https://eden.nostr.land/invoices", + "fees":{"admission":[{"amount":5000000,"unit":"msats"}], + "publication":[]}} From bc9d469c203a25a706727219fa7d37dacaf6040d Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 5 May 2023 08:50:50 -0300 Subject: [PATCH 095/314] add nip-47 to index. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e7c89144..a4a63a4a 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-42: Authentication of clients to relays](42.md) - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Connect](46.md) +- [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) - [NIP-56: Reporting](56.md) @@ -86,7 +87,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia | `10000` | Mute List | [51](51.md) | | `10001` | Pin List | [51](51.md) | | `10002` | Relay List Metadata | [65](65.md) | +| `13194` | Wallet Info | [47](47.md) | | `22242` | Client Authentication | [42](42.md) | +| `23194` | Wallet Request | [47](47.md) | +| `23195` | Wallet Response | [47](47.md) | | `24133` | Nostr Connect | [46](46.md) | | `30000` | Categorized People List | [51](51.md) | | `30001` | Categorized Bookmark List | [51](51.md) | From b8aec7dad561a8b27e22a91638dd04f2851a0c5c Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 5 May 2023 09:18:02 -0300 Subject: [PATCH 096/314] nip-31: dealing with custom unknown events. --- 31.md | 13 +++++++++++++ README.md | 1 + 2 files changed, 14 insertions(+) create mode 100644 31.md diff --git a/31.md b/31.md new file mode 100644 index 00000000..675c2496 --- /dev/null +++ b/31.md @@ -0,0 +1,13 @@ +NIP-31 +====== + +Dealing with unknown event kinds +-------------------------------- + +`draft` `optional` `author:pablof7z` `author:fiatjaf` + +When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use the `tags` field to store all their custom data related to their protocol, and use the `content` field to write a short human-readable plaintext summary of what that event is about. + +The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. + +These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. diff --git a/README.md b/README.md index a4a63a4a..f3ae5016 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) +- [NIP-31: Dealing with Unknown Events](31.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) From d5484a33bcaf717ef1ef54a0f9be1b76c4f70afa Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Sat, 6 May 2023 11:35:21 -0700 Subject: [PATCH 097/314] Clarify how NIP 45 works with multiple COUNT filters. (#504) --- 45.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/45.md b/45.md index 87e80002..a5253913 100644 --- a/45.md +++ b/45.md @@ -6,21 +6,21 @@ Event Counts `draft` `optional` `author:staab` -Relays may support the `COUNT` verb, which provides a mechanism for obtaining event counts. +Relays may support the verb `COUNT`, which provides 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. +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 only to 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 filters as specified in [NIP 01](01.md). +This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result. ``` ["COUNT", , ...] ``` -Counts are returned using a `COUNT` response in the form `{count: }`. Relays may use probabilistic counts to reduce compute requirements. +Counts are returned using a `COUNT` response in the form `{"count": }`. Relays may use probabilistic counts to reduce compute requirements. ``` ["COUNT", , {"count": }] From 1678c53dcd3a2cefcf953722d501c03920ce6092 Mon Sep 17 00:00:00 2001 From: ekzyis Date: Sat, 6 May 2023 23:31:22 +0200 Subject: [PATCH 098/314] Update old link to fiatjaf/nostr --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4a63a4a..94e945c5 100644 --- a/README.md +++ b/README.md @@ -1,7 +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. +They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software. --- From 29f26e72b5fd4e918c8d0d9f9d9ae384f7052a0a Mon Sep 17 00:00:00 2001 From: Kieran Date: Mon, 24 Apr 2023 10:32:03 +0100 Subject: [PATCH 099/314] NIP-98 --- 98.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 98.md diff --git a/98.md b/98.md new file mode 100644 index 00000000..48d079e9 --- /dev/null +++ b/98.md @@ -0,0 +1,64 @@ +NIP-98 +====== + +HTTP Auth +------------------------- + +`draft` `optional` `author:kieran` `author:melvincarvalho` + +This NIP defines and ephemerial event used to authenticate requests to HTTP servers using nostr events. + +This is useful for HTTP services which are build for Nostr and deal with Nostr user accounts. + +## Nostr event + +A `kind 27235` (In reference to [RFC 7235](https://www.rfc-editor.org/rfc/rfc7235)) event is used. + +The `content` SHOULD be empty. + +The following tags are defined as REQUIRED. + +* `url` - absolute URL +* `method` - HTTP Request Method + +Example event: +```json +{ + "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734", + "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed", + "content": "", + "kind": 27235, + "created_at": 1682327852, + "tags": [ + [ + "url", + "https://api.snort.social/api/v1/n5sp/list" + ], + [ + "method", + "GET" + ] + ], + "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184" +} +``` + +Servers MUST perform the following checks in order to validate the event: +1. The `kind` MUST be `27235`. +2. The `created_at` MUST be within a reasonable time window (suggestion 60 seconds). +3. The `url` tag MUST be exactly the same as the absolute request URL (including query parameters). +4. The `method` tag MUST be the same HTTP method used for the requested resource. + +All other checks which server MAY do are OPTIONAL, and implementation specific. + +## Request Flow + +Using the `Authorization` header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` + +Example HTTP Authorization header: +``` +Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1cmwiLCJodHRwczovL2FwaS5zbm9ydC5zb2NpYWwvYXBpL3YxL241c3AvbGlzdCJdLFsibWV0aG9kIiwiR0VUIl1dLCJzaWciOiI1ZWQ5ZDhlYzk1OGJjODU0Zjk5N2JkYzI0YWMzMzdkMDA1YWYzNzIzMjQ3NDdlZmU0YTAwZTI0ZjRjMzA0MzdmZjRkZDgzMDg2ODRiZWQ0NjdkOWQ2YmUzZTVhNTE3YmI0M2IxNzMyY2M3ZDMzOTQ5YTNhYWY4NjcwNWMyMjE4NCJ9 +``` + +## References +- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) \ No newline at end of file From 2d31ddd38a133584a2eea58fdbe106452999cce3 Mon Sep 17 00:00:00 2001 From: Kieran Date: Mon, 24 Apr 2023 10:56:04 +0100 Subject: [PATCH 100/314] add note about payload hash --- 98.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/98.md b/98.md index 48d079e9..3a8ffdf2 100644 --- a/98.md +++ b/98.md @@ -18,8 +18,8 @@ The `content` SHOULD be empty. The following tags are defined as REQUIRED. -* `url` - absolute URL -* `method` - HTTP Request Method +* `u` - absolute URL +* `method` - HTTP Request Method Example event: ```json @@ -31,7 +31,7 @@ Example event: "created_at": 1682327852, "tags": [ [ - "url", + "u", "https://api.snort.social/api/v1/n5sp/list" ], [ @@ -49,6 +49,10 @@ Servers MUST perform the following checks in order to validate the event: 3. The `url` tag MUST be exactly the same as the absolute request URL (including query parameters). 4. The `method` tag MUST be the same HTTP method used for the requested resource. +When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD include a SHA256 hash of the request body in a `payload` tag as hex (`["payload", ""]`), servers MAY check this to validate that the requested payload is authorized. + +If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code. + All other checks which server MAY do are OPTIONAL, and implementation specific. ## Request Flow From 30620c8e542b398f58f69426736a01d9aaa79452 Mon Sep 17 00:00:00 2001 From: Kieran Date: Mon, 24 Apr 2023 11:22:47 +0100 Subject: [PATCH 101/314] Update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 94e945c5..9714fc98 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) - [NIP-94: File Metadata](94.md) +- [NIP-98: HTTP Auth](98.md) ## Event Kinds @@ -92,6 +93,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `23194` | Wallet Request | [47](47.md) | | `23195` | Wallet Response | [47](47.md) | | `24133` | Nostr Connect | [46](46.md) | +| `27235` | HTTP Auth | [98](98.md) | | `30000` | Categorized People List | [51](51.md) | | `30001` | Categorized Bookmark List | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | From f75d91551cea5af89a572c123615db1cf9033caf Mon Sep 17 00:00:00 2001 From: Kieran Date: Mon, 24 Apr 2023 11:24:47 +0100 Subject: [PATCH 102/314] typo --- 98.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/98.md b/98.md index 3a8ffdf2..e3732169 100644 --- a/98.md +++ b/98.md @@ -6,7 +6,7 @@ HTTP Auth `draft` `optional` `author:kieran` `author:melvincarvalho` -This NIP defines and ephemerial event used to authenticate requests to HTTP servers using nostr events. +This NIP defines an ephemerial event used to authorize requests to HTTP servers using nostr events. This is useful for HTTP services which are build for Nostr and deal with Nostr user accounts. From de1aec64d21415c2f96fce6694de294c282ce128 Mon Sep 17 00:00:00 2001 From: Kieran Date: Mon, 8 May 2023 12:21:30 +0100 Subject: [PATCH 103/314] change references title --- 98.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/98.md b/98.md index e3732169..1ccd2611 100644 --- a/98.md +++ b/98.md @@ -64,5 +64,5 @@ Example HTTP Authorization header: Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1cmwiLCJodHRwczovL2FwaS5zbm9ydC5zb2NpYWwvYXBpL3YxL241c3AvbGlzdCJdLFsibWV0aG9kIiwiR0VUIl1dLCJzaWciOiI1ZWQ5ZDhlYzk1OGJjODU0Zjk5N2JkYzI0YWMzMzdkMDA1YWYzNzIzMjQ3NDdlZmU0YTAwZTI0ZjRjMzA0MzdmZjRkZDgzMDg2ODRiZWQ0NjdkOWQ2YmUzZTVhNTE3YmI0M2IxNzMyY2M3ZDMzOTQ5YTNhYWY4NjcwNWMyMjE4NCJ9 ``` -## References +## Reference Implementations - C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) \ No newline at end of file From ee018ef8a4af08dcf8f4c090bb3815ee13f4c627 Mon Sep 17 00:00:00 2001 From: Josua Schmid Date: Sun, 7 May 2023 21:53:35 +0200 Subject: [PATCH 104/314] Rephrase Markdown special rule --- 01.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index a07a0dff..3d8c7450 100644 --- a/01.md +++ b/01.md @@ -99,7 +99,8 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. ## Basic Event Kinds - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say). Markdown links (`[]()` stuff) are not plaintext. + - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say).\ + Do not use Markdown! Clients should not have to guess how to interpret content like `[Example](https://example.com)`. Use different event kinds for parsable content. - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. From 89a7aa0ea0197b478e96d2a281ac4d096c44caad Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Mon, 8 May 2023 11:05:58 -0300 Subject: [PATCH 105/314] nip01: remove misleading markdown example. --- 01.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/01.md b/01.md index 3d8c7450..713e6550 100644 --- a/01.md +++ b/01.md @@ -99,8 +99,7 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. ## Basic Event Kinds - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say).\ - Do not use Markdown! Clients should not have to guess how to interpret content like `[Example](https://example.com)`. Use different event kinds for parsable content. + - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say). Do not use Markdown! Clients should not have to guess how to interpret content like `[]()`. Use different event kinds for parsable content. - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. From d70aa87f076f8609950fc96e4e66d86c711c66ac Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 9 May 2023 22:09:45 +0900 Subject: [PATCH 106/314] Restore some lost changes c7711aa and 3cec80d. --- 11.md | 60 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/11.md b/11.md index 89518354..b0d6003f 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 } ] ... } @@ -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 @@ -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", ... } ``` @@ -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 @@ -245,11 +245,11 @@ 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 60aa6ae168e8d71e4fd247e49f8ba70fbe511fda Mon Sep 17 00:00:00 2001 From: "Robert C. Martin" Date: Tue, 9 May 2023 10:17:15 -0500 Subject: [PATCH 107/314] A few changes to some nips. (#510) --- 01.md | 1 + 47.md | 19 +++++++++++++++---- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/01.md b/01.md index 713e6550..e36f4f5d 100644 --- a/01.md +++ b/01.md @@ -109,3 +109,4 @@ A relay may choose to treat different message kinds differently, and it may or m - 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. 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. +- Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. diff --git a/47.md b/47.md index aa58b5c4..fe3d5756 100644 --- a/47.md +++ b/47.md @@ -12,8 +12,18 @@ This NIP describes a way for clients to access a remote Lightning wallet through ## Terms -* **client**: Nostr app on any platform that wants to pay Lightning invoices -* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). +* **client**: Nostr app on any platform that wants to pay Lightning invoices. +* **user**: The person using the **client**, and want's to connect their wallet app to their **client**. +* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. + +## Theory of Operation + 1. **Users** who which to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. + + 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. + + 3. When the **user** initiates a payment their nostr **client** create a `pay_invoice` request, encrypts it using a token from the URI, and sends it (kind 23194) to the relay(s) specified in the connection URI. The **wallet service** will be listening on those relays and will decrypt the request and then contact the **user's** wallet application to send the payment. The **wallet service** will know how to talk to the wallet application because the connection URI specified relay(s) that have access to the wallet app API. + + 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. ## Events @@ -24,7 +34,8 @@ There are three event kinds: The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be a plaintext string with the supported commands, space-seperated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. -Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **client** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. + +Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. The content of requests and responses is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: @@ -117,7 +128,7 @@ Errors: ## Example pay invoice flow 0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. -1. **client** sends an event to with **wallet service** service with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. +1. **client** sends an event to the **wallet service** service with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. 2. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. 3. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. From 4208652dc7a39c63c39559b13c656ec30400fcba Mon Sep 17 00:00:00 2001 From: William Casarin Date: Tue, 9 May 2023 15:02:14 -0700 Subject: [PATCH 108/314] nip47: add lud16 parameter to connection string This adds an optional but recommended lud16 parameter to nostr wallet connection strings. This enables seamless onboarding of new users, allowing clients to automatically configure the receive address for zaps. --- 47.md | 1 + 1 file changed, 1 insertion(+) diff --git a/47.md b/47.md index fe3d5756..c884b978 100644 --- a/47.md +++ b/47.md @@ -88,6 +88,7 @@ The **wallet service** generates this connection URI with protocol `nostr+wallet - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets). - The key is harder to leak since it is not shown to the user and backed up. - It improves privacy because the user's main key would not be linked to their payments. +- `lud16` Recommended. A lightning address that clients can use to automatically setup the `lud16` field on the user's profile if they have none configured. The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events. From 4cbb672d1cf6e0af2b4c09c9b33e97f7964ce36e Mon Sep 17 00:00:00 2001 From: earonesty Date: Sat, 13 May 2023 07:39:01 -0700 Subject: [PATCH 109/314] Fix docs from kind0 to kind33 https://github.com/nostr-protocol/nips/issues/376 --- 28.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/28.md b/28.md index 169ae4f4..9f9302f1 100644 --- a/28.md +++ b/28.md @@ -37,7 +37,7 @@ In the channel creation `content` field, Client SHOULD include basic channel met Update a channel's public metadata. -Clients and relays SHOULD handle kind 41 events similar to kind 0 `metadata` events. +Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel. Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. From 26194822005836a8ce690009fc636e0fe71802e6 Mon Sep 17 00:00:00 2001 From: earonesty Date: Sat, 13 May 2023 07:42:40 -0700 Subject: [PATCH 110/314] More explicit --- 28.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/28.md b/28.md index 9f9302f1..62ab398f 100644 --- a/28.md +++ b/28.md @@ -37,7 +37,7 @@ In the channel creation `content` field, Client SHOULD include basic channel met Update a channel's public metadata. -Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel. +Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel. Only the most recent kind 41 is needed to be stored. Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. From 64ac0710dea1af432051ef70698979bff106b9c2 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 14 May 2023 11:55:07 +0900 Subject: [PATCH 111/314] zap note -> zap receipt --- 57.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index 17042ea4..538d7275 100644 --- a/57.md +++ b/57.md @@ -20,7 +20,7 @@ Having lightning receipts on nostr allows clients to display lightning payments 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. +9. Clients MAY fetch `zap receipt`s 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 receipt` to show "zap authorized by ..." but this is optional. ## Reference and examples @@ -108,7 +108,7 @@ When a client sends a zap request event to a server's lnurl-pay callback URL, th 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. +5. There should be a `relays` tag with the relays to send the `zap receipt` 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 From 9076b8486da293f56e725ec593fcfb09a7bc2edf Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 14 May 2023 12:04:47 +0900 Subject: [PATCH 112/314] fix inconsistent quoting of zap request / receipt --- 57.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/57.md b/57.md index 538d7275..54141358 100644 --- a/57.md +++ b/57.md @@ -6,21 +6,21 @@ Lightning Zaps `draft` `optional` `author:jb55` `author:kieran` -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. +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. ## Protocol flow 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. +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). +5. The recipient's lnurl server will receive this `zap 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 `zap request` is valid, the server should fetch a description hash invoice where the description is this `zap request` 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 receipt`s 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 receipt` to show "zap authorized by ..." but this is optional. +9. Clients MAY fetch `zap receipt`s 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 receipt` to show "zap authorized by ..." but this is optional. ## Reference and examples @@ -60,10 +60,10 @@ Example: ### 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: +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 +- `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: @@ -97,12 +97,12 @@ const {pr: invoice} = await fetchJson(`${callback}?amount=${amount}&nostr=${even 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/`, where `nostrPubkey` is the nostr pubkey your server will use to sign `zap receipt` events. Clients will use this to validate zap receipts. +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 receipt`s. 2. Add an `allowsNostr` field and set it to true. ### Appendix D: LNURL Server Zap Request Validation -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: +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: 1. It MUST have a valid nostr signature 2. It MUST have tags @@ -116,29 +116,29 @@ The event MUST then be stored for use later, when the invoice is paid. ### Appendix E: Zap Receipt Event -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. +A `zap receipt` is created by a lightning node when an invoice generated by a `zap request` is paid. `Zap receipt`s are only created when the invoice description (committed to the description hash) contains a `zap request` 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 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. +3. Create a nostr event of kind `9735` as described below, and publish it to the `relays` declared in the `zap request`. -The following should be true of the zap receipt event: +The following should be true of the `zap receipt` event: - 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. +- `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. +- 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. -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 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. A reference implementation for a zap-enabled lnurl server can be found [here](https://github.com/jb55/cln-nostr-zapper). -Example zap receipt: +Example `zap receipt`: ```json { @@ -160,7 +160,7 @@ Example zap receipt: ### Appendix F: Validating Zap Receipts -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: +A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter, for example `{"kinds": [9735], "#e": [...]}`. Zaps MUST be validated using the following steps: - 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). @@ -180,4 +180,4 @@ When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay reque ## 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. +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 89e3c01b1438cedfb8d1ebbed3e320b8a6f3a582 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 14 May 2023 13:16:10 +0900 Subject: [PATCH 113/314] fix description of nostr query param --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 54141358..cb1f126c 100644 --- a/57.md +++ b/57.md @@ -102,7 +102,7 @@ The lnurl server will need some additional pieces of information so that clients ### Appendix D: LNURL Server Zap Request Validation -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: +When a client sends a `zap request` event to a server's lnurl-pay callback URL, there will be a `nostr` query parameter whose value is that event which is URI- and JSON-encoded. If present, the `zap request` event must be validated in the following ways: 1. It MUST have a valid nostr signature 2. It MUST have tags From 4ea0e8e9f276c03e298f466fb3074342f0ec01c3 Mon Sep 17 00:00:00 2001 From: Neil Date: Mon, 15 May 2023 09:30:27 -0700 Subject: [PATCH 114/314] Add new signing extension to NIP-07 --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 3b7a1d29..2a31f716 100644 --- a/07.md +++ b/07.md @@ -30,3 +30,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives) - [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox) - [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives) +- [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) From d9caf9d7b4ca5c3341b1262d5460a2e23630da5c Mon Sep 17 00:00:00 2001 From: jimbojw Date: Mon, 15 May 2023 08:15:53 -0400 Subject: [PATCH 115/314] fix: Updating links in NIP-15 to point to intended other NIPs. --- 15.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/15.md b/15.md index 617c0115..f8df3284 100644 --- a/15.md +++ b/15.md @@ -38,8 +38,8 @@ A merchant can publish these events: | `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) | +| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md) | +| `5 ` | `delete` | Delete a product or a stall. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) | ### Event `30017`: Create or update a stall. From 835ec2614164c593e686e829aae6cbac64997ae8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 16 May 2023 22:40:41 +0900 Subject: [PATCH 116/314] Add emoji tag to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b99f1d35..963fd791 100644 --- a/README.md +++ b/README.md @@ -157,6 +157,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | `description` | badge description | -- | [58](58.md) | | `description` | invoice description | -- | [57](57.md) | +| `emoji` | shortcode | image URL | [30](30.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) | From ccbdfb95c198c385595c18edac09d9c830fd9406 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Tue, 16 May 2023 21:50:04 +0900 Subject: [PATCH 117/314] allow underscores in an emoji shortcode --- 30.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/30.md b/30.md index 04689d0f..ffc5aeb3 100644 --- a/30.md +++ b/30.md @@ -14,7 +14,7 @@ Custom emoji may be added to **kind 0** and **kind 1** events by including one o Where: -- `` is a name given for the emoji, which MUST be comprised of only alphanumeric characters. +- `` is a name given for the emoji, which MUST be comprised of only alphanumeric characters and underscores. - `` is a URL to the corresponding image file of the emoji. For each emoji tag, clients should parse emoji shortcodes (aka "emojify") like `:shortcode:` in the event to display custom emoji. @@ -53,4 +53,4 @@ In kind 1 events, the `content` should be emojified. "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", "created_at": 1682630000 } -``` \ No newline at end of file +``` From 1c916953c1a3a47edeac32ea015c32c450194423 Mon Sep 17 00:00:00 2001 From: heipacker Date: Sat, 20 May 2023 12:26:46 +0800 Subject: [PATCH 118/314] new: add new signer. Android, IOS, Extension --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 2a31f716..71123663 100644 --- a/07.md +++ b/07.md @@ -31,3 +31,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox) - [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives) - [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) +- [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) From 04959313559731c90cfa74413b7b8996795ee601 Mon Sep 17 00:00:00 2001 From: Alejandro Gomez Date: Tue, 23 May 2023 08:51:08 +0200 Subject: [PATCH 119/314] NIP-23: suggest kind 30024 for drafts --- 23.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/23.md b/23.md index 151a31b5..42912281 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](33.md)) 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". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. "Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. From e4937befd6fc29482387ab18a7fab98338dba55d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:44:58 -0400 Subject: [PATCH 120/314] Zap splits --- 57.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index cb1f126c..987b5a2f 100644 --- a/57.md +++ b/57.md @@ -168,16 +168,20 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### 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`. +When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, `lud16` identifier or `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each member. If weights are not present, CLIENTS should equally divide the zap amount to all zap receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```json { "tags": [ - [ "zap", "pablo@f7z.io", "lud16" ] + [ "zap", "LNURL..", "lud06", 10 ], // 10% + [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% ] } ``` +When the hex code is used, clients MAY inform the user the zap split configuration in the note. + ## 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 a56d650333c03a51b1f2d7852670216489ff35d6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:46:05 -0400 Subject: [PATCH 121/314] fixing json formatting --- 57.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index 987b5a2f..e67ec8b1 100644 --- a/57.md +++ b/57.md @@ -173,9 +173,9 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur ```json { "tags": [ - [ "zap", "LNURL..", "lud06", 10 ], // 10% + [ "zap", "LNURL..", "lud06", 10 ], // 10% [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% ] } ``` From dd5c9c54ae33c0480b2f12b604353b738c827115 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:50:55 -0400 Subject: [PATCH 122/314] Changes the client guidance --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index e67ec8b1..74716857 100644 --- a/57.md +++ b/57.md @@ -180,7 +180,7 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur } ``` -When the hex code is used, clients MAY inform the user the zap split configuration in the note. +Clients MAY display the zap split configuration in the note. ## Future Work From 7c3e5902471b2eccf8032c06ab4e07940dd56ae7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 09:46:36 -0400 Subject: [PATCH 123/314] Moves weights to be a string as tags can only contain strings --- 57.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/57.md b/57.md index 74716857..4d02611d 100644 --- a/57.md +++ b/57.md @@ -173,9 +173,9 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur ```json { "tags": [ - [ "zap", "LNURL..", "lud06", 10 ], // 10% - [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% + [ "zap", "LNURL..", "lud06", "10" ], // 10% + [ "zap", "pablo@f7z.io", "lud16", "65" ], // 65% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "25" ] // 25% ] } ``` From 9c97736066a131442a5e43420f0600904959d1cf Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 10:10:18 -0400 Subject: [PATCH 124/314] minor text/grammar adjustments --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 4d02611d..a2214817 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on zapped event -When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, `lud16` identifier or `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each member. If weights are not present, CLIENTS should equally divide the zap amount to all zap receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```json { From 2f8be7c32b7b624ed65b3238d3ada9f2f8859777 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 10:41:14 -0400 Subject: [PATCH 125/314] better example of weights. --- 57.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/57.md b/57.md index a2214817..cb6a2904 100644 --- a/57.md +++ b/57.md @@ -170,12 +170,12 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). -```json +```js { "tags": [ - [ "zap", "LNURL..", "lud06", "10" ], // 10% - [ "zap", "pablo@f7z.io", "lud16", "65" ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "25" ] // 25% + [ "zap", "LNURL..", "lud06", "1" ], // 25% + [ "zap", "pablo@f7z.io", "lud16", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "2" ] // 50% ] } ``` From 5834c054398b39404868746db973ea7f373d1392 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 12:20:53 -0400 Subject: [PATCH 126/314] Dropping lud06 and lud16 from the zap tag --- 57.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/57.md b/57.md index cb6a2904..27b85a4c 100644 --- a/57.md +++ b/57.md @@ -166,16 +166,16 @@ A client can retrieve `zap receipt`s 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 +### Appendix G: `zap` tag on other events -When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on their value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```js { "tags": [ - [ "zap", "LNURL..", "lud06", "1" ], // 25% - [ "zap", "pablo@f7z.io", "lud16", "1" ], // 25% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "2" ] // 50% + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50% ] } ``` From 91bdf63b130cadb89c3908cab09305526e9f2092 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 12:22:16 -0400 Subject: [PATCH 127/314] grammar --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 27b85a4c..39fa5620 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on other events -When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on their value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```js { From a56d1c2877e5c40640350fe0b21748642258baaf Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 26 May 2023 17:28:10 +0900 Subject: [PATCH 128/314] =?UTF-8?q?Add=20description=20for=20d=C2=A0tag=20?= =?UTF-8?q?value?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 33.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/33.md b/33.md index 10681fac..c93c36e7 100644 --- a/33.md +++ b/33.md @@ -10,7 +10,7 @@ This NIP adds a new event range that allows for replacement of events that have Implementation -------------- -The value of a tag is defined as the first parameter of a tag after the tag name. +The value of a tag can be any string and 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 From 4f04de2afda831ef339ad225e4e08a5b1d075e3c Mon Sep 17 00:00:00 2001 From: Akiomi Kamakura Date: Sat, 27 May 2023 08:44:19 +0900 Subject: [PATCH 129/314] Update 07.md --- 07.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/07.md b/07.md index 71123663..a0b5bdc1 100644 --- a/07.md +++ b/07.md @@ -26,7 +26,7 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [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) +- [Alby](https://getalby.com) (Chrome and derivatives, Firefox) - [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives) - [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox) - [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives) From b12c93c452814ffa5f06aef95b60775bc86eaf58 Mon Sep 17 00:00:00 2001 From: Jose Mateo Date: Sun, 28 May 2023 05:58:48 -0400 Subject: [PATCH 130/314] Fix nip-57 typo --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index cb1f126c..438a0f87 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### 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`. +When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay request based on its value instead of the profile's field. An optional third argument on the tag specifies the type of value, either `lud06` or `lud16`. ```json { From 3a38583c068369f55249429ebefe6b09f3a243d5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 31 May 2023 12:35:51 +0900 Subject: [PATCH 131/314] Fix link to NIP-10 --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index e36f4f5d..33a10e70 100644 --- a/01.md +++ b/01.md @@ -107,6 +107,6 @@ 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. See [NIP-10](https://github.com/nostr-protocol/nips/blob/127d5518bfa9a4e4e7510490c0b8d95e342dfa4b/10.md) for a detailed description of "e" and "p" tags. +- 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](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. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. From cabbaadb69ecf28c2a91ced63359e1bd15b14ea9 Mon Sep 17 00:00:00 2001 From: haorendashu <385321165@qq.com> Date: Mon, 29 May 2023 15:47:09 +0800 Subject: [PATCH 132/314] Update 07.md Implementation --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index a0b5bdc1..ee4e3722 100644 --- a/07.md +++ b/07.md @@ -32,3 +32,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives) - [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) - [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) +- [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) From fe9ed69dc3aec54ae437ca09a6d61aa2ce175577 Mon Sep 17 00:00:00 2001 From: Doug Hoyte Date: Fri, 19 May 2023 00:54:44 -0400 Subject: [PATCH 133/314] Specify replacement behaviour when replaceable events have the same timestamp - This is so that relays can converge on a deterministic sets of events, no matter the order they were received - Otherwise, clients or relays that sync their sets of events could continually retransmit events they think are missing on the other side, wasting bandwidth --- 16.md | 2 ++ 33.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/16.md b/16.md index 4d9481d4..8ef4af4d 100644 --- a/16.md +++ b/16.md @@ -20,6 +20,8 @@ Upon a replaceable event with a newer timestamp than the currently known latest effectively replacing what gets returned when querying for `author:kind` tuples. +If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded. + Ephemeral Events ---------------- An *ephemeral event* is defined as an event with a kind `20000 <= n < 30000`. diff --git a/33.md b/33.md index c93c36e7..5128bece 100644 --- a/33.md +++ b/33.md @@ -18,6 +18,8 @@ replaceable event with the same kind, author and first `d` tag value being recei SHOULD be discarded, effectively replacing what gets returned when querying for `author:kind:d-tag` tuples. +If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded. + 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 867c8bb334b0d9bb22a6af5c16ce6d186852af5a Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Wed, 7 Jun 2023 21:56:17 +0200 Subject: [PATCH 134/314] NIP-89: Recommended Application Handlers (#530) --- 89.md | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 89.md diff --git a/89.md b/89.md new file mode 100644 index 00000000..5eee3b8e --- /dev/null +++ b/89.md @@ -0,0 +1,116 @@ +NIP-89 +====== + +Recommended Application Handlers +-------------------------------- + +`draft` `optional` `author:pablof7z` + +This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds. + +## Rationale +Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics. +This NIP provides a simple way for clients to discover applications that handle events of a specific kind to ensure smooth cross-client and cross-kind interactions. + +### Parties involved +There are three actors to this workflow: + +* application that handles a specific event kind (note that an application doesn't necessarily need to be a distinct entity and it could just be the same pubkey as user A) + * Publishes `kind:31990`, detailing how apps should redirect to it +* user A, who recommends an app that handles a specific event kind + * Publishes `kind:31989` +* user B, who seeks a recommendation for an app that handles a specific event kind + * Queries for `kind:31989` and, based on results, queries for `kind:31990` + +# Events + +## Recommendation event +```json +{ + "kind": 31989, + "pubkey": , + "tags": [ + [ "d", ], + [ "a", "31990:app1-pubkey:", "wss://relay1", "ios" ], + [ "a", "31990:app2-pubkey:", "wss://relay2", "web" ] + ] +} +``` + +The `d` tag in `kind:31989` is the supported event kind this event is recommending. + +Multiple `a` tags can appear on the same `kind:31989`. + +The second value of the tag SHOULD be a relay hint. +The third value of the tag SHOULD be the platform where this recommendation might apply. + +## Handler information +```json +{ + "kind": 31990, + "pubkey": , + "content": "", + "tags": [ + [ "d", ], + [ "k", ], + [ "web", "https://..../a/", "nevent" ], + [ "web", "https://..../p/", "nprofile" ], + [ "web", "https://..../e/" ], + [ "ios", ".../" ] + ] +} +``` + +* `content` is an optional `set_metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) + +* `k` tags' value is the event kind that is supported by this `kind:31990`. +Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: + * Multiple `k` tags can exist in the same event if the application supports more than one event kind and their handler URLs are the same. + * The same pubkey can have multiple events with different apps that handle the same event kind. + +* `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application. + +Multiple tags might be registered by the app, following NIP-19 nomenclature as the second value of the array. + +A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag. + +# User flow +A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application. + +When user B sees an unknown event kind, e.g. in a social-media centric nostr client, the client would allow user B to interact with the unknown-kind event (e.g. tapping on it). + +The client MIGHT query for the user's and the user's follows handler. + +# Example + +## User A recommends a `kind:31337`-handler +User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler. + +```json +{ + "kind": 31989, + "tags": [ + [ "d", "31337" ], + [ "a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", , "web" ] + ] +} +``` + +## User B interacts with a `kind:31337`-handler +User B might see in their timeline an event referring to a `kind:31337` event +(e.g. a `kind:1` tagging a `kind:31337`). + +User B's client, not knowing how to handle a `kind:31337` might display the event +using its `alt` tag (as described in NIP-31). When the user clicks on the event, +the application queries for a handler for this `kind`: + +`["REQ", , '[{ "kinds": [31989], "#d": ["31337"], 'authors': [, ] }]']` + +User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. + +User B's client sees the application's `kind:31990` which includes the information to redirect the user to the relevant URL with the desired entity replaced in the URL. + +## Alternative query bypassing `kind:31989` +Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms to avoid directing users to malicious handlers. + +`["REQ", , '[{ "kinds": [31990], "#k": [], 'authors': [...] }]']` \ No newline at end of file From c78856d281658ba5c795b5295418692aa2827d2e Mon Sep 17 00:00:00 2001 From: pablof7z Date: Wed, 7 Jun 2023 23:19:56 +0200 Subject: [PATCH 135/314] update readme with NIP-89 --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 963fd791..fbe43f9e 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) +- [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) ## Event Kinds @@ -101,6 +102,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | +| `31989` | Handler recommendation | [89](89.md) | +| `31990` | Handler information | [89](89.md) | ### Event Kind Ranges From 0d962cbe74018c64cd040c6c756ed94b648eef4b Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 8 Jun 2023 12:15:37 +0900 Subject: [PATCH 136/314] Minor JSON fix --- 09.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/09.md b/09.md index 89781fbf..a73e0ab1 100644 --- a/09.md +++ b/09.md @@ -20,7 +20,7 @@ For example: "pubkey": <32-bytes hex-encoded public key of the event creator>, "tags": [ ["e", "dcd59..464a2"], - ["e", "968c5..ad7a4"], + ["e", "968c5..ad7a4"] ], "content": "these posts were published by accident", ...other fields From 89b308d5402d7b4c4e8daabdaa9f28a45cc2a829 Mon Sep 17 00:00:00 2001 From: Suhail Saqan Date: Thu, 8 Jun 2023 11:48:03 -0500 Subject: [PATCH 137/314] add image to nip11 --- 11.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/11.md b/11.md index b0d6003f..3ad6896c 100644 --- a/11.md +++ b/11.md @@ -255,6 +255,18 @@ Relays that require payments may want to expose their fee schedules. } ``` +### Image ### + +A URL pointing to an image to be used to represent the relay. + +```json +{ +... + "image": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", +... +} +``` + ### Examples ### As of 2 May 2023 the following `curl` command provided these results. @@ -281,4 +293,5 @@ As of 2 May 2023 the following `curl` command provided these results. "payment_required":true}, "payments_url":"https://eden.nostr.land/invoices", "fees":{"admission":[{"amount":5000000,"unit":"msats"}], - "publication":[]}} + "publication":[]}}, + "image": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" From 964bc5b5ce946ab66aae945084549f26ffdef70f Mon Sep 17 00:00:00 2001 From: pablof7z Date: Thu, 8 Jun 2023 22:27:00 +0200 Subject: [PATCH 138/314] update NIP to use alt tag --- 31.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/31.md b/31.md index 675c2496..e77ae341 100644 --- a/31.md +++ b/31.md @@ -6,8 +6,10 @@ Dealing with unknown event kinds `draft` `optional` `author:pablof7z` `author:fiatjaf` -When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use the `tags` field to store all their custom data related to their protocol, and use the `content` field to write a short human-readable plaintext summary of what that event is about. +When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use an `alt` tag to write a short human-readable plaintext summary of what that event is about. -The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. +The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. The content of the `alt` tag should provide enough context for a user that doesn't know anything about this event kind to understand what it is. These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. + +`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md). From d435ffc39cacf485662cea5c98aaa4af5af3b447 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 9 Jun 2023 14:13:42 -0300 Subject: [PATCH 139/314] clarify kind:1 plaintextness. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 33a10e70..717e58af 100644 --- a/01.md +++ b/01.md @@ -99,7 +99,7 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. ## Basic Event Kinds - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say). Do not use Markdown! Clients should not have to guess how to interpret content like `[]()`. Use different event kinds for parsable content. + - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. From 3e03b4b67f3421c8b7604426a7217422cdd013ff Mon Sep 17 00:00:00 2001 From: Seth For Privacy Date: Fri, 9 Jun 2023 11:19:23 -0400 Subject: [PATCH 140/314] Add context for limiting `before` timestamp --- 26.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/26.md b/26.md index b8fa9028..91176991 100644 --- a/26.md +++ b/26.md @@ -52,7 +52,9 @@ For example, the following condition strings are valid: - `kind=0&kind=1&created_at>1675721813` - `kind=1&created_at>1674777689&created_at<1675721813` -For the vast majority of use-cases, it is advisable that query strings should include a `created_at` ***after*** condition reflecting the current time, to prevent the delegatee from publishing historic notes on the delegator's behalf. +For the vast majority of use-cases, it is advisable that: +1. Query strings should include a `created_at` ***after*** condition reflecting the current time, to prevent the delegatee from publishing historic notes on the delegator's behalf. +2. Query strings should include a `created_at` ***before*** condition that is not empty and is not some extremely distant time in the future. If delegations are not limited in time scope, they expose similar security risks to simply using the root key for authentication. #### Example @@ -105,4 +107,4 @@ Clients should display the delegated note as if it was published directly by the 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 +Relays SHOULD allow the delegator (8e0d3d3e) to delete the events published by the delegatee (477318cf). From 2e842b496a740f89ad80bf8257c37535d538ba54 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sat, 10 Jun 2023 17:52:25 +0900 Subject: [PATCH 141/314] Add description for clients to kind 1 --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 717e58af..2700dab1 100644 --- a/01.md +++ b/01.md @@ -99,7 +99,7 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. ## Basic Event Kinds - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. + - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. From fb5f5a1a974655eca7603b8b0f81b96922813eb2 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 12 Jun 2023 12:45:52 +0900 Subject: [PATCH 142/314] Fix typo "NIP: 26" to "NIP-26" --- 26.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/26.md b/26.md index 91176991..59cf807f 100644 --- a/26.md +++ b/26.md @@ -1,4 +1,4 @@ -NIP: 26 +NIP-26 ======= Delegated Event Signing From 2b34e9f4177216ea42ea32daafb3384521d94f32 Mon Sep 17 00:00:00 2001 From: Memory-of-Snow Date: Mon, 12 Jun 2023 17:46:01 +0900 Subject: [PATCH 143/314] Add a ',' between the 'id' and 'pubkey' elements in the JSON event in 01.md. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 2700dab1..9164a98d 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 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 a9f2c6a2f128e9dda70716ace7ba72c7a3c88c3f Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Mon, 15 May 2023 05:53:50 -0700 Subject: [PATCH 144/314] Add NIP-32 for labeling things in nostr --- 32.md | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 130 insertions(+) create mode 100644 32.md diff --git a/32.md b/32.md new file mode 100644 index 00000000..7bb51069 --- /dev/null +++ b/32.md @@ -0,0 +1,129 @@ +NIP-32 +====== + +Labeling +--------- + +`draft` `optional` `author:staab` `author:gruruya` + +A label is a `kind 1985` note that is used to label other entities. This supports a number of use cases: + +- Distributed moderation and content recommendations +- Reviews and ratings +- Definition of edges in a graph structure + +This NIP does not supersede NIP-56, which supports reporting content for the purpose of +direct moderation, in order to comply with laws or app store requirements. "Moderation" +as defined by this NIP is only relative to user preferences and should be interpreted +with the social graph in view to provide a better user experience. + +Label Target +---- + +The label event MUST include one or more tags representing the object or objects being +labeled: `e`, `p`, `r`, or `t` tags. This allows for labeling of events, people, relays, +or topics respectively. + +Label Tag +---- + +This NIP introduces a new tag `l` which denotes a label. A label MAY be an unqualified string indicating the type of content based on convention, a qualified string referring to a tag type within nostr, or a qualified string referring to a nomenclature external to nostr. Some examples: + +- `review` - the publisher is leaving a review about the given entity. +- `#t/footstr` - the publisher thinks the given entity should have the `footstr` topic applied. +- `#p/` - the publisher things the given entity should be tagged with with `` +- `MeSH/D005528` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary +- `GeoNames/3173435` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system +- `ISO-3166-2/IT-MI` - Milano, Italy using ISO 3166-2. + +As much as possible, fully-qualified labels should be used. + +Other Tags +----- + +The label event MAY include a `quality` tag with a value of 0 to 1. This allows for an +absolute, granular scale that can be represented in any way (5 stars, color scale, etc). + +The label event MAY include a `confidence` tag with a value of 0 to 1. This indicates the certainty which the author has about their rating. + +Example events +-------------- + +A report that an event contains nudity. + +```json +{ + "kind": 1985, + "tags": [ + ["e", ] + ["l", "nudity"], + ], + "content": "", + ... +} +``` + +A suggestion that multiple pubkeys be associated with the `permies` topic. + +```json +{ + "kind": 1985, + "tags": [ + ["l", "#t/permies"], + ["p", ], + ["p", ], + ], + "content": "", + ... +} +``` + +A review of a relay, as relates to certain topics, including additional dimensions. The author +is indicating here that `relay_url` is related to the bitcoin topic, but they're not very sure +that's the case. + +```json +{ + "kind": 1985, + "tags": [ + ["l", "#t/bitcoin"], + ["r", ], + ["quality", 0.7], + ["confidence", 0.2], + ], + "content": "I think this relay is mostly just bitcoiners.", + ... +} +``` + +A plain review of a relay. + +```json +{ + "kind": 1985, + "tags": [ + ["l", "review"], + ["r", ], + ["quality", 0.1], + ], + "content": "This relay is full of mean people.", + ... +} +``` + +A more abstract use case: defining an edge in a graph structure, in this case identifying +a lightning channel that is open between two pubkeys. This just demonstrates the flexibility +this spec provides for overlaying structured metadata on top of nostr. + +```json +{ + "kind": 1985, + "tags": [ + ["l", "lightning/channel"], + ["p", ], + ["p", ], + ], + "content": "", + ... +} +``` diff --git a/README.md b/README.md index a940ba60..b3b15502 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-28: Public Chat](28.md) - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) +- [NIP-32: Labeling](32.md) - [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) From 621340e26783511b311826c4555d40b5db902b58 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Mon, 15 May 2023 06:47:31 -0700 Subject: [PATCH 145/314] Add example to NIP-32 to support tagging multiple entities with multiple labels --- 32.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/32.md b/32.md index 7bb51069..253a5045 100644 --- a/32.md +++ b/32.md @@ -55,8 +55,26 @@ A report that an event contains nudity. { "kind": 1985, "tags": [ - ["e", ] - ["l", "nudity"], + ["e", ], + ["l", "nudity"] + ], + "content": "", + ... +} +``` + +A single event can apply multiple labels to multiple targets to support mass-tagging. + +```json +{ + "kind": 1985, + "tags": [ + ["e", ], + ["p", ], + ["t", "chickens"], + ["l", "permaculture"], + ["l", "permies"], + ["l", "farming"] ], "content": "", ... @@ -71,7 +89,7 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. "tags": [ ["l", "#t/permies"], ["p", ], - ["p", ], + ["p", ] ], "content": "", ... @@ -89,7 +107,7 @@ that's the case. ["l", "#t/bitcoin"], ["r", ], ["quality", 0.7], - ["confidence", 0.2], + ["confidence", 0.2] ], "content": "I think this relay is mostly just bitcoiners.", ... @@ -104,7 +122,7 @@ A plain review of a relay. "tags": [ ["l", "review"], ["r", ], - ["quality", 0.1], + ["quality", 0.1] ], "content": "This relay is full of mean people.", ... @@ -121,7 +139,7 @@ this spec provides for overlaying structured metadata on top of nostr. "tags": [ ["l", "lightning/channel"], ["p", ], - ["p", ], + ["p", ] ], "content": "", ... From 68b9331b624c8fcaa584c8e4b113793981c9ff80 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 16 May 2023 06:18:01 -0700 Subject: [PATCH 146/314] Add L tag, allow self-labeling, split namespaces out --- 32.md | 56 +++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 37 insertions(+), 19 deletions(-) diff --git a/32.md b/32.md index 253a5045..f5557ca9 100644 --- a/32.md +++ b/32.md @@ -27,16 +27,21 @@ or topics respectively. Label Tag ---- -This NIP introduces a new tag `l` which denotes a label. A label MAY be an unqualified string indicating the type of content based on convention, a qualified string referring to a tag type within nostr, or a qualified string referring to a nomenclature external to nostr. Some examples: +This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Some examples: -- `review` - the publisher is leaving a review about the given entity. -- `#t/footstr` - the publisher thinks the given entity should have the `footstr` topic applied. -- `#p/` - the publisher things the given entity should be tagged with with `` -- `MeSH/D005528` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary -- `GeoNames/3173435` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system -- `ISO-3166-2/IT-MI` - Milano, Italy using ISO 3166-2. +- `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied. +- `["l", "", "#p"]` - the publisher things the given entity should be tagged with with `` +- `["l", "D005528", "MeSH"]` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary +- `["l", "3173435", "GeoNames"]` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system +- `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. +- `["l", "relay", "review"]` - the publisher is leaving a review about a relay. -As much as possible, fully-qualified labels should be used. +`L` tags containing the label namespaces MUST be included in order to support searching by +namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace +MAY be used when the label content is provided by an end user. + +`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events +with a kind other than 1985, labels refer to the event itself. Other Tags ----- @@ -49,21 +54,25 @@ The label event MAY include a `confidence` tag with a value of 0 to 1. This indi Example events -------------- -A report that an event contains nudity. +A report that an event contains nudity. Note that NIP 56 is preferred for reporting content +to clients, while labels are recommended for supporting distributed content moderation use +cases. ```json { "kind": 1985, "tags": [ - ["e", ], - ["l", "nudity"] + ["L", "report"], + ["l", "nudity", "report"], + ["e", ] ], "content": "", ... } ``` -A single event can apply multiple labels to multiple targets to support mass-tagging. +A single event can apply multiple labels to multiple targets to support mass-tagging. Multiple +namespaces may be used at the same time. ```json { @@ -72,9 +81,14 @@ A single event can apply multiple labels to multiple targets to support mass-tag ["e", ], ["p", ], ["t", "chickens"], - ["l", "permaculture"], - ["l", "permies"], - ["l", "farming"] + ["L", "#t"] + ["L", "ugc"] + ["L", "com.example.labels"] + ["l", "chickens", "#t"], + ["l", "user generated content", "ugc"], + ["l", "permaculture", "com.example.labels"], + ["l", "permies", "com.example.labels"], + ["l", "farming", "com.example.labels"], ], "content": "", ... @@ -87,7 +101,8 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. { "kind": 1985, "tags": [ - ["l", "#t/permies"], + ["L", "#t"], + ["l", "permies", "#t"], ["p", ], ["p", ] ], @@ -104,7 +119,8 @@ that's the case. { "kind": 1985, "tags": [ - ["l", "#t/bitcoin"], + ["L", "#t"], + ["l", "bitcoin", "#t"], ["r", ], ["quality", 0.7], ["confidence", 0.2] @@ -120,7 +136,8 @@ A plain review of a relay. { "kind": 1985, "tags": [ - ["l", "review"], + ["L", "review"], + ["l", "relay", "review"], ["r", ], ["quality", 0.1] ], @@ -137,7 +154,8 @@ this spec provides for overlaying structured metadata on top of nostr. { "kind": 1985, "tags": [ - ["l", "lightning/channel"], + ["L", "my-lightning-nomenclature"], + ["l", "channel", "my-lightning-nomenclature"], ["p", ], ["p", ] ], From 34910c8674917a687ed7a71bb4968d6a54ee3f55 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 16 May 2023 12:28:02 -0700 Subject: [PATCH 147/314] Add s3x-jay to author for NIP 32 --- 32.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/32.md b/32.md index f5557ca9..0180a233 100644 --- a/32.md +++ b/32.md @@ -4,7 +4,7 @@ NIP-32 Labeling --------- -`draft` `optional` `author:staab` `author:gruruya` +`draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` A label is a `kind 1985` note that is used to label other entities. This supports a number of use cases: From 95f537e90d568ff23e485f336d251b5d415e1191 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Wed, 17 May 2023 12:50:29 -0700 Subject: [PATCH 148/314] Add relay hints, replaceable events, and clarification about content to NIP 32 --- 32.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/32.md b/32.md index 0180a233..b84fc642 100644 --- a/32.md +++ b/32.md @@ -6,7 +6,7 @@ Labeling `draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` -A label is a `kind 1985` note that is used to label other entities. This supports a number of use cases: +A label is a `kind 1985` (regular) event or `kind 32144` (replaceable) event that is used to label other entities. This supports a number of use cases: - Distributed moderation and content recommendations - Reviews and ratings @@ -22,7 +22,12 @@ Label Target The label event MUST include one or more tags representing the object or objects being labeled: `e`, `p`, `r`, or `t` tags. This allows for labeling of events, people, relays, -or topics respectively. +or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and +`p` tags. + +Any number of targets may be included when using a kind `1985` non-replaceable event. If kind +`32144` is preferred, the event MUST have a single target tag, and its value MUST also be the +value of the `d` tag. Label Tag ---- @@ -51,6 +56,12 @@ absolute, granular scale that can be represented in any way (5 stars, color scal The label event MAY include a `confidence` tag with a value of 0 to 1. This indicates the certainty which the author has about their rating. +Content +------- + +`l` tags should be short, meaningful strings. Longer discussions, such as for a review, or an +explanation of why something was labeled the way it was should go in the event's `content` field. + Example events -------------- @@ -64,7 +75,7 @@ cases. "tags": [ ["L", "report"], ["l", "nudity", "report"], - ["e", ] + ["e", , ] ], "content": "", ... @@ -78,8 +89,8 @@ namespaces may be used at the same time. { "kind": 1985, "tags": [ - ["e", ], - ["p", ], + ["e", , ], + ["p", , ], ["t", "chickens"], ["L", "#t"] ["L", "ugc"] @@ -103,8 +114,8 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. "tags": [ ["L", "#t"], ["l", "permies", "#t"], - ["p", ], - ["p", ] + ["p", , ], + ["p", , ] ], "content": "", ... @@ -156,8 +167,8 @@ this spec provides for overlaying structured metadata on top of nostr. "tags": [ ["L", "my-lightning-nomenclature"], ["l", "channel", "my-lightning-nomenclature"], - ["p", ], - ["p", ] + ["p", , ], + ["p", , ] ], "content": "", ... From 5b32def861fb114feb564ce2d089b7983639ada8 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 23 May 2023 14:33:27 -0700 Subject: [PATCH 149/314] Move annotations to the label tag for NIP-32. Remove replaceable events --- 32.md | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/32.md b/32.md index b84fc642..a16ddf7a 100644 --- a/32.md +++ b/32.md @@ -6,7 +6,7 @@ Labeling `draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` -A label is a `kind 1985` (regular) event or `kind 32144` (replaceable) event that is used to label other entities. This supports a number of use cases: +A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases: - Distributed moderation and content recommendations - Reviews and ratings @@ -25,10 +25,6 @@ labeled: `e`, `p`, `r`, or `t` tags. This allows for labeling of events, people, or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and `p` tags. -Any number of targets may be included when using a kind `1985` non-replaceable event. If kind -`32144` is preferred, the event MUST have a single target tag, and its value MUST also be the -value of the `d` tag. - Label Tag ---- @@ -48,18 +44,21 @@ MAY be used when the label content is provided by an end user. `l` and `L` tags MAY be added to other event kinds to support self-reporting. For events with a kind other than 1985, labels refer to the event itself. -Other Tags +Label Annotations ----- -The label event MAY include a `quality` tag with a value of 0 to 1. This allows for an -absolute, granular scale that can be represented in any way (5 stars, color scale, etc). +A label tag MAY include a 4th positional element detailing extra information about the label in question. This string +should be a url-encoded list of key/value pairs, for example `quality=1&confidence=1`. Any key MAY be used, but the +following are recommended: -The label event MAY include a `confidence` tag with a value of 0 to 1. This indicates the certainty which the author has about their rating. +- `quality` may have a value of 0 to 1. This allows for an absolute, granular scale that can be represented in any way (5 stars, color scale, etc). +- `confidence` may have a value of 0 to 1. This indicates the certainty which the author has about their rating. +- `context` may be a comma-separated list of urls (including NIP-21 urls) indicating other context that should be considered when interpreting labels. Content ------- -`l` tags should be short, meaningful strings. Longer discussions, such as for a review, or an +Labels should be short, meaningful strings. Longer discussions, such as for a review, or an explanation of why something was labeled the way it was should go in the event's `content` field. Example events @@ -131,10 +130,8 @@ that's the case. "kind": 1985, "tags": [ ["L", "#t"], - ["l", "bitcoin", "#t"], - ["r", ], - ["quality", 0.7], - ["confidence", 0.2] + ["l", "bitcoin", "#t", "quality=0.7&confidence=0.2"], + ["r", ] ], "content": "I think this relay is mostly just bitcoiners.", ... @@ -148,9 +145,8 @@ A plain review of a relay. "kind": 1985, "tags": [ ["L", "review"], - ["l", "relay", "review"], - ["r", ], - ["quality", 0.1] + ["l", "relay", "review", "quality=0.1"], + ["r", ] ], "content": "This relay is full of mean people.", ... From 2372874b98fd109cfa517532a276cec456e738f8 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 23 May 2023 14:47:56 -0700 Subject: [PATCH 150/314] Use JSON for label metadata in NIP-32 --- 32.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/32.md b/32.md index a16ddf7a..161af537 100644 --- a/32.md +++ b/32.md @@ -21,7 +21,7 @@ Label Target ---- The label event MUST include one or more tags representing the object or objects being -labeled: `e`, `p`, `r`, or `t` tags. This allows for labeling of events, people, relays, +labeled: `e`, `p`, `a`, `r`, or `t` tags. This allows for labeling of events, people, relays, or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and `p` tags. @@ -47,9 +47,8 @@ with a kind other than 1985, labels refer to the event itself. Label Annotations ----- -A label tag MAY include a 4th positional element detailing extra information about the label in question. This string -should be a url-encoded list of key/value pairs, for example `quality=1&confidence=1`. Any key MAY be used, but the -following are recommended: +A label tag MAY include a 4th positional element detailing extra metadata about the label in question. This string +should be a json-encoded object. Any key MAY be used, but the following are recommended: - `quality` may have a value of 0 to 1. This allows for an absolute, granular scale that can be represented in any way (5 stars, color scale, etc). - `confidence` may have a value of 0 to 1. This indicates the certainty which the author has about their rating. @@ -130,7 +129,7 @@ that's the case. "kind": 1985, "tags": [ ["L", "#t"], - ["l", "bitcoin", "#t", "quality=0.7&confidence=0.2"], + ["l", "bitcoin", "#t", "{\"quality\": 0.7, \"confidence\": 0.2}"], ["r", ] ], "content": "I think this relay is mostly just bitcoiners.", @@ -145,7 +144,7 @@ A plain review of a relay. "kind": 1985, "tags": [ ["L", "review"], - ["l", "relay", "review", "quality=0.1"], + ["l", "relay", "review", "{\"quality\": 0.1}"], ["r", ] ], "content": "This relay is full of mean people.", From 4e8f3adf43afae1944ade2a5031eebf5de0e1fd2 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Wed, 24 May 2023 12:42:26 -0700 Subject: [PATCH 151/314] Recommend qualified names for label namespaces --- 32.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/32.md b/32.md index 161af537..858e6371 100644 --- a/32.md +++ b/32.md @@ -28,14 +28,15 @@ or topics respectively. As with NIP-01, a relay hint SHOULD be included when usi Label Tag ---- -This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Some examples: +This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD ensure they are unambiguous by using a well-defined ISO standard or reverse domain name notation. Some examples: - `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied. - `["l", "", "#p"]` - the publisher things the given entity should be tagged with with `` - `["l", "D005528", "MeSH"]` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary - `["l", "3173435", "GeoNames"]` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system - `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. -- `["l", "relay", "review"]` - the publisher is leaving a review about a relay. +- `["l", "VI-hum", "social.nos.ontology"]` - Violence toward a human being as defined by ontology.nos.social. +- `["l", "review", "social.coracle.ontology"]` - the publisher is leaving a review about the target, as defined by ontology.coracle.social. `L` tags containing the label namespaces MUST be included in order to support searching by namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace @@ -58,7 +59,7 @@ Content ------- Labels should be short, meaningful strings. Longer discussions, such as for a review, or an -explanation of why something was labeled the way it was should go in the event's `content` field. +explanation of why something was labeled the way it was, should go in the event's `content` field. Example events -------------- @@ -143,8 +144,8 @@ A plain review of a relay. { "kind": 1985, "tags": [ - ["L", "review"], - ["l", "relay", "review", "{\"quality\": 0.1}"], + ["L", "social.coracle.ontology"], + ["l", "review", "social.coracle.ontology", "{\"quality\": 0.1}"], ["r", ] ], "content": "This relay is full of mean people.", From 057d097e741453895164590d1c56fe87703c2c97 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Thu, 25 May 2023 10:22:35 -0700 Subject: [PATCH 152/314] Add an example for self-tagging, clarify # labels --- 32.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/32.md b/32.md index 858e6371..dd2f50ca 100644 --- a/32.md +++ b/32.md @@ -30,8 +30,10 @@ Label Tag This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD ensure they are unambiguous by using a well-defined ISO standard or reverse domain name notation. Some examples: +Namespaces starting with `#` indicate that the label target should be associated with the label's value. This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. + - `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied. -- `["l", "", "#p"]` - the publisher things the given entity should be tagged with with `` +- `["l", "", "#p"]` - the publisher thinks the given entity is related to `` - `["l", "D005528", "MeSH"]` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary - `["l", "3173435", "GeoNames"]` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system - `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. @@ -170,3 +172,17 @@ this spec provides for overlaying structured metadata on top of nostr. ... } ``` + +Publishers can self-label by adding `l` tags to their own non-1985 events. + +```json +{ + "kind": 1, + "tags": [ + ["L", "social.nos.ontology"], + ["l", "IL-frd", "social.nos.ontology"] + ], + "content": "Send me 100 sats and I'll send you 200 back", + ... +} +``` From 114302517fa5b4ea499c5725f8a6aab675c36e24 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Sat, 27 May 2023 09:03:48 -0700 Subject: [PATCH 153/314] remove references to nip 56 in nip 32 --- 32.md | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/32.md b/32.md index dd2f50ca..1939555c 100644 --- a/32.md +++ b/32.md @@ -12,11 +12,6 @@ A label is a `kind 1985` event that is used to label other entities. This suppor - Reviews and ratings - Definition of edges in a graph structure -This NIP does not supersede NIP-56, which supports reporting content for the purpose of -direct moderation, in order to comply with laws or app store requirements. "Moderation" -as defined by this NIP is only relative to user preferences and should be interpreted -with the social graph in view to provide a better user experience. - Label Target ---- @@ -66,23 +61,6 @@ explanation of why something was labeled the way it was, should go in the event' Example events -------------- -A report that an event contains nudity. Note that NIP 56 is preferred for reporting content -to clients, while labels are recommended for supporting distributed content moderation use -cases. - -```json -{ - "kind": 1985, - "tags": [ - ["L", "report"], - ["l", "nudity", "report"], - ["e", , ] - ], - "content": "", - ... -} -``` - A single event can apply multiple labels to multiple targets to support mass-tagging. Multiple namespaces may be used at the same time. From 363d112e335c13f4fa1c113e2418db1102c58ed5 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Wed, 7 Jun 2023 16:03:05 -0700 Subject: [PATCH 154/314] Add a note about PREs, update NIP 36 to point to NIP 32 --- 32.md | 15 +++++++++++++-- 36.md | 7 ++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/32.md b/32.md index 1939555c..b572c132 100644 --- a/32.md +++ b/32.md @@ -23,9 +23,13 @@ or topics respectively. As with NIP-01, a relay hint SHOULD be included when usi Label Tag ---- -This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD ensure they are unambiguous by using a well-defined ISO standard or reverse domain name notation. Some examples: +This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. +A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature +external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD +ensure they are unambiguous by using a well-defined ISO standard or reverse domain name notation. Some examples: -Namespaces starting with `#` indicate that the label target should be associated with the label's value. This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. +Namespaces starting with `#` indicate that the label target should be associated with the label's value. +This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. - `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied. - `["l", "", "#p"]` - the publisher thinks the given entity is related to `` @@ -164,3 +168,10 @@ Publishers can self-label by adding `l` tags to their own non-1985 events. ... } ``` + +Other Notes +----------- + +When using this NIP to bulk-label many targets at once, events may be deleted and a replacement +may be published. We have opted not to use parameterizable/replaceable events for this due to the +complexity in coming up with a standard `d` tag. diff --git a/36.md b/36.md index 1223e53c..379d40a4 100644 --- a/36.md +++ b/36.md @@ -9,12 +9,15 @@ Sensitive Content / Content Warning The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown. Clients can hide the content until the user acts on it. +`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) with the `content-warning` namespace to support +further qualification and querying. + #### Spec ``` tag: content-warning options: - - [reason]: optional + - [reason]: optional ``` #### Example @@ -26,6 +29,8 @@ options: "kind": 1, "tags": [ ["t", "hastag"], + ["L", "content-warning"], + ["l", "reason", "content-warning"], ["content-warning", "reason"] /* reason is optional */ ], "content": "sensitive content with #hastag\n", From 92ce49dda0acce1f661868316a9858521d4bc974 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Wed, 7 Jun 2023 16:09:26 -0700 Subject: [PATCH 155/314] Add labeling to nip 56 as well --- 36.md | 4 +++- 56.md | 15 ++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/36.md b/36.md index 379d40a4..6d1cf639 100644 --- a/36.md +++ b/36.md @@ -9,7 +9,7 @@ Sensitive Content / Content Warning The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown. Clients can hide the content until the user acts on it. -`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) with the `content-warning` namespace to support +`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) with the `content-warning` or other namespace to support further qualification and querying. #### Spec @@ -31,6 +31,8 @@ options: ["t", "hastag"], ["L", "content-warning"], ["l", "reason", "content-warning"], + ["L", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"], ["content-warning", "reason"] /* reason is optional */ ], "content": "sensitive content with #hastag\n", diff --git a/56.md b/56.md index 55ee1a2e..42174fb2 100644 --- a/56.md +++ b/56.md @@ -32,6 +32,9 @@ being reported, which consists of the following report types: Some report tags only make sense for profile reports, such as `impersonation` +`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) to support +further qualification and querying. + Example events -------------- @@ -39,7 +42,9 @@ Example events { "kind": 1984, "tags": [ - [ "p", , "nudity"] + ["p", , "nudity"] + ["L", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"], ], "content": "", ... @@ -48,8 +53,8 @@ Example events { "kind": 1984, "tags": [ - [ "e", , "illegal"], - [ "p", ] + ["e", , "illegal"], + ["p", ] ], "content": "He's insulting the king!", ... @@ -58,8 +63,8 @@ Example events { "kind": 1984, "tags": [ - [ "p", , "impersonation"], - [ "p", ] + ["p", , "impersonation"], + ["p", ] ], "content": "Profile is imitating #[1]", ... From 61849b5a6bd1171a4c661c5c0531984a7b3db993 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 13 Jun 2023 09:34:24 -0700 Subject: [PATCH 156/314] Small wording changes --- 32.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/32.md b/32.md index b572c132..fcf6082c 100644 --- a/32.md +++ b/32.md @@ -37,7 +37,7 @@ This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, - `["l", "3173435", "GeoNames"]` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system - `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. - `["l", "VI-hum", "social.nos.ontology"]` - Violence toward a human being as defined by ontology.nos.social. -- `["l", "review", "social.coracle.ontology"]` - the publisher is leaving a review about the target, as defined by ontology.coracle.social. +- `["l", "relay/review", "social.coracle.ontology"]` - the publisher is leaving a review about a relay, as defined by ontology.coracle.social. `L` tags containing the label namespaces MUST be included in order to support searching by namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace @@ -54,7 +54,7 @@ should be a json-encoded object. Any key MAY be used, but the following are reco - `quality` may have a value of 0 to 1. This allows for an absolute, granular scale that can be represented in any way (5 stars, color scale, etc). - `confidence` may have a value of 0 to 1. This indicates the certainty which the author has about their rating. -- `context` may be a comma-separated list of urls (including NIP-21 urls) indicating other context that should be considered when interpreting labels. +- `context` may be an array of urls (including NIP-21 urls) indicating other context that should be considered when interpreting labels. Content ------- @@ -129,7 +129,7 @@ A plain review of a relay. "kind": 1985, "tags": [ ["L", "social.coracle.ontology"], - ["l", "review", "social.coracle.ontology", "{\"quality\": 0.1}"], + ["l", "relay/review", "social.coracle.ontology", "{\"quality\": 0.1}"], ["r", ] ], "content": "This relay is full of mean people.", From bef3e6c941c80114c1a040d42317c8fef4a74e7d Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Tue, 13 Jun 2023 17:30:26 -0700 Subject: [PATCH 157/314] Add a few more notes to nip 32 --- 32.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/32.md b/32.md index fcf6082c..45cadbe7 100644 --- a/32.md +++ b/32.md @@ -26,7 +26,7 @@ Label Tag This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD -ensure they are unambiguous by using a well-defined ISO standard or reverse domain name notation. Some examples: +ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation. Some examples: Namespaces starting with `#` indicate that the label target should be associated with the label's value. This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. @@ -36,8 +36,8 @@ This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, - `["l", "D005528", "MeSH"]` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary - `["l", "3173435", "GeoNames"]` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system - `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. -- `["l", "VI-hum", "social.nos.ontology"]` - Violence toward a human being as defined by ontology.nos.social. -- `["l", "relay/review", "social.coracle.ontology"]` - the publisher is leaving a review about a relay, as defined by ontology.coracle.social. +- `["l", "VI-hum", "com.example.ontology"]` - Violence toward a human being as defined by ontology.example.com. +- `["l", "relay/review", "com.example.ontology"]` - the publisher is leaving a review about a relay, as defined by ontology.example.com. `L` tags containing the label namespaces MUST be included in order to support searching by namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace @@ -128,8 +128,8 @@ A plain review of a relay. { "kind": 1985, "tags": [ - ["L", "social.coracle.ontology"], - ["l", "relay/review", "social.coracle.ontology", "{\"quality\": 0.1}"], + ["L", "com.example.ontology"], + ["l", "relay/review", "com.example.ontology", "{\"quality\": 0.1}"], ["r", ] ], "content": "This relay is full of mean people.", @@ -161,8 +161,8 @@ Publishers can self-label by adding `l` tags to their own non-1985 events. { "kind": 1, "tags": [ - ["L", "social.nos.ontology"], - ["l", "IL-frd", "social.nos.ontology"] + ["L", "com.example.ontology"], + ["l", "IL-frd", "com.example.ontology"] ], "content": "Send me 100 sats and I'll send you 200 back", ... @@ -175,3 +175,14 @@ Other Notes When using this NIP to bulk-label many targets at once, events may be deleted and a replacement may be published. We have opted not to use parameterizable/replaceable events for this due to the complexity in coming up with a standard `d` tag. + +Before creating a vocabulary, explore how your use case may have already been designed and +imitate that design if possible. Reverse domain name notation is encouraged to avoid +namespace clashes, but for the sake of interoperability all namespaces should be +considered open for public use, and not proprietary. In other words, if there is a +namespace that fits your use case, use it even if it points to someone else's domain name. + +Vocabularies MAY choose to include the namespace in the label, delimited by a `:` character. +This may be preferred when defining more formal vocabularies that should not be confused with +another namespace when querying without an `L` tag. For these vocabularies, all labels +SHOULD include the namespace (rather than mixing qualified and unqualified labels). From 992b045aa7b7610d1c492dab717eb183094fec39 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Wed, 14 Jun 2023 09:43:03 -0700 Subject: [PATCH 158/314] remove delimiter recommendation --- 32.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/32.md b/32.md index 45cadbe7..b1473859 100644 --- a/32.md +++ b/32.md @@ -182,7 +182,8 @@ namespace clashes, but for the sake of interoperability all namespaces should be considered open for public use, and not proprietary. In other words, if there is a namespace that fits your use case, use it even if it points to someone else's domain name. -Vocabularies MAY choose to include the namespace in the label, delimited by a `:` character. -This may be preferred when defining more formal vocabularies that should not be confused with -another namespace when querying without an `L` tag. For these vocabularies, all labels -SHOULD include the namespace (rather than mixing qualified and unqualified labels). +Vocabularies MAY choose to fully qualify all labels within a namespace (for example, +`["l", "com.example.vocabulary:my-label"]`. This may be preferred when defining more +formal vocabularies that should not be confused with another namespace when querying +without an `L` tag. For these vocabularies, all labels SHOULD include the namespace +(rather than mixing qualified and unqualified labels). From 58f1667479c94011350d15a0c0d9058a86980c71 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Fri, 16 Jun 2023 01:23:40 +0200 Subject: [PATCH 159/314] NIP-09: Add `a` tag deletion (#600) Co-authored-by: arthurfranca --- 09.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/09.md b/09.md index a73e0ab1..9dab90ff 100644 --- a/09.md +++ b/09.md @@ -8,7 +8,7 @@ Event Deletion A special event with kind `5`, meaning "deletion" is defined as having a list of one or more `e` tags, each referencing an event the author is requesting to be deleted. -Each tag entry must contain an "e" event id intended for deletion. +Each tag entry must contain an "e" event id and/or NIP-33 `a` tags intended for deletion. The event's `content` field MAY contain a text note describing the reason for the deletion. @@ -20,7 +20,8 @@ For example: "pubkey": <32-bytes hex-encoded public key of the event creator>, "tags": [ ["e", "dcd59..464a2"], - ["e", "968c5..ad7a4"] + ["e", "968c5..ad7a4"], + ["a", "::"] ], "content": "these posts were published by accident", ...other fields From b481651e81f3bc1aca8636992e1ede5ded4c1f2d Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 16 Jun 2023 18:18:44 -0300 Subject: [PATCH 160/314] change wording of nip-18 to bring it back to its original intent. --- 18.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/18.md b/18.md index 422ad9ca..cdea9cd4 100644 --- a/18.md +++ b/18.md @@ -9,8 +9,8 @@ Reposts 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 -the stringified JSON of the reposted note event for quick look up. +The `content` of a repost event the stringified JSON of the reposted note +for quick look up. It MAY also be empty, but that is not recommended. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag MUST include a relay URL as its third entry From ece0dda45be1053f673216edb9d6cd8a92035757 Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Sat, 17 Jun 2023 09:07:08 -0700 Subject: [PATCH 161/314] Remove some examples from nip 32 to keep things concise --- 32.md | 77 ++++++----------------------------------------------------- 1 file changed, 7 insertions(+), 70 deletions(-) diff --git a/32.md b/32.md index b1473859..ddd364ae 100644 --- a/32.md +++ b/32.md @@ -6,11 +6,7 @@ Labeling `draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` -A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases: - -- Distributed moderation and content recommendations -- Reviews and ratings -- Definition of edges in a graph structure +A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, from distributed moderation and content recommendations to reviews and ratings. Label Target ---- @@ -26,18 +22,17 @@ Label Tag This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD -ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation. Some examples: +ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation. Namespaces starting with `#` indicate that the label target should be associated with the label's value. This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. +Some examples: + - `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied. - `["l", "", "#p"]` - the publisher thinks the given entity is related to `` -- `["l", "D005528", "MeSH"]` - ["Foot"](https://meshb.nlm.nih.gov/record/ui?ui=D005528) from NIH's Medical Subject Headings vocabulary -- `["l", "3173435", "GeoNames"]` - [Milan, Italy](https://www.geonames.org/3173435/milan.html) using the GeoNames coding system - `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. - `["l", "VI-hum", "com.example.ontology"]` - Violence toward a human being as defined by ontology.example.com. -- `["l", "relay/review", "com.example.ontology"]` - the publisher is leaving a review about a relay, as defined by ontology.example.com. `L` tags containing the label namespaces MUST be included in order to support searching by namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace @@ -65,30 +60,6 @@ explanation of why something was labeled the way it was, should go in the event' Example events -------------- -A single event can apply multiple labels to multiple targets to support mass-tagging. Multiple -namespaces may be used at the same time. - -```json -{ - "kind": 1985, - "tags": [ - ["e", , ], - ["p", , ], - ["t", "chickens"], - ["L", "#t"] - ["L", "ugc"] - ["L", "com.example.labels"] - ["l", "chickens", "#t"], - ["l", "user generated content", "ugc"], - ["l", "permaculture", "com.example.labels"], - ["l", "permies", "com.example.labels"], - ["l", "farming", "com.example.labels"], - ], - "content": "", - ... -} -``` - A suggestion that multiple pubkeys be associated with the `permies` topic. ```json @@ -105,24 +76,7 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. } ``` -A review of a relay, as relates to certain topics, including additional dimensions. The author -is indicating here that `relay_url` is related to the bitcoin topic, but they're not very sure -that's the case. - -```json -{ - "kind": 1985, - "tags": [ - ["L", "#t"], - ["l", "bitcoin", "#t", "{\"quality\": 0.7, \"confidence\": 0.2}"], - ["r", ] - ], - "content": "I think this relay is mostly just bitcoiners.", - ... -} -``` - -A plain review of a relay. +A review of a relay. ```json { @@ -137,24 +91,6 @@ A plain review of a relay. } ``` -A more abstract use case: defining an edge in a graph structure, in this case identifying -a lightning channel that is open between two pubkeys. This just demonstrates the flexibility -this spec provides for overlaying structured metadata on top of nostr. - -```json -{ - "kind": 1985, - "tags": [ - ["L", "my-lightning-nomenclature"], - ["l", "channel", "my-lightning-nomenclature"], - ["p", , ], - ["p", , ] - ], - "content": "", - ... -} -``` - Publishers can self-label by adding `l` tags to their own non-1985 events. ```json @@ -174,7 +110,8 @@ Other Notes When using this NIP to bulk-label many targets at once, events may be deleted and a replacement may be published. We have opted not to use parameterizable/replaceable events for this due to the -complexity in coming up with a standard `d` tag. +complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, +publishers SHOULD limit labeling events to a single namespace. Before creating a vocabulary, explore how your use case may have already been designed and imitate that design if possible. Reverse domain name notation is encouraged to avoid From 1412eb89c2b3fe19b36ea57ef19d5bfe0b6ce929 Mon Sep 17 00:00:00 2001 From: Kieran Date: Sat, 17 Jun 2023 18:49:02 +0100 Subject: [PATCH 162/314] fix typo --- 98.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/98.md b/98.md index 1ccd2611..ecbebc08 100644 --- a/98.md +++ b/98.md @@ -46,7 +46,7 @@ Example event: Servers MUST perform the following checks in order to validate the event: 1. The `kind` MUST be `27235`. 2. The `created_at` MUST be within a reasonable time window (suggestion 60 seconds). -3. The `url` tag MUST be exactly the same as the absolute request URL (including query parameters). +3. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters). 4. The `method` tag MUST be the same HTTP method used for the requested resource. When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD include a SHA256 hash of the request body in a `payload` tag as hex (`["payload", ""]`), servers MAY check this to validate that the requested payload is authorized. From 36e9fd59e93730c2d2002ec7aac58a53e58143a3 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 17 Jun 2023 15:49:52 -0300 Subject: [PATCH 163/314] add note about websocket status code 4000. nip-01 may need some love. --- 01.md | 1 + 1 file changed, 1 insertion(+) diff --git a/01.md b/01.md index 9164a98d..07440585 100644 --- a/01.md +++ b/01.md @@ -110,3 +110,4 @@ A relay may choose to treat different message kinds differently, and it may or m - 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](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. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. +- When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. From 83cbd3e17a12bbc2b63799fe8f53883f80f70809 Mon Sep 17 00:00:00 2001 From: Suhail Saqan Date: Sat, 17 Jun 2023 16:01:03 -0500 Subject: [PATCH 164/314] change from `Image` to `Icon` --- 11.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/11.md b/11.md index 3ad6896c..ec46b367 100644 --- a/11.md +++ b/11.md @@ -255,14 +255,14 @@ Relays that require payments may want to expose their fee schedules. } ``` -### Image ### +### Icon ### -A URL pointing to an image to be used to represent the relay. +A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. ```json { ... - "image": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", + "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", ... } ``` @@ -294,4 +294,4 @@ As of 2 May 2023 the following `curl` command provided these results. "payments_url":"https://eden.nostr.land/invoices", "fees":{"admission":[{"amount":5000000,"unit":"msats"}], "publication":[]}}, - "image": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" + "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" From 7668507cdf5580037c3363a2acaf6a2e1f8e032f Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 16 Jun 2023 18:16:42 -0300 Subject: [PATCH 165/314] kind:16 generic reposts. --- 18.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/18.md b/18.md index cdea9cd4..965263f7 100644 --- a/18.md +++ b/18.md @@ -6,8 +6,8 @@ Reposts `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. +A repost is a `kind 6` event that is used to signal to followers +that a `kind 1` text note is worth reading. The `content` of a repost event the stringified JSON of the reposted note for quick look up. It MAY also be empty, but that is not recommended. @@ -21,5 +21,15 @@ 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. +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. + +## Generic Reposts + +Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` +as a "generic repost", that can include any kind of event inside other than +`kind 1`. + +`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number +of the reposted event as its value. From 1f6c79f6d217d6a8ba9d6ae8d52738ce3ff45251 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 18 Jun 2023 11:36:23 -0300 Subject: [PATCH 166/314] typo on nip 18. --- 18.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/18.md b/18.md index 965263f7..75c4100c 100644 --- a/18.md +++ b/18.md @@ -9,8 +9,7 @@ Reposts A repost is a `kind 6` event that is used to signal to followers that a `kind 1` text note is worth reading. -The `content` of a repost event the stringified JSON of the reposted note -for quick look up. It MAY also be empty, but that is not recommended. +The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag MUST include a relay URL as its third entry From 73e93d09ad596a7170b9dbea4498d0f74805bb70 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 18 Jun 2023 11:39:31 -0300 Subject: [PATCH 167/314] add generic repost to readme. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca2e6881..83d19ad0 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `3` | Contacts | [2](02.md) | | `4` | Encrypted Direct Messages | [4](04.md) | | `5` | Event Deletion | [9](09.md) | -| `6` | Reposts | [18](18.md) | +| `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | +| `16` | Generic Repost | [18](18.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | From 1b35f1153dbf57dd65cedf53672593d253bccc5f Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 21 Jun 2023 17:26:48 +0900 Subject: [PATCH 168/314] Add kind and tags for NIP-32 to lists --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3de2d29d..9893ffcf 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `1063` | File Metadata | [94](94.md) | | `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -156,6 +157,8 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md) | | `i` | identity | proof | [39](39.md) | +| `l` | label, label namespace | annotations | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | | `r` | a reference (URL, etc) | -- | [12](12.md) | | `t` | hashtag | -- | [12](12.md) | From fab6a21a779460f696f11169ddf343b437327592 Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Mon, 26 Jun 2023 10:37:48 +0900 Subject: [PATCH 169/314] fixed typos --- 47.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/47.md b/47.md index c884b978..b6a4f2bc 100644 --- a/47.md +++ b/47.md @@ -33,7 +33,7 @@ There are three event kinds: - `NIP-47 response`: 23195 The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be -a plaintext string with the supported commands, space-seperated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. +a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. @@ -64,8 +64,8 @@ Response: ``` The `result_type` field MUST contain the name of the method that this event is responding to. -The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not succesful. -If the command was succesful, the `error` field must be null. +The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful. +If the command was successful, the `error` field must be null. ### Error codes - `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. From e0fc913719aae2ed1b10884e80f085218738f65d Mon Sep 17 00:00:00 2001 From: tcheeric Date: Sun, 2 Jul 2023 11:57:27 +0100 Subject: [PATCH 170/314] For clarification, the time unit for all date attributes in the filters (since, until) are in seconds --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 07440585..2ff81ebf 100644 --- a/01.md +++ b/01.md @@ -66,8 +66,8 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th "kinds": , "#e": , "#p": , - "since": , - "until": , + "since": , + "until": , "limit": } ``` From 67e950a2009e81df1b8c91b0a2ade0596e83f168 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 3 Jul 2023 14:21:13 +0200 Subject: [PATCH 171/314] wip --- vending-machine.md | 163 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 vending-machine.md diff --git a/vending-machine.md b/vending-machine.md new file mode 100644 index 00000000..273aa28f --- /dev/null +++ b/vending-machine.md @@ -0,0 +1,163 @@ +# NIP-XX: Data Vending Machine +Money in, data out. + +## Rationale +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization"), but where they don't necessarily care about "who" processes the data. + +This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. + +### Actors +There are two actors to the workflow described in this NIP: +* Customers (npubs who request a job) +* Service providers (npubs who fulfill jobs) + +## User flow +* User publishes a job request +`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` + +* Service providers listen for the type of jobs they can perform +`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` + +* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it +* Upon completion, the service provider publishes the result of the job with a `job-result` event. +* Upon acceptance, the user zaps the service provider, tagging the job request + +## Kinds + +This NIP introduces two new kinds: + +* `kind:68001`: Job request -- a request to have a job be processed +* `kind:68002`: Job result -- a proposal of the resulting job + +### Job request +A request to have data processed -- published by a user + +```json +{ + "kind": 68001, + "content": "", + "tags": [ + // The type data processing the user wants to be performed + // on the + [ "j", "", "" ], + [ "input", "", "", "" ], + [ "relays", "wss://..."], + + // stringified sat amount that the user is offering to pay + // for this request + // should this include an optional max price or is it too + // ambiguous? + [ "bid", "", [""] ], + + // max timestamp at which the job is no longer to be processed + [ "expiration", "" ] + + // p tags + [ "p", "service-provider-1" ], + [ "p", "service-provider-2" ], + + // NIP-33 d-tag + [ "d", ""] + ] +} +``` + +#### `content` field +An optional, human-readable description of what this job is for. + +#### `j` tag +Specifies the job to be executed. A job request MUST have exactly one `j` tag. + +A `j` tag MIGHT name a specific model to be used for the computed with. + +#### `input` tag +Specified the input that the job should be executed with. + +* ``: The argument for the input +* ``: The way this argument should be interpreted + * Possible values: + * `url`: a URL to be fetched + * `event`: a different event ID + * `job`: the output of a previous job +* ``: + +#### `relays` tag +A list of relays the service provider should publish its job result to. + +#### `p` tags (optional) +A user might want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. + +#### `expiration` (optional) +A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) + +### Job result +The output of processing the data -- published by the +```json +{ + "pubkey": "service-provider", + + // result + "content": "", + "tags" [ + // stringified JSON request event + [ "request", "<2xxx1-event>" ], + [ "e", ], + [ "p", "" ], + [ "status", "success", ""], + [ "payment", "requested-payment-amount" ] + ] +} +``` + +### `status` tag +The service provider might want to return an error to the user in case the job could not be processed correctly + +### `payment` + +## Job types + +This NIP defines some job types, clients SHOULD specify these types for maximum compatibility with service providers. Other job types might be added to this NIP. + +### `speech-to-text` +#### params +| param | req? | description +|--------------------------------|------|-------- +| `range` | opt | timestamp range (in seconds) of desired text to be transcribed + +### `summarization` +| param | req? | description +|--------------------------------|------|-------- +| `length` | opt | desired length + +### `translation` -- Translate text to a specific language +#### params +| param | req? | description +|--------------------------------|------|-------- +| `language` | req | desired language in BCP 47 format. + +## Job chaining +A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. + +Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. + +## Job feedback +> **Warning** +> Is this hijacking/modifying the meaning of NIP-25 reactions too much? + +A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. +The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result, either +in the form of + + +## Explicitly not addressed in this NIP + +### Reputation system +Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). + +It's out of scope (and undesirable) to have this NIP address this issue; the market should. + +## Notes + +### Multitple job acceptance +* Nothing prevents a user from accepting multiple job results. + From 71803c21a6bdd2413244a47752c129e3c64eaec6 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 3 Jul 2023 14:33:17 +0200 Subject: [PATCH 172/314] Add examples --- vending-machine.md | 84 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 82 insertions(+), 2 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 273aa28f..a94cd332 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -77,8 +77,8 @@ Specified the input that the job should be executed with. * ``: The way this argument should be interpreted * Possible values: * `url`: a URL to be fetched - * `event`: a different event ID - * `job`: the output of a previous job + * `event`: a nostr event ID + * `job`: the output of a previous job with the specified event ID * ``: #### `relays` tag @@ -161,3 +161,83 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar ### Multitple job acceptance * Nothing prevents a user from accepting multiple job results. +# Appendix 1: Examples + +## Customer wants to get a transcript of a podcast from second 900 to 930. + +### `kind:68001`: Job Request +```json +{ + "id": "12345", + "pubkey": "abcdef", + "content": "I need a transcript of Bitcoin.review", + "tags": [ + [ "j", "speech-to-text" ], + [ "params", "range", "900", "930" ], + [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "bid", "5000", "9000" ] + ] +} +``` + +### `kind:1021`: Job fulfillment +```json +{ + "content": "Person 1: blah blah blah", + "tags": [ + ["e", "12345"], + ["p", "abcdef"], + ["status", "success"] + ] +} +``` + +## Customer wants to get a summarization of a podcast + +User publishes two job requests at the same time in the order they should be executed. + +### `kind:68001`: Job Request #1 +```json +{ + "id": "12345", + "pubkey": "abcdef", + "content": "I need a transcript of Bitcoin.review from second 900 to 930", + "tags": [ + [ "j", "speech-to-text" ], + [ "params", "range", "900", "930" ], + [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "bid", "5000", "9000" ] + ] +} +``` + +### `kind:68001`: Job Request #2 +```json +{ + "id": "12346", + "pubkey": "abcdef", + "content": "I need a summarization", + "tags": [ + [ "j", "summarization" ], + [ "params", "length", "3 paragraphs" ], + [ "input", "12346", "job" ], + [ "bid", "300", "900" ] + ] +} +``` + +## Customer wants a translation of a note +### `kind:68001`: Job Request #1 +```json +{ + "id": "12346", + "pubkey": "abcdef", + "content": "", + "tags": [ + [ "j", "translation" ], + [ "input", "", "event" ] + [ "params", "language", "es_AR" ], + [ "bid", "100", "500" ] + ] +} +``` \ No newline at end of file From ce552554a08bb5b9878621abfdde3207d54cae62 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Wed, 5 Jul 2023 11:14:50 +0200 Subject: [PATCH 173/314] wip, part 2 --- vending-machine.md | 208 ++++++++++++++++++++++++++++++--------------- 1 file changed, 139 insertions(+), 69 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index a94cd332..eb26688d 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -1,8 +1,15 @@ -# NIP-XX: Data Vending Machine -Money in, data out. +NIP-XX +====== + +Data Vending Machine +-------------------- + +`draft` `optional` `author:pablof7z` + +This NIP defines the interaction between customers and Service Providers to perform on-demand computation. ## Rationale -Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization"), but where they don't necessarily care about "who" processes the data. +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. @@ -11,26 +18,9 @@ There are two actors to the workflow described in this NIP: * Customers (npubs who request a job) * Service providers (npubs who fulfill jobs) -## User flow -* User publishes a job request -`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` - -* Service providers listen for the type of jobs they can perform -`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` - -* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it -* Upon completion, the service provider publishes the result of the job with a `job-result` event. -* Upon acceptance, the user zaps the service provider, tagging the job request - -## Kinds - -This NIP introduces two new kinds: - -* `kind:68001`: Job request -- a request to have a job be processed -* `kind:68002`: Job result -- a proposal of the resulting job - -### Job request -A request to have data processed -- published by a user +# Event Kinds +## Job request +A request to have data processed -- published by a customer ```json { @@ -38,40 +28,35 @@ A request to have data processed -- published by a user "content": "", "tags": [ // The type data processing the user wants to be performed - // on the - [ "j", "", "" ], - [ "input", "", "", "" ], + [ "j", "", "" ], + + // input(s) for the job request + [ "i", "", "", "" ], + + // relays where the job result should be published [ "relays", "wss://..."], - // stringified sat amount that the user is offering to pay - // for this request - // should this include an optional max price or is it too - // ambiguous? - [ "bid", "", [""] ], - - // max timestamp at which the job is no longer to be processed - [ "expiration", "" ] - - // p tags + // millisats amount that the user is offering to pay + [ "bid", "", "" ], + [ "exp", "" ], [ "p", "service-provider-1" ], [ "p", "service-provider-2" ], - - // NIP-33 d-tag - [ "d", ""] ] } ``` -#### `content` field +### `content` field An optional, human-readable description of what this job is for. -#### `j` tag +### `j` tag Specifies the job to be executed. A job request MUST have exactly one `j` tag. -A `j` tag MIGHT name a specific model to be used for the computed with. +A `j` tag MIGHT name a specific model to be used for the computed with as the second value. -#### `input` tag -Specified the input that the job should be executed with. +### `i` (input) tag +Specifies the input that the job should be executed with. The input is relay-indexable so that clients interested in the exact same job can find it it's result if it's already fulfilled. + +A job request CAN have zero or more inputs. * ``: The argument for the input * ``: The way this argument should be interpreted @@ -81,17 +66,20 @@ Specified the input that the job should be executed with. * `job`: the output of a previous job with the specified event ID * ``: -#### `relays` tag +### `bid` tag +The user MIGHT specify an amount of millisats they are willing to pay for the job to be processed. The user MIGHT also specify a maximum amount of millisats they are willing to pay. + +### `relays` tag A list of relays the service provider should publish its job result to. -#### `p` tags (optional) -A user might want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. +### `p` tags +A user MIGHT want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. -#### `expiration` (optional) +### `exp` A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) -### Job result -The output of processing the data -- published by the +## Job result +The output of processing the data -- published by the service provider. ```json { "pubkey": "service-provider", @@ -100,19 +88,22 @@ The output of processing the data -- published by the "content": "", "tags" [ // stringified JSON request event - [ "request", "<2xxx1-event>" ], - [ "e", ], + [ "request", "<68001-event>" ], + [ "e", ], [ "p", "" ], [ "status", "success", ""], - [ "payment", "requested-payment-amount" ] + [ "amount", "requested-payment-amount" ] ] } ``` -### `status` tag +The result of the job should be in the `content`. If the output is not text, the `content` field should be empty and an `output` tag should be used instead as described below. + +#### `status` tag The service provider might want to return an error to the user in case the job could not be processed correctly -### `payment` +#### `amount` +The amount of millisats the service provider is requesting to be paid. This amount MIGHT be different than the amount specified by the user in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. ## Job types @@ -133,21 +124,52 @@ This NIP defines some job types, clients SHOULD specify these types for maximum #### params | param | req? | description |--------------------------------|------|-------- -| `language` | req | desired language in BCP 47 format. +| `language` | req | requested language in BCP 47 format. -## Job chaining +# Protocol Flow +* User publishes a job request +`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` + +* Service providers listen for the type of jobs they can perform +`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` + +* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) +* Upon completion, the service provider publishes the result of the job with a `job-result` event. +* Upon acceptance, the user zaps the service provider, tagging the job result event. + +# Payment +Customers SHOULD pay service providers whose job results they accept. Users should zap the service provider, tagging the `kind:68002` job result. + + +# Job chaining A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. -## Job feedback +# Reactions > **Warning** > Is this hijacking/modifying the meaning of NIP-25 reactions too much? -A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. -The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result, either -in the form of +## Job request reactions +Service Providers might opt to give feedback about a job. +### E.g. Payment required +```json +{ + "kind": 7, + "content": "Please pay 7 sats for job xxxx", + "tags": [ + [ "e", ], + [ "status", "payment-required" ], + [ "amount", "7000" ], + ] +} +``` + +## Job feedback + +A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. +The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. ## Explicitly not addressed in this NIP @@ -163,7 +185,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar # Appendix 1: Examples -## Customer wants to get a transcript of a podcast from second 900 to 930. +## Transcript of a podcast from second `900` to `930`. ### `kind:68001`: Job Request ```json @@ -174,7 +196,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar "tags": [ [ "j", "speech-to-text" ], [ "params", "range", "900", "930" ], - [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "bid", "5000", "9000" ] ] } @@ -192,7 +214,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar } ``` -## Customer wants to get a summarization of a podcast +## Summarization of a podcast User publishes two job requests at the same time in the order they should be executed. @@ -205,7 +227,7 @@ User publishes two job requests at the same time in the order they should be exe "tags": [ [ "j", "speech-to-text" ], [ "params", "range", "900", "930" ], - [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "bid", "5000", "9000" ] ] } @@ -220,13 +242,13 @@ User publishes two job requests at the same time in the order they should be exe "tags": [ [ "j", "summarization" ], [ "params", "length", "3 paragraphs" ], - [ "input", "12346", "job" ], + [ "i", "12346", "job" ], [ "bid", "300", "900" ] ] } ``` -## Customer wants a translation of a note +## Translation of a note ### `kind:68001`: Job Request #1 ```json { @@ -235,9 +257,57 @@ User publishes two job requests at the same time in the order they should be exe "content": "", "tags": [ [ "j", "translation" ], - [ "input", "", "event" ] + [ "i", "", "event" ] [ "params", "language", "es_AR" ], [ "bid", "100", "500" ] ] } -``` \ No newline at end of file +``` + +## AI-image of the summarization of 2 podcasts + +### `kind:68001`: Job request #1 (transcribe podcast #1) +```json +{ + "id": "123", + "tags": [ + [ "j", "speech-to-text" ], + [ "i", "https://example.com/episode1.mp3", "url" ], + [ "bid", "100", "500" ] + ] +} +``` + +### `kind:68001`: Job request #2 (transcribe podcast #2) +```json +{ + "id": "124", + "tags": [ + [ "j", "speech-to-text" ], + [ "i", "https://example.com/episode2.mp3", "url" ], + [ "bid", "100", "500" ] + ] +} +``` + +### `kind:68001`: Job request #3 (summarize both podcasts into one podcast) +```json +{ + "id": "125", + "tags": [ + [ "j", "summarize" ], + [ "param", "length", "1 paragraph" ], + [ "i", "123", "job" ], + [ "i", "124", "job" ], + [ "bid", "100", "500" ] + ] +} +``` + +# Notes + +* Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. + +* Ambiguity on job acceptance, particularly for job-chaining circumstances is deliberately ambiguous: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. + +That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). From 667c700c1cab5106655df2de528e960b4875db0d Mon Sep 17 00:00:00 2001 From: gsovereignty Date: Sat, 8 Jul 2023 18:51:30 +0800 Subject: [PATCH 174/314] Problem: some of the language is inconsistent --- vending-machine.md | 53 +++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index eb26688d..2f9c0649 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -27,7 +27,7 @@ A request to have data processed -- published by a customer "kind": 68001, "content": "", "tags": [ - // The type data processing the user wants to be performed + // The type of data processing the user wants to be performed [ "j", "", "" ], // input(s) for the job request @@ -49,12 +49,12 @@ A request to have data processed -- published by a customer An optional, human-readable description of what this job is for. ### `j` tag -Specifies the job to be executed. A job request MUST have exactly one `j` tag. +Specifies the job to be executed. A job request MUST have exactly one (1) `j` tag. -A `j` tag MIGHT name a specific model to be used for the computed with as the second value. +A `j` tag MAY include a second value specifying the name of a model to be used when computing the result. ### `i` (input) tag -Specifies the input that the job should be executed with. The input is relay-indexable so that clients interested in the exact same job can find it it's result if it's already fulfilled. +Specifies the input data that the job is to be executed against. The input is relay-indexable so that clients interested in the exact same job can find the input data and the result result (if it's already fulfilled). A job request CAN have zero or more inputs. @@ -64,50 +64,51 @@ A job request CAN have zero or more inputs. * `url`: a URL to be fetched * `event`: a nostr event ID * `job`: the output of a previous job with the specified event ID -* ``: +* ``: an optional field indicating where the data can be found if it is a subset of the provided values, for example the name of the key(s) in a key/value set, or the start and end positions of the data if it's a bytestream. ### `bid` tag -The user MIGHT specify an amount of millisats they are willing to pay for the job to be processed. The user MIGHT also specify a maximum amount of millisats they are willing to pay. +The Customer MAY specify a maximum amount (in millisats) they are willing to pay for the job to be processed. ### `relays` tag -A list of relays the service provider should publish its job result to. +The Service Provider SHOULD publish job results to the relays specified in this this tag. ### `p` tags -A user MIGHT want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. +If a Customer has a preference for specific Service Provider(s) to process this job, they SHOULD indicate this by including the Service Provider(s) pubkey in a `p` tag. This is NOT intended to exclude other Service Providers and they MAY still choose to compete for jobs that have not tagged them. ### `exp` -A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) +A Customer MAY indicate that they will not pay for results produced after a specific Block height or Unix Timestamp. This is intended for time-sensitive jobs where the result is not relevant unless produced within a certain timeframe, e.g. a live transcription service. ## Job result -The output of processing the data -- published by the service provider. +The output of processing the data -- published by the Service Provider. ```json { - "pubkey": "service-provider", + "pubkey": "service-provider pubkey in hex", // result - "content": "", + "content": "string: ", + "kind": 68002, "tags" [ // stringified JSON request event - [ "request", "<68001-event>" ], - [ "e", ], - [ "p", "" ], - [ "status", "success", ""], + [ "request", "" ], + [ "e", "" ], + [ "p", "" ], + [ "status", "success", "" ], [ "amount", "requested-payment-amount" ] ] } ``` -The result of the job should be in the `content`. If the output is not text, the `content` field should be empty and an `output` tag should be used instead as described below. +The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. #### `status` tag -The service provider might want to return an error to the user in case the job could not be processed correctly +The Service Provider MAY indicate errors during processing by including them in the `status` tag, these errors are intended to be consumed by the Customer. #### `amount` -The amount of millisats the service provider is requesting to be paid. This amount MIGHT be different than the amount specified by the user in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. +The amount (in millisats) that the Service Provider is requesting to be paid. This amount MAY differ to the amount specified by the Customer in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. ## Job types -This NIP defines some job types, clients SHOULD specify these types for maximum compatibility with service providers. Other job types might be added to this NIP. +This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. ### `speech-to-text` #### params @@ -127,24 +128,24 @@ This NIP defines some job types, clients SHOULD specify these types for maximum | `language` | req | requested language in BCP 47 format. # Protocol Flow -* User publishes a job request +* Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` -* Service providers listen for the type of jobs they can perform +* Service Providers subsribe to the type of jobs they can perform `{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` -* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) +* When a job comes in, the Service Providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) * Upon completion, the service provider publishes the result of the job with a `job-result` event. * Upon acceptance, the user zaps the service provider, tagging the job result event. # Payment -Customers SHOULD pay service providers whose job results they accept. Users should zap the service provider, tagging the `kind:68002` job result. +Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. # Job chaining -A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. +A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. -Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. # Reactions > **Warning** From 141197c564d97073f0293e3b2f367f0b6b3619c2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Sat, 8 Jul 2023 08:11:22 -0400 Subject: [PATCH 175/314] NIP-53 Live Activities (#498) --- 53.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 53.md diff --git a/53.md b/53.md new file mode 100644 index 00000000..9a86d9e0 --- /dev/null +++ b/53.md @@ -0,0 +1,125 @@ +NIP-53 +====== + +Live Activities +--------------- + +`draft` `optional` `author:vitorpamplona` `author:v0l` + +## Abstract + +Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. + +# Live Event + +A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. + +For example: + +```js +{ + "kind": 30311, + "tags": [ + ["d", ""], + ["title", ""], + ["summary", ""], + ["image", ""], + ["t", "hashtag"] + ["streaming", ""], + ["recording", ""], // used to place the edited video once the activity is over + ["starts", ""], + ["ends", ""], + ["status", ""], + ["current_participants", ""], + ["total_participants", ""], + ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", ""], + ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], + ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], + ["relays", "wss://one.com", "wss://two.com", ...] + ], + "content": "", + ...other fields +} +``` + +A distinct `d` tag should be used for each activity. All other tags are optional. + +Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). + +Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. + +Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` + +The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). + +## Proof of Agreement to Participate + +Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex. + +Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. + +This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. + +# Live Chat Message + +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": 1311, + "tags": [ + ["a", "34550::", "", "root"], + ], + "content": "Zaps to live streams is beautiful." +} +``` + +# Use Cases + +Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com). + +# Example + +Live Streaming + +```json +{ + "id": "57f28dbc264990e2c61e80a883862f7c114019804208b14da0bff81371e484d2", + "pubkey": "1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec", + "created_at": 1687182672, + "kind": 30311, + "tags": [ + ["d", "demo-cf-stream"], + ["title", "Adult Swim Metalocalypse"], + ["summary", "Live stream from IPTV-ORG collection"], + ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], + ["starts", "1687182672"] + ["status", "live"], + ["t", "animation"], + ["t", "iptv"], + ["image", "https://i.imgur.com/CaKq6Mt.png"] + ], + "content": "", + "sig": "5bc7a60f5688effa5287244a24768cbe0dcd854436090abc3bef172f7f5db1410af4277508dbafc4f70a754a891c90ce3b966a7bc47e7c1eb71ff57640f3d389" +} +``` + +Live Streaming chat message + +```json +{ + "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "created_at": 1687286726, + "kind": 1311, + "tags": [ + ["a", "30311:1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec:demo-cf-stream", "", "root"] + ], + "content": "Zaps to live streams is beautiful.", + "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" +} +```` + From 5f27121c98efe01f756ee8d316051913277b33c5 Mon Sep 17 00:00:00 2001 From: Believethehype Date: Sun, 9 Jul 2023 12:08:28 +0200 Subject: [PATCH 176/314] Update vending-machine.md --- vending-machine.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/vending-machine.md b/vending-machine.md index 2f9c0649..e64a667c 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -89,7 +89,7 @@ The output of processing the data -- published by the Service Provider. "kind": 68002, "tags" [ // stringified JSON request event - [ "request", "" ], + [ "request", "<68001-event-as-stringified JSON>" ], [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], @@ -115,6 +115,7 @@ This NIP defines some example job types, Customers SHOULD specify these types fo | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed +| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs ### `summarization` | param | req? | description From 3a32c0fd781bb1b6e2d23eb83da9f0b56e4a233e Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 12:32:26 +0900 Subject: [PATCH 177/314] clarify case-sensitiveness of tag names --- 01.md | 2 +- 12.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 2ff81ebf..686b2ee3 100644 --- a/01.md +++ b/01.md @@ -107,7 +107,7 @@ 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. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. +- The `tags` array can store a case-sensitive 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](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. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. - When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. diff --git a/12.md b/12.md index 74c9d81a..7d1f46e7 100644 --- a/12.md +++ b/12.md @@ -8,7 +8,7 @@ Generic Tag Queries Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. -The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. +The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. Note that tag names are case-sensitive. Example Subscription Filter --------------------------- From 52edccbbe380eeadb7622fc9eb255928dcff6178 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 12:45:16 +0900 Subject: [PATCH 178/314] standardize the terminology --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 686b2ee3..4c2ccd9d 100644 --- a/01.md +++ b/01.md @@ -107,7 +107,7 @@ 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 case-sensitive 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](10.md) for a detailed description of "e" and "p" tags. +- The `tags` array can store a case-sensitive tag name 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](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. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. - When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. From 20b22e7079282fd5403b6f11ea4ddc3f1beb8bfe Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 11:27:58 +0900 Subject: [PATCH 179/314] add NIP-53 to the list --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9893ffcf..2a444c32 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) +- [NIP-53: Live Activities](53.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) @@ -87,6 +88,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | | `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `9734` | Zap Request | [57](57.md) | @@ -108,6 +110,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | +| `30311` | Live Event | [53](53.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | From 7cd861c4d3c7a28d6b0d4ee26ad2a36fdb2670a5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 10 Jul 2023 12:38:50 +0900 Subject: [PATCH 180/314] Update tag list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a444c32..c448df64 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | `description` | badge description | -- | [58](58.md) | | `description` | invoice description | -- | [57](57.md) | -| `emoji` | shortcode | image URL | [30](30.md) | +| `emoji` | shortcode, image URL | -- | [30](30.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) | From a9dd5574531229df065eb9df2212bb7510db1f61 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 11 Jul 2023 15:22:30 +0200 Subject: [PATCH 181/314] get rid of the kind:7 stuff --- vending-machine.md | 131 +++++++++++++++++++++------------------------ 1 file changed, 61 insertions(+), 70 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index e64a667c..0f0b0031 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -33,6 +33,9 @@ A request to have data processed -- published by a customer // input(s) for the job request [ "i", "", "", "" ], + // expected output format + [ "output", "mimetype" ], + // relays where the job result should be published [ "relays", "wss://..."], @@ -45,51 +48,36 @@ A request to have data processed -- published by a customer } ``` -### `content` field -An optional, human-readable description of what this job is for. +* `content` field: An optional, human-readable description of what this job is for. +* `j` tag: Job-type to be executed. + * A job request MUST have exactly one `j` tag. + * It MAY include a second value specifying the name of a model to be used when computing the result. -### `j` tag -Specifies the job to be executed. A job request MUST have exactly one (1) `j` tag. - -A `j` tag MAY include a second value specifying the name of a model to be used when computing the result. - -### `i` (input) tag -Specifies the input data that the job is to be executed against. The input is relay-indexable so that clients interested in the exact same job can find the input data and the result result (if it's already fulfilled). - -A job request CAN have zero or more inputs. - -* ``: The argument for the input -* ``: The way this argument should be interpreted - * Possible values: +* `i` tag: Input data for the job. + * A job request CAN have zero or more inputs. + * Positional arguments: `["i", "", "", "", ""]` + * ``: The argument for the input + * ``: The way this argument should be interpreted, one of: * `url`: a URL to be fetched - * `event`: a nostr event ID + * `event`: a nostr event ID, include an optional relay-url extra param * `job`: the output of a previous job with the specified event ID -* ``: an optional field indicating where the data can be found if it is a subset of the provided values, for example the name of the key(s) in a key/value set, or the start and end positions of the data if it's a bytestream. - -### `bid` tag -The Customer MAY specify a maximum amount (in millisats) they are willing to pay for the job to be processed. - -### `relays` tag -The Service Provider SHOULD publish job results to the relays specified in this this tag. - -### `p` tags -If a Customer has a preference for specific Service Provider(s) to process this job, they SHOULD indicate this by including the Service Provider(s) pubkey in a `p` tag. This is NOT intended to exclude other Service Providers and they MAY still choose to compete for jobs that have not tagged them. - -### `exp` -A Customer MAY indicate that they will not pay for results produced after a specific Block height or Unix Timestamp. This is intended for time-sensitive jobs where the result is not relevant unless produced within a certain timeframe, e.g. a live transcription service. + * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. + * ``: an optional field indicating how this input should be used. +* `output` tag: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format. +* `bid` tag: Customer MAY specify a maximum amount (in millisats) they are willing to pay. +* `relays` tag: relays where Service Providers SHOULD publish responses to. +* `p` tags: Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. +* `exp`: Optional expiration timestamp. Service Providers SHOULD not send results after this timestamp. ## Job result The output of processing the data -- published by the Service Provider. ```json { "pubkey": "service-provider pubkey in hex", - - // result - "content": "string: ", + "content": "", "kind": 68002, "tags" [ - // stringified JSON request event - [ "request", "<68001-event-as-stringified JSON>" ], + [ "request", "<68001-event>" ], [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], @@ -98,36 +86,15 @@ The output of processing the data -- published by the Service Provider. } ``` +## Job feedback +Both customers and service providers can give feedback about a job. + The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. -#### `status` tag -The Service Provider MAY indicate errors during processing by including them in the `status` tag, these errors are intended to be consumed by the Customer. - -#### `amount` -The amount (in millisats) that the Service Provider is requesting to be paid. This amount MAY differ to the amount specified by the Customer in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. - -## Job types - -This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. - -### `speech-to-text` -#### params -| param | req? | description -|--------------------------------|------|-------- -| `range` | opt | timestamp range (in seconds) of desired text to be transcribed -| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs - -### `summarization` -| param | req? | description -|--------------------------------|------|-------- -| `length` | opt | desired length - -### `translation` -- Translate text to a specific language -#### params -| param | req? | description -|--------------------------------|------|-------- -| `language` | req | requested language in BCP 47 format. +* `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. +* `amount`: millisats that the Service Provider is requesting to be paid. +## # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` @@ -142,15 +109,17 @@ This NIP defines some example job types, Customers SHOULD specify these types fo # Payment Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. +Additionally, if a service provider requests full or partial prepayment via a `kind:68003` job-feedback event, the customer SHOULD zap that event to pay the service provider. + +# Cancellation +A `kind:68001` job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. # Job chaining A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. -# Reactions -> **Warning** -> Is this hijacking/modifying the meaning of NIP-25 reactions too much? +# Job Feedback ## Job request reactions Service Providers might opt to give feedback about a job. @@ -169,7 +138,6 @@ Service Providers might opt to give feedback about a job. ``` ## Job feedback - A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. @@ -197,21 +165,21 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar "content": "I need a transcript of Bitcoin.review", "tags": [ [ "j", "speech-to-text" ], - [ "params", "range", "900", "930" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "bid", "5000", "9000" ] + [ "params", "range", "900", "930" ], + [ "bid", "5000", "9000" ], + [ "output", "text/plain" ] ] } ``` -### `kind:1021`: Job fulfillment +### `kind:68002`: Job fulfillment ```json { - "content": "Person 1: blah blah blah", + "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], - ["status", "success"] ] } ``` @@ -306,6 +274,29 @@ User publishes two job requests at the same time in the order they should be exe } ``` +# Appendix 2: Job types + +This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. + +### `speech-to-text` +#### params +| param | req? | description +|--------------------------------|------|-------- +| `range` | opt | timestamp range (in seconds) of desired text to be transcribed +| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs + +### `summarization` +| param | req? | description +|--------------------------------|------|-------- +| `length` | opt | desired length + +### `translation` -- Translate text to a specific language +#### params +| param | req? | description +|--------------------------------|------|-------- +| `language` | req | requested language in BCP 47 format. + + # Notes * Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. From def620e1ce4417a4e78b5012c3a43adbe105f43e Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 11 Jul 2023 22:25:54 +0200 Subject: [PATCH 182/314] more cleanup --- vending-machine.md | 57 +++++++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 0f0b0031..8121ffc0 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -27,19 +27,10 @@ A request to have data processed -- published by a customer "kind": 68001, "content": "", "tags": [ - // The type of data processing the user wants to be performed [ "j", "", "" ], - - // input(s) for the job request [ "i", "", "", "" ], - - // expected output format - [ "output", "mimetype" ], - - // relays where the job result should be published + [ "output", "" ], [ "relays", "wss://..."], - - // millisats amount that the user is offering to pay [ "bid", "", "" ], [ "exp", "" ], [ "p", "service-provider-1" ], @@ -94,7 +85,6 @@ The result of the job SHOULD be included in the `content` field. If the output i * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. * `amount`: millisats that the Service Provider is requesting to be paid. -## # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` @@ -127,7 +117,7 @@ Service Providers might opt to give feedback about a job. ### E.g. Payment required ```json { - "kind": 7, + "kind": 68003, "content": "Please pay 7 sats for job xxxx", "tags": [ [ "e", ], @@ -148,11 +138,6 @@ Service providers are at obvious risk of having their results not compensated. M It's out of scope (and undesirable) to have this NIP address this issue; the market should. -## Notes - -### Multitple job acceptance -* Nothing prevents a user from accepting multiple job results. - # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. @@ -162,7 +147,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar { "id": "12345", "pubkey": "abcdef", - "content": "I need a transcript of Bitcoin.review", + "content": "", "tags": [ [ "j", "speech-to-text" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], @@ -173,13 +158,30 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar } ``` -### `kind:68002`: Job fulfillment +### `kind:68003`: Job Feedback: request for (partial) payment +```json +{ + "kind": 68003, + "content": "", + "tags": [ + ["e", "12345"], + ["p", "abcdef"], + ["status", "payment-required"], + ["amount", "1000"] + ] +} +``` + +* User zaps 1000 sats to event kind:68003. + +### `kind:68002`: Job fulfillment + request for remaining payment ```json { "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], + ["amount", "6000"] ] } ``` @@ -208,7 +210,7 @@ User publishes two job requests at the same time in the order they should be exe { "id": "12346", "pubkey": "abcdef", - "content": "I need a summarization", + "content": "", "tags": [ [ "j", "summarization" ], [ "params", "length", "3 paragraphs" ], @@ -227,13 +229,26 @@ User publishes two job requests at the same time in the order they should be exe "content": "", "tags": [ [ "j", "translation" ], - [ "i", "", "event" ] + [ "i", "", "event", "wss://relay.nostr.com" ] [ "params", "language", "es_AR" ], [ "bid", "100", "500" ] ] } ``` +### `kind:68003`: Job respomse +```json +{ + "kind": 68003, + "content": "Che, que copado, boludo!", + "tags": [ + ["e", "12346"], + ["p", "abcdef"], + ["amount", "1000"] + ] +} +``` + ## AI-image of the summarization of 2 podcasts ### `kind:68001`: Job request #1 (transcribe podcast #1) From a1cd2bd809c6e7476fe1e4dcab78f3a0df22f37d Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Thu, 6 Jul 2023 17:22:42 +0900 Subject: [PATCH 183/314] NIP-25 content might be NIP-30 custom emoji --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index f74bcc08..855f331c 100644 --- a/25.md +++ b/25.md @@ -18,7 +18,7 @@ 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 tallies. -The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike", +The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", or the client MAY display this emoji reaction on the post. Tags From 00ec0c83ace1353b297b60af6bf519cb2ea04f0e Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Tue, 11 Jul 2023 00:15:34 +0900 Subject: [PATCH 184/314] Add new section Custom Emoji Reaction --- 25.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/25.md b/25.md index 855f331c..7a612a14 100644 --- a/25.md +++ b/25.md @@ -47,3 +47,25 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost ev.sign(privkey: privkey) return ev } +``` + +Custom Emoji Reaction +--------------------- + +The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode` in the +reaction content. The client should refer to the emoji tag and render the +content as an emoji if shortcode is specified. + +```json +{ + "kind": 7, + "content": ":soapbox:", + "tags": [ + ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682790000 +} +``` + +The content can be set only one `:shortcode:`. And emoji tag should be one. From ed32c93c9f17ddbfb855e94539a446ba37ec4db3 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 12 Jul 2023 12:38:43 +0900 Subject: [PATCH 185/314] Adjust NIP-14 title to other NIPs --- 14.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/14.md b/14.md index 0b37e8aa..7384394e 100644 --- a/14.md +++ b/14.md @@ -1,8 +1,8 @@ NIP-14 ====== -Subject tag in Text events. ---------------------------- +Subject tag in Text events +-------------------------- `draft` `optional` `author:unclebobmartin` diff --git a/README.md b/README.md index c448df64..71d08682 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-11: Relay Information Document](11.md) - [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) -- [NIP-14: Subject tag in text events.](14.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) From f5a930c824bc0192e1161ebb1ae4e6c21ecb2f94 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 12 Jul 2023 18:37:51 +0900 Subject: [PATCH 186/314] Fix NIP-21 title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 71d08682..274868ac 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [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) +- [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) - [NIP-25: Reactions](25.md) From 1889ac792b7119ba9dc41fd4e904445ad1d9c6b5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 13 Jul 2023 12:34:04 +0900 Subject: [PATCH 187/314] Add k tag to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 274868ac..6da74cd9 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md) | | `i` | identity | proof | [39](39.md) | +| `k` | kind number (string) | -- | [18](18.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | From 0b08cf545b50b4799000e90aa4c5ada2cb73ca62 Mon Sep 17 00:00:00 2001 From: Yoji Shidara Date: Thu, 13 Jul 2023 14:14:36 +0900 Subject: [PATCH 188/314] Explicitly state that the `subscription_id` is treated per connection --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 4c2ccd9d..8b1471d8 100644 --- a/01.md +++ b/01.md @@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", , ...]`, used to request events and subscribe to new updates. * `["CLOSE", ]`, used to stop previous subscriptions. -`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. +`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. `` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From 451c06a3c572a13afe45c1d80616f8e6dd9bb1de Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Thu, 13 Jul 2023 15:14:19 +0200 Subject: [PATCH 189/314] Add initial draft for classifieds NIP --- 402.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 402.md diff --git a/402.md b/402.md new file mode 100644 index 00000000..c0eee147 --- /dev/null +++ b/402.md @@ -0,0 +1,71 @@ +# NIP-402 + +## Classifieds + +`draft` `optional` `author:erskingardner` + +This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful. + +The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) that often sell many units of specific products through very specific channels. + +The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events. + +### Draft / Inactive Listings + +`kind:30403` has the same structure as `kind:30402` and is used to save draft or inactive classified listings. + +### Content + +The `.content` field should be a description of what is being offered and by whom. These events should be a string in Markdown syntax. + +### Author + +The `.pubkey` field of these events are treated as the party creating the listing. + +### Metadata + +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md). + +The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. + +- `"title"`, a title for the listing +- `"summary"`, for short tagline or summary for the listing +- `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. +- `"location"`, for the location. +- `"price"`, for the price of the thing being listed. This is a free-form string. e.g. `€2,000/week` or `$22 per hour` or `$500` + +Other standard tags that might be useful. + +- `"g"`, a geohash for more precise location + +## Example Event + +```json +{ + "kind": 30402, + "created_at": 1675642635, + // Markdown content + "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"], + ["published_at", "1296962229"], + ["t", "electronics"], + ["summary", "More lorem ipsum that is a little more than the title"], + ["location", "NYC"], + ["price", "$100"], + [ + "e", + "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", + "wss://relay.example.com" + ], + [ + "a", + "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", + "wss://relay.nostr.org" + ] + ], + "pubkey": "...", + "id": "..." +} +``` From f065a40ee60d3b0f48f4f09e3daf12d6045cc0ae Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Fri, 14 Jul 2023 00:05:02 +0200 Subject: [PATCH 190/314] Add image tags and change format of the price tag. --- 402.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/402.md b/402.md index c0eee147..5e725c7b 100644 --- a/402.md +++ b/402.md @@ -25,6 +25,7 @@ The `.pubkey` field of these events are treated as the party creating the listin ### Metadata - For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md). +- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](https://github.com/nostr-protocol/nips/blob/master/58.md). This allows clients to display images in carousel format more easily. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. @@ -32,7 +33,17 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"summary"`, for short tagline or summary for the listing - `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. - `"location"`, for the location. -- `"price"`, for the price of the thing being listed. This is a free-form string. e.g. `€2,000/week` or `$22 per hour` or `$500` +- `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. + - `"price"` is the name of the tag + - `""` is the amount in numeric format (but included in the tag as a string) + - `""` is the currency unit in 3-character ISO 4217 format. + - `""` is optional and can be used to describe recurring payments. + +#### `price` examples + +- $50 one-time payment `["price", "50", "USD", ""]` +- €15 per month `["price", "15", "EUR", "monthly"]` +- £50,000 per year `["price", "50000", "GBP", "yearly"]` Other standard tags that might be useful. @@ -51,9 +62,10 @@ Other standard tags that might be useful. ["title", "Lorem Ipsum"], ["published_at", "1296962229"], ["t", "electronics"], + ["image", "https://url.to.img", "256x256"], ["summary", "More lorem ipsum that is a little more than the title"], ["location", "NYC"], - ["price", "$100"], + ["price", "100", "USD"], [ "e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", From dd4caf9c4c88728d65dc76dd2adb3bf2bbe6b30e Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 14 Jul 2023 09:08:03 +0900 Subject: [PATCH 191/314] Fix typo --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index 7a612a14..86ce7635 100644 --- a/25.md +++ b/25.md @@ -52,7 +52,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost Custom Emoji Reaction --------------------- -The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode` in the +The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the reaction content. The client should refer to the emoji tag and render the content as an emoji if shortcode is specified. From d1814405beac7a936fa0dedc08359d70b5a9ab48 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 17:31:08 +0900 Subject: [PATCH 192/314] add detailed description of since/until --- 01.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/01.md b/01.md index 8b1471d8..01cfcc1a 100644 --- a/01.md +++ b/01.md @@ -78,6 +78,8 @@ Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON ar The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. +The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. + All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions. A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. From e9924bdcde2dc516a891c027bd023f487b73a674 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sat, 15 Jul 2023 12:24:32 +0200 Subject: [PATCH 193/314] add optional bolt11 --- vending-machine.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 8121ffc0..1d08bd23 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -72,7 +72,7 @@ The output of processing the data -- published by the Service Provider. [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], - [ "amount", "requested-payment-amount" ] + [ "amount", "requested-payment-amount", "" ] ] } ``` @@ -80,21 +80,27 @@ The output of processing the data -- published by the Service Provider. ## Job feedback Both customers and service providers can give feedback about a job. -The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. +The result of the job SHOULD be included in the `content` field. * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: millisats that the Service Provider is requesting to be paid. +* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` +* Service Prpvoders can submit `kind:68003` job-feedback events (e.g. `payment-required`, `processing`, `unprocessable-entity`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:68002` job-result event. +* Upon acceptance, the user zaps the service provider, tagging the job result event with a `kind:7` 👍 reaction. -* Service Providers subsribe to the type of jobs they can perform -`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` +`kind:68002` and `kind:68003` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers +SHOULD use the `payment-required` feedback event to signal that a payment must be done before moving on to the next step. -* When a job comes in, the Service Providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) -* Upon completion, the service provider publishes the result of the job with a `job-result` event. -* Upon acceptance, the user zaps the service provider, tagging the job result event. +## Notes about the protocol flow +The flow is deliverately left ambiguos, allowing vast flexibility for the interaction between customers and service providers so that +service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` +as the first reaction before sending an `processing` or before delivering `kind:68002` results, some might choose to serve partial results +for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to +assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. # Payment Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. @@ -131,7 +137,7 @@ Service Providers might opt to give feedback about a job. A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. -## Explicitly not addressed in this NIP +## Not addressed in this NIP ### Reputation system Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). From 629c787d284c6bf27853f8b272888d86bd48d1dc Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Mon, 17 Jul 2023 12:34:24 +0200 Subject: [PATCH 194/314] Update for feedback on format of price array --- 402.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/402.md b/402.md index 5e725c7b..e63e97ad 100644 --- a/402.md +++ b/402.md @@ -37,13 +37,13 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - `""` is the currency unit in 3-character ISO 4217 format. - - `""` is optional and can be used to describe recurring payments. + - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples -- $50 one-time payment `["price", "50", "USD", ""]` -- €15 per month `["price", "15", "EUR", "monthly"]` -- £50,000 per year `["price", "50000", "GBP", "yearly"]` +- $50 one-time payment `["price", "50", "USD"]` +- €15 per month `["price", "15", "EUR", "month"]` +- £50,000 per year `["price", "50000", "GBP", "year"]` Other standard tags that might be useful. From 63718d6d89269819807b1e1c996d304f7aca64b0 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:20:32 +0200 Subject: [PATCH 195/314] Update price detail --- 402.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/402.md b/402.md index e63e97ad..d5df9241 100644 --- a/402.md +++ b/402.md @@ -36,7 +36,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - - `""` is the currency unit in 3-character ISO 4217 format. + - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. 'btc', 'eth'). - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples From b480624ac27e7083ed01c7f3d2157fddf7bd692a Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:22:56 +0200 Subject: [PATCH 196/314] Improve formatting --- 402.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/402.md b/402.md index d5df9241..c316670f 100644 --- a/402.md +++ b/402.md @@ -36,7 +36,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. 'btc', 'eth'). + - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples From b31d3077f6655f150cca9bb07f5fba895dc815ca Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Mon, 3 Jul 2023 01:23:47 -0400 Subject: [PATCH 197/314] Fix content field in example in NIP-56 Reporting to replace deprecated NIP-08 indexed mentions with NIP-27 bech32 mentions --- 56.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/56.md b/56.md index 42174fb2..43b7bad0 100644 --- a/56.md +++ b/56.md @@ -63,10 +63,9 @@ Example events { "kind": 1984, "tags": [ - ["p", , "impersonation"], - ["p", ] + ["p", , "impersonation"] ], - "content": "Profile is imitating #[1]", + "content": "Profile is impersonating nostr:", ... } ``` @@ -75,7 +74,7 @@ Client behavior --------------- Clients can use reports from friends to make moderation decisions if they -choose to. For instance, if 3+ of your friends report a profile as explicit, +choose to. For instance, if 3+ of your friends report a profile for `nudity`, clients can have an option to automatically blur photos from said account. From afcbef2bb0ad854adfc8dac8d04ba16fe8107115 Mon Sep 17 00:00:00 2001 From: William Casarin Date: Tue, 18 Jul 2023 08:44:29 -0700 Subject: [PATCH 198/314] nip23: add some formatting guidelines to maximize compatibility Link: https://groups.google.com/g/nostr-protocol/c/tnrcWTIAzdU --- 23.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/23.md b/23.md index 42912281..7a06b0ef 100644 --- a/23.md +++ b/23.md @@ -12,7 +12,11 @@ This NIP defines `kind:30023` (a parameterized replaceable event according to [N ### Format -The `.content` of these events should be a string text in Markdown syntax. +The `.content` of these events should be a string text in Markdown syntax. To maximize compatibility and readability between different clients and devices, any client that is creating long form notes: + +- MUST NOT hard line-break paragraphs of text, such as arbitrary line breaks at 80 column boundaries. + +- MUST NOT support adding HTML to Markdown. ### Metadata From 859bd471fe22ce18bcf208581040fbfa3b06dee4 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 22:48:23 +0200 Subject: [PATCH 199/314] Update readme, change NIP number --- 402.md => 99.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) rename 402.md => 99.md (99%) diff --git a/402.md b/99.md similarity index 99% rename from 402.md rename to 99.md index c316670f..e974a5e3 100644 --- a/402.md +++ b/99.md @@ -1,4 +1,4 @@ -# NIP-402 +# NIP-99 ## Classifieds diff --git a/README.md b/README.md index 6da74cd9..9ffff275 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) +- [NIP-99: Classified Listings](99.md) ## Event Kinds @@ -111,6 +112,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | +| `30402` | Classified Listing | [99](99.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | @@ -177,9 +179,11 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `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) | +| `location` | location string | -- | [99](99.md) | | `name` | badge name | -- | [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | From 8efa0e76b471593396690941f234c570830449e4 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 22:52:18 +0200 Subject: [PATCH 200/314] Update title --- 99.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/99.md b/99.md index e974a5e3..274e5afb 100644 --- a/99.md +++ b/99.md @@ -1,6 +1,6 @@ # NIP-99 -## Classifieds +## Classified Listings `draft` `optional` `author:erskingardner` From ad39e1f3ca5ff2e61b1fc718a680c304acd82fef Mon Sep 17 00:00:00 2001 From: William Casarin Date: Mon, 10 Jul 2023 08:40:58 -0700 Subject: [PATCH 201/314] readme: add mailing lists --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9ffff275..a09be5e6 100644 --- a/README.md +++ b/README.md @@ -201,6 +201,21 @@ When experimenting with kinds, keep in mind the classification introduced by [NI 4. There should be no more than one way of doing the same thing. 5. Other rules will be made up when necessary. +## Mailing Lists + +The nostr ecosystem is getting large with many different organizations, relays +and clients. Following the nips repo on github is becoming more difficult and +noisy. To coordinate on protocol development outside of github, there are +mailing lists where you can work on NIPs before submitting them here: + +* [w3c nostr community group][w3-nostr] - [public-nostr@w3.org][mailto-w3] - requires signup +* [nostr-protocol google group][nostr-google-group] - [nostr-protocol@googlegroups.com][mailto-google] - no signup required + +[w3-nostr]: https://www.w3.org/community/nostr/ +[mailto-w3]: mailto:public-nostr@w3.org +[nostr-google-group]: https://groups.google.com/g/nostr-protocol +[mailto-google]: mailto:nostr-protocol@googlegroups.com + ## License All NIPs are public domain. From d0cb9d0c24ec9815b0668bffff246a19352b9ca2 Mon Sep 17 00:00:00 2001 From: erechorse <935horse@gmail.com> Date: Fri, 21 Jul 2023 00:48:55 +0900 Subject: [PATCH 202/314] Fix typos about inline code --- 56.md | 2 +- 57.md | 2 +- 65.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/56.md b/56.md index 43b7bad0..a129926f 100644 --- a/56.md +++ b/56.md @@ -10,7 +10,7 @@ Reporting A report is a `kind 1984` note that is used to report other notes for spam, illegal and explicit content. -The content MAY contain additional information submitted by the entity +The `content` MAY contain additional information submitted by the entity reporting the content. Tags diff --git a/57.md b/57.md index 438a0f87..95dba3b5 100644 --- a/57.md +++ b/57.md @@ -126,7 +126,7 @@ When receiving a payment, the following steps are executed: The following should be true of the `zap receipt` event: -- The content SHOULD be empty. +- 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. diff --git a/65.md b/65.md index 4c7a6a53..55f9ff0a 100644 --- a/65.md +++ b/65.md @@ -10,7 +10,7 @@ A special replaceable event meaning "Relay List Metadata" is defined as an event The primary purpose of this relay list is to advertise to others, not for configuring one's client. -The content is not used and SHOULD be an empty string. +The `content` is not used and SHOULD be an empty string. The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes. @@ -53,12 +53,12 @@ Authors may post events outside of the feed that they wish their followers to fo It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because - finding where someone posts is rather important - - these events do not have content that needs management + - these events do not have `content` that needs management - relays only need to store one replaceable event per pubkey to offer this service ### Why not in kind `0` Metadata -Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have content that may require moderation by relay operators so that it is more acceptable to relays. +Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have `content` that may require moderation by relay operators so that it is more acceptable to relays. ### Example From 2af496e363f58b1d8bd026e8920f62e6a843d134 Mon Sep 17 00:00:00 2001 From: benthecarman <15256660+benthecarman@users.noreply.github.com> Date: Fri, 21 Jul 2023 03:12:02 -0500 Subject: [PATCH 203/314] Fix event kind in example in NIP 53 --- 53.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/53.md b/53.md index 9a86d9e0..c5f2704e 100644 --- a/53.md +++ b/53.md @@ -71,7 +71,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t "created_at": "", "kind": 1311, "tags": [ - ["a", "34550::", "", "root"], + ["a", "30311::", "", "root"], ], "content": "Zaps to live streams is beautiful." } From b503f8a92b22be3037b8115fe3e644865a4fa155 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 19 Jul 2023 12:34:07 +0900 Subject: [PATCH 204/314] Clarify sort order when specified limit --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 01cfcc1a..f607ca20 100644 --- a/01.md +++ b/01.md @@ -84,7 +84,7 @@ All conditions of a filter that are specified must match for an event for it to A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. -The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the latest `n` events. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. +The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. ### From relay to client: sending events and notices From 4a386e645ce38e666ef277f9a21c665ae00ae0ee Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sun, 23 Jul 2023 00:18:56 +0900 Subject: [PATCH 205/314] Add draft kinds to list --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a09be5e6..1360190a 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `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) | +| `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | | `30402` | Classified Listing | [99](99.md) | +| `30403` | Draft Classified Listing | [99](99.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | From 53bd97373b5442445f5c387945cf5685ac39ab80 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 21:28:59 +0200 Subject: [PATCH 206/314] use different kinds per job request type --- vending-machine.md | 217 ++++++++++++++++++++++++++------------------- 1 file changed, 127 insertions(+), 90 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 1d08bd23..4dbc5a3a 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -8,10 +8,19 @@ Data Vending Machine This NIP defines the interaction between customers and Service Providers to perform on-demand computation. +## Kinds +This NIP reserves the range `65000-69999` for data vending machine use. + +| Kind | Description | +| ---- | ----------- | +| 65000 | Job feedback | +| 65001 | Job result | +| 65002-69999 | Job request kinds | + ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. -This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. +This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. ### Actors There are two actors to the workflow described in this NIP: @@ -24,52 +33,44 @@ A request to have data processed -- published by a customer ```json { - "kind": 68001, + "kind": 6xxxx, "content": "", "tags": [ - [ "j", "", "" ], - [ "i", "", "", "" ], + [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], - [ "bid", "", "" ], + [ "bid", "" ], [ "exp", "" ], - [ "p", "service-provider-1" ], - [ "p", "service-provider-2" ], + [ "t", "bitcoin" ] ] } ``` -* `content` field: An optional, human-readable description of what this job is for. -* `j` tag: Job-type to be executed. - * A job request MUST have exactly one `j` tag. - * It MAY include a second value specifying the name of a model to be used when computing the result. - -* `i` tag: Input data for the job. - * A job request CAN have zero or more inputs. - * Positional arguments: `["i", "", "", "", ""]` +* `i` tag: Input data for the job, (zero or more inputs may exist) * ``: The argument for the input - * ``: The way this argument should be interpreted, one of: + * ``: The way this argument should be interpreted, MUST be one of: * `url`: a URL to be fetched * `event`: a nostr event ID, include an optional relay-url extra param * `job`: the output of a previous job with the specified event ID - * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. + * `content`: * ``: an optional field indicating how this input should be used. -* `output` tag: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format. -* `bid` tag: Customer MAY specify a maximum amount (in millisats) they are willing to pay. + * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. +* `output` tag (opt): MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. +* `bid` tag (opt): Customer MAY specify a maximum amount (in millisats) they are willing to pay. * `relays` tag: relays where Service Providers SHOULD publish responses to. -* `p` tags: Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. -* `exp`: Optional expiration timestamp. Service Providers SHOULD not send results after this timestamp. +* `p` tags (opt): Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. +* `exp` (opt): expiration timestamp. Service Providers SHOULD not send results after this timestamp. ## Job result The output of processing the data -- published by the Service Provider. ```json { - "pubkey": "service-provider pubkey in hex", + "pubkey": "", "content": "", - "kind": 68002, + "kind": 65001, "tags" [ - [ "request", "<68001-event>" ], - [ "e", "" ], + [ "request", "" ], + [ "e", "", "" ], [ "p", "" ], [ "status", "success", "" ], [ "amount", "requested-payment-amount", "" ] @@ -77,6 +78,9 @@ The output of processing the data -- published by the Service Provider. } ``` +* `request` tag: The job request event ID. +* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. + ## Job feedback Both customers and service providers can give feedback about a job. @@ -86,29 +90,25 @@ The result of the job SHOULD be included in the `content` field. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. # Protocol Flow -* Customer publishes a job request -`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` -* Service Prpvoders can submit `kind:68003` job-feedback events (e.g. `payment-required`, `processing`, `unprocessable-entity`, etc.). -* Upon completion, the service provider publishes the result of the job with a `kind:68002` job-result event. -* Upon acceptance, the user zaps the service provider, tagging the job result event with a `kind:7` 👍 reaction. +* Customer publishes a job request (e.g. `kind:65002`). +* Service Prpvoders can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. +* At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. -`kind:68002` and `kind:68003` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers -SHOULD use the `payment-required` feedback event to signal that a payment must be done before moving on to the next step. +`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Custeroms are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. ## Notes about the protocol flow -The flow is deliverately left ambiguos, allowing vast flexibility for the interaction between customers and service providers so that -service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` -as the first reaction before sending an `processing` or before delivering `kind:68002` results, some might choose to serve partial results -for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to -assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. +The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. + +It's not up to this NIP to define how individual vending machines should choose to run their business. # Payment -Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. +Customers SHOULD pay service providers whose job results they accept by either zapping the Service Provider and tagging the `kind:65001` job result or, if included, paying the bolt11 invoice. -Additionally, if a service provider requests full or partial prepayment via a `kind:68003` job-feedback event, the customer SHOULD zap that event to pay the service provider. +Additionally, if a service provider requests full or partial prepayment via a `kind:65000` job-feedback event, the customer SHOULD zap that event to pay the service provider. # Cancellation -A `kind:68001` job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. +A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. # Job chaining A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. @@ -116,17 +116,31 @@ A Customer MAY request multiple jobs to be processed in a chained form, so that Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. # Job Feedback +The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback. -## Job request reactions -Service Providers might opt to give feedback about a job. +Any job feedback event MIGHT include an `amount` tag, indicating the amount of millisats the party is requesting to be paid. An optional third value can be a bolt11 invoice. -### E.g. Payment required +| status | description | +|--------|-------------| +| `payment-required` | Service Provider requires payment before continuing. | +| `processing` | Service Provider is processing the job. | +| `error` | Service Provider was unable to process the job. | +| `success` | Service Provider successfully processed the job. | +| `failure` | Service Provider failed to process the job. | +| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | + +Any job feedback event MIGHT include an `amount` tag, as described in the [Job Result](#job-result) section. + +Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. + +### E.g. Payment required (with sample content) ```json { - "kind": 68003, - "content": "Please pay 7 sats for job xxxx", + "kind": 65000, + "content": "This is the transcription service that you", "tags": [ - [ "e", ], + [ "e", , ], + [ "p", ], [ "status", "payment-required" ], [ "amount", "7000" ], ] @@ -144,153 +158,160 @@ Service providers are at obvious risk of having their results not compensated. M It's out of scope (and undesirable) to have this NIP address this issue; the market should. +### Encrypted job requests +Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: +* publish job requests with some useful metadata of the job "e.g. length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. + # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. -### `kind:68001`: Job Request +### `kind:65002`: Speech-to-text job request ```json { "id": "12345", "pubkey": "abcdef", "content": "", + "kind": 65002, "tags": [ - [ "j", "speech-to-text" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "params", "range", "900", "930" ], - [ "bid", "5000", "9000" ], + [ "output", "text/vtt" ], + [ "bid", "50000" ], [ "output", "text/plain" ] ] } ``` -### `kind:68003`: Job Feedback: request for (partial) payment +### `kind:65001`: Job Feedback: request for (partial) payment +* The SP is signaling here that it won't start processing until 100 sats are paid ```json { - "kind": 68003, + "kind": 65000, "content": "", "tags": [ ["e", "12345"], ["p", "abcdef"], ["status", "payment-required"], - ["amount", "1000"] + ["amount", "100000"] ] } ``` -* User zaps 1000 sats to event kind:68003. +* User zaps 100 sats to the `kind:65000` job-feedback -### `kind:68002`: Job fulfillment + request for remaining payment +### `kind:65001`: Job result + request for remaining payment ```json { "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], - ["amount", "6000"] + ["amount", "400000"] ] } ``` ## Summarization of a podcast +User publishes two job requests at the same time. -User publishes two job requests at the same time in the order they should be executed. - -### `kind:68001`: Job Request #1 +### `kind:65002`: Job Request #1: speech-to-text ```json { "id": "12345", "pubkey": "abcdef", + "kinds" 65002, "content": "I need a transcript of Bitcoin.review from second 900 to 930", "tags": [ - [ "j", "speech-to-text" ], - [ "params", "range", "900", "930" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "bid", "5000", "9000" ] + [ "output", "text/plain" ], + [ "params", "range", "900", "930" ], + [ "bid", "100000" ] ] } ``` -### `kind:68001`: Job Request #2 +### `kind:65003`: Job Request #2: summarization of job #1's result ```json { "id": "12346", "pubkey": "abcdef", + "kinds": 65003, "content": "", "tags": [ - [ "j", "summarization" ], - [ "params", "length", "3 paragraphs" ], [ "i", "12346", "job" ], - [ "bid", "300", "900" ] + [ "output", "text/plain" ], + [ "params", "length", "3 paragraphs" ], + [ "bid", "10000" ] ] } ``` ## Translation of a note -### `kind:68001`: Job Request #1 +### `kind:65004`: Job Request #1: translation of an existing note ```json { "id": "12346", "pubkey": "abcdef", "content": "", + "kinds": 65004, "tags": [ - [ "j", "translation" ], [ "i", "", "event", "wss://relay.nostr.com" ] - [ "params", "language", "es_AR" ], - [ "bid", "100", "500" ] + [ "params", "lang", "es_AR" ], + [ "bid", "5000" ] ] } ``` -### `kind:68003`: Job respomse +### `kind:65001`: Job respomse ```json { - "kind": 68003, + "kind": 65001, "content": "Che, que copado, boludo!", "tags": [ ["e", "12346"], ["p", "abcdef"], - ["amount", "1000"] + ["amount", "4000"] ] } ``` ## AI-image of the summarization of 2 podcasts -### `kind:68001`: Job request #1 (transcribe podcast #1) +### `kind:65002`: Job request #1 (transcribe podcast #1) ```json { "id": "123", + "kind" 65002, "tags": [ - [ "j", "speech-to-text" ], [ "i", "https://example.com/episode1.mp3", "url" ], - [ "bid", "100", "500" ] + [ "bid", "100000" ] ] } ``` -### `kind:68001`: Job request #2 (transcribe podcast #2) +### `kind:65002`: Job request #2 (transcribe podcast #2) ```json { "id": "124", + "kind" 65002, "tags": [ - [ "j", "speech-to-text" ], [ "i", "https://example.com/episode2.mp3", "url" ], - [ "bid", "100", "500" ] + [ "bid", "100000" ] ] } ``` -### `kind:68001`: Job request #3 (summarize both podcasts into one podcast) +### `kind:65003`: Job request #3 (summarize both podcasts into one paragraph) ```json { "id": "125", + "kind": 65003, "tags": [ - [ "j", "summarize" ], [ "param", "length", "1 paragraph" ], [ "i", "123", "job" ], [ "i", "124", "job" ], - [ "bid", "100", "500" ] + [ "bid", "100000" ] ] } ``` @@ -299,29 +320,45 @@ User publishes two job requests at the same time in the order they should be exe This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. -### `speech-to-text` +### speech-to-text: `kind:65002` #### params | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed -| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs +| `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs -### `summarization` +### summarization: `kind:65003` | param | req? | description |--------------------------------|------|-------- | `length` | opt | desired length -### `translation` -- Translate text to a specific language -#### params +### translation: `kind:65004` | param | req? | description |--------------------------------|------|-------- -| `language` | req | requested language in BCP 47 format. +| `lang` | req | desired language in BCP 47 format. +### image generation: `kind:65005` +* `input` # Notes -* Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. - -* Ambiguity on job acceptance, particularly for job-chaining circumstances is deliberately ambiguous: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. +* Job acceptance ambiguity, particularly for job-chaining circumstances is deliberate: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). + +# Appendix 3: Service provider discoverability + +Service Providers can use NIP-89 announcements to advertise their support for job kinds: + +```json +{ + "kind": 31990, + "pubkey": , + "tags": [ + [ "k", 65002 ], // e.g. speech-to-text + [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" + ] +} +``` + +Customers can use NIP-89 to see what service providers their follows use. \ No newline at end of file From d8b0e7d757206098f65b8ff868e8c59a9ac92ea6 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 23:37:20 +0300 Subject: [PATCH 207/314] wip --- vending-machine.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 4dbc5a3a..4934d4c3 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -9,13 +9,13 @@ Data Vending Machine This NIP defines the interaction between customers and Service Providers to perform on-demand computation. ## Kinds -This NIP reserves the range `65000-69999` for data vending machine use. +This NIP reserves the range `65000-66000` for data vending machine use. | Kind | Description | | ---- | ----------- | | 65000 | Job feedback | | 65001 | Job result | -| 65002-69999 | Job request kinds | +| 65002-66000 | Job request kinds | ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. @@ -33,7 +33,7 @@ A request to have data processed -- published by a customer ```json { - "kind": 6xxxx, + "kind": <65002-66000>, "content": "", "tags": [ [ "i", "", "", "", "" ], @@ -46,6 +46,8 @@ A request to have data processed -- published by a customer } ``` +All tags are optional. + * `i` tag: Input data for the job, (zero or more inputs may exist) * ``: The argument for the input * ``: The way this argument should be interpreted, MUST be one of: @@ -55,11 +57,11 @@ A request to have data processed -- published by a customer * `content`: * ``: an optional field indicating how this input should be used. * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. -* `output` tag (opt): MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. -* `bid` tag (opt): Customer MAY specify a maximum amount (in millisats) they are willing to pay. -* `relays` tag: relays where Service Providers SHOULD publish responses to. -* `p` tags (opt): Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. -* `exp` (opt): expiration timestamp. Service Providers SHOULD not send results after this timestamp. +* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. +* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay. +* `relays`: relays where Service Providers SHOULD publish responses to. +* `p`: Service Providers the customer is interested in. Other SP MIGHT still choose to process the job. +* `exp`: expiration timestamp. Service Providers SHOULD not send results after this timestamp. ## Job result The output of processing the data -- published by the Service Provider. From 280483adc5b2299886e1e15e369557001e8807af Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 23:58:12 +0300 Subject: [PATCH 208/314] more clarifications --- vending-machine.md | 68 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 16 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 4934d4c3..c4fdc18c 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -17,6 +17,8 @@ This NIP reserves the range `65000-66000` for data vending machine use. | 65001 | Job result | | 65002-66000 | Job request kinds | +[Appendix 2](#appendix-2-job-types) defines the job types. + ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. @@ -33,7 +35,7 @@ A request to have data processed -- published by a customer ```json { - "kind": <65002-66000>, + "kind": xxx, // kind in 65002-66000 range "content": "", "tags": [ [ "i", "", "", "", "" ], @@ -54,8 +56,8 @@ All tags are optional. * `url`: a URL to be fetched * `event`: a nostr event ID, include an optional relay-url extra param * `job`: the output of a previous job with the specified event ID - * `content`: - * ``: an optional field indicating how this input should be used. + * `text`: `` is the value of the input, no resolution is needed + * ``: an optional field indicating how this input should be used within the context of the job. * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. * `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay. @@ -97,7 +99,7 @@ The result of the job SHOULD be included in the `content` field. * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. * At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. -`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Custeroms are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. +`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. ## Notes about the protocol flow The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. @@ -117,6 +119,8 @@ A Customer MAY request multiple jobs to be processed in a chained form, so that Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcast](#summarization-of-a-podcast) + # Job Feedback The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback. @@ -215,7 +219,9 @@ Not to be included in the first draft of this NIP, but encrypted job requests sh ``` ## Summarization of a podcast -User publishes two job requests at the same time. +User publishes two job requests at the same time. A job that transcribes an audio and a job that summarizes the transcription (output of job #1). + +User publishes event #1 and #2 together. ### `kind:65002`: Job Request #1: speech-to-text ```json @@ -223,7 +229,7 @@ User publishes two job requests at the same time. "id": "12345", "pubkey": "abcdef", "kinds" 65002, - "content": "I need a transcript of Bitcoin.review from second 900 to 930", + "content": "", "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "output", "text/plain" ], @@ -233,7 +239,7 @@ User publishes two job requests at the same time. } ``` -### `kind:65003`: Job Request #2: summarization of job #1's result +### `kind:65002`: Job Request #2: summarization of job #1's result ```json { "id": "12346", @@ -241,7 +247,7 @@ User publishes two job requests at the same time. "kinds": 65003, "content": "", "tags": [ - [ "i", "12346", "job" ], + [ "i", "12345", "job" ], // input is the output of job with id 12345 [ "output", "text/plain" ], [ "params", "length", "3 paragraphs" ], [ "bid", "10000" ] @@ -317,30 +323,60 @@ User publishes two job requests at the same time. ] } ``` +## AI-image of embedded input + +### `kind:65005`: Job request +```json +{ + "kind": 65004, + "tags": [ + [ "i", "Millions of vending machines, interconnected with tubes with eah other", "text" ], + [ "param", "prompt", "photorealistic" ], + [ "bid", "500000" ] + ] +} +``` + +### `kind:65006`: Job request #4 (generate image based on the summary) +```json +{ + "id": "126", + "kind": 65004, + "tags": [ + [ "i", "125", "job" ], + [ "param", "prompt", "photorealistic" ], + [ "param", "size", "4000x4000" ], + [ "bid", "500000" ] + ] +} +``` # Appendix 2: Job types -This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. - -### speech-to-text: `kind:65002` -#### params +This is a list of all the supported job requests +. +## speech-to-text: `kind:65002` +### params | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed | `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs -### summarization: `kind:65003` +## summarization: `kind:65003` | param | req? | description |--------------------------------|------|-------- | `length` | opt | desired length -### translation: `kind:65004` +## translation: `kind:65004` | param | req? | description |--------------------------------|------|-------- | `lang` | req | desired language in BCP 47 format. -### image generation: `kind:65005` -* `input` +## image generation: `kind:65005` +| param | req? | description +|--------------------------------|------|-------- +| `prompt` | opt | extra prompt to be used for the image generation +| `size` | opt | desired size of the image # Notes From 4cb3ac871f1c54d2e845ec8655bf564072377a46 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 24 Jul 2023 00:38:47 +0300 Subject: [PATCH 209/314] clarifications, hopefully --- vending-machine.md | 192 ++++++++++++++++++++++----------------------- 1 file changed, 93 insertions(+), 99 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index c4fdc18c..276132df 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -1,4 +1,4 @@ -NIP-XX +NIP-90 ====== Data Vending Machine @@ -6,7 +6,9 @@ Data Vending Machine `draft` `optional` `author:pablof7z` -This NIP defines the interaction between customers and Service Providers to perform on-demand computation. +This NIP defines the interaction between customers and Service Providers for performing on-demand computation. + +Money in, data out. ## Kinds This NIP reserves the range `65000-66000` for data vending machine use. @@ -20,18 +22,18 @@ This NIP reserves the range `65000-66000` for data vending machine use. [Appendix 2](#appendix-2-job-types) defines the job types. ## Rationale -Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. -This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. +This NIP is not to be confused with a 1:1 marketplace; instead, it describes a flow where a user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. ### Actors -There are two actors to the workflow described in this NIP: +There are two actors in the workflow described in this NIP: * Customers (npubs who request a job) * Service providers (npubs who fulfill jobs) # Event Kinds ## Job request -A request to have data processed -- published by a customer +A request to have data processed, published by a customer ```json { @@ -50,33 +52,34 @@ A request to have data processed -- published by a customer All tags are optional. -* `i` tag: Input data for the job, (zero or more inputs may exist) +* `i` tag: Input data for the job (zero or more inputs may exist) * ``: The argument for the input * ``: The way this argument should be interpreted, MUST be one of: - * `url`: a URL to be fetched - * `event`: a nostr event ID, include an optional relay-url extra param - * `job`: the output of a previous job with the specified event ID + * `url`: A URL to be fetched + * `event`: A Nostr event ID, include an optional relay-url extra param + * `job`: The output of a previous job with the specified event ID * `text`: `` is the value of the input, no resolution is needed - * ``: an optional field indicating how this input should be used within the context of the job. - * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. -* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. -* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay. -* `relays`: relays where Service Providers SHOULD publish responses to. -* `p`: Service Providers the customer is interested in. Other SP MIGHT still choose to process the job. -* `exp`: expiration timestamp. Service Providers SHOULD not send results after this timestamp. + * ``: An optional field indicating how this input should be used within the context of the job + * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string +* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified +* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay +* `relays`: Relays where Service Providers SHOULD publish responses to +* `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job +* `exp`: Expiration timestamp. Service Providers SHOULD not send results after this timestamp ## Job result + The output of processing the data -- published by the Service Provider. + ```json { "pubkey": "", "content": "", "kind": 65001, - "tags" [ + "tags": [ [ "request", "" ], [ "e", "", "" ], [ "p", "" ], - [ "status", "success", "" ], [ "amount", "requested-payment-amount", "" ] ] } @@ -91,54 +94,35 @@ Both customers and service providers can give feedback about a job. The result of the job SHOULD be included in the `content` field. * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. +* `amount`: as defined in the [Job Result](#job-result) section. # Protocol Flow * Customer publishes a job request (e.g. `kind:65002`). -* Service Prpvoders can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. * At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. -`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. +`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. ## Notes about the protocol flow -The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. +The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. + +Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. It's not up to this NIP to define how individual vending machines should choose to run their business. -# Payment -Customers SHOULD pay service providers whose job results they accept by either zapping the Service Provider and tagging the `kind:65001` job result or, if included, paying the bolt11 invoice. - -Additionally, if a service provider requests full or partial prepayment via a `kind:65000` job-feedback event, the customer SHOULD zap that event to pay the service provider. - # Cancellation A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. # Job chaining -A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. +A Customer MAY request multiple jobs to be processed as a chain, where the output of a job can be the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. -Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. + +This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcast](#summarization-of-a-podcast) -# Job Feedback -The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback. - -Any job feedback event MIGHT include an `amount` tag, indicating the amount of millisats the party is requesting to be paid. An optional third value can be a bolt11 invoice. - -| status | description | -|--------|-------------| -| `payment-required` | Service Provider requires payment before continuing. | -| `processing` | Service Provider is processing the job. | -| `error` | Service Provider was unable to process the job. | -| `success` | Service Provider successfully processed the job. | -| `failure` | Service Provider failed to process the job. | -| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | - -Any job feedback event MIGHT include an `amount` tag, as described in the [Job Result](#job-result) section. - -Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. - ### E.g. Payment required (with sample content) ```json { @@ -153,20 +137,15 @@ Any job feedback event MIGHT include results in the `.content` field, as describ } ``` -## Job feedback -A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. -The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. - ## Not addressed in this NIP ### Reputation system -Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). - -It's out of scope (and undesirable) to have this NIP address this issue; the market should. +Service providers are at an obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e., building reputation systems, requiring npub "balances", etc.). It's out of scope (and undesirable) to have this NIP address this issue; the market should. ### Encrypted job requests Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: -* publish job requests with some useful metadata of the job "e.g. length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. + * publish job requests with some useful metadata of the job "e.g., length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. + # Appendix 1: Examples @@ -189,7 +168,7 @@ Not to be included in the first draft of this NIP, but encrypted job requests sh } ``` -### `kind:65001`: Job Feedback: request for (partial) payment +### `kind:65000`: Job Feedback: request for (partial) payment * The SP is signaling here that it won't start processing until 100 sats are paid ```json { @@ -228,7 +207,7 @@ User publishes event #1 and #2 together. { "id": "12345", "pubkey": "abcdef", - "kinds" 65002, + "kind": 65002, "content": "", "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], @@ -244,7 +223,7 @@ User publishes event #1 and #2 together. { "id": "12346", "pubkey": "abcdef", - "kinds": 65003, + "kind": 65003, "content": "", "tags": [ [ "i", "12345", "job" ], // input is the output of job with id 12345 @@ -262,16 +241,17 @@ User publishes event #1 and #2 together. "id": "12346", "pubkey": "abcdef", "content": "", - "kinds": 65004, + "kind": 65004, "tags": [ [ "i", "", "event", "wss://relay.nostr.com" ] + [ "output", "text/plain" ], [ "params", "lang", "es_AR" ], [ "bid", "5000" ] ] } ``` -### `kind:65001`: Job respomse +### `kind:65001`: Job result ```json { "kind": 65001, @@ -290,7 +270,7 @@ User publishes event #1 and #2 together. ```json { "id": "123", - "kind" 65002, + "kind": 65002, "tags": [ [ "i", "https://example.com/episode1.mp3", "url" ], [ "bid", "100000" ] @@ -302,7 +282,7 @@ User publishes event #1 and #2 together. ```json { "id": "124", - "kind" 65002, + "kind": 65002, "tags": [ [ "i", "https://example.com/episode2.mp3", "url" ], [ "bid", "100000" ] @@ -310,7 +290,7 @@ User publishes event #1 and #2 together. } ``` -### `kind:65003`: Job request #3 (summarize both podcasts into one paragraph) +### `kind:65003`: Job request #3 (summarize the two job's outputs into one paragraph) ```json { "id": "125", @@ -323,6 +303,21 @@ User publishes event #1 and #2 together. ] } ``` + +### `kind:65005`: Job request #4 (generate image based on the summary) +```json +{ + "id": "126", + "kind": 65004, + "tags": [ + [ "i", "125", "job" ], + [ "param", "prompt", "photorealistic" ], + [ "param", "size", "4000x4000" ], + [ "bid", "500000" ] + ] +} +`` + ## AI-image of embedded input ### `kind:65005`: Job request @@ -337,61 +332,60 @@ User publishes event #1 and #2 together. } ``` -### `kind:65006`: Job request #4 (generate image based on the summary) -```json -{ - "id": "126", - "kind": 65004, - "tags": [ - [ "i", "125", "job" ], - [ "param", "prompt", "photorealistic" ], - [ "param", "size", "4000x4000" ], - [ "bid", "500000" ] - ] -} -``` - # Appendix 2: Job types -This is a list of all the supported job requests -. +This is a list of all the supported job requests. + ## speech-to-text: `kind:65002` + ### params -| param | req? | description -|--------------------------------|------|-------- -| `range` | opt | timestamp range (in seconds) of desired text to be transcribed -| `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs + +| param | req? | description | +|------------|------|-----------------------------------------------------------| +| `range` | opt | timestamp range (in seconds) of desired text to be transcribed | +| `alignment`| opt | word, segment, raw: word-level, segment-level, or raw outputs | ## summarization: `kind:65003` -| param | req? | description -|--------------------------------|------|-------- -| `length` | opt | desired length + +| param | req? | description | +|-----------|------|---------------| +| `length` | opt | desired length | ## translation: `kind:65004` -| param | req? | description -|--------------------------------|------|-------- -| `lang` | req | desired language in BCP 47 format. + +| param | req? | description | +|-----------|------|--------------------------------------------| +| `lang` | req | desired language in BCP 47 format. | ## image generation: `kind:65005` -| param | req? | description -|--------------------------------|------|-------- -| `prompt` | opt | extra prompt to be used for the image generation -| `size` | opt | desired size of the image -# Notes +| param | req? | description | +|-----------|------|-------------------------------------------------------| +| `prompt` | opt | extra prompt to be used for the image generation | +| `size` | opt | desired size of the image | -* Job acceptance ambiguity, particularly for job-chaining circumstances is deliberate: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. -That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). +# Appendix 3: Job feedback status -# Appendix 3: Service provider discoverability +| status | description | +|--------|-------------| +| `payment-required` | Service Provider requires payment before continuing. | +| `processing` | Service Provider is processing the job. | +| `error` | Service Provider was unable to process the job. | +| `success` | Service Provider successfully processed the job. | +| `failure` | Service Provider failed to process the job. | +| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | + +Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. + +# Appendix 4: Service provider discoverability Service Providers can use NIP-89 announcements to advertise their support for job kinds: ```json { "kind": 31990, - "pubkey": , + "pubkey": "", "tags": [ [ "k", 65002 ], // e.g. speech-to-text [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" From 723103506030749fc2bba9d5b4ddaf607dd24da3 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 01:29:02 +0300 Subject: [PATCH 210/314] feed-generation kind and some more stuff --- vending-machine.md | 104 ++++++++++++++++++++++++++++++++------------- 1 file changed, 74 insertions(+), 30 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 276132df..c41ccceb 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -19,7 +19,7 @@ This NIP reserves the range `65000-66000` for data vending machine use. | 65001 | Job result | | 65002-66000 | Job request kinds | -[Appendix 2](#appendix-2-job-types) defines the job types. +[Appendix 2](#appendix-2-job-types) defines the job request types. ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. @@ -32,19 +32,23 @@ There are two actors in the workflow described in this NIP: * Service providers (npubs who fulfill jobs) # Event Kinds + +* `kind:65000`: job feedback +* `kind:65001`: job result +* `kind:65002`-`kind:66000`: job requests + ## Job request -A request to have data processed, published by a customer +A request to have data processed, published by a customer. This event signals that an npub is interested in receiving the result of some kind of compute. ```json { - "kind": xxx, // kind in 65002-66000 range + "kind": 65xxx, // kind in 65002-66000 range "content": "", "tags": [ [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], [ "bid", "" ], - [ "exp", "" ], [ "t", "bitcoin" ] ] } @@ -52,24 +56,25 @@ A request to have data processed, published by a customer All tags are optional. -* `i` tag: Input data for the job (zero or more inputs may exist) +* `i` tag: Input data for the job (zero or more inputs) * ``: The argument for the input - * ``: The way this argument should be interpreted, MUST be one of: + * ``: The way this argument should be interpreted. MUST be one of: * `url`: A URL to be fetched - * `event`: A Nostr event ID, include an optional relay-url extra param + * `event`: A Nostr event ID. * `job`: The output of a previous job with the specified event ID * `text`: `` is the value of the input, no resolution is needed * ``: An optional field indicating how this input should be used within the context of the job * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string -* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified +* `output`: Expected output format. (e.g. MIME type) + * Service Providers MUST publish the result of the job in this format if it has been specified. + * Each job-type ([Appendix 2](#appendix-2-job-types)) might define the output format more narrowly. * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay -* `relays`: Relays where Service Providers SHOULD publish responses to +* `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -* `exp`: Expiration timestamp. Service Providers SHOULD not send results after this timestamp ## Job result -The output of processing the data -- published by the Service Provider. +Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. ```json { @@ -79,28 +84,40 @@ The output of processing the data -- published by the Service Provider. "tags": [ [ "request", "" ], [ "e", "", "" ], - [ "p", "" ], + [ "p", "" ], [ "amount", "requested-payment-amount", "" ] ] } ``` -* `request` tag: The job request event ID. +* `request`: The job request event stringified-JSON. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. ## Job feedback -Both customers and service providers can give feedback about a job. +Service providers can give feedback about a job back to the customer. -The result of the job SHOULD be included in the `content` field. +```json +{ + "kind": 65000, + "content": "", + "tags": [ + [ "status", "", "" ], + [ "amount", "requested-payment-amount", "" ], + [ "e", "", "" ], + [ "p", "" ], + ] +} +``` -* `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: as defined in the [Job Result](#job-result) section. +* `content`: Either empty or a job-result (e.g. for partial-result samples) +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 3](#appendix-3-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. +* `amount` tag: as defined in the [Job Result](#job-result) section. # Protocol Flow -* Customer publishes a job request (e.g. `kind:65002`). +* Customer publishes a job request (e.g. `kind:65002` speech-to-text). * Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. -* At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user `kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. @@ -137,16 +154,6 @@ Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcas } ``` -## Not addressed in this NIP - -### Reputation system -Service providers are at an obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e., building reputation systems, requiring npub "balances", etc.). It's out of scope (and undesirable) to have this NIP address this issue; the market should. - -### Encrypted job requests -Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: - * publish job requests with some useful metadata of the job "e.g., length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. - - # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. @@ -316,7 +323,7 @@ User publishes event #1 and #2 together. [ "bid", "500000" ] ] } -`` +``` ## AI-image of embedded input @@ -364,6 +371,43 @@ This is a list of all the supported job requests. | `prompt` | opt | extra prompt to be used for the image generation | | `size` | opt | desired size of the image | +## event list generation: `kind:65006` + +Generates a list of event ids, (e.g. algorithmic feeds, spam-free notifications, trending topics) + +Output should be a stringified array of elements usually find in a nostr event' `tags`, e.g.: + +```json +{ "content": "[ + [\"e\", \"\"], + [\"a\", \"30023:pubkey:id\"], + [\"t\", \"tag\"], + [\"p\", \"pubkey\"], +]" } +``` + +| param | req? | description | +|-----------|------|-------------------------------------------------------| +| `filter` | opt | JSON-stringified `REQ`-like filter +| `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. +| `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. + +### example job-request + +Generate an algorithmic feed of the most interesting `kind:1`s related to the topic "bitcoin", tagging service providers specializing in safe-for-work content +that would interest pubkey `pubkey1`. + +```json +{ + "kind": 65006, + "tags": [ + [ "param", "filter", "{ \"kinds\": [1], \"#t\": [\"bitcoin\"] }" ], + [ "param", "p", "[\"pubkey1\"]"] + [ "bid", "5000" ], + [ "t", "sfw" ] + ] +} +``` # Appendix 3: Job feedback status From e58a40d2e7a1ea7a096b2d88919cd8cbf0daa219 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 25 Jul 2023 12:33:16 +0900 Subject: [PATCH 211/314] Minor JSON fix --- 56.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/56.md b/56.md index a129926f..259118d7 100644 --- a/56.md +++ b/56.md @@ -42,9 +42,9 @@ Example events { "kind": 1984, "tags": [ - ["p", , "nudity"] + ["p", , "nudity"], ["L", "social.nos.ontology"], - ["l", "NS-nud", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"] ], "content": "", ... From 948ee24775fe89e779efe7680ca6a27dc5a6207f Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 17:20:24 +0300 Subject: [PATCH 212/314] rename file --- vending-machine.md => 90.md | 1 - README.md | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) rename vending-machine.md => 90.md (99%) diff --git a/vending-machine.md b/90.md similarity index 99% rename from vending-machine.md rename to 90.md index c41ccceb..99f313d4 100644 --- a/vending-machine.md +++ b/90.md @@ -417,7 +417,6 @@ that would interest pubkey `pubkey1`. | `processing` | Service Provider is processing the job. | | `error` | Service Provider was unable to process the job. | | `success` | Service Provider successfully processed the job. | -| `failure` | Service Provider failed to process the job. | | `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. diff --git a/README.md b/README.md index 9893ffcf..ebfd3596 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) +- [NIP-90: Data Vending Machines](90.md) - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) @@ -110,6 +111,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30078` | Application-specific Data | [78](78.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `65000` | Job Feedback | [90](90.md) | +| `65001` | Job Result | [90](90.md) | ### Event Kind Ranges @@ -119,6 +122,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10000`--`19999` | Replaceable Events | [16](16.md) | | `20000`--`29999` | Ephemeral Events | [16](16.md) | | `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) | +| `65002`--`66000` | Job Requests | [90](90.md) | ## Message types From 9fa9045d19b93f4cbac231bff39558108a6e82ae Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 17:31:31 +0300 Subject: [PATCH 213/314] remove duplicated output --- 90.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 99f313d4..51c49cf2 100644 --- a/90.md +++ b/90.md @@ -168,9 +168,8 @@ Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcas "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "params", "range", "900", "930" ], - [ "output", "text/vtt" ], + [ "output", "text/plain" ], [ "bid", "50000" ], - [ "output", "text/plain" ] ] } ``` @@ -388,7 +387,7 @@ Output should be a stringified array of elements usually find in a nostr event' | param | req? | description | |-----------|------|-------------------------------------------------------| -| `filter` | opt | JSON-stringified `REQ`-like filter +| `filter` | opt | Stringified JSON `REQ` filter. Used to scope the desired results (e.g. specify the desired kinds) | `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. | `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. From 9e0be8467d9e803c5f0dd8da0d41a762502786df Mon Sep 17 00:00:00 2001 From: "Jesper L. Nielsen" Date: Wed, 26 Jul 2023 15:59:57 +0200 Subject: [PATCH 214/314] Update 01.md Spelling --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index f607ca20..50e9c9ca 100644 --- a/01.md +++ b/01.md @@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", , ...]`, used to request events and subscribe to new updates. * `["CLOSE", ]`, used to stop previous subscriptions. -`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. +`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. `` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From b4cdc1a73d415c79c35655fa02f5e55cd1f2a60c Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sat, 10 Jun 2023 20:57:57 -0400 Subject: [PATCH 215/314] NIP-52: Calendar Events --- 52.md | 209 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 9 ++- 2 files changed, 216 insertions(+), 2 deletions(-) create mode 100644 52.md diff --git a/52.md b/52.md new file mode 100644 index 00000000..c601412e --- /dev/null +++ b/52.md @@ -0,0 +1,209 @@ +NIP-52 +====== + +Calendar Events +--------------- + +`draft` `optional` `author:tyiu` + +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are replaceable and referenceable per [NIP-33](33.md) and deletable per [NIP-09](09.md). + +Unlike the term `calendar event` specific to this NIP, the term `event` is used broadly in all the NIPs to describe any Nostr event. The distinction is being made here to discern between the two terms. + +## Calendar Events + +There are two types of calendar events represented by different kinds: date-based and time-based calendar events. Calendar events are not required to be part of a [calendar](#calendar). + +### Date-Based Calendar Event + +This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. + +#### Format + +The format uses a parameterized replaceable event kind `31922`. + +The `.content` of these events is optional and should be a detailed description of the calendar event. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `name` (required) name of the calendar event +* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. +* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. +* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31922", + "content": "", + "tags": [ + ["d", ""], + + ["name", ""], + + // Dates + ["start", ""], + ["end", ""], + + // Location + ["location", ""], + ["g", ""], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "", ""], + ["p", "<32-bytes hex of a pubkey>", "", ""], + + // Hashtags + ["t", ""], + ["t", ""], + + // Reference links + ["r", ""], + ["r", ""] + ] +} +``` + +### Time-Based Calendar Event + +This kind of calendar event spans between a start time and end time. + +#### Format + +The format uses a parameterized replaceable event kind `31923`. + +The `.content` of these events is optional and should be a detailed description of the calendar event. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `name` (required) name of the calendar event +* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. +* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. +* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` +* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. +* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31923", + "content": "", + "tags": [ + ["d", ""], + + ["name", ""], + + // Timestamps + ["start", ""], + ["end", ""], + + ["start_tzid", ""], + ["end_tzid", ""], + + // Location + ["location", ""], + ["g", ""], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "", ""], + ["p", "<32-bytes hex of a pubkey>", "", ""], + + // Hashtags + ["t", ""], + ["t", ""], + + // Reference links + ["r", ""], + ["r", ""] + ] +} +``` + +## Calendar + +A calendar is a collection of calendar events, represented as a custom replaceable list event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. + +### Format + +The format uses a custom replaceable list of kind `31924` with a list of tags as described below: +* `d` (required) calendar name +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) + +```json +{ + "kind": 31924, + "tags": [ + ["d", ""], + ["a", "<31922 or 31923>::", ""], + ["a", "<31922 or 31923>::", ""] + ] +} +``` + +## Calendar Event RSVP + +A calendar event RSVP is a response to a calendar event to indicate a user's attendance intention. + +If a calendar event tags a pubkey, that can be interpreted as the calendar event creator inviting that user to attend. Clients MAY choose to prompt the user to RSVP for the calendar event. + +Any user may RSVP, even if they were not tagged on the calendar event. Clients MAY choose to prompt the calendar event creator to invite the user who RSVP'd. Clients also MAY choose to ignore these RSVPs. + +This NIP is intentionally not defining who is authorized to attend a calendar event if the user who RSVP'd has not been tagged. It is up to the calendar event creator to determine the semantics. + +This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. + +### Format + +The format uses a parameterized replaceable event kind `31925`. + +The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. + +The list of tags are as follows: +* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) +* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. +* `L` (required) label namespace of `status` per [NIP-32](32.md) +* `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. +* `L` (optional) label namespace of `freebusy` per [NIP-32](32.md). Exists if and only if corresponding `l` tag under the same label namespace exists. +* `l` (optional) label of `free` or `busy` under the label namespace of `freebusy` per [NIP-32](32.md). Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. Exists if and only if corresponding `l` tag under the same label namespace exists. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31925", + "content": "", + "tags": [ + ["a", "<31922 or 31923>::", ""], + ["d", ""], + ["L", "status"], + ["l", "", "status"], + ["L", "freebusy"], + ["l", "", "freebusy"] + ] +} +``` + +## Unsolved Limitations + +* No private events + +## Intentionally Unsupported Scenarios + +### Recurring Calendar Events + +Recurring calendar events come with a lot of complexity, making it difficult for software and humans to deal with. This complexity includes time zone differences between invitees, daylight savings, leap years, multiple calendar systems, one-off changes in schedule or other metadata, etc. + +This NIP intentionally omits support for recurring calendar events and pushes that complexity up to clients to manually implement if they desire. i.e., individual calendar events with duplicated metadata represent recurring calendar events. diff --git a/README.md b/README.md index 1360190a..ff128008 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) +- [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) @@ -115,6 +116,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30311` | Live Event | [53](53.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | +| `31922` | Date-Based Calendar Event | [52](52.md) | +| `31923` | Time-Based Calendar Event | [52](52.md) | +| `31924` | Calendar | [52](52.md) | +| `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | @@ -162,7 +167,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `alt` | Alt tag | -- | [31](31.md) | | `d` | identifier | -- | [33](33.md) | | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| `g` | geohash | -- | [12](12.md) | +| `g` | geohash | -- | [12](12.md), [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md) | | `l` | label, label namespace | annotations | [32](32.md) | @@ -181,7 +186,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `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) | -| `location` | location string | -- | [99](99.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | | `name` | badge name | -- | [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | From 064a79f6142326fa09cda411c15ceca997d37a03 Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Thu, 3 Aug 2023 14:40:45 -0500 Subject: [PATCH 216/314] NIP-48: Proxy Tags --- 48.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 62 insertions(+) create mode 100644 48.md diff --git a/48.md b/48.md new file mode 100644 index 00000000..8f227811 --- /dev/null +++ b/48.md @@ -0,0 +1,60 @@ +NIP-48 +====== + +Proxy Tags +---------- + +`draft` `optional` `author:alexgleason` + +Nostr events bridged from other protocols such as ActivityPub can link back to the source object by including a `"proxy"` tag, in the form: + +``` +["proxy", , ] +``` + +Where: + +- `` is the ID of the source object. The ID format varies depending on the protocol. The ID must be universally unique, regardless of the protocol. +- `` is the name of the protocol, e.g. `"activitypub"`. + +Clients may use this information to reconcile duplicated content bridged from other protocols, or to display a link to the source object. + +Proxy tags may be added to any event kind, and doing so indicates that the event did not originate on the Nostr protocol, and instead originated elsewhere on the web. + +### Supported protocols + +This list may be extended in the future. + +| Protocol | ID format | Example | +| -------- | --------- | ------- | +| `activitypub` | URL | `https://gleasonator.com/objects/9f524868-c1a0-4ee7-ad51-aaa23d68b526` | +| `atproto` | AT URI | `at://did:plc:zhbjlbmir5dganqhueg7y4i3/app.bsky.feed.post/3jt5hlibeol2i` | +| `rss` | URL with guid fragment | `https://soapbox.pub/rss/feed.xml#https%3A%2F%2Fsoapbox.pub%2Fblog%2Fmostr-fediverse-nostr-bridge` | +| `web` | URL | `https://twitter.com/jack/status/20` | + +### Examples + +ActivityPub object: + +```json +{ + "kind": 1, + "content": "I'm vegan btw", + "tags": [ + [ + "proxy", + "https://gleasonator.com/objects/8f6fac53-4f66-4c6e-ac7d-92e5e78c3e79", + "activitypub" + ] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1691091365, + "id": "55920b758b9c7b17854b6e3d44e6a02a83d1cb49e1227e75a30426dea94d4cb2", + "sig": "a72f12c08f18e85d98fb92ae89e2fe63e48b8864c5e10fbdd5335f3c9f936397a6b0a7350efe251f8168b1601d7012d4a6d0ee6eec958067cf22a14f5a5ea579" +} +``` + +### See also + +- [FEP-fffd: Proxy Objects](https://codeberg.org/fediverse/fep/src/branch/main/fep/fffd/fep-fffd.md) +- [Mostr bridge](https://mostr.pub/) \ No newline at end of file diff --git a/README.md b/README.md index ff128008..cfee37dc 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) +- [NIP-48: Proxy Tags](48.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) @@ -191,6 +192,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | From 1912dacd33e69584e7f451e18a81bdc114ea9d76 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:35:23 -0400 Subject: [PATCH 217/314] Simple moderated communities flow. --- 172.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 172.md diff --git a/172.md b/172.md new file mode 100644 index 00000000..0cc81078 --- /dev/null +++ b/172.md @@ -0,0 +1,85 @@ +NIP-172 +======= + +Moderated Communities (Reddit Style) +------------------------------------ + +`draft` `optional` `author:vitorpamplona` + +The goal of this NIP is to create moderator-approved public communities arount a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into to the community, simply tag any Nostr event with an `a` tag. Moderators the issue an approval event `34551` that links the community with the new post. + +# Community definition + +Kind 34550 should include any field that helps define the community and the set of moderators. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "34550", + "tags": [ + ["d", ""], + ["description", ""], + + // moderators + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ] +} +``` + +# New Post Request + +Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "1", + "tags": [ + ["a", "34550::", ""], + ], + "content": "" +} +``` + +Community management clients can filter all mentions to the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at anytime. + +# Post Approval by moderators + +The post approval includes a stringified `new post request` event inside the content's of the approval (NIP-18-style). + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "34551", + "tags": [ + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], + ], + "content": "{ }" +} +``` + +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post approvals for the past post or the community will restart. + +# Displaying + +Community clients can display posts that have been approved by at least 1 moderator or by the community owner. + +The following filter displays the approved posts. + +```js +{ + "authors": ["", "moderator1", "moderator2", "moderator3", ...], + "kinds": 34551, + "#a": ["34550::"], +} +``` \ No newline at end of file From 7f4970bb10923aca7400448a093b4debb4b49267 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:38:20 -0400 Subject: [PATCH 218/314] Typos --- 172.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/172.md b/172.md index 0cc81078..542258ac 100644 --- a/172.md +++ b/172.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` -The goal of this NIP is to create moderator-approved public communities arount a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into to the community, simply tag any Nostr event with an `a` tag. Moderators the issue an approval event `34551` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `34551` that links the community with the new post. # Community definition -Kind 34550 should include any field that helps define the community and the set of moderators. +Kind 34550 should include any field that helps define the community and the set of moderators. ```js { @@ -32,7 +32,7 @@ Kind 34550 should include any field that helps define the community and the set # New Post Request -Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. +Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. ```js { @@ -47,11 +47,11 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions to the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at anytime. +Community management clients can filter all mentions of the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. # Post Approval by moderators -The post approval includes a stringified `new post request` event inside the content's of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the content of the approval (NIP-18-style). ```js { @@ -68,13 +68,13 @@ The post approval includes a stringified `new post request` event inside the con } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post approvals for the past post or the community will restart. +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post-approvals for posts in the past or the community will restart. # Displaying -Community clients can display posts that have been approved by at least 1 moderator or by the community owner. +Community clients can display posts that have been approved by at least 1 moderator or by the community owner. -The following filter displays the approved posts. +The following filter displays the approved posts. ```js { From 6fbe488504729b4da4231f55097a144d9bbaa4a7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:40:19 -0400 Subject: [PATCH 219/314] Fixing indentation --- 172.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/172.md b/172.md index 542258ac..9aa59e21 100644 --- a/172.md +++ b/172.md @@ -20,12 +20,12 @@ Kind 34550 should include any field that helps define the community and the set "kind": "34550", "tags": [ ["d", ""], - ["description", ""], + ["description", ""], // moderators ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] ] } ``` @@ -61,8 +61,8 @@ The post-approval event includes a stringified `new post request` event inside t "kind": "34551", "tags": [ ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], + ["e", "", ""], + ["p", "", ""], ], "content": "{ }" } From bf84e733f3ad870ffd4516c6dfb60069997923be Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 13 Jun 2023 10:34:34 -0400 Subject: [PATCH 220/314] Adds preferred relay information to tags. --- 172.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/172.md b/172.md index 9aa59e21..1ca8b17d 100644 --- a/172.md +++ b/172.md @@ -21,11 +21,19 @@ Kind 34550 should include any field that helps define the community and the set "tags": [ ["d", ""], ["description", ""], + ["image", "", "WidthxHeight"] + + //.. other tags relevant to defining the community // moderators - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + + // relays used by the community + ["relay", "", "author"], + ["relay", ""], + ["relay", ""] ] } ``` @@ -51,7 +59,7 @@ Community management clients can filter all mentions of the kind-34550 event and # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the content of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the `.content` of the approval (NIP-18-style). ```js { From 4e61eb4e468a071c7d1efc8d0df6df06f65d5926 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 13 Jun 2023 15:52:41 -0400 Subject: [PATCH 221/314] Update 172.md Adds kind to the post approval. Co-authored-by: arthurfranca --- 172.md | 1 + 1 file changed, 1 insertion(+) diff --git a/172.md b/172.md index 1ca8b17d..4689165e 100644 --- a/172.md +++ b/172.md @@ -71,6 +71,7 @@ The post-approval event includes a stringified `new post request` event inside t ["a", "34550::", ""], ["e", "", ""], ["p", "", ""], + ["k", ""], ], "content": "{ }" } From 0c3df0ee30ca2a6eff842d7f851fd022e055a030 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:30 -0400 Subject: [PATCH 222/314] Removes quotes from kind Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4689165e..330fd1a8 100644 --- a/172.md +++ b/172.md @@ -17,7 +17,7 @@ Kind 34550 should include any field that helps define the community and the set "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "34550", + "kind": 34550, "tags": [ ["d", ""], ["description", ""], From 856ed84776b0b98b1e40d3776c8e65cc0c62957f Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:48 -0400 Subject: [PATCH 223/314] Fix typos in community image Co-authored-by: arthurfranca --- 172.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/172.md b/172.md index 330fd1a8..92cd52ca 100644 --- a/172.md +++ b/172.md @@ -21,9 +21,9 @@ Kind 34550 should include any field that helps define the community and the set "tags": [ ["d", ""], ["description", ""], - ["image", "", "WidthxHeight"] + ["image", "", "WidthxHeight"], - //.. other tags relevant to defining the community + //.. other tags relevant to defining the community // moderators ["p", "<32-bytes hex of a pubkey>", "", "moderator"], From 4c7b728be18c8cd934a879d888c04c85ac852687 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:56 -0400 Subject: [PATCH 224/314] Fix formatting Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 92cd52ca..6a89a538 100644 --- a/172.md +++ b/172.md @@ -30,7 +30,7 @@ Kind 34550 should include any field that helps define the community and the set ["p", "<32-bytes hex of a pubkey>", "", "moderator"], ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - // relays used by the community + // relays used by the community ["relay", "", "author"], ["relay", ""], ["relay", ""] From 3ff40201bdeae142be249c13a4c1983c18aabf84 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:39:32 -0400 Subject: [PATCH 225/314] Fixes double-quoted kind number Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 6a89a538..9f5fab50 100644 --- a/172.md +++ b/172.md @@ -47,7 +47,7 @@ Any Nostr event can be a post request. Clients should simply add the community's "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "1", + "kind": 1, "tags": [ ["a", "34550::", ""], ], From c07b5fa9b03dc4ce4f68140e3a57ceafcf5b95b3 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:46:24 -0400 Subject: [PATCH 226/314] Moves post approval to a regular (non-replaceable event) --- 172.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/172.md b/172.md index 9f5fab50..4a9f5a99 100644 --- a/172.md +++ b/172.md @@ -6,7 +6,7 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `34551` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. # Community definition @@ -66,7 +66,7 @@ The post-approval event includes a stringified `new post request` event inside t "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "34551", + "kind": "4550", "tags": [ ["a", "34550::", ""], ["e", "", ""], @@ -77,7 +77,7 @@ The post-approval event includes a stringified `new post request` event inside t } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post-approvals for posts in the past or the community will restart. +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copies of each moderator's approval events. # Displaying @@ -88,7 +88,7 @@ The following filter displays the approved posts. ```js { "authors": ["", "moderator1", "moderator2", "moderator3", ...], - "kinds": 34551, + "kinds": ["4550"], "#a": ["34550::"], } ``` \ No newline at end of file From 2b53049c1a69c413de1b3077a94a49810a2e0aff Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:50:06 -0400 Subject: [PATCH 227/314] Adds arthurfranca as author --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4a9f5a99..ec6a60bd 100644 --- a/172.md +++ b/172.md @@ -4,7 +4,7 @@ NIP-172 Moderated Communities (Reddit Style) ------------------------------------ -`draft` `optional` `author:vitorpamplona` +`draft` `optional` `author:vitorpamplona` `author:arthurfranca` The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. From 63441099be5898afc685bb2be28c2b30b2f27fc2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:53:55 -0400 Subject: [PATCH 228/314] Fixes typos & clarifies the text. --- 172.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/172.md b/172.md index ec6a60bd..df78081f 100644 --- a/172.md +++ b/172.md @@ -77,7 +77,7 @@ The post-approval event includes a stringified `new post request` event inside t } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copies of each moderator's approval events. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. # Displaying @@ -88,7 +88,7 @@ The following filter displays the approved posts. ```js { "authors": ["", "moderator1", "moderator2", "moderator3", ...], - "kinds": ["4550"], + "kinds": [4550], "#a": ["34550::"], } ``` \ No newline at end of file From 3a01861adeaf527f160e73b892b383a2c81a5c66 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:03:07 -0400 Subject: [PATCH 229/314] Adds references to other NIPs with more information and standardizes citations to event kinds --- 172.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/172.md b/172.md index df78081f..0c48ea38 100644 --- a/172.md +++ b/172.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` `author:arthurfranca` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. # Community definition -Kind 34550 should include any field that helps define the community and the set of moderators. +`Kind:34550` should include any field that helps define the community and the set of moderators. ```js { @@ -19,16 +19,16 @@ Kind 34550 should include any field that helps define the community and the set "created_at": "", "kind": 34550, "tags": [ - ["d", ""], - ["description", ""], - ["image", "", "WidthxHeight"], + ["d", ""], + ["description", ""], + ["image", "", "x"], //.. other tags relevant to defining the community // moderators - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey1>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], // relays used by the community ["relay", "", "author"], @@ -49,17 +49,17 @@ Any Nostr event can be a post request. Clients should simply add the community's "created_at": "", "kind": 1, "tags": [ - ["a", "34550::", ""], + ["a", "34550::", ""], ], - "content": "" + "content": "" } ``` -Community management clients can filter all mentions of the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. +Community management clients can filter all mentions of the `kind:34550` event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the `.content` of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). ```js { @@ -68,12 +68,12 @@ The post-approval event includes a stringified `new post request` event inside t "created_at": "", "kind": "4550", "tags": [ - ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], ["k", ""], ], - "content": "{ }" + "content": "" } ``` @@ -87,8 +87,8 @@ The following filter displays the approved posts. ```js { - "authors": ["", "moderator1", "moderator2", "moderator3", ...], + "authors": ["", "", "", "", ...], "kinds": [4550], - "#a": ["34550::"], + "#a": ["34550::"], } ``` \ No newline at end of file From d42fc18fa5800399690d82acfe34606e26419b8d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:05:35 -0400 Subject: [PATCH 230/314] Addressing how to unapprove a post. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 0c48ea38..87ae424b 100644 --- a/172.md +++ b/172.md @@ -55,7 +55,7 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions of the `kind:34550` event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. +Community management clients can filter all mentions to a given `kind:34550` event and request moderators to approve each submission. The same moderator can delete his/her approval of the post at any time using event deletions (See [NIP-09](09.md)). # Post Approval by moderators From 135a2f533890b77d3df1deca3fbe09ae47265723 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:13:09 -0400 Subject: [PATCH 231/314] Rewriting to use specification verbs SHOULD, MAY, etc --- 172.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/172.md b/172.md index 87ae424b..123eaefb 100644 --- a/172.md +++ b/172.md @@ -8,9 +8,9 @@ Moderated Communities (Reddit Style) The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. -# Community definition +# Community Definition -`Kind:34550` should include any field that helps define the community and the set of moderators. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. ```js { @@ -19,9 +19,9 @@ The goal of this NIP is to create moderator-approved public communities around a "created_at": "", "kind": 34550, "tags": [ - ["d", ""], - ["description", ""], - ["image", "", "x"], + ["d", ""], + ["description", ""], + ["image", "", "x"], //.. other tags relevant to defining the community @@ -40,7 +40,7 @@ The goal of this NIP is to create moderator-approved public communities around a # New Post Request -Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. +Any Nostr event can be a post request. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. ```js { @@ -55,11 +55,11 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions to a given `kind:34550` event and request moderators to approve each submission. The same moderator can delete his/her approval of the post at any time using event deletions (See [NIP-09](09.md)). +Community management clients MAY filter all mentions to a given `kind:34550` event and request moderators to approve each submission. Moderators MAY delete his/her approval of a post at any time using event deletions (See [NIP-09](09.md)). # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). +The post-approval event SHOULD include a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). ```js { @@ -81,14 +81,16 @@ It's recommended that multiple moderators approve posts to avoid deleting them f # Displaying -Community clients can display posts that have been approved by at least 1 moderator or by the community owner. +Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. The following filter displays the approved posts. ```js { - "authors": ["", "", "", "", ...], + "authors": ["", "", "", "", ...], "kinds": [4550], "#a": ["34550::"], } -``` \ No newline at end of file +``` + +Clients MAY hide approvals by blocked moderators at the user's request. \ No newline at end of file From 73f2f24bbfb3a7b4fc16f9bbc96b58a7b0ab9410 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:20:11 -0400 Subject: [PATCH 232/314] Better describes the use of `a`, `e` and `p` tags in the post approval event. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 123eaefb..84a88c92 100644 --- a/172.md +++ b/172.md @@ -59,7 +59,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve # Post Approval by moderators -The post-approval event SHOULD include a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). +The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notificaitons). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. ```js { From f8aa3f4e514dbe1688d269e71b1d5c6afad4c8c8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:24:48 -0400 Subject: [PATCH 233/314] Allows replaceable events to be part of communities as well. --- 172.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/172.md b/172.md index 84a88c92..d2b7a533 100644 --- a/172.md +++ b/172.md @@ -79,6 +79,10 @@ The post-approval event MUST include `a` tags of the communities the moderator i It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. +Replaceable events can be submitted for approval in two ways: (i) by their `e` tag if moderators want to approve each individual change to the repleceable event or (ii) by the `a` tag if the moderator trusts the original post author to not modify the event beyond community rules. + +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. + # Displaying Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. From 7957880b48c7a56687364d9325e28c17e1ed9ca2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 19 Jun 2023 15:07:40 -0400 Subject: [PATCH 234/314] Adds relay markers --- 172.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/172.md b/172.md index d2b7a533..28c36120 100644 --- a/172.md +++ b/172.md @@ -10,7 +10,7 @@ The goal of this NIP is to create moderator-approved public communities around a # Community Definition -`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. ```js { @@ -30,9 +30,10 @@ The goal of this NIP is to create moderator-approved public communities around a ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], - // relays used by the community + // relays used by the community (w/optional marker) ["relay", "", "author"], - ["relay", ""], + ["relay", "", "requests"], + ["relay", "", "approvals"], ["relay", ""] ] } From 507b0c20a52e4288d4ebaa9df0c4e12b89835172 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 7 Jul 2023 14:16:20 -0400 Subject: [PATCH 235/314] added a third option to approve replaceable events. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 28c36120..35350398 100644 --- a/172.md +++ b/172.md @@ -80,7 +80,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. -Replaceable events can be submitted for approval in two ways: (i) by their `e` tag if moderators want to approve each individual change to the repleceable event or (ii) by the `a` tag if the moderator trusts the original post author to not modify the event beyond community rules. +Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. From 892fe9e4004dbb515d71729b92d0432665f8e823 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 8 Aug 2023 13:31:54 -0300 Subject: [PATCH 236/314] move 172 to 72 and update indexes. --- 172.md => 72.md | 36 ++++++++++++++++++------------------ README.md | 6 +++++- 2 files changed, 23 insertions(+), 19 deletions(-) rename 172.md => 72.md (93%) diff --git a/172.md b/72.md similarity index 93% rename from 172.md rename to 72.md index 35350398..750b076a 100644 --- a/172.md +++ b/72.md @@ -1,5 +1,5 @@ -NIP-172 -======= +NIP-72 +====== Moderated Communities (Reddit Style) ------------------------------------ @@ -10,29 +10,29 @@ The goal of this NIP is to create moderator-approved public communities around a # Community Definition -`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", + "created_at": , "kind": 34550, "tags": [ ["d", ""], ["description", ""], ["image", "", "x"], - + //.. other tags relevant to defining the community // moderators ["p", "<32-bytes hex of a pubkey1>", "", "moderator"], ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], - + // relays used by the community (w/optional marker) ["relay", "", "author"], - ["relay", "", "requests"], + ["relay", "", "requests"], ["relay", "", "approvals"], ["relay", ""] ] @@ -43,15 +43,15 @@ The goal of this NIP is to create moderator-approved public communities around a Any Nostr event can be a post request. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", + "created_at": , "kind": 1, "tags": [ ["a", "34550::", ""], - ], + ], "content": "" } ``` @@ -62,27 +62,27 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notificaitons). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", - "kind": "4550", + "created_at": , + "kind": 4550, "tags": [ ["a", "34550::", ""], ["e", "", ""], ["p", "", ""], ["k", ""], - ], + ], "content": "" } ``` -It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. -Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. # Displaying @@ -98,4 +98,4 @@ The following filter displays the approved posts. } ``` -Clients MAY hide approvals by blocked moderators at the user's request. \ No newline at end of file +Clients MAY hide approvals by blocked moderators at the user's request. diff --git a/README.md b/README.md index cfee37dc..3c35ef36 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-72: Moderated Communities](72.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) @@ -94,6 +95,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1311` | Live Chat Message | [53](53.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | +| `4550` | Community Post Approval | [72](72.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -123,6 +125,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `34550` | Community Definition | [72](72.md) | + ### Event Kind Ranges @@ -170,7 +174,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md), [52](52.md) | | `i` | identity | proof | [39](39.md) | -| `k` | kind number (string) | -- | [18](18.md) | +| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | From 77b626d74871fb195dfd7b211a75af97753333dd Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Wed, 9 Aug 2023 00:55:21 +0200 Subject: [PATCH 237/314] nips over nostr --- 17.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 17.md diff --git a/17.md b/17.md new file mode 100644 index 00000000..6b5f3fc3 --- /dev/null +++ b/17.md @@ -0,0 +1,26 @@ +# NIPs over Nostr + +`draft` `optional` `author:Semisol` + +This NIP defines a method to do NIPs over Nostr. + +## NIP event + +A NIP event is an event with kind 9777. The content is in Markdown and is the NIP text. + +A NIP event can be identified in multiple ways: +- `50001::`: Represents the NIP. +- `!50001::@:`: Represents a specific version of this NIP. The ID may be omitted. + +The following tags may be in a NIP event (bold ones are mandatory, and underlined ones may be used more than once): +- **`d`**: A distinguishing tag for this NIP. A NIP event is identified by the author's public key and this d tag. +- **`v`**: The version for this NIP, as a limited subset of SemVer in the format `major.minor.patch`. + - More than one event can exist for the same version of a NIP. This is intended for minor edits, and if this is encountered, the event with the higher created_at is used, + and this SHOULD be avoided when possible. +- **__`p`__**: An author or contributor of this NIP. The parameter after the public key can be specified the type of contribution (more may be added): + - `author`: An author of this NIP. + - `contrib`: Someone that contributed to this NIP. +- __`D`__: Depends on tag, in the format `["D", "50001::", "@"]`. The ID may not be omitted. +- __`E`__: Extends tag, in the same format as the `D` tag. +- __`K`__: A kind or kind range this NIP uses, such as `0` or `10000-19999`. +- __**`license`**__: A license for this NIP as an SPDX license identifier. Multiple tags mean any can be chosen by the user. From ce7e6b2100918648ec4341c5fe517d076e8d225c Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Wed, 9 Aug 2023 00:56:48 +0200 Subject: [PATCH 238/314] wrong branch --- 17.md | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 17.md diff --git a/17.md b/17.md deleted file mode 100644 index 6b5f3fc3..00000000 --- a/17.md +++ /dev/null @@ -1,26 +0,0 @@ -# NIPs over Nostr - -`draft` `optional` `author:Semisol` - -This NIP defines a method to do NIPs over Nostr. - -## NIP event - -A NIP event is an event with kind 9777. The content is in Markdown and is the NIP text. - -A NIP event can be identified in multiple ways: -- `50001::`: Represents the NIP. -- `!50001::@:`: Represents a specific version of this NIP. The ID may be omitted. - -The following tags may be in a NIP event (bold ones are mandatory, and underlined ones may be used more than once): -- **`d`**: A distinguishing tag for this NIP. A NIP event is identified by the author's public key and this d tag. -- **`v`**: The version for this NIP, as a limited subset of SemVer in the format `major.minor.patch`. - - More than one event can exist for the same version of a NIP. This is intended for minor edits, and if this is encountered, the event with the higher created_at is used, - and this SHOULD be avoided when possible. -- **__`p`__**: An author or contributor of this NIP. The parameter after the public key can be specified the type of contribution (more may be added): - - `author`: An author of this NIP. - - `contrib`: Someone that contributed to this NIP. -- __`D`__: Depends on tag, in the format `["D", "50001::", "@"]`. The ID may not be omitted. -- __`E`__: Extends tag, in the same format as the `D` tag. -- __`K`__: A kind or kind range this NIP uses, such as `0` or `10000-19999`. -- __**`license`**__: A license for this NIP as an SPDX license identifier. Multiple tags mean any can be chosen by the user. From f91cb5ce665fa404b3a5e00c9f49f555d7a3855b Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Thu, 10 Aug 2023 01:34:49 +0900 Subject: [PATCH 239/314] fix typos --- 72.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/72.md b/72.md index 750b076a..f4bebf4e 100644 --- a/72.md +++ b/72.md @@ -60,7 +60,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve # Post Approval by moderators -The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notificaitons). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. +The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. ```json { @@ -78,7 +78,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i } ``` -It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. From e5a6c2c698bcfca4d9d135343fabf8846214314a Mon Sep 17 00:00:00 2001 From: ktecho Date: Thu, 10 Aug 2023 00:16:35 +0200 Subject: [PATCH 240/314] Adding (optional) shipping costs per product to nip-15 --- 15.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/15.md b/15.md index f8df3284..bd0f0db8 100644 --- a/15.md +++ b/15.md @@ -8,7 +8,7 @@ Nostr Marketplace (for resilient marketplaces) > Based on https://github.com/lnbits/Diagon-Alley -> Implemented here https://github.com/lnbits/nostrmarket +> Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market) ## Terms @@ -54,7 +54,7 @@ A merchant can publish these events: { "id": , "name": , - "cost": , + "cost": , "countries": [], } ] @@ -63,9 +63,12 @@ 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. + - an array with possible shipping zones for this stall. + - the customer MUST choose exactly one of those shipping zones. - 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. + - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per + product can also be specified if the shipping cost for that product is higher than what's specified by the base cost. **Event Tags**: ```json @@ -87,17 +90,30 @@ Fields that are not self-explanatory: "price": , "quantity": , "specs": [ - [ , ] - ] + [, ] + ], + "shipping": [ + { + "id": , + "cost": , + } + ] } ``` 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 + - an optional array of key pair values. It allows for the Customer UI to 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? + _Open_: better to move `spec` in the `tags` section of the event? + +- `shipping`: + - an _optional_ array of costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall + - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: + - the `base cost from the stall` for the chosen shipping option + - the result of multiplying the product units by the `shipping costs specified in the product`, if any. **Event Tags**: ```json @@ -211,4 +227,4 @@ Customer support is handled over whatever communication method was specified. If ## Additional -Standard data models can be found here here +Standard data models can be found here From b7faf8a4fec78d3504989117944b77a893a56d32 Mon Sep 17 00:00:00 2001 From: ktecho Date: Thu, 10 Aug 2023 16:17:45 +0200 Subject: [PATCH 241/314] Fix copy/paste --- 15.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/15.md b/15.md index bd0f0db8..26015590 100644 --- a/15.md +++ b/15.md @@ -95,7 +95,7 @@ Fields that are not self-explanatory: "shipping": [ { "id": , - "cost": , + "cost": , } ] } @@ -109,7 +109,7 @@ Fields that are not self-explanatory: _Open_: better to move `spec` in the `tags` section of the event? - `shipping`: - - an _optional_ array of costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - an _optional_ array of extra costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: - the `base cost from the stall` for the chosen shipping option From d87f86178b2178c2cb171af8a4e042bdffe4b1fe Mon Sep 17 00:00:00 2001 From: benthecarman Date: Thu, 10 Aug 2023 15:48:53 -0500 Subject: [PATCH 242/314] NIP-25: Handle empty string as + --- 25.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/25.md b/25.md index 86ce7635..63c07a73 100644 --- a/25.md +++ b/25.md @@ -19,7 +19,8 @@ dislikes in a reddit-like system of upvotes and downvotes, or display them as separate tallies. The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", -or the client MAY display this emoji reaction on the post. +or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should +consider it a "+". Tags ---- From a5047326d4d7c28e66c5d1262c252b86a1c8fe67 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 11 Aug 2023 06:12:50 -0400 Subject: [PATCH 243/314] Simplifies NIP-65 (#700) Co-authored-by: fiatjaf_ Co-authored-by: Jon Staab --- 65.md | 93 +++++++++++++++++++++++++---------------------------------- 1 file changed, 39 insertions(+), 54 deletions(-) diff --git a/65.md b/65.md index 55f9ff0a..3c064385 100644 --- a/65.md +++ b/65.md @@ -4,63 +4,13 @@ NIP-65 Relay List Metadata ------------------- -`draft` `optional` `author:mikedilger` +`draft` `optional` `author:mikedilger` `author:vitorpamplona` -A special replaceable event meaning "Relay List Metadata" is defined as an event with kind `10002` having a list of `r` tags, one for each relay the author uses to either read or write to. +Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. -The primary purpose of this relay list is to advertise to others, not for configuring one's client. +The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. If the marker is omitted, the relay is used for both purposes. -The `content` is not used and SHOULD be an empty string. - -The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes. - -Clients SHOULD, as with all replaceable events, use only the most recent kind-10002 event they can find. - -### The meaning of read and write - -Write relays are for events that are intended for anybody (e.g. your followers). Read relays are for events that address a particular person. - -Clients SHOULD write feed-related events created by their user to their user's write relays. - -Clients SHOULD read feed-related events created by another from at least some of that other person's write relays. Explicitly, they SHOULD NOT expect them to be available at their user's read relays. It SHOULD NOT be presumed that the user's read relays coincide with the write relays of the people the user follows. - -Clients SHOULD read events that tag their user from their user's read relays. - -Clients SHOULD write events that tag a person to at least some of that person's read relays. Explicitly, they SHOULD NOT expect that person will pick them up from their user's write relays. It SHOULD NOT be presumed that the user's write relays coincide with the read relays of the person being tagged. - -Clients SHOULD presume that if their user has a pubkey in their ContactList (kind 3) that it is because they wish to see that author's feed-related events. But clients MAY presume otherwise. - -### Motivation - -There is a common nostr use case where users wish to follow the content produced by other users. This is evidenced by the implicit meaning of the Contact List in [NIP-02](02.md) - -Because users don't often share the same sets of relays, ad-hoc solutions have arisen to get that content, but these solutions negatively impact scalability and decentralization: - - - Most people are sending their posts to the same most popular relays in order to be more widely seen - - Many people are pulling from a large number of relays (including many duplicate events) in order to get more data - - Events are being copied between relays, oftentimes to many different relays - -### Purposes - -The purpose of this NIP is to help clients find the events of the people they follow, to help tagged events get to the people tagged, and to help nostr scale better. - -### Suggestions - -It is suggested that people spread their kind `10002` events to many relays, but write their normal feed-related events to a much smaller number of relays (between 2 to 6 relays). It is suggested that clients offer a way for users to spread their kind `10002` events to many more relays than they normally post to. - -Authors may post events outside of the feed that they wish their followers to follow by posting them to relays outside of those listed in their "Relay List Metadata". For example, an author may want to reply to someone without all of their followers watching. - -It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because - - - finding where someone posts is rather important - - these events do not have `content` that needs management - - relays only need to store one replaceable event per pubkey to offer this service - -### Why not in kind `0` Metadata - -Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have `content` that may require moderation by relay operators so that it is more acceptable to relays. - -### Example +The `.content` is not used. ```json { @@ -74,3 +24,38 @@ Even though this is user related metadata, it is a separate event from kind `0` "content": "", ...other fields ``` + +This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. + +## When to Use Read and Write + +When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` + +When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002` + +When broadcasting an event, Clients SHOULD: + +- Broadcast the event to the WRITE relays of the author +- Broadcast the event all READ relays of each tagged user. + +## Motivation + +The old model of using a fixed relay list per user centralizes in large relay operators: + + - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience. + - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication + - Events are being copied between relays, oftentimes to many different relays + +This NIP allows Clients to connect directly with the most up-to-date relay set from each individual user, eliminating the need of broadcasting events to popular relays. + +## Final Considerations + +1. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays). + +2. Clients SHOULD spread an author's `kind:10002` events to as many relays as viable. + +3. `kind:10002` events should primarily be used to advertise the user's preferred relays to others. A user's own client may use other heuristics for selecting relays for fetching data. + +4. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy. + +5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. From 72bb8a128b2d7d3c2c654644cd68d0d0fe58a3b1 Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Sun, 13 Aug 2023 13:47:45 -0300 Subject: [PATCH 244/314] merge nips 12, 16, 20 and 33 into nip 01 (#703) Co-authored-by: Viktor Vsk --- 01.md | 102 ++++++++++++++++++++++++++++++++++++++---------------- 11.md | 13 ++++--- 12.md | 37 ++------------------ 13.md | 2 +- 15.md | 24 ++++++------- 16.md | 35 ++----------------- 19.md | 2 +- 20.md | 88 ++-------------------------------------------- 22.md | 6 ++-- 23.md | 8 ++--- 33.md | 50 ++------------------------ 51.md | 8 ++--- 52.md | 6 ++-- 53.md | 19 +++++----- 58.md | 10 ++---- 72.md | 2 +- README.md | 47 +++++++++---------------- 17 files changed, 141 insertions(+), 318 deletions(-) diff --git a/01.md b/01.md index 50e9c9ca..4b33975e 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` `author:semisol` +`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` `author:cameri` `author:Giszmo` 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. @@ -19,11 +19,10 @@ The only object type that exists is the `event`, which has the following format "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": , + "kind": , "tags": [ - ["e", <32-bytes hex of the id of another event>, ], - ["p", <32-bytes hex of a pubkey>, ], - ... // other kinds of tags may be included later + [...], + ... ], "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> @@ -43,9 +42,57 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ] ``` +### Tags + +Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: + +```json +{ + ..., + "tags": [ + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["alt", "reply"], + ... + ], + ... +} +``` + +The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. + +This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: + +- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, ]` +- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, ]` +- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes hex of a pubkey>:, ]` + +As a convention, all single-letter key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. + +### Kinds + +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: + +- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete older events once it gets a new one for the same pubkey. +- `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. + +And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: + +- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. +- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. + +These are just conventions and relay implementations may differ. + ## Communication between clients and relays -Relays expose a websocket endpoint to which clients can connect. +Relays expose a websocket endpoint to which clients can connect. Clients should open a single websocket connection to each relay and use it for all their subscriptions. + +### Meaning of WebSocket status codes + +- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again. ### From client to relay: sending events and creating subscriptions @@ -61,11 +108,10 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th ```json { - "ids": , - "authors": , + "ids": , + "authors": , "kinds": , - "#e": , - "#p": , + "#": , "since": , "until": , "limit": @@ -74,9 +120,9 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case it should overwrite the previous subscription. -Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON arrays with one or more values. At least one of the array's values must match the relevant field in an event for the condition itself to be considered a match. For scalar event attributes such as `kind`, the attribute from the event must be contained in the filter list. For tag attributes such as `#e`, where an event may have multiple values, the event and filter condition values must have at least one item in common. +Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. -The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. +The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values. The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. @@ -84,32 +130,28 @@ All conditions of a filter that are specified must match for an event for it to A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. -The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. +The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. ### From relay to client: sending events and notices -Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: +Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. + * `["OK", , , ]`, used to indicate acceptance or denial of an `EVENT` message. * `["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. -`EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MAY be empty when the 3rd is `true`, otherwise it MUST be a string containing a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: -## Basic Event Kinds - - - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. - - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. - -A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. - -## Other Notes: - -- 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 case-sensitive tag name 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](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. -- Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. -- When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. + * `["OK", "b1a649ebe8...", true, ""]` + * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` + * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]` + * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]` + * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]` + * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` + * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]` + * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` + * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` diff --git a/11.md b/11.md index ec46b367..c71f89e0 100644 --- a/11.md +++ b/11.md @@ -118,7 +118,7 @@ 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, +- `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 @@ -129,7 +129,7 @@ Even if set to False, authentication may be required for specific actions. ### Event Retention ### -There may be a cost associated with storing data forever, so relays +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. @@ -151,7 +151,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 +`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. @@ -161,8 +161,7 @@ a specific `kind` number, by giving a retention time of zero for those `kind` va While that is unfortunate, it does allow clients to discover servers that will support their protocol quickly via a single HTTP fetch. -There is no need to specify retention times for _ephemeral events_ as defined -in [NIP-16](16.md) since they are not retained. +There is no need to specify retention times for _ephemeral events_ since they are not retained. ### Content Limitations ### @@ -271,7 +270,7 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b As of 2 May 2023 the following `curl` command provided these results. >curl -H "Accept: application/nostr+json" https://eden.nostr.land - + {"name":"eden.nostr.land", "description":"Eden Nostr Land - Toronto 1-01", "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", @@ -293,5 +292,5 @@ As of 2 May 2023 the following `curl` command provided these results. "payment_required":true}, "payments_url":"https://eden.nostr.land/invoices", "fees":{"admission":[{"amount":5000000,"unit":"msats"}], - "publication":[]}}, + "publication":[]}}, "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" diff --git a/12.md b/12.md index 7d1f46e7..93579779 100644 --- a/12.md +++ b/12.md @@ -4,39 +4,6 @@ NIP-12 Generic Tag Queries ------------------- -`draft` `optional` `author:scsibug` `author:fiatjaf` +`final` `mandatory` `author:scsibug` `author:fiatjaf` -Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. - -The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. Note that tag names are case-sensitive. - -Example Subscription Filter ---------------------------- - -The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`. - -``` -{ - "kinds": [1], - "#r": ["foo", "bar"] -} -``` - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP. - -Rationale ---------- - -The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions. - -Suggested Use Cases -------------------- - -Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose. - -* Decentralized Commenting System: clients can comment on arbitrary web pages, and easily search for other comments, by using a `r` ("reference", in this case an URL) tag and value. -* Location-specific Posts: clients can use a `g` ("geohash") tag to associate a post with a physical location. Clients can search for a set of geohashes of varying precisions near them to find local content. -* Hashtags: clients can use simple `t` ("hashtag") tags to associate an event with an easily searchable topic name. Since Nostr events themselves are not searchable through the protocol, this provides a mechanism for user-driven search. +Moved to [NIP-01](01.md). diff --git a/13.md b/13.md index 360bde6c..01787336 100644 --- a/13.md +++ b/13.md @@ -110,7 +110,7 @@ function countLeadingZeroes(hex) { Querying relays for PoW notes ----------------------------- -Since relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: +If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: ``` $ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]' diff --git a/15.md b/15.md index f8df3284..f9e4b790 100644 --- a/15.md +++ b/15.md @@ -4,7 +4,7 @@ NIP-15 Nostr Marketplace (for resilient marketplaces) ----------------------------------- -`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` +`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` > Based on https://github.com/lnbits/Diagon-Alley @@ -33,13 +33,13 @@ The `merchant` admin software can be purely clientside, but for `convenience` an ## `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. | [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md) | -| `5 ` | `delete` | Delete a product or a stall. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) | +| Kind | | Description | +| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | +| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | +| `30017` | `set_stall` | Create or update a stall. | +| `30018` | `set_product` | Create or update a product. | +| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | +| `5 ` | `delete` | Delete a product or a stall. | ### Event `30017`: Create or update a stall. @@ -71,7 +71,7 @@ Fields that are not self-explanatory: ```json "tags": [["d", , , ] - -Relays MUST return `true` when the event is a duplicate and has already been saved. The `message` SHOULD start with `duplicate:` in this case. - -Relays MUST return `false` when the event was rejected and not saved. - -The `message` SHOULD provide additional information as to why the command succeeded or failed. - -The `message` SHOULD start with `blocked:` if the pubkey or network address has been blocked, banned, or is not on a whitelist. - -The `message` SHOULD start with `invalid:` if the event is invalid or doesn't meet some specific criteria (created_at is too far off, id is wrong, signature is wrong, etc) - -The `message` SHOULD start with `pow:` if the event doesn't meet some proof-of-work difficulty. The client MAY consult the relay metadata at this point to retrieve the required posting difficulty. - -The `message` SHOULD start with `rate-limited:` if the event was rejected due to rate limiting techniques. - -The `message` SHOULD start with `error:` if the event failed to save due to a server issue. - -Ephemeral events are not acknowledged with OK responses, unless there is a failure. - -If the event or `EVENT` command is malformed and could not be parsed, a NOTICE message SHOULD be used instead of a command result. This NIP only applies to non-malformed EVENT commands. - - -Examples --------- - -Event successfully written to the database: - - ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, ""] - -Event successfully written to the database because of a reason: - - ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, "pow: difficulty 25>=24"] - -Event blocked due to ip filter - - ["OK", "b1a649ebe8...", false, "blocked: tor exit nodes not allowed"] - -Event blocked due to pubkey ban - - ["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"] - -Event blocked, pubkey not registered - - ["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"] - -Event rejected, rate limited - - ["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"] - -Event rejected, `created_at` too far off - - ["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"] - -Event rejected, insufficient proof-of-work difficulty - - ["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"] - -Event failed to save, - - ["OK", "b1a649ebe8...", false, "error: could not connect to the database"] - - - -Client Handling ---------------- - -`messages` are meant for humans, with `reason:` prefixes so that clients can be slightly more intelligent with what to do with them. For example, with a `rate-limited:` reason the client may not show anything and simply try again with a longer timeout. - -For the `pow:` prefix it may query relay metadata to get the updated difficulty requirement and try again in the background. - -For the `invalid:` and `blocked:` prefix the client may wish to show these as styled error popups. - -The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it. - - -Future Extensions ------------------ - -This proposal SHOULD be extended to support further commands in the future, such as REQ and AUTH. They are left out of this initial version to keep things simpler. +Moved to [NIP-01](01.md). diff --git a/22.md b/22.md index 2172519e..f595ebf3 100644 --- a/22.md +++ b/22.md @@ -2,13 +2,13 @@ NIP-22 ====== Event `created_at` Limits ---------------------------- +------------------------- `draft` `optional` `author:jeffthibault` `author:Giszmo` Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md). -If a relay supports this NIP, the relay SHOULD send the client a [NIP-20](20.md) command result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. +If a relay supports this NIP, the relay SHOULD send the client an `OK` result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. Client Behavior --------------- @@ -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 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. +_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/23.md b/23.md index 7a06b0ef..76c0a69b 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](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. +This NIP defines `kind:30023` (a _parameterized replaceable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. "Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. @@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma ### Metadata -For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12. +For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12. Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: @@ -31,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st ### Editability -These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a `"d"` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. +These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. ### Linking -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)). +The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. ### References diff --git a/33.md b/33.md index 5128bece..1e7a9fc9 100644 --- a/33.md +++ b/33.md @@ -4,52 +4,6 @@ NIP-33 Parameterized Replaceable Events -------------------------------- -`draft` `optional` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` +`final` `mandatory` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` -This NIP adds a new event range that allows for replacement of events that have the same `d` tag and kind unlike NIP-16 which only replaced by kind. - -Implementation --------------- -The value of a tag can be any string and 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, 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. - -If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded. - -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: - -* `"tags":[["d",""]]` -* `"tags":[]`: implicit `d` tag with empty value -* `"tags":[["d"]]`: implicit empty value `""` -* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered -* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered -* `"tags":[["e"]]`: same as no tags -* `"tags":[["d","","1"]]`: only the first value is considered (`""`) - -Clients SHOULD NOT use `d` tags with multiple values and SHOULD include the `d` tag even if it has no value to allow querying using the `#d` filter. - -Referencing and tagging ------------------------ - -Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the -`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their -equivalents for event tags (i.e. an `nprofile` is generally translated into a tag -`["p", "", ""]`). - -To support linking to parameterized replaceable events, the `naddr` code is introduced on -NIP-19. It includes the public key of the event author and the `d` tag (and relays) such that -the referenced combination of public key and `d` tag can be found. - -The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "::", ""]`. - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. -Clients MAY send parameterized replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one and are recommended to send a `#d` tag filter. Clients should account for the fact that missing `d` tags or ones with no value are not returned in tag filters, and are recommended to always include a `d` tag with a value. +Moved to [NIP-01](01.md). diff --git a/51.md b/51.md index 80cc09ef..b7229aa8 100644 --- a/51.md +++ b/51.md @@ -2,15 +2,13 @@ NIP-51 ====== Lists -------------------------- +----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `depends:33` +`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. -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'. +If a list should only be defined once per user (like the "mute" list) the list is declared as a _replaceable event_. These lists may be referred to as "replaceable lists". Otherwise, the list is a _parameterized replaceable event_ and the list name will be used as the `d` tag. These lists may be referred to as "parameterized replaceable lists". ## Replaceable List Event Example diff --git a/52.md b/52.md index c601412e..846fbf43 100644 --- a/52.md +++ b/52.md @@ -6,7 +6,7 @@ Calendar Events `draft` `optional` `author:tyiu` -This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are replaceable and referenceable per [NIP-33](33.md) and deletable per [NIP-09](09.md). +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _parameterized replaceable_ and deletable per [NIP-09](09.md). Unlike the term `calendar event` specific to this NIP, the term `event` is used broadly in all the NIPs to describe any Nostr event. The distinction is being made here to discern between the two terms. @@ -139,7 +139,7 @@ A calendar is a collection of calendar events, represented as a custom replaceab The format uses a custom replaceable list of kind `31924` with a list of tags as described below: * `d` (required) calendar name -* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to ```json { @@ -171,7 +171,7 @@ The format uses a parameterized replaceable event kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. The list of tags are as follows: -* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) +* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `L` (required) label namespace of `status` per [NIP-32](32.md) * `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. diff --git a/53.md b/53.md index c5f2704e..b3d416b7 100644 --- a/53.md +++ b/53.md @@ -12,7 +12,7 @@ Service providers want to offer live activities to the Nostr network in such a w # Live Event -A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. +A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. For example: @@ -44,13 +44,13 @@ For example: A distinct `d` tag should be used for each activity. All other tags are optional. -Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). +Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). -Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. +Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` -The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). +The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. ## Proof of Agreement to Participate @@ -58,11 +58,11 @@ Event owners can add proof as the 5th term in each `p` tag to clarify the partic Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. -This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. +This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. # Live Chat Message -Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. ```js { @@ -74,7 +74,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t ["a", "30311::", "", "root"], ], "content": "Zaps to live streams is beautiful." -} +} ``` # Use Cases @@ -83,7 +83,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or # Example -Live Streaming +Live Streaming ```json { @@ -112,7 +112,7 @@ Live Streaming chat message ```json { "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", - "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", "created_at": 1687286726, "kind": 1311, "tags": [ @@ -122,4 +122,3 @@ Live Streaming chat message "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" } ```` - diff --git a/58.md b/58.md index 2fa44066..d6bb27d6 100644 --- a/58.md +++ b/58.md @@ -9,15 +9,9 @@ Badges Three special events are used to define, award and display badges in user profiles: -1. A "Badge Definition" event is defined as a parameterized replaceable event -with kind `30009` having a `d` tag with a value that uniquely identifies -the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can -be updated. +1. A "Badge Definition" event is defined as a parameterized replaceable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated. -2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing -a "Define Badge" event and one or more `p` tags, one for each pubkey the -badge issuer wishes to award. The value for the `a` tag MUST follow the format -defined in [NIP-33](33.md). Awarded badges are immutable and non-transferrable. +2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Define Badge" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. 3. A "Profile Badges" event is defined as a parameterized replaceable event with kind `30008` with a `d` tag with the value `profile_badges`. diff --git a/72.md b/72.md index f4bebf4e..599a4c45 100644 --- a/72.md +++ b/72.md @@ -6,7 +6,7 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` `author:arthurfranca` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag. Moderators issue an approval event `kind:4550` that links the community with the new post. # Community Definition diff --git a/README.md b/README.md index 3c35ef36..f2603cfa 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [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) -- [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) -- [NIP-20: Command Results](20.md) - [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) @@ -48,7 +45,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) -- [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) @@ -78,7 +74,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | ------- | -------------------------- | ----------- | | `0` | Metadata | [1](01.md) | | `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | [1](01.md) | +| `2` | Recommend Relay | | | `3` | Contacts | [2](02.md) | | `4` | Encrypted Direct Messages | [4](04.md) | | `5` | Event Deletion | [9](09.md) | @@ -128,59 +124,48 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.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 ### Client to Relay | type | description | NIP | | ------- | --------------------------------------------------- | ----------- | +| `EVENT` | used to publish events | [01](01.md) | +| `REQ` | used to request events and subscribe to new updates | [01](01.md) | +| `CLOSE` | used to stop previous subscriptions | [01](01.md) | | `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 | | -------- | ------------------------------------------------------- | ----------- | +| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) | +| `EVENT` | used to send events requested to clients | [01](01.md) | +| `NOTICE` | used to send human-readable messages to clients | [01](01.md) | +| `OK` | used to notify clients if an EVENT was successful | [01](01.md) | | `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. -When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md). - ## Standardized Tags | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | -------------------- | ------------------------ | -| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | +| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | | `alt` | Alt tag | -- | [31](31.md) | -| `d` | identifier | -- | [33](33.md) | -| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| `g` | geohash | -- | [12](12.md), [52](52.md) | +| `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.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) | +| `r` | a reference (URL, etc) | -- | | +| `t` | hashtag | -- | | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | | `challenge` | challenge string | -- | [42](42.md) | | `content-warning` | reason | -- | [36](36.md) | From 04051ffcbc36964ecaf44f390e7d1f17e61edb15 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 15 Aug 2023 05:40:54 +0900 Subject: [PATCH 245/314] Update tag list (#692) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2603cfa..38a03173 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `r` | a reference (URL, etc) | -- | | +| `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -189,7 +190,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `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) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From 88ee873c9e4824125d3f2e38d16c39ccf73ddf16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= Date: Tue, 15 Aug 2023 17:02:54 +0300 Subject: [PATCH 246/314] Rename countries to regions. (#465) --- 15.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/15.md b/15.md index 5e3164e7..01ef05bf 100644 --- a/15.md +++ b/15.md @@ -55,7 +55,7 @@ A merchant can publish these events: "id": , "name": , "cost": , - "countries": [], + "regions": [], } ] } From 2ba0eca44344a770b5ad24f20e749864cddf3518 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Tue, 15 Aug 2023 18:32:30 +0200 Subject: [PATCH 247/314] Nip 51 extended --- 51.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/51.md b/51.md index b7229aa8..03bd9219 100644 --- a/51.md +++ b/51.md @@ -4,7 +4,7 @@ NIP-51 Lists ----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` +`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. @@ -92,6 +92,7 @@ Then the user would create a 'Categorized People' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | +| 30303 | Categorized Reference List | ### Mute List @@ -108,3 +109,7 @@ 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 standardized tag can be included in a Categorized Bookmarks List. + +### Categorized Reference List + +An event with kind `30303` is defined as a parameterized replaceable list event for categorizing user references. The 'd' parameter of this event holds the category name of the list. The reference lists may have metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md) . Items in these lists are `r` tags, and follow the schema of Kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). Each `r` tag entry should contain the 'reference URL' and the 'description', `["r", , ]`. Any standard tag can be included in a reference list. \ No newline at end of file From 2f84cd97e38c0a824cc27ea2ac976545e9e3f09e Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 17 Aug 2023 08:17:24 -0300 Subject: [PATCH 248/314] remove harmful remark from nip-10. --- 10.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/10.md b/10.md index 64947967..9c79b4a2 100644 --- a/10.md +++ b/10.md @@ -19,7 +19,7 @@ Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. - + **The positions of the "e" tags within the event denote specific meanings as follows**: * No "e" tag:
@@ -29,34 +29,34 @@ Where: `["e", ]`: The id of the event to which this event is a reply. * Two "e" tags: `["e", ]`, `["e", ]`
- `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. + `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. * Many "e" tags: `["e", ]` `["e", ]`, ..., `["e", ]`
-There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. +There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. They are citings from this event. `root-id` and `reply-id` are as above. >This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. ## Marked "e" tags (PREFERRED) -`["e", , , ]` - +`["e", , , ]` + Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `` field, but may instead leave it as `""`. * `` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. -**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. +Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. A direct reply to the root of a thread should have a single marked "e" tag of type "root". ->This scheme is preferred because it allows events to mention others without confusing them with `` or ``. +>This scheme is preferred because it allows events to mention others without confusing them with `` or ``. ## The "p" tag Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. -When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. +When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. -Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] +Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] in no particular order. From 50b63c26c83ffe892c8698e9ea2eed88a3e6b9a0 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Thu, 17 Aug 2023 13:45:44 +0200 Subject: [PATCH 249/314] updated kind30001 --- 51.md | 45 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/51.md b/51.md index 03bd9219..cd1a4ab3 100644 --- a/51.md +++ b/51.md @@ -84,6 +84,43 @@ Then the user would create a 'Categorized People' list event like below: } ``` +Lets say a user wants to create a 'Categorized Bookmarks' list of `bookmarks` and has keys: +``` +priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1 +pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d +``` +The user wants to publicly include these bookmarks: + +```json +["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], +["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], +["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], +``` +and privately include these bookmarks (below is the JSON that would be encrypted and placed in the event content): + +```json +[ + ["r", "https://my-private.bookmark", "My private bookmark"], + ["a", "30001:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], +] +``` + +Then the user would create a 'Categorized Bookmarks' list event like below: + +```json +{ + "kind": 30001, + "tags": [ + ["d", "bookmarks"], + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], + ], + "content": "y3AyaLJfnmYr9x9Od9o4aYrmL9+Ynmsim5y2ONrU0urOTq+V81CyAthQ2mUOWE9xwGgrizhY7ILdQwWhy6FK0sA33GHtC0egUJw1zIdknPe7BZjznD570yk/8RXYgGyDKdexME+RMYykrnYFxq1+y/h00kmJg4u+Gpn+ZjmVhNYxl9b+TiBOAXG9UxnK/H0AmUqDpcldn6+j1/AiStwYZhD1UZ3jzDIk2qcCDy7MlGnYhSP+kNmG+2b0T/D1L0Z7?iv=PGJJfPE84gacAh7T0e6duQ==", + ...other fields +} +``` + ## List Event Kinds | kind | list type | @@ -92,7 +129,7 @@ Then the user would create a 'Categorized People' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | -| 30303 | Categorized Reference List | + ### Mute List @@ -108,8 +145,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 standardized tag can be included in a Categorized Bookmarks List. - -### Categorized Reference List - -An event with kind `30303` is defined as a parameterized replaceable list event for categorizing user references. The 'd' parameter of this event holds the category name of the list. The reference lists may have metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md) . Items in these lists are `r` tags, and follow the schema of Kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). Each `r` tag entry should contain the 'reference URL' and the 'description', `["r", , ]`. Any standard tag can be included in a reference list. \ No newline at end of file +An event of kind `30001` is defined as a parameterised replaceable list event for categorizing bookmarks. The `d' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). The tags included in these lists MUST follow the schema of event tags as defined in [NIP-01 - Basic protocol flow description](01.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file From 867132ce9ac889258cdb46cf73531e8892f46ec4 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Thu, 17 Aug 2023 16:21:21 +0200 Subject: [PATCH 250/314] fix typos --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index cd1a4ab3..cbd6be11 100644 --- a/51.md +++ b/51.md @@ -145,4 +145,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event of kind `30001` is defined as a parameterised replaceable list event for categorizing bookmarks. The `d' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). The tags included in these lists MUST follow the schema of event tags as defined in [NIP-01 - Basic protocol flow description](01.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file +An event of 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. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file From 7143bfccf7470e209c0048050f104a27901b9ebd Mon Sep 17 00:00:00 2001 From: gzuuus Date: Fri, 18 Aug 2023 10:23:45 +0200 Subject: [PATCH 251/314] added other parameter 'petname' to r tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38a03173..555f006d 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | -| `r` | a reference (URL, etc) | -- | | +| `r` | a reference (URL, etc) | petname | | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `amount` | millisatoshis, stringified | -- | [57](57.md) | From 37c4375e297166df8350c8a7d119d33c0757228b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 19 Aug 2023 23:03:19 -0300 Subject: [PATCH 252/314] bring back 9cac35db9b1d41c8eb7413269308a76687489b30 fixes https://github.com/nostr-protocol/nips/issues/732 --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index 4b33975e..63697439 100644 --- a/01.md +++ b/01.md @@ -80,10 +80,12 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. + These are just conventions and relay implementations may differ. ## Communication between clients and relays From c5a8b75abd9ad5c0b2a680f71ae2c91beda37d5a Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 20 Aug 2023 04:04:55 +0200 Subject: [PATCH 253/314] Consistency and small refinements for NIP-01 (#731) --- 01.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/01.md b/01.md index 63697439..d6ccfbe2 100644 --- a/01.md +++ b/01.md @@ -25,7 +25,7 @@ The only object type that exists is the `event`, which has the following format ... ], "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> + "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } ``` @@ -34,7 +34,7 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ```json [ 0, - , + , , , , @@ -64,11 +64,11 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, ]` -- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, ]` -- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes hex of a pubkey>:, ]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` +- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` +- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` -As a convention, all single-letter key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. +As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. ### Kinds @@ -80,7 +80,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. @@ -90,7 +90,7 @@ These are just conventions and relay implementations may differ. ## Communication between clients and relays -Relays expose a websocket endpoint to which clients can connect. Clients should open a single websocket connection to each relay and use it for all their subscriptions. +Relays expose a websocket endpoint to which clients can connect. Clients SHOULD open a single websocket connection to each relay and use it for all their subscriptions. Relays MAY limit number of connections from specific IP/client/etc. ### Meaning of WebSocket status codes @@ -113,14 +113,14 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th "ids":
, "authors": , "kinds": , - "#": , + "#": , "since": , "until": , - "limit": + "limit": } ``` -Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case it should overwrite the previous subscription. +Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case relay MUST overwrite the previous subscription. Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. From 89915e0251ec4e5ce3fc00e2f2dfd9106a359b79 Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 20 Aug 2023 14:27:03 +0200 Subject: [PATCH 254/314] Remove min_prefix mentions from NIP-11 after prefix search was removed from NIP-01 --- 11.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/11.md b/11.md index c71f89e0..083ae8f3 100644 --- a/11.md +++ b/11.md @@ -75,7 +75,6 @@ are rejected or fail immediately. "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, @@ -102,9 +101,6 @@ 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 @@ -284,7 +280,6 @@ As of 2 May 2023 the following `curl` command provided these results. "max_filters":2500, "max_limit":5000, "max_subid_length":256, - "min_prefix":4, "max_event_tags":2500, "max_content_length":65536, "min_pow_difficulty":0, From 209dc5d7945ca95f4de4c44df085568b271f3de5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 21 Aug 2023 18:49:21 +0900 Subject: [PATCH 255/314] Update NIP-50 title in list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38a03173..72eb2a4a 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) -- [NIP-50: Keywords filter](50.md) +- [NIP-50: Search Capability](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) From c6b6eea96a85aa6c9b5ce579685214fea3de0282 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 23 Aug 2023 12:55:31 -0300 Subject: [PATCH 256/314] remove bracket from kind attribute in example. fixes https://github.com/nostr-protocol/nips/issues/735 --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index ace4a03c..729d585e 100644 --- a/57.md +++ b/57.md @@ -78,7 +78,7 @@ const sats = 21 const amount = sats * 1000 const relays = ['wss://nostr-pub.wellorder.net'] const event = encodeURI(JSON.stringify(await signEvent({ - kind: [9734], + kind: 9734, content: "", pubkey: senderPubkey, created_at: Math.round(Date.now() / 1000), From 208dee210249f84496ddfa823542d023e23b3edb Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Thu, 24 Aug 2023 15:18:50 -0700 Subject: [PATCH 257/314] Define how to encode a non-parameterized replaceable event as a naddr --- 19.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/19.md b/19.md index 6b087426..cd989e21 100644 --- a/19.md +++ b/19.md @@ -35,7 +35,7 @@ These are the possible bech32 prefixes with `TLV`: - `nprofile`: a nostr profile - `nevent`: a nostr event - `nrelay`: a nostr relay - - `naddr`: a nostr _parameterized replaceable event_ coordinate + - `naddr`: a nostr _replaceable event_ coordinate These possible standardized `TLV` types are indicated here: @@ -44,7 +44,7 @@ These possible standardized `TLV` types are indicated here: - for `nprofile` it will be the 32 bytes of the profile public key - for `nevent` it will be the 32 bytes of the event id - for `nrelay`, this is the relay URL - - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced + - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. - `1`: `relay` - 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 From f7b7b865e629789cb4d64b45a836c116e2831cbe Mon Sep 17 00:00:00 2001 From: William Casarin Date: Wed, 23 Aug 2023 19:56:20 -0700 Subject: [PATCH 258/314] NIP-315: User Statuses This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. --- 315.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 62 insertions(+) create mode 100644 315.md diff --git a/315.md b/315.md new file mode 100644 index 00000000..0f4f0a1d --- /dev/null +++ b/315.md @@ -0,0 +1,60 @@ + +NIP-315 +======= + +User Statuses +-------------- + +`draft` `optional` `author:jb55` + +## Abstract + +This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. + +## Live Statuses + +A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _parameterized replaceable event_, where the `d` tag represents the status type: + +For example: + +```js +{ + "kind": 30315, + "content": "Sign up for nostrasia!", + "tags": [ + ["d", "general"], + ["r", "https://nostr.world"] + ], +} + +{ + "kind": 30315, + "content": "Intergalatic - Beastie Boys", + "tags": [ + ["d", "music"], + ["r", "spotify:search:Intergalatic%20-%20Beastie%20Boys"], + ["expiration", "1692845589"] + ], +} +``` + +Two common status types are defined: `general` and `music`. `general` represent general statuses: "Working", "Hiking", etc. + +`music` status events are for live streaming what you are currently listening to. The expiry of the `music` status should be when the track will stop playing. + +Any other status types can be used but they are not defined by this NIP. + +The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. + +# Client behavior + +Clients MAY display this next to the username on posts or profiles to provide live user status information. + +# Use Cases + +* Calendar nostr apps that update your general status when you're in a meeting +* Nostr Nests that update your general status with a link to the nest when you join +* Nostr music streaming services that update your music status when you're listening +* Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well +* Clients can use the system media player to update playing music status + diff --git a/README.md b/README.md index f8b77dfb..f6b57f11 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-315: User Statuses](315.md) ## Event Kinds @@ -113,6 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | +| `30315` | User Statuses | [315](315.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | From 7dc1f02fa70a5b9da7b3867e3faa37f48571d5e1 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 25 Aug 2023 08:41:26 -0300 Subject: [PATCH 259/314] rename 315 to 38. --- 315.md => 38.md | 5 ++--- README.md | 4 ++-- 2 files changed, 4 insertions(+), 5 deletions(-) rename 315.md => 38.md (99%) diff --git a/315.md b/38.md similarity index 99% rename from 315.md rename to 38.md index 0f4f0a1d..378da1c5 100644 --- a/315.md +++ b/38.md @@ -1,6 +1,6 @@ -NIP-315 -======= +NIP-38 +====== User Statuses -------------- @@ -57,4 +57,3 @@ Clients MAY display this next to the username on posts or profiles to provide li * Nostr music streaming services that update your music status when you're listening * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status - diff --git a/README.md b/README.md index f6b57f11..7951339f 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-36: Sensitive Content](36.md) +- [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) @@ -67,7 +68,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-315: User Statuses](315.md) ## Event Kinds @@ -114,7 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | -| `30315` | User Statuses | [315](315.md) | +| `30315` | User Statuses | [38](38.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | From 50945f7150c8b100f92fdfdffba32894ba5a831f Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 25 Aug 2023 23:17:05 +0900 Subject: [PATCH 260/314] Reword set_metadata to metadata (#741) --- 05.md | 4 ++-- 89.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/05.md b/05.md index 56b9156b..00d69af6 100644 --- a/05.md +++ b/05.md @@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` `author:fiatjaf` `author:mikedilger` -On events of kind `0` (`set_metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +On events of kind `0` (`metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. Upon seeing that, the client splits the identifier into `` and `` and use these values to make a GET request to `https:///.well-known/nostr.json?name=`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `set_metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example diff --git a/89.md b/89.md index 5eee3b8e..4503ecfd 100644 --- a/89.md +++ b/89.md @@ -61,7 +61,7 @@ The third value of the tag SHOULD be the platform where this recommendation migh } ``` -* `content` is an optional `set_metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) +* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) * `k` tags' value is the event kind that is supported by this `kind:31990`. Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: From 21f3ad5a42c0ae63f2fc0a6e9f18b05f44df68c5 Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 27 Aug 2023 15:34:55 +0200 Subject: [PATCH 261/314] Allow relays indicate whether probabilistic count was used in NIP-45 --- 45.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/45.md b/45.md index a5253913..7b11950a 100644 --- a/45.md +++ b/45.md @@ -21,6 +21,7 @@ This NIP defines the verb `COUNT`, which accepts a subscription id and filters a ``` Counts are returned using a `COUNT` response in the form `{"count": }`. Relays may use probabilistic counts to reduce compute requirements. +In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": , "approximate": }`. ``` ["COUNT", , {"count": }] @@ -36,4 +37,8 @@ Examples: # Count posts and reactions ["COUNT", , {"kinds": [1, 7], "authors": []}] ["COUNT", , {"count": 5}] + +# Count posts approximately +["COUNT", , {"kinds": [1]}] +["COUNT", , {"count": 93412452, "approximate": true}] ``` From acafcc774d571867bde615423c758c51dba64fca Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Mon, 28 Aug 2023 16:25:43 +0900 Subject: [PATCH 262/314] NIP-38: description for content --- 38.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/38.md b/38.md index 378da1c5..010c14c3 100644 --- a/38.md +++ b/38.md @@ -57,3 +57,5 @@ Clients MAY display this next to the username on posts or profiles to provide li * Nostr music streaming services that update your music status when you're listening * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status + +The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji. If the `content` is an empty string then the client should clear the status. From 1aa9301a4a993cf7122ebb7761945d94dc4eadba Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Mon, 28 Aug 2023 21:10:07 +0900 Subject: [PATCH 263/314] update 38.md --- 38.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/38.md b/38.md index 010c14c3..f1eddcd8 100644 --- a/38.md +++ b/38.md @@ -58,4 +58,4 @@ Clients MAY display this next to the username on posts or profiles to provide li * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status -The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji. If the `content` is an empty string then the client should clear the status. +The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. From d1d438bf1458fc0f59a191631d10c0bde35353be Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Tue, 29 Aug 2023 00:45:45 +0900 Subject: [PATCH 264/314] fix typo --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index d6ccfbe2..e4c0546c 100644 --- a/01.md +++ b/01.md @@ -62,7 +62,7 @@ Each tag is an array of strings of arbitrary size, with some conventions around The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. -This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: +This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` From e50bf508d9014cfb19bfa8a5c4ec88dc4788d490 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Tue, 29 Aug 2023 23:49:59 +0900 Subject: [PATCH 265/314] add a-tag format for non-parameterized replaceable events --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index e4c0546c..1831438e 100644 --- a/01.md +++ b/01.md @@ -66,7 +66,9 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` -- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` +- The `a` tag, used to refer to a (maybe parameterized) replaceable event + - for a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` + - for a non-parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. From d784820309dba0447d6a0a351ad0230ba6c5c5fb Mon Sep 17 00:00:00 2001 From: SnazzyBytes Date: Wed, 30 Aug 2023 18:30:41 -0500 Subject: [PATCH 266/314] add NIP-22 created_at limits to Server-Limitations --- 11.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/11.md b/11.md index 083ae8f3..deb6f197 100644 --- a/11.md +++ b/11.md @@ -80,6 +80,8 @@ are rejected or fail immediately. "min_pow_difficulty": 30, "auth_required": true, "payment_required": true, + "created_at_lower_limit":31536000, + "created_at_upper_limit":3, } ... } @@ -123,6 +125,10 @@ 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. +- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md) + +- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md) + ### Event Retention ### There may be a cost associated with storing data forever, so relays From 08bd050598e078179eea71cb9de777d887a9e9f8 Mon Sep 17 00:00:00 2001 From: Alejandro Date: Fri, 1 Sep 2023 15:07:52 +0200 Subject: [PATCH 267/314] NIP-75: Zap Goals (#757) --- 75.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 79 insertions(+) create mode 100644 75.md diff --git a/75.md b/75.md new file mode 100644 index 00000000..6c8cb7b1 --- /dev/null +++ b/75.md @@ -0,0 +1,76 @@ +# NIP-75 + +## Zap Goals + +`draft` `optional` `author:verbiricha` + +This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event. + +## Nostr Event + +A `kind:9041` event is used. + +The `.content` contains a human-readable description of the goal. + +The following tags are defined as REQUIRED. + +- `amount` - target amount in milisats. +- `relays` - a list of relays the zaps to this goal will be sent to and tallied from. + +Example event: + +```json +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["amount", "210000"], + ], + "content": "Nostrasia travel expenses", + ...other fields +``` + +The following tags are OPTIONAL. + +- `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress. + +```json +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["amount", "210000"], + ["closed_at", ""], + ], + "content": "Nostrasia travel expenses", + ...other fields +``` + +The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event. + +The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events). + +Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. + +```json +{ + "kind": 3XXXX, + "tags": [ + ... + ["goal", "", ""], + ], + ...other fields +``` + +## Client behavior + +Clients MAY display funding goals on user profiles. + +When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. + +When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. + +## Use cases + +- Fundraising clients +- Adding funding goals to events such as long form posts, badges or live streams diff --git a/README.md b/README.md index 7951339f..5beff919 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-72: Moderated Communities](72.md) +- [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) @@ -93,6 +94,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | +| `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -177,6 +179,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `description` | invoice description | -- | [57](57.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | From c7191fc2f518aa85b6437c001c1fdcadaa0b38a3 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Sat, 2 Sep 2023 14:34:39 +0300 Subject: [PATCH 268/314] fix inconsistency --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 1831438e..7a304e0d 100644 --- a/01.md +++ b/01.md @@ -82,7 +82,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. From ea8fa91c8058c8d74aff8b011196d504a2683fe9 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Mon, 4 Sep 2023 14:25:04 +0300 Subject: [PATCH 269/314] clarify parameterized replaceable events --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 7a304e0d..d822bfbc 100644 --- a/01.md +++ b/01.md @@ -84,7 +84,7 @@ And also a convention for kind ranges that allow for easier experimentation and - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. - for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event is expected to be stored by relays, older versions are expected to be discarded. In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. From 8aa89367cd66e160b2bc2320362e87b3a4e71eac Mon Sep 17 00:00:00 2001 From: Luis Miguel Date: Tue, 5 Sep 2023 18:15:14 +0200 Subject: [PATCH 270/314] Micro-typo nip-58 --- 58.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/58.md b/58.md index d6bb27d6..ccabc7b6 100644 --- a/58.md +++ b/58.md @@ -11,7 +11,7 @@ user profiles: 1. A "Badge Definition" event is defined as a parameterized replaceable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated. -2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Define Badge" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. +2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. 3. A "Profile Badges" event is defined as a parameterized replaceable event with kind `30008` with a `d` tag with the value `profile_badges`. From 74611d2580004e8384b77048a346c2e0b2a47890 Mon Sep 17 00:00:00 2001 From: gsovereignty Date: Fri, 8 Sep 2023 16:09:02 +0800 Subject: [PATCH 271/314] Spelling and clarifcations --- 98.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/98.md b/98.md index ecbebc08..c8cba0f5 100644 --- a/98.md +++ b/98.md @@ -6,9 +6,9 @@ HTTP Auth `draft` `optional` `author:kieran` `author:melvincarvalho` -This NIP defines an ephemerial event used to authorize requests to HTTP servers using nostr events. +This NIP defines an ephemeral event used to authorize requests to HTTP servers using nostr events. -This is useful for HTTP services which are build for Nostr and deal with Nostr user accounts. +This is useful for HTTP services which are built for Nostr and deal with Nostr user accounts. ## Nostr event @@ -16,7 +16,7 @@ A `kind 27235` (In reference to [RFC 7235](https://www.rfc-editor.org/rfc/rfc723 The `content` SHOULD be empty. -The following tags are defined as REQUIRED. +The following tags MUST be included. * `u` - absolute URL * `method` - HTTP Request Method @@ -45,7 +45,7 @@ Example event: Servers MUST perform the following checks in order to validate the event: 1. The `kind` MUST be `27235`. -2. The `created_at` MUST be within a reasonable time window (suggestion 60 seconds). +2. The `created_at` timestamp MUST be within a reasonable time window (suggestion 60 seconds). 3. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters). 4. The `method` tag MUST be the same HTTP method used for the requested resource. @@ -53,11 +53,11 @@ When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD i If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code. -All other checks which server MAY do are OPTIONAL, and implementation specific. +Servers MAY perform additional implementation-specific validation checks. ## Request Flow -Using the `Authorization` header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` +Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` Example HTTP Authorization header: ``` @@ -65,4 +65,4 @@ Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA ``` ## Reference Implementations -- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) \ No newline at end of file +- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) From c567f2e4d6fa4e79585e83b6e6d9313217295582 Mon Sep 17 00:00:00 2001 From: Tiago Vasconcelos Date: Fri, 8 Sep 2023 13:10:59 +0100 Subject: [PATCH 272/314] Add description to event 30019 (#768) --- 15.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/15.md b/15.md index 01ef05bf..edece818 100644 --- a/15.md +++ b/15.md @@ -220,6 +220,28 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni "shipped": , } ``` +## Customize Marketplace +Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. + +### Event `30019`: Create or update marketplace UI/UX + +**Event Content**: +```json +{ + "name": , + "about": , + "ui": { + "picture": , + "banner": , + "theme": , + "darkMode": + }, + "merchants": <[String] (optional), array of pubkeys>, + ... +} +``` + +This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment. ## Customer support events From e3504024a279ae896394254f08c56a64d6722d97 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 8 Sep 2023 21:11:38 +0900 Subject: [PATCH 273/314] Clarify character case of m tag value (#767) --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 24dd346f..c1b322a2 100644 --- a/94.md +++ b/94.md @@ -13,7 +13,7 @@ The purpose of this NIP is to allow an organization and classification of shared 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) +* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. * `"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 From 12238ebe2b234b7438864b521c0886471aa351a8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 11 Sep 2023 13:03:32 +0900 Subject: [PATCH 274/314] Remove description about NIP-12 --- 52.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/52.md b/52.md index 846fbf43..f5bd0adb 100644 --- a/52.md +++ b/52.md @@ -30,7 +30,7 @@ The list of tags are as follows: * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. * `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call -* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. @@ -88,7 +88,7 @@ The list of tags are as follows: * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` * `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. * `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call -* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. From 67cf855c8448c78010cd0d3ed8f19ddfeb1d2606 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 12 Sep 2023 09:50:25 -0300 Subject: [PATCH 275/314] Add tags to nip94 --- 94.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index c1b322a2..e34a576d 100644 --- a/94.md +++ b/94.md @@ -21,6 +21,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `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 +* `preview` (optional) shorter file variant such as thumbnail, blurred image or text excerpt +* `caption` (optional) loose description not meant for accessibility ```json { @@ -37,7 +39,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["dim", ], ["magnet", ], ["i",], - ["blurhash", ] + ["blurhash", ], + ["preview", , ], + ["caption", ] ], "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 de15edb04a7b6dc36bc6d5eaba26fb49e54b300e Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 12 Sep 2023 10:49:21 -0300 Subject: [PATCH 276/314] Invert caption and alt --- 94.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/94.md b/94.md index e34a576d..8e47c27d 100644 --- a/94.md +++ b/94.md @@ -22,7 +22,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `i` (optional) torrent infohash * `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client * `preview` (optional) shorter file variant such as thumbnail, blurred image or text excerpt -* `caption` (optional) loose description not meant for accessibility +* `alt` (optional) description for accessibility ```json { @@ -41,9 +41,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["i",], ["blurhash", ], ["preview", , ], - ["caption", ] + ["alt", ] ], - "content": , + "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 30c799b00148c687b693331cd169c9ed20b93515 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 12 Sep 2023 11:58:34 -0300 Subject: [PATCH 277/314] Expand preview into other tags --- 94.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 8e47c27d..c5e0f182 100644 --- a/94.md +++ b/94.md @@ -21,7 +21,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `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 -* `preview` (optional) shorter file variant such as thumbnail, blurred image or text excerpt +* `thumb` (optional) url of thumbnail with same aspect ratio +* `image` (optional) url of preview image with same dimensions +* `summary` (optional) text excerpt * `alt` (optional) description for accessibility ```json @@ -40,7 +42,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["magnet", ], ["i",], ["blurhash", ], - ["preview", , ], + ["thumb", ], + ["image", ], + ["summary", ], ["alt", ] ], "content": , From cf764ee7e5922167d944752678d2d8ab10314d3d Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Thu, 14 Sep 2023 12:04:02 -0300 Subject: [PATCH 278/314] Add xx tag --- 94.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index c5e0f182..b512af4c 100644 --- a/94.md +++ b/94.md @@ -15,7 +15,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. * `"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. +* `x` containing the SHA-256 hexencoded string of the **original** file before any server transformations +* `xx` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file @@ -37,6 +38,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["aes-256-gcm",, ], ["m", ], ["x",], + ["xx",], ["size", ], ["dim", ], ["magnet", ], From 01b6bfc28666db4b259556bf55c9269ca0c059d5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 20 Sep 2023 21:05:32 +0900 Subject: [PATCH 279/314] Update tag list (#778) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5beff919..98f6ddb7 100644 --- a/README.md +++ b/README.md @@ -161,12 +161,13 @@ Please update these lists when proposing NIPs introducing new event kinds. | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | | `d` | identifier | -- | [01](01.md) | -| `alt` | Alt tag | -- | [31](31.md) | +| `alt` | summary | -- | [31](31.md) | | `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | | `r` | a reference (URL, etc) | petname | | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | @@ -175,8 +176,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `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) | +| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | From 44c21c9d82dfa9fbe04655668c03400fa0ac1e34 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 24 Sep 2023 16:48:55 -0300 Subject: [PATCH 280/314] add nip-24: extra metadata fields. --- 24.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 24.md diff --git a/24.md b/24.md new file mode 100644 index 00000000..fb653f4e --- /dev/null +++ b/24.md @@ -0,0 +1,24 @@ +NIP-24 +====== + +Extra metadata fields and tags +------------------------------ + +`draft` `optional` `author:fiatjaf` + +This NIP defines extra optional fields added to events. + +kind 0 +====== + +These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events: + + - `display_name`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available. + - `website`: a web URL related in any way to the event author. + +tags +==== + +These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: + + - `r`: a web URL the event is referring to in some way From f3bafe5f872be937060071585296b62584a4f416 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 24 Sep 2023 19:48:05 -0300 Subject: [PATCH 281/314] `banner` and deprecated names. --- 24.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/24.md b/24.md index fb653f4e..cb5d8982 100644 --- a/24.md +++ b/24.md @@ -15,6 +15,14 @@ These are extra fields not specified in NIP-01 that may be present in the string - `display_name`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available. - `website`: a web URL related in any way to the event author. + - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. + +### Deprecated fields + +These are fields that should be ignored or removed when found in the wild: + + - `displayName`: use `display_name` instead. + - `username`: use `name` instead. tags ==== From cc1e73b1866ab2b7da860dcbb982eaa87a9f44ea Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 27 Sep 2023 12:20:41 -0300 Subject: [PATCH 282/314] Revert x and xx tags --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index b512af4c..ed9b68c9 100644 --- a/94.md +++ b/94.md @@ -15,8 +15,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits -* `x` containing the SHA-256 hexencoded string of the **original** file before any server transformations -* `xx` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations +* `x` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations +* `xx` containing the SHA-256 hexencoded string of the **original** file before any server transformations * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file From 3e2765b774e985f17cf8eead360f78dee0bf5fc4 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 27 Sep 2023 12:23:38 -0300 Subject: [PATCH 283/314] Rename xx to ox --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index ed9b68c9..77944a04 100644 --- a/94.md +++ b/94.md @@ -16,7 +16,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations -* `xx` containing the SHA-256 hexencoded string of the **original** file before any server transformations +* `ox` containing the SHA-256 hexencoded string of the **original** file before any server transformations * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file @@ -38,7 +38,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["aes-256-gcm",, ], ["m", ], ["x",], - ["xx",], + ["ox",], ["size", ], ["dim", ], ["magnet", ], From 4b2cd78defb1564bdc534c01f7f0f6cd230077f8 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 27 Sep 2023 12:59:33 -0300 Subject: [PATCH 284/314] Remove ox tag --- 94.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/94.md b/94.md index 77944a04..c5e0f182 100644 --- a/94.md +++ b/94.md @@ -15,8 +15,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits -* `x` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations -* `ox` containing the SHA-256 hexencoded string of the **original** file before any server transformations +* `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 @@ -38,7 +37,6 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["aes-256-gcm",, ], ["m", ], ["x",], - ["ox",], ["size", ], ["dim", ], ["magnet", ], From cf144593f1d350dabb61aa808b36118a6b3b03ec Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 28 Sep 2023 19:24:36 +0900 Subject: [PATCH 285/314] Add relay list of kind 3 to NIP-24 (#795) (as deprecated) --- 24.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/24.md b/24.md index cb5d8982..5f94a2b1 100644 --- a/24.md +++ b/24.md @@ -24,6 +24,17 @@ These are fields that should be ignored or removed when found in the wild: - `displayName`: use `display_name` instead. - `username`: use `name` instead. +kind 3 +====== + +These are extra fields not specified in NIP-02 that may be present in the stringified JSON of contacts events: + +### Deprecated fields + +These are fields that should be ignored or removed when found in the wild: + + - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write, but in favor of [NIP-65](65.md). + tags ==== From 84f1915cecc10cfca6584eacfbeecb35bddc65f9 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 28 Sep 2023 08:07:30 -0300 Subject: [PATCH 286/314] less aggressive wording for kind3 relay list deprecation. --- 24.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/24.md b/24.md index 5f94a2b1..dee9daa3 100644 --- a/24.md +++ b/24.md @@ -31,9 +31,7 @@ These are extra fields not specified in NIP-02 that may be present in the string ### Deprecated fields -These are fields that should be ignored or removed when found in the wild: - - - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write, but in favor of [NIP-65](65.md). + - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead. tags ==== From 5eb51d5278f758d92a4fd5ab881dfb30199df412 Mon Sep 17 00:00:00 2001 From: git Date: Thu, 28 Sep 2023 13:02:03 -0700 Subject: [PATCH 287/314] 65: trim slashes --- 65.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/65.md b/65.md index 3c064385..89fc5941 100644 --- a/65.md +++ b/65.md @@ -59,3 +59,5 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 4. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy. 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. + +6. Clients SHOULD trim trailing slashes (`/`) from relay URIs to canonicalize connections. From 423dda195b5251ffac5ec82c4129fe2f916c4d2b Mon Sep 17 00:00:00 2001 From: Keyan <34140557+huumn@users.noreply.github.com> Date: Thu, 28 Sep 2023 15:43:03 -0500 Subject: [PATCH 288/314] update nip-57 zap receipt spec to include 'a' tag --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 729d585e..8e2be1b2 100644 --- a/57.md +++ b/57.md @@ -128,7 +128,7 @@ The following should be true of the `zap receipt` event: - 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`. +- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request` AND optional `a` 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. From 3b5d3ca677829333779bb46874bb0dc816283dc9 Mon Sep 17 00:00:00 2001 From: git Date: Fri, 29 Sep 2023 11:46:30 -0700 Subject: [PATCH 289/314] 65: normalize relay uri --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 89fc5941..352ee28d 100644 --- a/65.md +++ b/65.md @@ -60,4 +60,4 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. -6. Clients SHOULD trim trailing slashes (`/`) from relay URIs to canonicalize connections. +6. Clients SHOULD deduplicate connections by normalizing relay URIs according to RFC 2616. From 4de43f65a1bc5f312dba039d8b405358ad1f7397 Mon Sep 17 00:00:00 2001 From: git Date: Fri, 29 Sep 2023 12:00:07 -0700 Subject: [PATCH 290/314] Update RFC reference --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 352ee28d..49d1d170 100644 --- a/65.md +++ b/65.md @@ -60,4 +60,4 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. -6. Clients SHOULD deduplicate connections by normalizing relay URIs according to RFC 2616. +6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 6455](https://www.rfc-editor.org/rfc/rfc6455.html#section-3). From b33409c099b4d08278c95beda0f42ba76f55c32c Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 29 Sep 2023 15:47:04 -0300 Subject: [PATCH 291/314] make it clear that relays can keep multiple replaceable event versions. --- 01.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index d822bfbc..2b28f23f 100644 --- a/01.md +++ b/01.md @@ -82,12 +82,14 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded. In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. +When answering to `REQ` messages for replaceable events such as `{"kinds":[0],"authors":[]}`, even if the relay has more than one version stored, it SHOULD return just the latest one. + These are just conventions and relay implementations may differ. ## Communication between clients and relays From 0d267aab5a74a7f63275f47ceb3c2773ce437f97 Mon Sep 17 00:00:00 2001 From: git Date: Mon, 2 Oct 2023 15:34:24 -0700 Subject: [PATCH 292/314] Better RFC reference --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 49d1d170..b6760290 100644 --- a/65.md +++ b/65.md @@ -60,4 +60,4 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. -6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 6455](https://www.rfc-editor.org/rfc/rfc6455.html#section-3). +6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). From aa1bf6d26845a025541b5d37c8df1cfab00c58fe Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 6 Oct 2023 07:11:23 +0900 Subject: [PATCH 293/314] Add NIP-24 to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 98f6ddb7..1097bc55 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) +- [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) From e9f8bc27b7f14355a3c4a321e4368046125a3dc0 Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Tue, 10 Oct 2023 20:12:21 +0300 Subject: [PATCH 294/314] add spring.site to nip-07 (#810) Add Spring.site as NIP07 implementation --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index ee4e3722..0c8c4027 100644 --- a/07.md +++ b/07.md @@ -33,3 +33,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) - [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) - [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) +- [Spring Browser](https://spring.site) (Android) From 21c6c12c524cb71f18e068c9bcf223cda0214b5f Mon Sep 17 00:00:00 2001 From: Vic <88121568+vicariousdrama@users.noreply.github.com> Date: Wed, 11 Oct 2023 00:57:12 -0400 Subject: [PATCH 295/314] Update 57.md (#808) Clarify how multiple relays should be included in the zap request event --- 57.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index 8e2be1b2..849c8696 100644 --- a/57.md +++ b/57.md @@ -45,7 +45,7 @@ Example: "kind": 9734, "content": "Zap!", "tags": [ - ["relays", "wss://nostr-pub.wellorder.com"], + ["relays", "wss://nostr-pub.wellorder.com", "wss://anotherrelay.example.com"], ["amount", "21000"], ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"], ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"], @@ -66,7 +66,7 @@ A signed `zap request` event is not published, but is instead sent using a HTTP - `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: +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 in javascript: ```javascript const senderPubkey // The sender's pubkey From 324c7aafdcd316fb971c1f26b964d2b53c939a10 Mon Sep 17 00:00:00 2001 From: Don Date: Wed, 11 Oct 2023 20:55:27 +0900 Subject: [PATCH 296/314] Change wording to imply that reactions can target any event (#815) * kind:17 generic reactions. * `kind 7` is available for all kind events. * `k` tag is not required. --- 25.md | 6 +++- README.md | 82 +++++++++++++++++++++++++++---------------------------- 2 files changed, 46 insertions(+), 42 deletions(-) diff --git a/25.md b/25.md index 63c07a73..7b29140a 100644 --- a/25.md +++ b/25.md @@ -7,7 +7,7 @@ Reactions `draft` `optional` `author:jb55` -A reaction is a `kind 7` note that is used to react to other notes. +A reaction is a `kind 7` event that is used to react to other events. The generic reaction, represented by the `content` set to a `+` string, SHOULD be interpreted as a "like" or "upvote". @@ -34,6 +34,9 @@ The last `e` tag MUST be the `id` of the note that is being reacted to. The last `p` tag MUST be the `pubkey` of the event being reacted to. +The reaction event MAY include a `k` tag with the stringified kind number +of the reacted event as its value. + Example code ```swift @@ -43,6 +46,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost } tags.append(["e", liked.id]) tags.append(["p", liked.pubkey]) + tags.append(["k", liked.kind]) let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) ev.calculate_id() ev.sign(privkey: privkey) diff --git a/README.md b/README.md index 1097bc55..dc708873 100644 --- a/README.md +++ b/README.md @@ -156,47 +156,47 @@ Please update these lists when proposing NIPs introducing new event kinds. ## Standardized Tags -| name | value | other parameters | NIP | -| ----------------- | ------------------------------------ | -------------------- | ------------------------ | -| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `a` | coordinates to an event | relay URL | [01](01.md) | -| `d` | identifier | -- | [01](01.md) | -| `alt` | summary | -- | [31](31.md) | -| `g` | geohash | -- | [52](52.md) | -| `i` | identity | proof | [39](39.md) | -| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | -| `l` | label, label namespace | annotations | [32](32.md) | -| `L` | label namespace | -- | [32](32.md) | -| `m` | MIME type | -- | [94](94.md) | -| `r` | a reference (URL, etc) | petname | | -| `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | | -| `amount` | millisatoshis, stringified | -- | [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` | invoice/badge description | -- | [57](57.md), [58](58.md) | -| `emoji` | shortcode, image URL | -- | [30](30.md) | -| `expiration` | unix timestamp (string) | -- | [40](40.md) | -| `goal` | event id (hex) | relay URL | [75](75.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | -| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | badge name | -- | [58](58.md) | -| `nonce` | random | -- | [13](13.md) | -| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | -| `price` | price | currency, frequency | [99](99.md) | -| `proxy` | external ID | protocol | [48](48.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` | pubkey (hex), relay URL | weight | [57](57.md) | +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | -------------------- | ------------------------------------- | +| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | +| `alt` | summary | -- | [31](31.md) | +| `g` | geohash | -- | [52](52.md) | +| `i` | identity | proof | [39](39.md) | +| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | +| `l` | label, label namespace | annotations | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `r` | a reference (URL, etc) | petname | | +| `r` | relay url | marker | [65](65.md) | +| `t` | hashtag | -- | | +| `amount` | millisatoshis, stringified | -- | [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` | invoice/badge description | -- | [57](57.md), [58](58.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | badge name | -- | [58](58.md) | +| `nonce` | random | -- | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.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` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From 09ffb951c69343312486aaff2726dca04bc42f6e Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Wed, 11 Oct 2023 10:17:43 -0300 Subject: [PATCH 297/314] rework NIP-03 so it is actually usable (#804) * rework nip-03 to be actually useful and usable. * fixes. * add ots verification flow. --- 03.md | 33 +++++++++++++++++++++++---------- README.md | 1 + 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/03.md b/03.md index 3c5d764e..4faf3f15 100644 --- a/03.md +++ b/03.md @@ -4,20 +4,33 @@ NIP-03 OpenTimestamps Attestations for Events -------------------------------------- -`draft` `optional` `author:fiatjaf` +`draft` `optional` `author:fiatjaf` `author:constant` -When there is an OTS available it MAY be included in the existing event body under the `ots` key: +This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps](https://opentimestamps.org/) proof for any other event: -``` +```json { - "id": ..., - "kind": ..., - ..., - ..., - "ots": + "kind": 1040 + "tags": [ + ["e", , ], + ["block", , ], + ["alt", "opentimestamps attestation"] + ], + "content": } ``` -The _event id_ MUST be used as the raw hash to be included in the OpenTimestamps merkle tree. +- The OpenTimestamps proof MUST prove the referenced `e` event id as its digest. +- The `block` tag is optional, it exists to establish a minimum date since which the given event has existed. +- The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation and no reference to "pending" attestations since they are useless in this context. -The attestation can be either provided by relays automatically (and the OTS binary contents just appended to the events it receives) or by clients themselves when they first upload the event to relays — and used by clients to show that an event is really "at least as old as [OTS date]". +### Example OpenTimestamps proof verification flow + +Using [`nak`](https://github.com/fiatjaf/nak), [`jq`](https://jqlang.github.io/jq/) and [`ots`](https://github.com/fiatjaf/ots): + +```bash +~> nak req -i e71c6ea722987debdb60f81f9ea4f604b5ac0664120dd64fb9d23abc4ec7c323 wss://nostr-pub.wellorder.net | jq -r .content | ots verify +> using an esplora server at https://blockstream.info/api +- sequence ending on block 810391 is valid +timestamp validated at block [810391] +``` diff --git a/README.md b/README.md index dc708873..e9f08bdb 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `1063` | File Metadata | [94](94.md) | | `1311` | Live Chat Message | [53](53.md) | +| `1040` | OpenTimestamps | [03](03.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | From 202e18f2b256646148805880ed58731c1c8b2b9b Mon Sep 17 00:00:00 2001 From: Mike O'Bank <111360219+mikeobank@users.noreply.github.com> Date: Thu, 12 Oct 2023 15:31:58 +0200 Subject: [PATCH 298/314] Nip 06 test vectors (#819) --- 06.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/06.md b/06.md index 4ae571f7..a0b4a01b 100644 --- a/06.md +++ b/06.md @@ -13,3 +13,19 @@ Basic key derivation from mnemonic seed phrase 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. + +### Test vectors + +mnemonic: leader monkey parrot ring guide accident before fence cannon height naive bean\ +private key (hex): 7f7ff03d123792d6ac594bfa67bf6d0c0ab55b6b1fdb6249303fe861f1ccba9a\ +nsec: nsec10allq0gjx7fddtzef0ax00mdps9t2kmtrldkyjfs8l5xruwvh2dq0lhhkp\ +public key (hex): 17162c921dc4d2518f9a101db33695df1afb56ab82f5ff3e5da6eec3ca5cd917\ +npub: npub1zutzeysacnf9rru6zqwmxd54mud0k44tst6l70ja5mhv8jjumytsd2x7nu + +--- + +mnemonic: what bleak badge arrange retreat wolf trade produce cricket blur garlic valid proud rude strong choose busy staff weather area salt hollow arm fade\ +private key (hex): c15d739894c81a2fcfd3a2df85a0d2c0dbc47a280d092799f144d73d7ae78add\ +nsec: nsec1c9wh8xy5eqdzln7n5t0ctgxjcrdug73gp5yj0x03gntn67h83twssdfhel\ +public key (hex): d41b22899549e1f3d335a31002cfd382174006e166d3e658e3a5eecdb6463573\ +npub: npub16sdj9zv4f8sl85e45vgq9n7nsgt5qphpvmf7vk8r5hhvmdjxx4es8rq74h From d9400e1e7b08225aedb6c78b522c5ad07b5198b4 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Sat, 14 Oct 2023 16:14:24 +0300 Subject: [PATCH 299/314] big refactor * use different kinds per response type * remove examples * remove specific job request definitions, moved to a separate repo for clarity --- 90.md | 383 +++++++++------------------------------------------------- 1 file changed, 58 insertions(+), 325 deletions(-) diff --git a/90.md b/90.md index 51c49cf2..4c0eff6a 100644 --- a/90.md +++ b/90.md @@ -4,22 +4,24 @@ NIP-90 Data Vending Machine -------------------- -`draft` `optional` `author:pablof7z` +`draft` `optional` `author:pablof7z` `author:dontbelievethehype` This NIP defines the interaction between customers and Service Providers for performing on-demand computation. Money in, data out. ## Kinds -This NIP reserves the range `65000-66000` for data vending machine use. +This NIP reserves the range `5000-7000` for data vending machine use. | Kind | Description | | ---- | ----------- | -| 65000 | Job feedback | -| 65001 | Job result | -| 65002-66000 | Job request kinds | +| 5000-5999 | Job request kinds | +| 6000-6999 | Job result | +| 7000 | Job feedback | -[Appendix 2](#appendix-2-job-types) defines the job request types. +Job results always use a kind number that is `1000` higher than the job request kind. (e.g. request: `kind:5001` gets a result: `kind:6001`). + +Job request types are defined [separately](https://github.com/nostr-protocol/data-vending-machines/tree/master/kinds). ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. @@ -31,21 +33,15 @@ There are two actors in the workflow described in this NIP: * Customers (npubs who request a job) * Service providers (npubs who fulfill jobs) -# Event Kinds - -* `kind:65000`: job feedback -* `kind:65001`: job result -* `kind:65002`-`kind:66000`: job requests - -## Job request -A request to have data processed, published by a customer. This event signals that an npub is interested in receiving the result of some kind of compute. +## Job request (`kind:5000-5999`) +A request to process data, published by a customer. This event signals that an customer is interested in receiving the result of some kind of compute. ```json { - "kind": 65xxx, // kind in 65002-66000 range + "kind": 5xxx, // kind in 5000-5999 range "content": "", "tags": [ - [ "i", "", "", "", "" ], + [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], [ "bid", "" ], @@ -59,20 +55,19 @@ All tags are optional. * `i` tag: Input data for the job (zero or more inputs) * ``: The argument for the input * ``: The way this argument should be interpreted. MUST be one of: - * `url`: A URL to be fetched + * `url`: A URL to be fetched of the data that should be processed. * `event`: A Nostr event ID. - * `job`: The output of a previous job with the specified event ID + * `job`: The output of a previous job with the specified event ID. The dermination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.) * `text`: `` is the value of the input, no resolution is needed - * ``: An optional field indicating how this input should be used within the context of the job * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string -* `output`: Expected output format. (e.g. MIME type) - * Service Providers MUST publish the result of the job in this format if it has been specified. - * Each job-type ([Appendix 2](#appendix-2-job-types)) might define the output format more narrowly. + * ``: An optional field indicating how this input should be used within the context of the job +* `output`: Expected output format. Different job request `kind` defines this more precisely. +* `param`: Optional parameters for the job as key (first argument)/value (second argument). Different job request `kind` defines this more precisely. (e.g. `[ "param", "lang", "es" ]`) * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay * `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -## Job result +## Job result (`kind:6000-6999`) Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. @@ -80,10 +75,11 @@ Service providers publish job results, providing the output of the job result. T { "pubkey": "", "content": "", - "kind": 65001, + "kind": 6xxx, "tags": [ [ "request", "" ], [ "e", "", "" ], + [ "i", "" ], [ "p", "" ], [ "amount", "requested-payment-amount", "" ] ] @@ -92,13 +88,14 @@ Service providers publish job results, providing the output of the job result. T * `request`: The job request event stringified-JSON. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. +* `i`: The original input(s) specified in the request. ## Job feedback Service providers can give feedback about a job back to the customer. ```json { - "kind": 65000, + "kind": 7000, "content": "", "tags": [ [ "status", "", "" ], @@ -110,305 +107,10 @@ Service providers can give feedback about a job back to the customer. ``` * `content`: Either empty or a job-result (e.g. for partial-result samples) -* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 3](#appendix-3-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. * `amount` tag: as defined in the [Job Result](#job-result) section. +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 1](#appendix-1-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. -# Protocol Flow -* Customer publishes a job request (e.g. `kind:65002` speech-to-text). -* Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). -* Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. -* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user - -`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. - -## Notes about the protocol flow -The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. - -Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. - -It's not up to this NIP to define how individual vending machines should choose to run their business. - -# Cancellation -A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. - -# Job chaining -A Customer MAY request multiple jobs to be processed as a chain, where the output of a job can be the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. - -Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. - -This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). - -Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcast](#summarization-of-a-podcast) - -### E.g. Payment required (with sample content) -```json -{ - "kind": 65000, - "content": "This is the transcription service that you", - "tags": [ - [ "e", , ], - [ "p", ], - [ "status", "payment-required" ], - [ "amount", "7000" ], - ] -} -``` - -# Appendix 1: Examples - -## Transcript of a podcast from second `900` to `930`. - -### `kind:65002`: Speech-to-text job request -```json -{ - "id": "12345", - "pubkey": "abcdef", - "content": "", - "kind": 65002, - "tags": [ - [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "params", "range", "900", "930" ], - [ "output", "text/plain" ], - [ "bid", "50000" ], - ] -} -``` - -### `kind:65000`: Job Feedback: request for (partial) payment -* The SP is signaling here that it won't start processing until 100 sats are paid -```json -{ - "kind": 65000, - "content": "", - "tags": [ - ["e", "12345"], - ["p", "abcdef"], - ["status", "payment-required"], - ["amount", "100000"] - ] -} -``` - -* User zaps 100 sats to the `kind:65000` job-feedback - -### `kind:65001`: Job result + request for remaining payment -```json -{ - "content": "blah blah blah", - "tags": [ - ["e", "12345"], - ["p", "abcdef"], - ["amount", "400000"] - ] -} -``` - -## Summarization of a podcast -User publishes two job requests at the same time. A job that transcribes an audio and a job that summarizes the transcription (output of job #1). - -User publishes event #1 and #2 together. - -### `kind:65002`: Job Request #1: speech-to-text -```json -{ - "id": "12345", - "pubkey": "abcdef", - "kind": 65002, - "content": "", - "tags": [ - [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "output", "text/plain" ], - [ "params", "range", "900", "930" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65002`: Job Request #2: summarization of job #1's result -```json -{ - "id": "12346", - "pubkey": "abcdef", - "kind": 65003, - "content": "", - "tags": [ - [ "i", "12345", "job" ], // input is the output of job with id 12345 - [ "output", "text/plain" ], - [ "params", "length", "3 paragraphs" ], - [ "bid", "10000" ] - ] -} -``` - -## Translation of a note -### `kind:65004`: Job Request #1: translation of an existing note -```json -{ - "id": "12346", - "pubkey": "abcdef", - "content": "", - "kind": 65004, - "tags": [ - [ "i", "", "event", "wss://relay.nostr.com" ] - [ "output", "text/plain" ], - [ "params", "lang", "es_AR" ], - [ "bid", "5000" ] - ] -} -``` - -### `kind:65001`: Job result -```json -{ - "kind": 65001, - "content": "Che, que copado, boludo!", - "tags": [ - ["e", "12346"], - ["p", "abcdef"], - ["amount", "4000"] - ] -} -``` - -## AI-image of the summarization of 2 podcasts - -### `kind:65002`: Job request #1 (transcribe podcast #1) -```json -{ - "id": "123", - "kind": 65002, - "tags": [ - [ "i", "https://example.com/episode1.mp3", "url" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65002`: Job request #2 (transcribe podcast #2) -```json -{ - "id": "124", - "kind": 65002, - "tags": [ - [ "i", "https://example.com/episode2.mp3", "url" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65003`: Job request #3 (summarize the two job's outputs into one paragraph) -```json -{ - "id": "125", - "kind": 65003, - "tags": [ - [ "param", "length", "1 paragraph" ], - [ "i", "123", "job" ], - [ "i", "124", "job" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65005`: Job request #4 (generate image based on the summary) -```json -{ - "id": "126", - "kind": 65004, - "tags": [ - [ "i", "125", "job" ], - [ "param", "prompt", "photorealistic" ], - [ "param", "size", "4000x4000" ], - [ "bid", "500000" ] - ] -} -``` - -## AI-image of embedded input - -### `kind:65005`: Job request -```json -{ - "kind": 65004, - "tags": [ - [ "i", "Millions of vending machines, interconnected with tubes with eah other", "text" ], - [ "param", "prompt", "photorealistic" ], - [ "bid", "500000" ] - ] -} -``` - -# Appendix 2: Job types - -This is a list of all the supported job requests. - -## speech-to-text: `kind:65002` - -### params - -| param | req? | description | -|------------|------|-----------------------------------------------------------| -| `range` | opt | timestamp range (in seconds) of desired text to be transcribed | -| `alignment`| opt | word, segment, raw: word-level, segment-level, or raw outputs | - -## summarization: `kind:65003` - -| param | req? | description | -|-----------|------|---------------| -| `length` | opt | desired length | - -## translation: `kind:65004` - -| param | req? | description | -|-----------|------|--------------------------------------------| -| `lang` | req | desired language in BCP 47 format. | - -## image generation: `kind:65005` - -| param | req? | description | -|-----------|------|-------------------------------------------------------| -| `prompt` | opt | extra prompt to be used for the image generation | -| `size` | opt | desired size of the image | - -## event list generation: `kind:65006` - -Generates a list of event ids, (e.g. algorithmic feeds, spam-free notifications, trending topics) - -Output should be a stringified array of elements usually find in a nostr event' `tags`, e.g.: - -```json -{ "content": "[ - [\"e\", \"\"], - [\"a\", \"30023:pubkey:id\"], - [\"t\", \"tag\"], - [\"p\", \"pubkey\"], -]" } -``` - -| param | req? | description | -|-----------|------|-------------------------------------------------------| -| `filter` | opt | Stringified JSON `REQ` filter. Used to scope the desired results (e.g. specify the desired kinds) -| `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. -| `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. - -### example job-request - -Generate an algorithmic feed of the most interesting `kind:1`s related to the topic "bitcoin", tagging service providers specializing in safe-for-work content -that would interest pubkey `pubkey1`. - -```json -{ - "kind": 65006, - "tags": [ - [ "param", "filter", "{ \"kinds\": [1], \"#t\": [\"bitcoin\"] }" ], - [ "param", "p", "[\"pubkey1\"]"] - [ "bid", "5000" ], - [ "t", "sfw" ] - ] -} -``` - -# Appendix 3: Job feedback status +### Job feedback status | status | description | |--------|-------------| @@ -420,16 +122,47 @@ that would interest pubkey `pubkey1`. Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. -# Appendix 4: Service provider discoverability -Service Providers can use NIP-89 announcements to advertise their support for job kinds: +# Protocol Flow +* Customer publishes a job request (e.g. `kind:5000` speech-to-text). +* Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event. +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user + +Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers MUST use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. + +Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. + +## Notes about the protocol flow +The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. + +Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering results, some might choose to serve partial results for the job (e.g. a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. + +It's not up to this NIP to define how individual vending machines should choose to run their business. + +# Cancellation +A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. + +# Appendix 1: Job chaining +A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. + +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. + +This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). + +# Appendix 2: Service provider discoverability +Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: ```json { "kind": 31990, "pubkey": "", + "content": "{ + \"name\": \"Translating DVM\", + \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" + }", "tags": [ - [ "k", 65002 ], // e.g. speech-to-text + [ "k", 5005 ], // e.g. translation [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" ] } From cf672b764bdcb6c33361203c206d5d52270c22ec Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 17 Oct 2023 07:38:53 -0300 Subject: [PATCH 300/314] remove useless "block" tag on OTS. --- 03.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/03.md b/03.md index 4faf3f15..680cc8b2 100644 --- a/03.md +++ b/03.md @@ -13,7 +13,6 @@ This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps]( "kind": 1040 "tags": [ ["e", , ], - ["block", , ], ["alt", "opentimestamps attestation"] ], "content": @@ -21,7 +20,6 @@ This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps]( ``` - The OpenTimestamps proof MUST prove the referenced `e` event id as its digest. -- The `block` tag is optional, it exists to establish a minimum date since which the given event has existed. - The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation and no reference to "pending" attestations since they are useless in this context. ### Example OpenTimestamps proof verification flow From 4216f0bf2f73b4a395568b6874132aca94f55094 Mon Sep 17 00:00:00 2001 From: Egge Date: Thu, 19 Oct 2023 14:27:56 +0200 Subject: [PATCH 301/314] added nodestr --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 0c8c4027..a9b6b343 100644 --- a/07.md +++ b/07.md @@ -34,3 +34,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) - [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) - [Spring Browser](https://spring.site) (Android) +- [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill) From ca73c5dd5ea19dec29a2781f1d3bd93ef95985f9 Mon Sep 17 00:00:00 2001 From: Mike O'Bank <111360219+mikeobank@users.noreply.github.com> Date: Fri, 20 Oct 2023 22:56:29 +0200 Subject: [PATCH 302/314] Clarify Unsigned Event Object type --- 07.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/07.md b/07.md index a9b6b343..24d8d456 100644 --- a/07.md +++ b/07.md @@ -12,7 +12,7 @@ That object must define the following methods: ``` async window.nostr.getPublicKey(): string // returns a public key as hex -async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it +async window.nostr.signEvent(event: { created_at: number, kind: number, tags: string[][], content: string }): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it ``` Aside from these two basic above, the following functions can also be implemented optionally: From 435147149af83cbdbb7a183b9d8769ed1dbb717d Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Sun, 29 Oct 2023 11:45:49 +0100 Subject: [PATCH 303/314] update readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6f9cb03c..8044b243 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | +| `7000` | Job Feedback | [90](90.md) | | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | From ad019ee0670c766b467028e7a55994cea4093a4a Mon Sep 17 00:00:00 2001 From: Akiomi Kamakura Date: Mon, 30 Oct 2023 11:00:57 +0900 Subject: [PATCH 304/314] DVM kinds change on README (#850) --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 8044b243..8be05951 100644 --- a/README.md +++ b/README.md @@ -130,8 +130,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | | `34550` | Community Definition | [72](72.md) | -| `65000` | Job Feedback | [90](90.md) | -| `65001` | Job Result | [90](90.md) | ## Message types From 4b9f13d983245e4dd166f102308afc28b8bb1603 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Tue, 31 Oct 2023 00:21:53 +0300 Subject: [PATCH 305/314] NIP-90: consistency changes --- 90.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 4c0eff6a..163dbd06 100644 --- a/90.md +++ b/90.md @@ -43,7 +43,7 @@ A request to process data, published by a customer. This event signals that an c "tags": [ [ "i", "", "", "", "" ], [ "output", "" ], - [ "relays", "wss://..."], + [ "relays", "wss://..." ], [ "bid", "" ], [ "t", "bitcoin" ] ] @@ -162,10 +162,10 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" }", "tags": [ - [ "k", 5005 ], // e.g. translation + [ "k", "5005" ], // e.g. translation [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" ] } ``` -Customers can use NIP-89 to see what service providers their follows use. \ No newline at end of file +Customers can use NIP-89 to see what service providers their follows use. From a328831a07defcd11924c2330b5aaf4f65ec40aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= Date: Tue, 31 Oct 2023 15:48:04 +0200 Subject: [PATCH 306/314] Unlimited quantity possible in NIP-15. --- 15.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/15.md b/15.md index edece818..68d28ff1 100644 --- a/15.md +++ b/15.md @@ -88,7 +88,7 @@ Fields that are not self-explanatory: "images": <[String], array of image URLs, optional>, "currency": , "price": , - "quantity": , + "quantity": , "specs": [ [, ] ], @@ -102,6 +102,7 @@ Fields that are not self-explanatory: ``` Fields that are not self-explanatory: + - `quantity` can be null in the case of items with unlimited abailability, like digital items, or services - `specs`: - an optional array of key pair values. It allows for the Customer UI to 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"]]` From cee69773473a9f6fed2cd7a150d70e77837a42b4 Mon Sep 17 00:00:00 2001 From: Ryan Breen Date: Wed, 1 Nov 2023 08:55:45 -0400 Subject: [PATCH 307/314] Adding Nostore to NIP-07 extension list. --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 24d8d456..51ddc165 100644 --- a/07.md +++ b/07.md @@ -35,3 +35,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) - [Spring Browser](https://spring.site) (Android) - [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill) +- [Nostore](https://apps.apple.com/us/app/nostore/id1666553677) (Safari on iOS/MacOS) From b14b9d2120ea7fd287eb44249ce5910df7ad45d2 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 2 Nov 2023 19:46:35 -0300 Subject: [PATCH 308/314] nip-01: clarify that whitespace is allowed inside the strings. closes https://github.com/nostr-protocol/nips/pull/861 --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 2b28f23f..183e0ba2 100644 --- a/01.md +++ b/01.md @@ -29,9 +29,9 @@ The only object type that exists is the `event`, which has the following format } ``` -To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (with no white space or line breaks) of the following structure: +To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (with no white space or line breaks between the fields) of the following structure: -```json +``` [ 0, , From 08d3eff350d11657160eca78459da34d9254252b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 4 Nov 2023 16:55:28 -0300 Subject: [PATCH 309/314] 52: fix kinds (as ints). --- 52.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/52.md b/52.md index f5bd0adb..69507441 100644 --- a/52.md +++ b/52.md @@ -40,7 +40,7 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": "31922", + "kind": 31922, "content": "", "tags": [ ["d", ""], @@ -98,7 +98,7 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": "31923", + "kind": 31923, "content": "", "tags": [ ["d", ""], @@ -183,7 +183,7 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": "31925", + "kind": 31925, "content": "", "tags": [ ["a", "<31922 or 31923>::", ""], From 749c9b0a2d49d09ccbd00f6bdb4843182e334ddf Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Wed, 25 Oct 2023 12:21:24 +0900 Subject: [PATCH 310/314] clearly define the term "READ/WRITE relay" --- 65.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/65.md b/65.md index b6760290..573e1df2 100644 --- a/65.md +++ b/65.md @@ -8,7 +8,7 @@ Relay List Metadata Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. -The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. If the marker is omitted, the relay is used for both purposes. +The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. Relays marked as `read` / `write` are called READ / WRITE relays, respectively. If the marker is omitted, the relay is used for both purposes. The `.content` is not used. @@ -27,7 +27,7 @@ The `.content` is not used. This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. -## When to Use Read and Write +## When to Use Read and Write Relays When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` From 6b566e897cf0a75d9b6671e73bc614333b89d7ae Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Wed, 25 Oct 2023 12:27:18 +0900 Subject: [PATCH 311/314] make the usage of punctuations uniform --- 65.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/65.md b/65.md index 573e1df2..939b2639 100644 --- a/65.md +++ b/65.md @@ -23,26 +23,27 @@ The `.content` is not used. ], "content": "", ...other fields +} ``` This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. ## When to Use Read and Write Relays -When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` +When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002`. -When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002` +When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002`. When broadcasting an event, Clients SHOULD: - Broadcast the event to the WRITE relays of the author -- Broadcast the event all READ relays of each tagged user. +- Broadcast the event all READ relays of each tagged user ## Motivation The old model of using a fixed relay list per user centralizes in large relay operators: - - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience. + - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication - Events are being copied between relays, oftentimes to many different relays From 108b7f16f9f75157cffde590a55077e4dfe7c955 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Mon, 6 Nov 2023 13:18:11 -0300 Subject: [PATCH 312/314] clarify that the OK array must have 4 items. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 183e0ba2..cb4f522d 100644 --- a/01.md +++ b/01.md @@ -150,7 +150,7 @@ Relays can send 4 types of messages, which must also be JSON arrays, according t This NIP defines no rules for how `NOTICE` messages should be sent or treated. - `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). -- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MAY be empty when the 3rd is `true`, otherwise it MUST be a string containing a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is `true`, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: * `["OK", "b1a649ebe8...", true, ""]` * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` From b128ad98ade41b2b1f029e7460329554748fea73 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Tue, 7 Nov 2023 14:16:43 +0200 Subject: [PATCH 313/314] NIP-84: Highlights (#501) Co-authored-by: Alejandro Co-authored-by: arthurfranca Co-authored-by: fiatjaf_ --- 84.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 100 insertions(+) create mode 100644 84.md diff --git a/84.md b/84.md new file mode 100644 index 00000000..b4a4be72 --- /dev/null +++ b/84.md @@ -0,0 +1,98 @@ +NIP-84 +====== + +Highlights +---------- + +`draft` `optional` `author:pablof7z` + +This NIP defines `kind:9802`, a "highlight" event, to signal content a user finds valuable. + +## Format +The `.content` of these events is the highlighted portion of the text. + +`.content` might be empty for highlights of non-text based media (e.g. NIP-94 audio/video). + +### References +Events SHOULD tag the source of the highlight, whether nostr-native or not. +`a` or `e` tags should be used for nostr events and `r` tags for URLs. + +When tagging a URL, clients generating these events SHOULD do a best effort of cleaning the URL from trackers +or obvious non-useful information from the query string. + +### Attribution +Clients MAY include one or more `p` tags, tagging the original authors of the material being highlighted; this is particularly +useful when highlighting non-nostr content for which the client might be able to get a nostr pubkey somehow +(e.g. prompting the user or reading a `` tag on the document). A role MAY be included as the +last value of the tag. + +```json +[ "p", "...", "author" ], +[ "p", "...", "author" ], +[ "p", "...", "editor" ], +``` + +### Context +Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the +surrounding content might be beneficial to give context to the higlight. + +### Ranges +Clients MAY include `range` tags with the start/end indexes of where the highlight begins and finishes within +the referenced article/tagged-event. + +``` +[ "range", , ] +``` + +Additionally a range with `context` as the third value of the tag MAY be added to indicate the begin/finish indexes +of the highlight within the included `context` tag. + +``` +[ "range", , , "context" ] +``` + +#### Text-based nostr events' highlights + +Highlights of Nostr events SHOULD use the range index of the content as-is +(e.g. NIP-23 articles include the markdown instead of computing the index from the rendered markdown). + +``` +[ "range", 3000, 3042 ] # highlight begins at index position 3000 of the tagged event's `.content` +[ "range", 42, 84, "context" ] # highlight begins at index position 42 of the `context` tag's value +``` + +#### Non-text-based nostr events' highlights + +A `kind:9802` event that tags a NIP-94 event which includes a video or audio file can use ranges to +indicate the start/end time position in seconds. + +#### Ranges in URL highlights + +When creating a highlight from a URL the range should be expressed over +the extracted plain text of the formatted content (e.g. rendered HTML instead of including the HTML markup); +this helps make finding the correct indexes easier on websites with markup variations on each render. + +e.g. `hello, world` + +Tagging `hello, world` would result in using a range tag like `["range", 0, 12 ]`. + +Text extraction (i.e. translation from non-plain text medium like HTML or PDF) is highly subjective and the value +of the range should be carefully interpreted by the different clients that support this. + +```json +{ + "created_at": 1682707885, + "content": "while allowing creators to simply keep doing what they’re doing. Creators don’t need to be blatant shills for brands", + "tags": [ + [ "r", "https://footstr.com/zapvertise/" ], + [ "p", "c48e29f04b482cc01ca1f9ef8c86ef8318c059e0e9353235162f080f26e14c11", "wss://relay.url", "author" ], + [ "context", "The Nostr zapvertising model creates a truly free market for advertisers, while allowing creators to simply keep doing what they’re doing. Creators don’t need to be blatant shills for brands, they just have to create high quality content people find valuable, and companies will naturally want to zapvertise on their posts." ] + [ "range", 3916, 4032 ], + [ "range", 74, 190, "context" ], + ], + "kind": 9802, + "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", + "id": "59e5887a3cdf32d5f11edf9b8cd098c620d278514b2edde3e6d1ba8a541d262c", + "sig": "f2d15b8bc2csf6d198350f8df0a31dcf66d7c32ec9c54e6b3f102d579370b7de9d164d70350a5b32a2911db3b124e972bafa9a1bc8fd60c1e338903d2f6306b0" +} +``` diff --git a/README.md b/README.md index 8be05951..f818b043 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-72: Moderated Communities](72.md) - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) +- [NIP-84: Highlights](84.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-94: File Metadata](94.md) @@ -101,6 +102,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | +| `9802` | Highlights | [84](84.md) | | `10000` | Mute List | [51](51.md) | | `10001` | Pin List | [51](51.md) | | `10002` | Relay List Metadata | [65](65.md) | From d85f9269ca300fb3bee627733c8086df4fcff875 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 7 Nov 2023 09:19:11 -0300 Subject: [PATCH 314/314] 84: fix markers example. --- 84.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/84.md b/84.md index b4a4be72..89bf88b1 100644 --- a/84.md +++ b/84.md @@ -27,9 +27,9 @@ useful when highlighting non-nostr content for which the client might be able to last value of the tag. ```json -[ "p", "...", "author" ], -[ "p", "...", "author" ], -[ "p", "...", "editor" ], +[ "p", "", "", "author" ], +[ "p", "", "", "author" ], +[ "p", "", "", "editor" ], ``` ### Context