From 67e950a2009e81df1b8c91b0a2ade0596e83f168 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 3 Jul 2023 14:21:13 +0200 Subject: [PATCH 001/192] wip --- vending-machine.md | 163 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 vending-machine.md diff --git a/vending-machine.md b/vending-machine.md new file mode 100644 index 00000000..273aa28f --- /dev/null +++ b/vending-machine.md @@ -0,0 +1,163 @@ +# NIP-XX: Data Vending Machine +Money in, data out. + +## Rationale +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization"), but where they don't necessarily care about "who" processes the data. + +This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. + +### Actors +There are two actors to the workflow described in this NIP: +* Customers (npubs who request a job) +* Service providers (npubs who fulfill jobs) + +## User flow +* User publishes a job request +`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` + +* Service providers listen for the type of jobs they can perform +`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` + +* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it +* Upon completion, the service provider publishes the result of the job with a `job-result` event. +* Upon acceptance, the user zaps the service provider, tagging the job request + +## Kinds + +This NIP introduces two new kinds: + +* `kind:68001`: Job request -- a request to have a job be processed +* `kind:68002`: Job result -- a proposal of the resulting job + +### Job request +A request to have data processed -- published by a user + +```json +{ + "kind": 68001, + "content": "", + "tags": [ + // The type data processing the user wants to be performed + // on the + [ "j", "", "" ], + [ "input", "", "", "" ], + [ "relays", "wss://..."], + + // stringified sat amount that the user is offering to pay + // for this request + // should this include an optional max price or is it too + // ambiguous? + [ "bid", "", [""] ], + + // max timestamp at which the job is no longer to be processed + [ "expiration", "" ] + + // p tags + [ "p", "service-provider-1" ], + [ "p", "service-provider-2" ], + + // NIP-33 d-tag + [ "d", ""] + ] +} +``` + +#### `content` field +An optional, human-readable description of what this job is for. + +#### `j` tag +Specifies the job to be executed. A job request MUST have exactly one `j` tag. + +A `j` tag MIGHT name a specific model to be used for the computed with. + +#### `input` tag +Specified the input that the job should be executed with. + +* ``: The argument for the input +* ``: The way this argument should be interpreted + * Possible values: + * `url`: a URL to be fetched + * `event`: a different event ID + * `job`: the output of a previous job +* ``: + +#### `relays` tag +A list of relays the service provider should publish its job result to. + +#### `p` tags (optional) +A user might want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. + +#### `expiration` (optional) +A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) + +### Job result +The output of processing the data -- published by the +```json +{ + "pubkey": "service-provider", + + // result + "content": "", + "tags" [ + // stringified JSON request event + [ "request", "<2xxx1-event>" ], + [ "e", ], + [ "p", "" ], + [ "status", "success", ""], + [ "payment", "requested-payment-amount" ] + ] +} +``` + +### `status` tag +The service provider might want to return an error to the user in case the job could not be processed correctly + +### `payment` + +## Job types + +This NIP defines some job types, clients SHOULD specify these types for maximum compatibility with service providers. Other job types might be added to this NIP. + +### `speech-to-text` +#### params +| param | req? | description +|--------------------------------|------|-------- +| `range` | opt | timestamp range (in seconds) of desired text to be transcribed + +### `summarization` +| param | req? | description +|--------------------------------|------|-------- +| `length` | opt | desired length + +### `translation` -- Translate text to a specific language +#### params +| param | req? | description +|--------------------------------|------|-------- +| `language` | req | desired language in BCP 47 format. + +## Job chaining +A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. + +Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. + +## Job feedback +> **Warning** +> Is this hijacking/modifying the meaning of NIP-25 reactions too much? + +A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. +The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result, either +in the form of + + +## Explicitly not addressed in this NIP + +### Reputation system +Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). + +It's out of scope (and undesirable) to have this NIP address this issue; the market should. + +## Notes + +### Multitple job acceptance +* Nothing prevents a user from accepting multiple job results. + From 71803c21a6bdd2413244a47752c129e3c64eaec6 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 3 Jul 2023 14:33:17 +0200 Subject: [PATCH 002/192] Add examples --- vending-machine.md | 84 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 82 insertions(+), 2 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 273aa28f..a94cd332 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -77,8 +77,8 @@ Specified the input that the job should be executed with. * ``: The way this argument should be interpreted * Possible values: * `url`: a URL to be fetched - * `event`: a different event ID - * `job`: the output of a previous job + * `event`: a nostr event ID + * `job`: the output of a previous job with the specified event ID * ``: #### `relays` tag @@ -161,3 +161,83 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar ### Multitple job acceptance * Nothing prevents a user from accepting multiple job results. +# Appendix 1: Examples + +## Customer wants to get a transcript of a podcast from second 900 to 930. + +### `kind:68001`: Job Request +```json +{ + "id": "12345", + "pubkey": "abcdef", + "content": "I need a transcript of Bitcoin.review", + "tags": [ + [ "j", "speech-to-text" ], + [ "params", "range", "900", "930" ], + [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "bid", "5000", "9000" ] + ] +} +``` + +### `kind:1021`: Job fulfillment +```json +{ + "content": "Person 1: blah blah blah", + "tags": [ + ["e", "12345"], + ["p", "abcdef"], + ["status", "success"] + ] +} +``` + +## Customer wants to get a summarization of a podcast + +User publishes two job requests at the same time in the order they should be executed. + +### `kind:68001`: Job Request #1 +```json +{ + "id": "12345", + "pubkey": "abcdef", + "content": "I need a transcript of Bitcoin.review from second 900 to 930", + "tags": [ + [ "j", "speech-to-text" ], + [ "params", "range", "900", "930" ], + [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "bid", "5000", "9000" ] + ] +} +``` + +### `kind:68001`: Job Request #2 +```json +{ + "id": "12346", + "pubkey": "abcdef", + "content": "I need a summarization", + "tags": [ + [ "j", "summarization" ], + [ "params", "length", "3 paragraphs" ], + [ "input", "12346", "job" ], + [ "bid", "300", "900" ] + ] +} +``` + +## Customer wants a translation of a note +### `kind:68001`: Job Request #1 +```json +{ + "id": "12346", + "pubkey": "abcdef", + "content": "", + "tags": [ + [ "j", "translation" ], + [ "input", "", "event" ] + [ "params", "language", "es_AR" ], + [ "bid", "100", "500" ] + ] +} +``` \ No newline at end of file From b5a7b67d78ad2b8ea52d81704be6b71a9cc80dac Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Mon, 3 Jul 2023 18:02:15 +0300 Subject: [PATCH 003/192] Clarify JSON serialization for the `id` field --- 01.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index 2ff81ebf..9258d2f7 100644 --- a/01.md +++ b/01.md @@ -30,7 +30,7 @@ The only object type that exists is the `event`, which has the following format } ``` -To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (with no white space or line breaks) of the following structure: +To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (which is described below) of the following structure: ```json [ @@ -43,6 +43,14 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ] ``` +To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: +- No whitespace, line breaks or other unnecessary formatting should be included in the output JSON. +- No characters except the following should be escaped, and instead should be included verbatim: + - The line break, `0x0A`, as `\n` + - A double quote, `0x22`, as `\"` + - A backspace, `0x5C`, as `\\` +- UTF-8 should be used for encoding. + ## Communication between clients and relays Relays expose a websocket endpoint to which clients can connect. From 3f8658ecc11e593f85a6a8d7de109d0b8f3254df Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Tue, 4 Jul 2023 13:49:52 +0300 Subject: [PATCH 004/192] Fix typo --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 9258d2f7..70aae443 100644 --- a/01.md +++ b/01.md @@ -48,7 +48,7 @@ To prevent implementation differences from creating a different event ID for the - No characters except the following should be escaped, and instead should be included verbatim: - The line break, `0x0A`, as `\n` - A double quote, `0x22`, as `\"` - - A backspace, `0x5C`, as `\\` + - A backslash, `0x5C`, as `\\` - UTF-8 should be used for encoding. ## Communication between clients and relays From 21d71791c89f41fb93f84b69d6db253bb7b403c4 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Tue, 4 Jul 2023 13:55:15 +0300 Subject: [PATCH 005/192] Add carriage returns and tab characters since those may be in some events --- 01.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/01.md b/01.md index 70aae443..f5673b38 100644 --- a/01.md +++ b/01.md @@ -49,6 +49,8 @@ To prevent implementation differences from creating a different event ID for the - The line break, `0x0A`, as `\n` - A double quote, `0x22`, as `\"` - A backslash, `0x5C`, as `\\` + - A carriage return, `0x0D`, as `\r` + - A tab character, `0x09`, as `\t` - UTF-8 should be used for encoding. ## Communication between clients and relays From ce552554a08bb5b9878621abfdde3207d54cae62 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Wed, 5 Jul 2023 11:14:50 +0200 Subject: [PATCH 006/192] wip, part 2 --- vending-machine.md | 208 ++++++++++++++++++++++++++++++--------------- 1 file changed, 139 insertions(+), 69 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index a94cd332..eb26688d 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -1,8 +1,15 @@ -# NIP-XX: Data Vending Machine -Money in, data out. +NIP-XX +====== + +Data Vending Machine +-------------------- + +`draft` `optional` `author:pablof7z` + +This NIP defines the interaction between customers and Service Providers to perform on-demand computation. ## Rationale -Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization"), but where they don't necessarily care about "who" processes the data. +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. @@ -11,26 +18,9 @@ There are two actors to the workflow described in this NIP: * Customers (npubs who request a job) * Service providers (npubs who fulfill jobs) -## User flow -* User publishes a job request -`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` - -* Service providers listen for the type of jobs they can perform -`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` - -* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it -* Upon completion, the service provider publishes the result of the job with a `job-result` event. -* Upon acceptance, the user zaps the service provider, tagging the job request - -## Kinds - -This NIP introduces two new kinds: - -* `kind:68001`: Job request -- a request to have a job be processed -* `kind:68002`: Job result -- a proposal of the resulting job - -### Job request -A request to have data processed -- published by a user +# Event Kinds +## Job request +A request to have data processed -- published by a customer ```json { @@ -38,40 +28,35 @@ A request to have data processed -- published by a user "content": "", "tags": [ // The type data processing the user wants to be performed - // on the - [ "j", "", "" ], - [ "input", "", "", "" ], + [ "j", "", "" ], + + // input(s) for the job request + [ "i", "", "", "" ], + + // relays where the job result should be published [ "relays", "wss://..."], - // stringified sat amount that the user is offering to pay - // for this request - // should this include an optional max price or is it too - // ambiguous? - [ "bid", "", [""] ], - - // max timestamp at which the job is no longer to be processed - [ "expiration", "" ] - - // p tags + // millisats amount that the user is offering to pay + [ "bid", "", "" ], + [ "exp", "" ], [ "p", "service-provider-1" ], [ "p", "service-provider-2" ], - - // NIP-33 d-tag - [ "d", ""] ] } ``` -#### `content` field +### `content` field An optional, human-readable description of what this job is for. -#### `j` tag +### `j` tag Specifies the job to be executed. A job request MUST have exactly one `j` tag. -A `j` tag MIGHT name a specific model to be used for the computed with. +A `j` tag MIGHT name a specific model to be used for the computed with as the second value. -#### `input` tag -Specified the input that the job should be executed with. +### `i` (input) tag +Specifies the input that the job should be executed with. The input is relay-indexable so that clients interested in the exact same job can find it it's result if it's already fulfilled. + +A job request CAN have zero or more inputs. * ``: The argument for the input * ``: The way this argument should be interpreted @@ -81,17 +66,20 @@ Specified the input that the job should be executed with. * `job`: the output of a previous job with the specified event ID * ``: -#### `relays` tag +### `bid` tag +The user MIGHT specify an amount of millisats they are willing to pay for the job to be processed. The user MIGHT also specify a maximum amount of millisats they are willing to pay. + +### `relays` tag A list of relays the service provider should publish its job result to. -#### `p` tags (optional) -A user might want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. +### `p` tags +A user MIGHT want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. -#### `expiration` (optional) +### `exp` A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) -### Job result -The output of processing the data -- published by the +## Job result +The output of processing the data -- published by the service provider. ```json { "pubkey": "service-provider", @@ -100,19 +88,22 @@ The output of processing the data -- published by the "content": "", "tags" [ // stringified JSON request event - [ "request", "<2xxx1-event>" ], - [ "e", ], + [ "request", "<68001-event>" ], + [ "e", ], [ "p", "" ], [ "status", "success", ""], - [ "payment", "requested-payment-amount" ] + [ "amount", "requested-payment-amount" ] ] } ``` -### `status` tag +The result of the job should be in the `content`. If the output is not text, the `content` field should be empty and an `output` tag should be used instead as described below. + +#### `status` tag The service provider might want to return an error to the user in case the job could not be processed correctly -### `payment` +#### `amount` +The amount of millisats the service provider is requesting to be paid. This amount MIGHT be different than the amount specified by the user in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. ## Job types @@ -133,21 +124,52 @@ This NIP defines some job types, clients SHOULD specify these types for maximum #### params | param | req? | description |--------------------------------|------|-------- -| `language` | req | desired language in BCP 47 format. +| `language` | req | requested language in BCP 47 format. -## Job chaining +# Protocol Flow +* User publishes a job request +`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` + +* Service providers listen for the type of jobs they can perform +`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` + +* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) +* Upon completion, the service provider publishes the result of the job with a `job-result` event. +* Upon acceptance, the user zaps the service provider, tagging the job result event. + +# Payment +Customers SHOULD pay service providers whose job results they accept. Users should zap the service provider, tagging the `kind:68002` job result. + + +# Job chaining A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. -## Job feedback +# Reactions > **Warning** > Is this hijacking/modifying the meaning of NIP-25 reactions too much? -A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. -The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result, either -in the form of +## Job request reactions +Service Providers might opt to give feedback about a job. +### E.g. Payment required +```json +{ + "kind": 7, + "content": "Please pay 7 sats for job xxxx", + "tags": [ + [ "e", ], + [ "status", "payment-required" ], + [ "amount", "7000" ], + ] +} +``` + +## Job feedback + +A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. +The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. ## Explicitly not addressed in this NIP @@ -163,7 +185,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar # Appendix 1: Examples -## Customer wants to get a transcript of a podcast from second 900 to 930. +## Transcript of a podcast from second `900` to `930`. ### `kind:68001`: Job Request ```json @@ -174,7 +196,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar "tags": [ [ "j", "speech-to-text" ], [ "params", "range", "900", "930" ], - [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "bid", "5000", "9000" ] ] } @@ -192,7 +214,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar } ``` -## Customer wants to get a summarization of a podcast +## Summarization of a podcast User publishes two job requests at the same time in the order they should be executed. @@ -205,7 +227,7 @@ User publishes two job requests at the same time in the order they should be exe "tags": [ [ "j", "speech-to-text" ], [ "params", "range", "900", "930" ], - [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "bid", "5000", "9000" ] ] } @@ -220,13 +242,13 @@ User publishes two job requests at the same time in the order they should be exe "tags": [ [ "j", "summarization" ], [ "params", "length", "3 paragraphs" ], - [ "input", "12346", "job" ], + [ "i", "12346", "job" ], [ "bid", "300", "900" ] ] } ``` -## Customer wants a translation of a note +## Translation of a note ### `kind:68001`: Job Request #1 ```json { @@ -235,9 +257,57 @@ User publishes two job requests at the same time in the order they should be exe "content": "", "tags": [ [ "j", "translation" ], - [ "input", "", "event" ] + [ "i", "", "event" ] [ "params", "language", "es_AR" ], [ "bid", "100", "500" ] ] } -``` \ No newline at end of file +``` + +## AI-image of the summarization of 2 podcasts + +### `kind:68001`: Job request #1 (transcribe podcast #1) +```json +{ + "id": "123", + "tags": [ + [ "j", "speech-to-text" ], + [ "i", "https://example.com/episode1.mp3", "url" ], + [ "bid", "100", "500" ] + ] +} +``` + +### `kind:68001`: Job request #2 (transcribe podcast #2) +```json +{ + "id": "124", + "tags": [ + [ "j", "speech-to-text" ], + [ "i", "https://example.com/episode2.mp3", "url" ], + [ "bid", "100", "500" ] + ] +} +``` + +### `kind:68001`: Job request #3 (summarize both podcasts into one podcast) +```json +{ + "id": "125", + "tags": [ + [ "j", "summarize" ], + [ "param", "length", "1 paragraph" ], + [ "i", "123", "job" ], + [ "i", "124", "job" ], + [ "bid", "100", "500" ] + ] +} +``` + +# Notes + +* Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. + +* Ambiguity on job acceptance, particularly for job-chaining circumstances is deliberately ambiguous: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. + +That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). From 667c700c1cab5106655df2de528e960b4875db0d Mon Sep 17 00:00:00 2001 From: gsovereignty Date: Sat, 8 Jul 2023 18:51:30 +0800 Subject: [PATCH 007/192] Problem: some of the language is inconsistent --- vending-machine.md | 53 +++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index eb26688d..2f9c0649 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -27,7 +27,7 @@ A request to have data processed -- published by a customer "kind": 68001, "content": "", "tags": [ - // The type data processing the user wants to be performed + // The type of data processing the user wants to be performed [ "j", "", "" ], // input(s) for the job request @@ -49,12 +49,12 @@ A request to have data processed -- published by a customer An optional, human-readable description of what this job is for. ### `j` tag -Specifies the job to be executed. A job request MUST have exactly one `j` tag. +Specifies the job to be executed. A job request MUST have exactly one (1) `j` tag. -A `j` tag MIGHT name a specific model to be used for the computed with as the second value. +A `j` tag MAY include a second value specifying the name of a model to be used when computing the result. ### `i` (input) tag -Specifies the input that the job should be executed with. The input is relay-indexable so that clients interested in the exact same job can find it it's result if it's already fulfilled. +Specifies the input data that the job is to be executed against. The input is relay-indexable so that clients interested in the exact same job can find the input data and the result result (if it's already fulfilled). A job request CAN have zero or more inputs. @@ -64,50 +64,51 @@ A job request CAN have zero or more inputs. * `url`: a URL to be fetched * `event`: a nostr event ID * `job`: the output of a previous job with the specified event ID -* ``: +* ``: an optional field indicating where the data can be found if it is a subset of the provided values, for example the name of the key(s) in a key/value set, or the start and end positions of the data if it's a bytestream. ### `bid` tag -The user MIGHT specify an amount of millisats they are willing to pay for the job to be processed. The user MIGHT also specify a maximum amount of millisats they are willing to pay. +The Customer MAY specify a maximum amount (in millisats) they are willing to pay for the job to be processed. ### `relays` tag -A list of relays the service provider should publish its job result to. +The Service Provider SHOULD publish job results to the relays specified in this this tag. ### `p` tags -A user MIGHT want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. +If a Customer has a preference for specific Service Provider(s) to process this job, they SHOULD indicate this by including the Service Provider(s) pubkey in a `p` tag. This is NOT intended to exclude other Service Providers and they MAY still choose to compete for jobs that have not tagged them. ### `exp` -A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) +A Customer MAY indicate that they will not pay for results produced after a specific Block height or Unix Timestamp. This is intended for time-sensitive jobs where the result is not relevant unless produced within a certain timeframe, e.g. a live transcription service. ## Job result -The output of processing the data -- published by the service provider. +The output of processing the data -- published by the Service Provider. ```json { - "pubkey": "service-provider", + "pubkey": "service-provider pubkey in hex", // result - "content": "", + "content": "string: ", + "kind": 68002, "tags" [ // stringified JSON request event - [ "request", "<68001-event>" ], - [ "e", ], - [ "p", "" ], - [ "status", "success", ""], + [ "request", "" ], + [ "e", "" ], + [ "p", "" ], + [ "status", "success", "" ], [ "amount", "requested-payment-amount" ] ] } ``` -The result of the job should be in the `content`. If the output is not text, the `content` field should be empty and an `output` tag should be used instead as described below. +The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. #### `status` tag -The service provider might want to return an error to the user in case the job could not be processed correctly +The Service Provider MAY indicate errors during processing by including them in the `status` tag, these errors are intended to be consumed by the Customer. #### `amount` -The amount of millisats the service provider is requesting to be paid. This amount MIGHT be different than the amount specified by the user in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. +The amount (in millisats) that the Service Provider is requesting to be paid. This amount MAY differ to the amount specified by the Customer in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. ## Job types -This NIP defines some job types, clients SHOULD specify these types for maximum compatibility with service providers. Other job types might be added to this NIP. +This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. ### `speech-to-text` #### params @@ -127,24 +128,24 @@ This NIP defines some job types, clients SHOULD specify these types for maximum | `language` | req | requested language in BCP 47 format. # Protocol Flow -* User publishes a job request +* Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` -* Service providers listen for the type of jobs they can perform +* Service Providers subsribe to the type of jobs they can perform `{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` -* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) +* When a job comes in, the Service Providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) * Upon completion, the service provider publishes the result of the job with a `job-result` event. * Upon acceptance, the user zaps the service provider, tagging the job result event. # Payment -Customers SHOULD pay service providers whose job results they accept. Users should zap the service provider, tagging the `kind:68002` job result. +Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. # Job chaining -A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. +A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. -Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. # Reactions > **Warning** From 5f27121c98efe01f756ee8d316051913277b33c5 Mon Sep 17 00:00:00 2001 From: Believethehype Date: Sun, 9 Jul 2023 12:08:28 +0200 Subject: [PATCH 008/192] Update vending-machine.md --- vending-machine.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/vending-machine.md b/vending-machine.md index 2f9c0649..e64a667c 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -89,7 +89,7 @@ The output of processing the data -- published by the Service Provider. "kind": 68002, "tags" [ // stringified JSON request event - [ "request", "" ], + [ "request", "<68001-event-as-stringified JSON>" ], [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], @@ -115,6 +115,7 @@ This NIP defines some example job types, Customers SHOULD specify these types fo | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed +| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs ### `summarization` | param | req? | description From a9dd5574531229df065eb9df2212bb7510db1f61 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 11 Jul 2023 15:22:30 +0200 Subject: [PATCH 009/192] get rid of the kind:7 stuff --- vending-machine.md | 131 +++++++++++++++++++++------------------------ 1 file changed, 61 insertions(+), 70 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index e64a667c..0f0b0031 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -33,6 +33,9 @@ A request to have data processed -- published by a customer // input(s) for the job request [ "i", "", "", "" ], + // expected output format + [ "output", "mimetype" ], + // relays where the job result should be published [ "relays", "wss://..."], @@ -45,51 +48,36 @@ A request to have data processed -- published by a customer } ``` -### `content` field -An optional, human-readable description of what this job is for. +* `content` field: An optional, human-readable description of what this job is for. +* `j` tag: Job-type to be executed. + * A job request MUST have exactly one `j` tag. + * It MAY include a second value specifying the name of a model to be used when computing the result. -### `j` tag -Specifies the job to be executed. A job request MUST have exactly one (1) `j` tag. - -A `j` tag MAY include a second value specifying the name of a model to be used when computing the result. - -### `i` (input) tag -Specifies the input data that the job is to be executed against. The input is relay-indexable so that clients interested in the exact same job can find the input data and the result result (if it's already fulfilled). - -A job request CAN have zero or more inputs. - -* ``: The argument for the input -* ``: The way this argument should be interpreted - * Possible values: +* `i` tag: Input data for the job. + * A job request CAN have zero or more inputs. + * Positional arguments: `["i", "", "", "", ""]` + * ``: The argument for the input + * ``: The way this argument should be interpreted, one of: * `url`: a URL to be fetched - * `event`: a nostr event ID + * `event`: a nostr event ID, include an optional relay-url extra param * `job`: the output of a previous job with the specified event ID -* ``: an optional field indicating where the data can be found if it is a subset of the provided values, for example the name of the key(s) in a key/value set, or the start and end positions of the data if it's a bytestream. - -### `bid` tag -The Customer MAY specify a maximum amount (in millisats) they are willing to pay for the job to be processed. - -### `relays` tag -The Service Provider SHOULD publish job results to the relays specified in this this tag. - -### `p` tags -If a Customer has a preference for specific Service Provider(s) to process this job, they SHOULD indicate this by including the Service Provider(s) pubkey in a `p` tag. This is NOT intended to exclude other Service Providers and they MAY still choose to compete for jobs that have not tagged them. - -### `exp` -A Customer MAY indicate that they will not pay for results produced after a specific Block height or Unix Timestamp. This is intended for time-sensitive jobs where the result is not relevant unless produced within a certain timeframe, e.g. a live transcription service. + * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. + * ``: an optional field indicating how this input should be used. +* `output` tag: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format. +* `bid` tag: Customer MAY specify a maximum amount (in millisats) they are willing to pay. +* `relays` tag: relays where Service Providers SHOULD publish responses to. +* `p` tags: Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. +* `exp`: Optional expiration timestamp. Service Providers SHOULD not send results after this timestamp. ## Job result The output of processing the data -- published by the Service Provider. ```json { "pubkey": "service-provider pubkey in hex", - - // result - "content": "string: ", + "content": "", "kind": 68002, "tags" [ - // stringified JSON request event - [ "request", "<68001-event-as-stringified JSON>" ], + [ "request", "<68001-event>" ], [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], @@ -98,36 +86,15 @@ The output of processing the data -- published by the Service Provider. } ``` +## Job feedback +Both customers and service providers can give feedback about a job. + The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. -#### `status` tag -The Service Provider MAY indicate errors during processing by including them in the `status` tag, these errors are intended to be consumed by the Customer. - -#### `amount` -The amount (in millisats) that the Service Provider is requesting to be paid. This amount MAY differ to the amount specified by the Customer in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. - -## Job types - -This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. - -### `speech-to-text` -#### params -| param | req? | description -|--------------------------------|------|-------- -| `range` | opt | timestamp range (in seconds) of desired text to be transcribed -| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs - -### `summarization` -| param | req? | description -|--------------------------------|------|-------- -| `length` | opt | desired length - -### `translation` -- Translate text to a specific language -#### params -| param | req? | description -|--------------------------------|------|-------- -| `language` | req | requested language in BCP 47 format. +* `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. +* `amount`: millisats that the Service Provider is requesting to be paid. +## # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` @@ -142,15 +109,17 @@ This NIP defines some example job types, Customers SHOULD specify these types fo # Payment Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. +Additionally, if a service provider requests full or partial prepayment via a `kind:68003` job-feedback event, the customer SHOULD zap that event to pay the service provider. + +# Cancellation +A `kind:68001` job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. # Job chaining A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. -# Reactions -> **Warning** -> Is this hijacking/modifying the meaning of NIP-25 reactions too much? +# Job Feedback ## Job request reactions Service Providers might opt to give feedback about a job. @@ -169,7 +138,6 @@ Service Providers might opt to give feedback about a job. ``` ## Job feedback - A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. @@ -197,21 +165,21 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar "content": "I need a transcript of Bitcoin.review", "tags": [ [ "j", "speech-to-text" ], - [ "params", "range", "900", "930" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "bid", "5000", "9000" ] + [ "params", "range", "900", "930" ], + [ "bid", "5000", "9000" ], + [ "output", "text/plain" ] ] } ``` -### `kind:1021`: Job fulfillment +### `kind:68002`: Job fulfillment ```json { - "content": "Person 1: blah blah blah", + "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], - ["status", "success"] ] } ``` @@ -306,6 +274,29 @@ User publishes two job requests at the same time in the order they should be exe } ``` +# Appendix 2: Job types + +This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. + +### `speech-to-text` +#### params +| param | req? | description +|--------------------------------|------|-------- +| `range` | opt | timestamp range (in seconds) of desired text to be transcribed +| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs + +### `summarization` +| param | req? | description +|--------------------------------|------|-------- +| `length` | opt | desired length + +### `translation` -- Translate text to a specific language +#### params +| param | req? | description +|--------------------------------|------|-------- +| `language` | req | requested language in BCP 47 format. + + # Notes * Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. From def620e1ce4417a4e78b5012c3a43adbe105f43e Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 11 Jul 2023 22:25:54 +0200 Subject: [PATCH 010/192] more cleanup --- vending-machine.md | 57 +++++++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 0f0b0031..8121ffc0 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -27,19 +27,10 @@ A request to have data processed -- published by a customer "kind": 68001, "content": "", "tags": [ - // The type of data processing the user wants to be performed [ "j", "", "" ], - - // input(s) for the job request [ "i", "", "", "" ], - - // expected output format - [ "output", "mimetype" ], - - // relays where the job result should be published + [ "output", "" ], [ "relays", "wss://..."], - - // millisats amount that the user is offering to pay [ "bid", "", "" ], [ "exp", "" ], [ "p", "service-provider-1" ], @@ -94,7 +85,6 @@ The result of the job SHOULD be included in the `content` field. If the output i * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. * `amount`: millisats that the Service Provider is requesting to be paid. -## # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` @@ -127,7 +117,7 @@ Service Providers might opt to give feedback about a job. ### E.g. Payment required ```json { - "kind": 7, + "kind": 68003, "content": "Please pay 7 sats for job xxxx", "tags": [ [ "e", ], @@ -148,11 +138,6 @@ Service providers are at obvious risk of having their results not compensated. M It's out of scope (and undesirable) to have this NIP address this issue; the market should. -## Notes - -### Multitple job acceptance -* Nothing prevents a user from accepting multiple job results. - # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. @@ -162,7 +147,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar { "id": "12345", "pubkey": "abcdef", - "content": "I need a transcript of Bitcoin.review", + "content": "", "tags": [ [ "j", "speech-to-text" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], @@ -173,13 +158,30 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar } ``` -### `kind:68002`: Job fulfillment +### `kind:68003`: Job Feedback: request for (partial) payment +```json +{ + "kind": 68003, + "content": "", + "tags": [ + ["e", "12345"], + ["p", "abcdef"], + ["status", "payment-required"], + ["amount", "1000"] + ] +} +``` + +* User zaps 1000 sats to event kind:68003. + +### `kind:68002`: Job fulfillment + request for remaining payment ```json { "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], + ["amount", "6000"] ] } ``` @@ -208,7 +210,7 @@ User publishes two job requests at the same time in the order they should be exe { "id": "12346", "pubkey": "abcdef", - "content": "I need a summarization", + "content": "", "tags": [ [ "j", "summarization" ], [ "params", "length", "3 paragraphs" ], @@ -227,13 +229,26 @@ User publishes two job requests at the same time in the order they should be exe "content": "", "tags": [ [ "j", "translation" ], - [ "i", "", "event" ] + [ "i", "", "event", "wss://relay.nostr.com" ] [ "params", "language", "es_AR" ], [ "bid", "100", "500" ] ] } ``` +### `kind:68003`: Job respomse +```json +{ + "kind": 68003, + "content": "Che, que copado, boludo!", + "tags": [ + ["e", "12346"], + ["p", "abcdef"], + ["amount", "1000"] + ] +} +``` + ## AI-image of the summarization of 2 podcasts ### `kind:68001`: Job request #1 (transcribe podcast #1) From e9924bdcde2dc516a891c027bd023f487b73a674 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sat, 15 Jul 2023 12:24:32 +0200 Subject: [PATCH 011/192] add optional bolt11 --- vending-machine.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 8121ffc0..1d08bd23 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -72,7 +72,7 @@ The output of processing the data -- published by the Service Provider. [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], - [ "amount", "requested-payment-amount" ] + [ "amount", "requested-payment-amount", "" ] ] } ``` @@ -80,21 +80,27 @@ The output of processing the data -- published by the Service Provider. ## Job feedback Both customers and service providers can give feedback about a job. -The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. +The result of the job SHOULD be included in the `content` field. * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: millisats that the Service Provider is requesting to be paid. +* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` +* Service Prpvoders can submit `kind:68003` job-feedback events (e.g. `payment-required`, `processing`, `unprocessable-entity`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:68002` job-result event. +* Upon acceptance, the user zaps the service provider, tagging the job result event with a `kind:7` πŸ‘ reaction. -* Service Providers subsribe to the type of jobs they can perform -`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` +`kind:68002` and `kind:68003` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers +SHOULD use the `payment-required` feedback event to signal that a payment must be done before moving on to the next step. -* When a job comes in, the Service Providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) -* Upon completion, the service provider publishes the result of the job with a `job-result` event. -* Upon acceptance, the user zaps the service provider, tagging the job result event. +## Notes about the protocol flow +The flow is deliverately left ambiguos, allowing vast flexibility for the interaction between customers and service providers so that +service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` +as the first reaction before sending an `processing` or before delivering `kind:68002` results, some might choose to serve partial results +for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to +assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. # Payment Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. @@ -131,7 +137,7 @@ Service Providers might opt to give feedback about a job. A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. -## Explicitly not addressed in this NIP +## Not addressed in this NIP ### Reputation system Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). From 53bd97373b5442445f5c387945cf5685ac39ab80 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 21:28:59 +0200 Subject: [PATCH 012/192] use different kinds per job request type --- vending-machine.md | 217 ++++++++++++++++++++++++++------------------- 1 file changed, 127 insertions(+), 90 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 1d08bd23..4dbc5a3a 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -8,10 +8,19 @@ Data Vending Machine This NIP defines the interaction between customers and Service Providers to perform on-demand computation. +## Kinds +This NIP reserves the range `65000-69999` for data vending machine use. + +| Kind | Description | +| ---- | ----------- | +| 65000 | Job feedback | +| 65001 | Job result | +| 65002-69999 | Job request kinds | + ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. -This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willigness to pay, and service providers compete to fulfill the job requirement in the best way possible. +This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. ### Actors There are two actors to the workflow described in this NIP: @@ -24,52 +33,44 @@ A request to have data processed -- published by a customer ```json { - "kind": 68001, + "kind": 6xxxx, "content": "", "tags": [ - [ "j", "", "" ], - [ "i", "", "", "" ], + [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], - [ "bid", "", "" ], + [ "bid", "" ], [ "exp", "" ], - [ "p", "service-provider-1" ], - [ "p", "service-provider-2" ], + [ "t", "bitcoin" ] ] } ``` -* `content` field: An optional, human-readable description of what this job is for. -* `j` tag: Job-type to be executed. - * A job request MUST have exactly one `j` tag. - * It MAY include a second value specifying the name of a model to be used when computing the result. - -* `i` tag: Input data for the job. - * A job request CAN have zero or more inputs. - * Positional arguments: `["i", "", "", "", ""]` +* `i` tag: Input data for the job, (zero or more inputs may exist) * ``: The argument for the input - * ``: The way this argument should be interpreted, one of: + * ``: The way this argument should be interpreted, MUST be one of: * `url`: a URL to be fetched * `event`: a nostr event ID, include an optional relay-url extra param * `job`: the output of a previous job with the specified event ID - * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. + * `content`: * ``: an optional field indicating how this input should be used. -* `output` tag: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format. -* `bid` tag: Customer MAY specify a maximum amount (in millisats) they are willing to pay. + * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. +* `output` tag (opt): MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. +* `bid` tag (opt): Customer MAY specify a maximum amount (in millisats) they are willing to pay. * `relays` tag: relays where Service Providers SHOULD publish responses to. -* `p` tags: Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. -* `exp`: Optional expiration timestamp. Service Providers SHOULD not send results after this timestamp. +* `p` tags (opt): Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. +* `exp` (opt): expiration timestamp. Service Providers SHOULD not send results after this timestamp. ## Job result The output of processing the data -- published by the Service Provider. ```json { - "pubkey": "service-provider pubkey in hex", + "pubkey": "", "content": "", - "kind": 68002, + "kind": 65001, "tags" [ - [ "request", "<68001-event>" ], - [ "e", "" ], + [ "request", "" ], + [ "e", "", "" ], [ "p", "" ], [ "status", "success", "" ], [ "amount", "requested-payment-amount", "" ] @@ -77,6 +78,9 @@ The output of processing the data -- published by the Service Provider. } ``` +* `request` tag: The job request event ID. +* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. + ## Job feedback Both customers and service providers can give feedback about a job. @@ -86,29 +90,25 @@ The result of the job SHOULD be included in the `content` field. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. # Protocol Flow -* Customer publishes a job request -`{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` -* Service Prpvoders can submit `kind:68003` job-feedback events (e.g. `payment-required`, `processing`, `unprocessable-entity`, etc.). -* Upon completion, the service provider publishes the result of the job with a `kind:68002` job-result event. -* Upon acceptance, the user zaps the service provider, tagging the job result event with a `kind:7` πŸ‘ reaction. +* Customer publishes a job request (e.g. `kind:65002`). +* Service Prpvoders can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. +* At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. -`kind:68002` and `kind:68003` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers -SHOULD use the `payment-required` feedback event to signal that a payment must be done before moving on to the next step. +`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Custeroms are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. ## Notes about the protocol flow -The flow is deliverately left ambiguos, allowing vast flexibility for the interaction between customers and service providers so that -service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` -as the first reaction before sending an `processing` or before delivering `kind:68002` results, some might choose to serve partial results -for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to -assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. +The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. + +It's not up to this NIP to define how individual vending machines should choose to run their business. # Payment -Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. +Customers SHOULD pay service providers whose job results they accept by either zapping the Service Provider and tagging the `kind:65001` job result or, if included, paying the bolt11 invoice. -Additionally, if a service provider requests full or partial prepayment via a `kind:68003` job-feedback event, the customer SHOULD zap that event to pay the service provider. +Additionally, if a service provider requests full or partial prepayment via a `kind:65000` job-feedback event, the customer SHOULD zap that event to pay the service provider. # Cancellation -A `kind:68001` job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. +A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. # Job chaining A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. @@ -116,17 +116,31 @@ A Customer MAY request multiple jobs to be processed in a chained form, so that Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. # Job Feedback +The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback. -## Job request reactions -Service Providers might opt to give feedback about a job. +Any job feedback event MIGHT include an `amount` tag, indicating the amount of millisats the party is requesting to be paid. An optional third value can be a bolt11 invoice. -### E.g. Payment required +| status | description | +|--------|-------------| +| `payment-required` | Service Provider requires payment before continuing. | +| `processing` | Service Provider is processing the job. | +| `error` | Service Provider was unable to process the job. | +| `success` | Service Provider successfully processed the job. | +| `failure` | Service Provider failed to process the job. | +| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | + +Any job feedback event MIGHT include an `amount` tag, as described in the [Job Result](#job-result) section. + +Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. + +### E.g. Payment required (with sample content) ```json { - "kind": 68003, - "content": "Please pay 7 sats for job xxxx", + "kind": 65000, + "content": "This is the transcription service that you", "tags": [ - [ "e", ], + [ "e", , ], + [ "p", ], [ "status", "payment-required" ], [ "amount", "7000" ], ] @@ -144,153 +158,160 @@ Service providers are at obvious risk of having their results not compensated. M It's out of scope (and undesirable) to have this NIP address this issue; the market should. +### Encrypted job requests +Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: +* publish job requests with some useful metadata of the job "e.g. length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. + # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. -### `kind:68001`: Job Request +### `kind:65002`: Speech-to-text job request ```json { "id": "12345", "pubkey": "abcdef", "content": "", + "kind": 65002, "tags": [ - [ "j", "speech-to-text" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "params", "range", "900", "930" ], - [ "bid", "5000", "9000" ], + [ "output", "text/vtt" ], + [ "bid", "50000" ], [ "output", "text/plain" ] ] } ``` -### `kind:68003`: Job Feedback: request for (partial) payment +### `kind:65001`: Job Feedback: request for (partial) payment +* The SP is signaling here that it won't start processing until 100 sats are paid ```json { - "kind": 68003, + "kind": 65000, "content": "", "tags": [ ["e", "12345"], ["p", "abcdef"], ["status", "payment-required"], - ["amount", "1000"] + ["amount", "100000"] ] } ``` -* User zaps 1000 sats to event kind:68003. +* User zaps 100 sats to the `kind:65000` job-feedback -### `kind:68002`: Job fulfillment + request for remaining payment +### `kind:65001`: Job result + request for remaining payment ```json { "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], - ["amount", "6000"] + ["amount", "400000"] ] } ``` ## Summarization of a podcast +User publishes two job requests at the same time. -User publishes two job requests at the same time in the order they should be executed. - -### `kind:68001`: Job Request #1 +### `kind:65002`: Job Request #1: speech-to-text ```json { "id": "12345", "pubkey": "abcdef", + "kinds" 65002, "content": "I need a transcript of Bitcoin.review from second 900 to 930", "tags": [ - [ "j", "speech-to-text" ], - [ "params", "range", "900", "930" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "bid", "5000", "9000" ] + [ "output", "text/plain" ], + [ "params", "range", "900", "930" ], + [ "bid", "100000" ] ] } ``` -### `kind:68001`: Job Request #2 +### `kind:65003`: Job Request #2: summarization of job #1's result ```json { "id": "12346", "pubkey": "abcdef", + "kinds": 65003, "content": "", "tags": [ - [ "j", "summarization" ], - [ "params", "length", "3 paragraphs" ], [ "i", "12346", "job" ], - [ "bid", "300", "900" ] + [ "output", "text/plain" ], + [ "params", "length", "3 paragraphs" ], + [ "bid", "10000" ] ] } ``` ## Translation of a note -### `kind:68001`: Job Request #1 +### `kind:65004`: Job Request #1: translation of an existing note ```json { "id": "12346", "pubkey": "abcdef", "content": "", + "kinds": 65004, "tags": [ - [ "j", "translation" ], [ "i", "", "event", "wss://relay.nostr.com" ] - [ "params", "language", "es_AR" ], - [ "bid", "100", "500" ] + [ "params", "lang", "es_AR" ], + [ "bid", "5000" ] ] } ``` -### `kind:68003`: Job respomse +### `kind:65001`: Job respomse ```json { - "kind": 68003, + "kind": 65001, "content": "Che, que copado, boludo!", "tags": [ ["e", "12346"], ["p", "abcdef"], - ["amount", "1000"] + ["amount", "4000"] ] } ``` ## AI-image of the summarization of 2 podcasts -### `kind:68001`: Job request #1 (transcribe podcast #1) +### `kind:65002`: Job request #1 (transcribe podcast #1) ```json { "id": "123", + "kind" 65002, "tags": [ - [ "j", "speech-to-text" ], [ "i", "https://example.com/episode1.mp3", "url" ], - [ "bid", "100", "500" ] + [ "bid", "100000" ] ] } ``` -### `kind:68001`: Job request #2 (transcribe podcast #2) +### `kind:65002`: Job request #2 (transcribe podcast #2) ```json { "id": "124", + "kind" 65002, "tags": [ - [ "j", "speech-to-text" ], [ "i", "https://example.com/episode2.mp3", "url" ], - [ "bid", "100", "500" ] + [ "bid", "100000" ] ] } ``` -### `kind:68001`: Job request #3 (summarize both podcasts into one podcast) +### `kind:65003`: Job request #3 (summarize both podcasts into one paragraph) ```json { "id": "125", + "kind": 65003, "tags": [ - [ "j", "summarize" ], [ "param", "length", "1 paragraph" ], [ "i", "123", "job" ], [ "i", "124", "job" ], - [ "bid", "100", "500" ] + [ "bid", "100000" ] ] } ``` @@ -299,29 +320,45 @@ User publishes two job requests at the same time in the order they should be exe This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. -### `speech-to-text` +### speech-to-text: `kind:65002` #### params | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed -| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs +| `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs -### `summarization` +### summarization: `kind:65003` | param | req? | description |--------------------------------|------|-------- | `length` | opt | desired length -### `translation` -- Translate text to a specific language -#### params +### translation: `kind:65004` | param | req? | description |--------------------------------|------|-------- -| `language` | req | requested language in BCP 47 format. +| `lang` | req | desired language in BCP 47 format. +### image generation: `kind:65005` +* `input` # Notes -* Should there be a possibility of getting the job result delivered encrypted? I don't like it but maybe it should be supported. - -* Ambiguity on job acceptance, particularly for job-chaining circumstances is deliberately ambiguous: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. +* Job acceptance ambiguity, particularly for job-chaining circumstances is deliberate: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). + +# Appendix 3: Service provider discoverability + +Service Providers can use NIP-89 announcements to advertise their support for job kinds: + +```json +{ + "kind": 31990, + "pubkey": , + "tags": [ + [ "k", 65002 ], // e.g. speech-to-text + [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" + ] +} +``` + +Customers can use NIP-89 to see what service providers their follows use. \ No newline at end of file From d8b0e7d757206098f65b8ff868e8c59a9ac92ea6 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 23:37:20 +0300 Subject: [PATCH 013/192] wip --- vending-machine.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 4dbc5a3a..4934d4c3 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -9,13 +9,13 @@ Data Vending Machine This NIP defines the interaction between customers and Service Providers to perform on-demand computation. ## Kinds -This NIP reserves the range `65000-69999` for data vending machine use. +This NIP reserves the range `65000-66000` for data vending machine use. | Kind | Description | | ---- | ----------- | | 65000 | Job feedback | | 65001 | Job result | -| 65002-69999 | Job request kinds | +| 65002-66000 | Job request kinds | ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. @@ -33,7 +33,7 @@ A request to have data processed -- published by a customer ```json { - "kind": 6xxxx, + "kind": <65002-66000>, "content": "", "tags": [ [ "i", "", "", "", "" ], @@ -46,6 +46,8 @@ A request to have data processed -- published by a customer } ``` +All tags are optional. + * `i` tag: Input data for the job, (zero or more inputs may exist) * ``: The argument for the input * ``: The way this argument should be interpreted, MUST be one of: @@ -55,11 +57,11 @@ A request to have data processed -- published by a customer * `content`: * ``: an optional field indicating how this input should be used. * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. -* `output` tag (opt): MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. -* `bid` tag (opt): Customer MAY specify a maximum amount (in millisats) they are willing to pay. -* `relays` tag: relays where Service Providers SHOULD publish responses to. -* `p` tags (opt): Service Providers the customer is interested in having process this job. Other SP MIGHT still choose to process the job. -* `exp` (opt): expiration timestamp. Service Providers SHOULD not send results after this timestamp. +* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. +* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay. +* `relays`: relays where Service Providers SHOULD publish responses to. +* `p`: Service Providers the customer is interested in. Other SP MIGHT still choose to process the job. +* `exp`: expiration timestamp. Service Providers SHOULD not send results after this timestamp. ## Job result The output of processing the data -- published by the Service Provider. From 280483adc5b2299886e1e15e369557001e8807af Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 23:58:12 +0300 Subject: [PATCH 014/192] more clarifications --- vending-machine.md | 68 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 16 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 4934d4c3..c4fdc18c 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -17,6 +17,8 @@ This NIP reserves the range `65000-66000` for data vending machine use. | 65001 | Job result | | 65002-66000 | Job request kinds | +[Appendix 2](#appendix-2-job-types) defines the job types. + ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. @@ -33,7 +35,7 @@ A request to have data processed -- published by a customer ```json { - "kind": <65002-66000>, + "kind": xxx, // kind in 65002-66000 range "content": "", "tags": [ [ "i", "", "", "", "" ], @@ -54,8 +56,8 @@ All tags are optional. * `url`: a URL to be fetched * `event`: a nostr event ID, include an optional relay-url extra param * `job`: the output of a previous job with the specified event ID - * `content`: - * ``: an optional field indicating how this input should be used. + * `text`: `` is the value of the input, no resolution is needed + * ``: an optional field indicating how this input should be used within the context of the job. * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. * `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay. @@ -97,7 +99,7 @@ The result of the job SHOULD be included in the `content` field. * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. * At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. -`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Custeroms are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. +`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. ## Notes about the protocol flow The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. @@ -117,6 +119,8 @@ A Customer MAY request multiple jobs to be processed in a chained form, so that Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcast](#summarization-of-a-podcast) + # Job Feedback The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback. @@ -215,7 +219,9 @@ Not to be included in the first draft of this NIP, but encrypted job requests sh ``` ## Summarization of a podcast -User publishes two job requests at the same time. +User publishes two job requests at the same time. A job that transcribes an audio and a job that summarizes the transcription (output of job #1). + +User publishes event #1 and #2 together. ### `kind:65002`: Job Request #1: speech-to-text ```json @@ -223,7 +229,7 @@ User publishes two job requests at the same time. "id": "12345", "pubkey": "abcdef", "kinds" 65002, - "content": "I need a transcript of Bitcoin.review from second 900 to 930", + "content": "", "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "output", "text/plain" ], @@ -233,7 +239,7 @@ User publishes two job requests at the same time. } ``` -### `kind:65003`: Job Request #2: summarization of job #1's result +### `kind:65002`: Job Request #2: summarization of job #1's result ```json { "id": "12346", @@ -241,7 +247,7 @@ User publishes two job requests at the same time. "kinds": 65003, "content": "", "tags": [ - [ "i", "12346", "job" ], + [ "i", "12345", "job" ], // input is the output of job with id 12345 [ "output", "text/plain" ], [ "params", "length", "3 paragraphs" ], [ "bid", "10000" ] @@ -317,30 +323,60 @@ User publishes two job requests at the same time. ] } ``` +## AI-image of embedded input + +### `kind:65005`: Job request +```json +{ + "kind": 65004, + "tags": [ + [ "i", "Millions of vending machines, interconnected with tubes with eah other", "text" ], + [ "param", "prompt", "photorealistic" ], + [ "bid", "500000" ] + ] +} +``` + +### `kind:65006`: Job request #4 (generate image based on the summary) +```json +{ + "id": "126", + "kind": 65004, + "tags": [ + [ "i", "125", "job" ], + [ "param", "prompt", "photorealistic" ], + [ "param", "size", "4000x4000" ], + [ "bid", "500000" ] + ] +} +``` # Appendix 2: Job types -This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. - -### speech-to-text: `kind:65002` -#### params +This is a list of all the supported job requests +. +## speech-to-text: `kind:65002` +### params | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed | `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs -### summarization: `kind:65003` +## summarization: `kind:65003` | param | req? | description |--------------------------------|------|-------- | `length` | opt | desired length -### translation: `kind:65004` +## translation: `kind:65004` | param | req? | description |--------------------------------|------|-------- | `lang` | req | desired language in BCP 47 format. -### image generation: `kind:65005` -* `input` +## image generation: `kind:65005` +| param | req? | description +|--------------------------------|------|-------- +| `prompt` | opt | extra prompt to be used for the image generation +| `size` | opt | desired size of the image # Notes From 4cb3ac871f1c54d2e845ec8655bf564072377a46 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 24 Jul 2023 00:38:47 +0300 Subject: [PATCH 015/192] clarifications, hopefully --- vending-machine.md | 192 ++++++++++++++++++++++----------------------- 1 file changed, 93 insertions(+), 99 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index c4fdc18c..276132df 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -1,4 +1,4 @@ -NIP-XX +NIP-90 ====== Data Vending Machine @@ -6,7 +6,9 @@ Data Vending Machine `draft` `optional` `author:pablof7z` -This NIP defines the interaction between customers and Service Providers to perform on-demand computation. +This NIP defines the interaction between customers and Service Providers for performing on-demand computation. + +Money in, data out. ## Kinds This NIP reserves the range `65000-66000` for data vending machine use. @@ -20,18 +22,18 @@ This NIP reserves the range `65000-66000` for data vending machine use. [Appendix 2](#appendix-2-job-types) defines the job types. ## Rationale -Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g. "speech-to-text", "summarization", etc.), but where they don't necessarily care about "who" processes the data. +Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. -This NIP is not to be confused with a 1:1 marketplace; but rather, a flow where user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. +This NIP is not to be confused with a 1:1 marketplace; instead, it describes a flow where a user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible. ### Actors -There are two actors to the workflow described in this NIP: +There are two actors in the workflow described in this NIP: * Customers (npubs who request a job) * Service providers (npubs who fulfill jobs) # Event Kinds ## Job request -A request to have data processed -- published by a customer +A request to have data processed, published by a customer ```json { @@ -50,33 +52,34 @@ A request to have data processed -- published by a customer All tags are optional. -* `i` tag: Input data for the job, (zero or more inputs may exist) +* `i` tag: Input data for the job (zero or more inputs may exist) * ``: The argument for the input * ``: The way this argument should be interpreted, MUST be one of: - * `url`: a URL to be fetched - * `event`: a nostr event ID, include an optional relay-url extra param - * `job`: the output of a previous job with the specified event ID + * `url`: A URL to be fetched + * `event`: A Nostr event ID, include an optional relay-url extra param + * `job`: The output of a previous job with the specified event ID * `text`: `` is the value of the input, no resolution is needed - * ``: an optional field indicating how this input should be used within the context of the job. - * ``: if `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string. -* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified. -* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay. -* `relays`: relays where Service Providers SHOULD publish responses to. -* `p`: Service Providers the customer is interested in. Other SP MIGHT still choose to process the job. -* `exp`: expiration timestamp. Service Providers SHOULD not send results after this timestamp. + * ``: An optional field indicating how this input should be used within the context of the job + * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string +* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified +* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay +* `relays`: Relays where Service Providers SHOULD publish responses to +* `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job +* `exp`: Expiration timestamp. Service Providers SHOULD not send results after this timestamp ## Job result + The output of processing the data -- published by the Service Provider. + ```json { "pubkey": "", "content": "", "kind": 65001, - "tags" [ + "tags": [ [ "request", "" ], [ "e", "", "" ], [ "p", "" ], - [ "status", "success", "" ], [ "amount", "requested-payment-amount", "" ] ] } @@ -91,54 +94,35 @@ Both customers and service providers can give feedback about a job. The result of the job SHOULD be included in the `content` field. * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. +* `amount`: as defined in the [Job Result](#job-result) section. # Protocol Flow * Customer publishes a job request (e.g. `kind:65002`). -* Service Prpvoders can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. * At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. -`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers are can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. +`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. ## Notes about the protocol flow -The flow is deliverately ambiguos, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` as the first reaction before sending an `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. +The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. + +Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. It's not up to this NIP to define how individual vending machines should choose to run their business. -# Payment -Customers SHOULD pay service providers whose job results they accept by either zapping the Service Provider and tagging the `kind:65001` job result or, if included, paying the bolt11 invoice. - -Additionally, if a service provider requests full or partial prepayment via a `kind:65000` job-feedback event, the customer SHOULD zap that event to pay the service provider. - # Cancellation A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. # Job chaining -A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. +A Customer MAY request multiple jobs to be processed as a chain, where the output of a job can be the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. -Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. + +This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcast](#summarization-of-a-podcast) -# Job Feedback -The parties to a job request can use `kind:65000` to provide feedback about the job, using a `status` tag to indicate the type of feedback. - -Any job feedback event MIGHT include an `amount` tag, indicating the amount of millisats the party is requesting to be paid. An optional third value can be a bolt11 invoice. - -| status | description | -|--------|-------------| -| `payment-required` | Service Provider requires payment before continuing. | -| `processing` | Service Provider is processing the job. | -| `error` | Service Provider was unable to process the job. | -| `success` | Service Provider successfully processed the job. | -| `failure` | Service Provider failed to process the job. | -| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | - -Any job feedback event MIGHT include an `amount` tag, as described in the [Job Result](#job-result) section. - -Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. - ### E.g. Payment required (with sample content) ```json { @@ -153,20 +137,15 @@ Any job feedback event MIGHT include results in the `.content` field, as describ } ``` -## Job feedback -A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. -The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. - ## Not addressed in this NIP ### Reputation system -Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). - -It's out of scope (and undesirable) to have this NIP address this issue; the market should. +Service providers are at an obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e., building reputation systems, requiring npub "balances", etc.). It's out of scope (and undesirable) to have this NIP address this issue; the market should. ### Encrypted job requests Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: -* publish job requests with some useful metadata of the job "e.g. length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. + * publish job requests with some useful metadata of the job "e.g., length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. + # Appendix 1: Examples @@ -189,7 +168,7 @@ Not to be included in the first draft of this NIP, but encrypted job requests sh } ``` -### `kind:65001`: Job Feedback: request for (partial) payment +### `kind:65000`: Job Feedback: request for (partial) payment * The SP is signaling here that it won't start processing until 100 sats are paid ```json { @@ -228,7 +207,7 @@ User publishes event #1 and #2 together. { "id": "12345", "pubkey": "abcdef", - "kinds" 65002, + "kind": 65002, "content": "", "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], @@ -244,7 +223,7 @@ User publishes event #1 and #2 together. { "id": "12346", "pubkey": "abcdef", - "kinds": 65003, + "kind": 65003, "content": "", "tags": [ [ "i", "12345", "job" ], // input is the output of job with id 12345 @@ -262,16 +241,17 @@ User publishes event #1 and #2 together. "id": "12346", "pubkey": "abcdef", "content": "", - "kinds": 65004, + "kind": 65004, "tags": [ [ "i", "", "event", "wss://relay.nostr.com" ] + [ "output", "text/plain" ], [ "params", "lang", "es_AR" ], [ "bid", "5000" ] ] } ``` -### `kind:65001`: Job respomse +### `kind:65001`: Job result ```json { "kind": 65001, @@ -290,7 +270,7 @@ User publishes event #1 and #2 together. ```json { "id": "123", - "kind" 65002, + "kind": 65002, "tags": [ [ "i", "https://example.com/episode1.mp3", "url" ], [ "bid", "100000" ] @@ -302,7 +282,7 @@ User publishes event #1 and #2 together. ```json { "id": "124", - "kind" 65002, + "kind": 65002, "tags": [ [ "i", "https://example.com/episode2.mp3", "url" ], [ "bid", "100000" ] @@ -310,7 +290,7 @@ User publishes event #1 and #2 together. } ``` -### `kind:65003`: Job request #3 (summarize both podcasts into one paragraph) +### `kind:65003`: Job request #3 (summarize the two job's outputs into one paragraph) ```json { "id": "125", @@ -323,6 +303,21 @@ User publishes event #1 and #2 together. ] } ``` + +### `kind:65005`: Job request #4 (generate image based on the summary) +```json +{ + "id": "126", + "kind": 65004, + "tags": [ + [ "i", "125", "job" ], + [ "param", "prompt", "photorealistic" ], + [ "param", "size", "4000x4000" ], + [ "bid", "500000" ] + ] +} +`` + ## AI-image of embedded input ### `kind:65005`: Job request @@ -337,61 +332,60 @@ User publishes event #1 and #2 together. } ``` -### `kind:65006`: Job request #4 (generate image based on the summary) -```json -{ - "id": "126", - "kind": 65004, - "tags": [ - [ "i", "125", "job" ], - [ "param", "prompt", "photorealistic" ], - [ "param", "size", "4000x4000" ], - [ "bid", "500000" ] - ] -} -``` - # Appendix 2: Job types -This is a list of all the supported job requests -. +This is a list of all the supported job requests. + ## speech-to-text: `kind:65002` + ### params -| param | req? | description -|--------------------------------|------|-------- -| `range` | opt | timestamp range (in seconds) of desired text to be transcribed -| `alignment` | opt | word, segment, raw: word-level, segment-level or raw outputs + +| param | req? | description | +|------------|------|-----------------------------------------------------------| +| `range` | opt | timestamp range (in seconds) of desired text to be transcribed | +| `alignment`| opt | word, segment, raw: word-level, segment-level, or raw outputs | ## summarization: `kind:65003` -| param | req? | description -|--------------------------------|------|-------- -| `length` | opt | desired length + +| param | req? | description | +|-----------|------|---------------| +| `length` | opt | desired length | ## translation: `kind:65004` -| param | req? | description -|--------------------------------|------|-------- -| `lang` | req | desired language in BCP 47 format. + +| param | req? | description | +|-----------|------|--------------------------------------------| +| `lang` | req | desired language in BCP 47 format. | ## image generation: `kind:65005` -| param | req? | description -|--------------------------------|------|-------- -| `prompt` | opt | extra prompt to be used for the image generation -| `size` | opt | desired size of the image -# Notes +| param | req? | description | +|-----------|------|-------------------------------------------------------| +| `prompt` | opt | extra prompt to be used for the image generation | +| `size` | opt | desired size of the image | -* Job acceptance ambiguity, particularly for job-chaining circumstances is deliberate: service providers could wait until explicit job result acceptance / payment to start working on the next item on the chain, or they could start working as soon as they see a result of the previous job computed. -That's up to each service provider to choose how to behave depending on the circumstances. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). +# Appendix 3: Job feedback status -# Appendix 3: Service provider discoverability +| status | description | +|--------|-------------| +| `payment-required` | Service Provider requires payment before continuing. | +| `processing` | Service Provider is processing the job. | +| `error` | Service Provider was unable to process the job. | +| `success` | Service Provider successfully processed the job. | +| `failure` | Service Provider failed to process the job. | +| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | + +Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. + +# Appendix 4: Service provider discoverability Service Providers can use NIP-89 announcements to advertise their support for job kinds: ```json { "kind": 31990, - "pubkey": , + "pubkey": "", "tags": [ [ "k", 65002 ], // e.g. speech-to-text [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" From 723103506030749fc2bba9d5b4ddaf607dd24da3 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 01:29:02 +0300 Subject: [PATCH 016/192] feed-generation kind and some more stuff --- vending-machine.md | 104 ++++++++++++++++++++++++++++++++------------- 1 file changed, 74 insertions(+), 30 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 276132df..c41ccceb 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -19,7 +19,7 @@ This NIP reserves the range `65000-66000` for data vending machine use. | 65001 | Job result | | 65002-66000 | Job request kinds | -[Appendix 2](#appendix-2-job-types) defines the job types. +[Appendix 2](#appendix-2-job-types) defines the job request types. ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. @@ -32,19 +32,23 @@ There are two actors in the workflow described in this NIP: * Service providers (npubs who fulfill jobs) # Event Kinds + +* `kind:65000`: job feedback +* `kind:65001`: job result +* `kind:65002`-`kind:66000`: job requests + ## Job request -A request to have data processed, published by a customer +A request to have data processed, published by a customer. This event signals that an npub is interested in receiving the result of some kind of compute. ```json { - "kind": xxx, // kind in 65002-66000 range + "kind": 65xxx, // kind in 65002-66000 range "content": "", "tags": [ [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], [ "bid", "" ], - [ "exp", "" ], [ "t", "bitcoin" ] ] } @@ -52,24 +56,25 @@ A request to have data processed, published by a customer All tags are optional. -* `i` tag: Input data for the job (zero or more inputs may exist) +* `i` tag: Input data for the job (zero or more inputs) * ``: The argument for the input - * ``: The way this argument should be interpreted, MUST be one of: + * ``: The way this argument should be interpreted. MUST be one of: * `url`: A URL to be fetched - * `event`: A Nostr event ID, include an optional relay-url extra param + * `event`: A Nostr event ID. * `job`: The output of a previous job with the specified event ID * `text`: `` is the value of the input, no resolution is needed * ``: An optional field indicating how this input should be used within the context of the job * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string -* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified +* `output`: Expected output format. (e.g. MIME type) + * Service Providers MUST publish the result of the job in this format if it has been specified. + * Each job-type ([Appendix 2](#appendix-2-job-types)) might define the output format more narrowly. * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay -* `relays`: Relays where Service Providers SHOULD publish responses to +* `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -* `exp`: Expiration timestamp. Service Providers SHOULD not send results after this timestamp ## Job result -The output of processing the data -- published by the Service Provider. +Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. ```json { @@ -79,28 +84,40 @@ The output of processing the data -- published by the Service Provider. "tags": [ [ "request", "" ], [ "e", "", "" ], - [ "p", "" ], + [ "p", "" ], [ "amount", "requested-payment-amount", "" ] ] } ``` -* `request` tag: The job request event ID. +* `request`: The job request event stringified-JSON. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. ## Job feedback -Both customers and service providers can give feedback about a job. +Service providers can give feedback about a job back to the customer. -The result of the job SHOULD be included in the `content` field. +```json +{ + "kind": 65000, + "content": "", + "tags": [ + [ "status", "", "" ], + [ "amount", "requested-payment-amount", "" ], + [ "e", "", "" ], + [ "p", "" ], + ] +} +``` -* `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: as defined in the [Job Result](#job-result) section. +* `content`: Either empty or a job-result (e.g. for partial-result samples) +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 3](#appendix-3-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. +* `amount` tag: as defined in the [Job Result](#job-result) section. # Protocol Flow -* Customer publishes a job request (e.g. `kind:65002`). +* Customer publishes a job request (e.g. `kind:65002` speech-to-text). * Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. -* At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user `kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. @@ -137,16 +154,6 @@ Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcas } ``` -## Not addressed in this NIP - -### Reputation system -Service providers are at an obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e., building reputation systems, requiring npub "balances", etc.). It's out of scope (and undesirable) to have this NIP address this issue; the market should. - -### Encrypted job requests -Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: - * publish job requests with some useful metadata of the job "e.g., length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. - - # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. @@ -316,7 +323,7 @@ User publishes event #1 and #2 together. [ "bid", "500000" ] ] } -`` +``` ## AI-image of embedded input @@ -364,6 +371,43 @@ This is a list of all the supported job requests. | `prompt` | opt | extra prompt to be used for the image generation | | `size` | opt | desired size of the image | +## event list generation: `kind:65006` + +Generates a list of event ids, (e.g. algorithmic feeds, spam-free notifications, trending topics) + +Output should be a stringified array of elements usually find in a nostr event' `tags`, e.g.: + +```json +{ "content": "[ + [\"e\", \"\"], + [\"a\", \"30023:pubkey:id\"], + [\"t\", \"tag\"], + [\"p\", \"pubkey\"], +]" } +``` + +| param | req? | description | +|-----------|------|-------------------------------------------------------| +| `filter` | opt | JSON-stringified `REQ`-like filter +| `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. +| `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. + +### example job-request + +Generate an algorithmic feed of the most interesting `kind:1`s related to the topic "bitcoin", tagging service providers specializing in safe-for-work content +that would interest pubkey `pubkey1`. + +```json +{ + "kind": 65006, + "tags": [ + [ "param", "filter", "{ \"kinds\": [1], \"#t\": [\"bitcoin\"] }" ], + [ "param", "p", "[\"pubkey1\"]"] + [ "bid", "5000" ], + [ "t", "sfw" ] + ] +} +``` # Appendix 3: Job feedback status From 948ee24775fe89e779efe7680ca6a27dc5a6207f Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 17:20:24 +0300 Subject: [PATCH 017/192] rename file --- vending-machine.md => 90.md | 1 - README.md | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) rename vending-machine.md => 90.md (99%) diff --git a/vending-machine.md b/90.md similarity index 99% rename from vending-machine.md rename to 90.md index c41ccceb..99f313d4 100644 --- a/vending-machine.md +++ b/90.md @@ -417,7 +417,6 @@ that would interest pubkey `pubkey1`. | `processing` | Service Provider is processing the job. | | `error` | Service Provider was unable to process the job. | | `success` | Service Provider successfully processed the job. | -| `failure` | Service Provider failed to process the job. | | `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. diff --git a/README.md b/README.md index 9893ffcf..ebfd3596 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) +- [NIP-90: Data Vending Machines](90.md) - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) @@ -110,6 +111,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30078` | Application-specific Data | [78](78.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `65000` | Job Feedback | [90](90.md) | +| `65001` | Job Result | [90](90.md) | ### Event Kind Ranges @@ -119,6 +122,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10000`--`19999` | Replaceable Events | [16](16.md) | | `20000`--`29999` | Ephemeral Events | [16](16.md) | | `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) | +| `65002`--`66000` | Job Requests | [90](90.md) | ## Message types From 9fa9045d19b93f4cbac231bff39558108a6e82ae Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 17:31:31 +0300 Subject: [PATCH 018/192] remove duplicated output --- 90.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 99f313d4..51c49cf2 100644 --- a/90.md +++ b/90.md @@ -168,9 +168,8 @@ Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcas "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "params", "range", "900", "930" ], - [ "output", "text/vtt" ], + [ "output", "text/plain" ], [ "bid", "50000" ], - [ "output", "text/plain" ] ] } ``` @@ -388,7 +387,7 @@ Output should be a stringified array of elements usually find in a nostr event' | param | req? | description | |-----------|------|-------------------------------------------------------| -| `filter` | opt | JSON-stringified `REQ`-like filter +| `filter` | opt | Stringified JSON `REQ` filter. Used to scope the desired results (e.g. specify the desired kinds) | `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. | `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. From acafcc774d571867bde615423c758c51dba64fca Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Mon, 28 Aug 2023 16:25:43 +0900 Subject: [PATCH 019/192] NIP-38: description for content --- 38.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/38.md b/38.md index 378da1c5..010c14c3 100644 --- a/38.md +++ b/38.md @@ -57,3 +57,5 @@ Clients MAY display this next to the username on posts or profiles to provide li * Nostr music streaming services that update your music status when you're listening * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status + +The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji. If the `content` is an empty string then the client should clear the status. From 1aa9301a4a993cf7122ebb7761945d94dc4eadba Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Mon, 28 Aug 2023 21:10:07 +0900 Subject: [PATCH 020/192] update 38.md --- 38.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/38.md b/38.md index 010c14c3..f1eddcd8 100644 --- a/38.md +++ b/38.md @@ -58,4 +58,4 @@ Clients MAY display this next to the username on posts or profiles to provide li * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status -The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji. If the `content` is an empty string then the client should clear the status. +The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. From 8aa89367cd66e160b2bc2320362e87b3a4e71eac Mon Sep 17 00:00:00 2001 From: Luis Miguel Date: Tue, 5 Sep 2023 18:15:14 +0200 Subject: [PATCH 021/192] Micro-typo nip-58 --- 58.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/58.md b/58.md index d6bb27d6..ccabc7b6 100644 --- a/58.md +++ b/58.md @@ -11,7 +11,7 @@ user profiles: 1. A "Badge Definition" event is defined as a parameterized replaceable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated. -2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Define Badge" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. +2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. 3. A "Profile Badges" event is defined as a parameterized replaceable event with kind `30008` with a `d` tag with the value `profile_badges`. From 74611d2580004e8384b77048a346c2e0b2a47890 Mon Sep 17 00:00:00 2001 From: gsovereignty Date: Fri, 8 Sep 2023 16:09:02 +0800 Subject: [PATCH 022/192] Spelling and clarifcations --- 98.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/98.md b/98.md index ecbebc08..c8cba0f5 100644 --- a/98.md +++ b/98.md @@ -6,9 +6,9 @@ HTTP Auth `draft` `optional` `author:kieran` `author:melvincarvalho` -This NIP defines an ephemerial event used to authorize requests to HTTP servers using nostr events. +This NIP defines an ephemeral event used to authorize requests to HTTP servers using nostr events. -This is useful for HTTP services which are build for Nostr and deal with Nostr user accounts. +This is useful for HTTP services which are built for Nostr and deal with Nostr user accounts. ## Nostr event @@ -16,7 +16,7 @@ A `kind 27235` (In reference to [RFC 7235](https://www.rfc-editor.org/rfc/rfc723 The `content` SHOULD be empty. -The following tags are defined as REQUIRED. +The following tags MUST be included. * `u` - absolute URL * `method` - HTTP Request Method @@ -45,7 +45,7 @@ Example event: Servers MUST perform the following checks in order to validate the event: 1. The `kind` MUST be `27235`. -2. The `created_at` MUST be within a reasonable time window (suggestion 60 seconds). +2. The `created_at` timestamp MUST be within a reasonable time window (suggestion 60 seconds). 3. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters). 4. The `method` tag MUST be the same HTTP method used for the requested resource. @@ -53,11 +53,11 @@ When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD i If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code. -All other checks which server MAY do are OPTIONAL, and implementation specific. +Servers MAY perform additional implementation-specific validation checks. ## Request Flow -Using the `Authorization` header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` +Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` Example HTTP Authorization header: ``` @@ -65,4 +65,4 @@ Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA ``` ## Reference Implementations -- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) \ No newline at end of file +- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) From c567f2e4d6fa4e79585e83b6e6d9313217295582 Mon Sep 17 00:00:00 2001 From: Tiago Vasconcelos Date: Fri, 8 Sep 2023 13:10:59 +0100 Subject: [PATCH 023/192] Add description to event 30019 (#768) --- 15.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/15.md b/15.md index 01ef05bf..edece818 100644 --- a/15.md +++ b/15.md @@ -220,6 +220,28 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni "shipped": , } ``` +## Customize Marketplace +Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. + +### Event `30019`: Create or update marketplace UI/UX + +**Event Content**: +```json +{ + "name": , + "about": , + "ui": { + "picture": , + "banner": , + "theme": , + "darkMode": + }, + "merchants": <[String] (optional), array of pubkeys>, + ... +} +``` + +This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment. ## Customer support events From e3504024a279ae896394254f08c56a64d6722d97 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 8 Sep 2023 21:11:38 +0900 Subject: [PATCH 024/192] Clarify character case of m tag value (#767) --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 24dd346f..c1b322a2 100644 --- a/94.md +++ b/94.md @@ -13,7 +13,7 @@ The purpose of this NIP is to allow an organization and classification of shared This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: * `url` the url to download the file -* `m` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the file. * `size` (optional) size of file in bytes From 12238ebe2b234b7438864b521c0886471aa351a8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 11 Sep 2023 13:03:32 +0900 Subject: [PATCH 025/192] Remove description about NIP-12 --- 52.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/52.md b/52.md index 846fbf43..f5bd0adb 100644 --- a/52.md +++ b/52.md @@ -30,7 +30,7 @@ The list of tags are as follows: * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. * `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call -* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. @@ -88,7 +88,7 @@ The list of tags are as follows: * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` * `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. * `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call -* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. From 67cf855c8448c78010cd0d3ed8f19ddfeb1d2606 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 12 Sep 2023 09:50:25 -0300 Subject: [PATCH 026/192] Add tags to nip94 --- 94.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index c1b322a2..e34a576d 100644 --- a/94.md +++ b/94.md @@ -21,6 +21,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `magnet` (optional) URI to magnet file * `i` (optional) torrent infohash * `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client +* `preview` (optional) shorter file variant such as thumbnail, blurred image or text excerpt +* `caption` (optional) loose description not meant for accessibility ```json { @@ -37,7 +39,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["dim", ], ["magnet", ], ["i",], - ["blurhash", ] + ["blurhash", ], + ["preview", , ], + ["caption", ] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From de15edb04a7b6dc36bc6d5eaba26fb49e54b300e Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 12 Sep 2023 10:49:21 -0300 Subject: [PATCH 027/192] Invert caption and alt --- 94.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/94.md b/94.md index e34a576d..8e47c27d 100644 --- a/94.md +++ b/94.md @@ -22,7 +22,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `i` (optional) torrent infohash * `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client * `preview` (optional) shorter file variant such as thumbnail, blurred image or text excerpt -* `caption` (optional) loose description not meant for accessibility +* `alt` (optional) description for accessibility ```json { @@ -41,9 +41,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["i",], ["blurhash", ], ["preview", , ], - ["caption", ] + ["alt", ] ], - "content": , + "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } ``` From 30c799b00148c687b693331cd169c9ed20b93515 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Tue, 12 Sep 2023 11:58:34 -0300 Subject: [PATCH 028/192] Expand preview into other tags --- 94.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 8e47c27d..c5e0f182 100644 --- a/94.md +++ b/94.md @@ -21,7 +21,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `magnet` (optional) URI to magnet file * `i` (optional) torrent infohash * `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client -* `preview` (optional) shorter file variant such as thumbnail, blurred image or text excerpt +* `thumb` (optional) url of thumbnail with same aspect ratio +* `image` (optional) url of preview image with same dimensions +* `summary` (optional) text excerpt * `alt` (optional) description for accessibility ```json @@ -40,7 +42,9 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["magnet", ], ["i",], ["blurhash", ], - ["preview", , ], + ["thumb", ], + ["image", ], + ["summary", ], ["alt", ] ], "content": , From cf764ee7e5922167d944752678d2d8ab10314d3d Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Thu, 14 Sep 2023 12:04:02 -0300 Subject: [PATCH 029/192] Add xx tag --- 94.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index c5e0f182..b512af4c 100644 --- a/94.md +++ b/94.md @@ -15,7 +15,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits -* `x` containing the SHA-256 hexencoded string of the file. +* `x` containing the SHA-256 hexencoded string of the **original** file before any server transformations +* `xx` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file @@ -37,6 +38,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["aes-256-gcm",, ], ["m", ], ["x",], + ["xx",], ["size", ], ["dim", ], ["magnet", ], From 01b6bfc28666db4b259556bf55c9269ca0c059d5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 20 Sep 2023 21:05:32 +0900 Subject: [PATCH 030/192] Update tag list (#778) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5beff919..98f6ddb7 100644 --- a/README.md +++ b/README.md @@ -161,12 +161,13 @@ Please update these lists when proposing NIPs introducing new event kinds. | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | | `d` | identifier | -- | [01](01.md) | -| `alt` | Alt tag | -- | [31](31.md) | +| `alt` | summary | -- | [31](31.md) | | `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | | `r` | a reference (URL, etc) | petname | | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | @@ -175,8 +176,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `challenge` | challenge string | -- | [42](42.md) | | `content-warning` | reason | -- | [36](36.md) | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | badge description | -- | [58](58.md) | -| `description` | invoice description | -- | [57](57.md) | +| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | From 44c21c9d82dfa9fbe04655668c03400fa0ac1e34 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 24 Sep 2023 16:48:55 -0300 Subject: [PATCH 031/192] add nip-24: extra metadata fields. --- 24.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 24.md diff --git a/24.md b/24.md new file mode 100644 index 00000000..fb653f4e --- /dev/null +++ b/24.md @@ -0,0 +1,24 @@ +NIP-24 +====== + +Extra metadata fields and tags +------------------------------ + +`draft` `optional` `author:fiatjaf` + +This NIP defines extra optional fields added to events. + +kind 0 +====== + +These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events: + + - `display_name`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available. + - `website`: a web URL related in any way to the event author. + +tags +==== + +These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: + + - `r`: a web URL the event is referring to in some way From f3bafe5f872be937060071585296b62584a4f416 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 24 Sep 2023 19:48:05 -0300 Subject: [PATCH 032/192] `banner` and deprecated names. --- 24.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/24.md b/24.md index fb653f4e..cb5d8982 100644 --- a/24.md +++ b/24.md @@ -15,6 +15,14 @@ These are extra fields not specified in NIP-01 that may be present in the string - `display_name`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available. - `website`: a web URL related in any way to the event author. + - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. + +### Deprecated fields + +These are fields that should be ignored or removed when found in the wild: + + - `displayName`: use `display_name` instead. + - `username`: use `name` instead. tags ==== From cc1e73b1866ab2b7da860dcbb982eaa87a9f44ea Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 27 Sep 2023 12:20:41 -0300 Subject: [PATCH 033/192] Revert x and xx tags --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index b512af4c..ed9b68c9 100644 --- a/94.md +++ b/94.md @@ -15,8 +15,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits -* `x` containing the SHA-256 hexencoded string of the **original** file before any server transformations -* `xx` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations +* `x` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations +* `xx` containing the SHA-256 hexencoded string of the **original** file before any server transformations * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file From 3e2765b774e985f17cf8eead360f78dee0bf5fc4 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 27 Sep 2023 12:23:38 -0300 Subject: [PATCH 034/192] Rename xx to ox --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index ed9b68c9..77944a04 100644 --- a/94.md +++ b/94.md @@ -16,7 +16,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations -* `xx` containing the SHA-256 hexencoded string of the **original** file before any server transformations +* `ox` containing the SHA-256 hexencoded string of the **original** file before any server transformations * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file @@ -38,7 +38,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["aes-256-gcm",, ], ["m", ], ["x",], - ["xx",], + ["ox",], ["size", ], ["dim", ], ["magnet", ], From 4b2cd78defb1564bdc534c01f7f0f6cd230077f8 Mon Sep 17 00:00:00 2001 From: arthurfranca Date: Wed, 27 Sep 2023 12:59:33 -0300 Subject: [PATCH 035/192] Remove ox tag --- 94.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/94.md b/94.md index 77944a04..c5e0f182 100644 --- a/94.md +++ b/94.md @@ -15,8 +15,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits -* `x` containing the SHA-256 hexencoded string of the **transformed** file after any server transformations -* `ox` containing the SHA-256 hexencoded string of the **original** file before any server transformations +* `x` containing the SHA-256 hexencoded string of the file. * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `x` * `magnet` (optional) URI to magnet file @@ -38,7 +37,6 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["aes-256-gcm",, ], ["m", ], ["x",], - ["ox",], ["size", ], ["dim", ], ["magnet", ], From cf144593f1d350dabb61aa808b36118a6b3b03ec Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 28 Sep 2023 19:24:36 +0900 Subject: [PATCH 036/192] Add relay list of kind 3 to NIP-24 (#795) (as deprecated) --- 24.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/24.md b/24.md index cb5d8982..5f94a2b1 100644 --- a/24.md +++ b/24.md @@ -24,6 +24,17 @@ These are fields that should be ignored or removed when found in the wild: - `displayName`: use `display_name` instead. - `username`: use `name` instead. +kind 3 +====== + +These are extra fields not specified in NIP-02 that may be present in the stringified JSON of contacts events: + +### Deprecated fields + +These are fields that should be ignored or removed when found in the wild: + + - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write, but in favor of [NIP-65](65.md). + tags ==== From 84f1915cecc10cfca6584eacfbeecb35bddc65f9 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 28 Sep 2023 08:07:30 -0300 Subject: [PATCH 037/192] less aggressive wording for kind3 relay list deprecation. --- 24.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/24.md b/24.md index 5f94a2b1..dee9daa3 100644 --- a/24.md +++ b/24.md @@ -31,9 +31,7 @@ These are extra fields not specified in NIP-02 that may be present in the string ### Deprecated fields -These are fields that should be ignored or removed when found in the wild: - - - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write, but in favor of [NIP-65](65.md). + - `{: {"read": , "write": }, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead. tags ==== From 5eb51d5278f758d92a4fd5ab881dfb30199df412 Mon Sep 17 00:00:00 2001 From: git Date: Thu, 28 Sep 2023 13:02:03 -0700 Subject: [PATCH 038/192] 65: trim slashes --- 65.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/65.md b/65.md index 3c064385..89fc5941 100644 --- a/65.md +++ b/65.md @@ -59,3 +59,5 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 4. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy. 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. + +6. Clients SHOULD trim trailing slashes (`/`) from relay URIs to canonicalize connections. From 423dda195b5251ffac5ec82c4129fe2f916c4d2b Mon Sep 17 00:00:00 2001 From: Keyan <34140557+huumn@users.noreply.github.com> Date: Thu, 28 Sep 2023 15:43:03 -0500 Subject: [PATCH 039/192] update nip-57 zap receipt spec to include 'a' tag --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 729d585e..8e2be1b2 100644 --- a/57.md +++ b/57.md @@ -128,7 +128,7 @@ The following should be true of the `zap receipt` event: - The `content` SHOULD be empty. - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. -- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request`. +- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request`. - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. - The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description. - `SHA256(description)` MUST match the description hash in the bolt11 invoice. From 3b5d3ca677829333779bb46874bb0dc816283dc9 Mon Sep 17 00:00:00 2001 From: git Date: Fri, 29 Sep 2023 11:46:30 -0700 Subject: [PATCH 040/192] 65: normalize relay uri --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 89fc5941..352ee28d 100644 --- a/65.md +++ b/65.md @@ -60,4 +60,4 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. -6. Clients SHOULD trim trailing slashes (`/`) from relay URIs to canonicalize connections. +6. Clients SHOULD deduplicate connections by normalizing relay URIs according to RFC 2616. From 4de43f65a1bc5f312dba039d8b405358ad1f7397 Mon Sep 17 00:00:00 2001 From: git Date: Fri, 29 Sep 2023 12:00:07 -0700 Subject: [PATCH 041/192] Update RFC reference --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 352ee28d..49d1d170 100644 --- a/65.md +++ b/65.md @@ -60,4 +60,4 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. -6. Clients SHOULD deduplicate connections by normalizing relay URIs according to RFC 2616. +6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 6455](https://www.rfc-editor.org/rfc/rfc6455.html#section-3). From b33409c099b4d08278c95beda0f42ba76f55c32c Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 29 Sep 2023 15:47:04 -0300 Subject: [PATCH 042/192] make it clear that relays can keep multiple replaceable event versions. --- 01.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index d822bfbc..2b28f23f 100644 --- a/01.md +++ b/01.md @@ -82,12 +82,14 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded. In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. +When answering to `REQ` messages for replaceable events such as `{"kinds":[0],"authors":[]}`, even if the relay has more than one version stored, it SHOULD return just the latest one. + These are just conventions and relay implementations may differ. ## Communication between clients and relays From 0d267aab5a74a7f63275f47ceb3c2773ce437f97 Mon Sep 17 00:00:00 2001 From: git Date: Mon, 2 Oct 2023 15:34:24 -0700 Subject: [PATCH 043/192] Better RFC reference --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 49d1d170..b6760290 100644 --- a/65.md +++ b/65.md @@ -60,4 +60,4 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. -6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 6455](https://www.rfc-editor.org/rfc/rfc6455.html#section-3). +6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). From aa1bf6d26845a025541b5d37c8df1cfab00c58fe Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 6 Oct 2023 07:11:23 +0900 Subject: [PATCH 044/192] Add NIP-24 to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 98f6ddb7..1097bc55 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) +- [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) From e9f8bc27b7f14355a3c4a321e4368046125a3dc0 Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Tue, 10 Oct 2023 20:12:21 +0300 Subject: [PATCH 045/192] add spring.site to nip-07 (#810) Add Spring.site as NIP07 implementation --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index ee4e3722..0c8c4027 100644 --- a/07.md +++ b/07.md @@ -33,3 +33,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) - [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) - [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) +- [Spring Browser](https://spring.site) (Android) From 21c6c12c524cb71f18e068c9bcf223cda0214b5f Mon Sep 17 00:00:00 2001 From: Vic <88121568+vicariousdrama@users.noreply.github.com> Date: Wed, 11 Oct 2023 00:57:12 -0400 Subject: [PATCH 046/192] Update 57.md (#808) Clarify how multiple relays should be included in the zap request event --- 57.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index 8e2be1b2..849c8696 100644 --- a/57.md +++ b/57.md @@ -45,7 +45,7 @@ Example: "kind": 9734, "content": "Zap!", "tags": [ - ["relays", "wss://nostr-pub.wellorder.com"], + ["relays", "wss://nostr-pub.wellorder.com", "wss://anotherrelay.example.com"], ["amount", "21000"], ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"], ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"], @@ -66,7 +66,7 @@ A signed `zap request` event is not published, but is instead sent using a HTTP - `nostr` is the `9734` `zap request` event, JSON encoded then URI encoded - `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl` -This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize his zap. Here is an example flow: +This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize his zap. Here is an example flow in javascript: ```javascript const senderPubkey // The sender's pubkey From 324c7aafdcd316fb971c1f26b964d2b53c939a10 Mon Sep 17 00:00:00 2001 From: Don Date: Wed, 11 Oct 2023 20:55:27 +0900 Subject: [PATCH 047/192] Change wording to imply that reactions can target any event (#815) * kind:17 generic reactions. * `kind 7` is available for all kind events. * `k` tag is not required. --- 25.md | 6 +++- README.md | 82 +++++++++++++++++++++++++++---------------------------- 2 files changed, 46 insertions(+), 42 deletions(-) diff --git a/25.md b/25.md index 63c07a73..7b29140a 100644 --- a/25.md +++ b/25.md @@ -7,7 +7,7 @@ Reactions `draft` `optional` `author:jb55` -A reaction is a `kind 7` note that is used to react to other notes. +A reaction is a `kind 7` event that is used to react to other events. The generic reaction, represented by the `content` set to a `+` string, SHOULD be interpreted as a "like" or "upvote". @@ -34,6 +34,9 @@ The last `e` tag MUST be the `id` of the note that is being reacted to. The last `p` tag MUST be the `pubkey` of the event being reacted to. +The reaction event MAY include a `k` tag with the stringified kind number +of the reacted event as its value. + Example code ```swift @@ -43,6 +46,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost } tags.append(["e", liked.id]) tags.append(["p", liked.pubkey]) + tags.append(["k", liked.kind]) let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) ev.calculate_id() ev.sign(privkey: privkey) diff --git a/README.md b/README.md index 1097bc55..dc708873 100644 --- a/README.md +++ b/README.md @@ -156,47 +156,47 @@ Please update these lists when proposing NIPs introducing new event kinds. ## Standardized Tags -| name | value | other parameters | NIP | -| ----------------- | ------------------------------------ | -------------------- | ------------------------ | -| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `a` | coordinates to an event | relay URL | [01](01.md) | -| `d` | identifier | -- | [01](01.md) | -| `alt` | summary | -- | [31](31.md) | -| `g` | geohash | -- | [52](52.md) | -| `i` | identity | proof | [39](39.md) | -| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | -| `l` | label, label namespace | annotations | [32](32.md) | -| `L` | label namespace | -- | [32](32.md) | -| `m` | MIME type | -- | [94](94.md) | -| `r` | a reference (URL, etc) | petname | | -| `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | | -| `amount` | millisatoshis, stringified | -- | [57](57.md) | -| `bolt11` | `bolt11` invoice | -- | [57](57.md) | -| `challenge` | challenge string | -- | [42](42.md) | -| `content-warning` | reason | -- | [36](36.md) | -| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | -| `emoji` | shortcode, image URL | -- | [30](30.md) | -| `expiration` | unix timestamp (string) | -- | [40](40.md) | -| `goal` | event id (hex) | relay URL | [75](75.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | -| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | badge name | -- | [58](58.md) | -| `nonce` | random | -- | [13](13.md) | -| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | -| `price` | price | currency, frequency | [99](99.md) | -| `proxy` | external ID | protocol | [48](48.md) | -| `published_at` | unix timestamp (string) | -- | [23](23.md) | -| `relay` | relay url | -- | [42](42.md) | -| `relays` | relay list | -- | [57](57.md) | -| `subject` | subject | -- | [14](14.md) | -| `summary` | article summary | -- | [23](23.md) | -| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | -| `title` | article title | -- | [23](23.md) | -| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | -------------------- | ------------------------------------- | +| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | +| `alt` | summary | -- | [31](31.md) | +| `g` | geohash | -- | [52](52.md) | +| `i` | identity | proof | [39](39.md) | +| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | +| `l` | label, label namespace | annotations | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `r` | a reference (URL, etc) | petname | | +| `r` | relay url | marker | [65](65.md) | +| `t` | hashtag | -- | | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | badge name | -- | [58](58.md) | +| `nonce` | random | -- | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `relay` | relay url | -- | [42](42.md) | +| `relays` | relay list | -- | [57](57.md) | +| `subject` | subject | -- | [14](14.md) | +| `summary` | article summary | -- | [23](23.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From 09ffb951c69343312486aaff2726dca04bc42f6e Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Wed, 11 Oct 2023 10:17:43 -0300 Subject: [PATCH 048/192] rework NIP-03 so it is actually usable (#804) * rework nip-03 to be actually useful and usable. * fixes. * add ots verification flow. --- 03.md | 33 +++++++++++++++++++++++---------- README.md | 1 + 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/03.md b/03.md index 3c5d764e..4faf3f15 100644 --- a/03.md +++ b/03.md @@ -4,20 +4,33 @@ NIP-03 OpenTimestamps Attestations for Events -------------------------------------- -`draft` `optional` `author:fiatjaf` +`draft` `optional` `author:fiatjaf` `author:constant` -When there is an OTS available it MAY be included in the existing event body under the `ots` key: +This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps](https://opentimestamps.org/) proof for any other event: -``` +```json { - "id": ..., - "kind": ..., - ..., - ..., - "ots": + "kind": 1040 + "tags": [ + ["e", , ], + ["block", , ], + ["alt", "opentimestamps attestation"] + ], + "content": } ``` -The _event id_ MUST be used as the raw hash to be included in the OpenTimestamps merkle tree. +- The OpenTimestamps proof MUST prove the referenced `e` event id as its digest. +- The `block` tag is optional, it exists to establish a minimum date since which the given event has existed. +- The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation and no reference to "pending" attestations since they are useless in this context. -The attestation can be either provided by relays automatically (and the OTS binary contents just appended to the events it receives) or by clients themselves when they first upload the event to relays β€” and used by clients to show that an event is really "at least as old as [OTS date]". +### Example OpenTimestamps proof verification flow + +Using [`nak`](https://github.com/fiatjaf/nak), [`jq`](https://jqlang.github.io/jq/) and [`ots`](https://github.com/fiatjaf/ots): + +```bash +~> nak req -i e71c6ea722987debdb60f81f9ea4f604b5ac0664120dd64fb9d23abc4ec7c323 wss://nostr-pub.wellorder.net | jq -r .content | ots verify +> using an esplora server at https://blockstream.info/api +- sequence ending on block 810391 is valid +timestamp validated at block [810391] +``` diff --git a/README.md b/README.md index dc708873..e9f08bdb 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `1063` | File Metadata | [94](94.md) | | `1311` | Live Chat Message | [53](53.md) | +| `1040` | OpenTimestamps | [03](03.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | From 202e18f2b256646148805880ed58731c1c8b2b9b Mon Sep 17 00:00:00 2001 From: Mike O'Bank <111360219+mikeobank@users.noreply.github.com> Date: Thu, 12 Oct 2023 15:31:58 +0200 Subject: [PATCH 049/192] Nip 06 test vectors (#819) --- 06.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/06.md b/06.md index 4ae571f7..a0b4a01b 100644 --- a/06.md +++ b/06.md @@ -13,3 +13,19 @@ Basic key derivation from mnemonic seed phrase A basic client can simply use an `account` of `0` to derive a single key. For more advanced use-cases you can increment `account`, allowing generation of practically infinite keys from the 5-level path with hardened derivation. Other types of clients can still get fancy and use other derivation paths for their own other purposes. + +### Test vectors + +mnemonic: leader monkey parrot ring guide accident before fence cannon height naive bean\ +private key (hex): 7f7ff03d123792d6ac594bfa67bf6d0c0ab55b6b1fdb6249303fe861f1ccba9a\ +nsec: nsec10allq0gjx7fddtzef0ax00mdps9t2kmtrldkyjfs8l5xruwvh2dq0lhhkp\ +public key (hex): 17162c921dc4d2518f9a101db33695df1afb56ab82f5ff3e5da6eec3ca5cd917\ +npub: npub1zutzeysacnf9rru6zqwmxd54mud0k44tst6l70ja5mhv8jjumytsd2x7nu + +--- + +mnemonic: what bleak badge arrange retreat wolf trade produce cricket blur garlic valid proud rude strong choose busy staff weather area salt hollow arm fade\ +private key (hex): c15d739894c81a2fcfd3a2df85a0d2c0dbc47a280d092799f144d73d7ae78add\ +nsec: nsec1c9wh8xy5eqdzln7n5t0ctgxjcrdug73gp5yj0x03gntn67h83twssdfhel\ +public key (hex): d41b22899549e1f3d335a31002cfd382174006e166d3e658e3a5eecdb6463573\ +npub: npub16sdj9zv4f8sl85e45vgq9n7nsgt5qphpvmf7vk8r5hhvmdjxx4es8rq74h From d9400e1e7b08225aedb6c78b522c5ad07b5198b4 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Sat, 14 Oct 2023 16:14:24 +0300 Subject: [PATCH 050/192] big refactor * use different kinds per response type * remove examples * remove specific job request definitions, moved to a separate repo for clarity --- 90.md | 383 +++++++++------------------------------------------------- 1 file changed, 58 insertions(+), 325 deletions(-) diff --git a/90.md b/90.md index 51c49cf2..4c0eff6a 100644 --- a/90.md +++ b/90.md @@ -4,22 +4,24 @@ NIP-90 Data Vending Machine -------------------- -`draft` `optional` `author:pablof7z` +`draft` `optional` `author:pablof7z` `author:dontbelievethehype` This NIP defines the interaction between customers and Service Providers for performing on-demand computation. Money in, data out. ## Kinds -This NIP reserves the range `65000-66000` for data vending machine use. +This NIP reserves the range `5000-7000` for data vending machine use. | Kind | Description | | ---- | ----------- | -| 65000 | Job feedback | -| 65001 | Job result | -| 65002-66000 | Job request kinds | +| 5000-5999 | Job request kinds | +| 6000-6999 | Job result | +| 7000 | Job feedback | -[Appendix 2](#appendix-2-job-types) defines the job request types. +Job results always use a kind number that is `1000` higher than the job request kind. (e.g. request: `kind:5001` gets a result: `kind:6001`). + +Job request types are defined [separately](https://github.com/nostr-protocol/data-vending-machines/tree/master/kinds). ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. @@ -31,21 +33,15 @@ There are two actors in the workflow described in this NIP: * Customers (npubs who request a job) * Service providers (npubs who fulfill jobs) -# Event Kinds - -* `kind:65000`: job feedback -* `kind:65001`: job result -* `kind:65002`-`kind:66000`: job requests - -## Job request -A request to have data processed, published by a customer. This event signals that an npub is interested in receiving the result of some kind of compute. +## Job request (`kind:5000-5999`) +A request to process data, published by a customer. This event signals that an customer is interested in receiving the result of some kind of compute. ```json { - "kind": 65xxx, // kind in 65002-66000 range + "kind": 5xxx, // kind in 5000-5999 range "content": "", "tags": [ - [ "i", "", "", "", "" ], + [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], [ "bid", "" ], @@ -59,20 +55,19 @@ All tags are optional. * `i` tag: Input data for the job (zero or more inputs) * ``: The argument for the input * ``: The way this argument should be interpreted. MUST be one of: - * `url`: A URL to be fetched + * `url`: A URL to be fetched of the data that should be processed. * `event`: A Nostr event ID. - * `job`: The output of a previous job with the specified event ID + * `job`: The output of a previous job with the specified event ID. The dermination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.) * `text`: `` is the value of the input, no resolution is needed - * ``: An optional field indicating how this input should be used within the context of the job * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string -* `output`: Expected output format. (e.g. MIME type) - * Service Providers MUST publish the result of the job in this format if it has been specified. - * Each job-type ([Appendix 2](#appendix-2-job-types)) might define the output format more narrowly. + * ``: An optional field indicating how this input should be used within the context of the job +* `output`: Expected output format. Different job request `kind` defines this more precisely. +* `param`: Optional parameters for the job as key (first argument)/value (second argument). Different job request `kind` defines this more precisely. (e.g. `[ "param", "lang", "es" ]`) * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay * `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -## Job result +## Job result (`kind:6000-6999`) Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. @@ -80,10 +75,11 @@ Service providers publish job results, providing the output of the job result. T { "pubkey": "", "content": "", - "kind": 65001, + "kind": 6xxx, "tags": [ [ "request", "" ], [ "e", "", "" ], + [ "i", "" ], [ "p", "" ], [ "amount", "requested-payment-amount", "" ] ] @@ -92,13 +88,14 @@ Service providers publish job results, providing the output of the job result. T * `request`: The job request event stringified-JSON. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. +* `i`: The original input(s) specified in the request. ## Job feedback Service providers can give feedback about a job back to the customer. ```json { - "kind": 65000, + "kind": 7000, "content": "", "tags": [ [ "status", "", "" ], @@ -110,305 +107,10 @@ Service providers can give feedback about a job back to the customer. ``` * `content`: Either empty or a job-result (e.g. for partial-result samples) -* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 3](#appendix-3-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. * `amount` tag: as defined in the [Job Result](#job-result) section. +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 1](#appendix-1-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. -# Protocol Flow -* Customer publishes a job request (e.g. `kind:65002` speech-to-text). -* Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). -* Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. -* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user - -`kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. - -## Notes about the protocol flow -The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. - -Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering `kind:65001` results, some might choose to serve partial results for the job (e.g. as a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. - -It's not up to this NIP to define how individual vending machines should choose to run their business. - -# Cancellation -A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. - -# Job chaining -A Customer MAY request multiple jobs to be processed as a chain, where the output of a job can be the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. - -Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. - -This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). - -Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcast](#summarization-of-a-podcast) - -### E.g. Payment required (with sample content) -```json -{ - "kind": 65000, - "content": "This is the transcription service that you", - "tags": [ - [ "e", , ], - [ "p", ], - [ "status", "payment-required" ], - [ "amount", "7000" ], - ] -} -``` - -# Appendix 1: Examples - -## Transcript of a podcast from second `900` to `930`. - -### `kind:65002`: Speech-to-text job request -```json -{ - "id": "12345", - "pubkey": "abcdef", - "content": "", - "kind": 65002, - "tags": [ - [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "params", "range", "900", "930" ], - [ "output", "text/plain" ], - [ "bid", "50000" ], - ] -} -``` - -### `kind:65000`: Job Feedback: request for (partial) payment -* The SP is signaling here that it won't start processing until 100 sats are paid -```json -{ - "kind": 65000, - "content": "", - "tags": [ - ["e", "12345"], - ["p", "abcdef"], - ["status", "payment-required"], - ["amount", "100000"] - ] -} -``` - -* User zaps 100 sats to the `kind:65000` job-feedback - -### `kind:65001`: Job result + request for remaining payment -```json -{ - "content": "blah blah blah", - "tags": [ - ["e", "12345"], - ["p", "abcdef"], - ["amount", "400000"] - ] -} -``` - -## Summarization of a podcast -User publishes two job requests at the same time. A job that transcribes an audio and a job that summarizes the transcription (output of job #1). - -User publishes event #1 and #2 together. - -### `kind:65002`: Job Request #1: speech-to-text -```json -{ - "id": "12345", - "pubkey": "abcdef", - "kind": 65002, - "content": "", - "tags": [ - [ "i", "https://bitcoin.review/episode1.mp3", "url" ], - [ "output", "text/plain" ], - [ "params", "range", "900", "930" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65002`: Job Request #2: summarization of job #1's result -```json -{ - "id": "12346", - "pubkey": "abcdef", - "kind": 65003, - "content": "", - "tags": [ - [ "i", "12345", "job" ], // input is the output of job with id 12345 - [ "output", "text/plain" ], - [ "params", "length", "3 paragraphs" ], - [ "bid", "10000" ] - ] -} -``` - -## Translation of a note -### `kind:65004`: Job Request #1: translation of an existing note -```json -{ - "id": "12346", - "pubkey": "abcdef", - "content": "", - "kind": 65004, - "tags": [ - [ "i", "", "event", "wss://relay.nostr.com" ] - [ "output", "text/plain" ], - [ "params", "lang", "es_AR" ], - [ "bid", "5000" ] - ] -} -``` - -### `kind:65001`: Job result -```json -{ - "kind": 65001, - "content": "Che, que copado, boludo!", - "tags": [ - ["e", "12346"], - ["p", "abcdef"], - ["amount", "4000"] - ] -} -``` - -## AI-image of the summarization of 2 podcasts - -### `kind:65002`: Job request #1 (transcribe podcast #1) -```json -{ - "id": "123", - "kind": 65002, - "tags": [ - [ "i", "https://example.com/episode1.mp3", "url" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65002`: Job request #2 (transcribe podcast #2) -```json -{ - "id": "124", - "kind": 65002, - "tags": [ - [ "i", "https://example.com/episode2.mp3", "url" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65003`: Job request #3 (summarize the two job's outputs into one paragraph) -```json -{ - "id": "125", - "kind": 65003, - "tags": [ - [ "param", "length", "1 paragraph" ], - [ "i", "123", "job" ], - [ "i", "124", "job" ], - [ "bid", "100000" ] - ] -} -``` - -### `kind:65005`: Job request #4 (generate image based on the summary) -```json -{ - "id": "126", - "kind": 65004, - "tags": [ - [ "i", "125", "job" ], - [ "param", "prompt", "photorealistic" ], - [ "param", "size", "4000x4000" ], - [ "bid", "500000" ] - ] -} -``` - -## AI-image of embedded input - -### `kind:65005`: Job request -```json -{ - "kind": 65004, - "tags": [ - [ "i", "Millions of vending machines, interconnected with tubes with eah other", "text" ], - [ "param", "prompt", "photorealistic" ], - [ "bid", "500000" ] - ] -} -``` - -# Appendix 2: Job types - -This is a list of all the supported job requests. - -## speech-to-text: `kind:65002` - -### params - -| param | req? | description | -|------------|------|-----------------------------------------------------------| -| `range` | opt | timestamp range (in seconds) of desired text to be transcribed | -| `alignment`| opt | word, segment, raw: word-level, segment-level, or raw outputs | - -## summarization: `kind:65003` - -| param | req? | description | -|-----------|------|---------------| -| `length` | opt | desired length | - -## translation: `kind:65004` - -| param | req? | description | -|-----------|------|--------------------------------------------| -| `lang` | req | desired language in BCP 47 format. | - -## image generation: `kind:65005` - -| param | req? | description | -|-----------|------|-------------------------------------------------------| -| `prompt` | opt | extra prompt to be used for the image generation | -| `size` | opt | desired size of the image | - -## event list generation: `kind:65006` - -Generates a list of event ids, (e.g. algorithmic feeds, spam-free notifications, trending topics) - -Output should be a stringified array of elements usually find in a nostr event' `tags`, e.g.: - -```json -{ "content": "[ - [\"e\", \"\"], - [\"a\", \"30023:pubkey:id\"], - [\"t\", \"tag\"], - [\"p\", \"pubkey\"], -]" } -``` - -| param | req? | description | -|-----------|------|-------------------------------------------------------| -| `filter` | opt | Stringified JSON `REQ` filter. Used to scope the desired results (e.g. specify the desired kinds) -| `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. -| `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. - -### example job-request - -Generate an algorithmic feed of the most interesting `kind:1`s related to the topic "bitcoin", tagging service providers specializing in safe-for-work content -that would interest pubkey `pubkey1`. - -```json -{ - "kind": 65006, - "tags": [ - [ "param", "filter", "{ \"kinds\": [1], \"#t\": [\"bitcoin\"] }" ], - [ "param", "p", "[\"pubkey1\"]"] - [ "bid", "5000" ], - [ "t", "sfw" ] - ] -} -``` - -# Appendix 3: Job feedback status +### Job feedback status | status | description | |--------|-------------| @@ -420,16 +122,47 @@ that would interest pubkey `pubkey1`. Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. -# Appendix 4: Service provider discoverability -Service Providers can use NIP-89 announcements to advertise their support for job kinds: +# Protocol Flow +* Customer publishes a job request (e.g. `kind:5000` speech-to-text). +* Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event. +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user + +Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers MUST use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. + +Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. + +## Notes about the protocol flow +The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. + +Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering results, some might choose to serve partial results for the job (e.g. a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. + +It's not up to this NIP to define how individual vending machines should choose to run their business. + +# Cancellation +A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. + +# Appendix 1: Job chaining +A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. + +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. + +This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). + +# Appendix 2: Service provider discoverability +Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: ```json { "kind": 31990, "pubkey": "", + "content": "{ + \"name\": \"Translating DVM\", + \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" + }", "tags": [ - [ "k", 65002 ], // e.g. speech-to-text + [ "k", 5005 ], // e.g. translation [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" ] } From 142cb8d655d411628517b44a1cbafdc8c1fbcc68 Mon Sep 17 00:00:00 2001 From: starbuilder <101296187+starbackr-dev@users.noreply.github.com> Date: Sun, 15 Oct 2023 10:44:07 -0400 Subject: [PATCH 051/192] Update 90.md Added optional Encryption to params and payload if the user require the input and output to be a secret. --- 90.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/90.md b/90.md index 4c0eff6a..7de34fc9 100644 --- a/90.md +++ b/90.md @@ -67,6 +67,37 @@ All tags are optional. * `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job +## Encrypted Params + +If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. The user also indicates whether the output should be encrypted or not as one of the parameters. + +```json +[ + [ "i", "what is the capital of France? ", "prompt" ], + [ "param", "model", "LLaMA-2" ], + [ "param", "max_tokens", "512" ], + [ "param", "temperature", "0.5" ], + [ "param", "top-k", "50" ], + [ "param", "top-p", "0.7" ], + [ "param", "frequency_penalty", "1" ], + [ "param", "output", "encrypted"] +] + +``` + +This param data will be encrypted and added to the `content` field and `p` tag should be present + +``` +"content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", + "tags": [ + [`p`, `04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f`] + + ] + + +``` + + ## Job result (`kind:6000-6999`) Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. @@ -110,6 +141,8 @@ Service providers can give feedback about a job back to the customer. * `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. +* NOTE: If the input params requires input to be encryped, then `content` field will have encrypted payload with `p` tag as key. + ### Job feedback status | status | description | @@ -168,4 +201,4 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo } ``` -Customers can use NIP-89 to see what service providers their follows use. \ No newline at end of file +Customers can use NIP-89 to see what service providers their follows use. From 9f4a4cf9d2f0a626fc2a341cff6d7f66d73c12e4 Mon Sep 17 00:00:00 2001 From: starbuilder <101296187+starbackr-dev@users.noreply.github.com> Date: Sun, 15 Oct 2023 14:59:13 -0400 Subject: [PATCH 052/192] Update 90.md changed `prompt` to 'text` --- 90.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/90.md b/90.md index 7de34fc9..a55d4915 100644 --- a/90.md +++ b/90.md @@ -73,7 +73,7 @@ If the user wants to keep the input parameters a secret, they can encrypt the `i ```json [ - [ "i", "what is the capital of France? ", "prompt" ], + [ "i", "what is the capital of France? ", "text" ], [ "param", "model", "LLaMA-2" ], [ "param", "max_tokens", "512" ], [ "param", "temperature", "0.5" ], From cf672b764bdcb6c33361203c206d5d52270c22ec Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 17 Oct 2023 07:38:53 -0300 Subject: [PATCH 053/192] remove useless "block" tag on OTS. --- 03.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/03.md b/03.md index 4faf3f15..680cc8b2 100644 --- a/03.md +++ b/03.md @@ -13,7 +13,6 @@ This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps]( "kind": 1040 "tags": [ ["e", , ], - ["block", , ], ["alt", "opentimestamps attestation"] ], "content": @@ -21,7 +20,6 @@ This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps]( ``` - The OpenTimestamps proof MUST prove the referenced `e` event id as its digest. -- The `block` tag is optional, it exists to establish a minimum date since which the given event has existed. - The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation and no reference to "pending" attestations since they are useless in this context. ### Example OpenTimestamps proof verification flow From 4216f0bf2f73b4a395568b6874132aca94f55094 Mon Sep 17 00:00:00 2001 From: Egge Date: Thu, 19 Oct 2023 14:27:56 +0200 Subject: [PATCH 054/192] added nodestr --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 0c8c4027..a9b6b343 100644 --- a/07.md +++ b/07.md @@ -34,3 +34,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) - [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) - [Spring Browser](https://spring.site) (Android) +- [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill) From ca73c5dd5ea19dec29a2781f1d3bd93ef95985f9 Mon Sep 17 00:00:00 2001 From: Mike O'Bank <111360219+mikeobank@users.noreply.github.com> Date: Fri, 20 Oct 2023 22:56:29 +0200 Subject: [PATCH 055/192] Clarify Unsigned Event Object type --- 07.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/07.md b/07.md index a9b6b343..24d8d456 100644 --- a/07.md +++ b/07.md @@ -12,7 +12,7 @@ That object must define the following methods: ``` async window.nostr.getPublicKey(): string // returns a public key as hex -async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it +async window.nostr.signEvent(event: { created_at: number, kind: number, tags: string[][], content: string }): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it ``` Aside from these two basic above, the following functions can also be implemented optionally: From 435147149af83cbdbb7a183b9d8769ed1dbb717d Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Sun, 29 Oct 2023 11:45:49 +0100 Subject: [PATCH 056/192] update readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6f9cb03c..8044b243 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | +| `7000` | Job Feedback | [90](90.md) | | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | From ad019ee0670c766b467028e7a55994cea4093a4a Mon Sep 17 00:00:00 2001 From: Akiomi Kamakura Date: Mon, 30 Oct 2023 11:00:57 +0900 Subject: [PATCH 057/192] DVM kinds change on README (#850) --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 8044b243..8be05951 100644 --- a/README.md +++ b/README.md @@ -130,8 +130,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | | `34550` | Community Definition | [72](72.md) | -| `65000` | Job Feedback | [90](90.md) | -| `65001` | Job Result | [90](90.md) | ## Message types From 4b9f13d983245e4dd166f102308afc28b8bb1603 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Tue, 31 Oct 2023 00:21:53 +0300 Subject: [PATCH 058/192] NIP-90: consistency changes --- 90.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 4c0eff6a..163dbd06 100644 --- a/90.md +++ b/90.md @@ -43,7 +43,7 @@ A request to process data, published by a customer. This event signals that an c "tags": [ [ "i", "", "", "", "" ], [ "output", "" ], - [ "relays", "wss://..."], + [ "relays", "wss://..." ], [ "bid", "" ], [ "t", "bitcoin" ] ] @@ -162,10 +162,10 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" }", "tags": [ - [ "k", 5005 ], // e.g. translation + [ "k", "5005" ], // e.g. translation [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" ] } ``` -Customers can use NIP-89 to see what service providers their follows use. \ No newline at end of file +Customers can use NIP-89 to see what service providers their follows use. From a328831a07defcd11924c2330b5aaf4f65ec40aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= Date: Tue, 31 Oct 2023 15:48:04 +0200 Subject: [PATCH 059/192] Unlimited quantity possible in NIP-15. --- 15.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/15.md b/15.md index edece818..68d28ff1 100644 --- a/15.md +++ b/15.md @@ -88,7 +88,7 @@ Fields that are not self-explanatory: "images": <[String], array of image URLs, optional>, "currency": , "price": , - "quantity": , + "quantity": , "specs": [ [, ] ], @@ -102,6 +102,7 @@ Fields that are not self-explanatory: ``` Fields that are not self-explanatory: + - `quantity` can be null in the case of items with unlimited abailability, like digital items, or services - `specs`: - an optional array of key pair values. It allows for the Customer UI to present product specifications in a structure mode. It also allows comparison between products - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` From cee69773473a9f6fed2cd7a150d70e77837a42b4 Mon Sep 17 00:00:00 2001 From: Ryan Breen Date: Wed, 1 Nov 2023 08:55:45 -0400 Subject: [PATCH 060/192] Adding Nostore to NIP-07 extension list. --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 24d8d456..51ddc165 100644 --- a/07.md +++ b/07.md @@ -35,3 +35,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) - [Spring Browser](https://spring.site) (Android) - [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill) +- [Nostore](https://apps.apple.com/us/app/nostore/id1666553677) (Safari on iOS/MacOS) From b14b9d2120ea7fd287eb44249ce5910df7ad45d2 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 2 Nov 2023 19:46:35 -0300 Subject: [PATCH 061/192] nip-01: clarify that whitespace is allowed inside the strings. closes https://github.com/nostr-protocol/nips/pull/861 --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 2b28f23f..183e0ba2 100644 --- a/01.md +++ b/01.md @@ -29,9 +29,9 @@ The only object type that exists is the `event`, which has the following format } ``` -To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (with no white space or line breaks) of the following structure: +To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (with no white space or line breaks between the fields) of the following structure: -```json +``` [ 0, , From 08d3eff350d11657160eca78459da34d9254252b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 4 Nov 2023 16:55:28 -0300 Subject: [PATCH 062/192] 52: fix kinds (as ints). --- 52.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/52.md b/52.md index f5bd0adb..69507441 100644 --- a/52.md +++ b/52.md @@ -40,7 +40,7 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": "31922", + "kind": 31922, "content": "", "tags": [ ["d", ""], @@ -98,7 +98,7 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": "31923", + "kind": 31923, "content": "", "tags": [ ["d", ""], @@ -183,7 +183,7 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": "31925", + "kind": 31925, "content": "", "tags": [ ["a", "<31922 or 31923>::", ""], From c2020929fbbcd667caa8ac67b706844512d19d7c Mon Sep 17 00:00:00 2001 From: starbuilder <101296187+starbackr-dev@users.noreply.github.com> Date: Mon, 6 Nov 2023 10:56:24 -0500 Subject: [PATCH 063/192] Update 90.md updated based on Pablo's feedback. --- 90.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/90.md b/90.md index a55d4915..0ac4b981 100644 --- a/90.md +++ b/90.md @@ -79,8 +79,8 @@ If the user wants to keep the input parameters a secret, they can encrypt the `i [ "param", "temperature", "0.5" ], [ "param", "top-k", "50" ], [ "param", "top-p", "0.7" ], - [ "param", "frequency_penalty", "1" ], - [ "param", "output", "encrypted"] + [ "param", "frequency_penalty", "1" ] + ] ``` @@ -90,8 +90,8 @@ This param data will be encrypted and added to the `content` field and `p` tag s ``` "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", "tags": [ - [`p`, `04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f`] - + [`p`, `04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f`], + [ `param`, `encrypted`, true] ] @@ -121,6 +121,10 @@ Service providers publish job results, providing the output of the job result. T * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. * `i`: The original input(s) specified in the request. +## Encrypted Output + +If the request has encrypted params, then output should be encrypted and placed in `content` field with `p` tag. If the output is encrypted, then avoid including `i` tag with input-data as clear text. + ## Job feedback Service providers can give feedback about a job back to the customer. From 749c9b0a2d49d09ccbd00f6bdb4843182e334ddf Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Wed, 25 Oct 2023 12:21:24 +0900 Subject: [PATCH 064/192] clearly define the term "READ/WRITE relay" --- 65.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/65.md b/65.md index b6760290..573e1df2 100644 --- a/65.md +++ b/65.md @@ -8,7 +8,7 @@ Relay List Metadata Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. -The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. If the marker is omitted, the relay is used for both purposes. +The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. Relays marked as `read` / `write` are called READ / WRITE relays, respectively. If the marker is omitted, the relay is used for both purposes. The `.content` is not used. @@ -27,7 +27,7 @@ The `.content` is not used. This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. -## When to Use Read and Write +## When to Use Read and Write Relays When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` From 6b566e897cf0a75d9b6671e73bc614333b89d7ae Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Wed, 25 Oct 2023 12:27:18 +0900 Subject: [PATCH 065/192] make the usage of punctuations uniform --- 65.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/65.md b/65.md index 573e1df2..939b2639 100644 --- a/65.md +++ b/65.md @@ -23,26 +23,27 @@ The `.content` is not used. ], "content": "", ...other fields +} ``` This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. ## When to Use Read and Write Relays -When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` +When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002`. -When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002` +When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002`. When broadcasting an event, Clients SHOULD: - Broadcast the event to the WRITE relays of the author -- Broadcast the event all READ relays of each tagged user. +- Broadcast the event all READ relays of each tagged user ## Motivation The old model of using a fixed relay list per user centralizes in large relay operators: - - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience. + - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication - Events are being copied between relays, oftentimes to many different relays From 108b7f16f9f75157cffde590a55077e4dfe7c955 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Mon, 6 Nov 2023 13:18:11 -0300 Subject: [PATCH 066/192] clarify that the OK array must have 4 items. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 183e0ba2..cb4f522d 100644 --- a/01.md +++ b/01.md @@ -150,7 +150,7 @@ Relays can send 4 types of messages, which must also be JSON arrays, according t This NIP defines no rules for how `NOTICE` messages should be sent or treated. - `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). -- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MAY be empty when the 3rd is `true`, otherwise it MUST be a string containing a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is `true`, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: * `["OK", "b1a649ebe8...", true, ""]` * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` From 56dbb7722c3d1a2c759277391960f41ba6948dcd Mon Sep 17 00:00:00 2001 From: starbuilder <101296187+starbackr-dev@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:31:37 -0500 Subject: [PATCH 067/192] Update 90.md changed and added [`encrypted`] to both 5xxx and 6xxx events --- 90.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/90.md b/90.md index 0ac4b981..24da99c0 100644 --- a/90.md +++ b/90.md @@ -91,7 +91,7 @@ This param data will be encrypted and added to the `content` field and `p` tag s "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", "tags": [ [`p`, `04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f`], - [ `param`, `encrypted`, true] + [`encrypted`] ] @@ -124,6 +124,23 @@ Service providers publish job results, providing the output of the job result. T ## Encrypted Output If the request has encrypted params, then output should be encrypted and placed in `content` field with `p` tag. If the output is encrypted, then avoid including `i` tag with input-data as clear text. +Add a tag encrypted to mark the output content as `encrypted` +```json +{ + "pubkey": "", + "content": "", + "kind": 6xxx, + "tags": [ + [ "request", "" ], + [ "e", "", "" ], + [ "p", "" ], + [ "amount", "requested-payment-amount", "" ], + [`encrypted`] + + ] +} +``` + ## Job feedback Service providers can give feedback about a job back to the customer. From 7e3b7cd90c6e5c4ccba94b58231312aaac421551 Mon Sep 17 00:00:00 2001 From: starbuilder <101296187+starbackr-dev@users.noreply.github.com> Date: Mon, 6 Nov 2023 17:22:50 -0500 Subject: [PATCH 068/192] Update 90.md updated based on comments --- 90.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/90.md b/90.md index 24da99c0..8394c383 100644 --- a/90.md +++ b/90.md @@ -69,7 +69,7 @@ All tags are optional. ## Encrypted Params -If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. The user also indicates whether the output should be encrypted or not as one of the parameters. +If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](https://github.com/nostr-protocol/nips/blob/master/04.md), using the user's private and service provider's public key for the shared secret ```json [ @@ -90,8 +90,8 @@ This param data will be encrypted and added to the `content` field and `p` tag s ``` "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", "tags": [ - [`p`, `04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f`], - [`encrypted`] + ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], + ["encrypted"] ] @@ -123,7 +123,7 @@ Service providers publish job results, providing the output of the job result. T ## Encrypted Output -If the request has encrypted params, then output should be encrypted and placed in `content` field with `p` tag. If the output is encrypted, then avoid including `i` tag with input-data as clear text. +If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text. Add a tag encrypted to mark the output content as `encrypted` ```json { @@ -135,7 +135,7 @@ Add a tag encrypted to mark the output content as `encrypted` [ "e", "", "" ], [ "p", "" ], [ "amount", "requested-payment-amount", "" ], - [`encrypted`] + ["encrypted"] ] } From b128ad98ade41b2b1f029e7460329554748fea73 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Tue, 7 Nov 2023 14:16:43 +0200 Subject: [PATCH 069/192] NIP-84: Highlights (#501) Co-authored-by: Alejandro Co-authored-by: arthurfranca Co-authored-by: fiatjaf_ --- 84.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 100 insertions(+) create mode 100644 84.md diff --git a/84.md b/84.md new file mode 100644 index 00000000..b4a4be72 --- /dev/null +++ b/84.md @@ -0,0 +1,98 @@ +NIP-84 +====== + +Highlights +---------- + +`draft` `optional` `author:pablof7z` + +This NIP defines `kind:9802`, a "highlight" event, to signal content a user finds valuable. + +## Format +The `.content` of these events is the highlighted portion of the text. + +`.content` might be empty for highlights of non-text based media (e.g. NIP-94 audio/video). + +### References +Events SHOULD tag the source of the highlight, whether nostr-native or not. +`a` or `e` tags should be used for nostr events and `r` tags for URLs. + +When tagging a URL, clients generating these events SHOULD do a best effort of cleaning the URL from trackers +or obvious non-useful information from the query string. + +### Attribution +Clients MAY include one or more `p` tags, tagging the original authors of the material being highlighted; this is particularly +useful when highlighting non-nostr content for which the client might be able to get a nostr pubkey somehow +(e.g. prompting the user or reading a `` tag on the document). A role MAY be included as the +last value of the tag. + +```json +[ "p", "...", "author" ], +[ "p", "...", "author" ], +[ "p", "...", "editor" ], +``` + +### Context +Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the +surrounding content might be beneficial to give context to the higlight. + +### Ranges +Clients MAY include `range` tags with the start/end indexes of where the highlight begins and finishes within +the referenced article/tagged-event. + +``` +[ "range", , ] +``` + +Additionally a range with `context` as the third value of the tag MAY be added to indicate the begin/finish indexes +of the highlight within the included `context` tag. + +``` +[ "range", , , "context" ] +``` + +#### Text-based nostr events' highlights + +Highlights of Nostr events SHOULD use the range index of the content as-is +(e.g. NIP-23 articles include the markdown instead of computing the index from the rendered markdown). + +``` +[ "range", 3000, 3042 ] # highlight begins at index position 3000 of the tagged event's `.content` +[ "range", 42, 84, "context" ] # highlight begins at index position 42 of the `context` tag's value +``` + +#### Non-text-based nostr events' highlights + +A `kind:9802` event that tags a NIP-94 event which includes a video or audio file can use ranges to +indicate the start/end time position in seconds. + +#### Ranges in URL highlights + +When creating a highlight from a URL the range should be expressed over +the extracted plain text of the formatted content (e.g. rendered HTML instead of including the HTML markup); +this helps make finding the correct indexes easier on websites with markup variations on each render. + +e.g. `hello, world` + +Tagging `hello, world` would result in using a range tag like `["range", 0, 12 ]`. + +Text extraction (i.e. translation from non-plain text medium like HTML or PDF) is highly subjective and the value +of the range should be carefully interpreted by the different clients that support this. + +```json +{ + "created_at": 1682707885, + "content": "while allowing creators to simply keep doing what they’re doing. Creators don’t need to be blatant shills for brands", + "tags": [ + [ "r", "https://footstr.com/zapvertise/" ], + [ "p", "c48e29f04b482cc01ca1f9ef8c86ef8318c059e0e9353235162f080f26e14c11", "wss://relay.url", "author" ], + [ "context", "The Nostr zapvertising model creates a truly free market for advertisers, while allowing creators to simply keep doing what they’re doing. Creators don’t need to be blatant shills for brands, they just have to create high quality content people find valuable, and companies will naturally want to zapvertise on their posts." ] + [ "range", 3916, 4032 ], + [ "range", 74, 190, "context" ], + ], + "kind": 9802, + "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", + "id": "59e5887a3cdf32d5f11edf9b8cd098c620d278514b2edde3e6d1ba8a541d262c", + "sig": "f2d15b8bc2csf6d198350f8df0a31dcf66d7c32ec9c54e6b3f102d579370b7de9d164d70350a5b32a2911db3b124e972bafa9a1bc8fd60c1e338903d2f6306b0" +} +``` diff --git a/README.md b/README.md index 8be05951..f818b043 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-72: Moderated Communities](72.md) - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) +- [NIP-84: Highlights](84.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-94: File Metadata](94.md) @@ -101,6 +102,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | +| `9802` | Highlights | [84](84.md) | | `10000` | Mute List | [51](51.md) | | `10001` | Pin List | [51](51.md) | | `10002` | Relay List Metadata | [65](65.md) | From d85f9269ca300fb3bee627733c8086df4fcff875 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 7 Nov 2023 09:19:11 -0300 Subject: [PATCH 070/192] 84: fix markers example. --- 84.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/84.md b/84.md index b4a4be72..89bf88b1 100644 --- a/84.md +++ b/84.md @@ -27,9 +27,9 @@ useful when highlighting non-nostr content for which the client might be able to last value of the tag. ```json -[ "p", "...", "author" ], -[ "p", "...", "author" ], -[ "p", "...", "editor" ], +[ "p", "", "", "author" ], +[ "p", "", "", "author" ], +[ "p", "", "", "editor" ], ``` ### Context From c5930de1076a747eb8181267a76ddaba8a8aad67 Mon Sep 17 00:00:00 2001 From: gsovereignty Date: Wed, 8 Nov 2023 13:46:50 +0800 Subject: [PATCH 071/192] Problem: nostrocket problem tracker event kind not included in list Mostly just letting people know that this event kind is now in use by Nostrocket. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f818b043..36dfada6 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1063` | File Metadata | [94](94.md) | | `1311` | Live Chat Message | [53](53.md) | | `1040` | OpenTimestamps | [03](03.md) | +| `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | From 2392dfc9a8b10873cf81c9366291e5971cb9d28c Mon Sep 17 00:00:00 2001 From: Akiomi Kamakura Date: Fri, 10 Nov 2023 05:45:29 +0900 Subject: [PATCH 072/192] Fix typo in 65.md --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 939b2639..cdfe9bf5 100644 --- a/65.md +++ b/65.md @@ -53,7 +53,7 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 1. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays). -2. Clients SHOULD spread an author's `kind:10002` events to as many relays as viable. +2. Clients SHOULD spread an author's `kind:10002` event to as many relays as viable. 3. `kind:10002` events should primarily be used to advertise the user's preferred relays to others. A user's own client may use other heuristics for selecting relays for fetching data. From 05cad663f8f4eb022620e2e27f0761733f05ce14 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 10 Nov 2023 07:00:40 -0300 Subject: [PATCH 073/192] improve nip-24. closes https://github.com/nostr-protocol/nips/pull/828 --- 24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/24.md b/24.md index dee9daa3..b88d990a 100644 --- a/24.md +++ b/24.md @@ -13,7 +13,7 @@ kind 0 These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events: - - `display_name`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available. + - `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata. - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. From c945d8bd9d14f928b52ba20e0441f311b046f0f6 Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Thu, 9 Nov 2023 13:05:31 -0800 Subject: [PATCH 074/192] Remove label annotations from NIP 32 --- 32.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/32.md b/32.md index ddd364ae..c5c62728 100644 --- a/32.md +++ b/32.md @@ -6,7 +6,7 @@ Labeling `draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` -A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, from distributed moderation and content recommendations to reviews and ratings. +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. Label Target ---- @@ -41,16 +41,6 @@ MAY be used when the label content is provided by an end user. `l` and `L` tags MAY be added to other event kinds to support self-reporting. For events with a kind other than 1985, labels refer to the event itself. -Label Annotations ------ - -A label tag MAY include a 4th positional element detailing extra metadata about the label in question. This string -should be a json-encoded object. Any key MAY be used, but the following are recommended: - -- `quality` may have a value of 0 to 1. This allows for an absolute, granular scale that can be represented in any way (5 stars, color scale, etc). -- `confidence` may have a value of 0 to 1. This indicates the certainty which the author has about their rating. -- `context` may be an array of urls (including NIP-21 urls) indicating other context that should be considered when interpreting labels. - Content ------- @@ -83,8 +73,9 @@ A review of a relay. "kind": 1985, "tags": [ ["L", "com.example.ontology"], - ["l", "relay/review", "com.example.ontology", "{\"quality\": 0.1}"], - ["r", ] + ["l", "relay/review", "com.example.ontology"], + ["r", ], + ["rating", "0.1"] ], "content": "This relay is full of mean people.", ... From 2e652f03d5d645b77f233d16cd3f2c29e1d1a1ec Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 10 Nov 2023 23:59:00 +0900 Subject: [PATCH 075/192] Update TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f818b043..a42aa20d 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [List](#list) - [Event Kinds](#event-kinds) - - [Event Kind Ranges](#event-kind-ranges) - [Message Types](#message-types) - [Client to Relay](#client-to-relay) - [Relay to Client](#relay-to-client) - [Standardized Tags](#standardized-tags) - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) +- [Mailing Lists](#mailing-lists) - [License](#license) --- From e7777c30315969b3097d4b7940a92e49519b1556 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sat, 11 Nov 2023 00:50:47 +0900 Subject: [PATCH 076/192] Add DVM kinds to list --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a42aa20d..9d3ee62c 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | +| `5000`-`5999` | Job Request | [90](90.md) | +| `6000`-`6999` | Job Result | [90](90.md) | | `7000` | Job Feedback | [90](90.md) | | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | From b303240a2b9a168069d94b4fefb3f156316215cd Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 10 Nov 2023 13:11:11 -0300 Subject: [PATCH 077/192] format kinds table. --- README.md | 118 +++++++++++++++++++++++++++--------------------------- 1 file changed, 59 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 9d3ee62c..3f7cb41f 100644 --- a/README.md +++ b/README.md @@ -75,65 +75,65 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Event Kinds -| kind | description | NIP | -| ------- | -------------------------- | ----------- | -| `0` | Metadata | [1](01.md) | -| `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | | -| `3` | Contacts | [2](02.md) | -| `4` | Encrypted Direct Messages | [4](04.md) | -| `5` | Event Deletion | [9](09.md) | -| `6` | Repost | [18](18.md) | -| `7` | Reaction | [25](25.md) | -| `8` | Badge Award | [58](58.md) | -| `16` | Generic Repost | [18](18.md) | -| `40` | Channel Creation | [28](28.md) | -| `41` | Channel Metadata | [28](28.md) | -| `42` | Channel Message | [28](28.md) | -| `43` | Channel Hide Message | [28](28.md) | -| `44` | Channel Mute User | [28](28.md) | -| `1063` | File Metadata | [94](94.md) | -| `1311` | Live Chat Message | [53](53.md) | -| `1040` | OpenTimestamps | [03](03.md) | -| `1984` | Reporting | [56](56.md) | -| `1985` | Label | [32](32.md) | -| `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) | -| `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) | -| `13194` | Wallet Info | [47](47.md) | -| `22242` | Client Authentication | [42](42.md) | -| `23194` | Wallet Request | [47](47.md) | -| `23195` | Wallet Response | [47](47.md) | -| `24133` | Nostr Connect | [46](46.md) | -| `27235` | HTTP Auth | [98](98.md) | -| `30000` | Categorized People List | [51](51.md) | -| `30001` | Categorized Bookmark List | [51](51.md) | -| `30008` | Profile Badges | [58](58.md) | -| `30009` | Badge Definition | [58](58.md) | -| `30017` | Create or update a stall | [15](15.md) | -| `30018` | Create or update a product | [15](15.md) | -| `30023` | Long-form Content | [23](23.md) | -| `30024` | Draft Long-form Content | [23](23.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) | -| `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) | -| `34550` | Community Definition | [72](72.md) | +| kind | description | NIP | +| ------------- | -------------------------- | ----------- | +| `0` | Metadata | [1](01.md) | +| `1` | Short Text Note | [1](01.md) | +| `2` | Recommend Relay | | +| `3` | Contacts | [2](02.md) | +| `4` | Encrypted Direct Messages | [4](04.md) | +| `5` | Event Deletion | [9](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `16` | Generic Repost | [18](18.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1040` | OpenTimestamps | [03](03.md) | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `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) | +| `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) | +| `13194` | Wallet Info | [47](47.md) | +| `22242` | Client Authentication | [42](42.md) | +| `23194` | Wallet Request | [47](47.md) | +| `23195` | Wallet Response | [47](47.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `27235` | HTTP Auth | [98](98.md) | +| `30000` | Categorized People List | [51](51.md) | +| `30001` | Categorized Bookmark List | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.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) | +| `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) | +| `34550` | Community Definition | [72](72.md) | ## Message types From cbdca1e9643711c62e06a19d9c2d889699a7978d Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 10 Nov 2023 13:16:35 -0300 Subject: [PATCH 078/192] nip-84: remove all the "range" stuff, we can add later if the need arises. --- 84.md | 61 ----------------------------------------------------------- 1 file changed, 61 deletions(-) diff --git a/84.md b/84.md index 89bf88b1..4caab62a 100644 --- a/84.md +++ b/84.md @@ -35,64 +35,3 @@ last value of the tag. ### Context Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the surrounding content might be beneficial to give context to the higlight. - -### Ranges -Clients MAY include `range` tags with the start/end indexes of where the highlight begins and finishes within -the referenced article/tagged-event. - -``` -[ "range", , ] -``` - -Additionally a range with `context` as the third value of the tag MAY be added to indicate the begin/finish indexes -of the highlight within the included `context` tag. - -``` -[ "range", , , "context" ] -``` - -#### Text-based nostr events' highlights - -Highlights of Nostr events SHOULD use the range index of the content as-is -(e.g. NIP-23 articles include the markdown instead of computing the index from the rendered markdown). - -``` -[ "range", 3000, 3042 ] # highlight begins at index position 3000 of the tagged event's `.content` -[ "range", 42, 84, "context" ] # highlight begins at index position 42 of the `context` tag's value -``` - -#### Non-text-based nostr events' highlights - -A `kind:9802` event that tags a NIP-94 event which includes a video or audio file can use ranges to -indicate the start/end time position in seconds. - -#### Ranges in URL highlights - -When creating a highlight from a URL the range should be expressed over -the extracted plain text of the formatted content (e.g. rendered HTML instead of including the HTML markup); -this helps make finding the correct indexes easier on websites with markup variations on each render. - -e.g. `hello, world` - -Tagging `hello, world` would result in using a range tag like `["range", 0, 12 ]`. - -Text extraction (i.e. translation from non-plain text medium like HTML or PDF) is highly subjective and the value -of the range should be carefully interpreted by the different clients that support this. - -```json -{ - "created_at": 1682707885, - "content": "while allowing creators to simply keep doing what they’re doing. Creators don’t need to be blatant shills for brands", - "tags": [ - [ "r", "https://footstr.com/zapvertise/" ], - [ "p", "c48e29f04b482cc01ca1f9ef8c86ef8318c059e0e9353235162f080f26e14c11", "wss://relay.url", "author" ], - [ "context", "The Nostr zapvertising model creates a truly free market for advertisers, while allowing creators to simply keep doing what they’re doing. Creators don’t need to be blatant shills for brands, they just have to create high quality content people find valuable, and companies will naturally want to zapvertise on their posts." ] - [ "range", 3916, 4032 ], - [ "range", 74, 190, "context" ], - ], - "kind": 9802, - "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - "id": "59e5887a3cdf32d5f11edf9b8cd098c620d278514b2edde3e6d1ba8a541d262c", - "sig": "f2d15b8bc2csf6d198350f8df0a31dcf66d7c32ec9c54e6b3f102d579370b7de9d164d70350a5b32a2911db3b124e972bafa9a1bc8fd60c1e338903d2f6306b0" -} -``` From b6c7a255102a65c4978b465a85f124e910e82a2d Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Fri, 10 Nov 2023 08:13:04 -0800 Subject: [PATCH 079/192] Clarify NIP 32 --- 32.md | 113 +++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 72 insertions(+), 41 deletions(-) diff --git a/32.md b/32.md index c5c62728..f8dc0029 100644 --- a/32.md +++ b/32.md @@ -6,7 +6,30 @@ Labeling `draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` -A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, including distributed moderation, collection management, license assignment, and content classification. +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 introduces two new tags: + +- `L` denotes a label namespace +- `l` denotes a label + +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` +("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. +This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. + +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. Label Target ---- @@ -16,37 +39,18 @@ labeled: `e`, `p`, `a`, `r`, or `t` tags. This allows for labeling of events, pe or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and `p` tags. -Label Tag ----- - -This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. -A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature -external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD -ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation. - -Namespaces starting with `#` indicate that the label target should be associated with the label's value. -This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. - -Some examples: - -- `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied. -- `["l", "", "#p"]` - the publisher thinks the given entity is related to `` -- `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2. -- `["l", "VI-hum", "com.example.ontology"]` - Violence toward a human being as defined by ontology.example.com. - -`L` tags containing the label namespaces MUST be included in order to support searching by -namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace -MAY be used when the label content is provided by an end user. - -`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events -with a kind other than 1985, labels refer to the event itself. - Content ------- Labels should be short, meaningful strings. Longer discussions, such as for a review, or an explanation of why something was labeled the way it was, should go in the event's `content` field. +Self-Reporting +------- + +`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events +with a kind other than 1985, labels refer to the event itself. + Example events -------------- @@ -60,39 +64,61 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. ["l", "permies", "#t"], ["p", , ], ["p", , ] - ], - "content": "", - ... + ] } ``` -A review of a relay. +A report flagging violence toward a human being as defined by ontology.example.com. ```json { "kind": 1985, "tags": [ ["L", "com.example.ontology"], - ["l", "relay/review", "com.example.ontology"], - ["r", ], - ["rating", "0.1"] - ], - "content": "This relay is full of mean people.", - ... + ["l", "VI-hum", "com.example.ontology"], + ["p", , ], + ["p", , ] + ] } ``` -Publishers can self-label by adding `l` tags to their own non-1985 events. +A moderation suggestion for a chat event. + +```json +{ + "kind": 1985, + "tags": [ + ["L", "nip28.moderation"], + ["l", "approve", "nip28.moderation"], + ["e", , ] + ], +} +``` + +Assignment of a license to an event. + +```json +{ + "kind": 1985, + "tags": [ + ["L", "license"], + ["l", "MIT", "license"], + ["e", , ] + ], +} +``` + +Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author +is labeling their note as being related to Milan, Italy using ISO 3166-2. ```json { "kind": 1, "tags": [ - ["L", "com.example.ontology"], - ["l", "IL-frd", "com.example.ontology"] + ["L", "ISO-3166-2"], + ["l", "IT-MI", "ISO-3166-2"] ], - "content": "Send me 100 sats and I'll send you 200 back", - ... + "content": "It's beautiful here in Milan!", } ``` @@ -115,3 +141,8 @@ Vocabularies MAY choose to fully qualify all labels within a namespace (for exam formal vocabularies that should not be confused with another namespace when querying without an `L` tag. For these vocabularies, all labels SHOULD include the namespace (rather than mixing qualified and unqualified labels). + +A good heuristic for whether a use case fits this NIP is whether labels would ever be unique. +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. From f1433e0f0cb28d17102b530081b48d47e0ee38ac Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Tue, 14 Nov 2023 18:38:48 -0300 Subject: [PATCH 080/192] add relay sets kind to nip-51 (#786) --- 51.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/51.md b/51.md index cbd6be11..e4d7c24e 100644 --- a/51.md +++ b/51.md @@ -129,6 +129,7 @@ Then the user would create a 'Categorized Bookmarks' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | +| 30002 | Categorized Relay Sets | ### Mute List @@ -145,4 +146,8 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event of kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file +An event of kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List. + +### Categorized Relay Set + +An event of kind `30002` is defined as a parameterized replaceable list event for categorizing relays. The 'd' parameter for this event holds the category name of the list. The relays lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). These sets can be used by clients in order to determine which relays to query in different scenarios. From 5dc6071978bc7c2dcee807d16ef085192971ac27 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 00:22:09 -0300 Subject: [PATCH 081/192] cut, simplify and update NIP-51 to reflect the real-world usage. --- 51.md | 151 ++++-------------------------------------------------- README.md | 117 +++++++++++++++++++++--------------------- 2 files changed, 69 insertions(+), 199 deletions(-) diff --git a/51.md b/51.md index e4d7c24e..c74487f6 100644 --- a/51.md +++ b/51.md @@ -6,148 +6,19 @@ Lists `draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` -A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. +This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**. -If a list should only be defined once per user (like the "mute" list) the list is declared as a _replaceable event_. These lists may be referred to as "replaceable lists". Otherwise, the list is a _parameterized replaceable event_ and the list name will be used as the `d` tag. These lists may be referred to as "parameterized replaceable lists". +Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. -## Replaceable List Event Example +## Generic lists -Lets say a user wants to create a 'Mute' list and has keys: -``` -priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1 -pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d -``` -The user wants to publicly include these users: +The kinds `30000` and `30001` have been reserved for generic lists. These must be accompanied by a `d` tag identifying the list, but these are generally client-specific, except in the standard cases specified below. -```json -["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], -["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"] -``` -and privately include these users (below is the JSON that would be encrypted and placed in the event content): +## Standard lists -```json -[ - ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"], - ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"] -] -``` - -Then the user would create a 'Mute' list event like below: - -```json -{ - "kind": 10000, - "tags": [ - ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], - ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], - ], - "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==", - ...other fields -} -``` - - -## Parameterized Replaceable List Event Example - -Lets say a user wants to create a 'Categorized People' list of `nostr` people and has keys: -``` -priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1 -pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d -``` -The user wants to publicly include these users: - -```json -["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], -["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"] -``` -and privately include these users (below is the JSON that would be encrypted and placed in the event content): - -```json -[ - ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"], - ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"] -] -``` - -Then the user would create a 'Categorized People' list event like below: - -```json -{ - "kind": 30000, - "tags": [ - ["d", "nostr"], - ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], - ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], - ], - "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==", - ...other fields -} -``` - -Lets say a user wants to create a 'Categorized Bookmarks' list of `bookmarks` and has keys: -``` -priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1 -pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d -``` -The user wants to publicly include these bookmarks: - -```json -["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], -["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], -["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], -``` -and privately include these bookmarks (below is the JSON that would be encrypted and placed in the event content): - -```json -[ - ["r", "https://my-private.bookmark", "My private bookmark"], - ["a", "30001:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], -] -``` - -Then the user would create a 'Categorized Bookmarks' list event like below: - -```json -{ - "kind": 30001, - "tags": [ - ["d", "bookmarks"], - ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], - ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], - ["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], - ], - "content": "y3AyaLJfnmYr9x9Od9o4aYrmL9+Ynmsim5y2ONrU0urOTq+V81CyAthQ2mUOWE9xwGgrizhY7ILdQwWhy6FK0sA33GHtC0egUJw1zIdknPe7BZjznD570yk/8RXYgGyDKdexME+RMYykrnYFxq1+y/h00kmJg4u+Gpn+ZjmVhNYxl9b+TiBOAXG9UxnK/H0AmUqDpcldn6+j1/AiStwYZhD1UZ3jzDIk2qcCDy7MlGnYhSP+kNmG+2b0T/D1L0Z7?iv=PGJJfPE84gacAh7T0e6duQ==", - ...other fields -} -``` - -## List Event Kinds - -| kind | list type | -| ------ | ----------------------- | -| 10000 | Mute | -| 10001 | Pin | -| 30000 | Categorized People | -| 30001 | Categorized Bookmarks | -| 30002 | Categorized Relay Sets | - - -### Mute List - -An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List. - -### Pin List - -An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standardized tag can be included in a Pin List. - -### Categorized People List - -An event with kind `30000` is defined as a parameterized replaceable list event for categorizing people. The 'd' parameter for this event holds the category name of the list. The tags included in these lists MUST follow the format of kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). - -### Categorized Bookmarks List - -An event of kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List. - -### Categorized Relay Set - -An event of kind `30002` is defined as a parameterized replaceable list event for categorizing relays. The 'd' parameter for this event holds the category name of the list. The relays lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). These sets can be used by clients in order to determine which relays to query in different scenarios. +| name | kind | "d" tag | description | expected tag items | +| --- | --- | --- | --- | --- | +| Muted list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | +| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | +| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Relay sets | 30002 | (user-defined) | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | diff --git a/README.md b/README.md index 483056dc..74411ca5 100644 --- a/README.md +++ b/README.md @@ -74,66 +74,65 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-99: Classified Listings](99.md) ## Event Kinds -| kind | description | NIP | -| ------------- | -------------------------- | ----------- | -| `0` | Metadata | [1](01.md) | -| `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | | -| `3` | Contacts | [2](02.md) | -| `4` | Encrypted Direct Messages | [4](04.md) | -| `5` | Event Deletion | [9](09.md) | -| `6` | Repost | [18](18.md) | -| `7` | Reaction | [25](25.md) | -| `8` | Badge Award | [58](58.md) | -| `16` | Generic Repost | [18](18.md) | -| `40` | Channel Creation | [28](28.md) | -| `41` | Channel Metadata | [28](28.md) | -| `42` | Channel Message | [28](28.md) | -| `43` | Channel Hide Message | [28](28.md) | -| `44` | Channel Mute User | [28](28.md) | -| `1063` | File Metadata | [94](94.md) | -| `1311` | Live Chat Message | [53](53.md) | -| `1040` | OpenTimestamps | [03](03.md) | +| kind | description | NIP | +| ------------- | -------------------------- | ----------- | +| `0` | Metadata | [1](01.md) | +| `1` | Short Text Note | [1](01.md) | +| `2` | Recommend Relay | | +| `3` | Contacts | [2](02.md) | +| `4` | Encrypted Direct Messages | [4](04.md) | +| `5` | Event Deletion | [9](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `16` | Generic Repost | [18](18.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1040` | OpenTimestamps | [03](03.md) | | `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) | -| `1984` | Reporting | [56](56.md) | -| `1985` | Label | [32](32.md) | -| `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) | -| `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) | -| `13194` | Wallet Info | [47](47.md) | -| `22242` | Client Authentication | [42](42.md) | -| `23194` | Wallet Request | [47](47.md) | -| `23195` | Wallet Response | [47](47.md) | -| `24133` | Nostr Connect | [46](46.md) | -| `27235` | HTTP Auth | [98](98.md) | -| `30000` | Categorized People List | [51](51.md) | -| `30001` | Categorized Bookmark List | [51](51.md) | -| `30008` | Profile Badges | [58](58.md) | -| `30009` | Badge Definition | [58](58.md) | -| `30017` | Create or update a stall | [15](15.md) | -| `30018` | Create or update a product | [15](15.md) | -| `30023` | Long-form Content | [23](23.md) | -| `30024` | Draft Long-form Content | [23](23.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) | -| `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) | -| `34550` | Community Definition | [72](72.md) | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `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) | +| `9041` | Zap Goal | [75](75.md) | +| `9734` | Zap Request | [57](57.md) | +| `9735` | Zap | [57](57.md) | +| `9802` | Highlights | [84](84.md) | +| `10002` | Relay List Metadata | [65](65.md) | +| `13194` | Wallet Info | [47](47.md) | +| `22242` | Client Authentication | [42](42.md) | +| `23194` | Wallet Request | [47](47.md) | +| `23195` | Wallet Response | [47](47.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `27235` | HTTP Auth | [98](98.md) | +| `30000` | People List | [51](51.md) | +| `30001` | Things List | [51](51.md) | +| `30002` | Relay Set | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.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) | +| `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) | +| `34550` | Community Definition | [72](72.md) | ## Message types From da05b5d9150200cec5a498ac180b6391abeddd69 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 00:47:15 -0300 Subject: [PATCH 082/192] add "communities" list and examples. --- 51.md | 44 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/51.md b/51.md index c74487f6..3ac89959 100644 --- a/51.md +++ b/51.md @@ -16,9 +16,41 @@ The kinds `30000` and `30001` have been reserved for generic lists. These must b ## Standard lists -| name | kind | "d" tag | description | expected tag items | -| --- | --- | --- | --- | --- | -| Muted list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | -| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | -| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Relay sets | 30002 | (user-defined) | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | +| name | kind | "d" tag | description | expected tag items | +| --- | --- | --- | --- | --- | +| Mute list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | +| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | +| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Communities list | 30001 | `"communities"` | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| Relay sets | 30002 | (user-defined) | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | + +## Examples + +### A _Mute list_ with some public items and some encrypted items + +```json +{ + "id": "a92a316b75e44cfdc19986c634049158d4206fcc0b7b9c7ccbcdabe28beebcd0", + "pubkey": "854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb", + "created_at": 1699597889, + "kind": 30000, + "tags": [ + ["d", "mute"], + ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"], + ["p", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"] + ], + "content": "TJob1dQrf2ndsmdbeGU+05HT5GMnBSx3fx8QdDY/g3NvCa7klfzgaQCmRZuo1d3WQjHDOjzSY1+MgTK5WjewFFumCcOZniWtOMSga9tJk1ky00tLoUUzyLnb1v9x95h/iT/KpkICJyAwUZ+LoJBUzLrK52wNTMt8M5jSLvCkRx8C0BmEwA/00pjOp4eRndy19H4WUUehhjfV2/VV/k4hMAjJ7Bb5Hp9xdmzmCLX9+64+MyeIQQjQAHPj8dkSsRahP7KS3MgMpjaF8nL48Bg5suZMxJayXGVp3BLtgRZx5z5nOk9xyrYk+71e2tnP9IDvSMkiSe76BcMct+m7kGVrRcavDI4n62goNNh25IpghT+a1OjjkpXt9me5wmaL7fxffV1pchdm+A7KJKIUU3kLC7QbUifF22EucRA9xiEyxETusNludBXN24O3llTbOy4vYFsq35BeZl4v1Cse7n2htZicVkItMz3wjzj1q1I1VqbnorNXFgllkRZn4/YXfTG/RMnoK/bDogRapOV+XToZ+IvsN0BqwKSUDx+ydKpci6htDRF2WDRkU+VQMqwM0CoLzy2H6A2cqyMMMD9SLRRzBg==?iv=S3rFeFr1gsYqmQA7bNnNTQ==", + "sig": "1173822c53261f8cffe7efbf43ba4a97a9198b3e402c2a1df130f42a8985a2d0d3430f4de350db184141e45ca844ab4e5364ea80f11d720e36357e1853dba6ca" +} +``` + +## Encryption process pseudocode + +```scala +val private_items = [ + ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"], + ["a", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"], +] +val base64blob = nip04.encrypt(json.encode_to_string(private_items)) +event.content = base64blob +``` From 1bbd87c42fe6ca6caa7582fdb89a355b6dfc70f4 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 07:33:26 -0300 Subject: [PATCH 083/192] distinction between lists and sets. --- 51.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/51.md b/51.md index 3ac89959..b184f428 100644 --- a/51.md +++ b/51.md @@ -14,19 +14,31 @@ Public items in a list are specified in the event `tags` array, while private it The kinds `30000` and `30001` have been reserved for generic lists. These must be accompanied by a `d` tag identifying the list, but these are generally client-specific, except in the standard cases specified below. -## Standard lists +### Standard lists -| name | kind | "d" tag | description | expected tag items | -| --- | --- | --- | --- | --- | -| Mute list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | -| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | -| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Communities list | 30001 | `"communities"` | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | -| Relay sets | 30002 | (user-defined) | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | +These are some standards that emerged in the wild: + +| name | kind | "d" tag | description | expected tag items | +| --- | --- | --- | --- | --- | +| Mute list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | +| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | +| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Communities list | 30001 | `"communities"` | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | + +## Sets + +Sets are lists with well-defined meaning and purpose and user-assigned `d` tags meant to be displayed in the UI. For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which relays they will publish an event or from which relays they will read the replies to an event; or _curation sets_ can be used by apps to showcase curations made by others tagged to different topics. + +Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tag that can be used to enhance their UI. + +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | +| Article Curation sets | 30003 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles) | ## Examples -### A _Mute list_ with some public items and some encrypted items +### A _mute list_ with some public items and some encrypted items ```json { From cf1b17280f5ba97c7f3bf1f699494f1551de8064 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 08:24:46 -0300 Subject: [PATCH 084/192] bring back kind:10000 mute lists, deprecation notice about kind:30000/"mute" and more examples. --- 51.md | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 105 insertions(+), 15 deletions(-) diff --git a/51.md b/51.md index b184f428..d113f805 100644 --- a/51.md +++ b/51.md @@ -6,35 +6,64 @@ Lists `draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` -This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**. +This NIP defines lists of things that users can create. Lists can contain references to anything, and these +references can be **public** or **private**. -Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. +Public items in a list are specified in the event `tags` array, while private items are specified in a JSON +array that mimics the structure of the event `tags` array, but stringified and encrypted using the same +scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and +stored in the `.content`. -## Generic lists +## Types of lists -The kinds `30000` and `30001` have been reserved for generic lists. These must be accompanied by a `d` tag identifying the list, but these are generally client-specific, except in the standard cases specified below. +### Generic lists -### Standard lists +The kind `30001` has been reserved for generic lists. These must be accompanied by a `d` tag identifying the +list, but these have no standard meaning and are generally client-specific (except in the standard cases +specified below). -These are some standards that emerged in the wild: +## Standard lists + +Users are expected to have a single list of each of these types. They have special meaning and clients may +rely on them to augment the user profile or browsing experience. + +For example, _mute lists_ 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 | "d" tag | description | expected tag items | | --- | --- | --- | --- | --- | -| Mute list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | +| Mute list | 10000 | | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | | Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | | Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | | Communities list | 30001 | `"communities"` | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | ## Sets -Sets are lists with well-defined meaning and purpose and user-assigned `d` tags meant to be displayed in the UI. For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which relays they will publish an event or from which relays they will read the replies to an event; or _curation sets_ can be used by apps to showcase curations made by others tagged to different topics. +Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely +on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of +them must be assigned a different `"d"` identifier. -Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tag that can be used to enhance their UI. +For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which +relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ +can be used by apps to showcase curations made by others tagged to different topics. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | -| Article Curation sets | 30003 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles) | +Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a +`"description"` tag that can be used to enhance their UI. + +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | +| Article Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | + +## Deprecated standard lists + +Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above: + +- kind:30000 and `d` "mute" + +| kind | "d" tag | use instead | +| --- | --- | --- | +| 30000 | `"mute"` | kind 10000 _mute list_ | ## Examples @@ -45,9 +74,8 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti "id": "a92a316b75e44cfdc19986c634049158d4206fcc0b7b9c7ccbcdabe28beebcd0", "pubkey": "854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb", "created_at": 1699597889, - "kind": 30000, + "kind": 10000, "tags": [ - ["d", "mute"], ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"], ["p", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"] ], @@ -56,6 +84,68 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti } ``` +### A _communities list_ with just public items + +```json +{ + "id": "da6b18c5452b5a60bf49588fc13ae4d1a047519c13e49a77b3184e6188c7bb1c", + "pubkey": "83fd07de9b763334cc9d46f2785c2558e6c2eabfe7d0c6ec214667cbaec50d47", + "created_at": 1689082210, + "kind": 30001, + "tags": [ + [ + "d", + "communities" + ], + [ + "a", + "34550:83fd07de9b763334cc9d46f2785c2558e6c2eabfe7d0c6ec214667cbaec50d47:meme" + ], + [ + "a", + "34550:b9a537523bba2fcdae857d90d8a760de4f2139c9f90d986f747ce7d0ec0d173d:NoBullshitBitcoin" + ] + ], + "content": "", + "sig": "e400cc8bf24955243137e4456b22142fdff400a7950cf0b0ac2ee86ed78671e2fddf9a9b40c77ccf8397f9c21d608b3fab3678ff13713fc3f97a4394cf766079" +} +``` + +### A _curation set_ of articles and notes about yaks + +``` +{ + "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", + "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", + "created_at": 1695327657, + "kind": 30004, + "tags": [ + [ + "d", + "jvdy9i4" + ], + [ + "title", + "Yaks" + ], + [ + "summary", + "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia." + ], + [ + "image", + "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg" + ], + ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], + ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], + ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], + ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"] + ], + "content": "", + "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd" +} +``` + ## Encryption process pseudocode ```scala From fd288d4ea9c5aef08747f91db90339b73cce0640 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 08:28:59 -0300 Subject: [PATCH 085/192] update readme kind list. --- README.md | 121 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 62 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 74411ca5..94be17e7 100644 --- a/README.md +++ b/README.md @@ -74,65 +74,68 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-99: Classified Listings](99.md) ## Event Kinds -| kind | description | NIP | -| ------------- | -------------------------- | ----------- | -| `0` | Metadata | [1](01.md) | -| `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | | -| `3` | Contacts | [2](02.md) | -| `4` | Encrypted Direct Messages | [4](04.md) | -| `5` | Event Deletion | [9](09.md) | -| `6` | Repost | [18](18.md) | -| `7` | Reaction | [25](25.md) | -| `8` | Badge Award | [58](58.md) | -| `16` | Generic Repost | [18](18.md) | -| `40` | Channel Creation | [28](28.md) | -| `41` | Channel Metadata | [28](28.md) | -| `42` | Channel Message | [28](28.md) | -| `43` | Channel Hide Message | [28](28.md) | -| `44` | Channel Mute User | [28](28.md) | -| `1063` | File Metadata | [94](94.md) | -| `1311` | Live Chat Message | [53](53.md) | -| `1040` | OpenTimestamps | [03](03.md) | -| `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) | -| `1984` | Reporting | [56](56.md) | -| `1985` | Label | [32](32.md) | -| `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) | -| `9041` | Zap Goal | [75](75.md) | -| `9734` | Zap Request | [57](57.md) | -| `9735` | Zap | [57](57.md) | -| `9802` | Highlights | [84](84.md) | -| `10002` | Relay List Metadata | [65](65.md) | -| `13194` | Wallet Info | [47](47.md) | -| `22242` | Client Authentication | [42](42.md) | -| `23194` | Wallet Request | [47](47.md) | -| `23195` | Wallet Response | [47](47.md) | -| `24133` | Nostr Connect | [46](46.md) | -| `27235` | HTTP Auth | [98](98.md) | -| `30000` | People List | [51](51.md) | -| `30001` | Things List | [51](51.md) | -| `30002` | Relay Set | [51](51.md) | -| `30008` | Profile Badges | [58](58.md) | -| `30009` | Badge Definition | [58](58.md) | -| `30017` | Create or update a stall | [15](15.md) | -| `30018` | Create or update a product | [15](15.md) | -| `30023` | Long-form Content | [23](23.md) | -| `30024` | Draft Long-form Content | [23](23.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) | -| `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) | -| `34550` | Community Definition | [72](72.md) | +| kind | description | NIP | +| ------------- | -------------------------- | ----------- | +| `0` | Metadata | [1](01.md) | +| `1` | Short Text Note | [1](01.md) | +| `2` | Recommend Relay | | +| `3` | Contacts | [2](02.md) | +| `4` | Encrypted Direct Messages | [4](04.md) | +| `5` | Event Deletion | [9](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `16` | Generic Repost | [18](18.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1040` | OpenTimestamps | [03](03.md) | +| `1971` | Problem Tracker | [nostrocket-1971][nostrocket-1971] | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `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) | +| `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 | [65](65.md) | +| `10002` | Relay List Metadata | [65](65.md) | +| `13194` | Wallet Info | [47](47.md) | +| `22242` | Client Authentication | [42](42.md) | +| `23194` | Wallet Request | [47](47.md) | +| `23195` | Wallet Response | [47](47.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `27235` | HTTP Auth | [98](98.md) | +| `30001` | Generic lists | [51](51.md) | +| `30002` | Relay sets | [51](51.md) | +| `30004` | Curation sets | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.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) | +| `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) | +| `34550` | Community Definition | [72](72.md) | + +[nostrocket-1971]: https://github.com/nostrocket/NIPS/blob/main/Problems.md ## Message types From 54befcc09a3fdd804ee3f98a8a670c582cd101cc Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 15:32:09 -0300 Subject: [PATCH 086/192] deprecate the 30001 ad-hoc pin/bookmark/communities lists and use new kinds. --- 51.md | 23 ++++++++++++----------- README.md | 5 ++++- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/51.md b/51.md index d113f805..d316bad1 100644 --- a/51.md +++ b/51.md @@ -30,12 +30,12 @@ rely on them to augment the user profile or browsing experience. For example, _mute lists_ 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 | "d" tag | description | expected tag items | -| --- | --- | --- | --- | --- | -| Mute list | 10000 | | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | -| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | -| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Communities list | 30001 | `"communities"` | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | +| Pin list | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Bookmarks list | 10003 | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | +| Communities list | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | ## Sets @@ -59,11 +59,12 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above: -- kind:30000 and `d` "mute" - -| kind | "d" tag | use instead | -| --- | --- | --- | -| 30000 | `"mute"` | kind 10000 _mute list_ | +| kind | "d" tag | use instead | +| --- | --- | --- | +| 30000 | `"mute"` | kind 10000 _mute list_ | +| 30001 | `"pin"` | kind 10001 _pin list_ | +| 30001 | `"bookmark"` | kind 10003 _bookmarks list_ | +| 30001 | `"communities"` | kind 10004 _communities list_ | ## Examples diff --git a/README.md b/README.md index 94be17e7..c0286ca4 100644 --- a/README.md +++ b/README.md @@ -105,8 +105,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `9802` | Highlights | [84](84.md) | -| `10000` | Mute list | [65](65.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) | | `13194` | Wallet Info | [47](47.md) | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | From 61b736574cde8e954efe70da3c8c9116297cebf0 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 15:32:22 -0300 Subject: [PATCH 087/192] add kind 30005 follow sets. --- 51.md | 9 +++++---- README.md | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/51.md b/51.md index d316bad1..e0bafdb8 100644 --- a/51.md +++ b/51.md @@ -50,10 +50,11 @@ can be used by apps to showcase curations made by others tagged to different top Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tag that can be used to enhance their UI. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | -| Article Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | +| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Follow sets | 30005 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | ## Deprecated standard lists diff --git a/README.md b/README.md index c0286ca4..6894daa9 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30001` | Generic lists | [51](51.md) | | `30002` | Relay sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | +| `30005` | Follow sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30017` | Create or update a stall | [15](15.md) | From 4db99145d7ae9df84f3d99681fa2df8320702a75 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 15:34:46 -0300 Subject: [PATCH 088/192] remove legacy communities list example. --- 51.md | 27 --------------------------- 1 file changed, 27 deletions(-) diff --git a/51.md b/51.md index e0bafdb8..3fc68309 100644 --- a/51.md +++ b/51.md @@ -86,33 +86,6 @@ Some clients have used these lists in the past, but they should work on transiti } ``` -### A _communities list_ with just public items - -```json -{ - "id": "da6b18c5452b5a60bf49588fc13ae4d1a047519c13e49a77b3184e6188c7bb1c", - "pubkey": "83fd07de9b763334cc9d46f2785c2558e6c2eabfe7d0c6ec214667cbaec50d47", - "created_at": 1689082210, - "kind": 30001, - "tags": [ - [ - "d", - "communities" - ], - [ - "a", - "34550:83fd07de9b763334cc9d46f2785c2558e6c2eabfe7d0c6ec214667cbaec50d47:meme" - ], - [ - "a", - "34550:b9a537523bba2fcdae857d90d8a760de4f2139c9f90d986f747ce7d0ec0d173d:NoBullshitBitcoin" - ] - ], - "content": "", - "sig": "e400cc8bf24955243137e4456b22142fdff400a7950cf0b0ac2ee86ed78671e2fddf9a9b40c77ccf8397f9c21d608b3fab3678ff13713fc3f97a4394cf766079" -} -``` - ### A _curation set_ of articles and notes about yaks ``` From 804ee187c2c18d6896ff2ef4e001eb55bd1e7af6 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 15:39:23 -0300 Subject: [PATCH 089/192] make follow sets kind 30000 as per @monlovesmango's comment. --- 51.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/51.md b/51.md index 3fc68309..d319b815 100644 --- a/51.md +++ b/51.md @@ -52,9 +52,9 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | name | kind | description | expected tag items | | --- | --- | --- | --- | +| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | -| Follow sets | 30005 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | ## Deprecated standard lists diff --git a/README.md b/README.md index 6894daa9..23772adf 100644 --- a/README.md +++ b/README.md @@ -116,10 +116,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `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) | | `30004` | Curation sets | [51](51.md) | -| `30005` | Follow sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30017` | Create or update a stall | [15](15.md) | From cd598bad5b90eba56eea67bfa512038112fb1ac8 Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Wed, 15 Nov 2023 20:06:00 -0300 Subject: [PATCH 090/192] remove the point that makes kind 30001 be a grab-bag of things Co-authored-by: hodlbod --- 51.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/51.md b/51.md index d319b815..b3256f79 100644 --- a/51.md +++ b/51.md @@ -18,9 +18,6 @@ stored in the `.content`. ### Generic lists -The kind `30001` has been reserved for generic lists. These must be accompanied by a `d` tag identifying the -list, but these have no standard meaning and are generally client-specific (except in the standard cases -specified below). ## Standard lists From 6c3eebf510cd7adb5db6a2598ffb5796693fc4dd Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Wed, 15 Nov 2023 20:06:49 -0300 Subject: [PATCH 091/192] clarify that standard lists use normal replaceable events Co-authored-by: hodlbod --- 51.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/51.md b/51.md index b3256f79..1fd3ef58 100644 --- a/51.md +++ b/51.md @@ -21,8 +21,9 @@ stored in the `.content`. ## Standard lists -Users are expected to have a single list of each of these types. They have special meaning and clients may -rely on them to augment the user profile or browsing experience. +Standard lists use non-parameterized replaceable events, meaning users may only have a single list +of each kind. They have special meaning and clients may rely on them to augment a user's profile or +browsing experience. For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. From 31382e57a1fabea855300461e7ef2dc751aaba61 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 20:52:10 -0300 Subject: [PATCH 092/192] add muted words, blocked relays, search relays, chat groups, emoji list and emoji sets. update set metadata tags. following @vitorpamplona, @frnandu, @snowcait, @hzrd149 closes https://github.com/nostr-protocol/nips/pull/559 closes https://github.com/nostr-protocol/nips/pull/673 --- 51.md | 46 ++++++++++++++++++---------------------------- README.md | 5 +++++ 2 files changed, 23 insertions(+), 28 deletions(-) diff --git a/51.md b/51.md index 1fd3ef58..86713701 100644 --- a/51.md +++ b/51.md @@ -16,9 +16,6 @@ stored in the `.content`. ## Types of lists -### Generic lists - - ## Standard lists Standard lists use non-parameterized replaceable events, meaning users may only have a single list @@ -28,12 +25,16 @@ browsing experience. For example, _mute lists_ 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) | -| Pin list | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Bookmarks list | 10003 | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | -| Communities list | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| 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 | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | +| 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 community 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) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | ## Sets @@ -45,18 +46,19 @@ For example, _relay sets_ can be displayed in a dropdown UI to give users the op relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ can be used by apps to showcase curations made by others tagged to different topics. -Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a -`"description"` tag that can be used to enhance their UI. +Aside from their main identifier, the `"d"` tag, sets can optionally have a `"name"`, a `"picture"` and an +`"about"` tag that can be used to enhance their UI. | name | kind | description | expected tag items | | --- | --- | --- | --- | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | ## Deprecated standard lists -Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above: +Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. | kind | "d" tag | use instead | | --- | --- | --- | @@ -93,22 +95,10 @@ Some clients have used these lists in the past, but they should work on transiti "created_at": 1695327657, "kind": 30004, "tags": [ - [ - "d", - "jvdy9i4" - ], - [ - "title", - "Yaks" - ], - [ - "summary", - "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia." - ], - [ - "image", - "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg" - ], + ["d", "jvdy9i4"], + ["name", "Yaks"], + ["picture", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"], + ["about", "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia."], ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], diff --git a/README.md b/README.md index 23772adf..91d6f84a 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `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) | +| `10030` | User emoji list | [51](51.md) | | `13194` | Wallet Info | [47](47.md) | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | @@ -122,6 +126,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30004` | Curation sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | +| `30030` | Emoji sets | [51](51.md) | | `30017` | Create or update a stall | [15](15.md) | | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | From 37f6cbb775126b386414220f783ca0f5f85e7614 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 21:42:51 -0300 Subject: [PATCH 093/192] remove all NIP authors. --- 01.md | 2 +- 02.md | 2 +- 03.md | 2 +- 04.md | 2 +- 05.md | 2 +- 06.md | 2 +- 07.md | 2 +- 08.md | 2 +- 09.md | 2 +- 10.md | 2 +- 11.md | 2 +- 12.md | 2 +- 13.md | 2 +- 14.md | 2 +- 15.md | 2 +- 16.md | 2 +- 18.md | 2 +- 19.md | 2 +- 20.md | 2 +- 21.md | 2 +- 22.md | 2 +- 23.md | 2 +- 24.md | 2 +- 25.md | 2 +- 26.md | 2 +- 27.md | 2 +- 28.md | 2 +- 30.md | 2 +- 31.md | 2 +- 32.md | 2 +- 33.md | 2 +- 36.md | 2 +- 38.md | 2 +- 39.md | 2 +- 40.md | 2 +- 42.md | 2 +- 45.md | 2 +- 46.md | 2 +- 47.md | 2 +- 48.md | 2 +- 50.md | 2 +- 51.md | 2 +- 52.md | 2 +- 53.md | 2 +- 56.md | 2 +- 57.md | 2 +- 58.md | 2 +- 65.md | 2 +- 72.md | 2 +- 75.md | 2 +- 78.md | 2 +- 84.md | 2 +- 89.md | 2 +- 90.md | 2 +- 94.md | 2 +- 98.md | 2 +- 99.md | 2 +- 57 files changed, 57 insertions(+), 57 deletions(-) diff --git a/01.md b/01.md index cb4f522d..dafea1d0 100644 --- a/01.md +++ b/01.md @@ -4,7 +4,7 @@ NIP-01 Basic protocol flow description ------------------------------- -`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` `author:cameri` `author:Giszmo` +`draft` `mandatory` This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. diff --git a/02.md b/02.md index 2f199080..0653d062 100644 --- a/02.md +++ b/02.md @@ -4,7 +4,7 @@ NIP-02 Contact List and Petnames ------------------------- -`final` `optional` `author:fiatjaf` `author:arcbtc` +`final` `optional` A special event with kind `3`, meaning "contact list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. diff --git a/03.md b/03.md index 680cc8b2..8b7deb62 100644 --- a/03.md +++ b/03.md @@ -4,7 +4,7 @@ NIP-03 OpenTimestamps Attestations for Events -------------------------------------- -`draft` `optional` `author:fiatjaf` `author:constant` +`draft` `optional` This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps](https://opentimestamps.org/) proof for any other event: diff --git a/04.md b/04.md index 6e45b74b..bf6767b7 100644 --- a/04.md +++ b/04.md @@ -4,7 +4,7 @@ NIP-04 Encrypted Direct Message ------------------------ -`final` `optional` `author:arcbtc` +`final` `optional` A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes: diff --git a/05.md b/05.md index 00d69af6..64375506 100644 --- a/05.md +++ b/05.md @@ -4,7 +4,7 @@ NIP-05 Mapping Nostr keys to DNS-based internet identifiers ---------------------------------------------------- -`final` `optional` `author:fiatjaf` `author:mikedilger` +`final` `optional` On events of kind `0` (`metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. diff --git a/06.md b/06.md index a0b4a01b..0e502543 100644 --- a/06.md +++ b/06.md @@ -4,7 +4,7 @@ NIP-06 Basic key derivation from mnemonic seed phrase ---------------------------------------------- -`draft` `optional` `author:fiatjaf` +`draft` `optional` [BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them. diff --git a/07.md b/07.md index 51ddc165..01af6f40 100644 --- a/07.md +++ b/07.md @@ -4,7 +4,7 @@ NIP-07 `window.nostr` capability for web browsers ------------------------------------------ -`draft` `optional` `author:fiatjaf` +`draft` `optional` The `window.nostr` object may be made available by web browsers or extensions and websites or web-apps may make use of it after checking its availability. diff --git a/08.md b/08.md index 6793e0bb..f4f4341d 100644 --- a/08.md +++ b/08.md @@ -6,7 +6,7 @@ NIP-08 Handling Mentions ----------------- -`final` `unrecommended` `optional` `author:fiatjaf` `author:scsibug` +`final` `unrecommended` `optional` This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. diff --git a/09.md b/09.md index 9dab90ff..f92410fa 100644 --- a/09.md +++ b/09.md @@ -4,7 +4,7 @@ NIP-09 Event Deletion -------------- -`draft` `optional` `author:scsibug` +`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. diff --git a/10.md b/10.md index 9c79b4a2..5b19fbd3 100644 --- a/10.md +++ b/10.md @@ -5,7 +5,7 @@ NIP-10 On "e" and "p" tags in Text Events (kind 1). -------------------------------------------- -`draft` `optional` `author:unclebobmartin` +`draft` `optional` ## Abstract This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. diff --git a/11.md b/11.md index deb6f197..017e5d42 100644 --- a/11.md +++ b/11.md @@ -4,7 +4,7 @@ NIP-11 Relay Information Document --------------------------- -`draft` `optional` `author:scsibug` `author:doc-hex` `author:cameri` +`draft` `optional` Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. diff --git a/12.md b/12.md index 93579779..bf0eda9e 100644 --- a/12.md +++ b/12.md @@ -4,6 +4,6 @@ NIP-12 Generic Tag Queries ------------------- -`final` `mandatory` `author:scsibug` `author:fiatjaf` +`final` `mandatory` Moved to [NIP-01](01.md). diff --git a/13.md b/13.md index 01787336..4b15bbe5 100644 --- a/13.md +++ b/13.md @@ -4,7 +4,7 @@ NIP-13 Proof of Work ------------- -`draft` `optional` `author:jb55` `author:cameri` +`draft` `optional` This NIP defines a way to generate and interpret Proof of Work for nostr notes. Proof of Work (PoW) is a way to add a proof of computational work to a note. This is a bearer proof that all relays and clients can universally validate with a small amount of code. This proof can be used as a means of spam deterrence. diff --git a/14.md b/14.md index 7384394e..72e5e396 100644 --- a/14.md +++ b/14.md @@ -4,7 +4,7 @@ NIP-14 Subject tag in Text events -------------------------- -`draft` `optional` `author:unclebobmartin` +`draft` `optional` This NIP defines the use of the "subject" tag in text (kind: 1) events. (implemented in more-speech) diff --git a/15.md b/15.md index 68d28ff1..0ee000fa 100644 --- a/15.md +++ b/15.md @@ -4,7 +4,7 @@ NIP-15 Nostr Marketplace (for resilient marketplaces) ----------------------------------- -`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` +`draft` `optional` > Based on https://github.com/lnbits/Diagon-Alley diff --git a/16.md b/16.md index 78ec7086..00320832 100644 --- a/16.md +++ b/16.md @@ -4,6 +4,6 @@ NIP-16 Event Treatment --------------- -`final` `mandatory` `author:Semisol` +`final` `mandatory` Moved to [NIP-01](01.md). diff --git a/18.md b/18.md index 75c4100c..ba96c895 100644 --- a/18.md +++ b/18.md @@ -4,7 +4,7 @@ NIP-18 Reposts ------- -`draft` `optional` `author:jb55` `author:fiatjaf` `author:arthurfranca` +`draft` `optional` A repost is a `kind 6` event that is used to signal to followers that a `kind 1` text note is worth reading. diff --git a/19.md b/19.md index cd989e21..ef808870 100644 --- a/19.md +++ b/19.md @@ -4,7 +4,7 @@ NIP-19 bech32-encoded entities ----------------------- -`draft` `optional` `author:jb55` `author:fiatjaf` `author:Semisol` +`draft` `optional` This NIP standardizes bech32-formatted strings that can be used to display keys, ids and other information in clients. These formats are not meant to be used anywhere in the core protocol, they are only meant for displaying to users, copy-pasting, sharing, rendering QR codes and inputting data. diff --git a/20.md b/20.md index ec6127a0..6feed6a9 100644 --- a/20.md +++ b/20.md @@ -4,6 +4,6 @@ NIP-20 Command Results --------------- -`final` `mandatory` `author:jb55` +`final` `mandatory` Moved to [NIP-01](01.md). diff --git a/21.md b/21.md index 6246eb49..6ed141a8 100644 --- a/21.md +++ b/21.md @@ -4,7 +4,7 @@ NIP-21 `nostr:` URI scheme ------------------- -`draft` `optional` `author:fiatjaf` +`draft` `optional` This NIP standardizes the usage of a common URI scheme for maximum interoperability and openness in the network. diff --git a/22.md b/22.md index f595ebf3..06af4937 100644 --- a/22.md +++ b/22.md @@ -4,7 +4,7 @@ NIP-22 Event `created_at` Limits ------------------------- -`draft` `optional` `author:jeffthibault` `author:Giszmo` +`draft` `optional` Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md). diff --git a/23.md b/23.md index 76c0a69b..382df837 100644 --- a/23.md +++ b/23.md @@ -4,7 +4,7 @@ NIP-23 Long-form Content ----------------- -`draft` `optional` `author:fiatjaf` +`draft` `optional` This NIP defines `kind:30023` (a _parameterized replaceable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. diff --git a/24.md b/24.md index b88d990a..f830b68d 100644 --- a/24.md +++ b/24.md @@ -4,7 +4,7 @@ NIP-24 Extra metadata fields and tags ------------------------------ -`draft` `optional` `author:fiatjaf` +`draft` `optional` This NIP defines extra optional fields added to events. diff --git a/25.md b/25.md index 7b29140a..3b4aa590 100644 --- a/25.md +++ b/25.md @@ -5,7 +5,7 @@ NIP-25 Reactions --------- -`draft` `optional` `author:jb55` +`draft` `optional` A reaction is a `kind 7` event that is used to react to other events. diff --git a/26.md b/26.md index 59cf807f..86c46e1f 100644 --- a/26.md +++ b/26.md @@ -4,7 +4,7 @@ NIP-26 Delegated Event Signing ----- -`draft` `optional` `author:markharding` `author:minds` +`draft` `optional` This NIP defines how events can be delegated so that they can be signed by other keypairs. diff --git a/27.md b/27.md index 6d761206..efd2c122 100644 --- a/27.md +++ b/27.md @@ -4,7 +4,7 @@ NIP-27 Text Note References -------------------- -`draft` `optional` `author:arthurfranca` `author:hodlbod` `author:fiatjaf` +`draft` `optional` This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023). diff --git a/28.md b/28.md index 62ab398f..59e9389b 100644 --- a/28.md +++ b/28.md @@ -5,7 +5,7 @@ NIP-28 Public Chat ----------- -`draft` `optional` `author:ChristopherDavid` `author:fiatjaf` `author:jb55` `author:Cameri` +`draft` `optional` This NIP defines new event kinds for public chat channels, channel messages, and basic client-side moderation. diff --git a/30.md b/30.md index ffc5aeb3..5a6f84de 100644 --- a/30.md +++ b/30.md @@ -4,7 +4,7 @@ NIP-30 Custom Emoji ------------ -`draft` `optional` `author:alexgleason` +`draft` `optional` Custom emoji may be added to **kind 0** and **kind 1** events by including one or more `"emoji"` tags, in the form: diff --git a/31.md b/31.md index e77ae341..ee920528 100644 --- a/31.md +++ b/31.md @@ -4,7 +4,7 @@ NIP-31 Dealing with unknown event kinds -------------------------------- -`draft` `optional` `author:pablof7z` `author:fiatjaf` +`draft` `optional` When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use an `alt` tag to write a short human-readable plaintext summary of what that event is about. diff --git a/32.md b/32.md index f8dc0029..dfcb35ea 100644 --- a/32.md +++ b/32.md @@ -4,7 +4,7 @@ NIP-32 Labeling --------- -`draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` +`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. diff --git a/33.md b/33.md index 1e7a9fc9..337a1f9b 100644 --- a/33.md +++ b/33.md @@ -4,6 +4,6 @@ NIP-33 Parameterized Replaceable Events -------------------------------- -`final` `mandatory` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` +`final` `mandatory` Moved to [NIP-01](01.md). diff --git a/36.md b/36.md index 6d1cf639..db4c4f2f 100644 --- a/36.md +++ b/36.md @@ -4,7 +4,7 @@ NIP-36 Sensitive Content / Content Warning ----------------------------------- -`draft` `optional` `author:fernandolguevara` +`draft` `optional` The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown. Clients can hide the content until the user acts on it. diff --git a/38.md b/38.md index f1eddcd8..911d5b18 100644 --- a/38.md +++ b/38.md @@ -5,7 +5,7 @@ NIP-38 User Statuses -------------- -`draft` `optional` `author:jb55` +`draft` `optional` ## Abstract diff --git a/39.md b/39.md index b84603c9..c9970fa5 100644 --- a/39.md +++ b/39.md @@ -4,7 +4,7 @@ NIP-39 External Identities in Profiles ------------------------------- -`draft` `optional` `author:pseudozach` `author:Semisol` +`draft` `optional` ## Abstract diff --git a/40.md b/40.md index 32680db8..b8a03365 100644 --- a/40.md +++ b/40.md @@ -4,7 +4,7 @@ NIP-40 Expiration Timestamp ----------------------------------- -`draft` `optional` `author:0xtlt` +`draft` `optional` The `expiration` tag enables users to specify a unix timestamp at which the message SHOULD be considered expired (by relays and clients) and SHOULD be deleted by relays. diff --git a/42.md b/42.md index 9b0c45b4..9f0c24dd 100644 --- a/42.md +++ b/42.md @@ -4,7 +4,7 @@ NIP-42 Authentication of clients to relays ----------------------------------- -`draft` `optional` `author:Semisol` `author:fiatjaf` +`draft` `optional` This NIP defines a way for clients to authenticate to relays by signing an ephemeral event. diff --git a/45.md b/45.md index 7b11950a..a3abd19d 100644 --- a/45.md +++ b/45.md @@ -4,7 +4,7 @@ NIP-45 Event Counts -------------- -`draft` `optional` `author:staab` +`draft` `optional` Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts. diff --git a/46.md b/46.md index 90fa1a06..53185416 100644 --- a/46.md +++ b/46.md @@ -4,7 +4,7 @@ NIP-46 Nostr Connect ------------------------ -`draft` `optional` `author:tiero` `author:giowe` `author:vforvalerio87` +`draft` `optional` ## Rationale diff --git a/47.md b/47.md index b6a4f2bc..d4b7c1f7 100644 --- a/47.md +++ b/47.md @@ -4,7 +4,7 @@ NIP-47 Nostr Wallet Connect -------------------- -`draft` `optional` `author:kiwiidb` `author:bumi` `author:semisol` `author:vitorpamplona` +`draft` `optional` ## Rationale diff --git a/48.md b/48.md index 8f227811..2f03e002 100644 --- a/48.md +++ b/48.md @@ -4,7 +4,7 @@ NIP-48 Proxy Tags ---------- -`draft` `optional` `author:alexgleason` +`draft` `optional` Nostr events bridged from other protocols such as ActivityPub can link back to the source object by including a `"proxy"` tag, in the form: diff --git a/50.md b/50.md index 5bda3559..2bdf1ff1 100644 --- a/50.md +++ b/50.md @@ -4,7 +4,7 @@ NIP-50 Search Capability ----------------- -`draft` `optional` `author:brugeman` `author:mikedilger` `author:fiatjaf` +`draft` `optional` ## Abstract diff --git a/51.md b/51.md index e4d7c24e..a8a8e956 100644 --- a/51.md +++ b/51.md @@ -4,7 +4,7 @@ NIP-51 Lists ----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` +`draft` `optional` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. diff --git a/52.md b/52.md index 69507441..15cc8fc5 100644 --- a/52.md +++ b/52.md @@ -4,7 +4,7 @@ NIP-52 Calendar Events --------------- -`draft` `optional` `author:tyiu` +`draft` `optional` This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _parameterized replaceable_ and deletable per [NIP-09](09.md). diff --git a/53.md b/53.md index b3d416b7..c4789ea1 100644 --- a/53.md +++ b/53.md @@ -4,7 +4,7 @@ NIP-53 Live Activities --------------- -`draft` `optional` `author:vitorpamplona` `author:v0l` +`draft` `optional` ## Abstract diff --git a/56.md b/56.md index 259118d7..0c951b5b 100644 --- a/56.md +++ b/56.md @@ -5,7 +5,7 @@ NIP-56 Reporting --------- -`draft` `optional` `author:jb55` +`draft` `optional` A report is a `kind 1984` note that is used to report other notes for spam, illegal and explicit content. diff --git a/57.md b/57.md index 849c8696..2b2c97b9 100644 --- a/57.md +++ b/57.md @@ -4,7 +4,7 @@ NIP-57 Lightning Zaps -------------- -`draft` `optional` `author:jb55` `author:kieran` +`draft` `optional` This NIP defines two new event types for recording lightning payments between users. `9734` is a `zap request`, representing a payer's request to a recipient's lightning wallet for an invoice. `9735` is a `zap receipt`, representing the confirmation by the recipient's lightning wallet that the invoice issued in response to a `zap request` has been paid. diff --git a/58.md b/58.md index ccabc7b6..9725c82a 100644 --- a/58.md +++ b/58.md @@ -4,7 +4,7 @@ NIP-58 Badges ------ -`draft` `optional` `author:cameri` +`draft` `optional` Three special events are used to define, award and display badges in user profiles: diff --git a/65.md b/65.md index cdfe9bf5..4a6f5a11 100644 --- a/65.md +++ b/65.md @@ -4,7 +4,7 @@ NIP-65 Relay List Metadata ------------------- -`draft` `optional` `author:mikedilger` `author:vitorpamplona` +`draft` `optional` Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. diff --git a/72.md b/72.md index 599a4c45..833336ce 100644 --- a/72.md +++ b/72.md @@ -4,7 +4,7 @@ NIP-72 Moderated Communities (Reddit Style) ------------------------------------ -`draft` `optional` `author:vitorpamplona` `author:arthurfranca` +`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. diff --git a/75.md b/75.md index 6c8cb7b1..3a89f904 100644 --- a/75.md +++ b/75.md @@ -2,7 +2,7 @@ ## Zap Goals -`draft` `optional` `author:verbiricha` +`draft` `optional` This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event. diff --git a/78.md b/78.md index 10ff5358..0f2fadac 100644 --- a/78.md +++ b/78.md @@ -4,7 +4,7 @@ NIP-78 Arbitrary custom app data ------------------------- -`draft` `optional` `author:sandwich` `author:fiatjaf` +`draft` `optional` The goal of this NIP is to enable [remoteStorage](https://remotestorage.io/)-like capabilities for custom applications that do not care about interoperability. diff --git a/84.md b/84.md index 4caab62a..308cbddd 100644 --- a/84.md +++ b/84.md @@ -4,7 +4,7 @@ NIP-84 Highlights ---------- -`draft` `optional` `author:pablof7z` +`draft` `optional` This NIP defines `kind:9802`, a "highlight" event, to signal content a user finds valuable. diff --git a/89.md b/89.md index 4503ecfd..2e5b7992 100644 --- a/89.md +++ b/89.md @@ -4,7 +4,7 @@ NIP-89 Recommended Application Handlers -------------------------------- -`draft` `optional` `author:pablof7z` +`draft` `optional` This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds. diff --git a/90.md b/90.md index 31447f28..fe0d89cd 100644 --- a/90.md +++ b/90.md @@ -4,7 +4,7 @@ NIP-90 Data Vending Machine -------------------- -`draft` `optional` `author:pablof7z` `author:dontbelievethehype` +`draft` `optional` This NIP defines the interaction between customers and Service Providers for performing on-demand computation. diff --git a/94.md b/94.md index c5e0f182..0b76c25b 100644 --- a/94.md +++ b/94.md @@ -4,7 +4,7 @@ NIP-94 File Metadata ------------- -`draft` `optional` `author:frbitten` `author:kieran` `author:lovvtide` `author:fiatjaf` `author:staab` +`draft` `optional` The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with kind:1 notes or by longform clients that deal with kind:30023 articles. diff --git a/98.md b/98.md index c8cba0f5..e04c7fc1 100644 --- a/98.md +++ b/98.md @@ -4,7 +4,7 @@ NIP-98 HTTP Auth ------------------------- -`draft` `optional` `author:kieran` `author:melvincarvalho` +`draft` `optional` This NIP defines an ephemeral event used to authorize requests to HTTP servers using nostr events. diff --git a/99.md b/99.md index 274e5afb..9e8f1dad 100644 --- a/99.md +++ b/99.md @@ -2,7 +2,7 @@ ## Classified Listings -`draft` `optional` `author:erskingardner` +`draft` `optional` 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. From 7f27800e27c437ce17d223799f37631105d1ae5f Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Thu, 16 Nov 2023 05:43:28 -0800 Subject: [PATCH 094/192] Add client tag to nip 89 --- 89.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/89.md b/89.md index 4503ecfd..04f19179 100644 --- a/89.md +++ b/89.md @@ -74,6 +74,19 @@ Multiple tags might be registered by the app, following NIP-19 nomenclature as t A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag. +# Client tag +When publishing events, clients MAY include a `client` tag in the same format as the recommendation event's `a` tags. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. + +```json +{ + "kind": 1, + "tags": [ + ["client", "31990:app1-pubkey:", "wss://relay1", "ios"] + ] + ... +} +``` + # User flow A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application. @@ -113,4 +126,4 @@ User B's client sees the application's `kind:31990` which includes the informati ## Alternative query bypassing `kind:31989` Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms to avoid directing users to malicious handlers. -`["REQ", , '[{ "kinds": [31990], "#k": [], 'authors': [...] }]']` \ No newline at end of file +`["REQ", , '[{ "kinds": [31990], "#k": [], 'authors': [...] }]']` From 2a0b701ff77d4ffd686661d829b7b7091e29589b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 16 Nov 2023 12:26:50 -0300 Subject: [PATCH 095/192] add bookmark sets (following @staab). --- 51.md | 33 +++++++++++++++++---------------- README.md | 1 + 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/51.md b/51.md index 86713701..ab15be48 100644 --- a/51.md +++ b/51.md @@ -25,16 +25,16 @@ browsing experience. For example, _mute lists_ 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 | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | -| 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 community 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) | -| 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 community 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) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | ## Sets @@ -49,12 +49,13 @@ can be used by apps to showcase curations made by others tagged to different top Aside from their main identifier, the `"d"` tag, sets can optionally have a `"name"`, a `"picture"` and an `"about"` tag that can be used to enhance their UI. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | -| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | -| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | -| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | +| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | +| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | ## Deprecated standard lists diff --git a/README.md b/README.md index 91d6f84a..36d5fc07 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `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) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | From 4a77fc5c402ec6c4cbdb574f9260e62fd2fc7bf4 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 16 Nov 2023 15:50:39 -0300 Subject: [PATCH 096/192] add interests list and interests sets (following @erskingardner and @pablof7z). --- 51.md | 2 ++ README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/51.md b/51.md index ab15be48..bcab8b8d 100644 --- a/51.md +++ b/51.md @@ -34,6 +34,7 @@ their feeds or receive annoying notifications from. | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 community 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) | +| 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) | ## Sets @@ -55,6 +56,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"na | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | ## Deprecated standard lists diff --git a/README.md b/README.md index 36d5fc07..790f0b6a 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10005` | Public chats list | [51](51.md) | | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | +| `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `13194` | Wallet Info | [47](47.md) | | `22242` | Client Authentication | [42](42.md) | @@ -127,6 +128,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30004` | Curation sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | +| `30015` | Interest sets | [51](51.md) | | `30030` | Emoji sets | [51](51.md) | | `30017` | Create or update a stall | [15](15.md) | | `30018` | Create or update a product | [15](15.md) | From e7e64af04aaf57461392acf117438038c4613eb0 Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Fri, 17 Nov 2023 12:22:43 +0900 Subject: [PATCH 097/192] fix typos --- 84.md | 2 +- 90.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/84.md b/84.md index 308cbddd..303cd933 100644 --- a/84.md +++ b/84.md @@ -34,4 +34,4 @@ last value of the tag. ### Context Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the -surrounding content might be beneficial to give context to the higlight. +surrounding content might be beneficial to give context to the highlight. diff --git a/90.md b/90.md index fe0d89cd..c498cddd 100644 --- a/90.md +++ b/90.md @@ -162,7 +162,7 @@ Service providers can give feedback about a job back to the customer. * `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. -* NOTE: If the input params requires input to be encryped, then `content` field will have encrypted payload with `p` tag as key. +* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key. ### Job feedback status From 4d709d1804de45bab3739ce814d4b0c0b211c273 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:12:47 +0300 Subject: [PATCH 098/192] add form feed and backspace --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index f5673b38..0840f2e6 100644 --- a/01.md +++ b/01.md @@ -46,11 +46,13 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: - No whitespace, line breaks or other unnecessary formatting should be included in the output JSON. - No characters except the following should be escaped, and instead should be included verbatim: - - The line break, `0x0A`, as `\n` + - A line break, `0x0A`, as `\n` - A double quote, `0x22`, as `\"` - A backslash, `0x5C`, as `\\` - A carriage return, `0x0D`, as `\r` - A tab character, `0x09`, as `\t` + - A backspace, `0x08`, as `\b` + - A form feed, `0x0C`, as `\f` - UTF-8 should be used for encoding. ## Communication between clients and relays From 5f1d10fad24a1c860dc46e87e371b517500ed49b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 17 Nov 2023 18:05:23 -0500 Subject: [PATCH 099/192] Adds contributor images to the readme. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 483056dc..1274b926 100644 --- a/README.md +++ b/README.md @@ -230,3 +230,9 @@ mailing lists where you can work on NIPs before submitting them here: ## License All NIPs are public domain. + +## Contributors + + + + From 33e7650bab299b980e053e8c44e93fb895dc4df5 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 16 Nov 2023 10:52:35 -0300 Subject: [PATCH 100/192] give a better and updated explanation of how nips work in the readme. --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1274b926..8e970ead 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # NIPs NIPs stand for **Nostr Implementation Possibilities**. + They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software. --- @@ -12,7 +13,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [Relay to Client](#relay-to-client) - [Standardized Tags](#standardized-tags) - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) -- [Mailing Lists](#mailing-lists) +- [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) +- [How this repository works](#how-this-repository-works) - [License](#license) --- @@ -212,20 +214,19 @@ Please update these lists when proposing NIPs introducing new event kinds. 4. There should be no more than one way of doing the same thing. 5. Other rules will be made up when necessary. -## Mailing Lists +## Is this repository a centralizing factor? -The nostr ecosystem is getting large with many different organizations, relays -and clients. Following the nips repo on github is becoming more difficult and -noisy. To coordinate on protocol development outside of github, there are -mailing lists where you can work on NIPs before submitting them here: +To promote interoperability, we standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. -* [w3c nostr community group][w3-nostr] - [public-nostr@w3.org][mailto-w3] - requires signup -* [nostr-protocol google group][nostr-google-group] - [nostr-protocol@googlegroups.com][mailto-google] - no signup required +It can even fork into multiple and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. -[w3-nostr]: https://www.w3.org/community/nostr/ -[mailto-w3]: mailto:public-nostr@w3.org -[nostr-google-group]: https://groups.google.com/g/nostr-protocol -[mailto-google]: mailto:nostr-protocol@googlegroups.com +There is a list of notable Nostr software developers who have commit access to this repository, but that exists mostly for practical reasons, as by the nature of the thing we're dealing with the repository owner can revoke membership and rewrite history as they want -- and if these actions are unjustified or perceived as bad or evil the community must react. + +## How this repository works + +Standards may emerge in two ways: the first way is that someone starts doing something, then others copy it; the second way is that someone has an idea of a new standard that could benefit multiple clients and the protocol in general without breaking **backwards-compatibility** and the principle of having **a single way of doing things**, then they write that idea and submit it to this repository, other interested parties read it and give their feedback, then once most people reasonably agree we codify that in a NIP which client and relay developers that are interested in the feature can proceed to implement. + +These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful. ## License From b5b46b629fb1b4dae4780d8d165bddd68d4cda68 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 08:21:15 -0300 Subject: [PATCH 101/192] reformat NIP-11. --- 11.md | 154 +++++++++++++++++++++++++++++++--------------------------- 1 file changed, 82 insertions(+), 72 deletions(-) diff --git a/11.md b/11.md index 017e5d42..e05cb1fa 100644 --- a/11.md +++ b/11.md @@ -25,42 +25,42 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application Any field may be omitted, and clients MUST ignore any additional fields they do not understand. Relays MUST accept CORS requests by sending `Access-Control-Allow-Origin`, `Access-Control-Allow-Headers`, and `Access-Control-Allow-Methods` headers. Field Descriptions ------------------ +------------------ -### Name ### +### Name A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation. -### Description ### +### Description Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. -### Pubkey ### +### Pubkey An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See `NIP-04`) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. Relay operators have no obligation to respond to direct messages. -### Contact ### +### Contact An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact. -### Supported NIPs ### +### Supported NIPs As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients. -### Software ### +### Software The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage. -### Version ### +### Version The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. Extra Fields ------------------ +------------ -### Server Limitations ### +### Server Limitations These are limitations imposed by the relay on clients. Your client should expect that requests which exceed these *practical* limitations @@ -68,22 +68,21 @@ are rejected or fail immediately. ```json { -... + ... "limitation": { - "max_message_length": 16384, - "max_subscriptions": 20, - "max_filters": 100, - "max_limit": 5000, - "max_subid_length": 100, - "max_event_tags": 100, - "max_content_length": 8196, - "min_pow_difficulty": 30, - "auth_required": true, - "payment_required": true, - "created_at_lower_limit":31536000, - "created_at_upper_limit":3, + "max_message_length": 16384, + "max_subscriptions": 20, + "max_filters": 100, + "max_limit": 5000, + "max_subid_length": 100, + "max_event_tags": 100, + "max_content_length": 8196, + "min_pow_difficulty": 30, + "auth_required": true, + "payment_required": true, + "created_at_lower_limit": 31536000, + "created_at_upper_limit": 3 } -... } ``` @@ -129,7 +128,7 @@ Even if set to False, authentication may be required for specific actions. - `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md) -### Event Retention ### +### Event Retention There may be a cost associated with storing data forever, so relays may wish to state retention times. The values stated here are defaults @@ -142,14 +141,12 @@ all, and preferably an error will be provided when those are received. ```json { -... "retention": [ - { "kinds": [0, 1, [5, 7], [40, 49]], "time": 3600 }, - { "kinds": [[40000, 49999]], "time": 100 }, - { "kinds": [[30000, 39999]], "count": 1000 }, - { "time": 3600, "count": 10000 } + {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600}, + {"kinds": [[40000, 49999]], "time": 100}, + {"kinds": [[30000, 39999]], "count": 1000}, + {"time": 3600, "count": 10000} ] -... } ``` @@ -165,8 +162,7 @@ support their protocol quickly via a single HTTP fetch. There is no need to specify retention times for _ephemeral events_ since they are not retained. - -### Content Limitations ### +### Content Limitations Some relays may be governed by the arbitrary laws of a nation state. This may limit what content can be stored in cleartext on those relays. All @@ -185,9 +181,8 @@ flexibility is up to the client software. ```json { -... - "relay_countries": [ "CA", "US" ], -... + ... + "relay_countries": [ "CA", "US" ] } ``` @@ -199,7 +194,7 @@ country of the legal entities who own the relay, so it's very likely a number of countries are involved. -### Community Preferences ### +### Community Preferences For public text notes at least, a relay may try to foster a local community. This would encourage users to follow the global @@ -208,11 +203,10 @@ To support this goal, relays MAY specify some of the following values. ```json { -... + ... "language_tags": [ "en", "en-419" ], "tags": [ "sfw-only", "bitcoin-only", "anime" ], - "posting_policy": "https://example.com/posting-policy.html", -... + "posting_policy": "https://example.com/posting-policy.html" } ``` @@ -239,59 +233,75 @@ detail and legal terms. Use the `tags` field to signify limitations on content, or topics to be discussed, which could be machine processed by appropriate client software. -### Pay-To-Relay ### +### Pay-to-Relay Relays that require payments may want to expose their fee schedules. ```json { -... + ... "payments_url": "https://my-relay/payments", "fees": { "admission": [{ "amount": 1000000, "unit": "msats" }], "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], - }, -... + } } ``` -### Icon ### +### Icon A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. ```json { -... + ... "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", -... } ``` -### Examples ### -As of 2 May 2023 the following `curl` command provided these results. +### Examples - >curl -H "Accept: application/nostr+json" https://eden.nostr.land +As of 2 May 2023 the following command provided these results: - {"name":"eden.nostr.land", - "description":"Eden Nostr Land - Toronto 1-01", - "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", - "contact":"me@ricardocabral.io", - "supported_nips":[1,2,4,9,11,12,15,16,20,22,26,28,33,40], - "supported_nip_extensions":["11a"], - "software":"git+https://github.com/Cameri/nostream.git", - "version":"1.22.6", - "limitation":{"max_message_length":1048576, - "max_subscriptions":10, - "max_filters":2500, - "max_limit":5000, - "max_subid_length":256, - "max_event_tags":2500, - "max_content_length":65536, - "min_pow_difficulty":0, - "auth_required":false, - "payment_required":true}, - "payments_url":"https://eden.nostr.land/invoices", - "fees":{"admission":[{"amount":5000000,"unit":"msats"}], - "publication":[]}}, - "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" +``` +~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq + +{ + "description": "nostr.land family of relays (us-or-01)", + "name": "nostr.land", + "pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd", + "software": "custom", + "supported_nips": [ + 1, + 2, + 4, + 9, + 11, + 12, + 16, + 20, + 22, + 28, + 33, + 40 + ], + "version": "1.0.1", + "limitation": { + "payment_required": true, + "max_message_length": 65535, + "max_event_tags": 2000, + "max_subscriptions": 20, + "auth_required": false + }, + "payments_url": "https://eden.nostr.land", + "fees": { + "subscription": [ + { + "amount": 2500000, + "unit": "msats", + "period": 2592000 + } + ] + }, +} From 7aa751be46d515d7612998a4da88285cb0957cd3 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 08:22:42 -0300 Subject: [PATCH 102/192] NIP-03: explain why a single attestation is recommended. --- 03.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/03.md b/03.md index 8b7deb62..74e010cb 100644 --- a/03.md +++ b/03.md @@ -20,7 +20,7 @@ This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps]( ``` - The OpenTimestamps proof MUST prove the referenced `e` event id as its digest. -- The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation and no reference to "pending" attestations since they are useless in this context. +- The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation (as not more than one valid attestation is necessary and less bytes is better than more) and no reference to "pending" attestations since they are useless in this context. ### Example OpenTimestamps proof verification flow From b0df71824f9967130b54150b64cc70fa94bffec2 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 08:48:49 -0300 Subject: [PATCH 103/192] NIP-72: reformat and clarify some things. --- 72.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/72.md b/72.md index 833336ce..74c7f086 100644 --- a/72.md +++ b/72.md @@ -10,16 +10,15 @@ The goal of this NIP is to create moderator-approved public communities around a # Community Definition -`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. +`kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. ```json { - "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", - "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + ... "created_at": , "kind": 34550, "tags": [ - ["d", ""], + ["d", ""], ["description", ""], ["image", "", "x"], @@ -41,18 +40,16 @@ The goal of this NIP is to create moderator-approved public communities around a # New Post Request -Any Nostr event can be a post request. Clients 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 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. ```json { - "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", - "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": , + ... "kind": 1, "tags": [ - ["a", "34550::", ""], + ["a", "34550::", ""], ], - "content": "" + "content": "hello world" } ``` @@ -64,17 +61,16 @@ The post-approval event MUST include `a` tags of the communities the moderator i ```json { - "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + ... "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": , "kind": 4550, "tags": [ - ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], - ["k", ""], + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], + ["k", ""] ], - "content": "" + "content": "" } ``` @@ -91,11 +87,15 @@ Community clients SHOULD display posts that have been approved by at least 1 mod The following filter displays the approved posts. ```js -{ - "authors": ["", "", "", "", ...], - "kinds": [4550], - "#a": ["34550::"], -} +[ + "REQ", + "_", + { + "authors": ["", "", "", "", ...], + "kinds": [4550], + "#a": ["34550::"], + } +] ``` Clients MAY hide approvals by blocked moderators at the user's request. From 5dcfe85306434f21ecb1e7a47edd92b2e3e64f9a Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 09:13:12 -0300 Subject: [PATCH 104/192] reformat a bunch of json things and small nitpicks. --- 11.md | 18 +++--- 13.md | 6 +- 14.md | 8 ++- 15.md | 205 ++++++++++++++++++++++++++++++---------------------------- 28.md | 46 ++++++------- 32.md | 9 ++- 36.md | 26 ++++---- 39.md | 28 ++++---- 40.md | 24 +++---- 42.md | 14 ++-- 45.md | 21 ++++-- 53.md | 30 ++++----- 56.md | 1 - 72.md | 14 ++-- 75.md | 17 +++-- 84.md | 11 +++- 89.md | 84 ++++++++++++------------ 90.md | 147 +++++++++++++++++++++-------------------- 94.md | 7 +- 98.md | 28 ++++---- 99.md | 6 +- 21 files changed, 385 insertions(+), 365 deletions(-) diff --git a/11.md b/11.md index e05cb1fa..ab05f31d 100644 --- a/11.md +++ b/11.md @@ -68,7 +68,6 @@ are rejected or fail immediately. ```json { - ... "limitation": { "max_message_length": 16384, "max_subscriptions": 20, @@ -82,7 +81,8 @@ are rejected or fail immediately. "payment_required": true, "created_at_lower_limit": 31536000, "created_at_upper_limit": 3 - } + }, + ... } ``` @@ -181,8 +181,8 @@ flexibility is up to the client software. ```json { + "relay_countries": [ "CA", "US" ], ... - "relay_countries": [ "CA", "US" ] } ``` @@ -203,10 +203,10 @@ To support this goal, relays MAY specify some of the following values. ```json { + "language_tags": ["en", "en-419"], + "tags": ["sfw-only", "bitcoin-only", "anime"], + "posting_policy": "https://example.com/posting-policy.html", ... - "language_tags": [ "en", "en-419" ], - "tags": [ "sfw-only", "bitcoin-only", "anime" ], - "posting_policy": "https://example.com/posting-policy.html" } ``` @@ -239,13 +239,13 @@ Relays that require payments may want to expose their fee schedules. ```json { - ... "payments_url": "https://my-relay/payments", "fees": { "admission": [{ "amount": 1000000, "unit": "msats" }], "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], - } + }, + ... } ``` @@ -255,8 +255,8 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b ```json { - ... "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", + ... } ``` diff --git a/13.md b/13.md index 4b15bbe5..53c4d1b6 100644 --- a/13.md +++ b/13.md @@ -35,11 +35,7 @@ Example mined note "created_at": 1651794653, "kind": 1, "tags": [ - [ - "nonce", - "776797", - "21" - ] + ["nonce", "776797", "21"] ], "content": "It's just me mining my own business", "sig": "284622fc0a3f4f1303455d5175f7ba962a3300d136085b9566801bc2e0699de0c7e31e44c81fb40ad9049173742e904713c3594a1da0fc5d2382a25c11aba977" diff --git a/14.md b/14.md index 72e5e396..480c4c57 100644 --- a/14.md +++ b/14.md @@ -6,14 +6,16 @@ Subject tag in Text events `draft` `optional` -This NIP defines the use of the "subject" tag in text (kind: 1) events. +This NIP defines the use of the "subject" tag in text (kind: 1) events. (implemented in more-speech) -`["subject": ]` +```json +["subject": ] +``` Browsers often display threaded lists of messages. The contents of the subject tag can be used in such lists, instead of the more ad hoc approach of using the first few words of the message. This is very similar to the way email browsers display lists of incoming emails by subject rather than by contents. When replying to a message with a subject, clients SHOULD replicate the subject tag. Clients MAY adorn the subject to denote -that it is a reply. e.g. by prepending "Re:". +that it is a reply. e.g. by prepending "Re:". Subjects should generally be shorter than 80 chars. Long subjects will likely be trimmed by clients. diff --git a/15.md b/15.md index 0ee000fa..51b7792e 100644 --- a/15.md +++ b/15.md @@ -1,14 +1,14 @@ NIP-15 ====== -Nostr Marketplace (for resilient marketplaces) ------------------------------------ +Nostr Marketplace +----------------- -`draft` `optional` +`draft` `optional` -> Based on https://github.com/lnbits/Diagon-Alley +Based on https://github.com/lnbits/Diagon-Alley. -> Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market) +Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). ## Terms @@ -35,29 +35,30 @@ The `merchant` admin software can be purely clientside, but for `convenience` an A merchant can publish these events: | Kind | | Description | | --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | -| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | +| `0` | `set_meta` | The merchant description (similar with any `nostr` public key). | | `30017` | `set_stall` | Create or update a stall. | | `30018` | `set_product` | Create or update a product. | -| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | -| `5 ` | `delete` | Delete a product or a stall. | +| `4` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | +| `5` | `delete` | Delete a product or a stall. | ### Event `30017`: Create or update a stall. -**Event Content**: +**Event Content** + ```json { - "id": , - "name": , - "description": , - "currency": , - "shipping": [ - { - "id": , - "name": , - "cost": , - "regions": [], - } - ] + "id": , + "name": , + "description": , + "currency": , + "shipping": [ + { + "id": , + "name": , + "cost": , + "regions": [], + } + ] } ``` @@ -70,34 +71,39 @@ Fields that are not self-explanatory: - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per product can also be specified if the shipping cost for that product is higher than what's specified by the base cost. -**Event Tags**: +**Event Tags** + ```json - "tags": [["d", , - "stall_id": , - "name": , - "description": , - "images": <[String], array of image URLs, optional>, - "currency": , - "price": , - "quantity": , - "specs": [ - [, ] - ], - "shipping": [ - { - "id": , - "cost": , - } - ] + "id": , + "stall_id": , + "name": , + "description": , + "images": <[string], array of image URLs, optional>, + "currency": , + "price": , + "quantity": , + "specs": [ + [, ] + ], + "shipping": [ + { + "id": , + "cost": , + } + ] } ``` @@ -114,16 +120,18 @@ Fields that are not self-explanatory: - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: - the `base cost from the stall` for the chosen shipping option - - the result of multiplying the product units by the `shipping costs specified in the product`, if any. + - the result of multiplying the product units by the `shipping costs specified in the product`, if any. + +**Event Tags** -**Event Tags**: ```json "tags": [ - ["d", , - "type": 0, - "name": , - "address": - "message": ", - "contact": { - "nostr": <32-bytes hex of a pubkey>, - "phone": , - "email": , - }, - "items": [ - { - "product_id": , - "quantity": - } - ], - "shipping_id": + "id": , + "type": 0, + "name": , + "address": + "message": ", + "contact": { + "nostr": <32-bytes hex of a pubkey>, + "phone": , + "email": , + }, + "items": [ + { + "product_id": , + "quantity": + } + ], + "shipping_id": } ``` @@ -186,23 +194,23 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni ```json { - "id": , - "type": 1, - "message": , - "payment_options": [ - { - "type": , - "link": - }, - { - "type": , - "link": - }, - { - "type": , - "link": - } - ] + "id": , + "type": 1, + "message": , + "payment_options": [ + { + "type": , + "link": + }, + { + "type": , + "link": + }, + { + "type": , + "link": + } + ] } ``` @@ -214,11 +222,11 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni ```json { - "id": , - "type": 2, - "message": , - "paid": , - "shipped": , + "id": , + "type": 2, + "message": , + "paid": , + "shipped": , } ``` ## Customize Marketplace @@ -226,19 +234,20 @@ Create a customized user experience using the `naddr` from [NIP-19](https://gith ### Event `30019`: Create or update marketplace UI/UX -**Event Content**: +**Event Content** + ```json { - "name": , - "about": , - "ui": { - "picture": , - "banner": , - "theme": , - "darkMode": - }, - "merchants": <[String] (optional), array of pubkeys>, - ... + "name": , + "about": , + "ui": { + "picture": , + "banner": , + "theme": , + "darkMode": + }, + "merchants": [array of pubkeys (optional)], + ... } ``` diff --git a/28.md b/28.md index 59e9389b..2dcf8003 100644 --- a/28.md +++ b/28.md @@ -27,8 +27,8 @@ In the channel creation `content` field, Client SHOULD include basic channel met ```json { - "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\"}", - ... + "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\"}", + ... } ``` @@ -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. +Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel.Only the most recent kind 41 is needed to be stored. Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. @@ -53,9 +53,9 @@ Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. ```json { - "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}", - "tags": [["e", , ]], - ... + "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}", + "tags": [["e", , ]], + ... } ``` @@ -72,9 +72,9 @@ Root message: ```json { - "content": , - "tags": [["e", , , "root"]], - ... + "content": , + "tags": [["e", , , "root"]], + ... } ``` @@ -82,14 +82,14 @@ Reply to another message: ```json { - "content": , - "tags": [ - ["e", , , "root"], - ["e", , , "reply"], - ["p", , ], - ... - ], - ... + "content": , + "tags": [ + ["e", , , "root"], + ["e", , , "reply"], + ["p", , ], + ... + ], + ... } ``` @@ -108,9 +108,9 @@ Clients MAY hide event 42s for other users other than the user who sent the even ```json { - "content": "{\"reason\": \"Dick pic\"}", - "tags": [["e", ]], - ... + "content": "{\"reason\": \"Dick pic\"}", + "tags": [["e", ]], + ... } ``` @@ -126,9 +126,9 @@ Clients MAY hide event 42s for users other than the user who sent the event 44. ```json { - "content": "{\"reason\": \"Posting dick pics\"}", - "tags": [["p", ]], - ... + "content": "{\"reason\": \"Posting dick pics\"}", + "tags": [["p", ]], + ... } ``` diff --git a/32.md b/32.md index dfcb35ea..be4e8724 100644 --- a/32.md +++ b/32.md @@ -64,7 +64,8 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. ["l", "permies", "#t"], ["p", , ], ["p", , ] - ] + ], + ... } ``` @@ -78,7 +79,8 @@ A report flagging violence toward a human being as defined by ontology.example.c ["l", "VI-hum", "com.example.ontology"], ["p", , ], ["p", , ] - ] + ], + ... } ``` @@ -92,6 +94,7 @@ A moderation suggestion for a chat event. ["l", "approve", "nip28.moderation"], ["e", , ] ], + ... } ``` @@ -105,6 +108,7 @@ Assignment of a license to an event. ["l", "MIT", "license"], ["e", , ] ], + ... } ``` @@ -119,6 +123,7 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. ["l", "IT-MI", "ISO-3166-2"] ], "content": "It's beautiful here in Milan!", + ... } ``` diff --git a/36.md b/36.md index db4c4f2f..b10262c2 100644 --- a/36.md +++ b/36.md @@ -24,18 +24,18 @@ options: ```json { - "pubkey": "", - "created_at": 1000000000, - "kind": 1, - "tags": [ - ["t", "hastag"], - ["L", "content-warning"], - ["l", "reason", "content-warning"], - ["L", "social.nos.ontology"], - ["l", "NS-nud", "social.nos.ontology"], - ["content-warning", "reason"] /* reason is optional */ - ], - "content": "sensitive content with #hastag\n", - "id": "" + "pubkey": "", + "created_at": 1000000000, + "kind": 1, + "tags": [ + ["t", "hastag"], + ["L", "content-warning"], + ["l", "reason", "content-warning"], + ["L", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"], + ["content-warning", ""] + ], + "content": "sensitive content with #hastag\n", + "id": "" } ``` diff --git a/39.md b/39.md index c9970fa5..c819e43b 100644 --- a/39.md +++ b/39.md @@ -15,15 +15,13 @@ Nostr protocol users may have other online identities such as usernames, profile A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md): ```json { - "id": , - "pubkey": , - ... - "tags": [ - ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], - ["i", "twitter:semisol_public", "1619358434134196225"], - ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] - ["i", "telegram:1087295469", "nostrdirectory/770"] - ] + "tags": [ + ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], + ["i", "twitter:semisol_public", "1619358434134196225"], + ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] + ["i", "telegram:1087295469", "nostrdirectory/770"] + ], + ... } ``` @@ -31,9 +29,9 @@ An `i` tag will have two parameters, which are defined as the following: 1. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`. 2. `proof`: String or object that points to the proof of owning this identity. -Clients SHOULD process any `i` tags with more than 2 values for future extensibility. -Identity provider names SHOULD only include `a-z`, `0-9` and the characters `._-/` and MUST NOT include `:`. -Identity names SHOULD be normalized if possible by replacing uppercase letters with lowercase letters, and if there are multiple aliases for an entity the primary one should be used. +Clients SHOULD process any `i` tags with more than 2 values for future extensibility. +Identity provider names SHOULD only include `a-z`, `0-9` and the characters `._-/` and MUST NOT include `:`. +Identity names SHOULD be normalized if possible by replacing uppercase letters with lowercase letters, and if there are multiple aliases for an entity the primary one should be used. ## Claim types @@ -41,14 +39,14 @@ Identity names SHOULD be normalized if possible by replacing uppercase letters w Identity: A GitHub username. -Proof: A GitHub Gist ID. This Gist should be created by `` with a single file that has the text `Verifying that I control the following Nostr public key: `. +Proof: A GitHub Gist ID. This Gist should be created by `` with a single file that has the text `Verifying that I control the following Nostr public key: `. This can be located at `https://gist.github.com//`. ### `twitter` Identity: A Twitter username. -Proof: A Tweet ID. The tweet should be posted by `` and have the text `Verifying my account on nostr My Public Key: ""`. +Proof: A Tweet ID. The tweet should be posted by `` and have the text `Verifying my account on nostr My Public Key: ""`. This can be located at `https://twitter.com//status/`. ### `mastodon` @@ -62,5 +60,5 @@ This can be located at `https:///`. Identity: A Telegram user ID. -Proof: A string in the format `/` which points to a message published in the public channel or group with name `` and message ID ``. This message should be sent by user ID `` and have the text `Verifying that I control the following Nostr public key: ""`. +Proof: A string in the format `/` which points to a message published in the public channel or group with name `` and message ID ``. This message should be sent by user ID `` and have the text `Verifying that I control the following Nostr public key: ""`. This can be located at `https://t.me/`. diff --git a/40.md b/40.md index b8a03365..909747f5 100644 --- a/40.md +++ b/40.md @@ -2,7 +2,7 @@ NIP-40 ====== Expiration Timestamp ------------------------------------ +-------------------- `draft` `optional` @@ -20,14 +20,14 @@ values: ```json { - "pubkey": "", - "created_at": 1000000000, - "kind": 1, - "tags": [ - ["expiration", "1600000000"] - ], - "content": "This message will expire at the specified timestamp and be deleted by relays.\n", - "id": "" + "pubkey": "", + "created_at": 1000000000, + "kind": 1, + "tags": [ + ["expiration", "1600000000"] + ], + "content": "This message will expire at the specified timestamp and be deleted by relays.\n", + "id": "" } ``` @@ -43,9 +43,9 @@ Clients SHOULD ignore events that have expired. Relay Behavior -------------- -Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely. -Relays SHOULD NOT send expired events to clients, even if they are stored. -Relays SHOULD drop any events that are published to them if they are expired. +Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely. +Relays SHOULD NOT send expired events to clients, even if they are stored. +Relays SHOULD drop any events that are published to them if they are expired. An expiration timestamp does not affect storage of ephemeral events. Suggested Use Cases diff --git a/42.md b/42.md index 9f0c24dd..e380e89a 100644 --- a/42.md +++ b/42.md @@ -24,13 +24,13 @@ A relay may want to require clients to authenticate to access restricted resourc This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays, the message is of the following form: -``` +```json ["AUTH", ] ``` And, when sent by clients, of the following form: -``` +```json ["AUTH", ] ``` @@ -41,16 +41,12 @@ Relays MUST exclude `kind: 22242` events from being broadcasted to any client. ```json { - "id": "...", - "pubkey": "...", - "created_at": 1669695536, "kind": 22242, "tags": [ ["relay", "wss://relay.example.com/"], ["challenge", "challengestringhere"] ], - "content": "", - "sig": "..." + ... } ``` @@ -67,13 +63,13 @@ is expected to last for the duration of the WebSocket connection. Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example: -``` +```json ["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"] ``` or it can return an `OK` message noting the reason an event was not written using the same prefix: -``` +```json ["OK", , false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"] ``` diff --git a/45.md b/45.md index a3abd19d..998b9529 100644 --- a/45.md +++ b/45.md @@ -16,29 +16,36 @@ 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": }] ``` -Examples: +## Examples: -``` -# Followers count +### Followers count + +```json ["COUNT", , {"kinds": [3], "#p": []}] ["COUNT", , {"count": 238}] +``` -# Count posts and reactions +### Count posts and reactions + +```json ["COUNT", , {"kinds": [1, 7], "authors": []}] ["COUNT", , {"count": 5}] +``` -# Count posts approximately +### Count posts approximately + +``` ["COUNT", , {"kinds": [1]}] ["COUNT", , {"count": 93412452, "approximate": true}] ``` diff --git a/53.md b/53.md index c4789ea1..d3cc0afd 100644 --- a/53.md +++ b/53.md @@ -6,17 +6,17 @@ Live Activities `draft` `optional` -## Abstract - Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. -# Live Event +## Concepts + +### Live Event A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. For example: -```js +```json { "kind": 30311, "tags": [ @@ -38,7 +38,7 @@ For example: ["relays", "wss://one.com", "wss://two.com", ...] ], "content": "", - ...other fields + ... } ``` @@ -52,7 +52,7 @@ Live Activity management clients are expected to constantly update `kind:30311` The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. -## Proof of Agreement to Participate +### Proof of Agreement to Participate Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex. @@ -60,30 +60,28 @@ Clients MAY only display participants if the proof is available or MAY display p This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. -# Live Chat Message +### Live Chat Message Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. -```js +```json { - "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", - "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", "kind": 1311, "tags": [ ["a", "30311::", "", "root"], ], - "content": "Zaps to live streams is beautiful." + "content": "Zaps to live streams is beautiful.", + ... } ``` -# Use Cases +## Use Cases Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com). -# Example +## Example -Live Streaming +### Live Streaming ```json { @@ -107,7 +105,7 @@ Live Streaming } ``` -Live Streaming chat message +### Live Streaming chat message ```json { diff --git a/56.md b/56.md index 0c951b5b..a2861e35 100644 --- a/56.md +++ b/56.md @@ -1,4 +1,3 @@ - NIP-56 ====== diff --git a/72.md b/72.md index 74c7f086..c0fffffc 100644 --- a/72.md +++ b/72.md @@ -14,7 +14,6 @@ The goal of this NIP is to create moderator-approved public communities around a ```json { - ... "created_at": , "kind": 34550, "tags": [ @@ -34,7 +33,8 @@ The goal of this NIP is to create moderator-approved public communities around a ["relay", "", "requests"], ["relay", "", "approvals"], ["relay", ""] - ] + ], + ... } ``` @@ -44,12 +44,12 @@ Any Nostr event can be submitted to a community by anyone for approval. Clients ```json { - ... "kind": 1, "tags": [ ["a", "34550::", ""], ], - "content": "hello world" + "content": "hello world", + ... } ``` @@ -61,7 +61,6 @@ The post-approval event MUST include `a` tags of the communities the moderator i ```json { - ... "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "kind": 4550, "tags": [ @@ -70,7 +69,8 @@ The post-approval event MUST include `a` tags of the communities the moderator i ["p", "", ""], ["k", ""] ], - "content": "" + "content": "", + ... } ``` @@ -86,7 +86,7 @@ Community clients SHOULD display posts that have been approved by at least 1 mod The following filter displays the approved posts. -```js +```json [ "REQ", "_", diff --git a/75.md b/75.md index 3a89f904..f3cf5d06 100644 --- a/75.md +++ b/75.md @@ -1,6 +1,8 @@ -# NIP-75 +NIP-75 +====== -## Zap Goals +Zap Goals +--------- `draft` `optional` @@ -27,7 +29,7 @@ Example event: ["amount", "210000"], ], "content": "Nostrasia travel expenses", - ...other fields + ... ``` The following tags are OPTIONAL. @@ -43,7 +45,8 @@ The following tags are OPTIONAL. ["closed_at", ""], ], "content": "Nostrasia travel expenses", - ...other fields + ... +} ``` The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event. @@ -54,12 +57,14 @@ Parameterized replaceable events can link to a goal by using a `goal` tag specif ```json { - "kind": 3XXXX, + ... + "kind": 3xxxx, "tags": [ ... ["goal", "", ""], ], - ...other fields + ... +} ``` ## Client behavior diff --git a/84.md b/84.md index 303cd933..d5f54d4c 100644 --- a/84.md +++ b/84.md @@ -27,9 +27,14 @@ useful when highlighting non-nostr content for which the client might be able to last value of the tag. ```json -[ "p", "", "", "author" ], -[ "p", "", "", "author" ], -[ "p", "", "", "editor" ], +{ + "tags": [ + ["p", "", "", "author"], + ["p", "", "", "author"], + ["p", "", "", "editor"] + ], + ... +} ``` ### Context diff --git a/89.md b/89.md index 73cb7bd5..be3d075d 100644 --- a/89.md +++ b/89.md @@ -9,10 +9,12 @@ Recommended Application Handlers This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds. ## Rationale + Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics. This NIP provides a simple way for clients to discover applications that handle events of a specific kind to ensure smooth cross-client and cross-kind interactions. ### Parties involved + There are three actors to this workflow: * application that handles a specific event kind (note that an application doesn't necessarily need to be a distinct entity and it could just be the same pubkey as user A) @@ -22,18 +24,18 @@ There are three actors to this workflow: * user B, who seeks a recommendation for an app that handles a specific event kind * Queries for `kind:31989` and, based on results, queries for `kind:31990` -# Events +## Events -## Recommendation event +### Recommendation event ```json { - "kind": 31989, - "pubkey": , - "tags": [ - [ "d", ], - [ "a", "31990:app1-pubkey:", "wss://relay1", "ios" ], - [ "a", "31990:app2-pubkey:", "wss://relay2", "web" ] - ] + "kind": 31989, + "pubkey": , + "tags": [ + ["d", ], + ["a", "31990:app1-pubkey:", "wss://relay1", "ios"], + ["a", "31990:app2-pubkey:", "wss://relay2", "web"] + ] } ``` @@ -47,34 +49,32 @@ The third value of the tag SHOULD be the platform where this recommendation migh ## Handler information ```json { - "kind": 31990, - "pubkey": , - "content": "", - "tags": [ - [ "d", ], - [ "k", ], - [ "web", "https://..../a/", "nevent" ], - [ "web", "https://..../p/", "nprofile" ], - [ "web", "https://..../e/" ], - [ "ios", ".../" ] - ] + "kind": 31990, + "pubkey": "", + "content": "", + "tags": [ + ["d", ], + ["k", ], + ["web", "https://..../a/", "nevent"], + ["web", "https://..../p/", "nprofile"], + ["web", "https://..../e/"], + ["ios", ".../"] + ] } ``` * `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) - * `k` tags' value is the event kind that is supported by this `kind:31990`. Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: * Multiple `k` tags can exist in the same event if the application supports more than one event kind and their handler URLs are the same. * The same pubkey can have multiple events with different apps that handle the same event kind. - * `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application. Multiple tags might be registered by the app, following NIP-19 nomenclature as the second value of the array. A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag. -# Client tag +## Client tag When publishing events, clients MAY include a `client` tag in the same format as the recommendation event's `a` tags. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. ```json @@ -87,43 +87,45 @@ When publishing events, clients MAY include a `client` tag in the same format as } ``` -# User flow +## User flow A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application. When user B sees an unknown event kind, e.g. in a social-media centric nostr client, the client would allow user B to interact with the unknown-kind event (e.g. tapping on it). The client MIGHT query for the user's and the user's follows handler. -# Example +## Example -## User A recommends a `kind:31337`-handler +### User A recommends a `kind:31337`-handler User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler. ```json { - "kind": 31989, - "tags": [ - [ "d", "31337" ], - [ "a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", , "web" ] - ] + "kind": 31989, + "tags": [ + ["d", "31337"], + ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", , "web"] + ], + ... } ``` -## User B interacts with a `kind:31337`-handler -User B might see in their timeline an event referring to a `kind:31337` event -(e.g. a `kind:1` tagging a `kind:31337`). +### User B interacts with a `kind:31337`-handler +User B might see in their timeline an event referring to a `kind:31337` event (e.g. a `kind:1` tagging a `kind:31337`). -User B's client, not knowing how to handle a `kind:31337` might display the event -using its `alt` tag (as described in NIP-31). When the user clicks on the event, -the application queries for a handler for this `kind`: +User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`: -`["REQ", , '[{ "kinds": [31989], "#d": ["31337"], 'authors': [, ] }]']` +```json +["REQ", , '[{ "kinds": [31989], "#d": ["31337"], 'authors': [, ] }]'] +``` User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. User B's client sees the application's `kind:31990` which includes the information to redirect the user to the relevant URL with the desired entity replaced in the URL. -## Alternative query bypassing `kind:31989` -Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms to avoid directing users to malicious handlers. +### Alternative query bypassing `kind:31989` +Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. -`["REQ", , '[{ "kinds": [31990], "#k": [], 'authors': [...] }]']` +```json +["REQ", , '[{ "kinds": [31990], "#k": [], 'authors': [...] }]'] +``` diff --git a/90.md b/90.md index c498cddd..6017c98c 100644 --- a/90.md +++ b/90.md @@ -13,11 +13,11 @@ Money in, data out. ## Kinds This NIP reserves the range `5000-7000` for data vending machine use. -| Kind | Description | -| ---- | ----------- | +| Kind | Description | +| ---- | ----------- | | 5000-5999 | Job request kinds | -| 6000-6999 | Job result | -| 7000 | Job feedback | +| 6000-6999 | Job result | +| 7000 | Job feedback | Job results always use a kind number that is `1000` higher than the job request kind. (e.g. request: `kind:5001` gets a result: `kind:6001`). @@ -67,34 +67,34 @@ All tags are optional. * `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -## Encrypted Params +## Encrypted Params If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](https://github.com/nostr-protocol/nips/blob/master/04.md), using the user's private and service provider's public key for the shared secret ```json [ - [ "i", "what is the capital of France? ", "text" ], - [ "param", "model", "LLaMA-2" ], - [ "param", "max_tokens", "512" ], - [ "param", "temperature", "0.5" ], - [ "param", "top-k", "50" ], - [ "param", "top-p", "0.7" ], - [ "param", "frequency_penalty", "1" ] - + ["i", "what is the capital of France? ", "text"], + ["param", "model", "LLaMA-2"], + ["param", "max_tokens", "512"], + ["param", "temperature", "0.5"], + ["param", "top-k", "50"], + ["param", "top-p", "0.7"], + ["param", "frequency_penalty", "1"] ] ``` -This param data will be encrypted and added to the `content` field and `p` tag should be present - -``` -"content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", - "tags": [ - ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], - ["encrypted"] - ] - +This param data will be encrypted and added to the `content` field and `p` tag should be present +```json +{ + "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", + "tags": [ + ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], + ["encrypted"] + ], + ... +} ``` @@ -104,16 +104,17 @@ Service providers publish job results, providing the output of the job result. T ```json { - "pubkey": "", - "content": "", - "kind": 6xxx, - "tags": [ - [ "request", "" ], - [ "e", "", "" ], - [ "i", "" ], - [ "p", "" ], - [ "amount", "requested-payment-amount", "" ] - ] + "pubkey": "", + "content": "", + "kind": 6xxx, + "tags": [ + ["request", ""], + ["e", "", ""], + ["i", ""], + ["p", ""], + ["amount", "requested-payment-amount", ""] + ], + ... } ``` @@ -123,38 +124,40 @@ Service providers publish job results, providing the output of the job result. T ## Encrypted Output -If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text. +If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text. Add a tag encrypted to mark the output content as `encrypted` + ```json { - "pubkey": "", - "content": "", - "kind": 6xxx, - "tags": [ - [ "request", "" ], - [ "e", "", "" ], - [ "p", "" ], - [ "amount", "requested-payment-amount", "" ], - ["encrypted"] - - ] + "pubkey": "", + "content": "", + "kind": 6xxx, + "tags": [ + ["request", ""], + ["e", "", ""], + ["p", ""], + ["amount", "requested-payment-amount", ""], + ["encrypted"] + ], + ... } ``` - ## Job feedback + Service providers can give feedback about a job back to the customer. ```json { - "kind": 7000, - "content": "", - "tags": [ - [ "status", "", "" ], - [ "amount", "requested-payment-amount", "" ], - [ "e", "", "" ], - [ "p", "" ], - ] + "kind": 7000, + "content": "", + "tags": [ + ["status", "", ""], + ["amount", "requested-payment-amount", ""], + ["e", "", ""], + ["p", ""], + ], + ... } ``` @@ -166,18 +169,19 @@ Service providers can give feedback about a job back to the customer. ### Job feedback status -| status | description | -|--------|-------------| -| `payment-required` | Service Provider requires payment before continuing. | -| `processing` | Service Provider is processing the job. | -| `error` | Service Provider was unable to process the job. | -| `success` | Service Provider successfully processed the job. | -| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | +| status | description | +| -------- | ------------- | +| `payment-required` | Service Provider requires payment before continuing. | +| `processing` | Service Provider is processing the job. | +| `error` | Service Provider was unable to process the job. | +| `success` | Service Provider successfully processed the job. | +| `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. # Protocol Flow + * Customer publishes a job request (e.g. `kind:5000` speech-to-text). * Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event. @@ -207,18 +211,19 @@ This gives a higher level of flexibility to service providers (which sophisticat # Appendix 2: Service provider discoverability Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: -```json +```js { - "kind": 31990, - "pubkey": "", - "content": "{ - \"name\": \"Translating DVM\", - \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" - }", - "tags": [ - [ "k", "5005" ], // e.g. translation - [ "t", "bitcoin" ] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" - ] + "kind": 31990, + "pubkey": "", + "content": "{ + \"name\": \"Translating DVM\", + \"about\": \"I'm a DVM specialized in translating Bitcoin content.\" + }", + "tags": [ + ["k", "5005"], // e.g. translation + ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" + ], + ... } ``` diff --git a/94.md b/94.md index 0b76c25b..95b6a3bc 100644 --- a/94.md +++ b/94.md @@ -28,9 +28,6 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ```json { - "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, - "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": , "kind": 1063, "tags": [ ["url",], @@ -47,8 +44,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["summary", ], ["alt", ] ], - "content": , - "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> + "content": "", + ... } ``` diff --git a/98.md b/98.md index e04c7fc1..ca523042 100644 --- a/98.md +++ b/98.md @@ -2,7 +2,7 @@ NIP-98 ====== HTTP Auth -------------------------- +--------- `draft` `optional` @@ -24,22 +24,16 @@ The following tags MUST be included. Example event: ```json { - "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734", - "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed", - "content": "", - "kind": 27235, - "created_at": 1682327852, - "tags": [ - [ - "u", - "https://api.snort.social/api/v1/n5sp/list" - ], - [ - "method", - "GET" - ] - ], - "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184" + "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734", + "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed", + "content": "", + "kind": 27235, + "created_at": 1682327852, + "tags": [ + ["u", "https://api.snort.social/api/v1/n5sp/list"], + ["method", "GET"] + ], + "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184" } ``` diff --git a/99.md b/99.md index 9e8f1dad..e65920c6 100644 --- a/99.md +++ b/99.md @@ -1,6 +1,8 @@ -# NIP-99 +NIP-99 +====== -## Classified Listings +Classified Listings +------------------- `draft` `optional` From 50d20123e2271e2d33323105414b01a0a69559d5 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 09:36:59 -0300 Subject: [PATCH 105/192] "restricted_writes" on NIP-11. --- 11.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/11.md b/11.md index ab05f31d..fe9f0e48 100644 --- a/11.md +++ b/11.md @@ -79,6 +79,7 @@ are rejected or fail immediately. "min_pow_difficulty": 30, "auth_required": true, "payment_required": true, + "restricted_writes": true, "created_at_lower_limit": 31536000, "created_at_upper_limit": 3 }, @@ -124,6 +125,9 @@ Even if set to False, authentication may be required for specific actions. - `payment_required`: this relay requires payment before a new connection may perform any action. +- `restricted_writes`: this relay requires some kind of condition to be fulfilled in order to +accept events (not necessarily, but including `payment_required` and `min_pow_difficulty`). + - `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md) - `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md) From 2d678bcd5a1beb56097fb9af037e1fe2b2598c5e Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 11:35:32 -0300 Subject: [PATCH 106/192] metadata tags for lists kept at "title", "image" and "description", following @erskingardner and @darecjo. --- 51.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/51.md b/51.md index bcab8b8d..b42bc8b2 100644 --- a/51.md +++ b/51.md @@ -47,8 +47,7 @@ For example, _relay sets_ can be displayed in a dropdown UI to give users the op relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ can be used by apps to showcase curations made by others tagged to different topics. -Aside from their main identifier, the `"d"` tag, sets can optionally have a `"name"`, a `"picture"` and an -`"about"` tag that can be used to enhance their UI. +Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tags that can be used to enhance their UI. | name | kind | description | expected tag items | | --- | --- | --- | --- | From 5e6e7a2bc85de7d251b2d7d111c355a9e5ddd0e4 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 18 Nov 2023 11:36:20 -0300 Subject: [PATCH 107/192] get rid of these arbitrary markdown linebreaks and put everything in the same line. --- 51.md | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/51.md b/51.md index b42bc8b2..f9f567a9 100644 --- a/51.md +++ b/51.md @@ -6,24 +6,17 @@ Lists `draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` -This NIP defines lists of things that users can create. Lists can contain references to anything, and these -references can be **public** or **private**. +This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**. -Public items in a list are specified in the event `tags` array, while private items are specified in a JSON -array that mimics the structure of the event `tags` array, but stringified and encrypted using the same -scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and -stored in the `.content`. +Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. ## Types of lists ## Standard lists -Standard lists use non-parameterized replaceable events, meaning users may only have a single list -of each kind. They have special meaning and clients may rely on them to augment a user's profile or -browsing experience. +Standard lists use non-parameterized replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience. -For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in -their feeds or receive annoying notifications from. +For example, _mute lists_ 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 | | --- | --- | --- | --- | @@ -39,13 +32,9 @@ their feeds or receive annoying notifications from. ## Sets -Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely -on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of -them must be assigned a different `"d"` identifier. +Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of them must be assigned a different `"d"` identifier. -For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which -relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ -can be used by apps to showcase curations made by others tagged to different topics. +For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ can be used by apps to showcase curations made by others tagged to different topics. Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tags that can be used to enhance their UI. From 33a719f34507bf2cbc6717eb5e4b9464daaad23a Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 19 Nov 2023 07:17:11 -0300 Subject: [PATCH 108/192] fix kind:40 name (following @snowcait). --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index f9f567a9..54c09204 100644 --- a/51.md +++ b/51.md @@ -24,7 +24,7 @@ For example, _mute lists_ can contain the public keys of spammers and bad actors | 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 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) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a" (kind:30015 interest set)` | From 438812d0a4a9afa5b4985e07771ae2919765b514 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 19 Nov 2023 10:17:57 -0300 Subject: [PATCH 109/192] clarify that `restricted_writes` do not include normal anti-spam heuristics and other kinds of soft-restrictions. --- 11.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/11.md b/11.md index fe9f0e48..615e796f 100644 --- a/11.md +++ b/11.md @@ -127,6 +127,9 @@ Even if set to False, authentication may be required for specific actions. - `restricted_writes`: this relay requires some kind of condition to be fulfilled in order to accept events (not necessarily, but including `payment_required` and `min_pow_difficulty`). +This should only be set to `true` when users are expected to know the relay policy before trying +to write to it -- like belonging to a special pubkey-based whitelist or writing only events of +a specific niche kind or content. Normal anti-spam heuristics, for example, do not qualify. - `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md) From cb37a9320e10fcc4d8c064571461311ca613a1d5 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 18 Oct 2023 11:48:18 -0300 Subject: [PATCH 110/192] rewrite NIP-46. --- 46.md | 178 +++++++++++++++++----------------------------------------- 1 file changed, 50 insertions(+), 128 deletions(-) diff --git a/46.md b/46.md index 53185416..ccdb535e 100644 --- a/46.md +++ b/46.md @@ -2,161 +2,83 @@ NIP-46 ====== Nostr Connect ------------------------- +------------- `draft` `optional` -## Rationale +This NIP describes a method for 2-way communication between a **remote signer** and a normal Nostr client. The remote signer could be, for example, a hardware device dedicated to signing Nostr events, while the client is a normal Nostr client. -Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface. +## Signer Discovery -Entering private keys can also be annoying and requires exposing them to even more systems such as the operating system's clipboard that might be monitored by malicious apps. +The client must somehow be able to contact the signer through a common relay. +### Started by the signer -## Terms +The remote signer generates a connection token in the form -* **App**: Nostr app on any platform that *requires* to act on behalf of a nostr account. -* **Signer**: Nostr app that holds the private key of a nostr account and *can sign* on its behalf. +``` +#?relay=wss://...&relay=wss://... +``` +The user copies that token and pastes it in the client UI somehow. Then the client can send events of kind `24133` to the specified relays and wait for responses from the remote signer. -## `TL;DR` +### Started by the client +The client generates a QR code in the following form (URL-encoded): -**App** and **Signer** sends ephemeral encrypted messages to each other using kind `24133`, using a relay of choice. +``` +nostrconnect://?relay=wss://...&metadata={"name":"client-name"} +``` -App prompts the Signer to do things such as fetching the public key or signing events. +The signer scans the QR code and sends a `connect` message to the client in the specified relays. -The `content` field must be an encrypted JSONRPC-ish **request** or **response**. +## Event payloads -## Signer Protocol +Event payloads are [NIP-04](04.md)-encrypted JSON blobs that look like JSONRPC. -### Messages +Events sent by the client to the remote signer have the following format: -#### Request - -```json +```js { - "id": , - "method": , - "params": [, ] + "pubkey": "" + "kind": 24133, + "tags": [ + ["p", ""] + ], + "content": "nip04_encrypted_json({id: , method: , params: []})", + ... } ``` -#### Response +And the events the remote signer sends to the client have the following format: -```json -{ - "id": , - "result": , - "error": -} +```js + "pubkey": "" + "kind": 24133, + "tags": [ + ["p", ""] + ], + "content": "nip04_encrypted_json({id: , result: , error: })", + ... ``` ### Methods - -#### Mandatory - -These are mandatory methods the remote signer app MUST implement: - -- **describe** - - params [] - - result `["describe", "get_public_key", "sign_event", "connect", "disconnect", "delegate", ...]` -- **get_public_key** - - params [] - - result `pubkey` -- **sign_event** - - params [`event`] - - result `event_with_signature` - -#### optional - - - **connect** - - params [`pubkey`] -- **disconnect** - - params [] -- **delegate** - - params [`delegatee`, `{ kind: number, since: number, until: number }`] - - result `{ from: string, to: string, cond: string, sig: string }` + - params: [`pubkey`, `secret`] + - result: `null` +- **get_public_key** + - params: [] + - result: `pubkey` +- **sign_event** + - params: [`event`] + - result: `event_with_pubkey_id_and_signature` - **get_relays** - - params [] - - result `{ [url: string]: {read: boolean, write: boolean} }` + - params: [] + - result: `{ [url: string]: {read: boolean, write: boolean} }` - **nip04_encrypt** - - params [`pubkey`, `plaintext`] - - result `nip4 ciphertext` + - params: [`pubkey`, `plaintext`] + - result: `nip4 ciphertext` - **nip04_decrypt** - - params [`pubkey`, `nip4 ciphertext`] - - result [`plaintext`] - - -NOTICE: `pubkey` and `signature` are hex-encoded strings. - - -### Nostr Connect URI - -**Signer** discovers **App** by scanning a QR code, clicking on a deep link or copy-pasting an URI. - -The **App** generates a special URI with prefix `nostrconnect://` and base path the hex-encoded `pubkey` with the following querystring parameters **URL encoded** - -- `relay` URL of the relay of choice where the **App** is connected and the **Signer** must send and listen for messages. -- `metadata` metadata JSON of the **App** - - `name` human-readable name of the **App** - - `url` (optional) URL of the website requesting the connection - - `description` (optional) description of the **App** - - `icons` (optional) array of URLs for icons of the **App**. - -#### JavaScript - -```js -const uri = `nostrconnect://?relay=${encodeURIComponent("wss://relay.damus.io")}&metadata=${encodeURIComponent(JSON.stringify({"name": "Example"}))}` -``` - -#### Example -```sh -nostrconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&metadata=%7B%22name%22%3A%22Example%22%7D -``` - - - -## Flows - -The `content` field contains encrypted message as specified by [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). The `kind` chosen is `24133`. - -### Connect - -1. User clicks on **"Connect"** button on a website or scan it with a QR code -2. It will show an URI to open a "nostr connect" enabled **Signer** -3. In the URI there is a pubkey of the **App** ie. `nostrconnect://&relay=&metadata=` -4. The **Signer** will send a message to ACK the `connect` request, along with his public key - -### Disconnect (from App) - -1. User clicks on **"Disconnect"** button on the **App** -2. The **App** will send a message to the **Signer** with a `disconnect` request -3. The **Signer** will send a message to ACK the `disconnect` request - -### Disconnect (from Signer) - -1. User clicks on **"Disconnect"** button on the **Signer** -2. The **Signer** will send a message to the **App** with a `disconnect` request - - -### Get Public Key - -1. The **App** will send a message to the **Signer** with a `get_public_key` request -3. The **Signer** will send back a message with the public key as a response to the `get_public_key` request - -### Sign Event - -1. The **App** will send a message to the **Signer** with a `sign_event` request along with the **event** to be signed -2. The **Signer** will show a popup to the user to inspect the event and sign it -3. The **Signer** will send back a message with the event including the `id` and the schnorr `signature` as a response to the `sign_event` request - -### Delegate - -1. The **App** will send a message with metadata to the **Signer** with a `delegate` request along with the **conditions** query string and the **pubkey** of the **App** to be delegated. -2. The **Signer** will show a popup to the user to delegate the **App** to sign on his behalf -3. The **Signer** will send back a message with the signed [NIP-26 delegation token](https://github.com/nostr-protocol/nips/blob/master/26.md) or reject it - - + - params: [`pubkey`, `nip4 ciphertext`] + - result: [`plaintext`] From c5c2d86a479d1ca52065b50faddc72220c3896cf Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Tue, 21 Nov 2023 20:49:35 -0300 Subject: [PATCH 111/192] peer-pubkey Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index ccdb535e..baefa4b4 100644 --- a/46.md +++ b/46.md @@ -80,5 +80,5 @@ And the events the remote signer sends to the client have the following format: - params: [`pubkey`, `plaintext`] - result: `nip4 ciphertext` - **nip04_decrypt** - - params: [`pubkey`, `nip4 ciphertext`] + - params: [`peer-pubkey`, `nip4 ciphertext`] - result: [`plaintext`] From e4bddbee7b90b701ea2041532c88935f5176850e Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Tue, 21 Nov 2023 22:25:19 -0300 Subject: [PATCH 112/192] peer-pubkey Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index baefa4b4..6610e82c 100644 --- a/46.md +++ b/46.md @@ -77,7 +77,7 @@ And the events the remote signer sends to the client have the following format: - params: [] - result: `{ [url: string]: {read: boolean, write: boolean} }` - **nip04_encrypt** - - params: [`pubkey`, `plaintext`] + - params: [`peer-pubkey`, `plaintext`] - result: `nip4 ciphertext` - **nip04_decrypt** - params: [`peer-pubkey`, `nip4 ciphertext`] From 6c35537ca425f154ca1c92897ab0eac599a80c87 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 21 Nov 2023 22:31:13 -0300 Subject: [PATCH 113/192] @v0l improvements. --- 46.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/46.md b/46.md index 6610e82c..1a9be035 100644 --- a/46.md +++ b/46.md @@ -10,7 +10,7 @@ This NIP describes a method for 2-way communication between a **remote signer** ## Signer Discovery -The client must somehow be able to contact the signer through a common relay. +The client always starts by generating a random key which is used to communicate with the signer, then it one of the methods below is used to allow the client to know what is the signer public key for the session and which relays to use. ### Started by the signer @@ -27,7 +27,7 @@ The user copies that token and pastes it in the client UI somehow. Then the clie The client generates a QR code in the following form (URL-encoded): ``` -nostrconnect://?relay=wss://...&metadata={"name":"client-name"} +nostrconnect://?relay=wss://...&metadata={"name":"...", "url": "...", "description": "..."} ``` The signer scans the QR code and sends a `connect` message to the client in the specified relays. From 5ae5a6d0553e34afc3cf19e96043f7e0e2b349ef Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 24 Nov 2023 02:44:12 +0900 Subject: [PATCH 114/192] Remove "NIP-33" (#896) --- 09.md | 2 +- 57.md | 4 ++-- 89.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/09.md b/09.md index f92410fa..fbbd6e13 100644 --- a/09.md +++ b/09.md @@ -8,7 +8,7 @@ Event Deletion A special event with kind `5`, meaning "deletion" is defined as having a list of one or more `e` tags, each referencing an event the author is requesting to be deleted. -Each tag entry must contain an "e" event id and/or NIP-33 `a` tags intended 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. diff --git a/57.md b/57.md index 2b2c97b9..759e2033 100644 --- a/57.md +++ b/57.md @@ -36,7 +36,7 @@ A `zap request` is an event of kind `9734` that is _not_ published to relays, bu In addition, the event MAY include the following tags: - `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. -- `a` is an optional NIP-33 event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes. +- `a` is an optional event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes. Example: @@ -110,7 +110,7 @@ When a client sends a `zap request` event to a server's lnurl-pay callback URL, 4. It MUST have 0 or 1 `e` tags 5. There should be a `relays` tag with the relays to send the `zap receipt` to. 6. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. -7. If there is an `a` tag, it MUST be a valid NIP-33 event coordinate +7. If there is an `a` tag, it MUST be a valid event coordinate The event MUST then be stored for use later, when the invoice is paid. diff --git a/89.md b/89.md index be3d075d..097bdcbd 100644 --- a/89.md +++ b/89.md @@ -65,7 +65,7 @@ The third value of the tag SHOULD be the platform where this recommendation migh * `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) * `k` tags' value is the event kind that is supported by this `kind:31990`. -Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: +Using a `k` tag(s) (instead of having the kind of the `d` tag) provides: * Multiple `k` tags can exist in the same event if the application supports more than one event kind and their handler URLs are the same. * The same pubkey can have multiple events with different apps that handle the same event kind. * `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application. From 1a106c6bff20a9408fe0ec51b265e3c5de86d25f Mon Sep 17 00:00:00 2001 From: Alejandro Date: Thu, 23 Nov 2023 19:17:28 +0100 Subject: [PATCH 115/192] [NIP-75] add optional 'image' and 'summary' tags (#890) --- 75.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/75.md b/75.md index f3cf5d06..c16436a8 100644 --- a/75.md +++ b/75.md @@ -35,6 +35,8 @@ Example event: The following tags are OPTIONAL. - `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress. +- `image` - an image for the goal +- `summary` - a brief description ```json { @@ -43,6 +45,8 @@ The following tags are OPTIONAL. ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], ["amount", "210000"], ["closed_at", ""], + ["image", ""], + ["summary", ""], ], "content": "Nostrasia travel expenses", ... From 6de35f9e6a50cd5bf88c0a350ef369919ac27f06 Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Mon, 27 Nov 2023 06:22:15 -0800 Subject: [PATCH 116/192] Make client hints backwards compatible --- 89.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/89.md b/89.md index 097bdcbd..43d197fc 100644 --- a/89.md +++ b/89.md @@ -74,14 +74,14 @@ Multiple tags might be registered by the app, following NIP-19 nomenclature as t A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag. -## Client tag -When publishing events, clients MAY include a `client` tag in the same format as the recommendation event's `a` tags. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. +# Client tag +When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. ```json { "kind": 1, "tags": [ - ["client", "31990:app1-pubkey:", "wss://relay1", "ios"] + ["client", "My Client", "31990:app1-pubkey:", "wss://relay1"] ] ... } From fb87a03d5f2d0aee4f3916e1cf8338ee69b314a9 Mon Sep 17 00:00:00 2001 From: Leon Date: Thu, 30 Nov 2023 18:38:48 +0800 Subject: [PATCH 117/192] Update 07.md Add OneKey to nip07 --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 01af6f40..aa0a5f4b 100644 --- a/07.md +++ b/07.md @@ -36,3 +36,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext - [Spring Browser](https://spring.site) (Android) - [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill) - [Nostore](https://apps.apple.com/us/app/nostore/id1666553677) (Safari on iOS/MacOS) +- [OneKey](https://onekey.so/) (Android, IOS, Chrome and derivatives) From 45e65e9bee4425c0fd7cb9f27a48df0eb1e4783a Mon Sep 17 00:00:00 2001 From: Scott Weldon Date: Thu, 30 Nov 2023 21:21:42 -0800 Subject: [PATCH 118/192] Fix typo --- 15.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/15.md b/15.md index 51b7792e..1c3154a3 100644 --- a/15.md +++ b/15.md @@ -108,7 +108,7 @@ Fields that are not self-explanatory: ``` Fields that are not self-explanatory: - - `quantity` can be null in the case of items with unlimited abailability, like digital items, or services + - `quantity` can be null in the case of items with unlimited availability, like digital items, or services - `specs`: - an optional array of key pair values. It allows for the Customer UI to present product specifications in a structure mode. It also allows comparison between products - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` From f2e30c63cb4ede5bbf4c83743d6f5e8e1b875335 Mon Sep 17 00:00:00 2001 From: ok300 <106775972+ok300@users.noreply.github.com> Date: Fri, 1 Dec 2023 11:08:25 +0100 Subject: [PATCH 119/192] Update NIP58 Badges: Remove section on PoW --- 58.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/58.md b/58.md index 9725c82a..e2a9f204 100644 --- a/58.md +++ b/58.md @@ -62,8 +62,6 @@ Users MAY choose to decorate their profiles with badges for fame, notoriety, rec ### Recommendations -Badge issuers MAY include some Proof of Work as per [NIP-13](13.md) when minting Badge Definitions or Badge Awards to embed them with a combined energy cost, arguably making them more special and valuable for users that wish to collect them. - Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users. Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels. From cf57f1d068a1c5cbe95df9ecf5c2ca35e227760d Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 1 Dec 2023 20:45:55 +0900 Subject: [PATCH 120/192] Update tag list --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b8b98d9d..2458f7d5 100644 --- a/README.md +++ b/README.md @@ -184,7 +184,6 @@ Please update these lists when proposing NIPs introducing new event kinds. | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | | `d` | identifier | -- | [01](01.md) | -| `alt` | summary | -- | [31](31.md) | | `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | @@ -194,13 +193,16 @@ Please update these lists when proposing NIPs introducing new event kinds. | `r` | a reference (URL, etc) | petname | | | `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) | | `content-warning` | reason | -- | [36](36.md) | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | +| `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), [58](58.md) | From d67988e64ee3c0a0df859ad557aa26fb7844f11e Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Fri, 1 Dec 2023 13:54:12 -0300 Subject: [PATCH 121/192] delete NIP-22 (#897) --- 11.md | 4 ++-- 22.md | 45 --------------------------------------------- README.md | 1 - 3 files changed, 2 insertions(+), 48 deletions(-) delete mode 100644 22.md diff --git a/11.md b/11.md index 615e796f..45102d7e 100644 --- a/11.md +++ b/11.md @@ -131,9 +131,9 @@ This should only be set to `true` when users are expected to know the relay poli to write to it -- like belonging to a special pubkey-based whitelist or writing only events of a specific niche kind or content. Normal anti-spam heuristics, for example, do not qualify. -- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md) +- `created_at_lower_limit`: 'created_at' lower limit -- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md) +- `created_at_upper_limit`: 'created_at' upper limit ### Event Retention diff --git a/22.md b/22.md deleted file mode 100644 index 06af4937..00000000 --- a/22.md +++ /dev/null @@ -1,45 +0,0 @@ -NIP-22 -====== - -Event `created_at` Limits -------------------------- - -`draft` `optional` - -Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md). - -If a relay supports this NIP, the relay SHOULD send the client an `OK` result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. - -Client Behavior ---------------- - -Clients SHOULD use the [NIP-11](11.md) `supported_nips` field to learn if a relay uses event `created_at` time limits as defined by this NIP. - -Motivation ----------- - -This NIP formalizes restrictions on event timestamps as accepted by a relay and allows clients to be aware of relays that have these restrictions. - -The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions. - -_Replaceable events_ can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. - -A wide adoption of this NIP could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future. - -Keep in mind that there is a use case where a user migrates their old posts onto a new relay. If a relay rejects events that were not recently created, it cannot serve this use case. - - -Python (pseudocode) Example ---------------------------- - -```python -import time - -TIME = int(time.time()) -LOWER_LIMIT = TIME - (60 * 60 * 24) # Define lower limit as 1 day into the past -UPPER_LIMIT = TIME + (60 * 15) # Define upper limit as 15 minutes into the future - -if event.created_at not in range(LOWER_LIMIT, UPPER_LIMIT): - ws.send('["OK", event.id, False, "invalid: the event created_at field is out of the acceptable range (-24h, +15min) for this relay"]') -``` -Note: These are just example limits, the relay operator can choose whatever limits they want. diff --git a/README.md b/README.md index 2458f7d5..6fbea22a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-21: `nostr:` URI scheme](21.md) -- [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) - [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) From 210e38ae36b9fcc314ce33504232dfa002f43791 Mon Sep 17 00:00:00 2001 From: CapDog <34176400+capitalistdog@users.noreply.github.com> Date: Sat, 2 Dec 2023 12:44:57 -0500 Subject: [PATCH 122/192] Add kind Lightning.Pub's kind 21000 (#911) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6fbea22a..d8b28714 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `13194` | Wallet Info | [47](47.md) | +| `21000` | Lightning Pub RPC | [Lightning.Pub](https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md)| | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | | `23195` | Wallet Response | [47](47.md) | From 3983a52d3bb720852090ee02911f56ee2701dd73 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 2 Dec 2023 14:45:10 -0300 Subject: [PATCH 123/192] latest discoveries. --- 46.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/46.md b/46.md index 1a9be035..ce319709 100644 --- a/46.md +++ b/46.md @@ -12,12 +12,12 @@ This NIP describes a method for 2-way communication between a **remote signer** The client always starts by generating a random key which is used to communicate with the signer, then it one of the methods below is used to allow the client to know what is the signer public key for the session and which relays to use. -### Started by the signer +### Started by the signer (nsecBunker) The remote signer generates a connection token in the form ``` -#?relay=wss://...&relay=wss://... +#?relay=wss://...&relay=wss://... ``` The user copies that token and pastes it in the client UI somehow. Then the client can send events of kind `24133` to the specified relays and wait for responses from the remote signer. @@ -34,7 +34,7 @@ The signer scans the QR code and sends a `connect` message to the client in the ## Event payloads -Event payloads are [NIP-04](04.md)-encrypted JSON blobs that look like JSONRPC. +Event payloads are [NIP-04](04.md)-encrypted JSON blobs that look like JSONRPC messages (their format is specified inside the `.content` of the event formats nelow). Events sent by the client to the remote signer have the following format: @@ -45,7 +45,7 @@ Events sent by the client to the remote signer have the following format: "tags": [ ["p", ""] ], - "content": "nip04_encrypted_json({id: , method: , params: []})", + "content": "nip04_encrypted_json({id: , method: , params: [array_of_strings]})", ... } ``` @@ -58,27 +58,29 @@ And the events the remote signer sends to the client have the following format: "tags": [ ["p", ""] ], - "content": "nip04_encrypted_json({id: , result: , error: })", + "content": "nip04_encrypted_json({id: , result: , error: })", ... ``` +The signer key will always be the key of the user who controls the signer device. + ### Methods - **connect** - params: [`pubkey`, `secret`] - - result: `null` + - result: `"ack"` - **get_public_key** - params: [] - - result: `pubkey` + - result: `pubkey-hex` - **sign_event** - params: [`event`] - - result: `event_with_pubkey_id_and_signature` + - result: `json_string(event_with_pubkey_id_and_signature)` - **get_relays** - params: [] - - result: `{ [url: string]: {read: boolean, write: boolean} }` + - result: `json_string({[url: string]: {read: boolean, write: boolean}})` - **nip04_encrypt** - - params: [`peer-pubkey`, `plaintext`] - - result: `nip4 ciphertext` + - params: [`third-party-pubkey`, `plaintext`] + - result: `nip04-ciphertext` - **nip04_decrypt** - - params: [`peer-pubkey`, `nip4 ciphertext`] - - result: [`plaintext`] + - params: [`third-party-pubkey`, `nip04-ciphertext`] + - result: `plaintext` From 131fcab95c49a828a216145b542e05e9bfbf0381 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 2 Dec 2023 14:54:42 -0300 Subject: [PATCH 124/192] reformat lightning.pub. --- README.md | 149 +++++++++++++++++++++++++++--------------------------- 1 file changed, 75 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index d8b28714..9f2570c4 100644 --- a/README.md +++ b/README.md @@ -75,81 +75,82 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-99: Classified Listings](99.md) ## Event Kinds -| kind | description | NIP | -| ------------- | -------------------------- | ----------- | -| `0` | Metadata | [1](01.md) | -| `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | | -| `3` | Contacts | [2](02.md) | -| `4` | Encrypted Direct Messages | [4](04.md) | -| `5` | Event Deletion | [9](09.md) | -| `6` | Repost | [18](18.md) | -| `7` | Reaction | [25](25.md) | -| `8` | Badge Award | [58](58.md) | -| `16` | Generic Repost | [18](18.md) | -| `40` | Channel Creation | [28](28.md) | -| `41` | Channel Metadata | [28](28.md) | -| `42` | Channel Message | [28](28.md) | -| `43` | Channel Hide Message | [28](28.md) | -| `44` | Channel Mute User | [28](28.md) | -| `1063` | File Metadata | [94](94.md) | -| `1311` | Live Chat Message | [53](53.md) | -| `1040` | OpenTimestamps | [03](03.md) | -| `1971` | Problem Tracker | [nostrocket-1971][nostrocket-1971] | -| `1984` | Reporting | [56](56.md) | -| `1985` | Label | [32](32.md) | -| `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) | -| `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) | -| `10015` | Interests list | [51](51.md) | -| `10030` | User emoji list | [51](51.md) | -| `13194` | Wallet Info | [47](47.md) | -| `21000` | Lightning Pub RPC | [Lightning.Pub](https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md)| | -| `22242` | Client Authentication | [42](42.md) | -| `23194` | Wallet Request | [47](47.md) | -| `23195` | Wallet Response | [47](47.md) | -| `24133` | Nostr Connect | [46](46.md) | -| `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) | -| `30008` | Profile Badges | [58](58.md) | -| `30009` | Badge Definition | [58](58.md) | -| `30015` | Interest sets | [51](51.md) | -| `30030` | Emoji sets | [51](51.md) | -| `30017` | Create or update a stall | [15](15.md) | -| `30018` | Create or update a product | [15](15.md) | -| `30023` | Long-form Content | [23](23.md) | -| `30024` | Draft Long-form Content | [23](23.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) | -| `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) | -| `34550` | Community Definition | [72](72.md) | +| kind | description | NIP | +| ------------- | -------------------------- | ----------- | +| `0` | Metadata | [1](01.md) | +| `1` | Short Text Note | [1](01.md) | +| `2` | Recommend Relay | | +| `3` | Contacts | [2](02.md) | +| `4` | Encrypted Direct Messages | [4](04.md) | +| `5` | Event Deletion | [9](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `16` | Generic Repost | [18](18.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1040` | OpenTimestamps | [03](03.md) | +| `1971` | Problem Tracker | [nostrocket][nostrocket] | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `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) | +| `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) | +| `10015` | Interests list | [51](51.md) | +| `10030` | User emoji list | [51](51.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) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30015` | Interest sets | [51](51.md) | +| `30030` | Emoji sets | [51](51.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.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) | +| `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) | +| `34550` | Community Definition | [72](72.md) | -[nostrocket-1971]: https://github.com/nostrocket/NIPS/blob/main/Problems.md +[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md +[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md ## Message types From 0ba4589550858bb86ed533f90054bfc642aa5350 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 2 Dec 2023 15:05:59 -0300 Subject: [PATCH 125/192] remove websocket status code meaning as it is replaced by the CLOSED message. --- 01.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/01.md b/01.md index dafea1d0..681fc99e 100644 --- a/01.md +++ b/01.md @@ -96,10 +96,6 @@ These are just conventions and relay implementations may differ. Relays expose a websocket endpoint to which clients can connect. Clients SHOULD open a single websocket connection to each relay and use it for all their subscriptions. Relays MAY limit number of connections from specific IP/client/etc. -### Meaning of WebSocket status codes - -- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again. - ### From client to relay: sending events and creating subscriptions Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns: From 0a97dc04405e33882abfd3e29b94d33e76697a38 Mon Sep 17 00:00:00 2001 From: Mike Dilger Date: Sun, 3 Dec 2023 13:22:34 +1300 Subject: [PATCH 126/192] Fix sort order of event kinds --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9f2570c4..a792ec29 100644 --- a/README.md +++ b/README.md @@ -92,9 +92,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `1040` | OpenTimestamps | [03](03.md) | | `1063` | File Metadata | [94](94.md) | | `1311` | Live Chat Message | [53](53.md) | -| `1040` | OpenTimestamps | [03](03.md) | | `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | @@ -131,11 +131,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30015` | Interest sets | [51](51.md) | -| `30030` | Emoji sets | [51](51.md) | | `30017` | Create or update a stall | [15](15.md) | | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | | `30024` | Draft Long-form Content | [23](23.md) | +| `30030` | Emoji sets | [51](51.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | From 9913395d90a602af56404ba2c9a1bc43cac65b26 Mon Sep 17 00:00:00 2001 From: CapDog <34176400+capitalistdog@users.noreply.github.com> Date: Sat, 2 Dec 2023 16:15:53 -0500 Subject: [PATCH 127/192] fix Lightning.Pub hotlink --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a792ec29..68c295fa 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `13194` | Wallet Info | [47](47.md) | -| `21000` | Lightning Pub RPC | [Lightning.Pub](lnpub) | +| `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) | From 149ead16791b7c38fa73e55e82613c3b99a2a8eb Mon Sep 17 00:00:00 2001 From: xiaolou86 <20718693+xiaolou86@users.noreply.github.com> Date: Mon, 4 Dec 2023 15:47:59 +0800 Subject: [PATCH 128/192] fix typo in 47.md --- 47.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/47.md b/47.md index d4b7c1f7..c6540d51 100644 --- a/47.md +++ b/47.md @@ -129,7 +129,7 @@ Errors: ## Example pay invoice flow 0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. -1. **client** sends an event to the **wallet service** service with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. +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. From 625dad7c1a363c38ed5a198b40888dfbc36e3b76 Mon Sep 17 00:00:00 2001 From: xiaolou86 <20718693+xiaolou86@users.noreply.github.com> Date: Mon, 4 Dec 2023 16:07:45 +0800 Subject: [PATCH 129/192] fix typo in 10.md --- 10.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/10.md b/10.md index 5b19fbd3..a434ea05 100644 --- a/10.md +++ b/10.md @@ -33,7 +33,7 @@ Where: * Many "e" tags: `["e", ]` `["e", ]`, ..., `["e", ]`
There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. -They are citings from this event. `root-id` and `reply-id` are as above. +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. From 85abb0e02649725578caf0a9e1d3ba162766f1e2 Mon Sep 17 00:00:00 2001 From: xiaolou86 <20718693+xiaolou86@users.noreply.github.com> Date: Mon, 4 Dec 2023 16:08:03 +0800 Subject: [PATCH 130/192] fix typo in 53.md --- 53.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/53.md b/53.md index d3cc0afd..e17f9656 100644 --- a/53.md +++ b/53.md @@ -6,7 +6,7 @@ Live Activities `draft` `optional` -Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. +Service providers want to offer live activities to the Nostr network in such a way that participants can easily log and query by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. ## Concepts From 8aba861bdf530f9e15b8d371ab3ce4f1ace61fef Mon Sep 17 00:00:00 2001 From: xiaolou86 <20718693+xiaolou86@users.noreply.github.com> Date: Mon, 4 Dec 2023 16:08:09 +0800 Subject: [PATCH 131/192] fix typo in 90.md --- 90.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/90.md b/90.md index 6017c98c..241eb38f 100644 --- a/90.md +++ b/90.md @@ -34,7 +34,7 @@ There are two actors in the workflow described in this NIP: * Service providers (npubs who fulfill jobs) ## Job request (`kind:5000-5999`) -A request to process data, published by a customer. This event signals that an customer is interested in receiving the result of some kind of compute. +A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute. ```json { From 2bd4bf784112aabff9d0fc2dd90fed9107aa5cde Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Wed, 6 Dec 2023 12:01:27 -0300 Subject: [PATCH 132/192] `CLOSED` messages for relays that want to reject REQs and NIP-42 `AUTH` integration (#902) Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> --- 01.md | 12 +++++++--- 42.md | 69 ++++++++++++++++++++++++++++++++++++------------------- 45.md | 11 ++++++++- README.md | 1 + 4 files changed, 65 insertions(+), 28 deletions(-) diff --git a/01.md b/01.md index 681fc99e..99c991ac 100644 --- a/01.md +++ b/01.md @@ -141,19 +141,25 @@ Relays can send 4 types of messages, which must also be JSON arrays, according t * `["EVENT", , ]`, used to send events requested by clients. * `["OK", , , ]`, used to indicate acceptance or denial of an `EVENT` message. * `["EOSE", ]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. + * `["CLOSED", , ]`, used to indicate that a subscription was ended on the server side. * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. This NIP defines no rules for how `NOTICE` messages should be sent or treated. - `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). -- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is `true`, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: - +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is `true`, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a `:` and then a human-readable message. Some examples: * `["OK", "b1a649ebe8...", true, ""]` * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]` * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]` * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]` * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` - * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]` + * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time"]` * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` +- `CLOSED` messages MUST be sent in response to a `REQ` when the relay refuses to fulfill it. It can also be sent when a relay decides to kill a subscription on its side before a client has disconnected or sent a `CLOSE`. This message uses the same pattern of `OK` messages with the machine-readable prefix and human-readable message. Some examples: + * `["CLOSED", "sub1", "duplicate: sub1 already opened"]` + * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` + * `["CLOSED", "sub1", "error: could not connect to the database"]` + * `["CLOSED", "sub1", "error: shutting down idle subscription"]` +- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. diff --git a/42.md b/42.md index e380e89a..07a04864 100644 --- a/42.md +++ b/42.md @@ -12,17 +12,15 @@ This NIP defines a way for clients to authenticate to relays by signing an ephem A relay may want to require clients to authenticate to access restricted resources. For example, - - A relay may request payment or other forms of whitelisting to publish events -- this can naΓ―vely be achieved by limiting publication - to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an - authenticated user; - - A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication - before clients can query for that kind. + - A relay may request payment or other forms of whitelisting to publish events -- this can naΓ―vely be achieved by limiting publication to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an authenticated user; + - A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication before clients can query for that kind. - A relay may limit subscriptions of any kind to paying users or users whitelisted through any other means, and require authentication. ## Definitions -This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want -to authenticate. When sent by relays, the message is of the following form: +### New client-relay protocol messages + +This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays, the message is of the following form: ```json ["AUTH", ] @@ -34,10 +32,11 @@ And, when sent by clients, of the following form: ["AUTH", ] ``` -The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, -one for the relay URL and one for the challenge string as received from the relay. -Relays MUST exclude `kind: 22242` events from being broadcasted to any client. -`created_at` should be the current time. Example: +`AUTH` messages sent by clients should be answered with an `OK` message, like any `EVENT` message. + +### Canonical authentication event + +The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example: ```json { @@ -50,27 +49,49 @@ Relays MUST exclude `kind: 22242` events from being broadcasted to any client. } ``` +### `OK` and `CLOSED` machine-readable prefixes + +This NIP defines two new prefixes that can be used in `OK` (in response to event writes by clients) and `CLOSED` (in response to rejected subscriptions by clients): + +- `"auth-required: "` - for when a client has not performed `AUTH` and the relay requires that to fulfill the query or write the event. +- `"restricted: "` - for when a client has already performed `AUTH` but the key used to perform it is still not allowed by the relay or is exceeding its authorization. + ## Protocol flow -At any moment the relay may send an `AUTH` message to the client containing a challenge. After receiving that the client may decide to -authenticate itself or not. The challenge is expected to be valid for the duration of the connection or until a next challenge is sent by -the relay. +At any moment the relay may send an `AUTH` message to the client containing a challenge. The challenge is valid for the duration of the connection or until another challenge is sent by the relay. The client MAY decide to send its `AUTH` event at any point and the authenticated session is valid afterwards for the duration of the connection. -The client may send an auth message right before performing an action for which it knows authentication will be required -- for example, right -before requesting `kind: 4` chat messages --, or it may do right on connection start or at some other moment it deems best. The authentication -is expected to last for the duration of the WebSocket connection. +### `auth-required` in response to a `REQ` message -Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For -that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example: +Given that a relay is likely to require clients to perform authentication only for certain jobs, like answering a `REQ` or accepting an `EVENT` write, these are some expected common flows: -```json -["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"] +``` +relay: ["AUTH", ""] +client: ["REQ", "sub_1", {"kinds": [4]}] +relay: ["CLOSED", "sub_1", "auth-required: we can't serve DMs to unauthenticated users"] +client: ["AUTH", {"id": "abcdef...", ...}] +relay: ["OK", "abcdef...", true, ""] +client: ["REQ", "sub_1", {"kinds": [4]}] +relay: ["EVENT", "sub_1", {...}] +relay: ["EVENT", "sub_1", {...}] +relay: ["EVENT", "sub_1", {...}] +relay: ["EVENT", "sub_1", {...}] +... ``` -or it can return an `OK` message noting the reason an event was not written using the same prefix: +In this case, the `AUTH` message from the relay could be sent right as the client connects or it can be sent immediately before the `CLOSED` is sent. The only requirement is that _the client must have a stored challenge associated with that relay_ so it can act upon that in response to the `auth-required` `CLOSED` message. -```json -["OK", , false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"] +### `auth-required` in response to an `EVENT` message + +The same flow is valid for when a client wants to write an `EVENT` to the relay, except now the relay sends back an `OK` message instead of a `CLOSED` message: + +``` +relay: ["AUTH", ""] +client: ["EVENT", {"id": "012345...", ...}] +relay: ["OK", "012345...", false, "auth-required: we only accept events from registered users"] +client: ["AUTH", {"id": "abcdef...", ...}] +relay: ["OK", "abcdef...", true, ""] +client: ["EVENT", {"id": "012345...", ...}] +relay: ["OK", "012345...", true, ""] ``` ## Signed Event Verification diff --git a/45.md b/45.md index 998b9529..780dfb6b 100644 --- a/45.md +++ b/45.md @@ -27,7 +27,9 @@ In case a relay uses probabilistic counts, it MAY indicate it in the response wi ["COUNT", , {"count": }] ``` -## Examples: +Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message. + +## Examples ### Followers count @@ -49,3 +51,10 @@ In case a relay uses probabilistic counts, it MAY indicate it in the response wi ["COUNT", , {"kinds": [1]}] ["COUNT", , {"count": 93412452, "approximate": true}] ``` + +### Relay refuses to count + +``` +["COUNT", , {"kinds": [4], "authors": [], "#p": []}] +["CLOSED", , "auth-required: cannot count other people's DMs"] +``` diff --git a/README.md b/README.md index 68c295fa..47b59860 100644 --- a/README.md +++ b/README.md @@ -172,6 +172,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `EVENT` | used to send events requested to clients | [01](01.md) | | `NOTICE` | used to send human-readable messages to clients | [01](01.md) | | `OK` | used to notify clients if an EVENT was successful | [01](01.md) | +| `CLOSED` | used to notify clients that a REQ was ended and why | [01](01.md) | | `AUTH` | used to send authentication challenges | [42](42.md) | | `COUNT` | used to send requested event counts to clients | [45](45.md) | From 0146892501d63042d13724bae7c887bfa985e251 Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Thu, 7 Dec 2023 10:01:57 -0600 Subject: [PATCH 133/192] NIP-02: Rename Contact List to Follow List --- 02.md | 20 ++++++++++---------- README.md | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/02.md b/02.md index 0653d062..8c47a5f7 100644 --- a/02.md +++ b/02.md @@ -1,12 +1,12 @@ NIP-02 ====== -Contact List and Petnames -------------------------- +Follow List +----------- `final` `optional` -A special event with kind `3`, meaning "contact list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. +A special event with kind `3`, meaning "follow list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. 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` can be anything and should be ignored. @@ -25,27 +25,27 @@ For example: } ``` -Every new contact list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past contact lists as soon as they receive a new one. +Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one. ## Uses -### Contact list backup +### Follow list backup If one believes a relay will store their events for sufficient time, they can use this kind-3 event to backup their following list and recover on a different device. ### Profile discovery and context augmentation -A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the contact lists of other people one might be following or browsing; or show the data in other contexts. +A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the follow lists of other people one might be following or browsing; or show the data in other contexts. ### Relay sharing -A client may publish a full list of contacts with good relays for each of their contacts so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance. +A client may publish a follow list with good relays for each of their follows so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance. ### Petname scheme -The data from these contact lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's contact lists. This alleviates the need for global human-readable names. For example: +The data from these follow lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's follow lists. This alleviates the need for global human-readable names. For example: -A user has an internal contact list that says +A user has an internal follow list that says ```json [ @@ -53,7 +53,7 @@ A user has an internal contact list that says ] ``` -And receives two contact lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says +And receives two follow lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says ```json [ diff --git a/README.md b/README.md index 47b59860..6b83490c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## List - [NIP-01: Basic protocol flow description](01.md) -- [NIP-02: Contact List and Petnames](02.md) +- [NIP-02: Follow List](02.md) - [NIP-03: OpenTimestamps Attestations for Events](03.md) - [NIP-04: Encrypted Direct Message](04.md) - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) @@ -80,7 +80,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `0` | Metadata | [1](01.md) | | `1` | Short Text Note | [1](01.md) | | `2` | Recommend Relay | | -| `3` | Contacts | [2](02.md) | +| `3` | Follows | [2](02.md) | | `4` | Encrypted Direct Messages | [4](04.md) | | `5` | Event Deletion | [9](09.md) | | `6` | Repost | [18](18.md) | From d0aef4c1581807a046b00396f67f3dd03cf599e8 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Thu, 7 Dec 2023 17:01:25 +0000 Subject: [PATCH 134/192] add nip-44 calls --- 46.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/46.md b/46.md index ce319709..3ab71e9c 100644 --- a/46.md +++ b/46.md @@ -84,3 +84,15 @@ The signer key will always be the key of the user who controls the signer device - **nip04_decrypt** - params: [`third-party-pubkey`, `nip04-ciphertext`] - result: `plaintext` +- **nip44_get_key** + - params: [`third-party-pubkey`] + - result: `nip44-conversation-key` +- **nip44_encrypt** + - params: [`third-party-pubkey`, `plaintext`] + - result: `nip44-ciphertext` +- **nip44_decrypt** + - params: [`third-party-pubkey`, `nip44-ciphertext`] + - result: `plaintext` +- **ping** + - params: [] + - result: `"pong"` From ef106ecccad2f764f80cae85f2bc666a419f9e20 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 7 Dec 2023 21:18:45 -0300 Subject: [PATCH 135/192] nip-42 phrasing. --- 42.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/42.md b/42.md index 07a04864..8c70de49 100644 --- a/42.md +++ b/42.md @@ -20,19 +20,19 @@ A relay may want to require clients to authenticate to access restricted resourc ### New client-relay protocol messages -This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays, the message is of the following form: +This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form: ```json ["AUTH", ] ``` -And, when sent by clients, of the following form: +And, when sent by clients, the following form: ```json ["AUTH", ] ``` -`AUTH` messages sent by clients should be answered with an `OK` message, like any `EVENT` message. +`AUTH` messages sent by clients MUST be answered with an `OK` message, like any `EVENT` message. ### Canonical authentication event From b8308a9a040005c7a06369d6f71a6f2db6ee9c92 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sun, 3 Dec 2023 10:29:59 +0000 Subject: [PATCH 136/192] Amend NIP-52 to require the content field to be provided, and decouple calendar identifier from calendar name --- 52.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/52.md b/52.md index 15cc8fc5..71b1df26 100644 --- a/52.md +++ b/52.md @@ -22,14 +22,14 @@ This kind of calendar event starts on a date and ends before a different date in The format uses a parameterized replaceable event kind `31922`. -The `.content` of these events is optional and should be a detailed description of the calendar event. +The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. * `name` (required) name of the calendar event * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. -* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `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 * `t` (optional, repeated) hashtag to categorize calendar event @@ -78,7 +78,7 @@ This kind of calendar event spans between a start time and end time. The format uses a parameterized replaceable event kind `31923`. -The `.content` of these events is optional and should be a detailed description of the calendar event. +The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. @@ -87,7 +87,7 @@ 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. -* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `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 * `t` (optional, repeated) hashtag to categorize calendar event @@ -137,15 +137,23 @@ A calendar is a collection of calendar events, represented as a custom replaceab ### Format +The `.content` of these events should be a detailed description of the calendar. It is required but can be an empty string. + The format uses a custom replaceable list of kind `31924` with a list of tags as described below: -* `d` (required) calendar name +* `d` (required) universally unique identifier. Generated by the client creating the calendar. +* `name` (required) calendar name * `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to ```json { + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , "kind": 31924, + "content": "", "tags": [ - ["d", ""], + ["d", ""], + ["name", ""], ["a", "<31922 or 31923>::", ""], ["a", "<31922 or 31923>::", ""] ] From ec08d65665fd533be685702501b69fe9ce7bdd24 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Fri, 8 Dec 2023 09:59:44 -0800 Subject: [PATCH 137/192] Deprecate 'name' for 'title' on calendar events and add 'title' as a shared tag via NIP-24 --- 24.md | 1 + 52.md | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/24.md b/24.md index f830b68d..d444a4bc 100644 --- a/24.md +++ b/24.md @@ -39,3 +39,4 @@ tags These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: - `r`: a web URL the event is referring to in some way + - `title`: title of the event diff --git a/52.md b/52.md index 71b1df26..4ec68369 100644 --- a/52.md +++ b/52.md @@ -26,7 +26,7 @@ The `.content` of these events should be a detailed description of the calendar The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. -* `name` (required) name of the calendar event +* `title` (required) title of the calendar event * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. * `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call @@ -35,6 +35,9 @@ The list of tags are as follows: * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. +The following tags are deprecated: +* `name` name of the calendar event. Use only if `title` is not available. + ```json { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, @@ -45,7 +48,7 @@ The list of tags are as follows: "tags": [ ["d", ""], - ["name", ""], + ["title", ""], // Dates ["start", "<YYYY-MM-DD>"], @@ -82,7 +85,7 @@ The `.content` of these events should be a detailed description of the calendar The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. -* `name` (required) name of the calendar event +* `title` (required) title of the calendar event * `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` @@ -93,6 +96,9 @@ The list of tags are as follows: * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. +The following tags are deprecated: +* `name` name of the calendar event. Use only if `title` is not available. + ```json { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, @@ -103,7 +109,7 @@ The list of tags are as follows: "tags": [ ["d", "<UUID>"], - ["name", "<name of calendar event>"], + ["title", "<title of calendar event>"], // Timestamps ["start", "<Unix timestamp in seconds>"], @@ -141,7 +147,7 @@ The `.content` of these events should be a detailed description of the calendar. The format uses a custom replaceable list of kind `31924` with a list of tags as described below: * `d` (required) universally unique identifier. Generated by the client creating the calendar. -* `name` (required) calendar name +* `title` (required) calendar title * `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to ```json @@ -153,7 +159,7 @@ The format uses a custom replaceable list of kind `31924` with a list of tags as "content": "<description of calendar>", "tags": [ ["d", "<UUID>"], - ["name", "<calendar name>"], + ["title", "<calendar title>"], ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"] ] From 822b70a565678222706dd6284eb7abcaadfc5115 Mon Sep 17 00:00:00 2001 From: Paul Miller <paul@paulmillr.com> Date: Wed, 20 Dec 2023 13:22:02 +0100 Subject: [PATCH 138/192] NIP44 encryption standard, revision 3 (#746) * Introduce NIP-44 encryption standard * Finalize NIP-44 * Update spec. --------- Co-authored-by: Jonathan Staab <shtaab@gmail.com> --- 04.md | 4 +- 07.md | 6 +- 44.md | 296 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 46.md | 1 + README.md | 3 +- 5 files changed, 306 insertions(+), 4 deletions(-) create mode 100644 44.md diff --git a/04.md b/04.md index bf6767b7..dc232b40 100644 --- a/04.md +++ b/04.md @@ -1,10 +1,12 @@ +> __Warning__ `unrecommended`: deprecated in favor of [NIP-44](44.md) + NIP-04 ====== Encrypted Direct Message ------------------------ -`final` `optional` +`final` `unrecommended` `optional` A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes: diff --git a/07.md b/07.md index aa0a5f4b..6db05971 100644 --- a/07.md +++ b/07.md @@ -18,8 +18,10 @@ async window.nostr.signEvent(event: { created_at: number, kind: number, tags: st Aside from these two basic above, the following functions can also be implemented optionally: ``` async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies -async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 -async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 +async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated) +async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated) +async window.nostr.nip44.encrypt(sender_privkey, recipient_pubkey, plaintext, version): string // returns encrypted payload as specified in nip-44 +async window.nostr.nip44.decrypt(recipient_privkey, sender_pubkey, payload): string // takes encrypted payload as specified in nip-44 ``` ### Implementation diff --git a/44.md b/44.md new file mode 100644 index 00000000..1282d261 --- /dev/null +++ b/44.md @@ -0,0 +1,296 @@ +# NIP-44 + +## Encrypted Payloads (Versioned) + +`optional` `author:paulmillr` `author:staab` + +The NIP introduces a new data format for keypair-based encryption. This NIP is versioned +to allow multiple algorithm choices to exist simultaneously. + +Nostr is a key directory. Every nostr user has their own public key, which solves key +distribution problems present in other solutions. The goal of this NIP is to have a +simple way to send messages between nostr accounts that cannot be read by everyone. + +The scheme has a number of important shortcomings: + +- No deniability: it is possible to prove the event was signed by a particular key +- No forward secrecy: when a user key is compromised, it is possible to decrypt all previous conversations +- No post-compromise security: when a user key is compromised, it is possible to decrypt all future conversations +- No post-quantum security: a powerful quantum computer would be able to decrypt the messages +- IP address leak: user IP may be seen by relays and all intermediaries between user and relay +- Date leak: the message date is public, since it is a part of NIP 01 event +- Limited message size leak: padding only partially obscures true message length +- No attachments: they are not supported + +Lack of forward secrecy is partially mitigated: 1) the messages +should only be stored on relays, specified by the user, instead of a set of +all public relays 2) the relays are supposed to regularly delete older messages. + +For risky situations, users should chat in specialized E2EE messaging software and limit use +of nostr to exchanging contacts. + +## Dependence on NIP-01 + +It's not enough to use NIP-44 for encryption: the output must also be signed. + +In nostr case, the payload is serialized and signed as per NIP-01 rules. + +The same event can be serialized in two different ways, +resulting in two distinct signatures. So, it's important +to ensure serialization rules, which are defined in NIP-01, +are the same across different NIP-44 implementations. + +After serialization, the event is signed by Schnorr signature over secp256k1, +defined in BIP340. It's important to ensure the key and signature validity as +per BIP340 rules. + +## Versions + +Currently defined encryption algorithms: + +- `0x00` - Reserved +- `0x01` - Deprecated and undefined +- `0x02` - secp256k1 ECDH, HKDF, padding, ChaCha20, HMAC-SHA256, base64 + +## Version 2 + +The algorithm choices are justified in a following way: + +- Encrypt-then-mac-then-sign instead of encrypt-then-sign-then-mac: + only events wrapped in NIP-01 signed envelope are currently accepted by nostr. +- ChaCha instead of AES: it's faster and has + [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/) +- ChaCha instead of XChaCha: XChaCha has not been standardized. Also, we don't need xchacha's improved + collision resistance of nonces: every message has a new (key, nonce) pair. +- HMAC-SHA256 instead of Poly1305: polynomial MACs are much easier to forge +- SHA256 instead of SHA3 or BLAKE: it is already used in nostr. Also blake's + speed advantage is smaller in non-parallel environments +- Custom padding instead of padmΓ©: better leakage reduction for small messages +- Base64 encoding instead of an other compression algorithm: it is widely available, + and is already used in nostr + +### Functions and operations + +- Cryptographic methods + - `secure_random_bytes(length)` fetches randomness from CSPRNG + - `hkdf(IKM, salt, info, L)` represents HKDF [(RFC 5869)](https://datatracker.ietf.org/doc/html/rfc5869) with SHA256 hash function, + comprised of methods `hkdf_extract(IKM, salt)` and `hkdf_expand(OKM, info, L)` + - `chacha20(key, nonce, data)` is ChaCha20 [(RFC 8439)](https://datatracker.ietf.org/doc/html/rfc8439), with starting counter set to 0 + - `hmac_sha256(key, message)` is HMAC [(RFC 2104)](https://datatracker.ietf.org/doc/html/rfc2104) + - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by + scalar a (`a β‹… B`), defined in + [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki). + The operation produces shared point, and we encode the shared point's 32-byte x coordinate, + using method `bytes(P)` from BIP340. Private and public keys must be validated + as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]` +- Operators + - `x[i:j]`, where `x` is a byte array and `i, j <= 0`, + returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x` +- Constants `c`: + - `min_plaintext_size` is 1. 1b msg is padded to 32b. + - `max_plaintext_size` is 65535 (64kb - 1). It is padded to 65536. +- Functions + - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding) + - `concat` refers to byte array concatenation + - `is_equal_ct(a, b)` is constant-time equality check of 2 byte arrays + - `utf8_encode(string)` and `utf8_decode(bytes)` transform string to byte array and back + - `write_u8(number)` restricts number to values 0..255 and encodes into Big-Endian uint8 byte array + - `write_u16_be(number)` restricts number to values 0..65535 and encodes into Big-Endian uint16 byte array + - `zeros(length)` creates byte array of length `length >= 0`, filled with zeros + - `floor(number)` and `log2(number)` are well-known mathematical methods + +User-defined functions: + +```py +# Calculates length of the padded byte array. +def calc_padded_len(unpadded_len): + next_power = 1 << (floor(log2(unpadded_len - 1))) + 1 + if next_power <= 256: + chunk = 32 + else: + chunk = next_power / 8 + if unpadded_len <= 32: + return 32 + else: + return chunk * (floor((len - 1) / chunk) + 1) + +# Converts unpadded plaintext to padded bytearray +def pad(plaintext): + unpadded = utf8_encode(plaintext) + unpadded_len = len(plaintext) + if (unpadded_len < c.min_plaintext_size or + unpadded_len > c.max_plaintext_size): raise Exception('invalid plaintext length') + prefix = write_u16_be(unpadded_len) + suffix = zeros(calc_padded_len(unpadded_len) - unpadded_len) + return concat(prefix, unpadded, suffix) + +# Converts padded bytearray to unpadded plaintext +def unpad(padded): + unpadded_len = read_uint16_be(padded[0:2]) + unpadded = padded[2:2+unpadded_len] + if (unpadded_len == 0 or + len(unpadded) != unpadded_len or + len(padded) != 2 + calc_padded_len(unpadded_len)): raise Exception('invalid padding') + return utf8_decode(unpadded) + +# metadata: always 65b (version: 1b, nonce: 32b, max: 32b) +# plaintext: 1b to 0xffff +# padded plaintext: 32b to 0xffff +# ciphertext: 32b+2 to 0xffff+2 +# raw payload: 99 (65+32+2) to 65603 (65+0xffff+2) +# compressed payload (base64): 132b to 87472b +def decode_payload(payload): + plen = len(payload) + if plen == 0 or payload[0] == '#': raise Exception('unknown version') + if plen < 132 or plen > 87472: raise Exception('invalid payload size') + data = base64_decode(payload) + dlen = len(d) + if dlen < 99 or dlen > 65603: raise Exception('invalid data size'); + vers = data[0] + if vers != 2: raise Exception('unknown version ' + vers) + nonce = data[1:33] + ciphertext = data[33:dlen - 32] + mac = data[dlen - 32:dlen] + return (nonce, ciphertext, mac) + +def hmac_aad(key, message, aad): + if len(aad) != 32: raise Exception('AAD associated data must be 32 bytes'); + return hmac(sha256, key, concat(aad, message)); + +# Calculates long-term key between users A and B: `get_key(Apriv, Bpub) == get_key(Bpriv, Apub)` +def get_conversation_key(private_key_a, public_key_b): + shared_x = secp256k1_ecdh(private_key_a, public_key_b) + return hkdf_extract(IKM=shared_x, salt=utf8_encode('nip44-v2')) + +# Calculates unique per-message key +def get_message_keys(conversation_key, nonce): + if len(conversation_key) != 32: raise Exception('invalid conversation_key length') + if len(nonce) != 32: raise Exception('invalid nonce length') + keys = hkdf_expand(OKM=conversation_key, info=nonce, L=76) + chacha_key = keys[0:32] + chacha_nonce = keys[32:44] + hmac_key = keys[44:76] + return (chacha_key, chacha_nonce, hmac_key) + +def encrypt(plaintext, conversation_key, nonce): + (chacha_key, chacha_nonce, hmac_key) = get_message_keys(conversation_key, nonce) + padded = pad(plaintext) + ciphertext = chacha20(key=chacha_key, nonce=chacha_nonce, data=padded) + mac = hmac_aad(key=hmac_key, message=ciphertext, aad=nonce) + return base64_encode(concat(write_u8(2), nonce, ciphertext, mac)) + +def decrypt(payload, conversation_key): + (nonce, ciphertext, mac) = decode_payload(payload) + (chacha_key, chacha_nonce, hmac_key) = get_message_keys(conversation_key, nonce) + calculated_mac = hmac_aad(key=hmac_key, message=ciphertext, aad=nonce) + if not is_equal_ct(calculated_mac, mac): raise Exception('invalid MAC') + padded_plaintext = chacha20(key=chacha_key, nonce=chacha_nonce, data=ciphertext) + return unpad(padded_plaintext) + +# Usage: +# conversation_key = get_conversation_key(sender_privkey, recipient_pubkey) +# nonce = secure_random_bytes(32) +# payload = encrypt('hello world', conversation_key, nonce) +# 'hello world' == decrypt(payload, conversation_key) +``` + +#### Encryption + +1. Calculate conversation key + - Execute ECDH (scalar multiplication) of public key B by private key A. + Output `shared_x` must be unhashed, 32-byte encoded x coordinate of the shared point. + - Use HKDF-extract with sha256, `IKM=shared_x` and `salt=utf8_encode('nip44-v2')` + - HKDF output will be `conversation_key` between two users + - It is always the same, when key roles are swapped: `conv(a, B) == conv(b, A)` +2. Generate random 32-byte nonce + - Always use [CSPRNG](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator) + - Don't generate nonce from message content + - Don't re-use the same nonce between messages: doing so would make them decryptable, + but won't leak long-term key +3. Calculate message keys + - The keys are generated from `conversation_key` and `nonce`. Validate that both are 32 bytes + - Use HKDF-expand, with sha256, `OKM=conversation_key`, `info=nonce` and `L=76` + - Slice 76-byte HKDF output into: `chacha_key` (bytes 0..32), `chacha_nonce` (bytes 32..44), `hmac_key` (bytes 44..76) +4. Add padding + - Content must be encoded from UTF-8 into byte array + - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes + - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` + - Padding algorithm is related to powers-of-two, with min padded msg size of 32 + - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob +5. Encrypt padded content + - Use ChaCha20, with key and nonce from step 3 +6. Calculate MAC (message authentication code) with AAD + - AAD is used: instead of calculating MAC on ciphertext, + it's calculated over a concatenation of `nonce` and `ciphertext` + - Validate that AAD (nonce) is 32 bytes +7. Base64-encode (with padding) params: `concat(version, nonce, ciphertext, mac)` + +After encryption, it's necessary to sign it. Use NIP-01 to serialize the event, +with result base64 assigned to event's `content`. Then, use NIP-01 to sign +the event using schnorr signature scheme over secp256k1. + +#### Decryption + +Before decryption, it's necessary to validate the message's pubkey and signature. +The public key must be a valid non-zero secp256k1 curve point, and signature must be valid +secp256k1 schnorr signature. For exact validation rules, refer to BIP-340. + +1. Check if first payload's character is `#` + - `#` is an optional future-proof flag that means non-base64 encoding is used + - The `#` is not present in base64 alphabet, but, instead of throwing `base64 is invalid`, + an app must say the encryption version is not yet supported +2. Decode base64 + - Base64 is decoded into `version, nonce, ciphertext, mac` + - If the version is unknown, the app, an app must say the encryption version is not yet supported + - Validate length of base64 message to prevent DoS on base64 decoder: it can be in range from 132 to 87472 chars + - Validate length of decoded message to verify output of the decoder: it can be in range from 99 to 65603 bytes +3. Calculate conversation key + - See step 1 of Encryption +4. Calculate message keys + - See step 3 of Encryption +5. Calculate MAC (message authentication code) with AAD and compare + - Stop and throw an error if MAC doesn't match the decoded one from step 2 + - Use constant-time comparison algorithm +6. Decrypt ciphertext + - Use ChaCha20 with key and nonce from step 3 +7. Remove padding + - Read the first two BE bytes of plaintext that correspond to plaintext length + - Verify that the length of sliced plaintext matches the value of the two BE bytes + - Verify that calculated padding from encryption's step 3 matches the actual padding + +## Tests and code + +A collection of implementations in different languages is +available [on GitHub](https://github.com/paulmillr/nip44). + +We publish extensive test vectors. Instead of having it in the +document directly, a sha256 checksum of vectors is provided: + + 269ed0f69e4c192512cc779e78c555090cebc7c785b609e338a62afc3ce25040 nip44.vectors.json + +Example of test vector from the file: + +```json +{ + "sec1": "0000000000000000000000000000000000000000000000000000000000000001", + "sec2": "0000000000000000000000000000000000000000000000000000000000000002", + "conversation_key": "c41c775356fd92eadc63ff5a0dc1da211b268cbea22316767095b2871ea1412d", + "nonce": "0000000000000000000000000000000000000000000000000000000000000001", + "plaintext": "a", + "payload": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABee0G5VSK0/9YypIObAtDKfYEAjD35uVkHyB0F4DwrcNaCXlCWZKaArsGrY6M9wnuTMxWfp1RTN9Xga8no+kF5Vsb" +} +``` + +The file also contains intermediate values. A quick guidance with regards to its usage: + +- `valid.get_conversation_key`: calculate conversation_key from secret key sec1 and public key pub2 +- `valid.get_message_keys`: calculate chacha_key, chacha_nocne, hmac_key from conversation_key and nonce +- `valid.calc_padded_len`: take unpadded length (first value), calculate padded length (second value) +- `valid.encrypt_decrypt`: emulate real conversation. Calculate + pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, + then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext. +- `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, + their checksum is provided. +- `invalid.encrypt_msg_lengths` +- `invalid.get_conversation_key`: calculating converastion_key must throw an error +- `invalid.decrypt`: decrypting message content must throw an error diff --git a/46.md b/46.md index 3ab71e9c..1f8e6c8d 100644 --- a/46.md +++ b/46.md @@ -96,3 +96,4 @@ The signer key will always be the key of the user who controls the signer device - **ping** - params: [] - result: `"pong"` + diff --git a/README.md b/README.md index 6b83490c..a66c4664 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [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) +- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-44](44.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) @@ -52,6 +52,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [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) From 4199f202365fc4c1a464b1033d040597bccbb08d Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 20 Dec 2023 13:56:03 -0300 Subject: [PATCH 139/192] nip-44: remove author names and arbitrary line-breaks. --- 44.md | 66 ++++++++++++++++++----------------------------------------- 1 file changed, 20 insertions(+), 46 deletions(-) diff --git a/44.md b/44.md index 1282d261..e66a7b3c 100644 --- a/44.md +++ b/44.md @@ -2,7 +2,7 @@ ## Encrypted Payloads (Versioned) -`optional` `author:paulmillr` `author:staab` +`optional` The NIP introduces a new data format for keypair-based encryption. This NIP is versioned to allow multiple algorithm choices to exist simultaneously. @@ -22,12 +22,11 @@ The scheme has a number of important shortcomings: - Limited message size leak: padding only partially obscures true message length - No attachments: they are not supported -Lack of forward secrecy is partially mitigated: 1) the messages -should only be stored on relays, specified by the user, instead of a set of -all public relays 2) the relays are supposed to regularly delete older messages. +Lack of forward secrecy is partially mitigated by these two factors: + 1. the messages should only be stored on relays, specified by the user, instead of a set of all public relays. + 2. the relays are supposed to regularly delete older messages. -For risky situations, users should chat in specialized E2EE messaging software and limit use -of nostr to exchanging contacts. +For risky situations, users should chat in specialized E2EE messaging software and limit use of nostr to exchanging contacts. ## Dependence on NIP-01 @@ -35,14 +34,9 @@ It's not enough to use NIP-44 for encryption: the output must also be signed. In nostr case, the payload is serialized and signed as per NIP-01 rules. -The same event can be serialized in two different ways, -resulting in two distinct signatures. So, it's important -to ensure serialization rules, which are defined in NIP-01, -are the same across different NIP-44 implementations. +The same event can be serialized in two different ways, resulting in two distinct signatures. So, it's important to ensure serialization rules, which are defined in NIP-01, are the same across different NIP-44 implementations. -After serialization, the event is signed by Schnorr signature over secp256k1, -defined in BIP340. It's important to ensure the key and signature validity as -per BIP340 rules. +After serialization, the event is signed by Schnorr signature over secp256k1, defined in BIP340. It's important to ensure the key and signature validity as per BIP340 rules. ## Versions @@ -56,18 +50,12 @@ Currently defined encryption algorithms: The algorithm choices are justified in a following way: -- Encrypt-then-mac-then-sign instead of encrypt-then-sign-then-mac: - only events wrapped in NIP-01 signed envelope are currently accepted by nostr. -- ChaCha instead of AES: it's faster and has - [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/) -- ChaCha instead of XChaCha: XChaCha has not been standardized. Also, we don't need xchacha's improved - collision resistance of nonces: every message has a new (key, nonce) pair. -- HMAC-SHA256 instead of Poly1305: polynomial MACs are much easier to forge -- SHA256 instead of SHA3 or BLAKE: it is already used in nostr. Also blake's - speed advantage is smaller in non-parallel environments -- Custom padding instead of padmΓ©: better leakage reduction for small messages -- Base64 encoding instead of an other compression algorithm: it is widely available, - and is already used in nostr +- Encrypt-then-mac-then-sign instead of encrypt-then-sign-then-mac: only events wrapped in NIP-01 signed envelope are currently accepted by nostr. +- ChaCha instead of AES: it's faster and has [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/) +- ChaCha instead of XChaCha: XChaCha has not been standardized. Also, we don't need xchacha's improved collision resistance of nonces: every message has a new (key, nonce) pair. +- HMAC-SHA256 instead of Poly1305: polynomial MACs are much easier to forge SHA256 instead of SHA3 or BLAKE: it is already used in nostr. Also blake's + speed advantage is smaller in non-parallel environments - Custom padding instead of padmΓ©: better leakage reduction for small messages +- Base64 encoding instead of an other compression algorithm: it is widely available, and is already used in nostr ### Functions and operations @@ -77,12 +65,7 @@ The algorithm choices are justified in a following way: comprised of methods `hkdf_extract(IKM, salt)` and `hkdf_expand(OKM, info, L)` - `chacha20(key, nonce, data)` is ChaCha20 [(RFC 8439)](https://datatracker.ietf.org/doc/html/rfc8439), with starting counter set to 0 - `hmac_sha256(key, message)` is HMAC [(RFC 2104)](https://datatracker.ietf.org/doc/html/rfc2104) - - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by - scalar a (`a β‹… B`), defined in - [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki). - The operation produces shared point, and we encode the shared point's 32-byte x coordinate, - using method `bytes(P)` from BIP340. Private and public keys must be validated - as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]` + - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by scalar a (`a β‹… B`), defined in [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki). The operation produces shared point, and we encode the shared point's 32-byte x coordinate, using method `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]` - Operators - `x[i:j]`, where `x` is a byte array and `i, j <= 0`, returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x` @@ -225,15 +208,11 @@ def decrypt(payload, conversation_key): - Validate that AAD (nonce) is 32 bytes 7. Base64-encode (with padding) params: `concat(version, nonce, ciphertext, mac)` -After encryption, it's necessary to sign it. Use NIP-01 to serialize the event, -with result base64 assigned to event's `content`. Then, use NIP-01 to sign -the event using schnorr signature scheme over secp256k1. +After encryption, it's necessary to sign it. Use NIP-01 to serialize the event, with result base64 assigned to event's `content`. Then, use NIP-01 to sign the event using schnorr signature scheme over secp256k1. #### Decryption -Before decryption, it's necessary to validate the message's pubkey and signature. -The public key must be a valid non-zero secp256k1 curve point, and signature must be valid -secp256k1 schnorr signature. For exact validation rules, refer to BIP-340. +Before decryption, it's necessary to validate the message's pubkey and signature. The public key must be a valid non-zero secp256k1 curve point, and signature must be valid secp256k1 schnorr signature. For exact validation rules, refer to BIP-340. 1. Check if first payload's character is `#` - `#` is an optional future-proof flag that means non-base64 encoding is used @@ -260,11 +239,9 @@ secp256k1 schnorr signature. For exact validation rules, refer to BIP-340. ## Tests and code -A collection of implementations in different languages is -available [on GitHub](https://github.com/paulmillr/nip44). +A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. -We publish extensive test vectors. Instead of having it in the -document directly, a sha256 checksum of vectors is provided: +We publish extensive test vectors. Instead of having it in the document directly, a sha256 checksum of vectors is provided: 269ed0f69e4c192512cc779e78c555090cebc7c785b609e338a62afc3ce25040 nip44.vectors.json @@ -286,11 +263,8 @@ The file also contains intermediate values. A quick guidance with regards to its - `valid.get_conversation_key`: calculate conversation_key from secret key sec1 and public key pub2 - `valid.get_message_keys`: calculate chacha_key, chacha_nocne, hmac_key from conversation_key and nonce - `valid.calc_padded_len`: take unpadded length (first value), calculate padded length (second value) -- `valid.encrypt_decrypt`: emulate real conversation. Calculate - pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, - then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext. -- `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, - their checksum is provided. +- `valid.encrypt_decrypt`: emulate real conversation. Calculate pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext. +- `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, their checksum is provided. - `invalid.encrypt_msg_lengths` - `invalid.get_conversation_key`: calculating converastion_key must throw an error - `invalid.decrypt`: decrypting message content must throw an error From 9be51261c0d1aeff2a99591d978b88bf7e5766b3 Mon Sep 17 00:00:00 2001 From: Paul Miller <paul@paulmillr.com> Date: Wed, 20 Dec 2023 20:18:43 +0300 Subject: [PATCH 140/192] nip-44: add audit notice --- 44.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/44.md b/44.md index e66a7b3c..d69c688e 100644 --- a/44.md +++ b/44.md @@ -237,6 +237,12 @@ Before decryption, it's necessary to validate the message's pubkey and signature - Verify that the length of sliced plaintext matches the value of the two BE bytes - Verify that calculated padding from encryption's step 3 matches the actual padding +## Audit + +The v2 of the standard has been subject to an audit by [Cure53](https://cure53.de) in December 2023. +Check out [audit-2023.12.pdf](https://github.com/paulmillr/nip44/blob/ce63c2eaf345e9f7f93b48f829e6bdeb7e7d7964/audit-2023.12.pdf) +and [auditor's website](https://cure53.de/audit-report_nip44-implementations.pdf). + ## Tests and code A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. From ff533d7a99715b0524f93a182f6c2169fe3b25b1 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 20 Dec 2023 14:39:35 -0300 Subject: [PATCH 141/192] remove nip44 calls from nip07 temporarily. --- 07.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/07.md b/07.md index 6db05971..90772eef 100644 --- a/07.md +++ b/07.md @@ -20,8 +20,6 @@ Aside from these two basic above, the following functions can also be implemente async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated) async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated) -async window.nostr.nip44.encrypt(sender_privkey, recipient_pubkey, plaintext, version): string // returns encrypted payload as specified in nip-44 -async window.nostr.nip44.decrypt(recipient_privkey, sender_pubkey, payload): string // takes encrypted payload as specified in nip-44 ``` ### Implementation From 732b0ce0a49fbdfa35dfae164f25ee9db947f1c2 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Wed, 20 Dec 2023 11:28:43 -0800 Subject: [PATCH 142/192] Clean up NIP 44 to clarify separation of concerns (encryption vs messaging), improve formatting and clarify encryption/decryption steps --- 44.md | 245 +++++++++++++++++++++++++++++++--------------------------- 1 file changed, 130 insertions(+), 115 deletions(-) diff --git a/44.md b/44.md index d69c688e..5093acd3 100644 --- a/44.md +++ b/44.md @@ -1,42 +1,14 @@ -# NIP-44 +NIP-44 +===== -## Encrypted Payloads (Versioned) +Encrypted Payloads (Versioned) +------------------------------ `optional` The NIP introduces a new data format for keypair-based encryption. This NIP is versioned -to allow multiple algorithm choices to exist simultaneously. - -Nostr is a key directory. Every nostr user has their own public key, which solves key -distribution problems present in other solutions. The goal of this NIP is to have a -simple way to send messages between nostr accounts that cannot be read by everyone. - -The scheme has a number of important shortcomings: - -- No deniability: it is possible to prove the event was signed by a particular key -- No forward secrecy: when a user key is compromised, it is possible to decrypt all previous conversations -- No post-compromise security: when a user key is compromised, it is possible to decrypt all future conversations -- No post-quantum security: a powerful quantum computer would be able to decrypt the messages -- IP address leak: user IP may be seen by relays and all intermediaries between user and relay -- Date leak: the message date is public, since it is a part of NIP 01 event -- Limited message size leak: padding only partially obscures true message length -- No attachments: they are not supported - -Lack of forward secrecy is partially mitigated by these two factors: - 1. the messages should only be stored on relays, specified by the user, instead of a set of all public relays. - 2. the relays are supposed to regularly delete older messages. - -For risky situations, users should chat in specialized E2EE messaging software and limit use of nostr to exchanging contacts. - -## Dependence on NIP-01 - -It's not enough to use NIP-44 for encryption: the output must also be signed. - -In nostr case, the payload is serialized and signed as per NIP-01 rules. - -The same event can be serialized in two different ways, resulting in two distinct signatures. So, it's important to ensure serialization rules, which are defined in NIP-01, are the same across different NIP-44 implementations. - -After serialization, the event is signed by Schnorr signature over secp256k1, defined in BIP340. It's important to ensure the key and signature validity as per BIP340 rules. +to allow multiple algorithm choices to exist simultaneously. This format may be used for +many things, but MUST be used in the context of a signed event as described in NIP 01. ## Versions @@ -46,29 +18,129 @@ Currently defined encryption algorithms: - `0x01` - Deprecated and undefined - `0x02` - secp256k1 ECDH, HKDF, padding, ChaCha20, HMAC-SHA256, base64 +## Limitations + +Every nostr user has their own public key, which solves key distribution problems present +in other solutions. However, nostr's relay-based architecture makes it difficult to implement +more robust private messaging protocols with things like metadata hiding, forward secrecy, +and post compromise secrecy. + +The goal of this NIP is to have a _simple_ way to encrypt payloads used in the context of a signed +event. When applying this NIP to any use case, it's important to keep in mind your users' threat +model and this NIP's limitations. For high-risk situations, users should chat in specialized E2EE +messaging software and limit use of nostr to exchanging contacts. + +On its own, messages sent using this scheme has a number of important shortcomings: + +- No deniability: it is possible to prove an event was signed by a particular key +- No forward secrecy: when a key is compromised, it is possible to decrypt all previous conversations +- No post-compromise security: when a key is compromised, it is possible to decrypt all future conversations +- No post-quantum security: a powerful quantum computer would be able to decrypt the messages +- IP address leak: user IP may be seen by relays and all intermediaries between user and relay +- Date leak: `created_at` is public, since it is a part of NIP 01 event +- Limited message size leak: padding only partially obscures true message length +- No attachments: they are not supported + +Lack of forward secrecy may be partially mitigated by only sending messages to trusted relays, and asking +relays to delete stored messages after a certain duration has elapsed. + ## Version 2 -The algorithm choices are justified in a following way: +NIP-44 version 2 has the following design characteristics: -- Encrypt-then-mac-then-sign instead of encrypt-then-sign-then-mac: only events wrapped in NIP-01 signed envelope are currently accepted by nostr. -- ChaCha instead of AES: it's faster and has [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/) -- ChaCha instead of XChaCha: XChaCha has not been standardized. Also, we don't need xchacha's improved collision resistance of nonces: every message has a new (key, nonce) pair. -- HMAC-SHA256 instead of Poly1305: polynomial MACs are much easier to forge SHA256 instead of SHA3 or BLAKE: it is already used in nostr. Also blake's - speed advantage is smaller in non-parallel environments - Custom padding instead of padmΓ©: better leakage reduction for small messages -- Base64 encoding instead of an other compression algorithm: it is widely available, and is already used in nostr +- Payloads are authenticated using a MAC before signing rather than afterwards because events are assumed + to be signed as specified in NIP-01. The outer signature serves to authenticate the full payload, and MUST + be validated before decrypting. +- ChaCha is used instead of AES because it's faster and has + [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/). +- ChaCha is used instead of XChaCha because XChaCha has not been standardized. Also, xChaCha's improved collision + resistance of nonces isn't necessary since every message has a new (key, nonce) pair. +- HMAC-SHA256 is used instead of Poly1305 because polynomial MACs are much easier to forge. +- SHA256 is used instead of SHA3 or BLAKE because it is already used in nostr. Also BLAKE's speed advantage + is smaller in non-parallel environments. +- A custom padding scheme is used instead of padmΓ© because it provides better leakage reduction for small messages. +- Base64 encoding is used instead of another compression algorithm because it is widely available, and is already used in nostr. -### Functions and operations +### Encryption + +1. Calculate a conversation key + - Execute ECDH (scalar multiplication) of public key B by private key A + Output `shared_x` must be unhashed, 32-byte encoded x coordinate of the shared point + - Use HKDF-extract with sha256, `IKM=shared_x` and `salt=utf8_encode('nip44-v2')` + - HKDF output will be a `conversation_key` between two users. + - It is always the same, when key roles are swapped: `conv(a, B) == conv(b, A)` +2. Generate a random 32-byte nonce + - Always use [CSPRNG](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator) + - Don't generate a nonce from message content + - Don't re-use the same nonce between messages: doing so would make them decryptable, + but won't leak the long-term key +3. Calculate message keys + - The keys are generated from `conversation_key` and `nonce`. Validate that both are 32 bytes long + - Use HKDF-expand, with sha256, `OKM=conversation_key`, `info=nonce` and `L=76` + - Slice 76-byte HKDF output into: `chacha_key` (bytes 0..32), `chacha_nonce` (bytes 32..44), `hmac_key` (bytes 44..76) +4. Add padding + - Content must be encoded from UTF-8 into byte array + - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes + - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` + - Padding algorithm is related to powers-of-two, with min padded msg size of 32 + - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob +5. Encrypt padded content + - Use ChaCha20, with key and nonce from step 3 +6. Calculate MAC (message authentication code) + - AAD (additional authenticated data) is used - instead of calculating MAC on ciphertext, + it's calculated over a concatenation of `nonce` and `ciphertext` + - Validate that AAD (nonce) is 32 bytes +7. Base64-encode (with padding) params using `concat(version, nonce, ciphertext, mac)` + +Encrypted payloads MUST be included in an event's payload, hashed, and signed as defined in NIP 01, using schnorr +signature scheme over secp256k1. + +### Decryption + +Before decryption, the event's pubkey and signature MUST be validated as defined in NIP 01. The public key MUST be +a valid non-zero secp256k1 curve point, and the signature must be valid secp256k1 schnorr signature. For exact +validation rules, refer to BIP-340. + +1. Check if first payload's character is `#` + - `#` is an optional future-proof flag that means non-base64 encoding is used + - The `#` is not present in base64 alphabet, but, instead of throwing `base64 is invalid`, + implementations MUST indicate that the encryption version is not yet supported +2. Decode base64 + - Base64 is decoded into `version, nonce, ciphertext, mac` + - If the version is unknown, implementations must indicate that the encryption version is not supported + - Validate length of base64 message to prevent DoS on base64 decoder: it can be in range from 132 to 87472 chars + - Validate length of decoded message to verify output of the decoder: it can be in range from 99 to 65603 bytes +3. Calculate conversation key + - See step 1 of (encryption)[#Encryption] +4. Calculate message keys + - See step 3 of (encryption)[#Encryption] +5. Calculate MAC (message authentication code) with AAD and compare + - Stop and throw an error if MAC doesn't match the decoded one from step 2 + - Use constant-time comparison algorithm +6. Decrypt ciphertext + - Use ChaCha20 with key and nonce from step 3 +7. Remove padding + - Read the first two BE bytes of plaintext that correspond to plaintext length + - Verify that the length of sliced plaintext matches the value of the two BE bytes + - Verify that calculated padding from step 3 of the (encryption)[#Encryption] process matches the actual padding + +### Details - Cryptographic methods - - `secure_random_bytes(length)` fetches randomness from CSPRNG - - `hkdf(IKM, salt, info, L)` represents HKDF [(RFC 5869)](https://datatracker.ietf.org/doc/html/rfc5869) with SHA256 hash function, - comprised of methods `hkdf_extract(IKM, salt)` and `hkdf_expand(OKM, info, L)` - - `chacha20(key, nonce, data)` is ChaCha20 [(RFC 8439)](https://datatracker.ietf.org/doc/html/rfc8439), with starting counter set to 0 - - `hmac_sha256(key, message)` is HMAC [(RFC 2104)](https://datatracker.ietf.org/doc/html/rfc2104) - - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by scalar a (`a β‹… B`), defined in [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki). The operation produces shared point, and we encode the shared point's 32-byte x coordinate, using method `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]` + - `secure_random_bytes(length)` fetches randomness from CSPRNG. + - `hkdf(IKM, salt, info, L)` represents HKDF [(RFC 5869)](https://datatracker.ietf.org/doc/html/rfc5869) + with SHA256 hash function comprised of methods `hkdf_extract(IKM, salt)` and `hkdf_expand(OKM, info, L)`. + - `chacha20(key, nonce, data)` is ChaCha20 [(RFC 8439)](https://datatracker.ietf.org/doc/html/rfc8439) with + starting counter set to 0. + - `hmac_sha256(key, message)` is HMAC [(RFC 2104)](https://datatracker.ietf.org/doc/html/rfc2104). + - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by scalar a (`a β‹… B`), defined in + [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki). + The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method + `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, + on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. - Operators - - `x[i:j]`, where `x` is a byte array and `i, j <= 0`, - returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x` + - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the + `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. - Constants `c`: - `min_plaintext_size` is 1. 1b msg is padded to 32b. - `max_plaintext_size` is 65535 (64kb - 1). It is padded to 65536. @@ -82,7 +154,10 @@ The algorithm choices are justified in a following way: - `zeros(length)` creates byte array of length `length >= 0`, filled with zeros - `floor(number)` and `log2(number)` are well-known mathematical methods -User-defined functions: +### Implementation pseudocode + +The following is a collection of python-like pseudocode functions which implement the above primitives, +intended to guide impelmenters. A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. ```py # Calculates length of the padded byte array. @@ -177,73 +252,13 @@ def decrypt(payload, conversation_key): # 'hello world' == decrypt(payload, conversation_key) ``` -#### Encryption +### Audit -1. Calculate conversation key - - Execute ECDH (scalar multiplication) of public key B by private key A. - Output `shared_x` must be unhashed, 32-byte encoded x coordinate of the shared point. - - Use HKDF-extract with sha256, `IKM=shared_x` and `salt=utf8_encode('nip44-v2')` - - HKDF output will be `conversation_key` between two users - - It is always the same, when key roles are swapped: `conv(a, B) == conv(b, A)` -2. Generate random 32-byte nonce - - Always use [CSPRNG](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator) - - Don't generate nonce from message content - - Don't re-use the same nonce between messages: doing so would make them decryptable, - but won't leak long-term key -3. Calculate message keys - - The keys are generated from `conversation_key` and `nonce`. Validate that both are 32 bytes - - Use HKDF-expand, with sha256, `OKM=conversation_key`, `info=nonce` and `L=76` - - Slice 76-byte HKDF output into: `chacha_key` (bytes 0..32), `chacha_nonce` (bytes 32..44), `hmac_key` (bytes 44..76) -4. Add padding - - Content must be encoded from UTF-8 into byte array - - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes - - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` - - Padding algorithm is related to powers-of-two, with min padded msg size of 32 - - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob -5. Encrypt padded content - - Use ChaCha20, with key and nonce from step 3 -6. Calculate MAC (message authentication code) with AAD - - AAD is used: instead of calculating MAC on ciphertext, - it's calculated over a concatenation of `nonce` and `ciphertext` - - Validate that AAD (nonce) is 32 bytes -7. Base64-encode (with padding) params: `concat(version, nonce, ciphertext, mac)` - -After encryption, it's necessary to sign it. Use NIP-01 to serialize the event, with result base64 assigned to event's `content`. Then, use NIP-01 to sign the event using schnorr signature scheme over secp256k1. - -#### Decryption - -Before decryption, it's necessary to validate the message's pubkey and signature. The public key must be a valid non-zero secp256k1 curve point, and signature must be valid secp256k1 schnorr signature. For exact validation rules, refer to BIP-340. - -1. Check if first payload's character is `#` - - `#` is an optional future-proof flag that means non-base64 encoding is used - - The `#` is not present in base64 alphabet, but, instead of throwing `base64 is invalid`, - an app must say the encryption version is not yet supported -2. Decode base64 - - Base64 is decoded into `version, nonce, ciphertext, mac` - - If the version is unknown, the app, an app must say the encryption version is not yet supported - - Validate length of base64 message to prevent DoS on base64 decoder: it can be in range from 132 to 87472 chars - - Validate length of decoded message to verify output of the decoder: it can be in range from 99 to 65603 bytes -3. Calculate conversation key - - See step 1 of Encryption -4. Calculate message keys - - See step 3 of Encryption -5. Calculate MAC (message authentication code) with AAD and compare - - Stop and throw an error if MAC doesn't match the decoded one from step 2 - - Use constant-time comparison algorithm -6. Decrypt ciphertext - - Use ChaCha20 with key and nonce from step 3 -7. Remove padding - - Read the first two BE bytes of plaintext that correspond to plaintext length - - Verify that the length of sliced plaintext matches the value of the two BE bytes - - Verify that calculated padding from encryption's step 3 matches the actual padding - -## Audit - -The v2 of the standard has been subject to an audit by [Cure53](https://cure53.de) in December 2023. +The v2 of the standard was audited by [Cure53](https://cure53.de) in December 2023. Check out [audit-2023.12.pdf](https://github.com/paulmillr/nip44/blob/ce63c2eaf345e9f7f93b48f829e6bdeb7e7d7964/audit-2023.12.pdf) and [auditor's website](https://cure53.de/audit-report_nip44-implementations.pdf). -## Tests and code +### Tests and code A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. @@ -251,7 +266,7 @@ We publish extensive test vectors. Instead of having it in the document directly 269ed0f69e4c192512cc779e78c555090cebc7c785b609e338a62afc3ce25040 nip44.vectors.json -Example of test vector from the file: +Example of a test vector from the file: ```json { From 2b78cc9304f775b8391f62b7fe61e99a3fdc905b Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Wed, 20 Dec 2023 11:35:12 -0800 Subject: [PATCH 143/192] Add clarification about not replacing nip 04 --- 44.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/44.md b/44.md index 5093acd3..8bc40383 100644 --- a/44.md +++ b/44.md @@ -10,6 +10,10 @@ The NIP introduces a new data format for keypair-based encryption. This NIP is v to allow multiple algorithm choices to exist simultaneously. This format may be used for many things, but MUST be used in the context of a signed event as described in NIP 01. +*Note*: this format DOES NOT define any `kind`s related to a new direct messaging standard, +only the encryption required to define one. It SHOULD NOT be used as a drop-in replacement +for NIP 04 payloads. + ## Versions Currently defined encryption algorithms: @@ -30,7 +34,7 @@ event. When applying this NIP to any use case, it's important to keep in mind yo model and this NIP's limitations. For high-risk situations, users should chat in specialized E2EE messaging software and limit use of nostr to exchanging contacts. -On its own, messages sent using this scheme has a number of important shortcomings: +On its own, messages sent using this scheme have a number of important shortcomings: - No deniability: it is possible to prove an event was signed by a particular key - No forward secrecy: when a key is compromised, it is possible to decrypt all previous conversations From 5ed4232584f3ab34192291daf985742248fb14ea Mon Sep 17 00:00:00 2001 From: Josua Schmid <josua.schmid@renuo.ch> Date: Fri, 22 Dec 2023 09:58:49 +0100 Subject: [PATCH 144/192] Mention deprecation of kind 2 Kind `2` was [consciously](https://github.com/nostr-protocol/nips/pull/703#issuecomment-1672098794) removed in https://github.com/nostr-protocol/nips/commit/72bb8a128b2d7d3c2c654644cd68d0d0fe58a3b1#diff-39307f1617417657ee9874be314f13aabdc74401b124d0afe8217f2919c9c7d8L105. Mentioning the fact should help prevent further confusion. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a66c4664..ce1542b5 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | ------------- | -------------------------- | ----------- | | `0` | Metadata | [1](01.md) | | `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | | +| `2` | Recommend Relay | 1 (before 2023-08-13) | | `3` | Follows | [2](02.md) | | `4` | Encrypted Direct Messages | [4](04.md) | | `5` | Event Deletion | [9](09.md) | From d30f03316f0b3ab56faba94b0abfcb9041b81764 Mon Sep 17 00:00:00 2001 From: Josua Schmid <josua.schmid@renuo.ch> Date: Fri, 22 Dec 2023 14:54:17 +0100 Subject: [PATCH 145/192] Emphasis on multiple filters in NIP-01 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As mentioned further down in NIP-01 > A REQ message may contain multiple filters. The comma makes it more clear that the message array can container more than 3 items. So it is understood easily to match ``` // correct: ["REQ", <subscription_id>, filters1, filters2, …] ``` instead of ``` // wrong: ["REQ", <subscription_id>, [filters1, filters2, …]] ``` --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 99c991ac..0cf03ed8 100644 --- a/01.md +++ b/01.md @@ -101,7 +101,7 @@ Relays expose a websocket endpoint to which clients can connect. Clients SHOULD Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns: * `["EVENT", <event JSON as defined above>]`, used to publish events. - * `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates. + * `["REQ", <subscription_id>, <filters JSON>, ...]`, used to request events and subscribe to new updates. * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. `<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage `<subscription_id>`s independently for each WebSocket connection; even if `<subscription_id>`s are the same string, they should be treated as different subscriptions for different connections. From 91244c50cdb77fd94021d0847148e091b8d468d1 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 23 Dec 2023 01:07:55 +0900 Subject: [PATCH 146/192] Add leading zero to NIP numbers --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ce1542b5..2467eb60 100644 --- a/README.md +++ b/README.md @@ -78,12 +78,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Event Kinds | kind | description | NIP | | ------------- | -------------------------- | ----------- | -| `0` | Metadata | [1](01.md) | -| `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | 1 (before 2023-08-13) | -| `3` | Follows | [2](02.md) | -| `4` | Encrypted Direct Messages | [4](04.md) | -| `5` | Event Deletion | [9](09.md) | +| `0` | Metadata | [01](01.md) | +| `1` | Short Text Note | [01](01.md) | +| `2` | Recommend Relay | 01 (before 2023-08-13) | +| `3` | Follows | [02](02.md) | +| `4` | Encrypted Direct Messages | [04](04.md) | +| `5` | Event Deletion | [09](09.md) | | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | From 95218740e2a78dbe941f09b09360541731d8f55e Mon Sep 17 00:00:00 2001 From: jiftechnify <jiftech.stlfy@gmail.com> Date: Mon, 25 Dec 2023 12:00:05 +0900 Subject: [PATCH 147/192] fix typos --- 44.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/44.md b/44.md index 8bc40383..0efa4825 100644 --- a/44.md +++ b/44.md @@ -80,7 +80,7 @@ NIP-44 version 2 has the following design characteristics: but won't leak the long-term key 3. Calculate message keys - The keys are generated from `conversation_key` and `nonce`. Validate that both are 32 bytes long - - Use HKDF-expand, with sha256, `OKM=conversation_key`, `info=nonce` and `L=76` + - Use HKDF-expand, with sha256, `PRK=conversation_key`, `info=nonce` and `L=76` - Slice 76-byte HKDF output into: `chacha_key` (bytes 0..32), `chacha_nonce` (bytes 32..44), `hmac_key` (bytes 44..76) 4. Add padding - Content must be encoded from UTF-8 into byte array @@ -115,9 +115,9 @@ validation rules, refer to BIP-340. - Validate length of base64 message to prevent DoS on base64 decoder: it can be in range from 132 to 87472 chars - Validate length of decoded message to verify output of the decoder: it can be in range from 99 to 65603 bytes 3. Calculate conversation key - - See step 1 of (encryption)[#Encryption] + - See step 1 of [encryption](#Encryption) 4. Calculate message keys - - See step 3 of (encryption)[#Encryption] + - See step 3 of [encryption](#Encryption) 5. Calculate MAC (message authentication code) with AAD and compare - Stop and throw an error if MAC doesn't match the decoded one from step 2 - Use constant-time comparison algorithm @@ -126,7 +126,7 @@ validation rules, refer to BIP-340. 7. Remove padding - Read the first two BE bytes of plaintext that correspond to plaintext length - Verify that the length of sliced plaintext matches the value of the two BE bytes - - Verify that calculated padding from step 3 of the (encryption)[#Encryption] process matches the actual padding + - Verify that calculated padding from step 3 of the [encryption](#Encryption) process matches the actual padding ### Details @@ -291,5 +291,5 @@ The file also contains intermediate values. A quick guidance with regards to its - `valid.encrypt_decrypt`: emulate real conversation. Calculate pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext. - `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, their checksum is provided. - `invalid.encrypt_msg_lengths` -- `invalid.get_conversation_key`: calculating converastion_key must throw an error +- `invalid.get_conversation_key`: calculating conversation_key must throw an error - `invalid.decrypt`: decrypting message content must throw an error From 3b065c3c0467def35f5d38a688a1adf98d944183 Mon Sep 17 00:00:00 2001 From: Josua Schmid <josua.schmid@renuo.ch> Date: Tue, 26 Dec 2023 20:54:06 +0100 Subject: [PATCH 148/192] Reword REQ for multiple filters --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 0cf03ed8..eed20a5c 100644 --- a/01.md +++ b/01.md @@ -101,12 +101,12 @@ Relays expose a websocket endpoint to which clients can connect. Clients SHOULD Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns: * `["EVENT", <event JSON as defined above>]`, used to publish events. - * `["REQ", <subscription_id>, <filters JSON>, ...]`, used to request events and subscribe to new updates. + * `["REQ", <subscription_id>, <filters1>, <filters2>, ...]`, used to request events and subscribe to new updates. * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. `<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage `<subscription_id>`s independently for each WebSocket connection; even if `<subscription_id>`s are the same string, they should be treated as different subscriptions for different connections. -`<filters>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: +`<filtersX>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: ```json { From 8e5a275f991c8fe31aba9db0ea0dac2586d50ca3 Mon Sep 17 00:00:00 2001 From: Josua Schmid <josua.schmid@renuo.ch> Date: Tue, 26 Dec 2023 21:57:04 +0100 Subject: [PATCH 149/192] NIP-01 Tighten-up subscription_id management rule Rephrase to "MUST" so that one does not assume a connection could `CLOSE` any `subscription_id`, which it must not. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index eed20a5c..ec872c30 100644 --- a/01.md +++ b/01.md @@ -104,7 +104,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", <subscription_id>, <filters1>, <filters2>, ...]`, used to request events and subscribe to new updates. * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. -`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage `<subscription_id>`s independently for each WebSocket connection; even if `<subscription_id>`s are the same string, they should be treated as different subscriptions for different connections. +`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars. It represents a subscription per connection. Relays MUST manage `<subscription_id>`s independently for each WebSocket connection. `<subscription_id>`s are not guarantueed to be globally unique. `<filtersX>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From 0266d86b41d9b0684fa181700069d7553af505ef Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 27 Dec 2023 19:37:20 +0900 Subject: [PATCH 150/192] Simplify list of NIP-07 implementations --- 07.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/07.md b/07.md index 90772eef..12ae6478 100644 --- a/07.md +++ b/07.md @@ -24,16 +24,4 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext ### Implementation -- [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives) -- [nos2x](https://github.com/fiatjaf/nos2x) (Chrome and derivatives) -- [Alby](https://getalby.com) (Chrome and derivatives, Firefox) -- [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives) -- [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox) -- [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives) -- [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) -- [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) -- [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) -- [Spring Browser](https://spring.site) (Android) -- [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill) -- [Nostore](https://apps.apple.com/us/app/nostore/id1666553677) (Safari on iOS/MacOS) -- [OneKey](https://onekey.so/) (Android, IOS, Chrome and derivatives) +See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions. From 5e0cfb62ece24ea55346f5fdcdc62ddc824139fb Mon Sep 17 00:00:00 2001 From: Josua Schmid <josua.schmid@renuo.ch> Date: Wed, 27 Dec 2023 15:06:36 +0100 Subject: [PATCH 151/192] Rephrase deprecation of kind 2 (#943) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2467eb60..bf340a88 100644 --- a/README.md +++ b/README.md @@ -77,10 +77,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Event Kinds | kind | description | NIP | -| ------------- | -------------------------- | ----------- | +| ------------- | -------------------------- | ------------------------ | | `0` | Metadata | [01](01.md) | | `1` | Short Text Note | [01](01.md) | -| `2` | Recommend Relay | 01 (before 2023-08-13) | +| `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | | `4` | Encrypted Direct Messages | [04](04.md) | | `5` | Event Deletion | [09](09.md) | From 17c67ef5577c8ac5419a1081aadea57e30f8c133 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 26 Dec 2023 09:09:18 -0500 Subject: [PATCH 152/192] Removes the `aes-256-gcm` tag since no one seems to be using. People that wish to use encryption can now use the new NIP-44 scheme. --- 94.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/94.md b/94.md index 95b6a3bc..84a3d12f 100644 --- a/94.md +++ b/94.md @@ -6,7 +6,7 @@ File Metadata `draft` `optional` -The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with kind:1 notes or by longform clients that deal with kind:30023 articles. +The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with `kind:1` notes or by longform clients that deal with `kind:30023` articles. ## Event format @@ -14,7 +14,6 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. -* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the file. * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `<width>x<height>` @@ -31,7 +30,6 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr "kind": 1063, "tags": [ ["url",<string with URI of file>], - ["aes-256-gcm",<key>, <iv>], ["m", <MIME type>], ["x",<Hash SHA-256>], ["size", <size of file in bytes>], From 27fef638e2460139cc9078427a0aec0ce4470517 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez <p@f7z.io> Date: Mon, 1 Jan 2024 02:08:56 +0000 Subject: [PATCH 153/192] index zap senders with P tag (#954) --- 57.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/57.md b/57.md index 759e2033..6d896206 100644 --- a/57.md +++ b/57.md @@ -111,6 +111,7 @@ When a client sends a `zap request` event to a server's lnurl-pay callback URL, 5. There should be a `relays` tag with the relays to send the `zap receipt` to. 6. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. 7. If there is an `a` tag, it MUST be a valid event coordinate +8. There MUST be 0 or 1 `P` tags. If there is one, it MUST be equal to the `zap receipt`'s `pubkey`. The event MUST then be stored for use later, when the invoice is paid. @@ -128,7 +129,7 @@ The following should be true of the `zap receipt` event: - The `content` SHOULD be empty. - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. -- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request`. +- `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. - `SHA256(description)` MUST match the description hash in the bolt11 invoice. @@ -148,13 +149,13 @@ Example `zap receipt`: "kind": 9735, "tags": [ ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], + ["P", "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322"], ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"], ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"], - ["description", "{\"pubkey\":\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], + ["description", "{\"pubkey\":\"97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"] ], "content": "", - "sig": "b0a3c5c984ceb777ac455b2f659505df51585d5fd97a0ec1fdb5f3347d392080d4b420240434a3afd909207195dac1e2f7e3df26ba862a45afd8bfe101c2b1cc" } ``` From 3d8652ea147facb07adb51031e6b21f7e663dc10 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Mon, 1 Jan 2024 12:21:50 -0600 Subject: [PATCH 154/192] NIP-02, NIP-51: new tags should be added to the end of the list Fixes https://github.com/nostr-protocol/nips/issues/958 --- 02.md | 2 ++ 51.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/02.md b/02.md index 8c47a5f7..8b0aee15 100644 --- a/02.md +++ b/02.md @@ -27,6 +27,8 @@ For example: Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one. +Whenever new follows are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order. + ## Uses ### Follow list backup diff --git a/51.md b/51.md index f5a9a749..507c515a 100644 --- a/51.md +++ b/51.md @@ -10,6 +10,8 @@ This NIP defines lists of things that users can create. Lists can contain refere Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. +When new items are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order. + ## Types of lists ## Standard lists From 402c330ce9d7d0d4aadb6e73acbc8c9375e04594 Mon Sep 17 00:00:00 2001 From: GoodDaisy <90915921+GoodDaisy@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:59:49 +0800 Subject: [PATCH 155/192] Fix typo in 01.md --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index ecac6f6c..80ee7924 100644 --- a/01.md +++ b/01.md @@ -116,7 +116,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", <subscription_id>, <filters1>, <filters2>, ...]`, used to request events and subscribe to new updates. * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. -`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars. It represents a subscription per connection. Relays MUST manage `<subscription_id>`s independently for each WebSocket connection. `<subscription_id>`s are not guarantueed to be globally unique. +`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars. It represents a subscription per connection. Relays MUST manage `<subscription_id>`s independently for each WebSocket connection. `<subscription_id>`s are not guaranteed to be globally unique. `<filtersX>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From 8bfcbebae4d423cbf7b1b0c24ff4d1ad3964dca1 Mon Sep 17 00:00:00 2001 From: GoodDaisy <90915921+GoodDaisy@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:59:58 +0800 Subject: [PATCH 156/192] Fix typo in 50.md --- 50.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/50.md b/50.md index 2bdf1ff1..9d1a54c3 100644 --- a/50.md +++ b/50.md @@ -41,7 +41,7 @@ implementation details between relays. Clients MAY verify that events returned by a relay match the specified query in a way that suits the client's use case, and MAY stop querying relays that have low precision. -Relays SHOULD exclude spam from search results by default if they supports some form of spam filtering. +Relays SHOULD exclude spam from search results by default if they support some form of spam filtering. ## Extensions From 2409f821a43fb42e40fdf0f348da6bb6855c2211 Mon Sep 17 00:00:00 2001 From: shuoer86 <129674997+shuoer86@users.noreply.github.com> Date: Sat, 6 Jan 2024 09:47:07 +0800 Subject: [PATCH 157/192] fix typo 44.md --- 44.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/44.md b/44.md index 0efa4825..f3071ea9 100644 --- a/44.md +++ b/44.md @@ -161,7 +161,7 @@ validation rules, refer to BIP-340. ### Implementation pseudocode The following is a collection of python-like pseudocode functions which implement the above primitives, -intended to guide impelmenters. A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. +intended to guide implementers. A collection of implementations in different languages is available at https://github.com/paulmillr/nip44. ```py # Calculates length of the padded byte array. @@ -286,7 +286,7 @@ Example of a test vector from the file: The file also contains intermediate values. A quick guidance with regards to its usage: - `valid.get_conversation_key`: calculate conversation_key from secret key sec1 and public key pub2 -- `valid.get_message_keys`: calculate chacha_key, chacha_nocne, hmac_key from conversation_key and nonce +- `valid.get_message_keys`: calculate chacha_key, chacha_nonce, hmac_key from conversation_key and nonce - `valid.calc_padded_len`: take unpadded length (first value), calculate padded length (second value) - `valid.encrypt_decrypt`: emulate real conversation. Calculate pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext. - `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, their checksum is provided. From 74a586d6ae04594987f1c950cfdbd5ca0e83542b Mon Sep 17 00:00:00 2001 From: shuoer86 <129674997+shuoer86@users.noreply.github.com> Date: Sat, 6 Jan 2024 09:47:17 +0800 Subject: [PATCH 158/192] fix typo 53.md --- 53.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/53.md b/53.md index e17f9656..fad2622f 100644 --- a/53.md +++ b/53.md @@ -94,7 +94,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or ["title", "Adult Swim Metalocalypse"], ["summary", "Live stream from IPTV-ORG collection"], ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], - ["starts", "1687182672"] + ["starts", "1687182672"], ["status", "live"], ["t", "animation"], ["t", "iptv"], From 13c9202ba39e351a08d034db6cd9194d7c989949 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Sun, 7 Jan 2024 15:32:03 +0000 Subject: [PATCH 159/192] Update 51.md to add support for video lists --- 51.md | 1 + 1 file changed, 1 insertion(+) diff --git a/51.md b/51.md index f5a9a749..a5ecd324 100644 --- a/51.md +++ b/51.md @@ -44,6 +44,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos), `"e"` (kind:1 notes) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | From ad40fbdab3c01be0fe553d8da41ff60863b9c4f0 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Sun, 7 Jan 2024 20:00:04 +0000 Subject: [PATCH 160/192] remove kind 1 option --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index a5ecd324..38e772d4 100644 --- a/51.md +++ b/51.md @@ -44,7 +44,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos), `"e"` (kind:1 notes) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | From cfc8dfce8936867826bbf2cb79c3a8c8b21789fe Mon Sep 17 00:00:00 2001 From: vuittont60 <81072379+vuittont60@users.noreply.github.com> Date: Mon, 8 Jan 2024 13:50:52 +0800 Subject: [PATCH 161/192] nip-46: fix typo --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index 1f8e6c8d..05247c59 100644 --- a/46.md +++ b/46.md @@ -34,7 +34,7 @@ The signer scans the QR code and sends a `connect` message to the client in the ## Event payloads -Event payloads are [NIP-04](04.md)-encrypted JSON blobs that look like JSONRPC messages (their format is specified inside the `.content` of the event formats nelow). +Event payloads are [NIP-04](04.md)-encrypted JSON blobs that look like JSONRPC messages (their format is specified inside the `.content` of the event formats below). Events sent by the client to the remote signer have the following format: From 0cd480dd84a3cd5fd693edba8abdf4a424ddd033 Mon Sep 17 00:00:00 2001 From: vuittont60 <81072379+vuittont60@users.noreply.github.com> Date: Mon, 8 Jan 2024 13:51:27 +0800 Subject: [PATCH 162/192] nip-58: fix typo --- 58.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/58.md b/58.md index e2a9f204..0ecef257 100644 --- a/58.md +++ b/58.md @@ -28,7 +28,7 @@ The following tags MAY be present: - A `name` tag with a short name for the badge. - `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels. - A `description` tag whose value MAY contain a textual representation of the -image, the meaning behind the badge, or the reason of it's issuance. +image, the meaning behind the badge, or the reason of its issuance. - One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels. ### Badge Award event From b0e6c01321633f5e0de6ebf6676f018a218459a9 Mon Sep 17 00:00:00 2001 From: arthurfranca <arthur.a.franca@gmail.com> Date: Mon, 8 Jan 2024 14:05:01 -0300 Subject: [PATCH 163/192] NIP-96 - HTTP File Storage Integration (#547) * Add NIP-95 - File Storage * Add missing response info * Make it clear that is is an HTTP file storage server integration * Add monetization suggestion * Use zap split tags for monetization suggestion * Add resize option * Add Zap Gates Integration * Replace /nip96 convention with /.well-known/nostr.json configuration * Relays can choose to also act as HTTP file storage server * Remove nip96 tag in favor of x tags third element * Fix typo * Remove redirect cooperation * Replaced 422 with 400 status code * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Update 96.md Co-authored-by: Jon Staab <jstaab@protonmail.com> * Make file expiration a range and add terms_of_service * Add optional content_type field * Add plans and tos * Remove monetization * Apply minor fixes * Update 96.md Co-authored-by: Semisol <45574030+Semisol@users.noreply.github.com> * Fix after review * Add kind 10096 * Apply suggestions * Add suggestions * Remove duplicate field * Add optional is_nip98_required plan config * Add suggestions * Replace x with ox tag for original file hash * Make minor changes * Remove nip96 namespace response field * Add note about alternative file processing flow * Simplify processing flow * Add nostrcheck to server list * Add audio/* example * Explain what metadata to show before processing is done * Add nostrage to list * Add eta * Add sove to list and replace eta with percentage * Fix status code * Add nostr.build to list * Add sovbit * Add optional extra http servers to ox tag * Add void.cat to list * Small fix * Remove ox third array element --------- Co-authored-by: Jon Staab <jstaab@protonmail.com> Co-authored-by: Semisol <45574030+Semisol@users.noreply.github.com> --- 94.md | 2 + 96.md | 302 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 3 files changed, 305 insertions(+) create mode 100644 96.md diff --git a/94.md b/94.md index 84a3d12f..eb8117a4 100644 --- a/94.md +++ b/94.md @@ -15,6 +15,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used,Β and they should be lowercase. * `x` containing the SHA-256 hexencoded string of the file. +* `ox` containing the SHA-256 hexencoded string of the original file, before any transformations done by the upload server * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `<width>x<height>` * `magnet` (optional) URI to magnet file @@ -32,6 +33,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["url",<string with URI of file>], ["m", <MIME type>], ["x",<Hash SHA-256>], + ["ox",<Hash SHA-256>], ["size", <size of file in bytes>], ["dim", <size of file in pixels>], ["magnet",<magnet URI> ], diff --git a/96.md b/96.md new file mode 100644 index 00000000..2641b2ab --- /dev/null +++ b/96.md @@ -0,0 +1,302 @@ +NIP-96 +====== + +HTTP File Storage Integration +----------------------------- + +`draft` `optional` `author:arthurfranca` `author:Semisol` `author:staab` `author:v0l` `author:bndw` `author:michaelhall923` `author:fishcakeday` `author:quentintaranpino` + +## Introduction + +This NIP defines a REST API for HTTP file storage servers intended to be used in conjunction with the nostr network. +The API will enable nostr users to upload files and later reference them by url on nostr notes. + +The spec DOES NOT use regular nostr events through websockets for +storing, requesting nor retrieving data because, for simplicity, the server +will not have to learn anything about nostr relays. + +## Server Adaptation + +File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`: + +```js +{ + // Required + // File upload and deletion are served from this url + // Also downloads if "download_url" field is absent or empty string + "api_url": "https://your-file-server.example/custom-api-path", + // Optional + // If absent, downloads are served from the api_url + "download_url": "https://a-cdn.example/a-path", + // Optional + // Note: This field is not meant to be set by HTTP Servers. + // Use this if you are a nostr relay using your /.well-known/nostr/nip96.json + // just to redirect to someone else's http file storage server's /.well-known/nostr/nip96.json + // In this case, "api_url" field must be an empty string + "delegated_to_url": "https://your-file-server.example", + // Optional + "supported_nips": [60], + // Optional + "tos_url": "https://your-file-server.example/terms-of-service", + // Optional + "content_types": ["image/jpeg", "video/webm", "audio/*"], + // Optional + "plans": { + // "free" is the only standardized plan key and + // clients may use its presence to learn if server offers free storage + "free": { + "name": "Free Tier", + // Default is true + // All plans MUST support NIP-98 uploads + // but some plans may also allow uploads without it + "is_nip98_required": true, + "url": "https://...", // plan's landing page if there is one + "max_byte_size": 10485760, + // Range in days / 0 for no expiration + // [7, 0] means it may vary from 7 days to unlimited persistence, + // [0, 0] means it has no expiration + // early expiration may be due to low traffic or any other factor + "file_expiration": [14, 90], + "media_transformations": { + "image": [ + 'resizing' + ] + } + } + } +} +``` + +### Relay Hints + +Note: This section is not meant to be used by HTTP Servers. + +A nostr relay MAY redirect to someone else's HTTP file storage server by +adding a `/.well-known/nostr/nip96.json` with "delegated_to_url" field +pointing to the url where the server hosts its own +`/.well-known/nostr/nip96.json`. In this case, the "api_url" field must +be an empty string and all other fields must be absent. + +If the nostr relay is also an HTTP file storage server, +it must use the "api_url" field instead. + +### List of Supporting File Storage Servers + +| Name | Domain | +| ------------- | ------------------------- | +| nostrcheck.me | https://nostrcheck.me | +| nostrage | https://nostrage.com | +| sove | https://sove.rent | +| nostr.build | https://nostr.build | +| sovbit | https://files.sovbit.host | +| void.cat | https://void.cat | + +## 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. + +`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. + +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. + + +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 `server` MUST reject with 413 Payload Too Large if file size exceeds limits. + +The `server` MUST reject with 400 Bad Request status if some fields are invalid. + +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. + +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). + +The upload response is a json object as follows: + +```js +{ + // "success" if successful or "error" if not + status: "success", + // Free text success, failure or info message + message: "Upload successful.", + // Optional. See "Delayed Processing" section + processing_url: "...", + // This uses the NIP-94 event format but DO NOT need + // to fill some fields like "id", "pubkey", "created_at" and "sig" + // + // This holds the download url ("url"), + // the ORIGINAL file hash before server transformations ("ox") + // and, optionally, all file metadata the server wants to make available + // + // nip94_event field is absent if unsuccessful upload + nip94_event: { + // Required tags: "url" and "ox" + tags: [ + // Can be same from /.well-known/nostr/nip96.json's "download_url" field + // (or "api_url" field if "download_url" is absent or empty) with appended + // original file hash. + // + // Note we appended .png file extension to the `ox` value + // (it is optional but extremely recommended to add the extension as it will help nostr clients + // with detecting the file type by using regular expression) + // + // Could also be any url to download the file + // (using or not using the /.well-known/nostr/nip96.json's "download_url" prefix), + // for load balancing purposes for example. + ["url", "https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png"], + // SHA-256 hash of the ORIGINAL file, before transformations. + // The server MUST store it even though it represents the ORIGINAL file because + // users may try to download/delete the transformed file using this value + ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + // Optional. SHA-256 hash of the saved file after any server transformations. + // The server can but does not need to store this value. + ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"], + // Optional. Recommended for helping clients to easily know file type before downloading it. + ["m", "image/png"] + // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it. + ["dim", "800x600"] + // ... other optional NIP-94 tags + ], + content: "" + }, + // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags) +} +``` + +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`. +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 with added "ox" [NIP-54](54.md) inline metadata field and optionally other ones. + +### Delayed Processing + +Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing. + +In that case, the server MUST serve the original file while the processing isn't done, then swap the original file for the processed one when the processing is over. The upload response is the same as usual but some optional metadata like `nip94_event.tags.*.x` and `nip94_event.tags.*.size` won't be available. + +The expected resulting metadata that is known in advance should be returned on the response. +For example, if the file processing would change a file from "jpg" to "webp", +use ".webp" extension on the `nip94_event.tags.*.url` field value and set "image/webp" to the `nip94_event.tags.*.m` field. +If some metadata are unknown before processing ends, omit them from the response. + +The upload response MAY include a `processing_url` field informing a temporary url that may be used by clients to check if +the file processing is done. + +If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON: + +``` +{ + // It should be "processing". If "error" it would mean the processing failed. + status: "processing", + message: "Processing. Please check again later for updated status.", + percentage: 15 // Processing percentage. An integer between 0 and 100. +} +``` + +When the processing is over, the server replies at the `processing_url` url with **201 Created** status and a regular successful JSON response already mentioned before (now **without** a `processing_url` field), possibly including optional metadata at `nip94_event.tags.*` fields +that weren't available before processing. + +### File compression + +File compression and other transformations like metadata stripping can be applied by the server. +However, for all file actions, such as download and deletion, the **original** file SHA-256 hash is what identifies the file in the url string. + +## 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. + +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). +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. + +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` + +### Media Transformations + +`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 + +##### 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 +or an image variant generated on the fly. + +Example: `https://your-file-server.example/custom-api-path/<sha256-file-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. + +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. + +The extension is optional as the file hash is the only needed file identification. + +`Clients` should send a `DELETE` request to the server deletion route in the above format. It must include a NIP-98 `Authorization` header. + +The `server` should reject deletes from users other than the original uploader. The `pubkey` encoded on the header value identifies the user. + +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). + +The successfull response is a 200 OK one with just basic JSON fields: + +``` +{ + status: "success", + message: "File deleted." +} +``` + +## Selecting a Server + +Note: HTTP File Storage Server developers may skip this section. This is meant for client developers. + +A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants +to upload files to. Servers are listed as `server` tags: + +```js +{ + // ... + "kind": 10096, + "content": "", + "tags": [ + ["server", "https://file.server.one"], + ["server", "https://file.server.two"] + ] +} +``` diff --git a/README.md b/README.md index bf340a88..678818d5 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-94: File Metadata](94.md) +- [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) From 4d32f3a1dbdf056172023df71d18dacd8e804e4b Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 9 Jan 2024 12:35:41 +0900 Subject: [PATCH 164/192] Remove authors --- 96.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/96.md b/96.md index 2641b2ab..661bd45e 100644 --- a/96.md +++ b/96.md @@ -4,7 +4,7 @@ NIP-96 HTTP File Storage Integration ----------------------------- -`draft` `optional` `author:arthurfranca` `author:Semisol` `author:staab` `author:v0l` `author:bndw` `author:michaelhall923` `author:fishcakeday` `author:quentintaranpino` +`draft` `optional` ## Introduction From 56610771b6b0c61b2269fc16f163a004b585f726 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= <i@ibz.me> Date: Tue, 9 Jan 2024 13:35:40 +0200 Subject: [PATCH 165/192] Add auctions to NIP-15. (#859) * Add auctions to NIP-15. * Update 15.md Co-authored-by: Vlad Stan <stan.v.vlad@gmail.com> * Address comments from @motorina0. * Remove reference to removed type=10. --------- Co-authored-by: Vlad Stan <stan.v.vlad@gmail.com> --- 15.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/15.md b/15.md index 1c3154a3..e2ba639c 100644 --- a/15.md +++ b/15.md @@ -149,7 +149,6 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff | 1 | Merchant | Payment Request | | 2 | Merchant | Order Status Update | - ### Step 1: `customer` order (event) The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). @@ -229,7 +228,9 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni "shipped": <bool: has been shipped>, } ``` + ## Customize Marketplace + Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. ### Event `30019`: Create or update marketplace UI/UX @@ -253,6 +254,81 @@ Create a customized user experience using the `naddr` from [NIP-19](https://gith This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment. +## Auctions + +### Event `30020`: Create or update a product sold as an auction + +**Event Content**: +```json +{ + "id": <String, UUID generated by the merchant. Sequential IDs (`0`, `1`, `2`...) are discouraged>, + "stall_id": <String, UUID of the stall to which this product belong to>, + "name": <String, product name>, + "description": <String (optional), product description>, + "images": <[String], array of image URLs, optional>, + "starting_bid": <int>, + "start_date": <int (optional) UNIX timestamp, date the auction started / will start>, + "duration": <int, number of seconds the auction will run for, excluding eventual time extensions that might happen>, + "specs": [ + [<String, spec key>, <String, spec value>] + ], + "shipping": [ + { + "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>, + "cost": <float, extra cost for shipping. The currency is defined at the stall level>, + } + ] +} +``` + +> [!NOTE] +> Items sold as an auction are very similar in structure to fixed-price items, with some important differences worth noting. + +* The `start_date` can be set to a date in the future if the auction is scheduled to start on that date, or can be omitted if the start date is unknown/hidden. If the start date is not specified, the auction will have to be edited later to set an actual date. + +* The auction runs for an initial number of seconds after the `start_date`, specified by `duration`. + +### Event `1021`: Bid + +```json +{ + "content": <int, amount of sats>, + "tags": [["e", <event ID of the auction to bid on>]], +} +``` + +Bids are simply events of kind `1021` with a `content` field specifying the amount, in the currency of the auction. Bids must reference an auction. + +> [!NOTE] +> Auctions can be edited as many times as desired (they are "parameterized replaceable events") by the author - even after the start_date, but they cannot be edited after they have received the first bid! This is enforced by the fact that bids reference the event ID of the auction (rather than the product UUID), which changes with every new version of the auctioned product. So a bid is always attached to one "version". Editing the auction after a bid would result in the new product losing the bid! + +### Event `1022`: Bid confirmation + +**Event Content**: + +```json +{ + "status": <String, "accepted" | "rejected" | "pending" | "winner">, + "message": <String (optional)>, + "duration_extended": <int (optional), number of seconds>, +} +``` + +**Event Tags**: +```json + "tags": [["e" <event ID of the bid being confirmed>], ["e", <event ID of the auction>]], +``` + +Bids should be confirmed by the merchant before being considered as valid by other clients. So clients should subscribe to *bid confirmation* events (kind `1022`) for every auction that they follow, in addition to the actual bids and should check that the pubkey of the bid confirmation matches the pubkey of the merchant (in addition to checking the signature). + +The `content` field is a JSON which includes *at least* a `status`. `winner` is how the *winning bid* is replied to after the auction ends and the winning bid is picked by the merchant. + +The reasons for which a bid can be marked as `rejected` or `pending` are up to the merchant's implementation and configuration - they could be anything from basic validation errors (amount too low) to the bidder being blacklisted or to the bidder lacking sufficient *trust*, which could lead to the bid being marked as `pending` until sufficient verification is performed. The difference between the two is that `pending` bids *might* get approved after additional steps are taken by the bidder, whereas `rejected` bids can not be later approved. + +An additional `message` field can appear in the `content` JSON to give further context as of why a bid is `rejected` or `pending`. + +Another thing that can happen is - if bids happen very close to the end date of the auction - for the merchant to decide to extend the auction duration for a few more minutes. This is done by passing a `duration_extended` field as part of a bid confirmation, which would contain a number of seconds by which the initial duration is extended. So the actual end date of an auction is always `start_date + duration + (SUM(c.duration_extended) FOR c in all confirmations`. + ## 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. From 8331354947f2d577e13eb5da4a56133071cb1019 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 10 Jan 2024 10:43:30 -0300 Subject: [PATCH 166/192] remove NIP-52 label cruft. --- 52.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/52.md b/52.md index 4ec68369..5ac116b9 100644 --- a/52.md +++ b/52.md @@ -187,10 +187,8 @@ The `.content` of these events is optional and should be a free-form note that a The list of tags are as follows: * `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. -* `L` (required) label namespace of `status` per [NIP-32](32.md) -* `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. -* `L` (optional) label namespace of `freebusy` per [NIP-32](32.md). Exists if and only if corresponding `l` tag under the same label namespace exists. -* `l` (optional) label of `free` or `busy` under the label namespace of `freebusy` per [NIP-32](32.md). Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. Exists if and only if corresponding `l` tag under the same label namespace exists. +* `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`. ```json { @@ -202,10 +200,8 @@ The list of tags are as follows: "tags": [ ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], ["d", "<UUID>"], - ["L", "status"], - ["l", "<accepted/declined/tentative>", "status"], - ["L", "freebusy"], - ["l", "<free/busy>", "freebusy"] + ["status", "<accepted/declined/tentative>"], + ["fb", "<free/busy>"], ] } ``` From 4b4e9fabfd66a3200222b3b2e71946c2640e701f Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 13 Jan 2024 01:23:01 +0900 Subject: [PATCH 167/192] Add kind and tag for NIP-96 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 678818d5..cf3827e8 100644 --- a/README.md +++ b/README.md @@ -118,6 +118,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10007` | Search relays list | [51](51.md) | | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.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) | @@ -220,6 +221,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | +| `server` | file storage server url | -- | [96](96.md) | | `subject` | subject | -- | [14](14.md) | | `summary` | article summary | -- | [23](23.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | From 20d33785fc2e2884f28bece04e4fab679b621ec8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 13 Jan 2024 03:46:59 +0900 Subject: [PATCH 168/192] Remove NIP-54 mention temporarily (#981) * Remove NIP-54 mention temporarily * Update 96.md Co-authored-by: arthurfranca <arthur.a.franca@gmail.com> --------- Co-authored-by: arthurfranca <arthur.a.franca@gmail.com> --- 96.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/96.md b/96.md index 661bd45e..d8ea105e 100644 --- a/96.md +++ b/96.md @@ -189,7 +189,7 @@ Note that if the server didn't apply any transformation to the received file, bo `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 with added "ox" [NIP-54](54.md) inline metadata field and optionally other ones. +Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url. ### Delayed Processing From d8d75d9b19e6c66f7d75c771e784cd9dee4d2320 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 16 Jan 2024 23:28:23 +0900 Subject: [PATCH 169/192] Fix some minor nitpicks in NIP-15 and NIP-51 --- 15.md | 20 ++++++++++---------- 51.md | 14 +++++++------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/15.md b/15.md index e2ba639c..55814fb5 100644 --- a/15.md +++ b/15.md @@ -56,7 +56,7 @@ A merchant can publish these events: "id": <string, id of the shipping zone, generated by the merchant>, "name": <string (optional), zone name>, "cost": <float, base cost for shipping. The currency is defined at the stall level>, - "regions": [<string, regions included in this zone>], + "regions": [<string, regions included in this zone>] } ] } @@ -101,7 +101,7 @@ Fields that are not self-explanatory: "shipping": [ { "id": <string, id of the shipping zone (must match one of the zones defined for the stall)>, - "cost": <float, extra cost for shipping. The currency is defined at the stall level>, + "cost": <float, extra cost for shipping. The currency is defined at the stall level> } ] } @@ -139,7 +139,7 @@ Fields that are not self-explanatory: ## Checkout events -All checkout events are sent as JSON strings using ([NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md)). +All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/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,19 +150,19 @@ 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 [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). ```json { "id": <string, id generated by the customer>, "type": 0, "name": <string (optional), ???>, - "address": <string (optional), for physical goods an address should be provided> + "address": <string (optional), for physical goods an address should be provided>, "message": "<string (optional), message for merchant>, "contact": { "nostr": <32-bytes hex of a pubkey>, "phone": <string (optional), if the customer wants to be contacted by phone>, - "email": <string (optional), if the customer wants to be contacted by email>, + "email": <string (optional), if the customer wants to be contacted by email> }, "items": [ { @@ -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 [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). `payment_options`/`type` include: @@ -217,7 +217,7 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni Once payment has been received and processed. -The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). ```json { @@ -275,7 +275,7 @@ This event leverages naddr to enable comprehensive customization and sharing of "shipping": [ { "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>, - "cost": <float, extra cost for shipping. The currency is defined at the stall level>, + "cost": <float, extra cost for shipping. The currency is defined at the stall level> } ] } @@ -310,7 +310,7 @@ Bids are simply events of kind `1021` with a `content` field specifying the amou { "status": <String, "accepted" | "rejected" | "pending" | "winner">, "message": <String (optional)>, - "duration_extended": <int (optional), number of seconds>, + "duration_extended": <int (optional), number of seconds> } ``` diff --git a/51.md b/51.md index 47ed8991..9a1639f8 100644 --- a/51.md +++ b/51.md @@ -18,18 +18,18 @@ When new items are added to an existing list, clients SHOULD append them to the Standard lists use non-parameterized replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience. -For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. +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)` | +| 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) | +| 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) | -| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a" (kind:30015 interest set)` | +| 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) | ## Sets @@ -44,9 +44,9 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | --- | --- | --- | --- | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | -| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | +| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | @@ -82,7 +82,7 @@ Some clients have used these lists in the past, but they should work on transiti ### A _curation set_ of articles and notes about yaks -``` +```json { "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", From d7293a3924143b222ffbda0dba11a373136e1269 Mon Sep 17 00:00:00 2001 From: Jonathan Staab <shtaab@gmail.com> Date: Fri, 11 Aug 2023 08:34:56 -0700 Subject: [PATCH 170/192] Introduce NIP-59 gift wrap --- 59.md | 250 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 250 insertions(+) create mode 100644 59.md diff --git a/59.md b/59.md new file mode 100644 index 00000000..cd841cff --- /dev/null +++ b/59.md @@ -0,0 +1,250 @@ +NIP-59 +====== + +Gift Wrap +--------- + +`optional` + +This NIP defines a protocol for encapsulating any nostr event. This makes it possible to obscure most metadata +for a given event, perform collaborative signing, and more. + +This NIP relies on [NIP-44](./44.md)'s versioned encryption algorithms. + +# Overview + +This protocol uses three main concepts to protect the transmission of a target event: `rumor`s, `seal`s, and `gift wrap`s. + +- A `rumor` is a regular nostr event, but is **not signed**. This means that if it is leaked, it cannot be verified. +- A `rumor` is serialized to JSON, encrypted, and placed in the `content` field of a `seal`. The `seal` is then + signed by the author of the note. The only information publicly available on a `seal` is who signed it, but not what was said. +- A `seal` is serialized to JSON, encrypted, and placed in the `content` field of a `gift wrap`. + +This allows the isolation of concerns across layers: + +- A rumor carries the content but is unsigned, which means if leaked it will be rejected by relays and clients, + and can't be authenticated. This provides a measure of deniability. +- A seal identifies the author without revealing the content or the recipient. +- A gift wrap can add metadata (recipient, tags, a different author) without revealing the true author. + +# Protocol Description + +## 1. The Rumor Event Kind + +A `rumor` is the same thing as an unsigned event. Any event kind can be made a `rumor` by removing the signature. + +## 2. The Seal Event Kind + +A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key. The `seal` is **always** encrypted +to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for +without the receiver's or the sender's private key. The only public information in this event is who is signing it. + +```js +{ + "id": "<id>", + "pubkey": "<real author's pubkey>", + "content": "<encrypted rumor>", + "kind": 13, + "created_at": 1686840217, + "tags": [], + "sig": "<real author's pubkey signature>" +} +``` + +Tags MUST must always be empty in a `kind:13`. The inner event MUST always be unsigned. + +## 3. Gift Wrap Event Kind + +A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` MUST include a single `p` tag +containing the recipient's public key. + +The goal is to hide the sender's information, the metadata, and the content of the original event from the public. +The only public information is the receiver's public key. + +```js +{ + "id": "<id>", + "pubkey": "<random, one-time-use pubkey>", + "content": "<encrypted kind 13>", + "kind": 1059, + "created_at": 1686840217, + "tags": [["p", "<Receiver>"]], + "sig": "<random, one-time-use pubkey signature>" +} +``` + +# Encrypting Payloads + +Encryption is done following NIP-44 on the JSON-encoded event. Place the the encryption payload in the `.content` +of the wrapper event (either a `seal` or a `gift wrap`). + +# Other Considerations + +If a `rumor` is intended for more than one party, or if the author wants to retain an encrypted copy, a single +`rumor` may be wrapped and addressed for each recipient individually. + +The canonical `created_at` time belongs to the `rumor`. All other timestamps SHOULD be tweaked to thwart +time-analysis attacks. Note that some relays don't serve events dated in the future, so all timestamps +SHOULD be in the past. + +Relays may choose not to store gift wrapped events due to them not being publicly useful. Clients MAY choose +to attach a certain amount of proof-of-work to the wrapper event per NIP-13 in a bid to demonstrate that +the event is not spam or a denial-of-service attack. + +To protect recipient metadata, relays SHOULD guard access to kind 1059 events based on user AUTH. When +possible, clients should only send wrapped events to relays that offer this protection. + +To protect recipient metadata, relays SHOULD only serve kind 1059 events intended for the marked recipient. +When possible, clients should only send wrapped events to `read` relays for the recipient that implement +AUTH, and refuse to serve wrapped events to non-recipients. + +# An Example + +Let's send a wrapped `kind 1` message between two parties asking "Are you going to the party tonight?" + +- Author private key: `0beebd062ec8735f4243466049d7747ef5d6594ee838de147f8aab842b15e273` +- Recipient private key: `e108399bd8424357a710b606ae0c13166d853d327e47a6e5e038197346bdbf45` +- Ephemeral wrapper key: `4f02eac59266002db5801adc5270700ca69d5b8f761d8732fab2fbf233c90cbd` + +## 1. Create an event + +Create a `kind 1` event with the message, the receivers, and any other tags you want, signed by the author. +Do not sign the event. + +```json +{ + "created_at": 1691518405, + "content": "Are you going to the party tonight?", + "tags": [], + "kind": 1, + "pubkey": "611df01bfcf85c26ae65453b772d8f1dfd25c264621c0277e1fc1518686faef9", + "id": "9dd003c6d3b73b74a85a9ab099469ce251653a7af76f523671ab828acd2a0ef9" +} +``` + +## 2. Seal the rumor + +Encrypt the JSON-encoded `rumor` with a conversation key derived using the author's private key and +the recipient's public key. Place the result in the `content` field of a `kind 13` `seal` event. Sign +it with the author's key. + +```json +{ + "content": "AqBCdwoS7/tPK+QGkPCadJTn8FxGkd24iApo3BR9/M0uw6n4RFAFSPAKKMgkzVMoRyR3ZS/aqATDFvoZJOkE9cPG/TAzmyZvr/WUIS8kLmuI1dCA+itFF6+ULZqbkWS0YcVU0j6UDvMBvVlGTzHz+UHzWYJLUq2LnlynJtFap5k8560+tBGtxi9Gx2NIycKgbOUv0gEqhfVzAwvg1IhTltfSwOeZXvDvd40rozONRxwq8hjKy+4DbfrO0iRtlT7G/eVEO9aJJnqagomFSkqCscttf/o6VeT2+A9JhcSxLmjcKFG3FEK3Try/WkarJa1jM3lMRQqVOZrzHAaLFW/5sXano6DqqC5ERD6CcVVsrny0tYN4iHHB8BHJ9zvjff0NjLGG/v5Wsy31+BwZA8cUlfAZ0f5EYRo9/vKSd8TV0wRb9DQ=", + "kind": 13, + "created_at": 1703015180, + "pubkey": "611df01bfcf85c26ae65453b772d8f1dfd25c264621c0277e1fc1518686faef9", + "tags": [], + "id": "28a87d7c074d94a58e9e89bb3e9e4e813e2189f285d797b1c56069d36f59eaa7", + "sig": "02fc3facf6621196c32912b1ef53bac8f8bfe9db51c0e7102c073103586b0d29c3f39bdaa1e62856c20e90b6c7cc5dc34ca8bb6a528872cf6e65e6284519ad73" +} +``` + +## 3. Wrap the seal + +Encrypt the JSON-encoded `kind 13` event with your ephemeral, single-use random key. Place the result +in the `content` field of a `kind 1059`. Add a single `p` tag containing the recipient's public key. +Sign the `gift wrap` using the random key generated in the previous step. + +```json +{ + "content": "AhC3Qj/QsKJFWuf6xroiYip+2yK95qPwJjVvFujhzSguJWb/6TlPpBW0CGFwfufCs2Zyb0JeuLmZhNlnqecAAalC4ZCugB+I9ViA5pxLyFfQjs1lcE6KdX3euCHBLAnE9GL/+IzdV9vZnfJH6atVjvBkNPNzxU+OLCHO/DAPmzmMVx0SR63frRTCz6Cuth40D+VzluKu1/Fg2Q1LSst65DE7o2efTtZ4Z9j15rQAOZfE9jwMCQZt27rBBK3yVwqVEriFpg2mHXc1DDwHhDADO8eiyOTWF1ghDds/DxhMcjkIi/o+FS3gG1dG7gJHu3KkGK5UXpmgyFKt+421m5o++RMD/BylS3iazS1S93IzTLeGfMCk+7IKxuSCO06k1+DaasJJe8RE4/rmismUvwrHu/HDutZWkvOAhd4z4khZo7bJLtiCzZCZ74lZcjOB4CYtuAX2ZGpc4I1iOKkvwTuQy9BWYpkzGg3ZoSWRD6ty7U+KN+fTTmIS4CelhBTT15QVqD02JxfLF7nA6sg3UlYgtiGw61oH68lSbx16P3vwSeQQpEB5JbhofW7t9TLZIbIW/ODnI4hpwj8didtk7IMBI3Ra3uUP7ya6vptkd9TwQkd/7cOFaSJmU+BIsLpOXbirJACMn+URoDXhuEtiO6xirNtrPN8jYqpwvMUm5lMMVzGT3kMMVNBqgbj8Ln8VmqouK0DR+gRyNb8fHT0BFPwsHxDskFk5yhe5c/2VUUoKCGe0kfCcX/EsHbJLUUtlHXmTqaOJpmQnW1tZ/siPwKRl6oEsIJWTUYxPQmrM2fUpYZCuAo/29lTLHiHMlTbarFOd6J/ybIbICy2gRRH/LFSryty3Cnf6aae+A9uizFBUdCwTwffc3vCBae802+R92OL78bbqHKPbSZOXNC+6ybqziezwG+OPWHx1Qk39RYaF0aFsM4uZWrFic97WwVrH5i+/Nsf/OtwWiuH0gV/SqvN1hnkxCTF/+XNn/laWKmS3e7wFzBsG8+qwqwmO9aVbDVMhOmeUXRMkxcj4QreQkHxLkCx97euZpC7xhvYnCHarHTDeD6nVK+xzbPNtzeGzNpYoiMqxZ9bBJwMaHnEoI944Vxoodf51cMIIwpTmmRvAzI1QgrfnOLOUS7uUjQ/IZ1Qa3lY08Nqm9MAGxZ2Ou6R0/Z5z30ha/Q71q6meAs3uHQcpSuRaQeV29IASmye2A2Nif+lmbhV7w8hjFYoaLCRsdchiVyNjOEM4VmxUhX4VEvw6KoCAZ/XvO2eBF/SyNU3Of4SO", + "kind": 1059, + "created_at": 1703021488, + "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c", + "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac", + "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259" + "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]], +} +``` + +## 4. Broadcast Selectively + +Broadcast the `kind 1059` event to the recipient's relays only. Delete all the other events. + +# Code Samples + +## JavaScript + +```javascript +import {bytesToHex} from "@noble/hashes/utils" +import type {EventTemplate, UnsignedEvent, Event} from "nostr-tools" +import {getPublicKey, getEventHash, nip19, nip44, finalizeEvent, generateSecretKey} from "nostr-tools" + +type Rumor = UnsignedEvent & {id: string} + +const TWO_DAYS = 2 * 24 * 60 * 60 + +const now = () => Math.round(Date.now() / 1000) +const randomNow = () => Math.round(now() - (Math.random() * TWO_DAYS)) + +const nip44ConversationKey = (privateKey: Uint8Array, publicKey: string) => + nip44.v2.utils.getConversationKey(bytesToHex(privateKey), publicKey) + +const nip44Encrypt = (data: EventTemplate, privateKey: Uint8Array, publicKey: string) => + nip44.v2.encrypt(JSON.stringify(data), nip44ConversationKey(privateKey, publicKey)) + +const nip44Decrypt = (data: Event, privateKey: Uint8Array) => + JSON.parse(nip44.v2.decrypt(data.content, nip44ConversationKey(privateKey, data.pubkey))) + +const createRumor = (event: Partial<UnsignedEvent>, privateKey: Uint8Array) => { + const rumor = { + created_at: now(), + content: "", + tags: [], + ...event, + pubkey: getPublicKey(privateKey), + } as any + + rumor.id = getEventHash(rumor) + + return rumor as Rumor +} + +const createSeal = (rumor: Rumor, privateKey: Uint8Array, recipientPublicKey: string) => { + return finalizeEvent( + { + kind: 13, + content: nip44Encrypt(rumor, privateKey, recipientPublicKey), + created_at: randomNow(), + tags: [], + }, + privateKey + ) as Event +} + +const createWrap = (event: Event, recipientPublicKey: string) => { + const randomKey = generateSecretKey() + + return finalizeEvent( + { + kind: 1059, + content: nip44Encrypt(event, randomKey, recipientPublicKey), + created_at: randomNow(), + tags: [["p", recipientPublicKey]], + }, + randomKey + ) as Event +} + +// Test case using the above example +const senderPrivateKey = nip19.decode(`nsec1p0ht6p3wepe47sjrgesyn4m50m6avk2waqudu9rl324cg2c4ufesyp6rdg`).data +const recipientPrivateKey = nip19.decode(`nsec1uyyrnx7cgfp40fcskcr2urqnzekc20fj0er6de0q8qvhx34ahazsvs9p36`).data +const recipientPublicKey = getPublicKey(recipientPrivateKey) + +const rumor = createRumor( + { + kind: 1, + content: "Are you going to the party tonight?", + }, + senderPrivateKey +) + +const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey) +const wrap = createWrap(seal, recipientPublicKey) + +// Receiver unwraps with his/her private key. + +const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey) +const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey) +``` From 1a2b21b67eeae2eba8c03215826a32d4a03ae172 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Tue, 9 Jan 2024 13:39:58 -0800 Subject: [PATCH 171/192] Remove p tag, clarify that NIP 59 does not define a messaging protocol on its own --- 59.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/59.md b/59.md index cd841cff..c990236c 100644 --- a/59.md +++ b/59.md @@ -9,6 +9,8 @@ Gift Wrap This NIP defines a protocol for encapsulating any nostr event. This makes it possible to obscure most metadata for a given event, perform collaborative signing, and more. +This NIP *does not* define any messaging protocol. Applications of this NIP should be defined separately. + This NIP relies on [NIP-44](./44.md)'s versioned encryption algorithms. # Overview @@ -55,11 +57,8 @@ Tags MUST must always be empty in a `kind:13`. The inner event MUST always be un ## 3. Gift Wrap Event Kind -A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` MUST include a single `p` tag -containing the recipient's public key. - -The goal is to hide the sender's information, the metadata, and the content of the original event from the public. -The only public information is the receiver's public key. +A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information +needed to route the event to its intended recipient, including the recipient's `p` tag or NIP-13 proof of work. ```js { @@ -68,7 +67,7 @@ The only public information is the receiver's public key. "content": "<encrypted kind 13>", "kind": 1059, "created_at": 1686840217, - "tags": [["p", "<Receiver>"]], + "tags": [["p", "<recipient pubkey>"]], "sig": "<random, one-time-use pubkey signature>" } ``` @@ -106,6 +105,9 @@ Let's send a wrapped `kind 1` message between two parties asking "Are you going - Recipient private key: `e108399bd8424357a710b606ae0c13166d853d327e47a6e5e038197346bdbf45` - Ephemeral wrapper key: `4f02eac59266002db5801adc5270700ca69d5b8f761d8732fab2fbf233c90cbd` +Note that this messaging protocol should not be used in practice, this is just an example. Refer to other +NIPs for concrete messaging protocols that depend on gift wraps. + ## 1. Create an event Create a `kind 1` event with the message, the receivers, and any other tags you want, signed by the author. @@ -243,7 +245,7 @@ const rumor = createRumor( const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey) const wrap = createWrap(seal, recipientPublicKey) -// Receiver unwraps with his/her private key. +// Recipient unwraps with his/her private key. const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey) const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey) From 9b39fd5ef51eefc85af99b5aefac1a109bc17de3 Mon Sep 17 00:00:00 2001 From: Thabokani <149070269+Thabokani@users.noreply.github.com> Date: Wed, 17 Jan 2024 16:09:50 +0800 Subject: [PATCH 172/192] NIP-96: fix typo --- 96.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/96.md b/96.md index d8ea105e..3ebbef83 100644 --- a/96.md +++ b/96.md @@ -273,7 +273,7 @@ The `server` should reject deletes from users other than the original uploader. 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). -The successfull response is a 200 OK one with just basic JSON fields: +The successful response is a 200 OK one with just basic JSON fields: ``` { From c766f8892b46b26a91ac1e570cb605a8074b78b2 Mon Sep 17 00:00:00 2001 From: ekzyis <ekzyis@ekzyis.com> Date: Thu, 18 Jan 2024 23:32:36 +0100 Subject: [PATCH 173/192] NIP-47: fix typo --- 47.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/47.md b/47.md index c6540d51..4916658c 100644 --- a/47.md +++ b/47.md @@ -17,7 +17,7 @@ This NIP describes a way for clients to access a remote Lightning wallet through * **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. ## Theory of Operation - 1. **Users** who which to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. + 1. **Users** who wish to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. From d0812229a5569372a6cd1bdb8d148beb1820585d Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sun, 21 Jan 2024 16:08:45 -0300 Subject: [PATCH 174/192] use jsonc in some places. --- 01.md | 11 +++++------ 52.md | 4 ++-- 72.md | 10 +++++----- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/01.md b/01.md index 80ee7924..46316ea5 100644 --- a/01.md +++ b/01.md @@ -14,7 +14,7 @@ Each user has a keypair. Signatures, public key, and encodings are done accordin The only object type that exists is the `event`, which has the following format on the wire: -```json +```jsonc { "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, @@ -22,7 +22,7 @@ The only object type that exists is the `event`, which has the following format "kind": <integer between 0 and 65535>, "tags": [ [<arbitrary string>...], - ... + // ... ], "content": <arbitrary string>, "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> @@ -58,17 +58,16 @@ To prevent implementation differences from creating a different event ID for the Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: -```json +```jsonc { - ..., "tags": [ ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], ["alt", "reply"], - ... + // ... ], - ... + // ... } ``` diff --git a/52.md b/52.md index 5ac116b9..f35d9040 100644 --- a/52.md +++ b/52.md @@ -38,7 +38,7 @@ The list of tags are as follows: The following tags are deprecated: * `name` name of the calendar event. Use only if `title` is not available. -```json +```jsonc { "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>, @@ -99,7 +99,7 @@ The list of tags are as follows: The following tags are deprecated: * `name` name of the calendar event. Use only if `title` is not available. -```json +```jsonc { "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>, diff --git a/72.md b/72.md index c0fffffc..4bafce06 100644 --- a/72.md +++ b/72.md @@ -12,7 +12,7 @@ The goal of this NIP is to create moderator-approved public communities around a `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. -```json +```jsonc { "created_at": <Unix timestamp in seconds>, "kind": 34550, @@ -42,14 +42,14 @@ The goal of this NIP is to create moderator-approved public communities around a 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. -```json +```jsonc { "kind": 1, "tags": [ ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"], ], "content": "hello world", - ... + // ... } ``` @@ -59,7 +59,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. -```json +```jsonc { "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "kind": 4550, @@ -70,7 +70,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i ["k", "<post-request-kind>"] ], "content": "<the full approved event, JSON-encoded>", - ... + // ... } ``` From c2f34817e38353245b17c586946ef2a354bf9a4c Mon Sep 17 00:00:00 2001 From: benthecarman <benthecarman@live.com> Date: Wed, 6 Dec 2023 02:33:54 -0600 Subject: [PATCH 175/192] NIP-47: Nostr Wallet Connect Extensions --- 47.md | 278 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 276 insertions(+), 2 deletions(-) diff --git a/47.md b/47.md index b6a4f2bc..4cef6107 100644 --- a/47.md +++ b/47.md @@ -36,6 +36,7 @@ The info event should be a replaceable event that is published by the **wallet s a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. +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: @@ -108,7 +109,8 @@ Request: { "method": "pay_invoice", "params": { - "invoice": "lnbc50n1..." // bolt11 invoice + "invoice": "lnbc50n1...", // bolt11 invoice + "amount": 123, // invoice amount in msats, optional } } ``` @@ -117,7 +119,7 @@ Response: ```jsonc { "result_type": "pay_invoice", - "result": { + "result": { "preimage": "0123456789abcdef..." // preimage of the payment } } @@ -126,6 +128,278 @@ Response: Errors: - `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. +### `multi_pay_invoice` + +Description: Requests payment of multiple invoices. + +Request: +```jsonc +{ + "method": "multi_pay_invoice", + "params": { + "invoices": [ + {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123}, // bolt11 invoice and amount in msats, amount is optional + {"id":"3da52c32a1", "invoice": "lnbc50n1..."}, + ], + } +} +``` + +Response: + +For every invoice in the request, a separate response event is sent. To differentiate between the responses, each +response event contains an `d` tag with the id of the invoice it is responding to, if no id was given, then the +payment hash of the invoice should be used. + +```jsonc +{ + "result_type": "multi_pay_invoice", + "result": { + "preimage": "0123456789abcdef..." // preimage of the payment + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `pay_keysend` + +Request: +```jsonc +{ + "method": "pay_keysend", + "params": { + "amount": 123, // invoice amount in msats, required + "pubkey": "03...", // payee pubkey, required + "preimage": "0123456789abcdef...", // preimage of the payment, optional + "tlv_records: [ // tlv records, optional + { + "type": 5482373484, // tlv type + "value": "0123456789abcdef" // hex encoded tlv value + } + ] + } +} +``` + +Response: +```jsonc +{ + "result_type": "pay_keysend", + "result": { + "preimage": "0123456789abcdef...", // preimage of the payment + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `multi_pay_keysend` + +Description: Requests multiple keysend payments. + +Has an array of keysends, these follow the same semantics as `pay_keysend`, just done in a batch + +Request: +```jsonc +{ + "method": "multi_pay_keysend", + "params": { + "keysends": [ + {"id": "4c5b24a351", pubkey": "03...", "amount": 123}, + {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]}, + ], + } +} +``` + +Response: + +For every keysend in the request, a separate response event is sent. To differentiate between the responses, each +response event contains an `d` tag with the id of the keysend it is responding to, if no id was given, then the +pubkey should be used. + +```jsonc +{ + "result_type": "multi_pay_keysend", + "result": { + "preimage": "0123456789abcdef..." // preimage of the payment + } +} +``` + +Errors: +- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. + +### `make_invoice` + +Request: +```jsonc +{ + "method": "make_invoice", + "params": { + "amount": 123, // value in msats + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "expiry": 213 // expiry in seconds from time invoice is created, optional + } +} +``` + +Response: +```jsonc +{ + "result_type": "make_invoice", + "result": { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage, optional if unpaid + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +### `lookup_invoice` + +Request: +```jsonc +{ + "method": "lookup_invoice", + "params": { + "payment_hash": "31afdf1..", // payment hash of the invoice, one of payment_hash or invoice is required + "invoice": "lnbc50n1..." // invoice to lookup + } +} +``` + +Response: +```jsonc +{ + "result_type": "lookup_invoice", + "result": { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage, optional if unpaid + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time, optional if unpaid + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +Errors: +- `NOT_FOUND`: The invoice could not be found by the given parameters. + +### `list_transactions` + +Lists invoices and payments. If `type` is not specified, both invoices and payments are returned. +The `from` and `until` parameters are timestamps in seconds since epoch. If `from` is not specified, it defaults to 0. +If `until` is not specified, it defaults to the current time. Transactions are returned in descending order of creation +time. + +Request: +```jsonc +{ + "method": "list_transactions", + "params": { + "from": 1693876973, // starting timestamp in seconds since epoch (inclusive), optional + "until": 1703225078, // ending timestamp in seconds since epoch (inclusive), optional + "limit": 10, // maximum number of invoices to return, optional + "offset": 0, // offset of the first invoice to return, optional + "unpaid": true, // include unpaid invoices, optional, default false + "type": "incoming", // "incoming" for invoices, "outgoing" for payments, undefined for both + } +} +``` + +Response: +```jsonc +{ + "result_type": "list_transactions", + "result": { + "transactions": [ + { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage, optional if unpaid + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time, optional if unpaid + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } + ], + }, +} +``` + +### `get_balance` + +Request: +```jsonc +{ + "method": "get_balance", + "params": { + } +} +``` + +Response: +```jsonc +{ + "result_type": "get_balance", + "result": { + "balance": 10000, // user's balance in msats + } +} +``` + +### `get_info` + +Request: +```jsonc +{ + "method": "get_info", + "params": { + } +} +``` + +Response: +```jsonc +{ + "result_type": "get_info", + "result": { + "alias": "string", + "color": "hex string", + "pubkey": "hex string", + "network": "string", // mainnet, testnet, signet, or regtest + "block_height": 1, + "block_hash": "hex string", + "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection + } +} +``` + ## Example pay invoice flow 0. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. From 363e4958cf10fc35f3168ca51374da06c0e5b2ee Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 23 Jan 2024 13:09:10 +0900 Subject: [PATCH 176/192] Add kinds for NIP-15 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index cf3827e8..91179cd7 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `1021` | Bid | [15](15.md) | +| `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1063` | File Metadata | [94](94.md) | | `1311` | Live Chat Message | [53](53.md) | @@ -136,6 +138,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `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) | From 6dd003508567dd780f3d8da12f0f9a62449cb992 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= <github@ibz.me> Date: Tue, 23 Jan 2024 18:36:38 +0200 Subject: [PATCH 177/192] #p refers to pubkeys, *not* "event pubkeys". --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 46316ea5..c1e37480 100644 --- a/01.md +++ b/01.md @@ -124,7 +124,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th "ids": <a list of event ids>, "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, "kinds": <a list of a kind numbers>, - "#<single-letter (a-zA-Z)>": <a list of tag values, for #e β€” a list of event ids, for #p β€” a list of event pubkeys etc>, + "#<single-letter (a-zA-Z)>": <a list of tag values, for #e β€” a list of event ids, for #p β€” a list of pubkeys, etc.>, "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, "until": <an integer unix timestamp in seconds, events must be older than this to pass>, "limit": <maximum number of events relays SHOULD return in the initial query> From 9fd5be26cd0593b15c61bf3ea219bbfcdec81495 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 25 Jan 2024 12:33:25 +0900 Subject: [PATCH 178/192] NIP-30: add supported kinds --- 30.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/30.md b/30.md index 5a6f84de..c2f8bb07 100644 --- a/30.md +++ b/30.md @@ -6,7 +6,7 @@ Custom Emoji `draft` `optional` -Custom emoji may be added to **kind 0** and **kind 1** events by including one or more `"emoji"` tags, in the form: +Custom emoji may be added to **kind 0**, **kind 1**, **kind 7** ([NIP-25](25.md)) and **kind 30315** ([NIP-38](38.md)) events by including one or more `"emoji"` tags, in the form: ``` ["emoji", <shortcode>, <image-url>] From 7ec060375c5aa8697e8b26c2d1088c9077bfa910 Mon Sep 17 00:00:00 2001 From: Michael Dilger <mike@mikedilger.com> Date: Tue, 30 Jan 2024 04:45:16 +1300 Subject: [PATCH 179/192] NIP-49: Private key encryption (#133) * Key export/import as implemented by gossip * Added test data * Last push didn't make sense, only this direction works * Multiple updates: 100k rounds, random salt, version number, length indications * Rename to NIP-49, include in README * Change encoding to bech32 (ncryptsec) * Major rework of the algorithm. NIP is now incomplete as I haven't coded it yet. * renamed * spelling * minor fix * formatting * MORE CHANGES: scrypt, spelt out more detail of the steps to take * spelling * Mostly just removing some unnecesary stuff * Remove the cafebabe note * Remove confusing nonce statement * Change title (and a bit of wording) * remove author * remove legacy event * rename on README --------- Co-authored-by: Mike Dilger <mike@ezicheq.com> Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> --- 49.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 113 insertions(+) create mode 100644 49.md diff --git a/49.md b/49.md new file mode 100644 index 00000000..becc5860 --- /dev/null +++ b/49.md @@ -0,0 +1,112 @@ + +NIP-49 +====== + +Private Key Encryption +---------------------- + +`draft` `optional` + +This NIP defines a method by which clients can encrypt (and decrypt) a user's private key with a passphrase. + +Symmetric Encryption Key derivation +----------------------------------- + +PASSPHRASE = read from the user + +LOG\_N = Let the user or implementer choose one byte representing a power of 2 (e.g. 18 represents 262,144) which is used as the number of rounds for scrypt. Larger numbers take more time and more memory, and offer better protection: + + | LOG\_N | MEMORY REQUIRED | APPROX TIME ON FAST COMPUTER | + |--------|-----------------|----------------------------- | + | 16 | 64 MiB | 100 ms | + | 18 | 256 MiB | | + | 20 | 1 GiB | 2 seconds | + | 21 | 2 GiB | | + | 22 | 4 GiB | | + +SALT = 16 random bytes + +SYMMETRIC_KEY = scrypt(passphrase=PASSPHRASE, salt=SALT, log\_n=LOG\_N, r=8, p=1) + +The symmetric key should be 32 bytes long. + +This symmetric encryption key is temporary and should be zeroed and discarded after use and not stored or reused for any other purpose. + + +Encrypting a private key +------------------------ + +The private key encryption process is as follows: + +PRIVATE\_KEY = User's private (secret) secp256k1 key as 32 raw bytes (not hex or bech32 encoded!) + +KEY\_SECURITY\_BYTE = one of: + +* 0x00 - if the key has been known to have been handled insecurely (stored unencrypted, cut and paste unencrypted, etc) +* 0x01 - if the key has NOT been known to have been handled insecurely (stored unencrypted, cut and paste unencrypted, etc) + * 0x02 - if the client does not track this data + +ASSOCIATED\_DATA = KEY\_SECURITY\_BYTE + +NONCE = 24 byte random nonce + +CIPHERTEXT = XChaCha20-Poly1305( + plaintext=PRIVATE\_KEY, + associated_data=ASSOCIATED\_DATA, + nonce=NONCE, + key=SYMMETRIC\_KEY +) + +VERSION\_NUMBER = 0x02 + +CIPHERTEXT_CONCATENATION = concat( + VERSION\_NUMBER, + LOG\_N, + SALT, + NONCE, + ASSOCIATED\_DATA, + CIPHERTEXT +) + +ENCRYPTED\_PRIVATE\_KEY = bech32_encode('ncryptsec', CIPHERTEXT\_CONCATENATION) + +The output prior to bech32 encoding should be 91 bytes long. + +The decryption process operates in the reverse. + + +Test Data +--------- + +The following encrypted private key: + +`ncryptsec1qgg9947rlpvqu76pj5ecreduf9jxhselq2nae2kghhvd5g7dgjtcxfqtd67p9m0w57lspw8gsq6yphnm8623nsl8xn9j4jdzz84zm3frztj3z7s35vpzmqf6ksu8r89qk5z2zxfmu5gv8th8wclt0h4p` + +When decrypted with password='nostr' and log_n=16 yields the following hex-encoded private key: + +`3501454135014541350145413501453fefb02227e449e57cf4d3a3ce05378683` + +The reverse process is non-deterministic due to the random nonce. + +Discussion +---------- + +### On Key Derivation + +Passwords make poor cryptographic keys. Prior to use as a cryptographic key, two things need to happen: + +1. An encryption key needs to be deterministically created from the password such that is has a uniform functionally random distribution of bits, such that the symmetric encryption algorithm's assumptions are valid, and +2. A slow irreversible algorithm should be injected into the process, so that brute-force attempts to decrypt by trying many passwords are severely hampered. + +These are achieved using a password-based key derivation function. We use scrypt, which has been proven to be maximally memory hard and which several cryptographers have indicated to the author is better than argon2 even though argon2 won a competition in 2015. + +### On the symmetric encryption algorithm + +XChaCha20-Poly1305 is typically favored by cryptographers over AES and is less associated with the U.S. government. It (or it's earlier variant without the 'X') is gaining wide usage, is used in TLS and OpenSSH, and is available in most modern crypto libraries. + +Recommendations +--------- + +It is not recommended that users publish these encrypted private keys to nostr, as cracking a key may become easier when an attacker can amass many encrypted private keys. + +It is recommended that clients zero out the memory of passwords and private keys before freeing that memory. diff --git a/README.md b/README.md index 91179cd7..9ce96fc3 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) +- [NIP-49: Private Key Encryption](49.md) - [NIP-50: Search Capability](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) From ee93721ac76bb1e54e7de1d6a7d9f00c6b3c9849 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 31 Jan 2024 07:47:56 +0900 Subject: [PATCH 180/192] Add NIP-59 to README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9ce96fc3..10b1dfb7 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) +- [NIP-59: Gift Wrap](59.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-72: Moderated Communities](72.md) - [NIP-75: Zap Goals](75.md) From f3589b99b0e5e297eea2de6b3686f81541b7d3db Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 1 Feb 2024 00:11:14 +0900 Subject: [PATCH 181/192] NIP-59: fix typo and nitpicks --- 59.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/59.md b/59.md index c990236c..7eff2b82 100644 --- a/59.md +++ b/59.md @@ -58,7 +58,7 @@ Tags MUST must always be empty in a `kind:13`. The inner event MUST always be un ## 3. Gift Wrap Event Kind A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information -needed to route the event to its intended recipient, including the recipient's `p` tag or NIP-13 proof of work. +needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work. ```js { @@ -74,7 +74,7 @@ needed to route the event to its intended recipient, including the recipient's ` # Encrypting Payloads -Encryption is done following NIP-44 on the JSON-encoded event. Place the the encryption payload in the `.content` +Encryption is done following [NIP-44](44.md) on the JSON-encoded event. Place the encryption payload in the `.content` of the wrapper event (either a `seal` or a `gift wrap`). # Other Considerations @@ -87,13 +87,13 @@ time-analysis attacks. Note that some relays don't serve events dated in the fut SHOULD be in the past. Relays may choose not to store gift wrapped events due to them not being publicly useful. Clients MAY choose -to attach a certain amount of proof-of-work to the wrapper event per NIP-13 in a bid to demonstrate that +to attach a certain amount of proof-of-work to the wrapper event per [NIP-13](13.md) in a bid to demonstrate that the event is not spam or a denial-of-service attack. -To protect recipient metadata, relays SHOULD guard access to kind 1059 events based on user AUTH. When +To protect recipient metadata, relays SHOULD guard access to `kind 1059` events based on user AUTH. When possible, clients should only send wrapped events to relays that offer this protection. -To protect recipient metadata, relays SHOULD only serve kind 1059 events intended for the marked recipient. +To protect recipient metadata, relays SHOULD only serve `kind 1059` events intended for the marked recipient. When possible, clients should only send wrapped events to `read` relays for the recipient that implement AUTH, and refuse to serve wrapped events to non-recipients. From ffef063a44cc1431da39b9fe145bf2a8ff84f302 Mon Sep 17 00:00:00 2001 From: ocknamo <s14pes@gmail.com> Date: Thu, 1 Feb 2024 23:57:58 +0900 Subject: [PATCH 182/192] fix: Correct PASSPHRASE to PASSWORD in NIP-49 --- 49.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/49.md b/49.md index becc5860..6de05eb9 100644 --- a/49.md +++ b/49.md @@ -7,12 +7,12 @@ Private Key Encryption `draft` `optional` -This NIP defines a method by which clients can encrypt (and decrypt) a user's private key with a passphrase. +This NIP defines a method by which clients can encrypt (and decrypt) a user's private key with a password. Symmetric Encryption Key derivation ----------------------------------- -PASSPHRASE = read from the user +PASSWORD = read from the user LOG\_N = Let the user or implementer choose one byte representing a power of 2 (e.g. 18 represents 262,144) which is used as the number of rounds for scrypt. Larger numbers take more time and more memory, and offer better protection: @@ -26,7 +26,7 @@ LOG\_N = Let the user or implementer choose one byte representing a power of 2 ( SALT = 16 random bytes -SYMMETRIC_KEY = scrypt(passphrase=PASSPHRASE, salt=SALT, log\_n=LOG\_N, r=8, p=1) +SYMMETRIC_KEY = scrypt(password=PASSWORD, salt=SALT, log\_n=LOG\_N, r=8, p=1) The symmetric key should be 32 bytes long. From 2c016b0659a8f29ad2420a4cd844a2dca4956407 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 27 Nov 2023 14:47:04 -0800 Subject: [PATCH 183/192] Add imeta tag --- 29.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 94.md | 1 + 2 files changed, 44 insertions(+) create mode 100644 29.md diff --git a/29.md b/29.md new file mode 100644 index 00000000..8c990bb3 --- /dev/null +++ b/29.md @@ -0,0 +1,43 @@ +NIP029 +====== + +imeta +-------------- + +`imeta` is a tag for adding media attachments to events. `imeta` tags MUST match URLs +in the event content. Clients may replace imeta URLs with rich previews. `imeta` tags +contain extra information about the media attachment, which clients can use to provide +a better experience when loading images. + +The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. +Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include +any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per url. + +## Example + +```json +{ + "content": "More image metadata tests don’t mind me https://nostr.build/i/my-image.jpg", + "kind": 1, + "tags": [ + [ + "imeta", + "url https://nostr.build/i/my-image.jpg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt A scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt1.jpg" + "fallback https://void.cat/alt1.jpg" + ] + ] +} +``` + +## Recommended client behavior + +When uploading images during a new post, clients MAY include this metadata +after the image is uploaded and included in the post. + +When pasting urls during post composition, the client MAY download the image +and add this metadata before the post is sent. diff --git a/94.md b/94.md index eb8117a4..e35dfa1c 100644 --- a/94.md +++ b/94.md @@ -25,6 +25,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `image` (optional) url of preview image with same dimensions * `summary` (optional) text excerpt * `alt` (optional) description for accessibility +* `fallback` (optional) zero or more fallback file sources in case `url` fails ```json { From 716234149a2544cd59c7f4d04608e71b4fc7aab3 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Thu, 1 Feb 2024 15:47:51 -0600 Subject: [PATCH 184/192] NIP-29: add to NIPs list, improve preamble phrasing --- 29.md | 14 +++++++------- README.md | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/29.md b/29.md index 8c990bb3..dafd51ca 100644 --- a/29.md +++ b/29.md @@ -1,13 +1,12 @@ -NIP029 +NIP-29 ====== -imeta --------------- +Media Attachments +----------------- -`imeta` is a tag for adding media attachments to events. `imeta` tags MUST match URLs -in the event content. Clients may replace imeta URLs with rich previews. `imeta` tags -contain extra information about the media attachment, which clients can use to provide -a better experience when loading images. +Media attachments (images, videos, and other files) may be added to events by including a URL in the event content, along with a matching `imeta` tag. + +`imeta` ("inline metadata") tags add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients may replace imeta URLs with rich previews. `imeta` tags contain extra information about the media attachment, which clients can use to provide a better experience when loading previews. The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include @@ -23,6 +22,7 @@ any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag p [ "imeta", "url https://nostr.build/i/my-image.jpg", + "m image/jpeg", "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", "dim 3024x4032", "alt A scenic photo overlooking the coast of Costa Rica", diff --git a/README.md b/README.md index 10b1dfb7..28d016b6 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) +- [NIP-29: Media Attachments](29.md) - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) From eee64fedb2c81a284fa98e09da57abd06d98dec0 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Thu, 1 Feb 2024 15:51:22 -0600 Subject: [PATCH 185/192] NIP-29: remove the redundant last sentence --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index dafd51ca..2913619e 100644 --- a/29.md +++ b/29.md @@ -6,7 +6,7 @@ Media Attachments Media attachments (images, videos, and other files) may be added to events by including a URL in the event content, along with a matching `imeta` tag. -`imeta` ("inline metadata") tags add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients may replace imeta URLs with rich previews. `imeta` tags contain extra information about the media attachment, which clients can use to provide a better experience when loading previews. +`imeta` ("inline metadata") tags add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients may replace imeta URLs with rich previews. The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include From 5e14fd7f0851779cda2adbb8fd8bac4547570b15 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Thu, 1 Feb 2024 15:52:52 -0600 Subject: [PATCH 186/192] NIP-29: images -> files --- 29.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/29.md b/29.md index 2913619e..2a22233d 100644 --- a/29.md +++ b/29.md @@ -36,8 +36,8 @@ any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag p ## Recommended client behavior -When uploading images during a new post, clients MAY include this metadata -after the image is uploaded and included in the post. +When uploading files during a new post, clients MAY include this metadata +after the file is uploaded and included in the post. -When pasting urls during post composition, the client MAY download the image +When pasting urls during post composition, the client MAY download the file and add this metadata before the post is sent. From 5196ac196a9e19cfbb9c6cd16d8081dd137e3572 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 1 Feb 2024 20:59:37 -0300 Subject: [PATCH 187/192] move `imeta` to NIP-92, add `imeta` tag to README. --- 29.md => 92.md | 2 +- README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) rename 29.md => 92.md (99%) diff --git a/29.md b/92.md similarity index 99% rename from 29.md rename to 92.md index 2a22233d..81d46106 100644 --- a/29.md +++ b/92.md @@ -1,4 +1,4 @@ -NIP-29 +NIP-92 ====== Media Attachments diff --git a/README.md b/README.md index 28d016b6..438f5172 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) -- [NIP-29: Media Attachments](29.md) - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) @@ -74,6 +73,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-84: Highlights](84.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) +- [NIP-92: Media Attachments](92.md) - [NIP-94: File Metadata](94.md) - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) @@ -218,6 +218,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `imeta` | inline metadata | -- | [92](92.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | | `name` | badge name | -- | [58](58.md) | From 6de5ee32f411a91f5001a7d300931a7b1ec9adca Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 3 Feb 2024 10:28:57 +0900 Subject: [PATCH 188/192] NIP-92: fix typo and nitpicks --- 92.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/92.md b/92.md index 81d46106..b857d6ce 100644 --- a/92.md +++ b/92.md @@ -10,7 +10,7 @@ Media attachments (images, videos, and other files) may be added to events by in The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include -any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per url. +any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per URL. ## Example @@ -27,7 +27,7 @@ any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag p "dim 3024x4032", "alt A scenic photo overlooking the coast of Costa Rica", "x <sha256 hash as specified in NIP 94>", - "fallback https://nostrcheck.me/alt1.jpg" + "fallback https://nostrcheck.me/alt1.jpg", "fallback https://void.cat/alt1.jpg" ] ] @@ -39,5 +39,5 @@ any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag p When uploading files during a new post, clients MAY include this metadata after the file is uploaded and included in the post. -When pasting urls during post composition, the client MAY download the file +When pasting URLs during post composition, the client MAY download the file and add this metadata before the post is sent. From c8ba0e2e35bf987b9336d2ff49f452e84620396a Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 29 Jan 2024 09:05:11 -0800 Subject: [PATCH 189/192] Add status to nip 99 --- 99.md | 1 + 1 file changed, 1 insertion(+) diff --git a/99.md b/99.md index e65920c6..93550d87 100644 --- a/99.md +++ b/99.md @@ -40,6 +40,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"<number>"` is the amount in numeric format (but included in the tag as a string) - `"<currency>"` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). - `"<frequency>"` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) +- - `"status"` (optional), the status of the listing. SHOULD be either "active" or "sold". #### `price` examples From d3dad114e60cb45bb04f2088a68ebd16cf6837df Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Tue, 6 Feb 2024 20:29:33 -0300 Subject: [PATCH 190/192] NIP-46: replace npub1...#? notation with bunker://... (#1023) --- 46.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/46.md b/46.md index 05247c59..94a052ee 100644 --- a/46.md +++ b/46.md @@ -17,7 +17,7 @@ The client always starts by generating a random key which is used to communicate The remote signer generates a connection token in the form ``` -<npub1...>#<optional-secret>?relay=wss://...&relay=wss://... +bunker://<hex-pubkey>?relay=wss://...&relay=wss://...&secret=<optional-secret> ``` The user copies that token and pastes it in the client UI somehow. Then the client can send events of kind `24133` to the specified relays and wait for responses from the remote signer. @@ -96,4 +96,3 @@ The signer key will always be the key of the user who controls the signer device - **ping** - params: [] - result: `"pong"` - From a46338bd6a183f17a292ea578ee69ff15ea6723f Mon Sep 17 00:00:00 2001 From: Thebora Kompanioni <theborakompanioni@users.noreply.github.com> Date: Thu, 8 Feb 2024 00:03:32 +0100 Subject: [PATCH 191/192] fix(docs): typo in 01.md --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index c1e37480..905e45f7 100644 --- a/01.md +++ b/01.md @@ -147,7 +147,7 @@ The `limit` property of a filter is only valid for the initial query and MUST be ### From relay to client: sending events and notices -Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns: +Relays can send 5 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients. * `["OK", <event_id>, <true|false>, <message>]`, used to indicate acceptance or denial of an `EVENT` message. From 94761a5f3bcfb2c4085ae4d42fced450a2da25eb Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 12 Feb 2024 22:23:21 +0900 Subject: [PATCH 192/192] Add kinds for NIP-59 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 438f5172..d1c52500 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | +| `13` | Seal | [59](59.md) | | `16` | Generic Repost | [18](18.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | @@ -100,6 +101,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `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) | | `1971` | Problem Tracker | [nostrocket][nostrocket] |