diff --git a/01.md b/01.md index 517ccb57..2b6f3af3 100644 --- a/01.md +++ b/01.md @@ -42,6 +42,7 @@ NIP-01 ] ``` +<<<<<<< HEAD 同一のイベントに対して異なるイベントIDが生成されるような実装の差異を防ぐため、シリアライズを行う際には以下のルールに従わなければならない(MUST): - ホワイトスペースや改行、その他の不必要なフォーマットは出力のJSONに含めてはならない。 - 以下の文字列以外はエスケープせず、そのまま含めるべきだ: @@ -53,10 +54,27 @@ NIP-01 - バックスペース`0x08`は`\b` - 改ページ`0x0C`は`\f` - エンコーディングにはUTF-8を使用するべきだ。 +======= +To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: +- UTF-8 should be used for encoding. +- Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON. +- The following characters in the content field must be escaped as shown, and all other characters must be included verbatim: + - A line break (`0x0A`), use `\n` + - A double quote (`0x22`), use `\"` + - A backslash (`0x5C`), use `\\` + - A carriage return (`0x0D`), use `\r` + - A tab character (`0x09`), use `\t` + - A backspace, (`0x08`), use `\b` + - A form feed, (`0x0C`), use `\f` +>>>>>>> upstream/master ### タグ +<<<<<<< HEAD タグはそれぞれ任意長の文字列の配列で、関連していくつかの慣例がある。以下の例を見てみよう。 +======= +Each tag is an array of one or more strings, with some conventions around them. Take a look at the example below: +>>>>>>> upstream/master ```jsonc { @@ -87,15 +105,27 @@ NIP-01 Kindはクライアントがイベントやイベントのフィールドをどう解釈すべきかを決める(たとえば、`"r"`タグのkind 1における意味は、kind 10002のイベントにおける意味と全く異なる可能性がある)。それぞれのNIPにおいて、他の場所で定義されていないkindの意味を定義する可能性がある。このNIPでは、以下のように2つの基本的なkindを定義する。 +<<<<<<< HEAD - `0`: **メタデータ**: `content`は文字列化されたJSONオブジェクト`{name: <ユーザ名>, about: <文字列>, picture: }`で、イベントを作成したユーザのことを記述する。リレーは、同一のpubkeyから新しいイベントを受信した際、過去のイベントを削除できる。 - `1`: **テキスト投稿**: `content`はノート(ユーザが発言したいこと)を**プレーンテキスト**で指定する。パースが必要なコンテンツ(マークダウンやHTMLなど)を使用すべきではない。クライアントもコンテンツをそのようにパースをしてはならない。 +======= +- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. +- `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. +>>>>>>> upstream/master 実験を容易にし、リレーの実装を柔軟にするため、kindの範囲についての以下のような慣例もある。 +<<<<<<< HEAD - kind`n`が範囲`1000 <= n < 10000`の場合は、イベントは**通常(regular)**で、全てがリレーに保存されることが期待される。 - kind`n`が範囲`10000 <= n < 20000 || n == 0 || n == 3`の場合は、イベントは**置換可能(replaceable)**で、最新のイベントだけがリレーに保持されなければならない(MUST)。また、古いバージョンは破棄してもかまわない(MAY)。 - kind`n`が範囲`20000 <= n < 30000`の場合は、イベントは**一時的(ephemeral)**で、リレーに保存されないことが期待される。 - kind`n`が範囲`30000 <= n < 40000`の場合は、イベントは**パラメータ付き置換可能(parameterized replaceable)**で、`pubkey`と`kind`と`d`タグの最初の値の組み合わせについて、最新のイベントのみがリレーに保存されなければならない(MUST)。また、古いバージョンは破棄してかまわない(MAY)。 +======= +- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays. +- 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 MUST be stored by relays, older versions MAY be discarded. +>>>>>>> upstream/master 置換可能イベントが同じタイムスタンプを持っている場合は、最も小さいID(辞書順で最初)のイベントが保持され、他のイベントは破棄されるべきだ。 @@ -125,8 +155,8 @@ Kindはクライアントがイベントやイベントのフィールドをど "authors": , "kinds": , "#": , - "since": , - "until": , + "since": = to this to pass>, + "until": , "limit": } ``` @@ -143,7 +173,11 @@ Kindはクライアントがイベントやイベントのフィールドをど 1つの`REQ`メッセージに複数のフィルタを含むことができる。この場合、いずれかのフィルタにマッチするイベントが返される。つまり、複数のフィルタは`||`条件として解釈される。 +<<<<<<< HEAD フィルタの`limit`プロパティは、初期クエリにのみ影響を及ぼし、それ以降は無視されなければならない(MUST)。`limit: n`が存在する場合、初期クエリでは最新の`n`イベントが`created_at`順に返されることが想定される。`limit`の指定よりも少ないイベントを返すことは問題ない。しかし、クライアントに対して不必要に負荷を与えることを避けるため、リレーは要求されたよりも(はるかに)多くのイベントを返すことがないよう期待される。 +======= +The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. Newer events should appear first, and in the case of ties the event with the lowest id (first in lexical order) should be first. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. +>>>>>>> upstream/master ### リレーからクライアントへ: イベントの送信と通知 diff --git a/02.md b/02.md index b8eba647..bdb07dbb 100644 --- a/02.md +++ b/02.md @@ -8,7 +8,13 @@ NIP-02 「フォローリスト」を意味するkind `3`の特別なイベントは、フォローしている/既知のプロフィールごとの`p`タグのリストを持つものとして定義される。 +<<<<<<< HEAD タグの個々の要素は、プロフィールの鍵・その鍵からのイベントを発見できるリレーのURL (必要なければ空文字列で設定可能) ・そのプロフィールのローカル名 (あるいは「愛称」) (空文字列が設定されるか、提供されないようできる) を含むべきで、つまり`["p", <32-bytes hex key>,
, ]`である。`content`は何でもかまわないが、無視されるべきである。 +======= +Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>,
, ]`. + +The `.content` is not used. +>>>>>>> upstream/master 例: diff --git a/04.md b/04.md index dbd0cd72..3c22ba0a 100644 --- a/04.md +++ b/04.md @@ -1,4 +1,4 @@ -> __Warning__ `unrecommended`: deprecated in favor of [NIP-44](44.md) +> __Warning__ `unrecommended`: deprecated in favor of [NIP-17](17.md) NIP-04 ====== diff --git a/05.md b/05.md index 2f9bb27b..0f6060dc 100644 --- a/05.md +++ b/05.md @@ -6,11 +6,19 @@ Nostr鍵をDNSベースのインターネット識別子に結びつける `final` `optional` +<<<<<<< HEAD kind `0` (`metadata`)には[インターネット識別子](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (eメールのようなアドレス) を値として`"nip05"`というキーを指定できる。"インターネット識別子"に対する多種多様な仕様のリンクがあるが、NIP-05は``部分が`a-z0-9-_.`で大文字と小文字を区別しないことを前提としている。 +======= +On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +>>>>>>> upstream/master クライアントは識別子を``と``に分けた上でそれらの値で`https:///.well-known/nostr.json?name=`にGET要求を行う。 +<<<<<<< HEAD 結果として、16進数で表される公開鍵に対応した`"names"`キーを持つ、JSONドキュメントオブジェクトが返されなければならない。指定された``の公開鍵が`metadata`イベントの`pubkey`と一致する場合、クライアントは与えられた公開鍵が実際にその識別子で照会できると結論付ける。 +======= +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 `user's metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +>>>>>>> upstream/master ### 例 diff --git a/07.md b/07.md index ae2defe3..5346f5bb 100644 --- a/07.md +++ b/07.md @@ -24,6 +24,14 @@ async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertex async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44 ``` +<<<<<<< HEAD ### 実装 +======= +### Recommendation to Extension Authors +To make sure that the `window.nostr` is available to nostr clients on page load, the authors who create Chromium and Firefox extensions should load their scripts by specifying `"run_at": "document_end"` in the extension's manifest. + + +### Implementation +>>>>>>> upstream/master https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions を参照する。 diff --git a/09.md b/09.md index fbbd6e13..e1be5429 100644 --- a/09.md +++ b/09.md @@ -1,16 +1,14 @@ NIP-09 ====== -Event Deletion +Event Deletion Request -------------- `draft` `optional` -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. +A special event with kind `5`, meaning "deletion request" is defined as having a list of one or more `e` or `a` tags, each referencing an event the author is requesting to be deleted. Deletion requests SHOULD include a `k` tag for the kind of each event being requested for deletion. -Each tag entry must contain an "e" event id and/or `a` tags intended for deletion. - -The event's `content` field MAY contain a text note describing the reason for the deletion. +The event's `content` field MAY contain a text note describing the reason for the deletion request. For example: @@ -21,29 +19,35 @@ For example: "tags": [ ["e", "dcd59..464a2"], ["e", "968c5..ad7a4"], - ["a", "::"] + ["a", "::"], + ["k", "1"], + ["k", "30023"] ], "content": "these posts were published by accident", ...other fields } ``` -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 delete or stop publishing any referenced events that have an identical `pubkey` as the deletion request. Clients SHOULD hide or otherwise indicate a deletion request status for referenced events. + +Relays SHOULD continue to publish/share the deletion request events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion request events to other relays which don't have it. -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. +When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion request event. ## 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 events' 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 request 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 request 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. -Clients display the deletion event itself in any way they choose, e.g., not at all, or with a prominent notice. +Clients display the deletion request event itself in any way they choose, e.g., not at all, or with a prominent notice. + +Clients MAY choose to inform the user that their request for deletion does not guarantee deletion because it is impossible to delete events from all relays and clients. ## Relay Usage -Relays MAY validate that a deletion event only references events that have the same `pubkey` as the deletion itself, however this is not required since relays may not have knowledge of all referenced events. +Relays MAY validate that a deletion request event only references events that have the same `pubkey` as the deletion request itself, however this is not required since relays may not have knowledge of all referenced events. -## Deleting a Deletion +## Deletion Request of a Deletion Request -Publishing a deletion event against a deletion has no effect. Clients and relays are not obliged to support "undelete" functionality. +Publishing a deletion request event against a deletion request has no effect. Clients and relays are not obliged to support "unrequest deletion" functionality. diff --git a/10.md b/10.md index a434ea05..dfd4cb9e 100644 --- a/10.md +++ b/10.md @@ -38,13 +38,14 @@ They are citing 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"`. + * `` is optional, SHOULD be the pubkey of the author of the referenced event Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. @@ -52,6 +53,7 @@ A direct reply to the root of a thread should have a single marked "e" tag of ty >This scheme is preferred because it allows events to mention others without confusing them with `` or ``. +`` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event. ## The "p" tag Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. diff --git a/11.md b/11.md index 45102d7e..a50038a0 100644 --- a/11.md +++ b/11.md @@ -37,7 +37,7 @@ Detailed plain-text information about the relay may be contained in the `descrip ### Pubkey -An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See `NIP-04`) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. +An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. Relay operators have no obligation to respond to direct messages. diff --git a/13.md b/13.md index 53c4d1b6..99289c2a 100644 --- a/13.md +++ b/13.md @@ -35,7 +35,7 @@ Example mined note "created_at": 1651794653, "kind": 1, "tags": [ - ["nonce", "776797", "21"] + ["nonce", "776797", "20"] ], "content": "It's just me mining my own business", "sig": "284622fc0a3f4f1303455d5175f7ba962a3300d136085b9566801bc2e0699de0c7e31e44c81fb40ad9049173742e904713c3594a1da0fc5d2382a25c11aba977" diff --git a/15.md b/15.md index 55814fb5..6daa8019 100644 --- a/15.md +++ b/15.md @@ -6,7 +6,7 @@ Nostr Marketplace `draft` `optional` -Based on https://github.com/lnbits/Diagon-Alley. +Based on [Diagon-Alley](https://github.com/lnbits/Diagon-Alley). Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). @@ -139,7 +139,7 @@ Fields that are not self-explanatory: ## Checkout events -All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md)). +All checkout events are sent as JSON strings using [NIP-04](04.md). The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types: @@ -150,7 +150,7 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff | 2 | Merchant | Order Status Update | ### Step 1: `customer` order (event) -The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in content of [NIP-04](04.md). ```json { @@ -182,7 +182,7 @@ _Open_: is `contact.nostr` required? Sent back from the merchant for payment. Any payment option is valid that the merchant can check. -The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in `content` of [NIP-04](04.md). `payment_options`/`type` include: @@ -217,7 +217,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n Once payment has been received and processed. -The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in `content` of [NIP-04](04.md). ```json { @@ -231,7 +231,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n ## 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. +Create a customized user experience using the `naddr` from [NIP-19](19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. ### Event `30019`: Create or update marketplace UI/UX @@ -331,7 +331,7 @@ Another thing that can happen is - if bids happen very close to the end date of ## Customer support events -Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md. +Customer support is handled over whatever communication method was specified. If communicating via nostr, [NIP-04](04.md) is used. ## Additional diff --git a/17.md b/17.md new file mode 100644 index 00000000..0f51367a --- /dev/null +++ b/17.md @@ -0,0 +1,164 @@ +NIP-17 +====== + +Private Direct Messages +----------------------- + +`draft` `optional` + +This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. + +## Direct Message Kind + +Kind `14` is a chat message. `p` tags identify one or more receivers of the message. + +```js +{ + "id": "", +  "pubkey": "", + "created_at": now(), +  "kind": 14, +  "tags": [ +    ["p", "", ""], +    ["p", "", ""], +    ["e", "", "", "reply"] // if this is a reply + ["subject", ""], +    ... +  ], +  "content": "", +} +``` + +`.content` MUST be plain text. Fields `id` and `created_at` are required. + +Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md). + +Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. + +## Chat Rooms + +The set of `pubkey` + `p` tags defines a chat room. If a new `p` tag is added or a current one is removed, a new room is created with clean message history. + +Clients SHOULD render messages of the same room in a continuous thread. + +An optional `subject` tag defines the current name/topic of the conversation. Any member can change the topic by simply submitting a new `subject` to an existing `pubkey` + `p`-tags room. There is no need to send `subject` in every message. The newest `subject` in the thread is the subject of the conversation. + +## Encrypting + +Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. + +```js +{ + "id": "", +  "pubkey": randomPublicKey, +  "created_at": randomTimeUpTo2DaysInThePast(), + "kind": 1059, // gift wrap +  "tags": [ +    ["p", receiverPublicKey, ""] // receiver +  ], +  "content": nip44Encrypt( +    { + "id": "", +      "pubkey": senderPublicKey, +      "created_at": randomTimeUpTo2DaysInThePast(), +      "kind": 13, // seal +      "tags": [], // no tags +      "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey), +      "sig": "" +    }, +    randomPrivateKey, receiverPublicKey +  ), +  "sig": "" +} +``` + +The encryption algorithm MUST use the latest version of [NIP-44](44.md). + +Clients MUST verify if pubkey of the `kind:13` is the same pubkey on the `kind:14`, otherwise any sender can impersonate others by simply changing the pubkey on `kind:14`. + +Clients SHOULD randomize `created_at` in up to two days in the past in both the seal and the gift wrap to make sure grouping by `created_at` doesn't reveal any metadata. + +The gift wrap's `p`-tag can be the receiver's main pubkey or an alias key created to receive DMs without exposing the receiver's identity. + +Clients CAN offer disappearing messages by setting an `expiration` tag in the gift wrap of each receiver or by not generating a gift wrap to the sender's public key + +## Publishing + +Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. + +```js +{ + "kind": 10050, + "tags": [ + ["relay", "wss://inbox.nostr.wine"], + ["relay", "wss://myrelay.nostr1.com"], + ], + "content": "", + //...other fields +} +``` + +Clients SHOULD publish kind `14` events to the `10050`-listed relays. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try. + +## Relays + +It's advisable that relays do not serve `kind:14` to clients other than the ones tagged in them. + +It's advisable that users choose relays that conform to these practices. + +Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable. + +## Benefits & Limitations + +This NIP offers the following privacy and security features: + +1. **No Metadata Leak**: Participant identities, each message's real date and time, event kinds, and other event tags are all hidden from the public. Senders and receivers cannot be linked with public information alone. +2. **No Public Group Identifiers**: There is no public central queue, channel or otherwise converging identifier to correlate or count all messages in the same group. +3. **No Moderation**: There are no group admins: no invitations or bans. +4. **No Shared Secrets**: No secret must be known to all members that can leak or be mistakenly shared +5. **Fully Recoverable**: Messages can be fully recoverable by any client with the user's private key +6. **Optional Forward Secrecy**: Users and clients can opt-in for "disappearing messages". +7. **Uses Public Relays**: Messages can flow through public relays without loss of privacy. Private relays can increase privacy further, but they are not required. +8. **Cold Storage**: Users can unilaterally opt-in to sharing their messages with a separate key that is exclusive for DM backup and recovery. + +The main limitation of this approach is having to send a separate encrypted event to each receiver. Group chats with more than 100 participants should find a more suitable messaging scheme. + +## Implementation + +Clients implementing this NIP should by default only connect to the set of relays found in their `kind:10050` list. From that they should be able to load all messages both sent and received as well as get new live updates, making it for a very simple and lightweight implementation that should be fast. + +When sending a message to anyone, clients must then connect to the relays in the receiver's `kind:10050` and send the events there, but can disconnect right after unless more messages are expected to be sent (e.g. the chat tab is still selected). Clients should also send a copy of their outgoing messages to their own `kind:10050` relay set. + +## Examples + +This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. + +The two final GiftWraps, one to the receiver and the other to the sender, are: + +```json +{ + "id":"2886780f7349afc1344047524540ee716f7bdc1b64191699855662330bf235d8", + "pubkey":"8f8a7ec43b77d25799281207e1a47f7a654755055788f7482653f9c9661c6d51", + "created_at":1703128320, + "kind":1059, + "tags":[ + [ "p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"] + ], + "content":"AsqzdlMsG304G8h08bE67dhAR1gFTzTckUUyuvndZ8LrGCvwI4pgC3d6hyAK0Wo9gtkLqSr2rT2RyHlE5wRqbCOlQ8WvJEKwqwIJwT5PO3l2RxvGCHDbd1b1o40ZgIVwwLCfOWJ86I5upXe8K5AgpxYTOM1BD+SbgI5jOMA8tgpRoitJedVSvBZsmwAxXM7o7sbOON4MXHzOqOZpALpS2zgBDXSAaYAsTdEM4qqFeik+zTk3+L6NYuftGidqVluicwSGS2viYWr5OiJ1zrj1ERhYSGLpQnPKrqDaDi7R1KrHGFGyLgkJveY/45y0rv9aVIw9IWF11u53cf2CP7akACel2WvZdl1htEwFu/v9cFXD06fNVZjfx3OssKM/uHPE9XvZttQboAvP5UoK6lv9o3d+0GM4/3zP+yO3C0NExz1ZgFmbGFz703YJzM+zpKCOXaZyzPjADXp8qBBeVc5lmJqiCL4solZpxA1865yPigPAZcc9acSUlg23J1dptFK4n3Tl5HfSHP+oZ/QS/SHWbVFCtq7ZMQSRxLgEitfglTNz9P1CnpMwmW/Y4Gm5zdkv0JrdUVrn2UO9ARdHlPsW5ARgDmzaxnJypkfoHXNfxGGXWRk0sKLbz/ipnaQP/eFJv/ibNuSfqL6E4BnN/tHJSHYEaTQ/PdrA2i9laG3vJti3kAl5Ih87ct0w/tzYfp4SRPhEF1zzue9G/16eJEMzwmhQ5Ec7jJVcVGa4RltqnuF8unUu3iSRTQ+/MNNUkK6Mk+YuaJJs6Fjw6tRHuWi57SdKKv7GGkr0zlBUU2Dyo1MwpAqzsCcCTeQSv+8qt4wLf4uhU9Br7F/L0ZY9bFgh6iLDCdB+4iABXyZwT7Ufn762195hrSHcU4Okt0Zns9EeiBOFxnmpXEslYkYBpXw70GmymQfJlFOfoEp93QKCMS2DAEVeI51dJV1e+6t3pCSsQN69Vg6jUCsm1TMxSs2VX4BRbq562+VffchvW2BB4gMjsvHVUSRl8i5/ZSDlfzSPXcSGALLHBRzy+gn0oXXJ/447VHYZJDL3Ig8+QW5oFMgnWYhuwI5QSLEyflUrfSz+Pdwn/5eyjybXKJftePBD9Q+8NQ8zulU5sqvsMeIx/bBUx0fmOXsS3vjqCXW5IjkmSUV7q54GewZqTQBlcx+90xh/LSUxXex7UwZwRnifvyCbZ+zwNTHNb12chYeNjMV7kAIr3cGQv8vlOMM8ajyaZ5KVy7HpSXQjz4PGT2/nXbL5jKt8Lx0erGXsSsazkdoYDG3U", + "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480" +} +``` + +```json +{ + "id":"162b0611a1911cfcb30f8a5502792b346e535a45658b3a31ae5c178465509721", + "pubkey":"626be2af274b29ea4816ad672ee452b7cf96bbb4836815a55699ae402183f512", + "created_at":1702711587, + "kind":1059, + "tags":[ + [ "p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"] + ], + "content":"AsTClTzr0gzXXji7uye5UB6LYrx3HDjWGdkNaBS6BAX9CpHa+Vvtt5oI2xJrmWLen+Fo2NBOFazvl285Gb3HSM82gVycrzx1HUAaQDUG6HI7XBEGqBhQMUNwNMiN2dnilBMFC3Yc8ehCJT/gkbiNKOpwd2rFibMFRMDKai2mq2lBtPJF18oszKOjA+XlOJV8JRbmcAanTbEK5nA/GnG3eGUiUzhiYBoHomj3vztYYxc0QYHOx0WxiHY8dsC6jPsXC7f6k4P+Hv5ZiyTfzvjkSJOckel1lZuE5SfeZ0nduqTlxREGeBJ8amOykgEIKdH2VZBZB+qtOMc7ez9dz4wffGwBDA7912NFS2dPBr6txHNxBUkDZKFbuD5wijvonZDvfWq43tZspO4NutSokZB99uEiRH8NAUdGTiNb25m9JcDhVfdmABqTg5fIwwTwlem5aXIy8b66lmqqz2LBzJtnJDu36bDwkILph3kmvaKPD8qJXmPQ4yGpxIbYSTCohgt2/I0TKJNmqNvSN+IVoUuC7ZOfUV9lOV8Ri0AMfSr2YsdZ9ofV5o82ClZWlWiSWZwy6ypa7CuT1PEGHzywB4CZ5ucpO60Z7hnBQxHLiAQIO/QhiBp1rmrdQZFN6PUEjFDloykoeHe345Yqy9Ke95HIKUCS9yJurD+nZjjgOxZjoFCsB1hQAwINTIS3FbYOibZnQwv8PXvcSOqVZxC9U0+WuagK7IwxzhGZY3vLRrX01oujiRrevB4xbW7Oxi/Agp7CQGlJXCgmRE8Rhm+Vj2s+wc/4VLNZRHDcwtfejogjrjdi8p6nfUyqoQRRPARzRGUnnCbh+LqhigT6gQf3sVilnydMRScEc0/YYNLWnaw9nbyBa7wFBAiGbJwO40k39wj+xT6HTSbSUgFZzopxroO3f/o4+ubx2+IL3fkev22mEN38+dFmYF3zE+hpE7jVxrJpC3EP9PLoFgFPKCuctMnjXmeHoiGs756N5r1Mm1ffZu4H19MSuALJlxQR7VXE/LzxRXDuaB2u9days/6muP6gbGX1ASxbJd/ou8+viHmSC/ioHzNjItVCPaJjDyc6bv+gs1NPCt0qZ69G+JmgHW/PsMMeL4n5bh74g0fJSHqiI9ewEmOG/8bedSREv2XXtKV39STxPweceIOh0k23s3N6+wvuSUAJE7u1LkDo14cobtZ/MCw/QhimYPd1u5HnEJvRhPxz0nVPz0QqL/YQeOkAYk7uzgeb2yPzJ6DBtnTnGDkglekhVzQBFRJdk740LEj6swkJ", + "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab" +} +``` diff --git a/19.md b/19.md index ef808870..cce9e641 100644 --- a/19.md +++ b/19.md @@ -34,8 +34,8 @@ These are the possible bech32 prefixes with `TLV`: - `nprofile`: a nostr profile - `nevent`: a nostr event - - `nrelay`: a nostr relay - `naddr`: a nostr _replaceable event_ coordinate + - `nrelay`: a nostr relay (deprecated) These possible standardized `TLV` types are indicated here: @@ -43,7 +43,6 @@ These possible standardized `TLV` types are indicated here: - depends on the bech32 prefix: - 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 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 diff --git a/21.md b/21.md index b09a706c..d3e404ac 100644 --- a/21.md +++ b/21.md @@ -10,7 +10,11 @@ NIP-21 スキームは `nostr:` である。 +<<<<<<< HEAD 後に続く識別子は、[NIP-19](https://github.com/nostr-jp/nips-ja/blob/main/19.md)で定義されているものと同じであることが期待される(`nsec` を除く)。 +======= +The identifiers that come after are expected to be the same as those defined in [NIP-19](19.md) (except `nsec`). +>>>>>>> upstream/master ## 例 diff --git a/24.md b/24.md index 753c34a1..83708ce8 100644 --- a/24.md +++ b/24.md @@ -28,7 +28,11 @@ kind 0 kind 3 ====== +<<<<<<< HEAD これらは連絡先イベントの文字列化されたJSONに存在する可能性のあるNIP-02で指定されていない追加のフィールドである。 +======= +These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events: +>>>>>>> upstream/master ### 廃止されたフィールド @@ -39,5 +43,11 @@ kind 3 これらのタグは複数のイベントkindに存在する。より具体的なNIPで異なる意味が指定されていない場合は、以下の意味を持つ。 +<<<<<<< HEAD - `r`: イベントがなんらかの形で参照しているウェブのURL。 - `title`: イベントのタイトル。 +======= + - `r`: a web URL the event is referring to in some way + - `i`: an external id the event is referring to in some way - see [NIP-73](73.md) + - `title`: name of [NIP-51](51.md) sets, [NIP-52](52.md) calendar event, [NIP-53](53.md) live event or [NIP-99](99.md) listing +>>>>>>> upstream/master diff --git a/25.md b/25.md index 4fba7a6a..bba29874 100644 --- a/25.md +++ b/25.md @@ -25,24 +25,36 @@ NIP-25 タグ ---- +<<<<<<< HEAD リアクションイベントには、リアクション対象としているイベントに含まれる`e`及び`p`タグを含めるべきである (SHOULD) 。 これにより、各ユーザはメンションされている投稿へのリアクションがあった際、通知を受け取ることが可能になる。 また、クライアントはこのようにして付与された`e`タグを使用することで、1つの投稿あるいはスレッド全体に関連する リアクションを取得することが可能となる。 タグのリストの中で最後に現れる`e`タグでは、リアクション対象となるノートの`id`を指定しなければならない (MUST) 。 +======= +The reaction event SHOULD include `e` and `p` tags from the note the user is reacting to (and optionally `a` tags if the target is a replaceable event). This allows users to be notified of reactions to posts they were mentioned in. Including the `e` tags enables clients to pull all the reactions associated with individual posts or all the posts in a thread. `a` tags enables clients to seek reactions for all versions of a replaceable event. + +The last `e` tag MUST be the `id` of the note that is being reacted to. +>>>>>>> upstream/master タグのリストの中で最後に現れる`p`タグでは、リアクション対象となるイベントの`pubkey`を指定しなければならない (MUST) 。 +<<<<<<< HEAD リアクションイベントには、リアクションされたイベントの文字列化されたkind番号を値とする `k`タグを含めてもよい (MAY) 。 +======= +The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. + +The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. +>>>>>>> upstream/master Example code ```swift func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { - var tags: [[String]] = liked.tags.filter { - tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") + var tags: [[String]] = liked.tags.filter { + tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") } tags.append(["e", liked.id]) tags.append(["p", liked.pubkey]) @@ -54,7 +66,31 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost } ``` +<<<<<<< HEAD カスタム絵文字によるリアクション +======= +Reactions to a website +--------------------- + +If the target of the reaction is a website, the reaction MUST be a `kind 17` event and MUST include an `r` tag with the website's URL. + +```json +{ + "kind": 17, + "content": "⭐", + "tags": [ + ["r", "https://example.com/"] + ], + ...other fields +} +``` + +URLs SHOULD be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6), so that reactions to the same website are not omitted from queries. +A fragment MAY be attached to the URL, to react to a section of the page. +It should be noted that a URL with a fragment is not considered to be the same URL as the original. + +Custom Emoji Reaction +>>>>>>> upstream/master --------------------- クライアントは、リアクション内容として[NIP-30](30.md)のカスタム絵文字における`:shortcode:`を使用してもよい。 @@ -68,8 +104,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost "tags": [ ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] ], - "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", - "created_at": 1682790000 + ...other fields } ``` diff --git a/27.md b/27.md index efd2c122..133f8ef0 100644 --- a/27.md +++ b/27.md @@ -20,7 +20,7 @@ A reader client that receives an event with such `nostr:...` mentions in its `.c 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. +As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://njump.me/npub1937vv2nf06360qn9y8el6d8sevnndy7tuh5nzre4gj05xc32tnwqauhaj6), showing a picture and name. 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: diff --git a/28.md b/28.md index 65ebb3ff..16320880 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.Only the most recent kind 41 is needed to be stored. +Kind 41 is used to update the metadata without modifying the event id for the channel. Only the most recent kind 41 per `e` tag value MAY be available. Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. diff --git a/29.md b/29.md index 0f4a5796..74dfd666 100644 --- a/29.md +++ b/29.md @@ -119,6 +119,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | | 9005 | `delete-event` | `e` (id hex) | | 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | +| 9007 | `create-group` | | - *group metadata* (`kind:39000`) (optional) diff --git a/32.md b/32.md index be4e8724..92d18ebd 100644 --- a/32.md +++ b/32.md @@ -6,10 +6,9 @@ Labeling `draft` `optional` -A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, -including distributed moderation, collection management, license assignment, and content classification. +This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification. -This NIP introduces two new tags: +New Tags: - `L` denotes a label namespace - `l` denotes a label @@ -20,7 +19,7 @@ Label Namespace Tag An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation. -`L` tags are REQUIRED in order to support searching by namespace rather than by a specific tag. The special `ugc` +`L` tags are RECOMMENDED 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` tags starting with `#` indicate that the label target should be associated with the label's value. @@ -29,7 +28,9 @@ This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, Label Tag ---- -An `l` tag's value can be any string. `l` tags MUST include a `mark` matching an `L` tag value in the same event. +An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a mark matching an `L` +tag value in the same event. If no `L` tag is included, a mark SHOULD still be included. If none is +included, `ugc` is implied. Label Target ---- @@ -42,7 +43,7 @@ or topics respectively. As with NIP-01, a relay hint SHOULD be included when usi Content ------- -Labels 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 an explanation of why something was labeled the way it was, should go in the event's `content` field. Self-Reporting @@ -127,10 +128,24 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. } ``` +Author is labeling their note language as English using ISO-639-1. + +```json +{ + "kind": 1, + "tags": [ + ["L", "ISO-639-1"], + ["l", "en", "ISO-639-1"] + ], + "content": "English text", + ... +} +``` + Other Notes ----------- -When using this NIP to bulk-label many targets at once, events may be deleted and a replacement +When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) 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. In order to avoid ambiguity when querying, publishers SHOULD limit labeling events to a single namespace. @@ -151,3 +166,11 @@ A good heuristic for whether a use case fits this NIP is whether labels would ev For example, many events might be labeled with a particular place, topic, or pubkey, but labels with specific values like "John Doe" or "3.18743" are not labels, they are values, and should be handled in some other way. + + +Appendix: Known Ontologies +------------------------- + +Below is a non-exhaustive list of ontologies currently in widespread use. + +- [social.ontolo.categories](https://ontolo.social/) diff --git a/34.md b/34.md index f72fcf28..69f460b7 100644 --- a/34.md +++ b/34.md @@ -23,8 +23,7 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a ["web", "", ...], // a webpage url, if the git server being used provides such a thing ["clone", "", ...], // a url to be given to `git clone` so anyone can clone it ["relays", "", ...] // relays that this repository will monitor for patches and issues - ["earliest-unique-commit", ""] // usually root commit but a recent commit for forks - ["r", ""] // so clients can subscribe to all events related to a local git repo + ["r", "", "euc"] ["maintainers", "", ...] ] } @@ -32,13 +31,45 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a The tags `web`, `clone`, `relays`, `maintainers` can have multiple values. +The `r` tag annotated with the `"euc"` marker should be the commit ID of the earliest unique commit of this repo, made to identify it among forks and group it with other repositories hosted elsewhere that may represent essentially the same project. In most cases it will be the root commit of a repository. In case of a permanent fork between two projects, then the first commit after the fork should be used. + Except `d`, all tags are optional. +## Repository state announcements + +An optional source of truth for the state of branches and tags in a repository. + +```jsonc +{ + "kind": 30618, + "content": "", + "tags": [ + ["d", ""], // matches the identifier in the coresponding repository announcement + ["refs//",""] + ["HEAD", "ref: refs/heads/"] + ] +} +``` + +The `refs` tag may appear multiple times, or none. + +If no `refs` tags are present, the author is no longer tracking repository state using this event. This approach enables the author to restart tracking state at a later time unlike [NIP-09](09.md) deletion requests. + +The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: + +```jsonc +{ + "tags": [ + ["refs//", "", "", "", ...], + ] +} +``` + ## Patches Patches can be sent by anyone to any repository. Patches to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch events SHOULD include an `a` tag pointing to that repository's announcement address. -Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. +Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch. @@ -52,7 +83,7 @@ The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` ["p", ""], ["p", ""], // optionally send the patch to another user to bring it to their attention - ["t", "root"], // ommited for additional patches in a series + ["t", "root"], // omitted for additional patches in a series // for the first patch in a revision ["t", "root-revision"], @@ -124,7 +155,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by ["p", ""], ["p", ""], - // optional for improved subscription filter efficency + // optional for improved subscription filter efficiency ["a", "30617::", ""], ["r", ""] @@ -132,7 +163,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by ["e", "", "", "mention"], // for each // when merged ["merge-commit", ""] - ["r", ""] + ["r", ""] // when applied ["applied-as-commits", "", ...] ["r", ""] // for each @@ -142,7 +173,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by The Status event with the largest created_at date is valid. -The Status of a patch-revision defaults to either that of the root-patch, or `1632` (Closed) if the root-patch's Status is `1631` and the patch-revision isn't tagged in the `1631` event. +The Status of a patch-revision defaults to either that of the root-patch, or `1632` (Closed) if the root-patch's Status is `1631` and the patch-revision isn't tagged in the `1631` event. ## Possible things to be added later diff --git a/35.md b/35.md new file mode 100644 index 00000000..04cfb46d --- /dev/null +++ b/35.md @@ -0,0 +1,70 @@ +NIP-35 +====== + +Torrents +----------- + +`draft` `optional` + +This NIP defined a new `kind 2003` which is a Torrent. + +`kind 2003` is a simple torrent index where there is enough information to search for content and construct the magnet link. No torrent files exist on nostr. + +## Tags +- `x`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` +- `file`: A file entry inside the torrent, including the full path ie. `info/example.txt` +- `tracker`: (Optional) A tracker to use for this torrent + +In order to make torrents searchable by general category, you SHOULD include a few tags like `movie`, `tv`, `HD`, `UHD` etc. + +## Tag prefixes + +Tag prefixes are used to label the content with references, ie. `["i", "imdb:1234"]` + +- `tcat`: A comma separated text category path, ie. `["i", "tcat:video,movie,4k"]`, this should also match the `newznab` category in a best effort approach. +- `newznab`: The category ID from [newznab](https://github.com/Prowlarr/Prowlarr/blob/develop/src/NzbDrone.Core/Indexers/NewznabStandardCategory.cs) +- `tmdb`: [The movie database](https://www.themoviedb.org/) id. +- `ttvdb`: [TV database](https://thetvdb.com/) id. +- `imdb`: [IMDB](https://www.imdb.com/) id. +- `mal`: [MyAnimeList](https://myanimelist.net/) id. +- `anilist`: [AniList](https://anilist.co/) id. + +A second level prefix should be included where the database supports multiple media types. +- `tmdb:movie:693134` maps to `themoviedb.org/movie/693134` +- `ttvdb:movie:290272` maps to `thetvdb.com/movies/dune-part-two` +- `mal:anime:9253` maps to `myanimelist.net/anime/9253` +- `mal:manga:17517` maps to `myanimelist.net/manga/17517` + +In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish. + +```jsonc +{ + "kind": 2003, + "content": "", + "tags": [ + ["title", ""], + ["x", ""], + ["file", "", ""], + ["file", "", ""], + ["tracker", "udp://mytacker.com:1337"], + ["tracker", "http://1337-tracker.net/announce"], + ["i", "tcat:video,movie,4k"], + ["i", "newznab:2045"], + ["i", "imdb:tt15239678"], + ["i", "tmdb:movie:693134"], + ["i", "ttvdb:movie:290272"], + ["t", "movie"], + ["t", "4k"], + ] +} +``` + +## Torrent Comments + +A torrent comment is a `kind 2004` event which is used to reply to a torrent event. + +This event works exactly like a `kind 1` and should follow `NIP-10` for tagging. + +## Implementations +1. [dtan.xyz](https://git.v0l.io/Kieran/dtan) +2. [nostrudel.ninja](https://github.com/hzrd149/nostrudel/tree/next/src/views/torrents) \ No newline at end of file diff --git a/38.md b/38.md index 911d5b18..4f2c06d2 100644 --- a/38.md +++ b/38.md @@ -46,6 +46,8 @@ 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. +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. + # Client behavior Clients MAY display this next to the username on posts or profiles to provide live user status information. @@ -57,5 +59,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 - -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. diff --git a/39.md b/39.md index c819e43b..b7c3b9c6 100644 --- a/39.md +++ b/39.md @@ -12,9 +12,11 @@ Nostr protocol users may have other online identities such as usernames, profile ## `i` tag on a metadata event -A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md): +A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): ```json { + "id": , + "pubkey": , "tags": [ ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], ["i", "twitter:semisol_public", "1619358434134196225"], diff --git a/45.md b/45.md index 780dfb6b..6b253960 100644 --- a/45.md +++ b/45.md @@ -16,14 +16,14 @@ Some queries a client may want to execute against connected relays are prohibiti 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. -```json +``` ["COUNT", , ...] ``` 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": }`. -```json +``` ["COUNT", , {"count": }] ``` @@ -33,14 +33,14 @@ Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST ret ### Followers count -```json +``` ["COUNT", , {"kinds": [3], "#p": []}] ["COUNT", , {"count": 238}] ``` ### Count posts and reactions -```json +``` ["COUNT", , {"kinds": [1, 7], "authors": []}] ["COUNT", , {"count": 5}] ``` diff --git a/46.md b/46.md index 206a8726..ac001e09 100644 --- a/46.md +++ b/46.md @@ -28,7 +28,11 @@ bunker://?relay=&relay=&secret= ``` +<<<<<<< HEAD このトークンはユーザーによってクライアントに貼り付けられ、クライアントはその詳細を使用して指定されたリレーを介してリモート署名器に接続する。 +======= +This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old optional secret. +>>>>>>> upstream/master ### クライアントによって直接接続が開始される場合 @@ -61,8 +65,9 @@ nostrconnect://?relay=&metadata "method": "sign_event", "params": [json_stringified(<{ content: "Hello, I'm signing remotely", - pubkey: "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - // ...the rest of the event data + kind: 1, + tags: [], + created_at: 1714078911 }>)] }), "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey @@ -100,7 +105,7 @@ nostrconnect://?relay=&metadata } ``` -The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure: +The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: ```json { @@ -118,21 +123,21 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.c Each of the following are methods that the client sends to the remote signer. -| Command | Params | Result | -| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[, , ]` | "ack" | -| `sign_event` | `[]` | `json_stringified()` | -| `ping` | `[]` | "pong" | -| `get_relays` | `[]` | `json_stringified({: {read: , write: }})` | -| `get_public_key` | `[]` | `` | -| `nip04_encrypt` | `[, ]` | `` | -| `nip04_decrypt` | `[, ]` | `` | -| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | -| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | +| Command | Params | Result | +| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | +| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | +| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | +| `ping` | `[]` | "pong" | +| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | +| `get_public_key` | `[]` | `<hex-pubkey>` | +| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | +| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | +| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | +| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | ### Requested permissions -The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. +The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. ## Response Events `kind:24133` @@ -147,19 +152,19 @@ The `connect` method may be provided with `optional_requested_permissions` for u } ``` -The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure: +The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: ```json { "id": <request_id>, "result": <results_string>, - "error": <error_string> + "error": <optional_error_string> } ``` - `id` is the request ID that this response is for. - `results` is a string of the result of the call (this can be either a string or a JSON stringified object) -- `error` is an error in string form. +- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request. ### Auth Challenges @@ -207,7 +212,7 @@ When the user types a NIP-05 the client: #### Remote signer discovery via NIP-89 -In this last case, most often used to fascilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events. +In this last case, most often used to facilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events. First the client will query for `kind: 31990` events that have a `k` tag of `24133`. @@ -223,4 +228,4 @@ Coming soon... ## References -- [NIP-04 - Encryption](https://github.com/nostr-protocol/nips/blob/master/04.md) +- [NIP-04 - Encryption](04.md) diff --git a/47.md b/47.md index 90338477..e4e432ca 100644 --- a/47.md +++ b/47.md @@ -38,7 +38,7 @@ a plaintext string with the supported commands, space-separated, eg. `pay_invoic 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. Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. -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: +The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: Request: ```jsonc @@ -81,7 +81,7 @@ If the command was successful, the `error` field must be null. ## 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: +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** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. @@ -95,7 +95,7 @@ The **client** should then store this connection and use it when the user wants ### Example connection string ```sh -nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c +nostr+walletconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c ``` ## Commands @@ -402,7 +402,7 @@ Response: ## 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. +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 the **wallet 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. diff --git a/50.md b/50.md index fee0afcb..a78671af 100644 --- a/50.md +++ b/50.md @@ -26,8 +26,15 @@ NIP-50 リレーは、`content`イベントフィールドに対してマッチングを実行すべきであり(SHOULD)、 その他のフィールドに対するマッチングも、特定のkindについて意味がある場合には実行してもよい(MAY)。 +<<<<<<< HEAD クエリ文字列は、`key:value`ペア(コロンで区切られた2つの単語)を含むかもしれない。このようなものは拡張であり、リレーは サポートしていない拡張は無視すべきだ(SHOULD)。 +======= +Results SHOULD be returned in descending order by quality of search result (as defined by the implementation), +not by the usual `.created_at`. The `limit` filter SHOULD be applied after sorting by matching score. +A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore +extensions they don't support. +>>>>>>> upstream/master クライアントは、複数の検索フィルタを指定できる。例えば、`["REQ", "", { "search": "orange" }, { "kinds": [1, 2], "search": "purple" }]`のようにだ。クライアントは、 `kinds`、`ids`などの他のフィルタフィールドを含めることで、検索結果を特定のイベントに限定できる。 diff --git a/51.md b/51.md index 95acbc81..65bc4848 100644 --- a/51.md +++ b/51.md @@ -20,18 +20,21 @@ Standard lists use non-parameterized replaceable events, meaning users may only For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | -| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | -| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | -| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | -| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | -| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | -| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | -| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | +| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | +| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | +| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | +| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | +| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | +| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | ## Sets diff --git a/52.md b/52.md index f35d9040..bedf613c 100644 --- a/52.md +++ b/52.md @@ -90,9 +90,12 @@ The list of tags are as follows: * `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. +* `summary` (optional) brief description of the calendar event +* `image` (optional) url of an image to use for the event * `location` (optional, repeated) 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 * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `l` (optional, repeated) label to categorize calendar event. e.g. `audiospace` to denote a scheduled event from a live audio space implementation such as cornychat.com * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. @@ -110,6 +113,8 @@ The following tags are deprecated: ["d", "<UUID>"], ["title", "<title of calendar event>"], + ["summary", "<brief description of the calendar event>"], + ["image", "<string with image URI>"], // Timestamps ["start", "<Unix timestamp in seconds>"], @@ -126,6 +131,10 @@ The following tags are deprecated: ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], + // Labels (example using com.cornychat namespace denoting the event as an audiospace) + ["L", "com.cornychat"], + ["l", "audiospace", "com.cornychat"], + // Hashtags ["t", "<tag>"], ["t", "<tag>"], @@ -178,6 +187,10 @@ This NIP is intentionally not defining who is authorized to attend a calendar ev This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. +The RSVP MUST have an `a` tag of the event coordinates to the calendar event, and optionally an `e` tag of the id of the specific calendar event revision. If an `e` tag is present, clients SHOULD interpret it as an indication that the RSVP is a response to that revision of the calendar event, and MAY interpret it to not necessarily apply to other revisions of the calendar event. + +The RSVP MAY tag the author of the calendar event it is in response to using a `p` tag so that clients can easily query all RSVPs that pertain to the author. + ### Format The format uses a parameterized replaceable event kind `31925`. @@ -185,10 +198,12 @@ 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. +* `a` (required) coordinates to a kind `31922` or `31923` calendar event being responded to. +* `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event. * `fb` (optional) `free` or `busy`. 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`. +* `p` (optional) pubkey of the author of the calendar event being responded to. ```json { @@ -198,10 +213,12 @@ The list of tags are as follows: "kind": 31925, "content": "<note>", "tags": [ - ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], + ["e", "<kind 31922 or 31923 event id", "<optional recommended relay URL>"] + ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional recommended relay URL>"], ["d", "<UUID>"], ["status", "<accepted/declined/tentative>"], ["fb", "<free/busy>"], + ["p", "<hex pubkey of kind 31922 or 31923 event>", "<optional recommended relay URL>"] ] } ``` diff --git a/53.md b/53.md index fad2622f..0b1cb813 100644 --- a/53.md +++ b/53.md @@ -77,7 +77,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t ## 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). +Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [zap.stream](https://zap.stream). ## Example diff --git a/54.md b/54.md new file mode 100644 index 00000000..fe469185 --- /dev/null +++ b/54.md @@ -0,0 +1,117 @@ +NIP-54 +====== + +Wiki +---- + +`draft` `optional` + +This NIP defines `kind:30818` (a _parameterized replaceable event_) for long-form text content similar to [NIP-23](23.md), but with one important difference: articles are meant to be descriptions, or encyclopedia entries, of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. + +Articles are identified by lowercase, normalized ascii `d` tags. + +### Articles +```jsonc +{ + "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", + "tags": [ + ["d", "wiki"], + ["title", "Wiki"], + ] +} +``` + +### `d` tag normalization rules + +- Any non-letter character MUST be converted to a `-`. +- All letters MUST be converted to lowercase. + +### Content rules + +The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: + + - `title`: for when the display title should be different from the `d` tag. + - `summary`: for display in lists. + - `a` and `e`: for referencing the original event a wiki article was forked from. + +One extra functionality is added: **wikilinks**. Unlike normal Markdown links `[]()` that link to webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink. + +Wikilinks can take these two forms: + + 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`; + 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. + +### Merge Requests + +Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event. + +[INSERT EVENT EXAMPLE] + +### Redirects + +Event `kind:30819` is also defined to stand for "wiki redirects", i.e. if one thinks `Shell structure` should redirect to `Thin-shell structure` they can issue one of these events instead of replicating the content. These events can be used for automatically redirecting between articles on a client, but also for generating crowdsourced "disambiguation" pages ([common in Wikipedia](https://en.wikipedia.org/wiki/Help:Disambiguation)). + +[INSERT EVENT EXAMPLE] + +How to decide what article to display +------------------------------------- + +As there could be many articles for each given name, some kind of prioritization must be done by clients. Criteria for this should vary between users and clients, but some means that can be used are described below: + +### Reactions + +[NIP-25](25.md) reactions are very simple and can be used to create a simple web-of-trust between wiki article writers and their content. While just counting a raw number of "likes" is unproductive, reacting to any wiki article event with a `+` can be interpreted as a recommendation for that article specifically and a partial recommendation of the author of that article. When 2 or 3-level deep recommendations are followed, suddenly a big part of all the articles may have some form of tagging. + +### Relays + +[NIP-51](51.md) lists of relays can be created with the kind 10102 and then used by wiki clients in order to determine where to query articles first and to rank these differently in relation to other events fetched from other relays. + +### Contact lists + +[NIP-02](02.md) contact lists can form the basis of a recommendation system that is then expanded with relay lists and reaction lists through nested queries. These lists form a good starting point only because they are so widespread. + +### Wiki-related contact lists + +[NIP-51](51.md) lists can also be used to create a list of users that are trusted only in the context of wiki authorship or wiki curationship. + +Forks +--------- +Wiki-events can tag other wiki-events with a `fork` marker to specify that this event came from a different version. Both `a` and `e` tags SHOULD be used and have the `fork` marker applied, to identify the exact version it was forked from. + +Deference +--------- +Wiki-events can tag other wiki-events with a `defer` marker to indicate that it considers someone else's entry as a "better" version of itself. If using a `defer` marker both `a` and `e` tags SHOULD be used. + +This is a stronger signal of trust than a `+` reaction. + +This marker is useful when a user edits someone else's entry; if the original author includes the editor's changes and the editor doesn't want to keep/maintain an independent version, the `link` tag could effectively be a considered a "deletion" of the editor's version and putting that pubkey's WoT weight behind the original author's version. + +Why Markdown? +------------- + +If the idea is to make a wiki then the most obvious text format to use is probably the mediawiki/wikitext format used by Wikipedia since it's widely deployed in all mediawiki installations and used for decades with great success. However, it turns out that format is very bloated and convoluted, has way too many features and probably because of that it doesn't have many alternative implementations out there, and the ones that exist are not complete and don't look very trustworthy. Also it is very much a centralized format that can probably be changed at the whims of the Wikipedia owners. + +On the other hand, Markdown has proven to work well for small scale wikis and one of the biggest wikis in the planet (which is not very often thought of as a wiki), [StackOverflow](https://stackoverflow.com) and its child sites, and also one of the biggest "personal wiki" software, [Obsidian](https://obsidian.md/). Markdown can probably deliver 95% of the functionality of wikitext. When augmented with tables, diagram generators and MathJax (which are common extensions that exist in the wild and can be included in this NIP) that rate probably goes to 99%, and its simplicity is a huge benefit that can't be overlooked. Wikitext format can also be transpíled into Markdown using Pandoc. Given all that, I think it's a reasonable suspicion that mediawiki is not inherently better than Markdown, the success of Wikipedia probably cannot be predicated on the syntax language choice. + +# Appendix 1: Merge requests +Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. + +```jsonc +{ + "content": "I added information about how to make hot ice-creams", + "kind": 818, + "tags": [ + [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], + [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], + [ "p", "<destination-pubkey>" ], + [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] + ] +} +``` + +`.content`: an optional explanation detailing why this merge is being requested. +`a` tag: tag of the article which should be modified (i.e. the target of this merge request). +`e` tag: optional version of the article in which this modifications is based +`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP. + +The destination-pubkey (the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-` diff --git a/55.md b/55.md new file mode 100644 index 00000000..4565e8c3 --- /dev/null +++ b/55.md @@ -0,0 +1,538 @@ +# NIP-55 + +## Android Signer Application + +`draft` `optional` + +This NIP describes a method for 2-way communication between an Android signer and any Nostr client on Android. The Android signer is an Android Application and the client can be a web client or an Android application. + +# Usage for Android applications + +The Android signer uses Intents and Content Resolvers to communicate between applications. + +To be able to use the Android signer in your application you should add this to your AndroidManifest.xml: + +```xml +<queries> + <intent> + <action android:name="android.intent.action.VIEW" /> + <category android:name="android.intent.category.BROWSABLE" /> + <data android:scheme="nostrsigner" /> + </intent> +</queries> +``` + +Then you can use this function to check if there's a signer application installed: + +```kotlin +fun isExternalSignerInstalled(context: Context): Boolean { + val intent = + Intent().apply { + action = Intent.ACTION_VIEW + data = Uri.parse("nostrsigner:") + } + val infos = context.packageManager.queryIntentActivities(intent, 0) + return infos.size > 0 +} +``` + +## Using Intents + +To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. + +```kotlin +val launcher = rememberLauncherForActivityResult( + contract = ActivityResultContracts.StartActivityForResult(), + onResult = { result -> + if (result.resultCode != Activity.RESULT_OK) { + Toast.makeText( + context, + "Sign request rejected", + Toast.LENGTH_SHORT + ).show() + } else { + val signature = activityResult.data?.getStringExtra("signature") + // Do something with signature ... + } + } +) +``` + +Create the Intent using the **nostrsigner** scheme: + +```kotlin +val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content")) +``` + +Set the Signer package name: + +```kotlin +intent.`package` = "com.example.signer" +``` + +Send the Intent: + +```kotlin +launcher.launch(intent) +``` + +### Methods + +- **get_public_key** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "get_public_key") + // You can send some default permissions for the user to authorize for ever + val permissions = listOf( + Permission( + type = "sign_event", + kind = 22242 + ), + Permission( + type = "nip44_decrypt" + ) + ) + intent.putExtra("permissions", permissions.toJson()) + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **npub** in the signature field + + ```kotlin + val npub = intent.data?.getStringExtra("signature") + // The package name of the signer application + val packageName = intent.data?.getStringExtra("package") + ``` + +- **sign_event** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "sign_event") + // To handle results when not waiting between intents + intent.putExtra("id", event.id) + // Send the current logged in user npub + intent.putExtra("current_user", npub) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature**, **id** and **event** fields + + ```kotlin + val signature = intent.data?.getStringExtra("signature") + // The id you sent + val id = intent.data?.getStringExtra("id") + val signedEventJson = intent.data?.getStringExtra("event") + ``` + +- **nip04_encrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_encrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for encrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val encryptedText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip44_encrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip44_encrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for encrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val encryptedText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip04_decrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_decrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for decrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val plainText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip44_decrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_decrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for decrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val plainText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **decrypt_zap_event** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "decrypt_zap_event") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val eventJson = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +## Using Content Resolver + +To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. + +If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null + +For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json + +For the other types Signer Application returns the column "signature" + +If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application + +### Methods + +- **get_public_key** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"), + listOf("login"), + null, + null, + null + ) + ``` + - result: + - Will return the **npub** in the signature column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + if (index < 0) return + val npub = it.getString(index) + } + ``` + +- **sign_event** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.SIGN_EVENT"), + listOf("$eventJson", "", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** and the **event** columns + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val indexJson = it.getColumnIndex("event") + val signature = it.getString(index) + val eventJson = it.getString(indexJson) + } + ``` + +- **nip04_encrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **nip44_encrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **nip04_decrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP04_DECRYPT"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **nip44_decrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP44_DECRYPT"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **decrypt_zap_event** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), + listOf("$eventJson", "", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val eventJson = it.getString(index) + } + ``` + +# Usage for Web Applications + +Since web applications can't receive a result from the intent, you should add a modal to paste the signature or the event json or create a callback url. + +If you send the callback url parameter, Signer Application will send the result to the url. + +If you don't send a callback url, Signer Application will copy the result to the clipboard. + +You can configure the `returnType` to be **signature** or **event**. + +Android intents and browser urls have limitations, so if you are using the `returnType` of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base64 gzip encoded event json + +## Methods + +- **get_public_key** + - params: + + ```js + window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_public_key&callbackUrl=https://example.com/?event=`; + ``` + +- **sign_event** + - params: + + ```js + window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; + ``` + +- **nip04_encrypt** + - params: + + ```js + window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **nip44_encrypt** + - params: + + ```js + window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **nip04_decrypt** + - params: + + ```js + window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **nip44_decrypt** + - params: + + ```js + window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **decrypt_zap_event** + - params: + + ```js + window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`; + ``` + +## Example + +```js +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <title>Document</title> +</head> +<body> + <h1>Test</h1> + + <script> + window.onload = function() { + var url = new URL(window.location.href); + var params = url.searchParams; + if (params) { + var param1 = params.get("event"); + if (param1) alert(param1) + } + let json = { + kind: 1, + content: "test" + } + let encodedJson = encodeURIComponent(JSON.stringify(json)) + var newAnchor = document.createElement("a"); + newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; + newAnchor.textContent = "Open External Signer"; + document.body.appendChild(newAnchor) + } + </script> +</body> +</html> +``` diff --git a/56.md b/56.md index 3209b80d..fc8d8985 100644 --- a/56.md +++ b/56.md @@ -26,6 +26,7 @@ A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag being reported, which consists of the following report types: - `nudity` - depictions of nudity, porn, etc. +- `malware` - virus, trojan horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc. - `profanity` - profanity, hateful speech, etc. - `illegal` - something which may be illegal in some jurisdiction - `spam` - spam diff --git a/57.md b/57.md index 6d896206..d04eeff1 100644 --- a/57.md +++ b/57.md @@ -131,7 +131,7 @@ The following should be true of the `zap receipt` event: - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). - 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. +- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. - `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. diff --git a/59.md b/59.md index 7eff2b82..4dc857f6 100644 --- a/59.md +++ b/59.md @@ -155,7 +155,7 @@ Sign the `gift wrap` using the random key generated in the previous step. "created_at": 1703021488, "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c", "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac", - "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259" + "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259", "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]], } ``` diff --git a/64.md b/64.md new file mode 100644 index 00000000..6d8d3736 --- /dev/null +++ b/64.md @@ -0,0 +1,146 @@ +NIP-64 +====== + +Chess (Portable Game Notation) +----- + +`draft` `optional` + +This NIP defines `kind:64` notes representing chess games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software. + +## Note + +### Content + +The `.content` of these notes is a string representing a [PGN-database][pgn_formal_syntax]. + +### Notes + +```json +{ + "kind": 64, + "content": "1. e4 *", + ... +} +``` + +```json +{ + "kind": 64, + "tags": [ + ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], + ... + ], + "content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2" + ... +} +``` + +## Client Behavior + +Clients SHOULD display the content represented as chessboard. + +Clients SHOULD publish PGN notes in ["export format"][pgn_export_format] ("strict mode", i.e. created by machines) but expect incoming notes to be in ["import format"][pgn_import_format] ("lax mode", i.e. created by humans). + +Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. + +Clients MAY include additional tags (e.g. like [`"alt"`](https://github.com/nostr-protocol/nips/blob/master/31.md)) in order to represent the note to users of non-supporting clients. + +## Relay Behavior + +Relays MAY validate PGN contents and reject invalid notes. + + +## Examples + +```pgn +// A game where nothing is known. Game still in progress, game abandoned, or result otherwise unknown. +// Maybe players died before a move has been made. +* +``` + +```pgn +1. e4 * +``` + +```pgn +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} * +``` + +```pgn +[Event "F/S Return Match"] +[Site "Belgrade, Serbia JUG"] +[Date "1992.11.04"] +[Round "29"] +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] +[Result "1/2-1/2"] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6 +4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 +11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 +Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 +23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 +hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 +35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 +Nf2 42. g4 Bd3 43. Re6 1/2-1/2 +``` + +```pgn +[Event "Hourly HyperBullet Arena"] +[Site "https://lichess.org/wxx4GldJ"] +[Date "2017.04.01"] +[White "T_LUKE"] +[Black "decidement"] +[Result "1-0"] +[UTCDate "2017.04.01"] +[UTCTime "11:56:14"] +[WhiteElo "2047"] +[BlackElo "1984"] +[WhiteRatingDiff "+10"] +[BlackRatingDiff "-7"] +[Variant "Standard"] +[TimeControl "30+0"] +[ECO "B00"] +[Termination "Abandoned"] + +1. e4 1-0 + + +[Event "Hourly HyperBullet Arena"] +[Site "https://lichess.org/rospUdSk"] +[Date "2017.04.01"] +[White "Bastel"] +[Black "oslochess"] +[Result "1-0"] +[UTCDate "2017.04.01"] +[UTCTime "11:55:56"] +[WhiteElo "2212"] +[BlackElo "2000"] +[WhiteRatingDiff "+6"] +[BlackRatingDiff "-4"] +[Variant "Standard"] +[TimeControl "30+0"] +[ECO "A01"] +[Termination "Normal"] + +1. b3 d5 2. Bb2 c6 3. Nc3 Bf5 4. d4 Nf6 5. e3 Nbd7 6. f4 Bg6 7. Nf3 Bh5 8. Bd3 e6 9. O-O Be7 10. Qe1 O-O 11. Ne5 Bg6 12. Nxg6 hxg6 13. e4 dxe4 14. Nxe4 Nxe4 15. Bxe4 Nf6 16. c4 Bd6 17. Bc2 Qc7 18. f5 Be7 19. fxe6 fxe6 20. Qxe6+ Kh8 21. Qh3+ Kg8 22. Bxg6 Qd7 23. Qe3 Bd6 24. Bf5 Qe7 25. Be6+ Kh8 26. Qh3+ Nh7 27. Bf5 Rf6 28. Qxh7# 1-0 +``` + +## Resources +- [PGN Specification][pgn_specification]: PGN (Portable Game Notation) specification +- [PGN Specification Supplement](https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-spec-supplement.md): Addition for adding graphical elements, clock values, eval, ... +- [PGN Formal Syntax][pgn_formal_syntax] +- [PGN Seven Tag Roster][pgn_seven_tag_roster] +- [PGN Import Format][pgn_import_format] +- [PGN Export Format][pgn_export_format] +- [lichess / pgn-viewer (GitHub)](https://github.com/lichess-org/pgn-viewer): PGN viewer widget, designed to be embedded in content pages + +[pgn_specification]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md +[pgn_formal_syntax]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#18-formal-syntax +[pgn_seven_tag_roster]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#811-seven-tag-roster +[pgn_import_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#31-import-format-allows-for-manually-prepared-data +[pgn_export_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#32-export-format-used-for-program-generated-output diff --git a/65.md b/65.md index 8adae39a..2a1fc8da 100644 --- a/65.md +++ b/65.md @@ -36,8 +36,13 @@ NIP-65 イベントを送信する際は、クライアントは以下のようにすべきである (SHOULD) 。 +<<<<<<< HEAD - イベント発行者の書き込み(WRITE)リレーにイベントを送信する - イベントにタグ付けされた各ユーザの読み出し(READ)リレーにイベントを送信する +======= +- Broadcast the event to the WRITE relays of the author +- Broadcast the event to all READ relays of each tagged user +>>>>>>> upstream/master ## 動機 diff --git a/70.md b/70.md new file mode 100644 index 00000000..043d5fbf --- /dev/null +++ b/70.md @@ -0,0 +1,45 @@ +NIP-70 +====== + +Protected Events +---------------- + +`draft` `optional` + +When the `"-"` tag is present, that means the event is "protected". + +A protected event is an event that can only be published to relays by its author. This is achieved by relays ensuring that the author is [authenticated](42.md) before publishing their own events or by just rejecting events with `["-"]` outright. + +The default behavior of a relay MUST be to reject any event that contains `["-"]`. + +Relays that want to accept such events MUST first require that the client perform the [NIP-42](42.md) `AUTH` flow and then check if the authenticated client has the same pubkey as the event being published and only accept the event in that case. + +## The tag + +The tag is a simple tag with a single item: `["-"]`. It may be added to any event. + +## Example flow + +- User `79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798` connects to relay `wss://example.com`: + +```jsonc +/* client: */ +["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] +/* relay: */ +["AUTH", "<challenge>"] +["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", false, "auth-required: this event may only be published by its author"] +/* client: */ +["AUTH", {}] +["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] +["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", true, ""] +``` + +## Why + +There are multiple circumstances in which it would be beneficial to prevent the unlimited spreading of an event through all relays imaginable and restrict some to only a certain demographic or to a semi-closed community relay. Even when the information is public it may make sense to keep it compartimentalized across different relays. + +It's also possible to create closed access feeds with this when the publisher has some relationship with the relay and trusts the relay to not release their published events to anyone. + +Even though it's ultimately impossible to restrict the spread of information on the internet (for example, one of the members of the closed group may want to take an event intended to be restricted and republish it to other relays), most relays would be happy to not facilitate the acts of these so-called "pirates", in respect to the original decision of the author and therefore gladly reject these republish acts if given the means to. + +This NIP gives these authors and relays the means to clearly signal when a given event is not intended to be republished by third parties. diff --git a/71.md b/71.md new file mode 100644 index 00000000..2743b2b1 --- /dev/null +++ b/71.md @@ -0,0 +1,118 @@ +NIP-71 +====== + +Video Events +--------------- + +`draft` `optional` + +This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and delete requestable per [NIP-09](09.md). + +Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience. + +## Video Events + +There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc). + +#### Format + +The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. + +The `.content` of these events is a summary or description on the video content. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. +* `url` (required) the url to the video 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. +* `title` (required) title of the video +* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published +* `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 `<width>x<height>` +* `duration` (optional) video duration in seconds +* `magnet` (optional) URI to magnet file +* `i` (optional) torrent infohash +* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code +* `thumb` (optional) url of thumbnail with same aspect ratio +* `image` (optional) url of preview image with same dimensions +* `content-warning` (optional) warning about content of NSFW video +* `alt` (optional) description for accessibility +* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url +* `t` (optional, repeated) hashtag to categorize video +* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL +* `r` (optional, repeated) references / links to web pages + +```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": <Unix timestamp in seconds>, + "kind": 34235 | 34236, + "content": "<summary / description of video>", + "tags": [ + ["d", "<UUID>"], + + ["title", "<title of video>"], + ["thumb", "<thumbnail image for video>"], + ["published_at", "<unix timestamp>"], + ["alt", <description>], + + // Video Data + ["url",<string with URI of file>], + ["m", <MIME type>], + ["x",<Hash SHA-256>], + ["size", <size of file in bytes>], + ["duration", <duration of video in seconds>], + ["dim", <size of file in pixels>], + ["magnet",<magnet URI> ], + ["i",<torrent infohash>], + ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], + ["content-warning", "<reason>"], + ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // Hashtags + ["t", "<tag>"], + ["t", "<tag>"], + + // Reference links + ["r", "<url>"], + ["r", "<url>"] + ] +} +``` + +## Video View + +A video event view is a response to a video event to track a user's view or progress viewing the video. + +### Format + +The format uses a parameterized replaceable event kind `34237`. + +The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. + +The list of tags are as follows: +* `a` (required) reference tag to kind `34235` or `34236` video event being viewed +* `d` (required) same as `a` reference tag value +* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds + + +```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": <Unix timestamp in seconds>, + "kind": 34237, + "content": "<note>", + "tags": [ + ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], + ["e", "<event-id", "<relay-url>"] + ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"], + ["viewed", <start>, <end>], + ] +} +``` diff --git a/72.md b/72.md index 4bafce06..b2f523b4 100644 --- a/72.md +++ b/72.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` -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. +The goal of this NIP is to enable public communities. 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 may issue an approval event `kind:4550`. # 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. A community definition event's `d` tag MAY double as its name, but if a `name` tag is provided, it SHOULD be displayed instead of the `d` tag. ```jsonc { @@ -18,6 +18,7 @@ The goal of this NIP is to create moderator-approved public communities around a "kind": 34550, "tags": [ ["d", "<community-d-identifier>"], + ["name", "<Community name>"], ["description", "<Community description>"], ["image", "<Community image url>", "<Width>x<Height>"], @@ -38,9 +39,9 @@ The goal of this NIP is to create moderator-approved public communities around a } ``` -# New Post Request +# Posting to a community -Any Nostr event can be submitted to a community by anyone for approval. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. +Any Nostr event can be posted to a community. Clients MUST add one or more community `a` tags, each with a recommended relay. ```jsonc { @@ -53,11 +54,15 @@ Any Nostr event can be submitted to a community by anyone for approval. Clients } ``` -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)). +# Moderation -# Post Approval by moderators +Anyone may issue an approval event to express their opinion that a post is appropriate for a community. Clients MAY choose which approval events to honor, but SHOULD at least use ones published by the group's defined 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 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. +An approval event MUST include one or more community `a` tags, an `e` or `a` tag pointing to the post, and the `p` tag of the author of the post (for approval notifications). `a` tag prefixes can be used to disambiguate between community and replaceable event pointers (community `a` tags always begin with `34550`). + +The event SHOULD also include the JSON-stringified `post request` event inside the `.content`, and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. + +Moderators MAY request deletion of their approval of a post at any time using [NIP-09 event deletion requests](09.md). ```jsonc { @@ -76,26 +81,16 @@ 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 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. +Approvals of replaceable events can be created in three ways: -Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. +1. By tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the replaceable event +2. By tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and +3. 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. -# Displaying +Since relays are instructed to delete old versions of a replaceable event, the `content` of an approval using an `e` tag MUST have the specific version of the event or clients might not be able to find that version of the content anywhere. -Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be approved for all `34550:*` `a` tags. -The following filter displays the approved posts. - -```json -[ - "REQ", - "_", - { - "authors": ["<owner-pubkey>", "<moderator1-pubkey>", "<moderator2-pubkey>", "<moderator3-pubkey>", ...], - "kinds": [4550], - "#a": ["34550:<Community event author pubkey>:<d-identifier of the community>"], - } -] -``` +# Cross-posting -Clients MAY hide approvals by blocked moderators at the user's request. +Clients MAY support cross-posting between communities by posting a NIP 18 `kind 6` or `kind 16` repost to one or more communities using `a` tags as described above. The `content` of the repost MUST be the original event, not the approval event. diff --git a/73.md b/73.md new file mode 100644 index 00000000..12228d36 --- /dev/null +++ b/73.md @@ -0,0 +1,48 @@ +NIP-73 +====== + +External Content IDs +------------------------- + +`draft` `optional` + +There are certain established global content identifiers that would be useful to reference in nostr events so that clients can query all events assosiated with these ids. + +- Book [ISBNs](https://en.wikipedia.org/wiki/ISBN) +- Podcast [GUIDs](https://podcastnamespace.org/tag/guid) +- Movie [ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) + +Since the `i` tag is already used for similar references in kind-0 metadata events it makes sense to use it for these content ids as well. + + +## Supported IDs + +### Books: + +- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 + +Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs return the ISBNs without hyphens. Removing hypens from ISBNs is trivial, whereas adding the hyphens back in is non-trivial requiring a library. + +### Podcasts: + +- Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc +- Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]` +- Podcast RSS Publisher GUID: `["i", "podcast:publisher:guid:18bcbf10-6701-4ffb-b255-bc057390d738"]` + +### Movies: + +- Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 + +Movie ISANs SHOULD be referenced _**without the version part**_ as the versions / edits of movies are not relevant. More info on ISAN parts here - https://support.isan.org/hc/en-us/articles/360002783131-Records-relations-and-hierarchies-in-the-ISAN-Registry + +--- + +### Optional URL Hints + +Each `i` tag MAY have a url hint as the second argument to redirect people to a website if the client isn't opinionated about how to interpret the id: + +`["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg]` + +`["i", "isan:0000-0000-401A-0000-7", https://www.imdb.com/title/tt0120737]` + + diff --git a/89.md b/89.md index 43d197fc..54aa30bc 100644 --- a/89.md +++ b/89.md @@ -116,7 +116,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e 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`: ```json -["REQ", <id>, '[{ "kinds": [31989], "#d": ["31337"], 'authors': [<user>, <users-contact-list>] }]'] +["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] ``` User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. @@ -127,5 +127,5 @@ User B's client sees the application's `kind:31990` which includes the informati Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. ```json -["REQ", <id>, '[{ "kinds": [31990], "#k": [<desired-event-kind>], 'authors': [...] }]'] +["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] ``` diff --git a/90.md b/90.md index 241eb38f..5a15ebb6 100644 --- a/90.md +++ b/90.md @@ -162,8 +162,8 @@ 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) -* `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. +* `amount` tag: as defined in the [Job Result](#job-result-kind6000-6999) section. +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Job Feedback Status](#job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. * NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key. @@ -177,7 +177,7 @@ Service providers can give feedback about a job back to the customer. | `success` | Service Provider successfully processed 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. +Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result-kind6000-6999) section. This is useful for service providers to provide a sample of the results that have been processed so far. # Protocol Flow @@ -199,7 +199,7 @@ Some service providers might choose to submit a `payment-required` as the first 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. +A job request might be canceled 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. diff --git a/96.md b/96.md index f7d901fd..be709991 100644 --- a/96.md +++ b/96.md @@ -1,8 +1,6 @@ -NIP-96 -====== +# NIP-96 -HTTP File Storage Integration ------------------------------ +## HTTP File Storage Integration `draft` `optional` @@ -84,46 +82,46 @@ it must use the "api_url" field instead. See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. +## Auth + +When indicated, `clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). + ## Upload -A file can be uploaded one at a time to `https://your-file-server.example/custom-api-path` (route from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) as `multipart/form-data` content type using `POST` method with the file object set to the `file` form data field. +`POST $api_url` as `multipart/form-data`. -`Clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). -If using an html form, use an `Authorization` form data field instead. +**AUTH required** -These following **optional** form data fields MAY be used by `servers` and SHOULD be sent by `clients`: -- `expiration`: string of the UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this; -- `size`: string of the file byte size. This is just a value the server can use to reject early if the file size exceeds the server limits; -- `alt`: (recommended) strict description text for visibility-impaired users; -- `caption`: loose description; -- `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment; -- `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. +List of form fields: +- `file`: **REQUIRED** the file to upload +- `caption`: **RECOMMENDED** loose description; +- `expiration`: UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this. +- `size`: File byte size. This is just a value the server can use to reject early if the file size exceeds the server limits. +- `alt`: **RECOMMENDED** strict description text for visibility-impaired users. +- `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment. +- `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. +- `no_transform`: "true" asks server not to transform the file and serve the uploaded file as is, may be rejected. Others custom form data fields may be used depending on specific `server` support. The `server` isn't required to store any metadata sent by `clients`. -Note for `clients`: if using an HTML form, it is important for the `file` form field to be the **last** one, or be re-ordered right before sending or be appended as the last field of XHR2's FormData object. - The `filename` embedded in the file may not be honored by the `server`, which could internally store just the SHA-256 hash value as the file name, ignoring extra metadata. -The hash is enough to uniquely identify a file, that's why it will be used on the "download" and "delete" routes. - -The `server` MUST link the user's `pubkey` string (which is embedded in the decoded header value) as the owner of the file so to later allow them to delete the file. -Note that if a file with the same hash of a previously received file (so the same file) is uploaded by another user, the server doesn't need to store the new file. -It should just add the new user's `pubkey` to the list of the owners of the already stored file with said hash (if it wants to save space by keeping just one copy of the same file, because multiple uploads of the same file results in the same file hash). - -The `server` MAY also store the `Authorization` header/field value (decoded or not) for accountability purpose as this proves that the user with the unique pubkey did ask for the upload of the file with a specific hash. However, storing the pubkey is sufficient to establish ownership. +The hash is enough to uniquely identify a file, that's why it will be used on the `download` and `delete` routes. -The `server` MUST reject with 413 Payload Too Large if file size exceeds limits. +The `server` MUST link the user's `pubkey` string as the owner of the file so to later allow them to delete the file. -The `server` MUST reject with 400 Bad Request status if some fields are invalid. +`no_transform` can be used to replicate a file to multiple servers for redundancy, clients can use the [server list](#selecting-a-server) to find alternative servers which might contain the same file. When uploading a file and requesting `no_transform` clients should check that the hash matches in the response in order to detect if the file was modified. -The `server` MUST reply to the upload with 200 OK status if the `payload` tag value contains an already used SHA-256 hash (if file is already owned by the same pubkey) or reject the upload with 403 Forbidden status if it isn't the same of the received file. +### Response codes -The `server` MAY reject the upload with 402 Payment Required status if the user has a pending payment (Payment flow is not strictly required. Server owners decide if the storage is free or not. Monetization schemes may be added later to correlated NIPs.). - -On successful uploads the `server` MUST reply with **201 Created** HTTP status code or **202 Accepted** if a `processing_url` field is added -to the response so that the `client` can follow the processing status (see [Delayed Processing](#delayed-processing) section). +- `200 OK`: File upload exists, but is successful (Existing hash) +- `201 Created`: File upload successful (New hash) +- `202 Accepted`: File upload is awaiting processing, see [Delayed Processing](#delayed-processing) section +- `413 Payload Too Large`: File size exceeds limit +- `400 Bad Request`: Form data is invalid or not supported. +- `403 Forbidden`: User is not allowed to upload or the uploaded file hash didnt match the hash included in the `Authorization` header `payload` tag. +- `402 Payment Required`: Payment is required by the server, **this flow is undefined**. The upload response is a json object as follows: @@ -179,11 +177,13 @@ The upload response is a json object as follows: Note that if the server didn't apply any transformation to the received file, both `nip94_event.tags.*.ox` and `nip94_event.tags.*.x` fields will have the same value. The server MUST link the saved file to the SHA-256 hash of the **original** file before any server transformations (the `nip94_event.tags.*.ox` tag value). The **original** file's SHA-256 hash will be used to identify the saved file when downloading or deleting it. -`Clients` may upload the same file to one or many `servers`. +`clients` may upload the same file to one or many `servers`. After successful upload, the `client` may optionally generate and send to any set of nostr `relays` a [NIP-94](94.md) event by including the missing fields. Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url. +`clients` may also use the tags from the `nip94_event` to construct an `imeta` tag + ### Delayed Processing Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing. @@ -219,7 +219,7 @@ However, for all file actions, such as download and deletion, the **original** f ## Download -`Servers` must make available the route `https://your-file-server.example/custom-api-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" or "download_url" field) with `GET` method for file download. +`GET $api_url/<sha256-hash>(.ext)` The primary file download url informed at the upload's response field `nip94_event.tags.*.url` can be that or not (it can be any non-standard url the server wants). @@ -227,17 +227,17 @@ If not, the server still MUST also respond to downloads at the standard url mentioned on the previous paragraph, to make it possible for a client to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash. -Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. +Note that the "\<sha256-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path. When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension). The file extension may be absent because the hash is the only needed string to uniquely identify a file. -Example: `https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` +Example: `$api_url/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` ### Media Transformations -`Servers` may respond to some media transformation query parameters and ignore those they don't support by serving +`servers` may respond to some media transformation query parameters and ignore those they don't support by serving the original media file without transformations. #### Image Transformations @@ -245,23 +245,23 @@ the original media file without transformations. ##### Resizing Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio. -`Clients` may use the `w` query parameter to request an image version with the desired pixel width. -`Servers` can then serve the variant with the closest width to the parameter value +`clients` may use the `w` query parameter to request an image version with the desired pixel width. +`servers` can then serve the variant with the closest width to the parameter value or an image variant generated on the fly. -Example: `https://your-file-server.example/custom-api-path/<sha256-file-hash>.png?w=32` +Example: `$api_url/<sha256-hash>.png?w=32` ## Deletion -`Servers` must make available the route `https://deletion.domain/deletion-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) with `DELETE` method for file deletion. +`DELETE $api_url/<sha256-hash>(.ext)` -Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. +**AUTH required** -The extension is optional as the file hash is the only needed file identification. +Note that the `/<sha256-hash>` part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. -`Clients` should send a `DELETE` request to the server deletion route in the above format. It must include a NIP-98 `Authorization` header. +The extension is optional as the file hash is the only needed file identification. -The `server` should reject deletes from users other than the original uploader. The `pubkey` encoded on the header value identifies the user. +The `server` should reject deletes from users other than the original uploader with the appropriate http response code (403 Forbidden). It should be noted that more than one user may have uploaded the same file (with the same hash). In this case, a delete must not really delete the file but just remove the user's `pubkey` from the file owners list (considering the server keeps just one copy of the same file, because multiple uploads of the same file results in the same file hash). @@ -275,6 +275,46 @@ The successful response is a 200 OK one with just basic JSON fields: } ``` +## Listing files + +`GET $api_url?page=x&count=y` + +**AUTH required** + +Returns a list of files linked to the authenticated users pubkey. + +Example Response: + +```js +{ + "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) + "total": 1, // total number of files + "page": 0, // the current page number + "files": [ + { + "tags": [ + ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], + ["size", "123456"], + ["alt", "a meme that makes you laugh"], + ["expiration", "1715691139"], + // ...other metadata + ] + "content": "haha funny meme", // caption + "created_at": 1715691130 // upload timestamp + }, + ... + ] +} +``` + +`files` contains an array of NIP-94 events + +### Query args + +- `page` page number (`offset=page*count`) +- `count` number of items per page + ## Selecting a Server Note: HTTP File Storage Server developers may skip this section. This is meant for client developers. diff --git a/98.md b/98.md index ca523042..be425b28 100644 --- a/98.md +++ b/98.md @@ -55,7 +55,8 @@ Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` e Example HTTP Authorization header: ``` -Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1cmwiLCJodHRwczovL2FwaS5zbm9ydC5zb2NpYWwvYXBpL3YxL241c3AvbGlzdCJdLFsibWV0aG9kIiwiR0VUIl1dLCJzaWciOiI1ZWQ5ZDhlYzk1OGJjODU0Zjk5N2JkYzI0YWMzMzdkMDA1YWYzNzIzMjQ3NDdlZmU0YTAwZTI0ZjRjMzA0MzdmZjRkZDgzMDg2ODRiZWQ0NjdkOWQ2YmUzZTVhNTE3YmI0M2IxNzMyY2M3ZDMzOTQ5YTNhYWY4NjcwNWMyMjE4NCJ9 +Authorization: Nostr +eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1IiwiaHR0cHM6Ly9hcGkuc25vcnQuc29jaWFsL2FwaS92MS9uNXNwL2xpc3QiXSxbIm1ldGhvZCIsIkdFVCJdXSwic2lnIjoiNWVkOWQ4ZWM5NThiYzg1NGY5OTdiZGMyNGFjMzM3ZDAwNWFmMzcyMzI0NzQ3ZWZlNGEwMGUyNGY0YzMwNDM3ZmY0ZGQ4MzA4Njg0YmVkNDY3ZDlkNmJlM2U1YTUxN2JiNDNiMTczMmNjN2QzMzk0OWEzYWFmODY3MDVjMjIxODQifQ ``` ## Reference Implementations diff --git a/99.md b/99.md index 93550d87..89482871 100644 --- a/99.md +++ b/99.md @@ -8,9 +8,9 @@ Classified Listings 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 category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](15.md) that often sell many units of specific products through very specific channels. -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. +The structure of these events is very similar to [NIP-23](23.md) long-form content events. ### Draft / Inactive Listings @@ -26,8 +26,8 @@ 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. +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](12.md). +- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. diff --git a/BREAKING.md b/BREAKING.md index 80248142..cac35454 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,8 +5,17 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [NIP-45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted | +| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated | +| 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated | +| 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [NIP-01](01.md) | events should be sorted by id after created_at | +| 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [NIP-25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | +| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | +| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | +| 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [NIP-25](25.md) | e-tags were changed to not include entire thread | +| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [NIP-34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | -| 2024-02-10 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | +| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | | 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | @@ -18,8 +27,9 @@ reverse chronological order. | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [NIP-01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | | 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | | 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed | +| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [NIP-32](32.md) | 'l' tag annotations was removed | | 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items | | 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed | | 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` | @@ -32,10 +42,10 @@ reverse chronological order. | 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" | | 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed | -| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | +| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | | 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported | | 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | -| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | +| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | | 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | @@ -45,3 +55,4 @@ Breaking changes prior to 2023-03-01 are not yet documented. - If it isn't clear that a change is breaking or not, we list it. - The date is the date it was merged, not necessarily the date of the commit. + diff --git a/README.md b/README.md index eb50d661..cf80e3df 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 ## 仕様一覧 +<<<<<<< HEAD - [NIP-01: 基本的なプロトコルフローの説明](01.md) - [NIP-02: フォローリスト](02.md) - [NIP-03: イベントに対するOpenTimestamps認証](03.md) @@ -33,9 +34,23 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 - [NIP-09: イベント(の)削除](09.md) - [NIP-10: テキストイベントにおいて`e`タグおよび`p`タグを使用する際の規約](10.md) - [NIP-11: リレー情報ドキュメント](11.md) +======= +- [NIP-01: Basic protocol flow description](01.md) +- [NIP-02: Follow List](02.md) +- [NIP-03: OpenTimestamps Attestations for Events](03.md) +- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md) +- [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-09: Event Deletion Request](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) +>>>>>>> upstream/master - [NIP-13: Proof of Work](13.md) - [NIP-14: テキストイベントにおける件名タグ](14.md) - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) +<<<<<<< HEAD - [NIP-18: リポスト](18.md) - [NIP-19: bech32でエンコードされた情報](19.md) - [NIP-21: `nostr:` URIスキーム](21.md) @@ -66,11 +81,55 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 - [NIP-52: カレンダーイベント](52.md) - [NIP-53: ライブアクティビティ](53.md) - [NIP-56: 通報](56.md) +======= +- [NIP-17: Private Direct Messages](17.md) +- [NIP-18: Reposts](18.md) +- [NIP-19: bech32-encoded entities](19.md) +- [NIP-21: `nostr:` URI scheme](21.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) +- [NIP-28: Public Chat](28.md) +- [NIP-29: Relay-based Groups](29.md) +- [NIP-30: Custom Emoji](30.md) +- [NIP-31: Dealing with Unknown Events](31.md) +- [NIP-32: Labeling](32.md) +- [NIP-34: `git` stuff](34.md) +- [NIP-35: Torrents](35.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) +- [NIP-44: Versioned Encryption](44.md) +- [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-49: Private Key Encryption](49.md) +- [NIP-50: Search Capability](50.md) +- [NIP-51: Lists](51.md) +- [NIP-52: Calendar Events](52.md) +- [NIP-53: Live Activities](53.md) +- [NIP-54: Wiki](54.md) +- [NIP-55: Android Signer Application](55.md) +- [NIP-56: Reporting](56.md) +>>>>>>> upstream/master - [NIP-57: Lightning Zaps](57.md) - [NIP-58: バッジ](58.md) - [NIP-59: Gift Wrap](59.md) +<<<<<<< HEAD - [NIP-65: リレーリストメタデータ](65.md) +======= +- [NIP-64: Chess (PGN)](64.md) +- [NIP-65: Relay List Metadata](65.md) +- [NIP-70: Protected Events](70.md) +- [NIP-71: Video Events](71.md) +>>>>>>> upstream/master - [NIP-72: Moderated Communities](72.md) +- [NIP-73: External Content IDs](73.md) - [NIP-75: Zap Goals](75.md) - [NIP-78: アプリケーション固有データ](78.md) - [NIP-84: ハイライト](84.md) @@ -83,6 +142,7 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 - [NIP-99: Classified Listings](99.md) ## Event Kinds +<<<<<<< HEAD | kind | description | NIP | | ------------- | -------------------------- | ------------------------ | | `0` | メタデータ | [01](01.md) | @@ -175,9 +235,123 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 | `31990` | ハンドラ情報 | [89](89.md) | | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | - +======= +>>>>>>> upstream/master + +| kind | description | NIP | +| ------------- | ------------------------------- | -------------------------------------- | +| `0` | User Metadata | [01](01.md) | +| `1` | Short Text Note | [01](01.md) | +| `2` | Recommend Relay | 01 (deprecated) | +| `3` | Follows | [02](02.md) | +| `4` | Encrypted Direct Messages | [04](04.md) | +| `5` | Event Deletion Request | [09](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `9` | Group Chat Message | [29](29.md) | +| `10` | Group Chat Threaded Reply | [29](29.md) | +| `11` | Group Thread | [29](29.md) | +| `12` | Group Thread Reply | [29](29.md) | +| `13` | Seal | [59](59.md) | +| `14` | Direct Message | [17](17.md) | +| `16` | Generic Repost | [18](18.md) | +| `17` | Reaction to a website | [25](25.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) | +| `64` | Chess (PGN) | [64](64.md) | +| `818` | Merge Requests | [54](54.md) | +| `1021` | Bid | [15](15.md) | +| `1022` | Bid confirmation | [15](15.md) | +| `1040` | OpenTimestamps | [03](03.md) | +| `1059` | Gift Wrap | [59](59.md) | +| `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1617` | Patches | [34](34.md) | +| `1621` | Issues | [34](34.md) | +| `1622` | Replies | [34](34.md) | +| `1630`-`1633` | Status | [34](34.md) | +| `1971` | Problem Tracker | [nostrocket][nostrocket] | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `2003` | Torrent | [35](35.md) | +| `2004` | Torrent Comment | [35](35.md) | +| `2022` | Coinjoin Pool | [joinstr][joinstr] | +| `4550` | Community Post Approval | [72](72.md) | +| `5000`-`5999` | Job Request | [90](90.md) | +| `6000`-`6999` | Job Result | [90](90.md) | +| `7000` | Job Feedback | [90](90.md) | +| `9000`-`9030` | Group Control Events | [29](29.md) | +| `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) | +| `10003` | Bookmark list | [51](51.md) | +| `10004` | Communities list | [51](51.md) | +| `10005` | Public chats list | [51](51.md) | +| `10006` | Blocked relays list | [51](51.md) | +| `10007` | Search relays list | [51](51.md) | +| `10009` | User groups | [51](51.md), [29](29.md) | +| `10015` | Interests list | [51](51.md) | +| `10030` | User emoji list | [51](51.md) | +| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | +| `10096` | File storage server list | [96](96.md) | +| `13194` | Wallet Info | [47](47.md) | +| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | +| `22242` | Client Authentication | [42](42.md) | +| `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` | Follow sets | [51](51.md) | +| `30001` | Generic lists | [51](51.md) | +| `30002` | Relay sets | [51](51.md) | +| `30003` | Bookmark sets | [51](51.md) | +| `30004` | Curation sets | [51](51.md) | +| `30005` | Video sets | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30015` | Interest sets | [51](51.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30019` | Marketplace UI/UX | [15](15.md) | +| `30020` | Product sold as an auction | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.md) | +| `30030` | Emoji sets | [51](51.md) | +| `30063` | Release artifact sets | [51](51.md) | +| `30078` | Application-specific Data | [78](78.md) | +| `30311` | Live Event | [53](53.md) | +| `30315` | User Statuses | [38](38.md) | +| `30402` | Classified Listing | [99](99.md) | +| `30403` | Draft Classified Listing | [99](99.md) | +| `30617` | Repository announcements | [34](34.md) | +| `30618` | Repository state announcements | [34](34.md) | +| `30818` | Wiki article | [54](54.md) | +| `30819` | Redirects | [54](54.md) | +| `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] | +| `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) | +| `34235` | Video Event | [71](71.md) | +| `34236` | Short-form Portrait Video Event | [71](71.md) | +| `34237` | Video View Event | [71](71.md) | +| `34550` | Community Definition | [72](72.md) | +| `39000-9` | Group metadata events | [29](29.md) | + +[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md +[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md ## メッセージ型 @@ -203,6 +377,7 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 | `AUTH` | 認証チャレンジの送信 | [42](42.md) | | `COUNT` | 要求されたイベントの計数結果 | [45](45.md) | +<<<<<<< HEAD 新しいイベント種別(kind)を含むNIPsを提案する場合は、これらのリストも更新すること。 ## 標準化済みタグ @@ -255,14 +430,78 @@ NIPsは、**Nostr Implementation Possibilities**の略称である。 | `title` | 記事のタイトル | -- | [23](23.md) | | `web` | webpage URL | -- | [34](34.md) | | `zap` | 公開鍵 (hex), リレー URL | weight | [57](57.md) | +======= +## Standardized Tags + +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [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) | +| `-` | -- | -- | [70](70.md) | +| `g` | geohash | -- | [52](52.md) | +| `h` | group id | -- | [29](29.md) | +| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | +| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | +| `l` | label, label namespace | -- | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `q` | event id (hex) | relay URL | [18](18.md) | +| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | +| `r` | relay url | marker | [65](65.md) | +| `t` | hashtag | -- | | +| `alt` | summary | -- | [31](31.md) | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `client` | name, address | relay URL | [89](89.md) | +| `clone` | git clone URL | -- | [34](34.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `encrypted` | -- | -- | [90](90.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), [52](52.md), [58](58.md) | +| `imeta` | inline metadata | -- | [92](92.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | +| `nonce` | random | difficulty | [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), [17](17.md) | +| `relays` | relay list | -- | [57](57.md) | +| `server` | file storage server url | -- | [96](96.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md) | +| `summary` | summary | -- | [23](23.md), [52](52.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `web` | webpage URL | -- | [34](34.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | + +Please update these lists when proposing new NIPs. +>>>>>>> upstream/master ## NIPsの受け入れ基準 +<<<<<<< HEAD 1. (適用可能であれば)少なくとも2つのクライアントと1つのリレーが実装しているべきである。 2. 理にかなっている必要がある。 3. 任意に実装可能であり、後方互換性を有するべきである: 実装しないことを選択したクライアントやリレーが、実装することを選択したクライアントやリレーと通信した際に動作を停止しないよう厳に注意しなければならない。 4. 同じことする方法が複数あってはならない。 5. その他のルールは必要に応じて作成する。 +======= +1. They should be fully implemented in at least two clients and one relay -- when applicable. +2. They should make sense. +3. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to. +4. There should be no more than one way of doing the same thing. +5. Other rules will be made up when necessary. +>>>>>>> upstream/master ## このリポジトリは中央集権的な要素ではありませんか？