From e4937befd6fc29482387ab18a7fab98338dba55d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:44:58 -0400 Subject: [PATCH 001/176] Zap splits --- 57.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index cb1f126..987b5a2 100644 --- a/57.md +++ b/57.md @@ -168,16 +168,20 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on zapped event -When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay request based on it's value instead of the profile's field. An optional third argument on the tag specifies the type of value, either `lud06` or `lud16`. +When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, `lud16` identifier or `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each member. If weights are not present, CLIENTS should equally divide the zap amount to all zap receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```json { "tags": [ - [ "zap", "pablo@f7z.io", "lud16" ] + [ "zap", "LNURL..", "lud06", 10 ], // 10% + [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% ] } ``` +When the hex code is used, clients MAY inform the user the zap split configuration in the note. + ## Future Work Zaps can be extended to be more private by encrypting `zap request` notes to the target user, but for simplicity it has been left out of this initial draft. From a56d650333c03a51b1f2d7852670216489ff35d6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:46:05 -0400 Subject: [PATCH 002/176] fixing json formatting --- 57.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index 987b5a2..e67ec8b 100644 --- a/57.md +++ b/57.md @@ -173,9 +173,9 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur ```json { "tags": [ - [ "zap", "LNURL..", "lud06", 10 ], // 10% + [ "zap", "LNURL..", "lud06", 10 ], // 10% [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% ] } ``` From dd5c9c54ae33c0480b2f12b604353b738c827115 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:50:55 -0400 Subject: [PATCH 003/176] Changes the client guidance --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index e67ec8b..7471685 100644 --- a/57.md +++ b/57.md @@ -180,7 +180,7 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur } ``` -When the hex code is used, clients MAY inform the user the zap split configuration in the note. +Clients MAY display the zap split configuration in the note. ## Future Work From 7c3e5902471b2eccf8032c06ab4e07940dd56ae7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 09:46:36 -0400 Subject: [PATCH 004/176] Moves weights to be a string as tags can only contain strings --- 57.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/57.md b/57.md index 7471685..4d02611 100644 --- a/57.md +++ b/57.md @@ -173,9 +173,9 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur ```json { "tags": [ - [ "zap", "LNURL..", "lud06", 10 ], // 10% - [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% + [ "zap", "LNURL..", "lud06", "10" ], // 10% + [ "zap", "pablo@f7z.io", "lud16", "65" ], // 65% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "25" ] // 25% ] } ``` From 9c97736066a131442a5e43420f0600904959d1cf Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 10:10:18 -0400 Subject: [PATCH 005/176] minor text/grammar adjustments --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 4d02611..a221481 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on zapped event -When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, `lud16` identifier or `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each member. If weights are not present, CLIENTS should equally divide the zap amount to all zap receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```json { From 2f8be7c32b7b624ed65b3238d3ada9f2f8859777 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 10:41:14 -0400 Subject: [PATCH 006/176] better example of weights. --- 57.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/57.md b/57.md index a221481..cb6a290 100644 --- a/57.md +++ b/57.md @@ -170,12 +170,12 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). -```json +```js { "tags": [ - [ "zap", "LNURL..", "lud06", "10" ], // 10% - [ "zap", "pablo@f7z.io", "lud16", "65" ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "25" ] // 25% + [ "zap", "LNURL..", "lud06", "1" ], // 25% + [ "zap", "pablo@f7z.io", "lud16", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "2" ] // 50% ] } ``` From 5834c054398b39404868746db973ea7f373d1392 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 12:20:53 -0400 Subject: [PATCH 007/176] Dropping lud06 and lud16 from the zap tag --- 57.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/57.md b/57.md index cb6a290..27b85a4 100644 --- a/57.md +++ b/57.md @@ -166,16 +166,16 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter - The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present). - The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. -### Appendix G: `zap` tag on zapped event +### Appendix G: `zap` tag on other events -When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on their value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```js { "tags": [ - [ "zap", "LNURL..", "lud06", "1" ], // 25% - [ "zap", "pablo@f7z.io", "lud16", "1" ], // 25% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "2" ] // 50% + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50% ] } ``` From 91bdf63b130cadb89c3908cab09305526e9f2092 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 12:22:16 -0400 Subject: [PATCH 008/176] grammar --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 27b85a4..39fa562 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on other events -When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on their value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```js { From 67e950a2009e81df1b8c91b0a2ade0596e83f168 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Mon, 3 Jul 2023 14:21:13 +0200 Subject: [PATCH 009/176] 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 0000000..273aa28 --- /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 010/176] Add examples --- vending-machine.md | 84 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 82 insertions(+), 2 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 273aa28..a94cd33 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -77,8 +77,8 @@ Specified the input that the job should be executed with. * ``: The way this argument should be interpreted * Possible values: * `url`: a URL to be fetched - * `event`: a different event ID - * `job`: the output of a previous job + * `event`: a nostr event ID + * `job`: the output of a previous job with the specified event ID * ``: #### `relays` tag @@ -161,3 +161,83 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar ### Multitple job acceptance * Nothing prevents a user from accepting multiple job results. +# Appendix 1: Examples + +## Customer wants to get a transcript of a podcast from second 900 to 930. + +### `kind:68001`: Job Request +```json +{ + "id": "12345", + "pubkey": "abcdef", + "content": "I need a transcript of Bitcoin.review", + "tags": [ + [ "j", "speech-to-text" ], + [ "params", "range", "900", "930" ], + [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "bid", "5000", "9000" ] + ] +} +``` + +### `kind:1021`: Job fulfillment +```json +{ + "content": "Person 1: blah blah blah", + "tags": [ + ["e", "12345"], + ["p", "abcdef"], + ["status", "success"] + ] +} +``` + +## Customer wants to get a summarization of a podcast + +User publishes two job requests at the same time in the order they should be executed. + +### `kind:68001`: Job Request #1 +```json +{ + "id": "12345", + "pubkey": "abcdef", + "content": "I need a transcript of Bitcoin.review from second 900 to 930", + "tags": [ + [ "j", "speech-to-text" ], + [ "params", "range", "900", "930" ], + [ "input", "https://bitcoin.review/episode1.mp3", "url" ], + [ "bid", "5000", "9000" ] + ] +} +``` + +### `kind:68001`: Job Request #2 +```json +{ + "id": "12346", + "pubkey": "abcdef", + "content": "I need a summarization", + "tags": [ + [ "j", "summarization" ], + [ "params", "length", "3 paragraphs" ], + [ "input", "12346", "job" ], + [ "bid", "300", "900" ] + ] +} +``` + +## Customer wants a translation of a note +### `kind:68001`: Job Request #1 +```json +{ + "id": "12346", + "pubkey": "abcdef", + "content": "", + "tags": [ + [ "j", "translation" ], + [ "input", "", "event" ] + [ "params", "language", "es_AR" ], + [ "bid", "100", "500" ] + ] +} +``` \ No newline at end of file From ce552554a08bb5b9878621abfdde3207d54cae62 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Wed, 5 Jul 2023 11:14:50 +0200 Subject: [PATCH 011/176] 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 a94cd33..eb26688 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 012/176] 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 eb26688..2f9c064 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -27,7 +27,7 @@ A request to have data processed -- published by a customer "kind": 68001, "content": "", "tags": [ - // The type data processing the user wants to be performed + // The type of data processing the user wants to be performed [ "j", "", "" ], // input(s) for the job request @@ -49,12 +49,12 @@ A request to have data processed -- published by a customer An optional, human-readable description of what this job is for. ### `j` tag -Specifies the job to be executed. A job request MUST have exactly one `j` tag. +Specifies the job to be executed. A job request MUST have exactly one (1) `j` tag. -A `j` tag MIGHT name a specific model to be used for the computed with as the second value. +A `j` tag MAY include a second value specifying the name of a model to be used when computing the result. ### `i` (input) tag -Specifies the input that the job should be executed with. The input is relay-indexable so that clients interested in the exact same job can find it it's result if it's already fulfilled. +Specifies the input data that the job is to be executed against. The input is relay-indexable so that clients interested in the exact same job can find the input data and the result result (if it's already fulfilled). A job request CAN have zero or more inputs. @@ -64,50 +64,51 @@ A job request CAN have zero or more inputs. * `url`: a URL to be fetched * `event`: a nostr event ID * `job`: the output of a previous job with the specified event ID -* ``: +* ``: an optional field indicating where the data can be found if it is a subset of the provided values, for example the name of the key(s) in a key/value set, or the start and end positions of the data if it's a bytestream. ### `bid` tag -The user MIGHT specify an amount of millisats they are willing to pay for the job to be processed. The user MIGHT also specify a maximum amount of millisats they are willing to pay. +The Customer MAY specify a maximum amount (in millisats) they are willing to pay for the job to be processed. ### `relays` tag -A list of relays the service provider should publish its job result to. +The Service Provider SHOULD publish job results to the relays specified in this this tag. ### `p` tags -A user MIGHT want to explicitly request this job to be processed by specific service provider(s). Other service providers might still choose to compete for this job. +If a Customer has a preference for specific Service Provider(s) to process this job, they SHOULD indicate this by including the Service Provider(s) pubkey in a `p` tag. This is NOT intended to exclude other Service Providers and they MAY still choose to compete for jobs that have not tagged them. ### `exp` -A user might specify that they will not be interested in results past a certain time (e.g. a time-sensitive job whos value is no longer relevant after some time, like a live transcription service) +A Customer MAY indicate that they will not pay for results produced after a specific Block height or Unix Timestamp. This is intended for time-sensitive jobs where the result is not relevant unless produced within a certain timeframe, e.g. a live transcription service. ## Job result -The output of processing the data -- published by the service provider. +The output of processing the data -- published by the Service Provider. ```json { - "pubkey": "service-provider", + "pubkey": "service-provider pubkey in hex", // result - "content": "", + "content": "string: ", + "kind": 68002, "tags" [ // stringified JSON request event - [ "request", "<68001-event>" ], - [ "e", ], - [ "p", "" ], - [ "status", "success", ""], + [ "request", "" ], + [ "e", "" ], + [ "p", "" ], + [ "status", "success", "" ], [ "amount", "requested-payment-amount" ] ] } ``` -The result of the job should be in the `content`. If the output is not text, the `content` field should be empty and an `output` tag should be used instead as described below. +The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. #### `status` tag -The service provider might want to return an error to the user in case the job could not be processed correctly +The Service Provider MAY indicate errors during processing by including them in the `status` tag, these errors are intended to be consumed by the Customer. #### `amount` -The amount of millisats the service provider is requesting to be paid. This amount MIGHT be different than the amount specified by the user in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. +The amount (in millisats) that the Service Provider is requesting to be paid. This amount MAY differ to the amount specified by the Customer in the `bid` tag. The amount SHOULD be less than the maximum amount specified by the user in the `bid` tag. ## Job types -This NIP defines some job types, clients SHOULD specify these types for maximum compatibility with service providers. Other job types might be added to this NIP. +This NIP defines some example job types, Customers SHOULD specify these types for maximum compatibility with Service Providers. Other job types MAY be added to this NIP after being observed in the wild. ### `speech-to-text` #### params @@ -127,24 +128,24 @@ This NIP defines some job types, clients SHOULD specify these types for maximum | `language` | req | requested language in BCP 47 format. # Protocol Flow -* User publishes a job request +* Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` -* Service providers listen for the type of jobs they can perform +* Service Providers subsribe to the type of jobs they can perform `{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` -* When a job comes in, the service providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) +* When a job comes in, the Service Providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) * Upon completion, the service provider publishes the result of the job with a `job-result` event. * Upon acceptance, the user zaps the service provider, tagging the job result event. # Payment -Customers SHOULD pay service providers whose job results they accept. Users should zap the service provider, tagging the `kind:68002` job result. +Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. # Job chaining -A customer CAN request multiple jobs to be chained, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. +A Customer MAY request multiple jobs to be processed in a chained form, so that the output of a job can be the input of the next job. (e.g. summarization of a podcast's transcription). This is done by specifying as `input` an eventID of a different job with the `job` marker. -Service providers might opt to start processing a subsequent job the moment they see the prior job's result, or they might choose to wait for a zap to have been published. This introduces the risk that service provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to service providers to mitigate or to decide whether the service provider of job#1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. +Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for a explicit zap to assume the job was accepted. # Reactions > **Warning** From 141197c564d97073f0293e3b2f367f0b6b3619c2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Sat, 8 Jul 2023 08:11:22 -0400 Subject: [PATCH 013/176] NIP-53 Live Activities (#498) --- 53.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 53.md diff --git a/53.md b/53.md new file mode 100644 index 0000000..9a86d9e --- /dev/null +++ b/53.md @@ -0,0 +1,125 @@ +NIP-53 +====== + +Live Activities +--------------- + +`draft` `optional` `author:vitorpamplona` `author:v0l` + +## Abstract + +Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. + +# Live Event + +A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. + +For example: + +```js +{ + "kind": 30311, + "tags": [ + ["d", ""], + ["title", ""], + ["summary", ""], + ["image", ""], + ["t", "hashtag"] + ["streaming", ""], + ["recording", ""], // used to place the edited video once the activity is over + ["starts", ""], + ["ends", ""], + ["status", ""], + ["current_participants", ""], + ["total_participants", ""], + ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", ""], + ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], + ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], + ["relays", "wss://one.com", "wss://two.com", ...] + ], + "content": "", + ...other fields +} +``` + +A distinct `d` tag should be used for each activity. All other tags are optional. + +Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). + +Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. + +Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` + +The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). + +## Proof of Agreement to Participate + +Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex. + +Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. + +This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. + +# Live Chat Message + +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": 1311, + "tags": [ + ["a", "34550::", "", "root"], + ], + "content": "Zaps to live streams is beautiful." +} +``` + +# Use Cases + +Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com). + +# Example + +Live Streaming + +```json +{ + "id": "57f28dbc264990e2c61e80a883862f7c114019804208b14da0bff81371e484d2", + "pubkey": "1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec", + "created_at": 1687182672, + "kind": 30311, + "tags": [ + ["d", "demo-cf-stream"], + ["title", "Adult Swim Metalocalypse"], + ["summary", "Live stream from IPTV-ORG collection"], + ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], + ["starts", "1687182672"] + ["status", "live"], + ["t", "animation"], + ["t", "iptv"], + ["image", "https://i.imgur.com/CaKq6Mt.png"] + ], + "content": "", + "sig": "5bc7a60f5688effa5287244a24768cbe0dcd854436090abc3bef172f7f5db1410af4277508dbafc4f70a754a891c90ce3b966a7bc47e7c1eb71ff57640f3d389" +} +``` + +Live Streaming chat message + +```json +{ + "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "created_at": 1687286726, + "kind": 1311, + "tags": [ + ["a", "30311:1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec:demo-cf-stream", "", "root"] + ], + "content": "Zaps to live streams is beautiful.", + "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" +} +```` + From 5f27121c98efe01f756ee8d316051913277b33c5 Mon Sep 17 00:00:00 2001 From: Believethehype Date: Sun, 9 Jul 2023 12:08:28 +0200 Subject: [PATCH 014/176] 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 2f9c064..e64a667 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -89,7 +89,7 @@ The output of processing the data -- published by the Service Provider. "kind": 68002, "tags" [ // stringified JSON request event - [ "request", "" ], + [ "request", "<68001-event-as-stringified JSON>" ], [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], @@ -115,6 +115,7 @@ This NIP defines some example job types, Customers SHOULD specify these types fo | param | req? | description |--------------------------------|------|-------- | `range` | opt | timestamp range (in seconds) of desired text to be transcribed +| `alignment` | opt | word, segment, raw : word-level, segment-level or raw outputs ### `summarization` | param | req? | description From 3a32c0fd781bb1b6e2d23eb83da9f0b56e4a233e Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 12:32:26 +0900 Subject: [PATCH 015/176] clarify case-sensitiveness of tag names --- 01.md | 2 +- 12.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 2ff81eb..686b2ee 100644 --- a/01.md +++ b/01.md @@ -107,7 +107,7 @@ A relay may choose to treat different message kinds differently, and it may or m ## Other Notes: - Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. +- The `tags` array can store a case-sensitive tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. - The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. - When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. diff --git a/12.md b/12.md index 74c9d81..7d1f46e 100644 --- a/12.md +++ b/12.md @@ -8,7 +8,7 @@ Generic Tag Queries Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. -The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. +The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. Note that tag names are case-sensitive. Example Subscription Filter --------------------------- From 52edccbbe380eeadb7622fc9eb255928dcff6178 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 12:45:16 +0900 Subject: [PATCH 016/176] standardize the terminology --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 686b2ee..4c2ccd9 100644 --- a/01.md +++ b/01.md @@ -107,7 +107,7 @@ A relay may choose to treat different message kinds differently, and it may or m ## Other Notes: - Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a case-sensitive tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. +- The `tags` array can store a case-sensitive tag name as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. - The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. - When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. From 20b22e7079282fd5403b6f11ea4ddc3f1beb8bfe Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 11:27:58 +0900 Subject: [PATCH 017/176] add NIP-53 to the list --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9893ffc..2a444c3 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) +- [NIP-53: Live Activities](53.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) @@ -87,6 +88,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | | `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `9734` | Zap Request | [57](57.md) | @@ -108,6 +110,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | +| `30311` | Live Event | [53](53.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | From 7cd861c4d3c7a28d6b0d4ee26ad2a36fdb2670a5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 10 Jul 2023 12:38:50 +0900 Subject: [PATCH 018/176] Update tag list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a444c3..c448df6 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | `description` | badge description | -- | [58](58.md) | | `description` | invoice description | -- | [57](57.md) | -| `emoji` | shortcode | image URL | [30](30.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | From a9dd5574531229df065eb9df2212bb7510db1f61 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 11 Jul 2023 15:22:30 +0200 Subject: [PATCH 019/176] 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 e64a667..0f0b003 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 020/176] more cleanup --- vending-machine.md | 57 +++++++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 0f0b003..8121ffc 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -27,19 +27,10 @@ A request to have data processed -- published by a customer "kind": 68001, "content": "", "tags": [ - // The type of data processing the user wants to be performed [ "j", "", "" ], - - // input(s) for the job request [ "i", "", "", "" ], - - // expected output format - [ "output", "mimetype" ], - - // relays where the job result should be published + [ "output", "" ], [ "relays", "wss://..."], - - // millisats amount that the user is offering to pay [ "bid", "", "" ], [ "exp", "" ], [ "p", "service-provider-1" ], @@ -94,7 +85,6 @@ The result of the job SHOULD be included in the `content` field. If the output i * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. * `amount`: millisats that the Service Provider is requesting to be paid. -## # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` @@ -127,7 +117,7 @@ Service Providers might opt to give feedback about a job. ### E.g. Payment required ```json { - "kind": 7, + "kind": 68003, "content": "Please pay 7 sats for job xxxx", "tags": [ [ "e", ], @@ -148,11 +138,6 @@ Service providers are at obvious risk of having their results not compensated. M It's out of scope (and undesirable) to have this NIP address this issue; the market should. -## Notes - -### Multitple job acceptance -* Nothing prevents a user from accepting multiple job results. - # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. @@ -162,7 +147,7 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar { "id": "12345", "pubkey": "abcdef", - "content": "I need a transcript of Bitcoin.review", + "content": "", "tags": [ [ "j", "speech-to-text" ], [ "i", "https://bitcoin.review/episode1.mp3", "url" ], @@ -173,13 +158,30 @@ It's out of scope (and undesirable) to have this NIP address this issue; the mar } ``` -### `kind:68002`: Job fulfillment +### `kind:68003`: Job Feedback: request for (partial) payment +```json +{ + "kind": 68003, + "content": "", + "tags": [ + ["e", "12345"], + ["p", "abcdef"], + ["status", "payment-required"], + ["amount", "1000"] + ] +} +``` + +* User zaps 1000 sats to event kind:68003. + +### `kind:68002`: Job fulfillment + request for remaining payment ```json { "content": "blah blah blah", "tags": [ ["e", "12345"], ["p", "abcdef"], + ["amount", "6000"] ] } ``` @@ -208,7 +210,7 @@ User publishes two job requests at the same time in the order they should be exe { "id": "12346", "pubkey": "abcdef", - "content": "I need a summarization", + "content": "", "tags": [ [ "j", "summarization" ], [ "params", "length", "3 paragraphs" ], @@ -227,13 +229,26 @@ User publishes two job requests at the same time in the order they should be exe "content": "", "tags": [ [ "j", "translation" ], - [ "i", "", "event" ] + [ "i", "", "event", "wss://relay.nostr.com" ] [ "params", "language", "es_AR" ], [ "bid", "100", "500" ] ] } ``` +### `kind:68003`: Job respomse +```json +{ + "kind": 68003, + "content": "Che, que copado, boludo!", + "tags": [ + ["e", "12346"], + ["p", "abcdef"], + ["amount", "1000"] + ] +} +``` + ## AI-image of the summarization of 2 podcasts ### `kind:68001`: Job request #1 (transcribe podcast #1) From a1cd2bd809c6e7476fe1e4dcab78f3a0df22f37d Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Thu, 6 Jul 2023 17:22:42 +0900 Subject: [PATCH 021/176] NIP-25 content might be NIP-30 custom emoji --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index f74bcc0..855f331 100644 --- a/25.md +++ b/25.md @@ -18,7 +18,7 @@ downvote or dislike on a post. A client MAY also choose to tally likes against dislikes in a reddit-like system of upvotes and downvotes, or display them as separate tallies. -The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike", +The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", or the client MAY display this emoji reaction on the post. Tags From 00ec0c83ace1353b297b60af6bf519cb2ea04f0e Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Tue, 11 Jul 2023 00:15:34 +0900 Subject: [PATCH 022/176] Add new section Custom Emoji Reaction --- 25.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/25.md b/25.md index 855f331..7a612a1 100644 --- a/25.md +++ b/25.md @@ -47,3 +47,25 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost ev.sign(privkey: privkey) return ev } +``` + +Custom Emoji Reaction +--------------------- + +The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode` in the +reaction content. The client should refer to the emoji tag and render the +content as an emoji if shortcode is specified. + +```json +{ + "kind": 7, + "content": ":soapbox:", + "tags": [ + ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682790000 +} +``` + +The content can be set only one `:shortcode:`. And emoji tag should be one. From ed32c93c9f17ddbfb855e94539a446ba37ec4db3 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 12 Jul 2023 12:38:43 +0900 Subject: [PATCH 023/176] Adjust NIP-14 title to other NIPs --- 14.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/14.md b/14.md index 0b37e8a..7384394 100644 --- a/14.md +++ b/14.md @@ -1,8 +1,8 @@ NIP-14 ====== -Subject tag in Text events. ---------------------------- +Subject tag in Text events +-------------------------- `draft` `optional` `author:unclebobmartin` diff --git a/README.md b/README.md index c448df6..71d0868 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-11: Relay Information Document](11.md) - [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) -- [NIP-14: Subject tag in text events.](14.md) +- [NIP-14: Subject tag in text events](14.md) - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) - [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) From f5a930c824bc0192e1161ebb1ae4e6c21ecb2f94 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 12 Jul 2023 18:37:51 +0900 Subject: [PATCH 024/176] Fix NIP-21 title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 71d0868..274868a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-20: Command Results](20.md) -- [NIP-21: `nostr:` URL scheme](21.md) +- [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) - [NIP-25: Reactions](25.md) From 1889ac792b7119ba9dc41fd4e904445ad1d9c6b5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 13 Jul 2023 12:34:04 +0900 Subject: [PATCH 025/176] Add k tag to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 274868a..6da74cd 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md) | | `i` | identity | proof | [39](39.md) | +| `k` | kind number (string) | -- | [18](18.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | From 0b08cf545b50b4799000e90aa4c5ada2cb73ca62 Mon Sep 17 00:00:00 2001 From: Yoji Shidara Date: Thu, 13 Jul 2023 14:14:36 +0900 Subject: [PATCH 026/176] Explicitly state that the `subscription_id` is treated per connection --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 4c2ccd9..8b1471d 100644 --- a/01.md +++ b/01.md @@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", , ...]`, used to request events and subscribe to new updates. * `["CLOSE", ]`, used to stop previous subscriptions. -`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. +`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. `` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From 451c06a3c572a13afe45c1d80616f8e6dd9bb1de Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Thu, 13 Jul 2023 15:14:19 +0200 Subject: [PATCH 027/176] Add initial draft for classifieds NIP --- 402.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 402.md diff --git a/402.md b/402.md new file mode 100644 index 0000000..c0eee14 --- /dev/null +++ b/402.md @@ -0,0 +1,71 @@ +# NIP-402 + +## Classifieds + +`draft` `optional` `author:erskingardner` + +This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful. + +The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) that often sell many units of specific products through very specific channels. + +The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events. + +### Draft / Inactive Listings + +`kind:30403` has the same structure as `kind:30402` and is used to save draft or inactive classified listings. + +### Content + +The `.content` field should be a description of what is being offered and by whom. These events should be a string in Markdown syntax. + +### Author + +The `.pubkey` field of these events are treated as the party creating the listing. + +### Metadata + +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md). + +The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. + +- `"title"`, a title for the listing +- `"summary"`, for short tagline or summary for the listing +- `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. +- `"location"`, for the location. +- `"price"`, for the price of the thing being listed. This is a free-form string. e.g. `€2,000/week` or `$22 per hour` or `$500` + +Other standard tags that might be useful. + +- `"g"`, a geohash for more precise location + +## Example Event + +```json +{ + "kind": 30402, + "created_at": 1675642635, + // Markdown content + "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.", + "tags": [ + ["d", "lorem-ipsum"], + ["title", "Lorem Ipsum"], + ["published_at", "1296962229"], + ["t", "electronics"], + ["summary", "More lorem ipsum that is a little more than the title"], + ["location", "NYC"], + ["price", "$100"], + [ + "e", + "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", + "wss://relay.example.com" + ], + [ + "a", + "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", + "wss://relay.nostr.org" + ] + ], + "pubkey": "...", + "id": "..." +} +``` From f065a40ee60d3b0f48f4f09e3daf12d6045cc0ae Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Fri, 14 Jul 2023 00:05:02 +0200 Subject: [PATCH 028/176] Add image tags and change format of the price tag. --- 402.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/402.md b/402.md index c0eee14..5e725c7 100644 --- a/402.md +++ b/402.md @@ -25,6 +25,7 @@ The `.pubkey` field of these events are treated as the party creating the listin ### Metadata - For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md). +- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](https://github.com/nostr-protocol/nips/blob/master/58.md). This allows clients to display images in carousel format more easily. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. @@ -32,7 +33,17 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"summary"`, for short tagline or summary for the listing - `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. - `"location"`, for the location. -- `"price"`, for the price of the thing being listed. This is a free-form string. e.g. `€2,000/week` or `$22 per hour` or `$500` +- `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. + - `"price"` is the name of the tag + - `""` is the amount in numeric format (but included in the tag as a string) + - `""` is the currency unit in 3-character ISO 4217 format. + - `""` is optional and can be used to describe recurring payments. + +#### `price` examples + +- $50 one-time payment `["price", "50", "USD", ""]` +- €15 per month `["price", "15", "EUR", "monthly"]` +- £50,000 per year `["price", "50000", "GBP", "yearly"]` Other standard tags that might be useful. @@ -51,9 +62,10 @@ Other standard tags that might be useful. ["title", "Lorem Ipsum"], ["published_at", "1296962229"], ["t", "electronics"], + ["image", "https://url.to.img", "256x256"], ["summary", "More lorem ipsum that is a little more than the title"], ["location", "NYC"], - ["price", "$100"], + ["price", "100", "USD"], [ "e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", From dd4caf9c4c88728d65dc76dd2adb3bf2bbe6b30e Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 14 Jul 2023 09:08:03 +0900 Subject: [PATCH 029/176] Fix typo --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index 7a612a1..86ce763 100644 --- a/25.md +++ b/25.md @@ -52,7 +52,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost Custom Emoji Reaction --------------------- -The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode` in the +The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the reaction content. The client should refer to the emoji tag and render the content as an emoji if shortcode is specified. From d1814405beac7a936fa0dedc08359d70b5a9ab48 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 17:31:08 +0900 Subject: [PATCH 030/176] add detailed description of since/until --- 01.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/01.md b/01.md index 8b1471d..01cfcc1 100644 --- a/01.md +++ b/01.md @@ -78,6 +78,8 @@ Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON ar The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. +The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. + All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions. A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. From e9924bdcde2dc516a891c027bd023f487b73a674 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sat, 15 Jul 2023 12:24:32 +0200 Subject: [PATCH 031/176] 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 8121ffc..1d08bd2 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -72,7 +72,7 @@ The output of processing the data -- published by the Service Provider. [ "e", "" ], [ "p", "" ], [ "status", "success", "" ], - [ "amount", "requested-payment-amount" ] + [ "amount", "requested-payment-amount", "" ] ] } ``` @@ -80,21 +80,27 @@ The output of processing the data -- published by the Service Provider. ## Job feedback Both customers and service providers can give feedback about a job. -The result of the job SHOULD be included in the `content` field. If the output is not text, the `content` field SHOULD be empty and an `output` tag should be used instead as described below. +The result of the job SHOULD be included in the `content` field. * `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: millisats that the Service Provider is requesting to be paid. +* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. # Protocol Flow * Customer publishes a job request `{ "kind": 68001, "tags": [ [ "j", "speech-to-text" ], ... ] }` +* Service Prpvoders can submit `kind:68003` job-feedback events (e.g. `payment-required`, `processing`, `unprocessable-entity`, etc.). +* Upon completion, the service provider publishes the result of the job with a `kind:68002` job-result event. +* Upon acceptance, the user zaps the service provider, tagging the job result event with a `kind:7` 👍 reaction. -* Service Providers subsribe to the type of jobs they can perform -`{"kinds":[68001], "#j": ["speech-to-text", "image-generation", ... ]}` +`kind:68002` and `kind:68003` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers +SHOULD use the `payment-required` feedback event to signal that a payment must be done before moving on to the next step. -* When a job comes in, the Service Providers who opt to attempt to fulfill the request begin processing it, or they can react to it with feedback for the user (e.g. _payment required_, _unprocessable entity_, etc.) -* Upon completion, the service provider publishes the result of the job with a `job-result` event. -* Upon acceptance, the user zaps the service provider, tagging the job result event. +## Notes about the protocol flow +The flow is deliverately left ambiguos, allowing vast flexibility for the interaction between customers and service providers so that +service providers can model their behavior based on their own decisions. Some service providers might choose to submit a `payment-required` +as the first reaction before sending an `processing` or before delivering `kind:68002` results, some might choose to serve partial results +for the job (e.g. as a sample), send a `payment-required`to deliver the rest of the results, and some service providers might choose to +assess likelyhood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. # Payment Customers SHOULD pay service providers whose job results they accept by zapping the Service Provider and tagging the `kind:68002` job result. @@ -131,7 +137,7 @@ Service Providers might opt to give feedback about a job. A user might choose to not accept a job result for any reason. A user can provide feedback via NIP-25 reactions. The `content` of the `kind:7` event SHOULD include a description of how the user reacted to the job result. -## Explicitly not addressed in this NIP +## Not addressed in this NIP ### Reputation system Service providers are at obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e. building reputation systems, requiring npub "balances", etc, etc). From 629c787d284c6bf27853f8b272888d86bd48d1dc Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Mon, 17 Jul 2023 12:34:24 +0200 Subject: [PATCH 032/176] Update for feedback on format of price array --- 402.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/402.md b/402.md index 5e725c7..e63e97a 100644 --- a/402.md +++ b/402.md @@ -37,13 +37,13 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - `""` is the currency unit in 3-character ISO 4217 format. - - `""` is optional and can be used to describe recurring payments. + - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples -- $50 one-time payment `["price", "50", "USD", ""]` -- €15 per month `["price", "15", "EUR", "monthly"]` -- £50,000 per year `["price", "50000", "GBP", "yearly"]` +- $50 one-time payment `["price", "50", "USD"]` +- €15 per month `["price", "15", "EUR", "month"]` +- £50,000 per year `["price", "50000", "GBP", "year"]` Other standard tags that might be useful. From 63718d6d89269819807b1e1c996d304f7aca64b0 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:20:32 +0200 Subject: [PATCH 033/176] Update price detail --- 402.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/402.md b/402.md index e63e97a..d5df924 100644 --- a/402.md +++ b/402.md @@ -36,7 +36,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - - `""` is the currency unit in 3-character ISO 4217 format. + - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. 'btc', 'eth'). - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples From b480624ac27e7083ed01c7f3d2157fddf7bd692a Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:22:56 +0200 Subject: [PATCH 034/176] Improve formatting --- 402.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/402.md b/402.md index d5df924..c316670 100644 --- a/402.md +++ b/402.md @@ -36,7 +36,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. 'btc', 'eth'). + - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples From b31d3077f6655f150cca9bb07f5fba895dc815ca Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Mon, 3 Jul 2023 01:23:47 -0400 Subject: [PATCH 035/176] Fix content field in example in NIP-56 Reporting to replace deprecated NIP-08 indexed mentions with NIP-27 bech32 mentions --- 56.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/56.md b/56.md index 42174fb..43b7bad 100644 --- a/56.md +++ b/56.md @@ -63,10 +63,9 @@ Example events { "kind": 1984, "tags": [ - ["p", , "impersonation"], - ["p", ] + ["p", , "impersonation"] ], - "content": "Profile is imitating #[1]", + "content": "Profile is impersonating nostr:", ... } ``` @@ -75,7 +74,7 @@ Client behavior --------------- Clients can use reports from friends to make moderation decisions if they -choose to. For instance, if 3+ of your friends report a profile as explicit, +choose to. For instance, if 3+ of your friends report a profile for `nudity`, clients can have an option to automatically blur photos from said account. From afcbef2bb0ad854adfc8dac8d04ba16fe8107115 Mon Sep 17 00:00:00 2001 From: William Casarin Date: Tue, 18 Jul 2023 08:44:29 -0700 Subject: [PATCH 036/176] nip23: add some formatting guidelines to maximize compatibility Link: https://groups.google.com/g/nostr-protocol/c/tnrcWTIAzdU --- 23.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/23.md b/23.md index 4291228..7a06b0e 100644 --- a/23.md +++ b/23.md @@ -12,7 +12,11 @@ This NIP defines `kind:30023` (a parameterized replaceable event according to [N ### Format -The `.content` of these events should be a string text in Markdown syntax. +The `.content` of these events should be a string text in Markdown syntax. To maximize compatibility and readability between different clients and devices, any client that is creating long form notes: + +- MUST NOT hard line-break paragraphs of text, such as arbitrary line breaks at 80 column boundaries. + +- MUST NOT support adding HTML to Markdown. ### Metadata From 859bd471fe22ce18bcf208581040fbfa3b06dee4 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 22:48:23 +0200 Subject: [PATCH 037/176] Update readme, change NIP number --- 402.md => 99.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) rename 402.md => 99.md (99%) diff --git a/402.md b/99.md similarity index 99% rename from 402.md rename to 99.md index c316670..e974a5e 100644 --- a/402.md +++ b/99.md @@ -1,4 +1,4 @@ -# NIP-402 +# NIP-99 ## Classifieds diff --git a/README.md b/README.md index 6da74cd..9ffff27 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) +- [NIP-99: Classified Listings](99.md) ## Event Kinds @@ -111,6 +112,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | +| `30402` | Classified Listing | [99](99.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | @@ -177,9 +179,11 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [99](99.md) | | `name` | badge name | -- | [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | From 8efa0e76b471593396690941f234c570830449e4 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 22:52:18 +0200 Subject: [PATCH 038/176] Update title --- 99.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/99.md b/99.md index e974a5e..274e5af 100644 --- a/99.md +++ b/99.md @@ -1,6 +1,6 @@ # NIP-99 -## Classifieds +## Classified Listings `draft` `optional` `author:erskingardner` From ad39e1f3ca5ff2e61b1fc718a680c304acd82fef Mon Sep 17 00:00:00 2001 From: William Casarin Date: Mon, 10 Jul 2023 08:40:58 -0700 Subject: [PATCH 039/176] readme: add mailing lists --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9ffff27..a09be5e 100644 --- a/README.md +++ b/README.md @@ -201,6 +201,21 @@ When experimenting with kinds, keep in mind the classification introduced by [NI 4. There should be no more than one way of doing the same thing. 5. Other rules will be made up when necessary. +## Mailing Lists + +The nostr ecosystem is getting large with many different organizations, relays +and clients. Following the nips repo on github is becoming more difficult and +noisy. To coordinate on protocol development outside of github, there are +mailing lists where you can work on NIPs before submitting them here: + +* [w3c nostr community group][w3-nostr] - [public-nostr@w3.org][mailto-w3] - requires signup +* [nostr-protocol google group][nostr-google-group] - [nostr-protocol@googlegroups.com][mailto-google] - no signup required + +[w3-nostr]: https://www.w3.org/community/nostr/ +[mailto-w3]: mailto:public-nostr@w3.org +[nostr-google-group]: https://groups.google.com/g/nostr-protocol +[mailto-google]: mailto:nostr-protocol@googlegroups.com + ## License All NIPs are public domain. From d0cb9d0c24ec9815b0668bffff246a19352b9ca2 Mon Sep 17 00:00:00 2001 From: erechorse <935horse@gmail.com> Date: Fri, 21 Jul 2023 00:48:55 +0900 Subject: [PATCH 040/176] Fix typos about inline code --- 56.md | 2 +- 57.md | 2 +- 65.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/56.md b/56.md index 43b7bad..a129926 100644 --- a/56.md +++ b/56.md @@ -10,7 +10,7 @@ Reporting A report is a `kind 1984` note that is used to report other notes for spam, illegal and explicit content. -The content MAY contain additional information submitted by the entity +The `content` MAY contain additional information submitted by the entity reporting the content. Tags diff --git a/57.md b/57.md index 438a0f8..95dba3b 100644 --- a/57.md +++ b/57.md @@ -126,7 +126,7 @@ When receiving a payment, the following steps are executed: The following should be true of the `zap receipt` event: -- The content SHOULD be empty. +- The `content` SHOULD be empty. - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. - `tags` MUST include the `p` tag AND optional `e` tag from the `zap request`. - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. diff --git a/65.md b/65.md index 4c7a6a5..55f9ff0 100644 --- a/65.md +++ b/65.md @@ -10,7 +10,7 @@ A special replaceable event meaning "Relay List Metadata" is defined as an event The primary purpose of this relay list is to advertise to others, not for configuring one's client. -The content is not used and SHOULD be an empty string. +The `content` is not used and SHOULD be an empty string. The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes. @@ -53,12 +53,12 @@ Authors may post events outside of the feed that they wish their followers to fo It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because - finding where someone posts is rather important - - these events do not have content that needs management + - these events do not have `content` that needs management - relays only need to store one replaceable event per pubkey to offer this service ### Why not in kind `0` Metadata -Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have content that may require moderation by relay operators so that it is more acceptable to relays. +Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have `content` that may require moderation by relay operators so that it is more acceptable to relays. ### Example From 2af496e363f58b1d8bd026e8920f62e6a843d134 Mon Sep 17 00:00:00 2001 From: benthecarman <15256660+benthecarman@users.noreply.github.com> Date: Fri, 21 Jul 2023 03:12:02 -0500 Subject: [PATCH 041/176] Fix event kind in example in NIP 53 --- 53.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/53.md b/53.md index 9a86d9e..c5f2704 100644 --- a/53.md +++ b/53.md @@ -71,7 +71,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t "created_at": "", "kind": 1311, "tags": [ - ["a", "34550::", "", "root"], + ["a", "30311::", "", "root"], ], "content": "Zaps to live streams is beautiful." } From b503f8a92b22be3037b8115fe3e644865a4fa155 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 19 Jul 2023 12:34:07 +0900 Subject: [PATCH 042/176] Clarify sort order when specified limit --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 01cfcc1..f607ca2 100644 --- a/01.md +++ b/01.md @@ -84,7 +84,7 @@ All conditions of a filter that are specified must match for an event for it to A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. -The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the latest `n` events. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. +The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. ### From relay to client: sending events and notices From 4a386e645ce38e666ef277f9a21c665ae00ae0ee Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sun, 23 Jul 2023 00:18:56 +0900 Subject: [PATCH 043/176] Add draft kinds to list --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a09be5e..1360190 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30017` | Create or update a stall | [15](15.md) | | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | | `30402` | Classified Listing | [99](99.md) | +| `30403` | Draft Classified Listing | [99](99.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | From 53bd97373b5442445f5c387945cf5685ac39ab80 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sun, 23 Jul 2023 21:28:59 +0200 Subject: [PATCH 044/176] 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 1d08bd2..4dbc5a3 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 045/176] wip --- vending-machine.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 4dbc5a3..4934d4c 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 046/176] more clarifications --- vending-machine.md | 68 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 16 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index 4934d4c..c4fdc18 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 047/176] clarifications, hopefully --- vending-machine.md | 192 ++++++++++++++++++++++----------------------- 1 file changed, 93 insertions(+), 99 deletions(-) diff --git a/vending-machine.md b/vending-machine.md index c4fdc18..276132d 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 048/176] 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 276132d..c41ccce 100644 --- a/vending-machine.md +++ b/vending-machine.md @@ -19,7 +19,7 @@ This NIP reserves the range `65000-66000` for data vending machine use. | 65001 | Job result | | 65002-66000 | Job request kinds | -[Appendix 2](#appendix-2-job-types) defines the job types. +[Appendix 2](#appendix-2-job-types) defines the job request types. ## Rationale Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data. @@ -32,19 +32,23 @@ There are two actors in the workflow described in this NIP: * Service providers (npubs who fulfill jobs) # Event Kinds + +* `kind:65000`: job feedback +* `kind:65001`: job result +* `kind:65002`-`kind:66000`: job requests + ## Job request -A request to have data processed, published by a customer +A request to have data processed, published by a customer. This event signals that an npub is interested in receiving the result of some kind of compute. ```json { - "kind": xxx, // kind in 65002-66000 range + "kind": 65xxx, // kind in 65002-66000 range "content": "", "tags": [ [ "i", "", "", "", "" ], [ "output", "" ], [ "relays", "wss://..."], [ "bid", "" ], - [ "exp", "" ], [ "t", "bitcoin" ] ] } @@ -52,24 +56,25 @@ A request to have data processed, published by a customer All tags are optional. -* `i` tag: Input data for the job (zero or more inputs may exist) +* `i` tag: Input data for the job (zero or more inputs) * ``: The argument for the input - * ``: The way this argument should be interpreted, MUST be one of: + * ``: The way this argument should be interpreted. MUST be one of: * `url`: A URL to be fetched - * `event`: A Nostr event ID, include an optional relay-url extra param + * `event`: A Nostr event ID. * `job`: The output of a previous job with the specified event ID * `text`: `` is the value of the input, no resolution is needed * ``: An optional field indicating how this input should be used within the context of the job * ``: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string -* `output`: MIME type. Expected output format. Service Providers SHOULD publish the result of the job in this format if it has been specified +* `output`: Expected output format. (e.g. MIME type) + * Service Providers MUST publish the result of the job in this format if it has been specified. + * Each job-type ([Appendix 2](#appendix-2-job-types)) might define the output format more narrowly. * `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay -* `relays`: Relays where Service Providers SHOULD publish responses to +* `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -* `exp`: Expiration timestamp. Service Providers SHOULD not send results after this timestamp ## Job result -The output of processing the data -- published by the Service Provider. +Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. ```json { @@ -79,28 +84,40 @@ The output of processing the data -- published by the Service Provider. "tags": [ [ "request", "" ], [ "e", "", "" ], - [ "p", "" ], + [ "p", "" ], [ "amount", "requested-payment-amount", "" ] ] } ``` -* `request` tag: The job request event ID. +* `request`: The job request event stringified-JSON. * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. ## Job feedback -Both customers and service providers can give feedback about a job. +Service providers can give feedback about a job back to the customer. -The result of the job SHOULD be included in the `content` field. +```json +{ + "kind": 65000, + "content": "", + "tags": [ + [ "status", "", "" ], + [ "amount", "requested-payment-amount", "" ], + [ "e", "", "" ], + [ "p", "" ], + ] +} +``` -* `status` tag: Service Providers MAY indicate errors or extra info about the results by including them in the `status` tag. -* `amount`: as defined in the [Job Result](#job-result) section. +* `content`: Either empty or a job-result (e.g. for partial-result samples) +* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 3](#appendix-3-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. +* `amount` tag: as defined in the [Job Result](#job-result) section. # Protocol Flow -* Customer publishes a job request (e.g. `kind:65002`). +* Customer publishes a job request (e.g. `kind:65002` speech-to-text). * Service Providers can submit `kind:65000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:65001` job-result event. -* At any point, the user can pay the included `bolt11` or zap any of the events the service provider has sent to the user. +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user `kind:65000` and `kind:65001` events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers SHOULD use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. @@ -137,16 +154,6 @@ Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcas } ``` -## Not addressed in this NIP - -### Reputation system -Service providers are at an obvious risk of having their results not compensated. Mitigation of this risk is up to service providers to figure out (i.e., building reputation systems, requiring npub "balances", etc.). It's out of scope (and undesirable) to have this NIP address this issue; the market should. - -### Encrypted job requests -Not to be included in the first draft of this NIP, but encrypted job requests should be added. A few ways: - * publish job requests with some useful metadata of the job "e.g., length of audio to be transcribed", service providers offer to do the job, the customer replies with a NIP-04-like encrypted job requested encrypted with the service provider's pubkey. - - # Appendix 1: Examples ## Transcript of a podcast from second `900` to `930`. @@ -316,7 +323,7 @@ User publishes event #1 and #2 together. [ "bid", "500000" ] ] } -`` +``` ## AI-image of embedded input @@ -364,6 +371,43 @@ This is a list of all the supported job requests. | `prompt` | opt | extra prompt to be used for the image generation | | `size` | opt | desired size of the image | +## event list generation: `kind:65006` + +Generates a list of event ids, (e.g. algorithmic feeds, spam-free notifications, trending topics) + +Output should be a stringified array of elements usually find in a nostr event' `tags`, e.g.: + +```json +{ "content": "[ + [\"e\", \"\"], + [\"a\", \"30023:pubkey:id\"], + [\"t\", \"tag\"], + [\"p\", \"pubkey\"], +]" } +``` + +| param | req? | description | +|-----------|------|-------------------------------------------------------| +| `filter` | opt | JSON-stringified `REQ`-like filter +| `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. +| `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. + +### example job-request + +Generate an algorithmic feed of the most interesting `kind:1`s related to the topic "bitcoin", tagging service providers specializing in safe-for-work content +that would interest pubkey `pubkey1`. + +```json +{ + "kind": 65006, + "tags": [ + [ "param", "filter", "{ \"kinds\": [1], \"#t\": [\"bitcoin\"] }" ], + [ "param", "p", "[\"pubkey1\"]"] + [ "bid", "5000" ], + [ "t", "sfw" ] + ] +} +``` # Appendix 3: Job feedback status From e58a40d2e7a1ea7a096b2d88919cd8cbf0daa219 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 25 Jul 2023 12:33:16 +0900 Subject: [PATCH 049/176] Minor JSON fix --- 56.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/56.md b/56.md index a129926..259118d 100644 --- a/56.md +++ b/56.md @@ -42,9 +42,9 @@ Example events { "kind": 1984, "tags": [ - ["p", , "nudity"] + ["p", , "nudity"], ["L", "social.nos.ontology"], - ["l", "NS-nud", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"] ], "content": "", ... From 948ee24775fe89e779efe7680ca6a27dc5a6207f Mon Sep 17 00:00:00 2001 From: pablof7z Date: Tue, 25 Jul 2023 17:20:24 +0300 Subject: [PATCH 050/176] 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 c41ccce..99f313d 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 9893ffc..ebfd359 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 051/176] remove duplicated output --- 90.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 99f313d..51c49cf 100644 --- a/90.md +++ b/90.md @@ -168,9 +168,8 @@ Consult [Appendix 1: Example](#appendix-1-examples)'s [Summarization of a podcas "tags": [ [ "i", "https://bitcoin.review/episode1.mp3", "url" ], [ "params", "range", "900", "930" ], - [ "output", "text/vtt" ], + [ "output", "text/plain" ], [ "bid", "50000" ], - [ "output", "text/plain" ] ] } ``` @@ -388,7 +387,7 @@ Output should be a stringified array of elements usually find in a nostr event' | param | req? | description | |-----------|------|-------------------------------------------------------| -| `filter` | opt | JSON-stringified `REQ`-like filter +| `filter` | opt | Stringified JSON `REQ` filter. Used to scope the desired results (e.g. specify the desired kinds) | `prompt` | opt | A human-readable description of the desired results. Which might be used with e.g. an LLM to tune the results. | `p` | opt | Array of pubkeys to generate a feed from someone else's point-of-view. This param allows for a client to choose to generate the feeds and incur the costs of its users. From 9e0be8467d9e803c5f0dd8da0d41a762502786df Mon Sep 17 00:00:00 2001 From: "Jesper L. Nielsen" Date: Wed, 26 Jul 2023 15:59:57 +0200 Subject: [PATCH 052/176] Update 01.md Spelling --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index f607ca2..50e9c9c 100644 --- a/01.md +++ b/01.md @@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", , ...]`, used to request events and subscribe to new updates. * `["CLOSE", ]`, used to stop previous subscriptions. -`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. +`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. `` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From b4cdc1a73d415c79c35655fa02f5e55cd1f2a60c Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sat, 10 Jun 2023 20:57:57 -0400 Subject: [PATCH 053/176] NIP-52: Calendar Events --- 52.md | 209 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 9 ++- 2 files changed, 216 insertions(+), 2 deletions(-) create mode 100644 52.md diff --git a/52.md b/52.md new file mode 100644 index 0000000..c601412 --- /dev/null +++ b/52.md @@ -0,0 +1,209 @@ +NIP-52 +====== + +Calendar Events +--------------- + +`draft` `optional` `author:tyiu` + +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are replaceable and referenceable per [NIP-33](33.md) and deletable per [NIP-09](09.md). + +Unlike the term `calendar event` specific to this NIP, the term `event` is used broadly in all the NIPs to describe any Nostr event. The distinction is being made here to discern between the two terms. + +## Calendar Events + +There are two types of calendar events represented by different kinds: date-based and time-based calendar events. Calendar events are not required to be part of a [calendar](#calendar). + +### Date-Based Calendar Event + +This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. + +#### Format + +The format uses a parameterized replaceable event kind `31922`. + +The `.content` of these events is optional and should be a detailed description of the calendar event. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `name` (required) name of the calendar event +* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. +* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. +* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31922", + "content": "", + "tags": [ + ["d", ""], + + ["name", ""], + + // Dates + ["start", ""], + ["end", ""], + + // Location + ["location", ""], + ["g", ""], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "", ""], + ["p", "<32-bytes hex of a pubkey>", "", ""], + + // Hashtags + ["t", ""], + ["t", ""], + + // Reference links + ["r", ""], + ["r", ""] + ] +} +``` + +### Time-Based Calendar Event + +This kind of calendar event spans between a start time and end time. + +#### Format + +The format uses a parameterized replaceable event kind `31923`. + +The `.content` of these events is optional and should be a detailed description of the calendar event. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `name` (required) name of the calendar event +* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. +* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. +* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` +* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. +* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call +* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location as suggested as an example by [NIP-12](12.md) +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31923", + "content": "", + "tags": [ + ["d", ""], + + ["name", ""], + + // Timestamps + ["start", ""], + ["end", ""], + + ["start_tzid", ""], + ["end_tzid", ""], + + // Location + ["location", ""], + ["g", ""], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "", ""], + ["p", "<32-bytes hex of a pubkey>", "", ""], + + // Hashtags + ["t", ""], + ["t", ""], + + // Reference links + ["r", ""], + ["r", ""] + ] +} +``` + +## Calendar + +A calendar is a collection of calendar events, represented as a custom replaceable list event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. + +### Format + +The format uses a custom replaceable list of kind `31924` with a list of tags as described below: +* `d` (required) calendar name +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) + +```json +{ + "kind": 31924, + "tags": [ + ["d", ""], + ["a", "<31922 or 31923>::", ""], + ["a", "<31922 or 31923>::", ""] + ] +} +``` + +## Calendar Event RSVP + +A calendar event RSVP is a response to a calendar event to indicate a user's attendance intention. + +If a calendar event tags a pubkey, that can be interpreted as the calendar event creator inviting that user to attend. Clients MAY choose to prompt the user to RSVP for the calendar event. + +Any user may RSVP, even if they were not tagged on the calendar event. Clients MAY choose to prompt the calendar event creator to invite the user who RSVP'd. Clients also MAY choose to ignore these RSVPs. + +This NIP is intentionally not defining who is authorized to attend a calendar event if the user who RSVP'd has not been tagged. It is up to the calendar event creator to determine the semantics. + +This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. + +### Format + +The format uses a parameterized replaceable event kind `31925`. + +The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. + +The list of tags are as follows: +* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) +* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. +* `L` (required) label namespace of `status` per [NIP-32](32.md) +* `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. +* `L` (optional) label namespace of `freebusy` per [NIP-32](32.md). Exists if and only if corresponding `l` tag under the same label namespace exists. +* `l` (optional) label of `free` or `busy` under the label namespace of `freebusy` per [NIP-32](32.md). Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. Exists if and only if corresponding `l` tag under the same label namespace exists. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31925", + "content": "", + "tags": [ + ["a", "<31922 or 31923>::", ""], + ["d", ""], + ["L", "status"], + ["l", "", "status"], + ["L", "freebusy"], + ["l", "", "freebusy"] + ] +} +``` + +## Unsolved Limitations + +* No private events + +## Intentionally Unsupported Scenarios + +### Recurring Calendar Events + +Recurring calendar events come with a lot of complexity, making it difficult for software and humans to deal with. This complexity includes time zone differences between invitees, daylight savings, leap years, multiple calendar systems, one-off changes in schedule or other metadata, etc. + +This NIP intentionally omits support for recurring calendar events and pushes that complexity up to clients to manually implement if they desire. i.e., individual calendar events with duplicated metadata represent recurring calendar events. diff --git a/README.md b/README.md index 1360190..ff12800 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) +- [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) @@ -115,6 +116,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30311` | Live Event | [53](53.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | +| `31922` | Date-Based Calendar Event | [52](52.md) | +| `31923` | Time-Based Calendar Event | [52](52.md) | +| `31924` | Calendar | [52](52.md) | +| `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | @@ -162,7 +167,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `alt` | Alt tag | -- | [31](31.md) | | `d` | identifier | -- | [33](33.md) | | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| `g` | geohash | -- | [12](12.md) | +| `g` | geohash | -- | [12](12.md), [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md) | | `l` | label, label namespace | annotations | [32](32.md) | @@ -181,7 +186,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [99](99.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | | `name` | badge name | -- | [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | From 064a79f6142326fa09cda411c15ceca997d37a03 Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Thu, 3 Aug 2023 14:40:45 -0500 Subject: [PATCH 054/176] NIP-48: Proxy Tags --- 48.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 62 insertions(+) create mode 100644 48.md diff --git a/48.md b/48.md new file mode 100644 index 0000000..8f22781 --- /dev/null +++ b/48.md @@ -0,0 +1,60 @@ +NIP-48 +====== + +Proxy Tags +---------- + +`draft` `optional` `author:alexgleason` + +Nostr events bridged from other protocols such as ActivityPub can link back to the source object by including a `"proxy"` tag, in the form: + +``` +["proxy", , ] +``` + +Where: + +- `` is the ID of the source object. The ID format varies depending on the protocol. The ID must be universally unique, regardless of the protocol. +- `` is the name of the protocol, e.g. `"activitypub"`. + +Clients may use this information to reconcile duplicated content bridged from other protocols, or to display a link to the source object. + +Proxy tags may be added to any event kind, and doing so indicates that the event did not originate on the Nostr protocol, and instead originated elsewhere on the web. + +### Supported protocols + +This list may be extended in the future. + +| Protocol | ID format | Example | +| -------- | --------- | ------- | +| `activitypub` | URL | `https://gleasonator.com/objects/9f524868-c1a0-4ee7-ad51-aaa23d68b526` | +| `atproto` | AT URI | `at://did:plc:zhbjlbmir5dganqhueg7y4i3/app.bsky.feed.post/3jt5hlibeol2i` | +| `rss` | URL with guid fragment | `https://soapbox.pub/rss/feed.xml#https%3A%2F%2Fsoapbox.pub%2Fblog%2Fmostr-fediverse-nostr-bridge` | +| `web` | URL | `https://twitter.com/jack/status/20` | + +### Examples + +ActivityPub object: + +```json +{ + "kind": 1, + "content": "I'm vegan btw", + "tags": [ + [ + "proxy", + "https://gleasonator.com/objects/8f6fac53-4f66-4c6e-ac7d-92e5e78c3e79", + "activitypub" + ] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1691091365, + "id": "55920b758b9c7b17854b6e3d44e6a02a83d1cb49e1227e75a30426dea94d4cb2", + "sig": "a72f12c08f18e85d98fb92ae89e2fe63e48b8864c5e10fbdd5335f3c9f936397a6b0a7350efe251f8168b1601d7012d4a6d0ee6eec958067cf22a14f5a5ea579" +} +``` + +### See also + +- [FEP-fffd: Proxy Objects](https://codeberg.org/fediverse/fep/src/branch/main/fep/fffd/fep-fffd.md) +- [Mostr bridge](https://mostr.pub/) \ No newline at end of file diff --git a/README.md b/README.md index ff12800..cfee37d 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) +- [NIP-48: Proxy Tags](48.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) @@ -191,6 +192,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | From 1912dacd33e69584e7f451e18a81bdc114ea9d76 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:35:23 -0400 Subject: [PATCH 055/176] Simple moderated communities flow. --- 172.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 172.md diff --git a/172.md b/172.md new file mode 100644 index 0000000..0cc8107 --- /dev/null +++ b/172.md @@ -0,0 +1,85 @@ +NIP-172 +======= + +Moderated Communities (Reddit Style) +------------------------------------ + +`draft` `optional` `author:vitorpamplona` + +The goal of this NIP is to create moderator-approved public communities arount a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into to the community, simply tag any Nostr event with an `a` tag. Moderators the issue an approval event `34551` that links the community with the new post. + +# Community definition + +Kind 34550 should include any field that helps define the community and the set of moderators. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "34550", + "tags": [ + ["d", ""], + ["description", ""], + + // moderators + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ] +} +``` + +# New Post Request + +Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "1", + "tags": [ + ["a", "34550::", ""], + ], + "content": "" +} +``` + +Community management clients can filter all mentions to the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at anytime. + +# Post Approval by moderators + +The post approval includes a stringified `new post request` event inside the content's of the approval (NIP-18-style). + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "34551", + "tags": [ + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], + ], + "content": "{ }" +} +``` + +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post approvals for the past post or the community will restart. + +# Displaying + +Community clients can display posts that have been approved by at least 1 moderator or by the community owner. + +The following filter displays the approved posts. + +```js +{ + "authors": ["", "moderator1", "moderator2", "moderator3", ...], + "kinds": 34551, + "#a": ["34550::"], +} +``` \ No newline at end of file From 7f4970bb10923aca7400448a093b4debb4b49267 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:38:20 -0400 Subject: [PATCH 056/176] Typos --- 172.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/172.md b/172.md index 0cc8107..542258a 100644 --- a/172.md +++ b/172.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` -The goal of this NIP is to create moderator-approved public communities arount a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into to the community, simply tag any Nostr event with an `a` tag. Moderators the issue an approval event `34551` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `34551` that links the community with the new post. # Community definition -Kind 34550 should include any field that helps define the community and the set of moderators. +Kind 34550 should include any field that helps define the community and the set of moderators. ```js { @@ -32,7 +32,7 @@ Kind 34550 should include any field that helps define the community and the set # New Post Request -Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. +Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. ```js { @@ -47,11 +47,11 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions to the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at anytime. +Community management clients can filter all mentions of the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. # Post Approval by moderators -The post approval includes a stringified `new post request` event inside the content's of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the content of the approval (NIP-18-style). ```js { @@ -68,13 +68,13 @@ The post approval includes a stringified `new post request` event inside the con } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post approvals for the past post or the community will restart. +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post-approvals for posts in the past or the community will restart. # Displaying -Community clients can display posts that have been approved by at least 1 moderator or by the community owner. +Community clients can display posts that have been approved by at least 1 moderator or by the community owner. -The following filter displays the approved posts. +The following filter displays the approved posts. ```js { From 6fbe488504729b4da4231f55097a144d9bbaa4a7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:40:19 -0400 Subject: [PATCH 057/176] Fixing indentation --- 172.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/172.md b/172.md index 542258a..9aa59e2 100644 --- a/172.md +++ b/172.md @@ -20,12 +20,12 @@ Kind 34550 should include any field that helps define the community and the set "kind": "34550", "tags": [ ["d", ""], - ["description", ""], + ["description", ""], // moderators ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] ] } ``` @@ -61,8 +61,8 @@ The post-approval event includes a stringified `new post request` event inside t "kind": "34551", "tags": [ ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], + ["e", "", ""], + ["p", "", ""], ], "content": "{ }" } From bf84e733f3ad870ffd4516c6dfb60069997923be Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 13 Jun 2023 10:34:34 -0400 Subject: [PATCH 058/176] Adds preferred relay information to tags. --- 172.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/172.md b/172.md index 9aa59e2..1ca8b17 100644 --- a/172.md +++ b/172.md @@ -21,11 +21,19 @@ Kind 34550 should include any field that helps define the community and the set "tags": [ ["d", ""], ["description", ""], + ["image", "", "WidthxHeight"] + + //.. other tags relevant to defining the community // moderators - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + + // relays used by the community + ["relay", "", "author"], + ["relay", ""], + ["relay", ""] ] } ``` @@ -51,7 +59,7 @@ Community management clients can filter all mentions of the kind-34550 event and # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the content of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the `.content` of the approval (NIP-18-style). ```js { From 4e61eb4e468a071c7d1efc8d0df6df06f65d5926 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 13 Jun 2023 15:52:41 -0400 Subject: [PATCH 059/176] Update 172.md Adds kind to the post approval. Co-authored-by: arthurfranca --- 172.md | 1 + 1 file changed, 1 insertion(+) diff --git a/172.md b/172.md index 1ca8b17..4689165 100644 --- a/172.md +++ b/172.md @@ -71,6 +71,7 @@ The post-approval event includes a stringified `new post request` event inside t ["a", "34550::", ""], ["e", "", ""], ["p", "", ""], + ["k", ""], ], "content": "{ }" } From 0c3df0ee30ca2a6eff842d7f851fd022e055a030 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:30 -0400 Subject: [PATCH 060/176] Removes quotes from kind Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4689165..330fd1a 100644 --- a/172.md +++ b/172.md @@ -17,7 +17,7 @@ Kind 34550 should include any field that helps define the community and the set "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "34550", + "kind": 34550, "tags": [ ["d", ""], ["description", ""], From 856ed84776b0b98b1e40d3776c8e65cc0c62957f Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:48 -0400 Subject: [PATCH 061/176] Fix typos in community image Co-authored-by: arthurfranca --- 172.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/172.md b/172.md index 330fd1a..92cd52c 100644 --- a/172.md +++ b/172.md @@ -21,9 +21,9 @@ Kind 34550 should include any field that helps define the community and the set "tags": [ ["d", ""], ["description", ""], - ["image", "", "WidthxHeight"] + ["image", "", "WidthxHeight"], - //.. other tags relevant to defining the community + //.. other tags relevant to defining the community // moderators ["p", "<32-bytes hex of a pubkey>", "", "moderator"], From 4c7b728be18c8cd934a879d888c04c85ac852687 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:56 -0400 Subject: [PATCH 062/176] Fix formatting Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 92cd52c..6a89a53 100644 --- a/172.md +++ b/172.md @@ -30,7 +30,7 @@ Kind 34550 should include any field that helps define the community and the set ["p", "<32-bytes hex of a pubkey>", "", "moderator"], ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - // relays used by the community + // relays used by the community ["relay", "", "author"], ["relay", ""], ["relay", ""] From 3ff40201bdeae142be249c13a4c1983c18aabf84 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:39:32 -0400 Subject: [PATCH 063/176] Fixes double-quoted kind number Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 6a89a53..9f5fab5 100644 --- a/172.md +++ b/172.md @@ -47,7 +47,7 @@ Any Nostr event can be a post request. Clients should simply add the community's "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "1", + "kind": 1, "tags": [ ["a", "34550::", ""], ], From c07b5fa9b03dc4ce4f68140e3a57ceafcf5b95b3 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:46:24 -0400 Subject: [PATCH 064/176] Moves post approval to a regular (non-replaceable event) --- 172.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/172.md b/172.md index 9f5fab5..4a9f5a9 100644 --- a/172.md +++ b/172.md @@ -6,7 +6,7 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `34551` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. # Community definition @@ -66,7 +66,7 @@ The post-approval event includes a stringified `new post request` event inside t "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "34551", + "kind": "4550", "tags": [ ["a", "34550::", ""], ["e", "", ""], @@ -77,7 +77,7 @@ The post-approval event includes a stringified `new post request` event inside t } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post-approvals for posts in the past or the community will restart. +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copies of each moderator's approval events. # Displaying @@ -88,7 +88,7 @@ The following filter displays the approved posts. ```js { "authors": ["", "moderator1", "moderator2", "moderator3", ...], - "kinds": 34551, + "kinds": ["4550"], "#a": ["34550::"], } ``` \ No newline at end of file From 2b53049c1a69c413de1b3077a94a49810a2e0aff Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:50:06 -0400 Subject: [PATCH 065/176] Adds arthurfranca as author --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4a9f5a9..ec6a60b 100644 --- a/172.md +++ b/172.md @@ -4,7 +4,7 @@ NIP-172 Moderated Communities (Reddit Style) ------------------------------------ -`draft` `optional` `author:vitorpamplona` +`draft` `optional` `author:vitorpamplona` `author:arthurfranca` The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. From 63441099be5898afc685bb2be28c2b30b2f27fc2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:53:55 -0400 Subject: [PATCH 066/176] Fixes typos & clarifies the text. --- 172.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/172.md b/172.md index ec6a60b..df78081 100644 --- a/172.md +++ b/172.md @@ -77,7 +77,7 @@ The post-approval event includes a stringified `new post request` event inside t } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copies of each moderator's approval events. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. # Displaying @@ -88,7 +88,7 @@ The following filter displays the approved posts. ```js { "authors": ["", "moderator1", "moderator2", "moderator3", ...], - "kinds": ["4550"], + "kinds": [4550], "#a": ["34550::"], } ``` \ No newline at end of file From 3a01861adeaf527f160e73b892b383a2c81a5c66 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:03:07 -0400 Subject: [PATCH 067/176] Adds references to other NIPs with more information and standardizes citations to event kinds --- 172.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/172.md b/172.md index df78081..0c48ea3 100644 --- a/172.md +++ b/172.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` `author:arthurfranca` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. # Community definition -Kind 34550 should include any field that helps define the community and the set of moderators. +`Kind:34550` should include any field that helps define the community and the set of moderators. ```js { @@ -19,16 +19,16 @@ Kind 34550 should include any field that helps define the community and the set "created_at": "", "kind": 34550, "tags": [ - ["d", ""], - ["description", ""], - ["image", "", "WidthxHeight"], + ["d", ""], + ["description", ""], + ["image", "", "x"], //.. other tags relevant to defining the community // moderators - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey1>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], // relays used by the community ["relay", "", "author"], @@ -49,17 +49,17 @@ Any Nostr event can be a post request. Clients should simply add the community's "created_at": "", "kind": 1, "tags": [ - ["a", "34550::", ""], + ["a", "34550::", ""], ], - "content": "" + "content": "" } ``` -Community management clients can filter all mentions of the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. +Community management clients can filter all mentions of the `kind:34550` event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the `.content` of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). ```js { @@ -68,12 +68,12 @@ The post-approval event includes a stringified `new post request` event inside t "created_at": "", "kind": "4550", "tags": [ - ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], ["k", ""], ], - "content": "{ }" + "content": "" } ``` @@ -87,8 +87,8 @@ The following filter displays the approved posts. ```js { - "authors": ["", "moderator1", "moderator2", "moderator3", ...], + "authors": ["", "", "", "", ...], "kinds": [4550], - "#a": ["34550::"], + "#a": ["34550::"], } ``` \ No newline at end of file From d42fc18fa5800399690d82acfe34606e26419b8d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:05:35 -0400 Subject: [PATCH 068/176] Addressing how to unapprove a post. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 0c48ea3..87ae424 100644 --- a/172.md +++ b/172.md @@ -55,7 +55,7 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions of the `kind:34550` event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. +Community management clients can filter all mentions to a given `kind:34550` event and request moderators to approve each submission. The same moderator can delete his/her approval of the post at any time using event deletions (See [NIP-09](09.md)). # Post Approval by moderators From 135a2f533890b77d3df1deca3fbe09ae47265723 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:13:09 -0400 Subject: [PATCH 069/176] Rewriting to use specification verbs SHOULD, MAY, etc --- 172.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/172.md b/172.md index 87ae424..123eaef 100644 --- a/172.md +++ b/172.md @@ -8,9 +8,9 @@ Moderated Communities (Reddit Style) The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. -# Community definition +# Community Definition -`Kind:34550` should include any field that helps define the community and the set of moderators. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. ```js { @@ -19,9 +19,9 @@ The goal of this NIP is to create moderator-approved public communities around a "created_at": "", "kind": 34550, "tags": [ - ["d", ""], - ["description", ""], - ["image", "", "x"], + ["d", ""], + ["description", ""], + ["image", "", "x"], //.. other tags relevant to defining the community @@ -40,7 +40,7 @@ The goal of this NIP is to create moderator-approved public communities around a # New Post Request -Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. +Any Nostr event can be a post request. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. ```js { @@ -55,11 +55,11 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions to a given `kind:34550` event and request moderators to approve each submission. The same moderator can delete his/her approval of the post at any time using event deletions (See [NIP-09](09.md)). +Community management clients MAY filter all mentions to a given `kind:34550` event and request moderators to approve each submission. Moderators MAY delete his/her approval of a post at any time using event deletions (See [NIP-09](09.md)). # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). +The post-approval event SHOULD include a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). ```js { @@ -81,14 +81,16 @@ It's recommended that multiple moderators approve posts to avoid deleting them f # Displaying -Community clients can display posts that have been approved by at least 1 moderator or by the community owner. +Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. The following filter displays the approved posts. ```js { - "authors": ["", "", "", "", ...], + "authors": ["", "", "", "", ...], "kinds": [4550], "#a": ["34550::"], } -``` \ No newline at end of file +``` + +Clients MAY hide approvals by blocked moderators at the user's request. \ No newline at end of file From 73f2f24bbfb3a7b4fc16f9bbc96b58a7b0ab9410 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:20:11 -0400 Subject: [PATCH 070/176] Better describes the use of `a`, `e` and `p` tags in the post approval event. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 123eaef..84a88c9 100644 --- a/172.md +++ b/172.md @@ -59,7 +59,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve # Post Approval by moderators -The post-approval event SHOULD include a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). +The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notificaitons). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. ```js { From f8aa3f4e514dbe1688d269e71b1d5c6afad4c8c8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:24:48 -0400 Subject: [PATCH 071/176] Allows replaceable events to be part of communities as well. --- 172.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/172.md b/172.md index 84a88c9..d2b7a53 100644 --- a/172.md +++ b/172.md @@ -79,6 +79,10 @@ The post-approval event MUST include `a` tags of the communities the moderator i It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. +Replaceable events can be submitted for approval in two ways: (i) by their `e` tag if moderators want to approve each individual change to the repleceable event or (ii) by the `a` tag if the moderator trusts the original post author to not modify the event beyond community rules. + +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. + # Displaying Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. From 7957880b48c7a56687364d9325e28c17e1ed9ca2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 19 Jun 2023 15:07:40 -0400 Subject: [PATCH 072/176] Adds relay markers --- 172.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/172.md b/172.md index d2b7a53..28c3612 100644 --- a/172.md +++ b/172.md @@ -10,7 +10,7 @@ The goal of this NIP is to create moderator-approved public communities around a # Community Definition -`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. ```js { @@ -30,9 +30,10 @@ The goal of this NIP is to create moderator-approved public communities around a ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], - // relays used by the community + // relays used by the community (w/optional marker) ["relay", "", "author"], - ["relay", ""], + ["relay", "", "requests"], + ["relay", "", "approvals"], ["relay", ""] ] } From 507b0c20a52e4288d4ebaa9df0c4e12b89835172 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 7 Jul 2023 14:16:20 -0400 Subject: [PATCH 073/176] added a third option to approve replaceable events. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 28c3612..3535039 100644 --- a/172.md +++ b/172.md @@ -80,7 +80,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. -Replaceable events can be submitted for approval in two ways: (i) by their `e` tag if moderators want to approve each individual change to the repleceable event or (ii) by the `a` tag if the moderator trusts the original post author to not modify the event beyond community rules. +Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. From 892fe9e4004dbb515d71729b92d0432665f8e823 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 8 Aug 2023 13:31:54 -0300 Subject: [PATCH 074/176] move 172 to 72 and update indexes. --- 172.md => 72.md | 36 ++++++++++++++++++------------------ README.md | 6 +++++- 2 files changed, 23 insertions(+), 19 deletions(-) rename 172.md => 72.md (93%) diff --git a/172.md b/72.md similarity index 93% rename from 172.md rename to 72.md index 3535039..750b076 100644 --- a/172.md +++ b/72.md @@ -1,5 +1,5 @@ -NIP-172 -======= +NIP-72 +====== Moderated Communities (Reddit Style) ------------------------------------ @@ -10,29 +10,29 @@ The goal of this NIP is to create moderator-approved public communities around a # Community Definition -`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", + "created_at": , "kind": 34550, "tags": [ ["d", ""], ["description", ""], ["image", "", "x"], - + //.. other tags relevant to defining the community // moderators ["p", "<32-bytes hex of a pubkey1>", "", "moderator"], ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], - + // relays used by the community (w/optional marker) ["relay", "", "author"], - ["relay", "", "requests"], + ["relay", "", "requests"], ["relay", "", "approvals"], ["relay", ""] ] @@ -43,15 +43,15 @@ The goal of this NIP is to create moderator-approved public communities around a Any Nostr event can be a post request. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", + "created_at": , "kind": 1, "tags": [ ["a", "34550::", ""], - ], + ], "content": "" } ``` @@ -62,27 +62,27 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notificaitons). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", - "kind": "4550", + "created_at": , + "kind": 4550, "tags": [ ["a", "34550::", ""], ["e", "", ""], ["p", "", ""], ["k", ""], - ], + ], "content": "" } ``` -It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. -Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. # Displaying @@ -98,4 +98,4 @@ The following filter displays the approved posts. } ``` -Clients MAY hide approvals by blocked moderators at the user's request. \ No newline at end of file +Clients MAY hide approvals by blocked moderators at the user's request. diff --git a/README.md b/README.md index cfee37d..3c35ef3 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-72: Moderated Communities](72.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) @@ -94,6 +95,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1311` | Live Chat Message | [53](53.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | +| `4550` | Community Post Approval | [72](72.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -123,6 +125,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `34550` | Community Definition | [72](72.md) | + ### Event Kind Ranges @@ -170,7 +174,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md), [52](52.md) | | `i` | identity | proof | [39](39.md) | -| `k` | kind number (string) | -- | [18](18.md) | +| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | From 77b626d74871fb195dfd7b211a75af97753333dd Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Wed, 9 Aug 2023 00:55:21 +0200 Subject: [PATCH 075/176] nips over nostr --- 17.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 17.md diff --git a/17.md b/17.md new file mode 100644 index 0000000..6b5f3fc --- /dev/null +++ b/17.md @@ -0,0 +1,26 @@ +# NIPs over Nostr + +`draft` `optional` `author:Semisol` + +This NIP defines a method to do NIPs over Nostr. + +## NIP event + +A NIP event is an event with kind 9777. The content is in Markdown and is the NIP text. + +A NIP event can be identified in multiple ways: +- `50001::`: Represents the NIP. +- `!50001::@:`: Represents a specific version of this NIP. The ID may be omitted. + +The following tags may be in a NIP event (bold ones are mandatory, and underlined ones may be used more than once): +- **`d`**: A distinguishing tag for this NIP. A NIP event is identified by the author's public key and this d tag. +- **`v`**: The version for this NIP, as a limited subset of SemVer in the format `major.minor.patch`. + - More than one event can exist for the same version of a NIP. This is intended for minor edits, and if this is encountered, the event with the higher created_at is used, + and this SHOULD be avoided when possible. +- **__`p`__**: An author or contributor of this NIP. The parameter after the public key can be specified the type of contribution (more may be added): + - `author`: An author of this NIP. + - `contrib`: Someone that contributed to this NIP. +- __`D`__: Depends on tag, in the format `["D", "50001::", "@"]`. The ID may not be omitted. +- __`E`__: Extends tag, in the same format as the `D` tag. +- __`K`__: A kind or kind range this NIP uses, such as `0` or `10000-19999`. +- __**`license`**__: A license for this NIP as an SPDX license identifier. Multiple tags mean any can be chosen by the user. From ce7e6b2100918648ec4341c5fe517d076e8d225c Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Wed, 9 Aug 2023 00:56:48 +0200 Subject: [PATCH 076/176] wrong branch --- 17.md | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 17.md diff --git a/17.md b/17.md deleted file mode 100644 index 6b5f3fc..0000000 --- a/17.md +++ /dev/null @@ -1,26 +0,0 @@ -# NIPs over Nostr - -`draft` `optional` `author:Semisol` - -This NIP defines a method to do NIPs over Nostr. - -## NIP event - -A NIP event is an event with kind 9777. The content is in Markdown and is the NIP text. - -A NIP event can be identified in multiple ways: -- `50001::`: Represents the NIP. -- `!50001::@:`: Represents a specific version of this NIP. The ID may be omitted. - -The following tags may be in a NIP event (bold ones are mandatory, and underlined ones may be used more than once): -- **`d`**: A distinguishing tag for this NIP. A NIP event is identified by the author's public key and this d tag. -- **`v`**: The version for this NIP, as a limited subset of SemVer in the format `major.minor.patch`. - - More than one event can exist for the same version of a NIP. This is intended for minor edits, and if this is encountered, the event with the higher created_at is used, - and this SHOULD be avoided when possible. -- **__`p`__**: An author or contributor of this NIP. The parameter after the public key can be specified the type of contribution (more may be added): - - `author`: An author of this NIP. - - `contrib`: Someone that contributed to this NIP. -- __`D`__: Depends on tag, in the format `["D", "50001::", "@"]`. The ID may not be omitted. -- __`E`__: Extends tag, in the same format as the `D` tag. -- __`K`__: A kind or kind range this NIP uses, such as `0` or `10000-19999`. -- __**`license`**__: A license for this NIP as an SPDX license identifier. Multiple tags mean any can be chosen by the user. From f91cb5ce665fa404b3a5e00c9f49f555d7a3855b Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Thu, 10 Aug 2023 01:34:49 +0900 Subject: [PATCH 077/176] fix typos --- 72.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/72.md b/72.md index 750b076..f4bebf4 100644 --- a/72.md +++ b/72.md @@ -60,7 +60,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve # Post Approval by moderators -The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notificaitons). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. +The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. ```json { @@ -78,7 +78,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i } ``` -It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. From e5a6c2c698bcfca4d9d135343fabf8846214314a Mon Sep 17 00:00:00 2001 From: ktecho Date: Thu, 10 Aug 2023 00:16:35 +0200 Subject: [PATCH 078/176] Adding (optional) shipping costs per product to nip-15 --- 15.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/15.md b/15.md index f8df328..bd0f0db 100644 --- a/15.md +++ b/15.md @@ -8,7 +8,7 @@ Nostr Marketplace (for resilient marketplaces) > Based on https://github.com/lnbits/Diagon-Alley -> Implemented here https://github.com/lnbits/nostrmarket +> Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market) ## Terms @@ -54,7 +54,7 @@ A merchant can publish these events: { "id": , "name": , - "cost": , + "cost": , "countries": [], } ] @@ -63,9 +63,12 @@ A merchant can publish these events: Fields that are not self-explanatory: - `shipping`: - - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone. + - an array with possible shipping zones for this stall. + - the customer MUST choose exactly one of those shipping zones. - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero. - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection. + - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per + product can also be specified if the shipping cost for that product is higher than what's specified by the base cost. **Event Tags**: ```json @@ -87,17 +90,30 @@ Fields that are not self-explanatory: "price": , "quantity": , "specs": [ - [ , ] - ] + [, ] + ], + "shipping": [ + { + "id": , + "cost": , + } + ] } ``` Fields that are not self-explanatory: - `specs`: - - an array of key pair values. It allows for the Customer UI to present present product specifications in a structure mode. It also allows comparison between products + - an optional array of key pair values. It allows for the Customer UI to present product specifications in a structure mode. It also allows comparison between products - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` -_Open_: better to move `spec` in the `tags` section of the event? + _Open_: better to move `spec` in the `tags` section of the event? + +- `shipping`: + - an _optional_ array of costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall + - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: + - the `base cost from the stall` for the chosen shipping option + - the result of multiplying the product units by the `shipping costs specified in the product`, if any. **Event Tags**: ```json @@ -211,4 +227,4 @@ Customer support is handled over whatever communication method was specified. If ## Additional -Standard data models can be found here here +Standard data models can be found here From b7faf8a4fec78d3504989117944b77a893a56d32 Mon Sep 17 00:00:00 2001 From: ktecho Date: Thu, 10 Aug 2023 16:17:45 +0200 Subject: [PATCH 079/176] Fix copy/paste --- 15.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/15.md b/15.md index bd0f0db..2601559 100644 --- a/15.md +++ b/15.md @@ -95,7 +95,7 @@ Fields that are not self-explanatory: "shipping": [ { "id": , - "cost": , + "cost": , } ] } @@ -109,7 +109,7 @@ Fields that are not self-explanatory: _Open_: better to move `spec` in the `tags` section of the event? - `shipping`: - - an _optional_ array of costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - an _optional_ array of extra costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: - the `base cost from the stall` for the chosen shipping option From d87f86178b2178c2cb171af8a4e042bdffe4b1fe Mon Sep 17 00:00:00 2001 From: benthecarman Date: Thu, 10 Aug 2023 15:48:53 -0500 Subject: [PATCH 080/176] NIP-25: Handle empty string as + --- 25.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/25.md b/25.md index 86ce763..63c07a7 100644 --- a/25.md +++ b/25.md @@ -19,7 +19,8 @@ dislikes in a reddit-like system of upvotes and downvotes, or display them as separate tallies. The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", -or the client MAY display this emoji reaction on the post. +or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should +consider it a "+". Tags ---- From a5047326d4d7c28e66c5d1262c252b86a1c8fe67 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 11 Aug 2023 06:12:50 -0400 Subject: [PATCH 081/176] Simplifies NIP-65 (#700) Co-authored-by: fiatjaf_ Co-authored-by: Jon Staab --- 65.md | 93 +++++++++++++++++++++++++---------------------------------- 1 file changed, 39 insertions(+), 54 deletions(-) diff --git a/65.md b/65.md index 55f9ff0..3c06438 100644 --- a/65.md +++ b/65.md @@ -4,63 +4,13 @@ NIP-65 Relay List Metadata ------------------- -`draft` `optional` `author:mikedilger` +`draft` `optional` `author:mikedilger` `author:vitorpamplona` -A special replaceable event meaning "Relay List Metadata" is defined as an event with kind `10002` having a list of `r` tags, one for each relay the author uses to either read or write to. +Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. -The primary purpose of this relay list is to advertise to others, not for configuring one's client. +The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. If the marker is omitted, the relay is used for both purposes. -The `content` is not used and SHOULD be an empty string. - -The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes. - -Clients SHOULD, as with all replaceable events, use only the most recent kind-10002 event they can find. - -### The meaning of read and write - -Write relays are for events that are intended for anybody (e.g. your followers). Read relays are for events that address a particular person. - -Clients SHOULD write feed-related events created by their user to their user's write relays. - -Clients SHOULD read feed-related events created by another from at least some of that other person's write relays. Explicitly, they SHOULD NOT expect them to be available at their user's read relays. It SHOULD NOT be presumed that the user's read relays coincide with the write relays of the people the user follows. - -Clients SHOULD read events that tag their user from their user's read relays. - -Clients SHOULD write events that tag a person to at least some of that person's read relays. Explicitly, they SHOULD NOT expect that person will pick them up from their user's write relays. It SHOULD NOT be presumed that the user's write relays coincide with the read relays of the person being tagged. - -Clients SHOULD presume that if their user has a pubkey in their ContactList (kind 3) that it is because they wish to see that author's feed-related events. But clients MAY presume otherwise. - -### Motivation - -There is a common nostr use case where users wish to follow the content produced by other users. This is evidenced by the implicit meaning of the Contact List in [NIP-02](02.md) - -Because users don't often share the same sets of relays, ad-hoc solutions have arisen to get that content, but these solutions negatively impact scalability and decentralization: - - - Most people are sending their posts to the same most popular relays in order to be more widely seen - - Many people are pulling from a large number of relays (including many duplicate events) in order to get more data - - Events are being copied between relays, oftentimes to many different relays - -### Purposes - -The purpose of this NIP is to help clients find the events of the people they follow, to help tagged events get to the people tagged, and to help nostr scale better. - -### Suggestions - -It is suggested that people spread their kind `10002` events to many relays, but write their normal feed-related events to a much smaller number of relays (between 2 to 6 relays). It is suggested that clients offer a way for users to spread their kind `10002` events to many more relays than they normally post to. - -Authors may post events outside of the feed that they wish their followers to follow by posting them to relays outside of those listed in their "Relay List Metadata". For example, an author may want to reply to someone without all of their followers watching. - -It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because - - - finding where someone posts is rather important - - these events do not have `content` that needs management - - relays only need to store one replaceable event per pubkey to offer this service - -### Why not in kind `0` Metadata - -Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have `content` that may require moderation by relay operators so that it is more acceptable to relays. - -### Example +The `.content` is not used. ```json { @@ -74,3 +24,38 @@ Even though this is user related metadata, it is a separate event from kind `0` "content": "", ...other fields ``` + +This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. + +## When to Use Read and Write + +When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` + +When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002` + +When broadcasting an event, Clients SHOULD: + +- Broadcast the event to the WRITE relays of the author +- Broadcast the event all READ relays of each tagged user. + +## Motivation + +The old model of using a fixed relay list per user centralizes in large relay operators: + + - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience. + - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication + - Events are being copied between relays, oftentimes to many different relays + +This NIP allows Clients to connect directly with the most up-to-date relay set from each individual user, eliminating the need of broadcasting events to popular relays. + +## Final Considerations + +1. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays). + +2. Clients SHOULD spread an author's `kind:10002` events to as many relays as viable. + +3. `kind:10002` events should primarily be used to advertise the user's preferred relays to others. A user's own client may use other heuristics for selecting relays for fetching data. + +4. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy. + +5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. From 72bb8a128b2d7d3c2c654644cd68d0d0fe58a3b1 Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Sun, 13 Aug 2023 13:47:45 -0300 Subject: [PATCH 082/176] merge nips 12, 16, 20 and 33 into nip 01 (#703) Co-authored-by: Viktor Vsk --- 01.md | 102 ++++++++++++++++++++++++++++++++++++++---------------- 11.md | 13 ++++--- 12.md | 37 ++------------------ 13.md | 2 +- 15.md | 24 ++++++------- 16.md | 35 ++----------------- 19.md | 2 +- 20.md | 88 ++-------------------------------------------- 22.md | 6 ++-- 23.md | 8 ++--- 33.md | 50 ++------------------------ 51.md | 8 ++--- 52.md | 6 ++-- 53.md | 19 +++++----- 58.md | 10 ++---- 72.md | 2 +- README.md | 47 +++++++++---------------- 17 files changed, 141 insertions(+), 318 deletions(-) diff --git a/01.md b/01.md index 50e9c9c..4b33975 100644 --- a/01.md +++ b/01.md @@ -4,7 +4,7 @@ NIP-01 Basic protocol flow description ------------------------------- -`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` +`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` `author:cameri` `author:Giszmo` This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. @@ -19,11 +19,10 @@ The only object type that exists is the `event`, which has the following format "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": , + "kind": , "tags": [ - ["e", <32-bytes hex of the id of another event>, ], - ["p", <32-bytes hex of a pubkey>, ], - ... // other kinds of tags may be included later + [...], + ... ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> @@ -43,9 +42,57 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ] ``` +### Tags + +Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: + +```json +{ + ..., + "tags": [ + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["alt", "reply"], + ... + ], + ... +} +``` + +The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. + +This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: + +- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, ]` +- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, ]` +- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes hex of a pubkey>:, ]` + +As a convention, all single-letter key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. + +### Kinds + +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: + +- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete older events once it gets a new one for the same pubkey. +- `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. + +And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: + +- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. +- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. + +These are just conventions and relay implementations may differ. + ## Communication between clients and relays -Relays expose a websocket endpoint to which clients can connect. +Relays expose a websocket endpoint to which clients can connect. Clients should open a single websocket connection to each relay and use it for all their subscriptions. + +### Meaning of WebSocket status codes + +- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again. ### From client to relay: sending events and creating subscriptions @@ -61,11 +108,10 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th ```json { - "ids": , - "authors": , + "ids": , + "authors": , "kinds": , - "#e": , - "#p": , + "#": , "since": , "until": , "limit": @@ -74,9 +120,9 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case it should overwrite the previous subscription. -Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON arrays with one or more values. At least one of the array's values must match the relevant field in an event for the condition itself to be considered a match. For scalar event attributes such as `kind`, the attribute from the event must be contained in the filter list. For tag attributes such as `#e`, where an event may have multiple values, the event and filter condition values must have at least one item in common. +Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. -The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. +The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values. The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. @@ -84,32 +130,28 @@ All conditions of a filter that are specified must match for an event for it to A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. -The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. +The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. ### From relay to client: sending events and notices -Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: +Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. + * `["OK", , , ]`, used to indicate acceptance or denial of an `EVENT` message. * `["EOSE", ]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. This NIP defines no rules for how `NOTICE` messages should be sent or treated. -`EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MAY be empty when the 3rd is `true`, otherwise it MUST be a string containing a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: -## Basic Event Kinds - - - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. - - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. - -A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. - -## Other Notes: - -- Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a case-sensitive tag name as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. -- The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. -- Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. -- When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. + * `["OK", "b1a649ebe8...", true, ""]` + * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` + * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]` + * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]` + * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]` + * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` + * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]` + * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` + * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` diff --git a/11.md b/11.md index ec46b36..c71f89e 100644 --- a/11.md +++ b/11.md @@ -118,7 +118,7 @@ field of any event. This is a count of unicode characters. After serializing into JSON it may be larger (in bytes), and is still subject to the `max_message_length`, if defined. -- `min_pow_difficulty`: new events will require at least this difficulty of PoW, +- `min_pow_difficulty`: new events will require at least this difficulty of PoW, based on [NIP-13](13.md), or they will be rejected by this server. - `auth_required`: this relay requires [NIP-42](42.md) authentication @@ -129,7 +129,7 @@ Even if set to False, authentication may be required for specific actions. ### Event Retention ### -There may be a cost associated with storing data forever, so relays +There may be a cost associated with storing data forever, so relays may wish to state retention times. The values stated here are defaults for unauthenticated users and visitors. Paid users would likely have other policies. @@ -151,7 +151,7 @@ all, and preferably an error will be provided when those are received. } ``` -`retention` is a list of specifications: each will apply to either all kinds, or +`retention` is a list of specifications: each will apply to either all kinds, or a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive start and end values. Events of indicated kind (or all) are then limited to a `count` and/or time period. @@ -161,8 +161,7 @@ a specific `kind` number, by giving a retention time of zero for those `kind` va While that is unfortunate, it does allow clients to discover servers that will support their protocol quickly via a single HTTP fetch. -There is no need to specify retention times for _ephemeral events_ as defined -in [NIP-16](16.md) since they are not retained. +There is no need to specify retention times for _ephemeral events_ since they are not retained. ### Content Limitations ### @@ -271,7 +270,7 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b As of 2 May 2023 the following `curl` command provided these results. >curl -H "Accept: application/nostr+json" https://eden.nostr.land - + {"name":"eden.nostr.land", "description":"Eden Nostr Land - Toronto 1-01", "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", @@ -293,5 +292,5 @@ As of 2 May 2023 the following `curl` command provided these results. "payment_required":true}, "payments_url":"https://eden.nostr.land/invoices", "fees":{"admission":[{"amount":5000000,"unit":"msats"}], - "publication":[]}}, + "publication":[]}}, "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" diff --git a/12.md b/12.md index 7d1f46e..9357977 100644 --- a/12.md +++ b/12.md @@ -4,39 +4,6 @@ NIP-12 Generic Tag Queries ------------------- -`draft` `optional` `author:scsibug` `author:fiatjaf` +`final` `mandatory` `author:scsibug` `author:fiatjaf` -Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. - -The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. Note that tag names are case-sensitive. - -Example Subscription Filter ---------------------------- - -The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`. - -``` -{ - "kinds": [1], - "#r": ["foo", "bar"] -} -``` - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP. - -Rationale ---------- - -The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions. - -Suggested Use Cases -------------------- - -Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose. - -* Decentralized Commenting System: clients can comment on arbitrary web pages, and easily search for other comments, by using a `r` ("reference", in this case an URL) tag and value. -* Location-specific Posts: clients can use a `g` ("geohash") tag to associate a post with a physical location. Clients can search for a set of geohashes of varying precisions near them to find local content. -* Hashtags: clients can use simple `t` ("hashtag") tags to associate an event with an easily searchable topic name. Since Nostr events themselves are not searchable through the protocol, this provides a mechanism for user-driven search. +Moved to [NIP-01](01.md). diff --git a/13.md b/13.md index 360bde6..0178733 100644 --- a/13.md +++ b/13.md @@ -110,7 +110,7 @@ function countLeadingZeroes(hex) { Querying relays for PoW notes ----------------------------- -Since relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: +If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: ``` $ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]' diff --git a/15.md b/15.md index f8df328..f9e4b79 100644 --- a/15.md +++ b/15.md @@ -4,7 +4,7 @@ NIP-15 Nostr Marketplace (for resilient marketplaces) ----------------------------------- -`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` +`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` > Based on https://github.com/lnbits/Diagon-Alley @@ -33,13 +33,13 @@ The `merchant` admin software can be purely clientside, but for `convenience` an ## `Merchant` publishing/updating products (event) A merchant can publish these events: -| Kind | | Description | NIP | -|---------|------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------| -| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | [NIP01 ](https://github.com/nostr-protocol/nips/blob/master/01.md) | -| `30017` | `set_stall` | Create or update a stall. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | -| `30018` | `set_product` | Create or update a product. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | -| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md) | -| `5 ` | `delete` | Delete a product or a stall. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) | +| Kind | | Description | +| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | +| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | +| `30017` | `set_stall` | Create or update a stall. | +| `30018` | `set_product` | Create or update a product. | +| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | +| `5 ` | `delete` | Delete a product or a stall. | ### Event `30017`: Create or update a stall. @@ -71,7 +71,7 @@ Fields that are not self-explanatory: ```json "tags": [["d", , , ] - -Relays MUST return `true` when the event is a duplicate and has already been saved. The `message` SHOULD start with `duplicate:` in this case. - -Relays MUST return `false` when the event was rejected and not saved. - -The `message` SHOULD provide additional information as to why the command succeeded or failed. - -The `message` SHOULD start with `blocked:` if the pubkey or network address has been blocked, banned, or is not on a whitelist. - -The `message` SHOULD start with `invalid:` if the event is invalid or doesn't meet some specific criteria (created_at is too far off, id is wrong, signature is wrong, etc) - -The `message` SHOULD start with `pow:` if the event doesn't meet some proof-of-work difficulty. The client MAY consult the relay metadata at this point to retrieve the required posting difficulty. - -The `message` SHOULD start with `rate-limited:` if the event was rejected due to rate limiting techniques. - -The `message` SHOULD start with `error:` if the event failed to save due to a server issue. - -Ephemeral events are not acknowledged with OK responses, unless there is a failure. - -If the event or `EVENT` command is malformed and could not be parsed, a NOTICE message SHOULD be used instead of a command result. This NIP only applies to non-malformed EVENT commands. - - -Examples --------- - -Event successfully written to the database: - - ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, ""] - -Event successfully written to the database because of a reason: - - ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, "pow: difficulty 25>=24"] - -Event blocked due to ip filter - - ["OK", "b1a649ebe8...", false, "blocked: tor exit nodes not allowed"] - -Event blocked due to pubkey ban - - ["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"] - -Event blocked, pubkey not registered - - ["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"] - -Event rejected, rate limited - - ["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"] - -Event rejected, `created_at` too far off - - ["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"] - -Event rejected, insufficient proof-of-work difficulty - - ["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"] - -Event failed to save, - - ["OK", "b1a649ebe8...", false, "error: could not connect to the database"] - - - -Client Handling ---------------- - -`messages` are meant for humans, with `reason:` prefixes so that clients can be slightly more intelligent with what to do with them. For example, with a `rate-limited:` reason the client may not show anything and simply try again with a longer timeout. - -For the `pow:` prefix it may query relay metadata to get the updated difficulty requirement and try again in the background. - -For the `invalid:` and `blocked:` prefix the client may wish to show these as styled error popups. - -The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it. - - -Future Extensions ------------------ - -This proposal SHOULD be extended to support further commands in the future, such as REQ and AUTH. They are left out of this initial version to keep things simpler. +Moved to [NIP-01](01.md). diff --git a/22.md b/22.md index 2172519..f595ebf 100644 --- a/22.md +++ b/22.md @@ -2,13 +2,13 @@ NIP-22 ====== Event `created_at` Limits ---------------------------- +------------------------- `draft` `optional` `author:jeffthibault` `author:Giszmo` Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md). -If a relay supports this NIP, the relay SHOULD send the client a [NIP-20](20.md) command result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. +If a relay supports this NIP, the relay SHOULD send the client an `OK` result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. Client Behavior --------------- @@ -22,7 +22,7 @@ This NIP formalizes restrictions on event timestamps as accepted by a relay and The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions. -[Replaceable events](16.md#replaceable-events) can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. +_Replaceable events_ can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. A wide adoption of this NIP could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future. diff --git a/23.md b/23.md index 7a06b0e..76c0a69 100644 --- a/23.md +++ b/23.md @@ -6,7 +6,7 @@ Long-form Content `draft` `optional` `author:fiatjaf` -This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. +This NIP defines `kind:30023` (a _parameterized replaceable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. "Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. @@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma ### Metadata -For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12. +For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12. Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: @@ -31,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st ### Editability -These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a `"d"` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. +These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. ### Linking -The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)). +The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. ### References diff --git a/33.md b/33.md index 5128bec..1e7a9fc 100644 --- a/33.md +++ b/33.md @@ -4,52 +4,6 @@ NIP-33 Parameterized Replaceable Events -------------------------------- -`draft` `optional` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` +`final` `mandatory` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` -This NIP adds a new event range that allows for replacement of events that have the same `d` tag and kind unlike NIP-16 which only replaced by kind. - -Implementation --------------- -The value of a tag can be any string and is defined as the first parameter of a tag after the tag name. - -A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`. -Upon a parameterized replaceable event with a newer timestamp than the currently known latest -replaceable event with the same kind, author and first `d` tag value being received, the old event -SHOULD be discarded, effectively replacing what gets returned when querying for -`author:kind:d-tag` tuples. - -If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded. - -A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the -value as an empty string. Events from the same author with any of the following `tags` -replace each other: - -* `"tags":[["d",""]]` -* `"tags":[]`: implicit `d` tag with empty value -* `"tags":[["d"]]`: implicit empty value `""` -* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered -* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered -* `"tags":[["e"]]`: same as no tags -* `"tags":[["d","","1"]]`: only the first value is considered (`""`) - -Clients SHOULD NOT use `d` tags with multiple values and SHOULD include the `d` tag even if it has no value to allow querying using the `#d` filter. - -Referencing and tagging ------------------------ - -Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the -`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their -equivalents for event tags (i.e. an `nprofile` is generally translated into a tag -`["p", "", ""]`). - -To support linking to parameterized replaceable events, the `naddr` code is introduced on -NIP-19. It includes the public key of the event author and the `d` tag (and relays) such that -the referenced combination of public key and `d` tag can be found. - -The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "::", ""]`. - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. -Clients MAY send parameterized replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one and are recommended to send a `#d` tag filter. Clients should account for the fact that missing `d` tags or ones with no value are not returned in tag filters, and are recommended to always include a `d` tag with a value. +Moved to [NIP-01](01.md). diff --git a/51.md b/51.md index 80cc09e..b7229aa 100644 --- a/51.md +++ b/51.md @@ -2,15 +2,13 @@ NIP-51 ====== Lists -------------------------- +----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `depends:33` +`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. -If a list type should only be defined once per user (like the 'Mute' list), the list type's events should follow the specification for [NIP-16 - Replaceable Events](16.md). These lists may be referred to as 'replaceable lists'. - -Otherwise, the list type's events should follow the specification for [NIP-33 - Parameterized Replaceable Events](33.md), where the list name will be used as the 'd' parameter. These lists may be referred to as 'parameterized replaceable lists'. +If a list should only be defined once per user (like the "mute" list) the list is declared as a _replaceable event_. These lists may be referred to as "replaceable lists". Otherwise, the list is a _parameterized replaceable event_ and the list name will be used as the `d` tag. These lists may be referred to as "parameterized replaceable lists". ## Replaceable List Event Example diff --git a/52.md b/52.md index c601412..846fbf4 100644 --- a/52.md +++ b/52.md @@ -6,7 +6,7 @@ Calendar Events `draft` `optional` `author:tyiu` -This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are replaceable and referenceable per [NIP-33](33.md) and deletable per [NIP-09](09.md). +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _parameterized replaceable_ and deletable per [NIP-09](09.md). Unlike the term `calendar event` specific to this NIP, the term `event` is used broadly in all the NIPs to describe any Nostr event. The distinction is being made here to discern between the two terms. @@ -139,7 +139,7 @@ A calendar is a collection of calendar events, represented as a custom replaceab The format uses a custom replaceable list of kind `31924` with a list of tags as described below: * `d` (required) calendar name -* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to ```json { @@ -171,7 +171,7 @@ The format uses a parameterized replaceable event kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. The list of tags are as follows: -* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) +* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `L` (required) label namespace of `status` per [NIP-32](32.md) * `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. diff --git a/53.md b/53.md index c5f2704..b3d416b 100644 --- a/53.md +++ b/53.md @@ -12,7 +12,7 @@ Service providers want to offer live activities to the Nostr network in such a w # Live Event -A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. +A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. For example: @@ -44,13 +44,13 @@ For example: A distinct `d` tag should be used for each activity. All other tags are optional. -Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). +Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). -Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. +Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` -The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). +The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. ## Proof of Agreement to Participate @@ -58,11 +58,11 @@ Event owners can add proof as the 5th term in each `p` tag to clarify the partic Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. -This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. +This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. # Live Chat Message -Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. ```js { @@ -74,7 +74,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t ["a", "30311::", "", "root"], ], "content": "Zaps to live streams is beautiful." -} +} ``` # Use Cases @@ -83,7 +83,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or # Example -Live Streaming +Live Streaming ```json { @@ -112,7 +112,7 @@ Live Streaming chat message ```json { "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", - "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", "created_at": 1687286726, "kind": 1311, "tags": [ @@ -122,4 +122,3 @@ Live Streaming chat message "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" } ```` - diff --git a/58.md b/58.md index 2fa4406..d6bb27d 100644 --- a/58.md +++ b/58.md @@ -9,15 +9,9 @@ Badges Three special events are used to define, award and display badges in user profiles: -1. A "Badge Definition" event is defined as a parameterized replaceable event -with kind `30009` having a `d` tag with a value that uniquely identifies -the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can -be updated. +1. A "Badge Definition" event is defined as a parameterized replaceable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated. -2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing -a "Define Badge" event and one or more `p` tags, one for each pubkey the -badge issuer wishes to award. The value for the `a` tag MUST follow the format -defined in [NIP-33](33.md). Awarded badges are immutable and non-transferrable. +2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Define Badge" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. 3. A "Profile Badges" event is defined as a parameterized replaceable event with kind `30008` with a `d` tag with the value `profile_badges`. diff --git a/72.md b/72.md index f4bebf4..599a4c4 100644 --- a/72.md +++ b/72.md @@ -6,7 +6,7 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` `author:arthurfranca` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag. Moderators issue an approval event `kind:4550` that links the community with the new post. # Community Definition diff --git a/README.md b/README.md index 3c35ef3..f2603cf 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-09: Event Deletion](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) -- [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events](14.md) - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) -- [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) -- [NIP-20: Command Results](20.md) - [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) @@ -48,7 +45,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) -- [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) @@ -78,7 +74,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | ------- | -------------------------- | ----------- | | `0` | Metadata | [1](01.md) | | `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | [1](01.md) | +| `2` | Recommend Relay | | | `3` | Contacts | [2](02.md) | | `4` | Encrypted Direct Messages | [4](04.md) | | `5` | Event Deletion | [9](09.md) | @@ -128,59 +124,48 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | -### Event Kind Ranges - -| range | description | NIP | -| ---------------- | -------------------------------- | ----------- | -| `1000`--`9999` | Regular Events | [16](16.md) | -| `10000`--`19999` | Replaceable Events | [16](16.md) | -| `20000`--`29999` | Ephemeral Events | [16](16.md) | -| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) | - ## Message types ### Client to Relay | type | description | NIP | | ------- | --------------------------------------------------- | ----------- | +| `EVENT` | used to publish events | [01](01.md) | +| `REQ` | used to request events and subscribe to new updates | [01](01.md) | +| `CLOSE` | used to stop previous subscriptions | [01](01.md) | | `AUTH` | used to send authentication events | [42](42.md) | -| `CLOSE` | used to stop previous subscriptions | [1](01.md) | | `COUNT` | used to request event counts | [45](45.md) | -| `EVENT` | used to publish events | [1](01.md) | -| `REQ` | used to request events and subscribe to new updates | [1](01.md) | ### Relay to Client | type | description | NIP | | -------- | ------------------------------------------------------- | ----------- | +| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) | +| `EVENT` | used to send events requested to clients | [01](01.md) | +| `NOTICE` | used to send human-readable messages to clients | [01](01.md) | +| `OK` | used to notify clients if an EVENT was successful | [01](01.md) | | `AUTH` | used to send authentication challenges | [42](42.md) | | `COUNT` | used to send requested event counts to clients | [45](45.md) | -| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) | -| `EVENT` | used to send events requested to clients | [1](01.md) | -| `NOTICE` | used to send human-readable messages to clients | [1](01.md) | -| `OK` | used to notify clients if an EVENT was successful | [20](20.md) | Please update these lists when proposing NIPs introducing new event kinds. -When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md). - ## Standardized Tags | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | -------------------- | ------------------------ | -| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | +| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | | `alt` | Alt tag | -- | [31](31.md) | -| `d` | identifier | -- | [33](33.md) | -| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| `g` | geohash | -- | [12](12.md), [52](52.md) | +| `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | -| `p` | pubkey (hex) | relay URL | [1](01.md) | -| `r` | a reference (URL, etc) | -- | [12](12.md) | -| `t` | hashtag | -- | [12](12.md) | -| `amount` | millisats | -- | [57](57.md) | +| `r` | a reference (URL, etc) | -- | | +| `t` | hashtag | -- | | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | | `challenge` | challenge string | -- | [42](42.md) | | `content-warning` | reason | -- | [36](36.md) | From 04051ffcbc36964ecaf44f390e7d1f17e61edb15 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 15 Aug 2023 05:40:54 +0900 Subject: [PATCH 083/176] Update tag list (#692) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2603cf..38a0317 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `r` | a reference (URL, etc) | -- | | +| `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -189,7 +190,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `summary` | article summary | -- | [23](23.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | -| `zap` | profile name | type of value | [57](57.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From 88ee873c9e4824125d3f2e38d16c39ccf73ddf16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= Date: Tue, 15 Aug 2023 17:02:54 +0300 Subject: [PATCH 084/176] Rename countries to regions. (#465) --- 15.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/15.md b/15.md index 5e3164e..01ef05b 100644 --- a/15.md +++ b/15.md @@ -55,7 +55,7 @@ A merchant can publish these events: "id": , "name": , "cost": , - "countries": [], + "regions": [], } ] } From 2ba0eca44344a770b5ad24f20e749864cddf3518 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Tue, 15 Aug 2023 18:32:30 +0200 Subject: [PATCH 085/176] Nip 51 extended --- 51.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/51.md b/51.md index b7229aa..03bd921 100644 --- a/51.md +++ b/51.md @@ -4,7 +4,7 @@ NIP-51 Lists ----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` +`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. @@ -92,6 +92,7 @@ Then the user would create a 'Categorized People' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | +| 30303 | Categorized Reference List | ### Mute List @@ -108,3 +109,7 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List. + +### Categorized Reference List + +An event with kind `30303` is defined as a parameterized replaceable list event for categorizing user references. The 'd' parameter of this event holds the category name of the list. The reference lists may have metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md) . Items in these lists are `r` tags, and follow the schema of Kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). Each `r` tag entry should contain the 'reference URL' and the 'description', `["r", , ]`. Any standard tag can be included in a reference list. \ No newline at end of file From 2f84cd97e38c0a824cc27ea2ac976545e9e3f09e Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 17 Aug 2023 08:17:24 -0300 Subject: [PATCH 086/176] remove harmful remark from nip-10. --- 10.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/10.md b/10.md index 6494796..9c79b4a 100644 --- a/10.md +++ b/10.md @@ -19,7 +19,7 @@ Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. - + **The positions of the "e" tags within the event denote specific meanings as follows**: * No "e" tag:
@@ -29,34 +29,34 @@ Where: `["e", ]`: The id of the event to which this event is a reply. * Two "e" tags: `["e", ]`, `["e", ]`
- `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. + `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. * Many "e" tags: `["e", ]` `["e", ]`, ..., `["e", ]`
-There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. +There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. They are citings from this event. `root-id` and `reply-id` are as above. >This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. ## Marked "e" tags (PREFERRED) -`["e", , , ]` - +`["e", , , ]` + Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `` field, but may instead leave it as `""`. * `` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. -**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. +Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. A direct reply to the root of a thread should have a single marked "e" tag of type "root". ->This scheme is preferred because it allows events to mention others without confusing them with `` or ``. +>This scheme is preferred because it allows events to mention others without confusing them with `` or ``. ## The "p" tag Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. -When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. +When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. -Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] +Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] in no particular order. From 50b63c26c83ffe892c8698e9ea2eed88a3e6b9a0 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Thu, 17 Aug 2023 13:45:44 +0200 Subject: [PATCH 087/176] updated kind30001 --- 51.md | 45 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/51.md b/51.md index 03bd921..cd1a4ab 100644 --- a/51.md +++ b/51.md @@ -84,6 +84,43 @@ Then the user would create a 'Categorized People' list event like below: } ``` +Lets say a user wants to create a 'Categorized Bookmarks' list of `bookmarks` and has keys: +``` +priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1 +pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d +``` +The user wants to publicly include these bookmarks: + +```json +["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], +["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], +["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], +``` +and privately include these bookmarks (below is the JSON that would be encrypted and placed in the event content): + +```json +[ + ["r", "https://my-private.bookmark", "My private bookmark"], + ["a", "30001:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], +] +``` + +Then the user would create a 'Categorized Bookmarks' list event like below: + +```json +{ + "kind": 30001, + "tags": [ + ["d", "bookmarks"], + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], + ], + "content": "y3AyaLJfnmYr9x9Od9o4aYrmL9+Ynmsim5y2ONrU0urOTq+V81CyAthQ2mUOWE9xwGgrizhY7ILdQwWhy6FK0sA33GHtC0egUJw1zIdknPe7BZjznD570yk/8RXYgGyDKdexME+RMYykrnYFxq1+y/h00kmJg4u+Gpn+ZjmVhNYxl9b+TiBOAXG9UxnK/H0AmUqDpcldn6+j1/AiStwYZhD1UZ3jzDIk2qcCDy7MlGnYhSP+kNmG+2b0T/D1L0Z7?iv=PGJJfPE84gacAh7T0e6duQ==", + ...other fields +} +``` + ## List Event Kinds | kind | list type | @@ -92,7 +129,7 @@ Then the user would create a 'Categorized People' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | -| 30303 | Categorized Reference List | + ### Mute List @@ -108,8 +145,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List. - -### Categorized Reference List - -An event with kind `30303` is defined as a parameterized replaceable list event for categorizing user references. The 'd' parameter of this event holds the category name of the list. The reference lists may have metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md) . Items in these lists are `r` tags, and follow the schema of Kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). Each `r` tag entry should contain the 'reference URL' and the 'description', `["r", , ]`. Any standard tag can be included in a reference list. \ No newline at end of file +An event of kind `30001` is defined as a parameterised replaceable list event for categorizing bookmarks. The `d' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). The tags included in these lists MUST follow the schema of event tags as defined in [NIP-01 - Basic protocol flow description](01.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file From 867132ce9ac889258cdb46cf73531e8892f46ec4 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Thu, 17 Aug 2023 16:21:21 +0200 Subject: [PATCH 088/176] fix typos --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index cd1a4ab..cbd6be1 100644 --- a/51.md +++ b/51.md @@ -145,4 +145,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event of kind `30001` is defined as a parameterised replaceable list event for categorizing bookmarks. The `d' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). The tags included in these lists MUST follow the schema of event tags as defined in [NIP-01 - Basic protocol flow description](01.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file +An event of kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file From 7143bfccf7470e209c0048050f104a27901b9ebd Mon Sep 17 00:00:00 2001 From: gzuuus Date: Fri, 18 Aug 2023 10:23:45 +0200 Subject: [PATCH 089/176] added other parameter 'petname' to r tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38a0317..555f006 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | -| `r` | a reference (URL, etc) | -- | | +| `r` | a reference (URL, etc) | petname | | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `amount` | millisatoshis, stringified | -- | [57](57.md) | From 37c4375e297166df8350c8a7d119d33c0757228b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 19 Aug 2023 23:03:19 -0300 Subject: [PATCH 090/176] bring back 9cac35db9b1d41c8eb7413269308a76687489b30 fixes https://github.com/nostr-protocol/nips/issues/732 --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index 4b33975..6369743 100644 --- a/01.md +++ b/01.md @@ -80,10 +80,12 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. + These are just conventions and relay implementations may differ. ## Communication between clients and relays From c5a8b75abd9ad5c0b2a680f71ae2c91beda37d5a Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 20 Aug 2023 04:04:55 +0200 Subject: [PATCH 091/176] Consistency and small refinements for NIP-01 (#731) --- 01.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/01.md b/01.md index 6369743..d6ccfbe 100644 --- a/01.md +++ b/01.md @@ -25,7 +25,7 @@ The only object type that exists is the `event`, which has the following format ... ], "content": , - "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> + "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } ``` @@ -34,7 +34,7 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ```json [ 0, - , + , , , , @@ -64,11 +64,11 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, ]` -- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, ]` -- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes hex of a pubkey>:, ]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` +- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` +- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` -As a convention, all single-letter key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. +As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. ### Kinds @@ -80,7 +80,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. @@ -90,7 +90,7 @@ These are just conventions and relay implementations may differ. ## Communication between clients and relays -Relays expose a websocket endpoint to which clients can connect. Clients should open a single websocket connection to each relay and use it for all their subscriptions. +Relays expose a websocket endpoint to which clients can connect. Clients SHOULD open a single websocket connection to each relay and use it for all their subscriptions. Relays MAY limit number of connections from specific IP/client/etc. ### Meaning of WebSocket status codes @@ -113,14 +113,14 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th "ids": , "authors": , "kinds": , - "#": , + "#": , "since": , "until": , - "limit": + "limit": } ``` -Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case it should overwrite the previous subscription. +Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case relay MUST overwrite the previous subscription. Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. From 89915e0251ec4e5ce3fc00e2f2dfd9106a359b79 Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 20 Aug 2023 14:27:03 +0200 Subject: [PATCH 092/176] Remove min_prefix mentions from NIP-11 after prefix search was removed from NIP-01 --- 11.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/11.md b/11.md index c71f89e..083ae8f 100644 --- a/11.md +++ b/11.md @@ -75,7 +75,6 @@ are rejected or fail immediately. "max_filters": 100, "max_limit": 5000, "max_subid_length": 100, - "min_prefix": 4, "max_event_tags": 100, "max_content_length": 8196, "min_pow_difficulty": 30, @@ -102,9 +101,6 @@ Must be one or higher. - `max_subid_length`: maximum length of subscription id as a string. -- `min_prefix`: for `authors` and `ids` filters which are to match against -a hex prefix, you must provide at least this many hex digits in the prefix. - - `max_limit`: the relay server will clamp each filter's `limit` value to this number. This means the client won't be able to get more than this number of events from a single subscription filter. This clamping is typically done silently @@ -284,7 +280,6 @@ As of 2 May 2023 the following `curl` command provided these results. "max_filters":2500, "max_limit":5000, "max_subid_length":256, - "min_prefix":4, "max_event_tags":2500, "max_content_length":65536, "min_pow_difficulty":0, From 209dc5d7945ca95f4de4c44df085568b271f3de5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 21 Aug 2023 18:49:21 +0900 Subject: [PATCH 093/176] Update NIP-50 title in list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38a0317..72eb2a4 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) -- [NIP-50: Keywords filter](50.md) +- [NIP-50: Search Capability](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) From c6b6eea96a85aa6c9b5ce579685214fea3de0282 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 23 Aug 2023 12:55:31 -0300 Subject: [PATCH 094/176] remove bracket from kind attribute in example. fixes https://github.com/nostr-protocol/nips/issues/735 --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index ace4a03..729d585 100644 --- a/57.md +++ b/57.md @@ -78,7 +78,7 @@ const sats = 21 const amount = sats * 1000 const relays = ['wss://nostr-pub.wellorder.net'] const event = encodeURI(JSON.stringify(await signEvent({ - kind: [9734], + kind: 9734, content: "", pubkey: senderPubkey, created_at: Math.round(Date.now() / 1000), From 208dee210249f84496ddfa823542d023e23b3edb Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Thu, 24 Aug 2023 15:18:50 -0700 Subject: [PATCH 095/176] Define how to encode a non-parameterized replaceable event as a naddr --- 19.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/19.md b/19.md index 6b08742..cd989e2 100644 --- a/19.md +++ b/19.md @@ -35,7 +35,7 @@ These are the possible bech32 prefixes with `TLV`: - `nprofile`: a nostr profile - `nevent`: a nostr event - `nrelay`: a nostr relay - - `naddr`: a nostr _parameterized replaceable event_ coordinate + - `naddr`: a nostr _replaceable event_ coordinate These possible standardized `TLV` types are indicated here: @@ -44,7 +44,7 @@ These possible standardized `TLV` types are indicated here: - for `nprofile` it will be the 32 bytes of the profile public key - for `nevent` it will be the 32 bytes of the event id - for `nrelay`, this is the relay URL - - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced + - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. - `1`: `relay` - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii - this may be included multiple times From f7b7b865e629789cb4d64b45a836c116e2831cbe Mon Sep 17 00:00:00 2001 From: William Casarin Date: Wed, 23 Aug 2023 19:56:20 -0700 Subject: [PATCH 096/176] NIP-315: User Statuses This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. --- 315.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 62 insertions(+) create mode 100644 315.md diff --git a/315.md b/315.md new file mode 100644 index 0000000..0f4f0a1 --- /dev/null +++ b/315.md @@ -0,0 +1,60 @@ + +NIP-315 +======= + +User Statuses +-------------- + +`draft` `optional` `author:jb55` + +## Abstract + +This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. + +## Live Statuses + +A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _parameterized replaceable event_, where the `d` tag represents the status type: + +For example: + +```js +{ + "kind": 30315, + "content": "Sign up for nostrasia!", + "tags": [ + ["d", "general"], + ["r", "https://nostr.world"] + ], +} + +{ + "kind": 30315, + "content": "Intergalatic - Beastie Boys", + "tags": [ + ["d", "music"], + ["r", "spotify:search:Intergalatic%20-%20Beastie%20Boys"], + ["expiration", "1692845589"] + ], +} +``` + +Two common status types are defined: `general` and `music`. `general` represent general statuses: "Working", "Hiking", etc. + +`music` status events are for live streaming what you are currently listening to. The expiry of the `music` status should be when the track will stop playing. + +Any other status types can be used but they are not defined by this NIP. + +The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. + +# Client behavior + +Clients MAY display this next to the username on posts or profiles to provide live user status information. + +# Use Cases + +* Calendar nostr apps that update your general status when you're in a meeting +* Nostr Nests that update your general status with a link to the nest when you join +* Nostr music streaming services that update your music status when you're listening +* Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well +* Clients can use the system media player to update playing music status + diff --git a/README.md b/README.md index f8b77df..f6b57f1 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-315: User Statuses](315.md) ## Event Kinds @@ -113,6 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | +| `30315` | User Statuses | [315](315.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | From 7dc1f02fa70a5b9da7b3867e3faa37f48571d5e1 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 25 Aug 2023 08:41:26 -0300 Subject: [PATCH 097/176] rename 315 to 38. --- 315.md => 38.md | 5 ++--- README.md | 4 ++-- 2 files changed, 4 insertions(+), 5 deletions(-) rename 315.md => 38.md (99%) diff --git a/315.md b/38.md similarity index 99% rename from 315.md rename to 38.md index 0f4f0a1..378da1c 100644 --- a/315.md +++ b/38.md @@ -1,6 +1,6 @@ -NIP-315 -======= +NIP-38 +====== User Statuses -------------- @@ -57,4 +57,3 @@ Clients MAY display this next to the username on posts or profiles to provide li * Nostr music streaming services that update your music status when you're listening * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status - diff --git a/README.md b/README.md index f6b57f1..7951339 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-36: Sensitive Content](36.md) +- [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) @@ -67,7 +68,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-315: User Statuses](315.md) ## Event Kinds @@ -114,7 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | -| `30315` | User Statuses | [315](315.md) | +| `30315` | User Statuses | [38](38.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | From 50945f7150c8b100f92fdfdffba32894ba5a831f Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 25 Aug 2023 23:17:05 +0900 Subject: [PATCH 098/176] Reword set_metadata to metadata (#741) --- 05.md | 4 ++-- 89.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/05.md b/05.md index 56b9156..00d69af 100644 --- a/05.md +++ b/05.md @@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` `author:fiatjaf` `author:mikedilger` -On events of kind `0` (`set_metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +On events of kind `0` (`metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. Upon seeing that, the client splits the identifier into `` and `` and use these values to make a GET request to `https:///.well-known/nostr.json?name=`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `set_metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example diff --git a/89.md b/89.md index 5eee3b8..4503ecf 100644 --- a/89.md +++ b/89.md @@ -61,7 +61,7 @@ The third value of the tag SHOULD be the platform where this recommendation migh } ``` -* `content` is an optional `set_metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) +* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) * `k` tags' value is the event kind that is supported by this `kind:31990`. Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: From 21f3ad5a42c0ae63f2fc0a6e9f18b05f44df68c5 Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 27 Aug 2023 15:34:55 +0200 Subject: [PATCH 099/176] Allow relays indicate whether probabilistic count was used in NIP-45 --- 45.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/45.md b/45.md index a525391..7b11950 100644 --- a/45.md +++ b/45.md @@ -21,6 +21,7 @@ This NIP defines the verb `COUNT`, which accepts a subscription id and filters a ``` Counts are returned using a `COUNT` response in the form `{"count": }`. Relays may use probabilistic counts to reduce compute requirements. +In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": , "approximate": }`. ``` ["COUNT", , {"count": }] @@ -36,4 +37,8 @@ Examples: # Count posts and reactions ["COUNT", , {"kinds": [1, 7], "authors": []}] ["COUNT", , {"count": 5}] + +# Count posts approximately +["COUNT", , {"kinds": [1]}] +["COUNT", , {"count": 93412452, "approximate": true}] ``` From acafcc774d571867bde615423c758c51dba64fca Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Mon, 28 Aug 2023 16:25:43 +0900 Subject: [PATCH 100/176] NIP-38: description for content --- 38.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/38.md b/38.md index 378da1c..010c14c 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 101/176] update 38.md --- 38.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/38.md b/38.md index 010c14c..f1eddcd 100644 --- a/38.md +++ b/38.md @@ -58,4 +58,4 @@ Clients MAY display this next to the username on posts or profiles to provide li * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status -The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji. If the `content` is an empty string then the client should clear the status. +The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. From d1d438bf1458fc0f59a191631d10c0bde35353be Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Tue, 29 Aug 2023 00:45:45 +0900 Subject: [PATCH 102/176] fix typo --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index d6ccfbe..e4c0546 100644 --- a/01.md +++ b/01.md @@ -62,7 +62,7 @@ Each tag is an array of strings of arbitrary size, with some conventions around The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. -This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: +This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` From e50bf508d9014cfb19bfa8a5c4ec88dc4788d490 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Tue, 29 Aug 2023 23:49:59 +0900 Subject: [PATCH 103/176] add a-tag format for non-parameterized replaceable events --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index e4c0546..1831438 100644 --- a/01.md +++ b/01.md @@ -66,7 +66,9 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` -- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` +- The `a` tag, used to refer to a (maybe parameterized) replaceable event + - for a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` + - for a non-parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. From d784820309dba0447d6a0a351ad0230ba6c5c5fb Mon Sep 17 00:00:00 2001 From: SnazzyBytes Date: Wed, 30 Aug 2023 18:30:41 -0500 Subject: [PATCH 104/176] add NIP-22 created_at limits to Server-Limitations --- 11.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/11.md b/11.md index 083ae8f..deb6f19 100644 --- a/11.md +++ b/11.md @@ -80,6 +80,8 @@ are rejected or fail immediately. "min_pow_difficulty": 30, "auth_required": true, "payment_required": true, + "created_at_lower_limit":31536000, + "created_at_upper_limit":3, } ... } @@ -123,6 +125,10 @@ Even if set to False, authentication may be required for specific actions. - `payment_required`: this relay requires payment before a new connection may perform any action. +- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md) + +- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md) + ### Event Retention ### There may be a cost associated with storing data forever, so relays From 08bd050598e078179eea71cb9de777d887a9e9f8 Mon Sep 17 00:00:00 2001 From: Alejandro Date: Fri, 1 Sep 2023 15:07:52 +0200 Subject: [PATCH 105/176] NIP-75: Zap Goals (#757) --- 75.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 79 insertions(+) create mode 100644 75.md diff --git a/75.md b/75.md new file mode 100644 index 0000000..6c8cb7b --- /dev/null +++ b/75.md @@ -0,0 +1,76 @@ +# NIP-75 + +## Zap Goals + +`draft` `optional` `author:verbiricha` + +This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event. + +## Nostr Event + +A `kind:9041` event is used. + +The `.content` contains a human-readable description of the goal. + +The following tags are defined as REQUIRED. + +- `amount` - target amount in milisats. +- `relays` - a list of relays the zaps to this goal will be sent to and tallied from. + +Example event: + +```json +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["amount", "210000"], + ], + "content": "Nostrasia travel expenses", + ...other fields +``` + +The following tags are OPTIONAL. + +- `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress. + +```json +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["amount", "210000"], + ["closed_at", ""], + ], + "content": "Nostrasia travel expenses", + ...other fields +``` + +The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event. + +The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events). + +Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. + +```json +{ + "kind": 3XXXX, + "tags": [ + ... + ["goal", "", ""], + ], + ...other fields +``` + +## Client behavior + +Clients MAY display funding goals on user profiles. + +When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. + +When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. + +## Use cases + +- Fundraising clients +- Adding funding goals to events such as long form posts, badges or live streams diff --git a/README.md b/README.md index 7951339..5beff91 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-72: Moderated Communities](72.md) +- [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) @@ -93,6 +94,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | +| `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -177,6 +179,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `description` | invoice description | -- | [57](57.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | From c7191fc2f518aa85b6437c001c1fdcadaa0b38a3 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Sat, 2 Sep 2023 14:34:39 +0300 Subject: [PATCH 106/176] fix inconsistency --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 1831438..7a304e0 100644 --- a/01.md +++ b/01.md @@ -82,7 +82,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. From ea8fa91c8058c8d74aff8b011196d504a2683fe9 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Mon, 4 Sep 2023 14:25:04 +0300 Subject: [PATCH 107/176] clarify parameterized replaceable events --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 7a304e0..d822bfb 100644 --- a/01.md +++ b/01.md @@ -84,7 +84,7 @@ And also a convention for kind ranges that allow for easier experimentation and - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. - for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event is expected to be stored by relays, older versions are expected to be discarded. In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. From 8aa89367cd66e160b2bc2320362e87b3a4e71eac Mon Sep 17 00:00:00 2001 From: Luis Miguel Date: Tue, 5 Sep 2023 18:15:14 +0200 Subject: [PATCH 108/176] Micro-typo nip-58 --- 58.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/58.md b/58.md index d6bb27d..ccabc7b 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 109/176] Spelling and clarifcations --- 98.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/98.md b/98.md index ecbebc0..c8cba0f 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 110/176] Add description to event 30019 (#768) --- 15.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/15.md b/15.md index 01ef05b..edece81 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 111/176] 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 24dd346..c1b322a 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 112/176] Remove description about NIP-12 --- 52.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/52.md b/52.md index 846fbf4..f5bd0ad 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 113/176] Add tags to nip94 --- 94.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index c1b322a..e34a576 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 114/176] Invert caption and alt --- 94.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/94.md b/94.md index e34a576..8e47c27 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 115/176] Expand preview into other tags --- 94.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 8e47c27..c5e0f18 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 116/176] Add xx tag --- 94.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index c5e0f18..b512af4 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 117/176] Update tag list (#778) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5beff91..98f6ddb 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 118/176] 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 0000000..fb653f4 --- /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 119/176] `banner` and deprecated names. --- 24.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/24.md b/24.md index fb653f4..cb5d898 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 120/176] Revert x and xx tags --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index b512af4..ed9b68c 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 121/176] Rename xx to ox --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index ed9b68c..77944a0 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 122/176] Remove ox tag --- 94.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/94.md b/94.md index 77944a0..c5e0f18 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 123/176] 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 cb5d898..5f94a2b 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 124/176] 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 5f94a2b..dee9daa 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 125/176] 65: trim slashes --- 65.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/65.md b/65.md index 3c06438..89fc594 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 126/176] 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 729d585..8e2be1b 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 127/176] 65: normalize relay uri --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 89fc594..352ee28 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 128/176] Update RFC reference --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 352ee28..49d1d17 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 129/176] 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 d822bfb..2b28f23 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 130/176] Better RFC reference --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 49d1d17..b676029 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 131/176] Add NIP-24 to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 98f6ddb..1097bc5 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 132/176] 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 ee4e372..0c8c402 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 133/176] 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 8e2be1b..849c869 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 134/176] 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 63c07a7..7b29140 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 1097bc5..dc70887 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 135/176] 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 3c5d764..4faf3f1 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 dc70887..e9f08bd 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 136/176] Nip 06 test vectors (#819) --- 06.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/06.md b/06.md index 4ae571f..a0b4a01 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 137/176] 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 51c49cf..4c0eff6 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 138/176] 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 4c0eff6..7de34fc 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 139/176] 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 7de34fc..a55d491 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 140/176] remove useless "block" tag on OTS. --- 03.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/03.md b/03.md index 4faf3f1..680cc8b 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 141/176] added nodestr --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 0c8c402..a9b6b34 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 142/176] Clarify Unsigned Event Object type --- 07.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/07.md b/07.md index a9b6b34..24d8d45 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 143/176] update readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6f9cb03..8044b24 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 144/176] DVM kinds change on README (#850) --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 8044b24..8be0595 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 145/176] NIP-90: consistency changes --- 90.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 4c0eff6..163dbd0 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 146/176] 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 edece81..68d28ff 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 147/176] Adding Nostore to NIP-07 extension list. --- 07.md | 1 + 1 file changed, 1 insertion(+) diff --git a/07.md b/07.md index 24d8d45..51ddc16 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 148/176] 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 2b28f23..183e0ba 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 149/176] 52: fix kinds (as ints). --- 52.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/52.md b/52.md index f5bd0ad..6950744 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 150/176] 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 a55d491..0ac4b98 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 151/176] 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 b676029..573e1df 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 152/176] 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 573e1df..939b263 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 153/176] 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 183e0ba..cb4f522 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 154/176] 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 0ac4b98..24da99c 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 155/176] 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 24da99c..8394c38 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 156/176] 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 0000000..b4a4be7 --- /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 8be0595..f818b04 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 157/176] 84: fix markers example. --- 84.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/84.md b/84.md index b4a4be7..89bf88b 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 158/176] 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 f818b04..36dfada 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 159/176] Fix typo in 65.md --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 939b263..cdfe9bf 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 160/176] 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 dee9daa..b88d990 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 161/176] 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 ddd364a..c5c6272 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 162/176] Update TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f818b04..a42aa20 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 163/176] Add DVM kinds to list --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a42aa20..9d3ee62 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 164/176] format kinds table. --- README.md | 118 +++++++++++++++++++++++++++--------------------------- 1 file changed, 59 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 9d3ee62..3f7cb41 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 165/176] 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 89bf88b..4caab62 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 166/176] Clarify NIP 32 --- 32.md | 113 +++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 72 insertions(+), 41 deletions(-) diff --git a/32.md b/32.md index c5c6272..f8dc002 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 167/176] 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 cbd6be1..e4d7c24 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 37f6cbb775126b386414220f783ca0f5f85e7614 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 15 Nov 2023 21:42:51 -0300 Subject: [PATCH 168/176] 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 cb4f522..dafea1d 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 2f19908..0653d06 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 680cc8b..8b7deb6 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 6e45b74..bf6767b 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 00d69af..6437550 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 a0b4a01..0e50254 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 51ddc16..01af6f4 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 6793e0b..f4f4341 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 9dab90f..f92410f 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 9c79b4a..5b19fbd 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 deb6f19..017e5d4 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 9357977..bf0eda9 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 0178733..4b15bbe 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 7384394..72e5e39 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 68d28ff..0ee000f 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 78ec708..0032083 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 75c4100..ba96c89 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 cd989e2..ef80887 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 ec6127a..6feed6a 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 6246eb4..6ed141a 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 f595ebf..06af493 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 76c0a69..382df83 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 b88d990..f830b68 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 7b29140..3b4aa59 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 59cf807..86c46e1 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 6d76120..efd2c12 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 62ab398..59e9389 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 ffc5aeb..5a6f84d 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 e77ae34..ee92052 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 f8dc002..dfcb35e 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 1e7a9fc..337a1f9 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 6d1cf63..db4c4f2 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 f1eddcd..911d5b1 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 b84603c..c9970fa 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 32680db..b8a0336 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 9b0c45b..9f0c24d 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 7b11950..a3abd19 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 90fa1a0..5318541 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 b6a4f2b..d4b7c1f 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 8f22781..2f03e00 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 5bda355..2bdf1ff 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 e4d7c24..a8a8e95 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 6950744..15cc8fc 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 b3d416b..c4789ea 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 259118d..0c951b5 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 849c869..2b2c97b 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 ccabc7b..9725c82 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 cdfe9bf..4a6f5a1 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 599a4c4..833336c 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 6c8cb7b..3a89f90 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 10ff535..0f2fada 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 4caab62..308cbdd 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 4503ecf..2e5b799 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 31447f2..fe0d89c 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 c5e0f18..0b76c25 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 c8cba0f..e04c7fc 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 274e5af..9e8f1da 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 169/176] 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 4503ecf..04f1917 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 e7e64af04aaf57461392acf117438038c4613eb0 Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Fri, 17 Nov 2023 12:22:43 +0900 Subject: [PATCH 170/176] fix typos --- 84.md | 2 +- 90.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/84.md b/84.md index 308cbdd..303cd93 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 fe0d89c..c498cdd 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 5f1d10fad24a1c860dc46e87e371b517500ed49b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 17 Nov 2023 18:05:23 -0500 Subject: [PATCH 171/176] Adds contributor images to the readme. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 483056d..1274b92 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 172/176] 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 1274b92..8e970ea 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 173/176] reformat NIP-11. --- 11.md | 154 +++++++++++++++++++++++++++++++--------------------------- 1 file changed, 82 insertions(+), 72 deletions(-) diff --git a/11.md b/11.md index 017e5d4..e05cb1f 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 174/176] 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 8b7deb6..74e010c 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 175/176] 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 833336c..74c7f08 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 176/176] 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 e05cb1f..ab05f31 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 4b15bbe..53c4d1b 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 72e5e39..480c4c5 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 0ee000f..51b7792 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 59e9389..2dcf800 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 dfcb35e..be4e872 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 db4c4f2..b10262c 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 c9970fa..c819e43 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 b8a0336..909747f 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 9f0c24d..e380e89 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 a3abd19..998b952 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 c4789ea..d3cc0af 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 0c951b5..a2861e3 100644 --- a/56.md +++ b/56.md @@ -1,4 +1,3 @@ - NIP-56 ====== diff --git a/72.md b/72.md index 74c7f08..c0fffff 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 3a89f90..f3cf5d0 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 303cd93..d5f54d4 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 73cb7bd..be3d075 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 c498cdd..6017c98 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 0b76c25..95b6a3b 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 e04c7fc..ca52304 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 9e8f1da..e65920c 100644 --- a/99.md +++ b/99.md @@ -1,6 +1,8 @@ -# NIP-99 +NIP-99 +====== -## Classified Listings +Classified Listings +------------------- `draft` `optional`