mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-12-22 16:35:52 -05:00
Merge branch 'master' into nip11-cl
This commit is contained in:
commit
77425aca40
6
01.md
6
01.md
|
@ -77,11 +77,11 @@ 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>, <recommended relay URL, optional>]`
|
- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]`
|
||||||
- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
|
- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
|
||||||
- The `a` tag, used to refer to a (maybe parameterized) replaceable event
|
- The `a` tag, used to refer to an addressable or replaceable event
|
||||||
- for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
|
- for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
|
||||||
- for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]`
|
- for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]`
|
||||||
|
|
||||||
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.
|
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. Only the first value in any given tag is indexed.
|
||||||
|
|
||||||
### Kinds
|
### Kinds
|
||||||
|
|
||||||
|
@ -95,7 +95,7 @@ And also a convention for kind ranges that allow for easier experimentation and
|
||||||
- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays.
|
- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays.
|
||||||
- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded.
|
- for kind `n` such that `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 `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays.
|
||||||
- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded.
|
- for kind `n` such that `30000 <= n < 40000`, events are **addressable** by their `kind`, `pubkey` and `d` tag value -- which means that, for each combination of `kind`, `pubkey` and the `d` tag 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.
|
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.
|
||||||
|
|
||||||
|
|
4
02.md
4
02.md
|
@ -14,7 +14,7 @@ The `.content` is not used.
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 3,
|
"kind": 3,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -23,7 +23,7 @@ For example:
|
||||||
["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"]
|
["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"]
|
||||||
],
|
],
|
||||||
"content": "",
|
"content": "",
|
||||||
...other fields
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
10
05.md
10
05.md
|
@ -10,18 +10,18 @@ On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with a
|
||||||
|
|
||||||
Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`.
|
Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`.
|
||||||
|
|
||||||
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 `<name>` matches the `pubkey` from the `user's 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 `<name>` matches the `pubkey` from the `user metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
If a client sees an event like this:
|
If a client sees an event like this:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9",
|
"pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9",
|
||||||
"kind": 0,
|
"kind": 0,
|
||||||
"content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}"
|
"content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}"
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b
|
||||||
"bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9"
|
"bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
````
|
```
|
||||||
|
|
||||||
or with the **recommended** `"relays"` attribute:
|
or with the **recommended** `"relays"` attribute:
|
||||||
|
|
||||||
|
@ -46,7 +46,7 @@ or with the **recommended** `"relays"` attribute:
|
||||||
"b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ]
|
"b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
````
|
```
|
||||||
|
|
||||||
If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed.
|
If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed.
|
||||||
|
|
||||||
|
|
4
09.md
4
09.md
|
@ -12,7 +12,7 @@ The event's `content` field MAY contain a text note describing the reason for th
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 5,
|
"kind": 5,
|
||||||
"pubkey": <32-bytes hex-encoded public key of the event creator>,
|
"pubkey": <32-bytes hex-encoded public key of the event creator>,
|
||||||
|
@ -24,7 +24,7 @@ For example:
|
||||||
["k", "30023"]
|
["k", "30023"]
|
||||||
],
|
],
|
||||||
"content": "these posts were published by accident",
|
"content": "these posts were published by accident",
|
||||||
...other fields
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
67
10.md
67
10.md
|
@ -10,10 +10,41 @@ On "e" and "p" tags in Text Events (kind 1)
|
||||||
## Abstract
|
## 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.
|
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.
|
||||||
|
|
||||||
## Positional "e" tags (DEPRECATED)
|
## Marked "e" tags (PREFERRED)
|
||||||
>This scheme is in common use; but should be considered deprecated.
|
`["e", <event-id>, <relay-url>, <marker>, <pubkey>]`
|
||||||
|
|
||||||
`["e", <event-id>, <relay-url>]` as per NIP-01.
|
Where:
|
||||||
|
|
||||||
|
* `<event-id>` is the id of the event being referenced.
|
||||||
|
* `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-url>` field, but may instead leave it as `""`.
|
||||||
|
* `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
|
||||||
|
* `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event
|
||||||
|
|
||||||
|
Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id.
|
||||||
|
|
||||||
|
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 `<reply-id>` or `<root-id>`.
|
||||||
|
|
||||||
|
`<pubkey>` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event.
|
||||||
|
|
||||||
|
## The "p" tag
|
||||||
|
Used in a text event contains a list of pubkeys used to record who is involved in a reply thread.
|
||||||
|
|
||||||
|
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`]
|
||||||
|
in no particular order.
|
||||||
|
|
||||||
|
## Deprecated Positional "e" tags
|
||||||
|
|
||||||
|
This scheme is not in common use anymore and is here just to keep backward compatibility with older events on the network.
|
||||||
|
|
||||||
|
Positional `e` tags are deprecated because they create ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply.
|
||||||
|
|
||||||
|
They use simple `e` tags without any marker.
|
||||||
|
|
||||||
|
`["e", <event-id>, <relay-url>]` as per NIP-01.
|
||||||
|
|
||||||
Where:
|
Where:
|
||||||
|
|
||||||
|
@ -33,32 +64,4 @@ Where:
|
||||||
|
|
||||||
* Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br>
|
* Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br>
|
||||||
There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain.
|
There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain.
|
||||||
They are citing from this event. `root-id` and `reply-id` are as above.
|
They are citing from this event. `root-id` and `reply-id` are as above.
|
||||||
|
|
||||||
>This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply.
|
|
||||||
|
|
||||||
## Marked "e" tags (PREFERRED)
|
|
||||||
`["e", <event-id>, <relay-url>, <marker>, <pubkey>]`
|
|
||||||
|
|
||||||
Where:
|
|
||||||
|
|
||||||
* `<event-id>` is the id of the event being referenced.
|
|
||||||
* `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`.
|
|
||||||
* `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
|
|
||||||
* `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event
|
|
||||||
|
|
||||||
Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id.
|
|
||||||
|
|
||||||
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 `<reply-id>` or `<root-id>`.
|
|
||||||
|
|
||||||
`<pubkey>` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event.
|
|
||||||
|
|
||||||
## The "p" tag
|
|
||||||
Used in a text event contains a list of pubkeys used to record who is involved in a reply thread.
|
|
||||||
|
|
||||||
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`]
|
|
||||||
in no particular order.
|
|
40
11.md
40
11.md
|
@ -14,6 +14,8 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application
|
||||||
{
|
{
|
||||||
"name": <string identifying relay>,
|
"name": <string identifying relay>,
|
||||||
"description": <string with detailed information>,
|
"description": <string with detailed information>,
|
||||||
|
"banner": <a link to an image (e.g. in .jpg, or .png format)>,
|
||||||
|
"icon": <a link to an icon (e.g. in .jpg, or .png format>,
|
||||||
"pubkey": <administrative contact pubkey>,
|
"pubkey": <administrative contact pubkey>,
|
||||||
"contact": <administrative alternate contact>,
|
"contact": <administrative alternate contact>,
|
||||||
"supported_nips": <a list of NIP numbers supported by the relay>,
|
"supported_nips": <a list of NIP numbers supported by the relay>,
|
||||||
|
@ -35,6 +37,21 @@ A relay may select a `name` for use in client software. This is a string, and S
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
### Banner
|
||||||
|
|
||||||
|
To make nostr relay management more user friendly, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay, complementing the text `Description`. [Here is an example banner](https://image.nostr.build/232ddf6846e8aea5a61abcd70f9222ab521f711aa545b7ab02e430248fa3a249.png) mockup as visualized in Damus iOS relay view of the Damus relay.
|
||||||
|
|
||||||
|
### Icon
|
||||||
|
|
||||||
|
Icon is a compact visual representation of the relay for use in UI with limited real estate such as a nostr user's relay list view. Below is an example URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
|
||||||
|
// other fields...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### 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-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance.
|
An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance.
|
||||||
|
@ -66,7 +83,7 @@ These are limitations imposed by the relay on clients. Your client
|
||||||
should expect that requests which exceed these *practical* limitations
|
should expect that requests which exceed these *practical* limitations
|
||||||
are rejected or fail immediately.
|
are rejected or fail immediately.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"limitation": {
|
"limitation": {
|
||||||
"max_message_length": 16384,
|
"max_message_length": 16384,
|
||||||
|
@ -83,7 +100,7 @@ are rejected or fail immediately.
|
||||||
"created_at_lower_limit": 31536000,
|
"created_at_lower_limit": 31536000,
|
||||||
"created_at_upper_limit": 3
|
"created_at_upper_limit": 3
|
||||||
},
|
},
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -146,14 +163,15 @@ Retention times are given in seconds, with `null` indicating infinity.
|
||||||
If zero is provided, this means the event will not be stored at
|
If zero is provided, this means the event will not be stored at
|
||||||
all, and preferably an error will be provided when those are received.
|
all, and preferably an error will be provided when those are received.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"retention": [
|
"retention": [
|
||||||
{"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600},
|
{"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600},
|
||||||
{"kinds": [[40000, 49999]], "time": 100},
|
{"kinds": [[40000, 49999]], "time": 100},
|
||||||
{"kinds": [[30000, 39999]], "count": 1000},
|
{"kinds": [[30000, 39999]], "count": 1000},
|
||||||
{"time": 3600, "count": 10000}
|
{"time": 3600, "count": 10000}
|
||||||
]
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -186,10 +204,10 @@ Users should be able to avoid relays in countries they don't like,
|
||||||
and/or select relays in more favorable zones. Exposing this
|
and/or select relays in more favorable zones. Exposing this
|
||||||
flexibility is up to the client software.
|
flexibility is up to the client software.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"relay_countries": [ "CA", "US" ],
|
"relay_countries": [ "CA", "US" ],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -208,12 +226,12 @@ local community. This would encourage users to follow the global
|
||||||
feed on that relay, in addition to their usual individual follows.
|
feed on that relay, in addition to their usual individual follows.
|
||||||
To support this goal, relays MAY specify some of the following values.
|
To support this goal, relays MAY specify some of the following values.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"language_tags": ["en", "en-419"],
|
"language_tags": ["en", "en-419"],
|
||||||
"tags": ["sfw-only", "bitcoin-only", "anime"],
|
"tags": ["sfw-only", "bitcoin-only", "anime"],
|
||||||
"posting_policy": "https://example.com/posting-policy.html",
|
"posting_policy": "https://example.com/posting-policy.html",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -308,7 +326,6 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
|
"icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
|
||||||
...
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -316,9 +333,11 @@ 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 command provided these results:
|
As of 2 May 2023 the following command provided these results:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
|
||||||
```
|
```
|
||||||
~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
|
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"description": "nostr.land family of relays (us-or-01)",
|
"description": "nostr.land family of relays (us-or-01)",
|
||||||
"name": "nostr.land",
|
"name": "nostr.land",
|
||||||
|
@ -357,3 +376,4 @@ As of 2 May 2023 the following command provided these results:
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
45
13.md
45
13.md
|
@ -48,37 +48,30 @@ Validating
|
||||||
Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id:
|
Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
#include <stdio.h>
|
int zero_bits(unsigned char b)
|
||||||
#include <stdlib.h>
|
{
|
||||||
#include <string.h>
|
int n = 0;
|
||||||
|
|
||||||
int countLeadingZeroes(const char *hex) {
|
if (b == 0)
|
||||||
int count = 0;
|
return 8;
|
||||||
|
|
||||||
for (int i = 0; i < strlen(hex); i++) {
|
while (b >>= 1)
|
||||||
int nibble = (int)strtol((char[]){hex[i], '\0'}, NULL, 16);
|
n++;
|
||||||
if (nibble == 0) {
|
|
||||||
count += 4;
|
|
||||||
} else {
|
|
||||||
count += __builtin_clz(nibble) - 28;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return count;
|
return 7-n;
|
||||||
}
|
}
|
||||||
|
|
||||||
int main(int argc, char *argv[]) {
|
/* find the number of leading zero bits in a hash */
|
||||||
if (argc != 2) {
|
int count_leading_zero_bits(unsigned char *hash)
|
||||||
fprintf(stderr, "Usage: %s <hex_string>\n", argv[0]);
|
{
|
||||||
return 1;
|
int bits, total, i;
|
||||||
}
|
for (i = 0, total = 0; i < 32; i++) {
|
||||||
|
bits = zero_bits(hash[i]);
|
||||||
const char *hex_string = argv[1];
|
total += bits;
|
||||||
int result = countLeadingZeroes(hex_string);
|
if (bits != 8)
|
||||||
printf("Leading zeroes in hex string %s: %d\n", hex_string, result);
|
break;
|
||||||
|
}
|
||||||
return 0;
|
return total;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
19
15.md
19
15.md
|
@ -73,10 +73,10 @@ Fields that are not self-explanatory:
|
||||||
|
|
||||||
**Event Tags**
|
**Event Tags**
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"tags": [["d", <string, id of stall]],
|
"tags": [["d", <string, id of stall]],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
- the `d` tag is required, its value MUST be the same as the stall `id`.
|
- the `d` tag is required, its value MUST be the same as the stall `id`.
|
||||||
|
@ -124,12 +124,12 @@ Fields that are not self-explanatory:
|
||||||
|
|
||||||
**Event Tags**
|
**Event Tags**
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
"tags": [
|
"tags": [
|
||||||
["d", <string, id of product],
|
["d", <string, id of product],
|
||||||
["t", <string (optional), product category],
|
["t", <string (optional), product category],
|
||||||
["t", <string (optional), product category],
|
["t", <string (optional), product category],
|
||||||
...
|
// other fields...
|
||||||
],
|
],
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
@ -158,7 +158,7 @@ The below JSON goes in content of [NIP-04](04.md).
|
||||||
"type": 0,
|
"type": 0,
|
||||||
"name": <string (optional), ???>,
|
"name": <string (optional), ???>,
|
||||||
"address": <string (optional), for physical goods an address should be provided>,
|
"address": <string (optional), for physical goods an address should be provided>,
|
||||||
"message": "<string (optional), message for merchant>,
|
"message": <string (optional), message for merchant>,
|
||||||
"contact": {
|
"contact": {
|
||||||
"nostr": <32-bytes hex of a pubkey>,
|
"nostr": <32-bytes hex of a pubkey>,
|
||||||
"phone": <string (optional), if the customer wants to be contacted by phone>,
|
"phone": <string (optional), if the customer wants to be contacted by phone>,
|
||||||
|
@ -237,7 +237,7 @@ Create a customized user experience using the `naddr` from [NIP-19](19.md#sharea
|
||||||
|
|
||||||
**Event Content**
|
**Event Content**
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"name": <string (optional), market name>,
|
"name": <string (optional), market name>,
|
||||||
"about": <string (optional), market description>,
|
"about": <string (optional), market description>,
|
||||||
|
@ -248,7 +248,7 @@ Create a customized user experience using the `naddr` from [NIP-19](19.md#sharea
|
||||||
"darkMode": <bool, true/false>
|
"darkMode": <bool, true/false>
|
||||||
},
|
},
|
||||||
"merchants": [array of pubkeys (optional)],
|
"merchants": [array of pubkeys (optional)],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -290,10 +290,11 @@ This event leverages naddr to enable comprehensive customization and sharing of
|
||||||
|
|
||||||
### Event `1021`: Bid
|
### Event `1021`: Bid
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": <int, amount of sats>,
|
"content": <int, amount of sats>,
|
||||||
"tags": [["e", <event ID of the auction to bid on>]],
|
"tags": [["e", <event ID of the auction to bid on>]],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -335,4 +336,4 @@ Customer support is handled over whatever communication method was specified. If
|
||||||
|
|
||||||
## Additional
|
## Additional
|
||||||
|
|
||||||
Standard data models can be found <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a>
|
Standard data models can be found [here](https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py)
|
||||||
|
|
12
17.md
12
17.md
|
@ -12,18 +12,18 @@ This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encr
|
||||||
|
|
||||||
Kind `14` is a chat message. `p` tags identify one or more receivers of the message.
|
Kind `14` is a chat message. `p` tags identify one or more receivers of the message.
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": "<usual hash>",
|
"id": "<usual hash>",
|
||||||
"pubkey": "<sender-pubkey>",
|
"pubkey": "<sender-pubkey>",
|
||||||
"created_at": now(),
|
"created_at": "<current-time>",
|
||||||
"kind": 14,
|
"kind": 14,
|
||||||
"tags": [
|
"tags": [
|
||||||
["p", "<receiver-1-pubkey>", "<relay-url>"],
|
["p", "<receiver-1-pubkey>", "<relay-url>"],
|
||||||
["p", "<receiver-2-pubkey>", "<relay-url>"],
|
["p", "<receiver-2-pubkey>", "<relay-url>"],
|
||||||
["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply
|
["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply
|
||||||
["subject", "<conversation-title>"],
|
["subject", "<conversation-title>"],
|
||||||
...
|
// rest of tags...
|
||||||
],
|
],
|
||||||
"content": "<message-in-plain-text>",
|
"content": "<message-in-plain-text>",
|
||||||
}
|
}
|
||||||
|
@ -47,7 +47,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An
|
||||||
|
|
||||||
Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually.
|
Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually.
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": "<usual hash>",
|
"id": "<usual hash>",
|
||||||
"pubkey": randomPublicKey,
|
"pubkey": randomPublicKey,
|
||||||
|
@ -86,7 +86,7 @@ Clients CAN offer disappearing messages by setting an `expiration` tag in the gi
|
||||||
|
|
||||||
Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs.
|
Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs.
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 10050,
|
"kind": 10050,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -94,7 +94,7 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS
|
||||||
["relay", "wss://myrelay.nostr1.com"],
|
["relay", "wss://myrelay.nostr1.com"],
|
||||||
],
|
],
|
||||||
"content": "",
|
"content": "",
|
||||||
//...other fields
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
8
18.md
8
18.md
|
@ -25,6 +25,14 @@ quote reposted. The `q` tag ensures quote reposts are not pulled and included
|
||||||
as replies in threads. It also allows you to easily pull and count all of the
|
as replies in threads. It also allows you to easily pull and count all of the
|
||||||
quotes for a post.
|
quotes for a post.
|
||||||
|
|
||||||
|
`q` tags should follow the same conventions as NIP 10 `e` tags, with the exception
|
||||||
|
of the `mark` argument.
|
||||||
|
|
||||||
|
`["q", <event-id>, <relay-url>, <pubkey>]`
|
||||||
|
|
||||||
|
Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the
|
||||||
|
event in the content.
|
||||||
|
|
||||||
## Generic Reposts
|
## Generic Reposts
|
||||||
|
|
||||||
Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16`
|
Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16`
|
||||||
|
|
184
22.md
Normal file
184
22.md
Normal file
|
@ -0,0 +1,184 @@
|
||||||
|
NIP-22
|
||||||
|
======
|
||||||
|
|
||||||
|
Comment
|
||||||
|
-------
|
||||||
|
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
A comment is a threading note always scoped to a root event or an `I`-tag.
|
||||||
|
|
||||||
|
It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting).
|
||||||
|
|
||||||
|
Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`)
|
||||||
|
and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`).
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 1111,
|
||||||
|
content: '<comment>',
|
||||||
|
tags: [
|
||||||
|
// root scope: event addresses, event ids, or I-tags.
|
||||||
|
["<A, E, I>", "<address, id or I-value>", "<relay or web page hint>", "<root event's pubkey, if an E tag>"],
|
||||||
|
// the root item kind
|
||||||
|
["K", "<root kind>"],
|
||||||
|
|
||||||
|
// parent item: event addresses, event ids, or i-tags.
|
||||||
|
["<a, e, i>", "<address, id or i-value>", "<relay or web page hint>", "<parent event's pubkey, if an e tag>"],
|
||||||
|
// parent item kind
|
||||||
|
["k", "<parent comment kind>"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Tags `K` and `k` MUST be present to define the event kind of the root and the parent items.
|
||||||
|
|
||||||
|
`I` and `i` tags create scopes for hashtags, geohashes, URLs, and other external identifiers.
|
||||||
|
|
||||||
|
The possible values for `i` tags – and `k` tags, when related to an extenal identity – are listed on [NIP-73](73.md).
|
||||||
|
Their uppercase versions use the same type of values but relate to the root item instead of the parent one.
|
||||||
|
|
||||||
|
`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md).
|
||||||
|
|
||||||
|
```json
|
||||||
|
["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]
|
||||||
|
```
|
||||||
|
|
||||||
|
`p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md).
|
||||||
|
If the parent item is an event, a `p` tag set to the parent event's author SHOULD be added.
|
||||||
|
|
||||||
|
```json
|
||||||
|
["p", "<pubkey>", "<relay-url>"]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
A comment on a blog post looks like this:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 1111,
|
||||||
|
content: 'Great blog post!',
|
||||||
|
tags: [
|
||||||
|
// top-level comments scope to event addresses or ids
|
||||||
|
["A", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"],
|
||||||
|
// the root kind
|
||||||
|
["K", "30023"],
|
||||||
|
|
||||||
|
// the parent event address (same as root for top-level comments)
|
||||||
|
["a", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"],
|
||||||
|
// when the parent event is replaceable or addressable, also include an `e` tag referencing its id
|
||||||
|
["e", "5b4fc7fed15672fefe65d2426f67197b71ccc82aa0cc8a9e94f683eb78e07651", "wss://example.relay"],
|
||||||
|
// the parent event kind
|
||||||
|
["k", "30023"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A comment on a [NIP-94](94.md) file looks like this:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 1111,
|
||||||
|
content: 'Great file!',
|
||||||
|
tags: [
|
||||||
|
// top-level comments have the same scope and reply to addresses or ids
|
||||||
|
["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"],
|
||||||
|
// the root kind
|
||||||
|
["K", "1063"],
|
||||||
|
|
||||||
|
// the parent event id (same as root for top-level comments)
|
||||||
|
["e", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"],
|
||||||
|
// the parent kind
|
||||||
|
["k", "1063"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A reply to a comment looks like this:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 1111,
|
||||||
|
content: 'This is a reply to "Great file!"',
|
||||||
|
tags: [
|
||||||
|
// nip-94 file event id
|
||||||
|
["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"],
|
||||||
|
// the root kind
|
||||||
|
["K", "1063"],
|
||||||
|
|
||||||
|
// the parent event
|
||||||
|
["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://example.relay", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"],
|
||||||
|
// the parent kind
|
||||||
|
["k", "1111"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A comment on a website's url looks like this:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 1111,
|
||||||
|
content: 'Nice article!',
|
||||||
|
tags: [
|
||||||
|
// referencing the root url
|
||||||
|
["I", "https://abc.com/articles/1"],
|
||||||
|
// the root "kind": for an url, the kind is its domain
|
||||||
|
["K", "https://abc.com"],
|
||||||
|
|
||||||
|
// the parent reference (same as root for top-level comments)
|
||||||
|
["i", "https://abc.com/articles/1"],
|
||||||
|
// the parent "kind": for an url, the kind is its domain
|
||||||
|
["k", "https://abc.com"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A podcast comment example:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
id: "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05",
|
||||||
|
pubkey: "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111",
|
||||||
|
kind: 1111,
|
||||||
|
content: "This was a great episode!",
|
||||||
|
tags: [
|
||||||
|
// podcast episode reference
|
||||||
|
["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"],
|
||||||
|
// podcast episode type
|
||||||
|
["K", "podcast:item:guid"],
|
||||||
|
|
||||||
|
// same value as "I" tag above, because it is a top-level comment (not a reply to a comment)
|
||||||
|
["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"],
|
||||||
|
["k", "podcast:item:guid"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A reply to a podcast comment:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 1111,
|
||||||
|
content: "I'm replying to the above comment.",
|
||||||
|
tags: [
|
||||||
|
// podcast episode reference
|
||||||
|
["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"],
|
||||||
|
// podcast episode type
|
||||||
|
["K", "podcast:item:guid"],
|
||||||
|
|
||||||
|
// this is a reference to the above comment
|
||||||
|
["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"],
|
||||||
|
// the parent comment kind
|
||||||
|
["k", "1111"]
|
||||||
|
]
|
||||||
|
// other fields
|
||||||
|
}
|
||||||
|
```
|
4
23.md
4
23.md
|
@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma
|
||||||
|
|
||||||
### Metadata
|
### 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` 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.
|
||||||
|
|
||||||
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:
|
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,7 +31,7 @@ Other metadata fields can be added as tags to the event as necessary. Here we st
|
||||||
|
|
||||||
### Editability
|
### Editability
|
||||||
|
|
||||||
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.
|
These articles are meant to be editable, so they should 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
|
### Linking
|
||||||
|
|
||||||
|
|
2
24.md
2
24.md
|
@ -6,7 +6,7 @@ Extra metadata fields and tags
|
||||||
|
|
||||||
`draft` `optional`
|
`draft` `optional`
|
||||||
|
|
||||||
This NIP defines extra optional fields added to events.
|
This NIP keeps track of extra optional fields that can added to events which are not defined anywhere else but have become _de facto_ standards and other minor implementation possibilities that do not deserve their own NIP and do not have a place in other NIPs.
|
||||||
|
|
||||||
kind 0
|
kind 0
|
||||||
======
|
======
|
||||||
|
|
8
25.md
8
25.md
|
@ -57,14 +57,14 @@ Reactions to a website
|
||||||
|
|
||||||
If the target of the reaction is a website, the reaction MUST be a `kind 17` event and MUST include an `r` tag with the website's URL.
|
If the target of the reaction is a website, the reaction MUST be a `kind 17` event and MUST include an `r` tag with the website's URL.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 17,
|
"kind": 17,
|
||||||
"content": "⭐",
|
"content": "⭐",
|
||||||
"tags": [
|
"tags": [
|
||||||
["r", "https://example.com/"]
|
["r", "https://example.com/"]
|
||||||
],
|
],
|
||||||
...other fields
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -79,14 +79,14 @@ 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
|
reaction content. The client should refer to the emoji tag and render the
|
||||||
content as an emoji if shortcode is specified.
|
content as an emoji if shortcode is specified.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 7,
|
"kind": 7,
|
||||||
"content": ":soapbox:",
|
"content": ":soapbox:",
|
||||||
"tags": [
|
"tags": [
|
||||||
["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"]
|
["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"]
|
||||||
],
|
],
|
||||||
...other fields
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
26
28.md
26
28.md
|
@ -25,10 +25,10 @@ Create a public chat channel.
|
||||||
|
|
||||||
In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41).
|
In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41).
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
|
"content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -52,11 +52,11 @@ Clients MAY add additional metadata fields.
|
||||||
|
|
||||||
Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
|
Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
|
"content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
|
||||||
"tags": [["e", <channel_create_event_id>, <relay-url>]],
|
"tags": [["e", <channel_create_event_id>, <relay-url>]],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -71,26 +71,26 @@ Clients SHOULD append [NIP-10](10.md) "p" tags to replies.
|
||||||
|
|
||||||
Root message:
|
Root message:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": <string>,
|
"content": <string>,
|
||||||
"tags": [["e", <kind_40_event_id>, <relay-url>, "root"]],
|
"tags": [["e", <kind_40_event_id>, <relay-url>, "root"]],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Reply to another message:
|
Reply to another message:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": <string>,
|
"content": <string>,
|
||||||
"tags": [
|
"tags": [
|
||||||
["e", <kind_40_event_id>, <relay-url>, "root"],
|
["e", <kind_40_event_id>, <relay-url>, "root"],
|
||||||
["e", <kind_42_event_id>, <relay-url>, "reply"],
|
["e", <kind_42_event_id>, <relay-url>, "reply"],
|
||||||
["p", <pubkey>, <relay-url>],
|
["p", <pubkey>, <relay-url>],
|
||||||
...
|
// rest of tags...
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -107,11 +107,11 @@ Clients MAY hide event 42s for other users other than the user who sent the even
|
||||||
|
|
||||||
(For example, if three users 'hide' an event giving a reason that includes the word 'pornography', a Nostr client that is an iOS app may choose to hide that message for all iOS clients.)
|
(For example, if three users 'hide' an event giving a reason that includes the word 'pornography', a Nostr client that is an iOS app may choose to hide that message for all iOS clients.)
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": "{\"reason\": \"Dick pic\"}",
|
"content": "{\"reason\": \"Dick pic\"}",
|
||||||
"tags": [["e", <kind_42_event_id>]],
|
"tags": [["e", <kind_42_event_id>]],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -125,11 +125,11 @@ Clients SHOULD hide event 42s shown to a given user, if there is an event 44 fro
|
||||||
|
|
||||||
Clients MAY hide event 42s for users other than the user who sent the event 44.
|
Clients MAY hide event 42s for users other than the user who sent the event 44.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": "{\"reason\": \"Posting dick pics\"}",
|
"content": "{\"reason\": \"Posting dick pics\"}",
|
||||||
"tags": [["p", <pubkey>]],
|
"tags": [["p", <pubkey>]],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
192
29.md
192
29.md
|
@ -22,9 +22,15 @@ Relays are supposed to generate the events that describe group metadata and grou
|
||||||
|
|
||||||
A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`.
|
A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`.
|
||||||
|
|
||||||
|
Group identifiers must be strings restricted to the characters `a-z0-9-_`, and SHOULD be random in order to avoid name collisions.
|
||||||
|
|
||||||
|
When encountering just the `<host>` without the `'<group-id>`, clients MAY infer `_` as the group id, which is a special top-level group dedicated to relay-local discussions.
|
||||||
|
|
||||||
## The `h` tag
|
## The `h` tag
|
||||||
|
|
||||||
Events sent by users to groups (chat messages, text notes, moderation events etc) must have an `h` tag with the value set to the group _id_.
|
Events sent by users to groups (chat messages, text notes, moderation events etc) MUST have an `h` tag with the value set to the group _id_.
|
||||||
|
|
||||||
|
`h` tags MAY include the group's name as the second argument. This allows `unmanaged` groups to be assigned human-readable names without relay support.
|
||||||
|
|
||||||
## Timeline references
|
## Timeline references
|
||||||
|
|
||||||
|
@ -36,68 +42,56 @@ This is a hack to prevent messages from being broadcasted to external relays tha
|
||||||
|
|
||||||
Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay.
|
Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay.
|
||||||
|
|
||||||
|
## Group management
|
||||||
|
|
||||||
|
Groups can have any number of users with elevated access. These users are identified by role labels which are arbitrarily defined by the relays (see also the description of `kind:39003`). What each role is capable of not defined in this NIP either, it's a relay policy that can vary. Roles can be assigned by other users (as long as they have the capability to add roles) by publishing a `kind:9000` event with that user's pubkey in a `p` tag and the roles afterwards (even if the user is already a group member a `kind:9000` can be issued and the user roles must just be updated).
|
||||||
|
|
||||||
|
The roles supported by the group as to having some special privilege assigned to them should be accessible on the event `kind:39003`, but the relay may also accept other role names, arbitrarily defined by clients, and just not do anything with them.
|
||||||
|
|
||||||
|
Users with any roles that have any privilege can be considered _admins_ in a broad sense and be returned in the `kind:39001` event for a group.
|
||||||
|
|
||||||
|
## Unmanaged groups
|
||||||
|
|
||||||
|
Unmanaged groups are impromptu groups that can be used in any public relay unaware of NIP-29 specifics. They piggyback on relays' natural white/blacklists (or lack of) but aside from that are not actively managed and won't have any admins, group state or metadata events.
|
||||||
|
|
||||||
|
In `unmanaged` groups, everybody is considered to be a member.
|
||||||
|
|
||||||
|
Unmanaged groups can transition to managed groups, in that case the relay master key just has to publish moderation events setting the state of all groups and start enforcing the rules they choose to.
|
||||||
|
|
||||||
## Event definitions
|
## Event definitions
|
||||||
|
|
||||||
- *text root note* (`kind:11`)
|
These are the events expected to be found in NIP-29 groups.
|
||||||
|
|
||||||
This is the basic unit of a "microblog" root text note sent to a group.
|
### Normal user-created events
|
||||||
|
|
||||||
```js
|
Groups may accept any event kind, including chats, threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag.
|
||||||
"kind": 11,
|
|
||||||
"content": "hello my friends lovers of pizza",
|
|
||||||
"tags": [
|
|
||||||
["h", "<group-id>"],
|
|
||||||
["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...]
|
|
||||||
]
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
- *threaded text reply* (`kind:12`)
|
### User-related group management events
|
||||||
|
|
||||||
This is the basic unit of a "microblog" reply note sent to a group. It's the same as `kind:11`, except for the fact that it must be used whenever it's in reply to some other note (either in reply to a `kind:11` or a `kind:12`). `kind:12` events SHOULD use NIP-10 markers, leaving an empty relay url:
|
These are events that can be sent by users to manage their situation in a group, they also require the `h` tag.
|
||||||
|
|
||||||
* `["e", "<kind-11-root-id>", "", "root"]`
|
|
||||||
* `["e", "<kind-12-event-id>", "", "reply"]`
|
|
||||||
|
|
||||||
- *chat message* (`kind:9`)
|
|
||||||
|
|
||||||
This is the basic unit of a _chat message_ sent to a group.
|
|
||||||
|
|
||||||
```js
|
|
||||||
"kind": 9,
|
|
||||||
"content": "hello my friends lovers of pizza",
|
|
||||||
"tags": [
|
|
||||||
["h", "<group-id>"],
|
|
||||||
["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...]
|
|
||||||
]
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
- *chat message threaded reply* (`kind:10`)
|
|
||||||
|
|
||||||
Similar to `kind:12`, this is the basic unit of a chat message sent to a group. This is intended for in-chat threads that may be hidden by default. Not all in-chat replies MUST use `kind:10`, only when the intention is to create a hidden thread that isn't part of the normal flow of the chat (although clients are free to display those by default too).
|
|
||||||
|
|
||||||
`kind:10` SHOULD use NIP-10 markers, just like `kind:12`.
|
|
||||||
|
|
||||||
- *join request* (`kind:9021`)
|
- *join request* (`kind:9021`)
|
||||||
|
|
||||||
Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them.
|
Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them.
|
||||||
|
|
||||||
```js
|
```json
|
||||||
{
|
{
|
||||||
"kind": 9021,
|
"kind": 9021,
|
||||||
"content": "optional reason",
|
"content": "optional reason",
|
||||||
"tags": [
|
"tags": [
|
||||||
["h", "<group-id>"]
|
["h", "<group-id>"],
|
||||||
|
["code", "<optional-invite-code>"]
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event.
|
||||||
|
|
||||||
- *leave request* (`kind:9022`)
|
- *leave request* (`kind:9022`)
|
||||||
|
|
||||||
Any user can send one of these events to the relay in order to be automatically removed from the group. The relay will automatically issue a `kind:9001` in response removing this user.
|
Any user can send one of these events to the relay in order to be automatically removed from the group. The relay will automatically issue a `kind:9001` in response removing this user.
|
||||||
|
|
||||||
```js
|
```json
|
||||||
{
|
{
|
||||||
"kind": 9022,
|
"kind": 9022,
|
||||||
"content": "optional reason",
|
"content": "optional reason",
|
||||||
|
@ -107,34 +101,42 @@ Any user can send one of these events to the relay in order to be automatically
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Group state -- or moderation
|
||||||
|
|
||||||
|
These are events expected to be sent by the relay master key or by group admins -- and relays should reject them if they don't come from an authorized admin. They also require the `h` tag.
|
||||||
|
|
||||||
- *moderation events* (`kinds:9000-9020`) (optional)
|
- *moderation events* (`kinds:9000-9020`) (optional)
|
||||||
|
|
||||||
Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action. The relay may discard the event after taking action or keep it as a moderation log.
|
Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action based on its role and the relay's internal policy (see also the description of `kind:39003`).
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 90xx,
|
"kind": 90xx,
|
||||||
"content": "optional reason",
|
"content": "optional reason",
|
||||||
"tags": [
|
"tags": [
|
||||||
["h", "<group-id>"],
|
["h", "<group-id>"],
|
||||||
["previous", ...]
|
["previous", /*...*/]
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table:
|
Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table:
|
||||||
|
|
||||||
| kind | name | tags |
|
| kind | name | tags |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| 9000 | `add-user` | `p` (pubkey hex) |
|
| 9000 | `put-user` | `p` with pubkey hex and optional roles |
|
||||||
| 9001 | `remove-user` | `p` (pubkey hex) |
|
| 9001 | `remove-user` | `p` with pubkey hex |
|
||||||
| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) |
|
| 9002 | `edit-metadata` | fields from `kind:39000` to be modified |
|
||||||
| 9003 | `add-permission` | `p` (pubkey), `permission` (name) |
|
| 9005 | `delete-event` | `e` with event id hex |
|
||||||
| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) |
|
| 9007 | `create-group` | |
|
||||||
| 9005 | `delete-event` | `e` (id hex) |
|
| 9008 | `delete-group` | |
|
||||||
| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` |
|
| 9009 | `create-invite` | |
|
||||||
| 9007 | `create-group` | |
|
|
||||||
| 9008 | `delete-group` | |
|
It's expected that the group state (of who is an allowed member or not, who is an admin and with which permission or not, what are the group name and picture etc) can be fully reconstructed from the canonical sequence of these events.
|
||||||
|
|
||||||
|
### Group metadata events
|
||||||
|
|
||||||
|
These events contain the group id in a `d` tag instead of the `h` tag. They MUST be created by the relay master key only and a single instance of each (or none) should exist at all times for each group. They are merely informative but should reflect the latest group state (as it was changed by moderation events over time).
|
||||||
|
|
||||||
- *group metadata* (`kind:39000`) (optional)
|
- *group metadata* (`kind:39000`) (optional)
|
||||||
|
|
||||||
|
@ -142,7 +144,9 @@ This event defines the metadata for the group -- basically how clients should di
|
||||||
|
|
||||||
If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on.
|
If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on.
|
||||||
|
|
||||||
```js
|
When this event is not found, clients may still connect to the group, but treat it as having a different status, `unmanaged`,
|
||||||
|
|
||||||
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 39000,
|
"kind": 39000,
|
||||||
"content": "",
|
"content": "",
|
||||||
|
@ -154,7 +158,7 @@ If the group is forked and hosted in multiple relays, there will be multiple ver
|
||||||
["public"], // or ["private"]
|
["public"], // or ["private"]
|
||||||
["open"] // or ["closed"]
|
["open"] // or ["closed"]
|
||||||
]
|
]
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -162,41 +166,29 @@ If the group is forked and hosted in multiple relays, there will be multiple ver
|
||||||
|
|
||||||
- *group admins* (`kind:39001`) (optional)
|
- *group admins* (`kind:39001`) (optional)
|
||||||
|
|
||||||
Similar to the group metadata, this event is supposed to be generated by relays that host the group.
|
Each admin is listed along with one or more roles. These roles SHOULD have a correspondence with the roles supported by the relay, as advertised by the `kind:39003` event.
|
||||||
|
|
||||||
Each admin gets a label that is only used for display purposes, and a list of permissions it has are listed afterwards. These permissions can inform client building UI, but ultimately are evaluated by the relay in order to become effective.
|
```jsonc
|
||||||
|
|
||||||
The list of capabilities, as defined by this NIP, for now, is the following:
|
|
||||||
|
|
||||||
- `add-user`
|
|
||||||
- `edit-metadata`
|
|
||||||
- `delete-event`
|
|
||||||
- `remove-user`
|
|
||||||
- `add-permission`
|
|
||||||
- `remove-permission`
|
|
||||||
- `edit-group-status`
|
|
||||||
- `delete-group`
|
|
||||||
|
|
||||||
```js
|
|
||||||
{
|
{
|
||||||
"kind": 39001,
|
"kind": 39001,
|
||||||
"content": "list of admins for the pizza lovers group",
|
"content": "list of admins for the pizza lovers group",
|
||||||
"tags": [
|
"tags": [
|
||||||
["d", "<group-id>"],
|
["d", "<group-id>"],
|
||||||
["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"],
|
["p", "<pubkey1-as-hex>", "ceo"],
|
||||||
["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"]
|
["p", "<pubkey2-as-hex>", "secretary", "gardener"],
|
||||||
]
|
// other pubkeys...
|
||||||
...
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- *group members* (`kind:39002`) (optional)
|
- *group members* (`kind:39002`) (optional)
|
||||||
|
|
||||||
Similar to *group admins*, this event is supposed to be generated by relays that host the group.
|
It's a list of pubkeys that are members of the group. Relays might choose to not to publish this information, to restrict what pubkeys can fetch it or to only display a subset of the members in it.
|
||||||
|
|
||||||
It's a NIP-51-like list of pubkeys that are members of the group. Relays might choose to not to publish this information or to restrict what pubkeys can fetch it.
|
Clients should not assume this will always be present or that it will contain a full list of members.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 39002,
|
"kind": 39002,
|
||||||
"content": "list of members for the pizza lovers group",
|
"content": "list of members for the pizza lovers group",
|
||||||
|
@ -205,10 +197,48 @@ It's a NIP-51-like list of pubkeys that are members of the group. Relays might c
|
||||||
["p", "<admin1>"],
|
["p", "<admin1>"],
|
||||||
["p", "<member-pubkey1>"],
|
["p", "<member-pubkey1>"],
|
||||||
["p", "<member-pubkey2>"],
|
["p", "<member-pubkey2>"],
|
||||||
]
|
// other pubkeys...
|
||||||
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Storing the list of groups a user belongs to
|
- *group roles* (`kind:39003`) (optional)
|
||||||
|
|
||||||
A definition for kind `10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in.
|
This is an event that MAY be published by the relay informing users and clients about what are the roles supported by this relay according to its internal logic.
|
||||||
|
|
||||||
|
For example, a relay may choose to support the roles `"admin"` and `"moderator"`, in which the `"admin"` will be allowed to edit the group metadata, delete messages and remove users from the group, while the `"moderator"` can only delete messages (or the relay may choose to call these roles `"ceo"` and `"secretary"` instead, the exact role name is not relevant).
|
||||||
|
|
||||||
|
The process through which the relay decides what roles to support and how to handle moderation events internally based on them is specific to each relay and not specified here.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 39003,
|
||||||
|
"content": "list of roles supported by this group",
|
||||||
|
"tags": [
|
||||||
|
["d", "<group-id>"],
|
||||||
|
["role", "<role-name>", "<optional-description>"],
|
||||||
|
["role", "<role-name>", "<optional-description>"],
|
||||||
|
// other roles...
|
||||||
|
],
|
||||||
|
// other fields...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Implementation quirks
|
||||||
|
|
||||||
|
### Checking your own membership in a group
|
||||||
|
|
||||||
|
The latest of either `kind:9000` or `kind:9001` events present in a group should tell a user that they are currently members of the group or if they were removed. In case none of these exist the user is assumed to not be a member of the group -- unless the group is `unmanaged`, in which case the user is assumed to be a member.
|
||||||
|
|
||||||
|
### Adding yourself to a group
|
||||||
|
|
||||||
|
When a group is `open`, anyone can send a `kind:9021` event to it in order to be added, then expect a `kind:9000` event to be emitted confirming that the user was added. The same happens with `closed` groups, except in that case a user may only send a `kind:9021` if it has an invite code.
|
||||||
|
|
||||||
|
### Storing your list of groups
|
||||||
|
|
||||||
|
A definition for `kind:10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in.
|
||||||
|
|
||||||
|
### Using `unmanaged` relays
|
||||||
|
|
||||||
|
To prevent event leakage, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays.
|
||||||
|
|
16
30.md
16
30.md
|
@ -54,3 +54,19 @@ In kind 1 events, the `content` should be emojified.
|
||||||
"created_at": 1682630000
|
"created_at": 1682630000
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Kind 7 events
|
||||||
|
|
||||||
|
In kind 7 events, the `content` should be emojified.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"kind": 7,
|
||||||
|
"content": ":dezh:",
|
||||||
|
"tags": [
|
||||||
|
["emoji", "dezh", "https://raw.githubusercontent.com/dezh-tech/brand-assets/main/dezh/logo/black-normal.svg"]
|
||||||
|
],
|
||||||
|
"pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
|
||||||
|
"created_at": 1682630000
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
30
32.md
30
32.md
|
@ -8,7 +8,7 @@ Labeling
|
||||||
|
|
||||||
This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification.
|
This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification.
|
||||||
|
|
||||||
New Tags:
|
New Tags:
|
||||||
|
|
||||||
- `L` denotes a label namespace
|
- `L` denotes a label namespace
|
||||||
- `l` denotes a label
|
- `l` denotes a label
|
||||||
|
@ -57,7 +57,7 @@ Example events
|
||||||
|
|
||||||
A suggestion that multiple pubkeys be associated with the `permies` topic.
|
A suggestion that multiple pubkeys be associated with the `permies` topic.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1985,
|
"kind": 1985,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -66,13 +66,13 @@ A suggestion that multiple pubkeys be associated with the `permies` topic.
|
||||||
["p", <pubkey1>, <relay_url>],
|
["p", <pubkey1>, <relay_url>],
|
||||||
["p", <pubkey2>, <relay_url>]
|
["p", <pubkey2>, <relay_url>]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
A report flagging violence toward a human being as defined by ontology.example.com.
|
A report flagging violence toward a human being as defined by ontology.example.com.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1985,
|
"kind": 1985,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -81,13 +81,13 @@ A report flagging violence toward a human being as defined by ontology.example.c
|
||||||
["p", <pubkey1>, <relay_url>],
|
["p", <pubkey1>, <relay_url>],
|
||||||
["p", <pubkey2>, <relay_url>]
|
["p", <pubkey2>, <relay_url>]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
A moderation suggestion for a chat event.
|
A moderation suggestion for a chat event.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1985,
|
"kind": 1985,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -95,13 +95,13 @@ A moderation suggestion for a chat event.
|
||||||
["l", "approve", "nip28.moderation"],
|
["l", "approve", "nip28.moderation"],
|
||||||
["e", <kind40_event_id>, <relay_url>]
|
["e", <kind40_event_id>, <relay_url>]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Assignment of a license to an event.
|
Assignment of a license to an event.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1985,
|
"kind": 1985,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -109,14 +109,14 @@ Assignment of a license to an event.
|
||||||
["l", "MIT", "license"],
|
["l", "MIT", "license"],
|
||||||
["e", <event_id>, <relay_url>]
|
["e", <event_id>, <relay_url>]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author
|
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.
|
is labeling their note as being related to Milan, Italy using ISO 3166-2.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1,
|
"kind": 1,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -124,13 +124,13 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2.
|
||||||
["l", "IT-MI", "ISO-3166-2"]
|
["l", "IT-MI", "ISO-3166-2"]
|
||||||
],
|
],
|
||||||
"content": "It's beautiful here in Milan!",
|
"content": "It's beautiful here in Milan!",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Author is labeling their note language as English using ISO-639-1.
|
Author is labeling their note language as English using ISO-639-1.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1,
|
"kind": 1,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -138,7 +138,7 @@ Author is labeling their note language as English using ISO-639-1.
|
||||||
["l", "en", "ISO-639-1"]
|
["l", "en", "ISO-639-1"]
|
||||||
],
|
],
|
||||||
"content": "English text",
|
"content": "English text",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -146,7 +146,7 @@ Other Notes
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement
|
When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement
|
||||||
may be published. We have opted not to use parameterizable/replaceable events for this due to the
|
may be published. We have opted not to use addressable/replaceable events for this due to the
|
||||||
complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying,
|
complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying,
|
||||||
publishers SHOULD limit labeling events to a single namespace.
|
publishers SHOULD limit labeling events to a single namespace.
|
||||||
|
|
||||||
|
@ -169,7 +169,7 @@ be handled in some other way.
|
||||||
|
|
||||||
|
|
||||||
Appendix: Known Ontologies
|
Appendix: Known Ontologies
|
||||||
-------------------------
|
--------------------------
|
||||||
|
|
||||||
Below is a non-exhaustive list of ontologies currently in widespread use.
|
Below is a non-exhaustive list of ontologies currently in widespread use.
|
||||||
|
|
||||||
|
|
14
34.md
14
34.md
|
@ -104,15 +104,20 @@ The first patch in a series MAY be a cover letter in the format produced by `git
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
|
|
||||||
Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag.
|
Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag.
|
||||||
|
|
||||||
```jsonc
|
Issues may have a `subject` tag, which clients can utilize to display a header. Additionally, one or more `t` tags may be included to provide labels for the issue.
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"kind": 1621,
|
"kind": 1621,
|
||||||
"content": "<markdown text>",
|
"content": "<markdown text>",
|
||||||
"tags": [
|
"tags": [
|
||||||
["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"],
|
["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"],
|
||||||
["p", "<repository-owner>"]
|
["p", "<repository-owner>"]
|
||||||
|
["subject", "<issue-subject>"]
|
||||||
|
["t", "<issue-label>"]
|
||||||
|
["t", "<another-issue-label>"]
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -132,8 +137,9 @@ Replies are also Markdown text. The difference is that they MUST be issued as re
|
||||||
// other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10
|
// other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10
|
||||||
["p", "<patch-author-pubkey-hex>", "", "mention"],
|
["p", "<patch-author-pubkey-hex>", "", "mention"],
|
||||||
["e", "<previous-reply-id-hex>", "", "reply"],
|
["e", "<previous-reply-id-hex>", "", "reply"],
|
||||||
// ...
|
// rest of tags...
|
||||||
]
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
2
35.md
2
35.md
|
@ -37,7 +37,7 @@ A second level prefix should be included where the database supports multiple me
|
||||||
|
|
||||||
In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish.
|
In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"kind": 2003,
|
"kind": 2003,
|
||||||
"content": "<long-description-pre-formatted>",
|
"content": "<long-description-pre-formatted>",
|
||||||
|
|
6
38.md
6
38.md
|
@ -17,7 +17,7 @@ A special event with `kind:30315` "User Status" is defined as an *optionally exp
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```js
|
```json
|
||||||
{
|
{
|
||||||
"kind": 30315,
|
"kind": 30315,
|
||||||
"content": "Sign up for nostrasia!",
|
"content": "Sign up for nostrasia!",
|
||||||
|
@ -26,7 +26,9 @@ For example:
|
||||||
["r", "https://nostr.world"]
|
["r", "https://nostr.world"]
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"kind": 30315,
|
"kind": 30315,
|
||||||
"content": "Intergalatic - Beastie Boys",
|
"content": "Intergalatic - Beastie Boys",
|
||||||
|
@ -44,7 +46,7 @@ Two common status types are defined: `general` and `music`. `general` represent
|
||||||
|
|
||||||
Any other status types can be used but they are not defined by this NIP.
|
Any other status types can be used but they are not defined by this NIP.
|
||||||
|
|
||||||
The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event.
|
The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or addressable event.
|
||||||
|
|
||||||
The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status.
|
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.
|
||||||
|
|
||||||
|
|
5
39.md
5
39.md
|
@ -13,7 +13,8 @@ Nostr protocol users may have other online identities such as usernames, profile
|
||||||
## `i` tag on a metadata event
|
## `i` tag on a metadata event
|
||||||
|
|
||||||
A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md):
|
A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md):
|
||||||
```json
|
|
||||||
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": <id>,
|
"id": <id>,
|
||||||
"pubkey": <pubkey>,
|
"pubkey": <pubkey>,
|
||||||
|
@ -23,7 +24,7 @@ A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP
|
||||||
["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"]
|
["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"]
|
||||||
["i", "telegram:1087295469", "nostrdirectory/770"]
|
["i", "telegram:1087295469", "nostrdirectory/770"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
8
42.md
8
42.md
|
@ -22,13 +22,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 has the following form:
|
This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form:
|
||||||
|
|
||||||
```json
|
```
|
||||||
["AUTH", <challenge-string>]
|
["AUTH", <challenge-string>]
|
||||||
```
|
```
|
||||||
|
|
||||||
And, when sent by clients, the following form:
|
And, when sent by clients, the following form:
|
||||||
|
|
||||||
```json
|
```
|
||||||
["AUTH", <signed-event-json>]
|
["AUTH", <signed-event-json>]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -38,14 +38,14 @@ And, when sent by clients, the following form:
|
||||||
|
|
||||||
The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example:
|
The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 22242,
|
"kind": 22242,
|
||||||
"tags": [
|
"tags": [
|
||||||
["relay", "wss://relay.example.com/"],
|
["relay", "wss://relay.example.com/"],
|
||||||
["challenge", "challengestringhere"]
|
["challenge", "challengestringhere"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
2
44.md
2
44.md
|
@ -142,6 +142,8 @@ validation rules, refer to BIP-340.
|
||||||
The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method
|
The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method
|
||||||
`bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid,
|
`bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid,
|
||||||
on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`.
|
on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`.
|
||||||
|
NIP44 doesn't do hashing of the output: keep this in mind, because some libraries hash it using sha256.
|
||||||
|
As an example, in libsecp256k1, unhashed version is available in `secp256k1_ec_pubkey_tweak_mul`
|
||||||
- Operators
|
- Operators
|
||||||
- `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the
|
- `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the
|
||||||
`i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`.
|
`i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`.
|
||||||
|
|
226
46.md
226
46.md
|
@ -4,6 +4,10 @@ NIP-46
|
||||||
Nostr Remote Signing
|
Nostr Remote Signing
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect, nip05 login is removed, create_account moved to another NIP.
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface.
|
Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface.
|
||||||
|
@ -12,102 +16,70 @@ This NIP describes a method for 2-way communication between a remote signer and
|
||||||
|
|
||||||
## Terminology
|
## Terminology
|
||||||
|
|
||||||
- **Local keypair**: A local public and private key-pair used to encrypt content and communicate with the remote signer. Usually created by the client application.
|
- **user**: A person that is trying to use Nostr.
|
||||||
- **Remote user pubkey**: The public key that the user wants to sign as. The remote signer has control of the private key that matches this public key.
|
- **client**: A user-facing application that _user_ is looking at and clicking buttons in. This application will send requests to _remote-signer_.
|
||||||
- **Remote signer pubkey**: This is the public key of the remote signer itself. This is needed in both `create_account` command because you don't yet have a remote user pubkey.
|
- **remote-signer**: A daemon or server running somewhere that will answer requests from _client_, also known as "bunker".
|
||||||
|
- **client-keypair/pubkey**: The keys generated by _client_. Used to encrypt content and communicate with _remote-signer_.
|
||||||
|
- **remote-signer-keypair/pubkey**: The keys used by _remote-signer_ to encrypt content and communicate with _client_. This keypair MAY be same as _user-keypair_, but not necessarily.
|
||||||
|
- **user-keypair/pubkey**: The actual keys representing _user_ (that will be used to sign events in response to `sign_event` requests, for example). The _remote-signer_ generally has control over these keys.
|
||||||
|
|
||||||
All pubkeys specified in this NIP are in hex format.
|
All pubkeys specified in this NIP are in hex format.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
1. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout;
|
||||||
|
2. A connection is established (see below), _remote-signer_ learns `client-pubkey`, _client_ learns `remote-signer-pubkey`.
|
||||||
|
3. _client_ uses `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`;
|
||||||
|
4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`.
|
||||||
|
5. _client_ requests `get_public_key` to learn `user-pubkey`.
|
||||||
|
|
||||||
## Initiating a connection
|
## Initiating a connection
|
||||||
|
|
||||||
To initiate a connection between a client and a remote signer there are a few different options.
|
There are two ways to initiate a connection:
|
||||||
|
|
||||||
### Direct connection initiated by remote signer
|
### Direct connection initiated by _remote-signer_
|
||||||
|
|
||||||
This is most common in a situation where you have your own nsecbunker or other type of remote signer and want to connect through a client that supports remote signing.
|
_remote-signer_ provides connection token in the form:
|
||||||
|
|
||||||
The remote signer would provide a connection token in the form:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
|
bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
|
||||||
```
|
```
|
||||||
|
|
||||||
This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old optional secret.
|
_user_ passes this token to _client_, which then sends `connect` request to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old secret.
|
||||||
|
|
||||||
### Direct connection initiated by the client
|
### Direct connection initiated by the _client_
|
||||||
|
|
||||||
In this case, basically the opposite direction of the first case, the client provides a connection token (or encodes the token in a QR code) and the signer initiates a connection to the client via the specified relay(s).
|
_client_ provides a connection token using `nostrconnect://` as the protocol, and `client-pubkey` as the origin. Additional information should be passed as query parameters:
|
||||||
|
|
||||||
|
- `relay` (required) - one or more relay urls on which the _client_ is listening for responses from the _remote-signer_.
|
||||||
|
- `secret` (required) - a short random string that the _remote-signer_ should return as the `result` field of its response.
|
||||||
|
- `perms` (optional) - a comma-separated list of permissions the _client_ is requesting be approved by the _remote-signer_
|
||||||
|
- `name` (optional) - the name of the _client_ application
|
||||||
|
- `url` (optional) - the canonical url of the _client_ application
|
||||||
|
- `image` (optional) - a small image representing the _client_ application
|
||||||
|
|
||||||
|
Here's an example:
|
||||||
|
|
||||||
```
|
```
|
||||||
nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}>
|
nostrconnect://83f3b2ae6aa368e8275397b9c26cf550101d63ebaab900d19dd4a4429f5ad8f5?relay=wss%3A%2F%2Frelay1.example.com&perms=nip44_encrypt%2Cnip44_decrypt%2Csign_event%3A13%2Csign_event%3A14%2Csign_event%3A1059&name=My+Client&secret=0s8j2djs&relay=wss%3A%2F%2Frelay2.example2.com
|
||||||
```
|
```
|
||||||
|
|
||||||
## The flow
|
_user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response.
|
||||||
|
|
||||||
1. Client creates a local keypair. This keypair doesn't need to be communicated to the user since it's largely disposable (i.e. the user doesn't need to see this pubkey). Clients might choose to store it locally and they should delete it when the user logs out.
|
|
||||||
2. Client gets the remote user pubkey (either via a `bunker://` connection string or a NIP-05 login-flow; shown below)
|
|
||||||
3. Clients use the local keypair to send requests to the remote signer by `p`-tagging and encrypting to the remote user pubkey.
|
|
||||||
4. The remote signer responds to the client by `p`-tagging and encrypting to the local keypair pubkey.
|
|
||||||
|
|
||||||
### Example flow for signing an event
|
|
||||||
|
|
||||||
- Remote user pubkey (e.g. signing as) `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
|
|
||||||
- Local pubkey is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86`
|
|
||||||
|
|
||||||
#### Signature request
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"kind": 24133,
|
|
||||||
"pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
|
|
||||||
"content": nip04({
|
|
||||||
"id": <random_string>,
|
|
||||||
"method": "sign_event",
|
|
||||||
"params": [json_stringified(<{
|
|
||||||
content: "Hello, I'm signing remotely",
|
|
||||||
kind: 1,
|
|
||||||
tags: [],
|
|
||||||
created_at: 1714078911
|
|
||||||
}>)]
|
|
||||||
}),
|
|
||||||
"tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Response event
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"kind": 24133,
|
|
||||||
"pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
|
|
||||||
"content": nip04({
|
|
||||||
"id": <random_string>,
|
|
||||||
"result": json_stringified(<signed-event>)
|
|
||||||
}),
|
|
||||||
"tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the local keypair pubkey
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Diagram
|
|
||||||
|
|
||||||
![signing-example](https://i.nostr.build/P3gW.png)
|
|
||||||
|
|
||||||
## Request Events `kind: 24133`
|
## Request Events `kind: 24133`
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": <id>,
|
|
||||||
"kind": 24133,
|
"kind": 24133,
|
||||||
"pubkey": <local_keypair_pubkey>,
|
"pubkey": <local_keypair_pubkey>,
|
||||||
"content": <nip04(<request>)>,
|
"content": <nip04(<request>)>,
|
||||||
"tags": [["p", <remote_user_pubkey>]], // NB: in the `create_account` event, the remote signer pubkey should be `p` tagged.
|
"tags": [["p", <remote-signer-pubkey>]],
|
||||||
"created_at": <unix timestamp in seconds>
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure:
|
The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": <random_string>,
|
"id": <random_string>,
|
||||||
"method": <method_name>,
|
"method": <method_name>,
|
||||||
|
@ -121,15 +93,15 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted
|
||||||
|
|
||||||
### Methods/Commands
|
### Methods/Commands
|
||||||
|
|
||||||
Each of the following are methods that the client sends to the remote signer.
|
Each of the following are methods that the _client_ sends to the _remote-signer_.
|
||||||
|
|
||||||
| Command | Params | Result |
|
| Command | Params | Result |
|
||||||
| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- |
|
| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" |
|
| `connect` | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" OR `<required-secret-value>` |
|
||||||
| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` |
|
| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` |
|
||||||
| `ping` | `[]` | "pong" |
|
| `ping` | `[]` | "pong" |
|
||||||
| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` |
|
| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` |
|
||||||
| `get_public_key` | `[]` | `<hex-pubkey>` |
|
| `get_public_key` | `[]` | `<user-pubkey>` |
|
||||||
| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` |
|
| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` |
|
||||||
| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` |
|
| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` |
|
||||||
| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` |
|
| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` |
|
||||||
|
@ -137,7 +109,7 @@ Each of the following are methods that the client sends to the remote signer.
|
||||||
|
|
||||||
### Requested permissions
|
### Requested permissions
|
||||||
|
|
||||||
The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later.
|
The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string.
|
||||||
|
|
||||||
## Response Events `kind:24133`
|
## Response Events `kind:24133`
|
||||||
|
|
||||||
|
@ -145,9 +117,9 @@ The `connect` method may be provided with `optional_requested_permissions` for u
|
||||||
{
|
{
|
||||||
"id": <id>,
|
"id": <id>,
|
||||||
"kind": 24133,
|
"kind": 24133,
|
||||||
"pubkey": <remote_signer_pubkey>,
|
"pubkey": <remote-signer-pubkey>,
|
||||||
"content": <nip04(<response>)>,
|
"content": <nip04(<response>)>,
|
||||||
"tags": [["p", <local_keypair_pubkey>]],
|
"tags": [["p", <client-pubkey>]],
|
||||||
"created_at": <unix timestamp in seconds>
|
"created_at": <unix timestamp in seconds>
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -166,9 +138,54 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted
|
||||||
- `results` is a string of the result of the call (this can be either a string or a JSON stringified object)
|
- `results` is a string of the result of the call (this can be either a string or a JSON stringified object)
|
||||||
- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request.
|
- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request.
|
||||||
|
|
||||||
### Auth Challenges
|
## Example flow for signing an event
|
||||||
|
|
||||||
An Auth Challenge is a response that a remote signer can send back when it needs the user to authenticate via other means. This is currently used in the OAuth-like flow enabled by signers like [Nsecbunker](https://github.com/kind-0/nsecbunkerd/). The response `content` object will take the following form:
|
- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
|
||||||
|
- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
|
||||||
|
- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86`
|
||||||
|
|
||||||
|
### Signature request
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 24133,
|
||||||
|
"pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
|
||||||
|
"content": nip04({
|
||||||
|
"id": <random_string>,
|
||||||
|
"method": "sign_event",
|
||||||
|
"params": [json_stringified(<{
|
||||||
|
content: "Hello, I'm signing remotely",
|
||||||
|
kind: 1,
|
||||||
|
tags: [],
|
||||||
|
created_at: 1714078911
|
||||||
|
}>)]
|
||||||
|
}),
|
||||||
|
"tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Response event
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 24133,
|
||||||
|
"pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
|
||||||
|
"content": nip04({
|
||||||
|
"id": <random_string>,
|
||||||
|
"result": json_stringified(<signed-event>)
|
||||||
|
}),
|
||||||
|
"tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Diagram
|
||||||
|
|
||||||
|
![signing-example](https://i.nostr.build/P3gW.png)
|
||||||
|
|
||||||
|
|
||||||
|
## Auth Challenges
|
||||||
|
|
||||||
|
An Auth Challenge is a response that a _remote-signer_ can send back when it needs the _user_ to authenticate via other means. The response `content` object will take the following form:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
@ -178,54 +195,33 @@ An Auth Challenge is a response that a remote signer can send back when it needs
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Clients should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the remote signer (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). It's also possible to add a `redirect_uri` url parameter to the auth_url, which is helpful in situations when a client cannot open a new window or tab to display the auth challenge.
|
_client_ should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the _remote-signer_ (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate).
|
||||||
|
|
||||||
#### Example event signing request with auth challenge
|
### Example event signing request with auth challenge
|
||||||
|
|
||||||
![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png)
|
![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png)
|
||||||
|
|
||||||
## Remote Signer Commands
|
|
||||||
|
|
||||||
Remote signers might support additional commands when communicating directly with it. These commands follow the same flow as noted above, the only difference is that when the client sends a request event, the `p`-tag is the pubkey of the remote signer itself and the `content` payload is encrypted to the same remote signer pubkey.
|
|
||||||
|
|
||||||
### Methods/Commands
|
|
||||||
|
|
||||||
Each of the following are methods that the client sends to the remote signer.
|
|
||||||
|
|
||||||
| Command | Params | Result |
|
|
||||||
| ---------------- | ------------------------------------------ | ------------------------------------ |
|
|
||||||
| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` |
|
|
||||||
|
|
||||||
## Appendix
|
## Appendix
|
||||||
|
|
||||||
### NIP-05 Login Flow
|
### Announcing _remote-signer_ metadata
|
||||||
|
|
||||||
Clients might choose to present a more familiar login flow, so users can type a NIP-05 address instead of a `bunker://` string.
|
_remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"names":{
|
||||||
|
"_": <remote-signer-app-pubkey>,
|
||||||
|
},
|
||||||
|
"nip46": {
|
||||||
|
"relays": ["wss://relay1","wss://relay2"...],
|
||||||
|
"nostrconnect_url": "https://remote-signer-domain.com/<nostrconnect>"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
When the user types a NIP-05 the client:
|
The `<remote-signer-app-pubkey>` MAY be used to verify the domain from _remote-signer_'s NIP-89 event (see below). `relays` SHOULD be used to construct a more precise `nostrconnect://` string for the specific `remote-signer`. `nostrconnect_url` template MAY be used to redirect users to _remote-signer_'s connection flow by replacing `<nostrconnect>` placeholder with an actual `nostrconnect://` string.
|
||||||
|
|
||||||
- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the **remote user pubkey**)
|
### Remote signer discovery via NIP-89
|
||||||
- In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on.
|
|
||||||
- Now the client has enough information to send commands to the remote signer on behalf of the user.
|
|
||||||
|
|
||||||
### OAuth-like Flow
|
_remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above.
|
||||||
|
|
||||||
#### Remote signer discovery via NIP-89
|
_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`.
|
||||||
|
|
||||||
In this last case, most often used to facilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events.
|
|
||||||
|
|
||||||
First the client will query for `kind: 31990` events that have a `k` tag of `24133`.
|
|
||||||
|
|
||||||
These are generally shown to a user, and once the user selects which remote signer to use and provides the remote user pubkey they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the remote signer that is actually managing the remote key that they would like to use in this case. If the remote user pubkey is managed on another remote signer, the connection will fail.
|
|
||||||
|
|
||||||
In addition, it's important that clients validate that the pubkey of the announced remote signer matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain.
|
|
||||||
|
|
||||||
Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username.
|
|
||||||
|
|
||||||
#### Example Oauth-like flow to create a new user account with Nsecbunker
|
|
||||||
|
|
||||||
Coming soon...
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
- [NIP-04 - Encryption](04.md)
|
|
||||||
|
|
140
47.md
140
47.md
|
@ -8,32 +8,42 @@ Nostr Wallet Connect
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
This NIP describes a way for clients to access a remote Lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol.
|
This NIP describes a way for clients to access a remote lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol.
|
||||||
|
|
||||||
## Terms
|
## Terms
|
||||||
|
|
||||||
* **client**: Nostr app on any platform that wants to pay Lightning invoices.
|
* **client**: Nostr app on any platform that wants to interact with a lightning wallet.
|
||||||
* **user**: The person using the **client**, and want's to connect their wallet app to their **client**.
|
* **user**: The person using the **client**, and wants to connect their wallet to their **client**.
|
||||||
* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves.
|
* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves.
|
||||||
|
|
||||||
## Theory of Operation
|
## Theory of Operation
|
||||||
1. **Users** who wish to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means.
|
1. **Users** who wish to use this NIP to allow **client(s)** to interact with their wallet must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means.
|
||||||
|
|
||||||
2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event.
|
2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** (or the **client** on the user's behalf) wants to interact with the wallet. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event.
|
||||||
|
|
||||||
3. When the **user** initiates a payment their nostr **client** create a `pay_invoice` request, encrypts it using a token from the URI, and sends it (kind 23194) to the relay(s) specified in the connection URI. The **wallet service** will be listening on those relays and will decrypt the request and then contact the **user's** wallet application to send the payment. The **wallet service** will know how to talk to the wallet application because the connection URI specified relay(s) that have access to the wallet app API.
|
3. When the **user** initiates a payment their nostr **client** create a `pay_invoice` request, encrypts it using a token from the URI, and sends it (kind 23194) to the relay(s) specified in the connection URI. The **wallet service** will be listening on those relays and will decrypt the request and then contact the **user's** wallet application to send the payment. The **wallet service** will know how to talk to the wallet application because the connection URI specified relay(s) that have access to the wallet app API.
|
||||||
|
|
||||||
4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI.
|
4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI.
|
||||||
|
|
||||||
|
5. The **wallet service** may send encrypted notifications (kind 23196) of wallet events (such as a received payment) to the **client**.
|
||||||
|
|
||||||
## Events
|
## Events
|
||||||
|
|
||||||
There are three event kinds:
|
There are four event kinds:
|
||||||
- `NIP-47 info event`: 13194
|
- `NIP-47 info event`: 13194
|
||||||
- `NIP-47 request`: 23194
|
- `NIP-47 request`: 23194
|
||||||
- `NIP-47 response`: 23195
|
- `NIP-47 response`: 23195
|
||||||
|
- `NIP-47 notification event`: 23196
|
||||||
|
|
||||||
The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be
|
### Info Event
|
||||||
a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs.
|
|
||||||
|
The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which capabilities it supports.
|
||||||
|
|
||||||
|
The content should be a plaintext string with the supported capabilities space-separated, eg. `pay_invoice get_balance notifications`.
|
||||||
|
|
||||||
|
If the **wallet service** supports notifications, the info event SHOULD contain a `notifications` tag with the supported notification types space-separated, eg. `payment_received payment_sent`.
|
||||||
|
|
||||||
|
### Request and Response Events
|
||||||
|
|
||||||
Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to.
|
Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to.
|
||||||
Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored.
|
Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored.
|
||||||
|
@ -68,6 +78,22 @@ The `result_type` field MUST contain the name of the method that this event is r
|
||||||
The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful.
|
The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful.
|
||||||
If the command was successful, the `error` field must be null.
|
If the command was successful, the `error` field must be null.
|
||||||
|
|
||||||
|
### Notification Events
|
||||||
|
|
||||||
|
The notification event SHOULD contain one `p` tag, the public key of the **user**.
|
||||||
|
|
||||||
|
The content of notifications is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"notification_type": "payment_received", //indicates the structure of the notification field
|
||||||
|
"notification": {
|
||||||
|
"payment_hash": "0123456789abcdef..." // notification-related data
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Error codes
|
### Error codes
|
||||||
- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds.
|
- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds.
|
||||||
- `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented.
|
- `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented.
|
||||||
|
@ -120,7 +146,8 @@ Response:
|
||||||
{
|
{
|
||||||
"result_type": "pay_invoice",
|
"result_type": "pay_invoice",
|
||||||
"result": {
|
"result": {
|
||||||
"preimage": "0123456789abcdef..." // preimage of the payment
|
"preimage": "0123456789abcdef...", // preimage of the payment
|
||||||
|
"fees_paid": 123, // value in msats, optional
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -148,14 +175,15 @@ Request:
|
||||||
Response:
|
Response:
|
||||||
|
|
||||||
For every invoice in the request, a separate response event is sent. To differentiate between the responses, each
|
For every invoice in the request, a separate response event is sent. To differentiate between the responses, each
|
||||||
response event contains an `d` tag with the id of the invoice it is responding to, if no id was given, then the
|
response event contains a `d` tag with the id of the invoice it is responding to, if no id was given, then the
|
||||||
payment hash of the invoice should be used.
|
payment hash of the invoice should be used.
|
||||||
|
|
||||||
```jsonc
|
```jsonc
|
||||||
{
|
{
|
||||||
"result_type": "multi_pay_invoice",
|
"result_type": "multi_pay_invoice",
|
||||||
"result": {
|
"result": {
|
||||||
"preimage": "0123456789abcdef..." // preimage of the payment
|
"preimage": "0123456789abcdef...", // preimage of the payment
|
||||||
|
"fees_paid": 123, // value in msats, optional
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -173,7 +201,7 @@ Request:
|
||||||
"amount": 123, // invoice amount in msats, required
|
"amount": 123, // invoice amount in msats, required
|
||||||
"pubkey": "03...", // payee pubkey, required
|
"pubkey": "03...", // payee pubkey, required
|
||||||
"preimage": "0123456789abcdef...", // preimage of the payment, optional
|
"preimage": "0123456789abcdef...", // preimage of the payment, optional
|
||||||
"tlv_records: [ // tlv records, optional
|
"tlv_records": [ // tlv records, optional
|
||||||
{
|
{
|
||||||
"type": 5482373484, // tlv type
|
"type": 5482373484, // tlv type
|
||||||
"value": "0123456789abcdef" // hex encoded tlv value
|
"value": "0123456789abcdef" // hex encoded tlv value
|
||||||
|
@ -189,6 +217,7 @@ Response:
|
||||||
"result_type": "pay_keysend",
|
"result_type": "pay_keysend",
|
||||||
"result": {
|
"result": {
|
||||||
"preimage": "0123456789abcdef...", // preimage of the payment
|
"preimage": "0123456789abcdef...", // preimage of the payment
|
||||||
|
"fees_paid": 123, // value in msats, optional
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -208,7 +237,7 @@ Request:
|
||||||
"method": "multi_pay_keysend",
|
"method": "multi_pay_keysend",
|
||||||
"params": {
|
"params": {
|
||||||
"keysends": [
|
"keysends": [
|
||||||
{"id": "4c5b24a351", pubkey": "03...", "amount": 123},
|
{"id": "4c5b24a351", "pubkey": "03...", "amount": 123},
|
||||||
{"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]},
|
{"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]},
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
@ -225,7 +254,8 @@ pubkey should be used.
|
||||||
{
|
{
|
||||||
"result_type": "multi_pay_keysend",
|
"result_type": "multi_pay_keysend",
|
||||||
"result": {
|
"result": {
|
||||||
"preimage": "0123456789abcdef..." // preimage of the payment
|
"preimage": "0123456789abcdef...", // preimage of the payment
|
||||||
|
"fees_paid": 123, // value in msats, optional
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -358,8 +388,7 @@ Request:
|
||||||
```jsonc
|
```jsonc
|
||||||
{
|
{
|
||||||
"method": "get_balance",
|
"method": "get_balance",
|
||||||
"params": {
|
"params": {}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -379,8 +408,7 @@ Request:
|
||||||
```jsonc
|
```jsonc
|
||||||
{
|
{
|
||||||
"method": "get_info",
|
"method": "get_info",
|
||||||
"params": {
|
"params": {}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -396,6 +424,59 @@ Response:
|
||||||
"block_height": 1,
|
"block_height": 1,
|
||||||
"block_hash": "hex string",
|
"block_hash": "hex string",
|
||||||
"methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection
|
"methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection
|
||||||
|
"notifications": ["payment_received", "payment_sent"], // list of supported notifications for this connection, optional.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notifications
|
||||||
|
|
||||||
|
### `payment_received`
|
||||||
|
|
||||||
|
Description: A payment was successfully received by the wallet.
|
||||||
|
|
||||||
|
Notification:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"notification_type": "payment_received",
|
||||||
|
"notification": {
|
||||||
|
"type": "incoming",
|
||||||
|
"invoice": "string", // encoded invoice
|
||||||
|
"description": "string", // invoice's description, optional
|
||||||
|
"description_hash": "string", // invoice's description hash, optional
|
||||||
|
"preimage": "string", // payment's preimage
|
||||||
|
"payment_hash": "string", // Payment hash for the payment
|
||||||
|
"amount": 123, // value in msats
|
||||||
|
"fees_paid": 123, // value in msats
|
||||||
|
"created_at": unixtimestamp, // invoice/payment creation time
|
||||||
|
"expires_at": unixtimestamp, // invoice expiration time, optional if not applicable
|
||||||
|
"settled_at": unixtimestamp, // invoice/payment settlement time
|
||||||
|
"metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### `payment_sent`
|
||||||
|
|
||||||
|
Description: A payment was successfully sent by the wallet.
|
||||||
|
|
||||||
|
Notification:
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"notification_type": "payment_sent",
|
||||||
|
"notification": {
|
||||||
|
"type": "outgoing",
|
||||||
|
"invoice": "string", // encoded invoice
|
||||||
|
"description": "string", // invoice's description, optional
|
||||||
|
"description_hash": "string", // invoice's description hash, optional
|
||||||
|
"preimage": "string", // payment's preimage
|
||||||
|
"payment_hash": "string", // Payment hash for the payment
|
||||||
|
"amount": 123, // value in msats
|
||||||
|
"fees_paid": 123, // value in msats
|
||||||
|
"created_at": unixtimestamp, // invoice/payment creation time
|
||||||
|
"expires_at": unixtimestamp, // invoice expiration time, optional if not applicable
|
||||||
|
"settled_at": unixtimestamp, // invoice/payment settlement time
|
||||||
|
"metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc.
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -409,3 +490,24 @@ Response:
|
||||||
|
|
||||||
## Using a dedicated relay
|
## Using a dedicated relay
|
||||||
This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case.
|
This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case.
|
||||||
|
|
||||||
|
## Appendix
|
||||||
|
|
||||||
|
### Example NIP-47 info event
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"id": "df467db0a9f9ec77ffe6f561811714ccaa2e26051c20f58f33c3d66d6c2b4d1c",
|
||||||
|
"pubkey": "c04ccd5c82fc1ea3499b9c6a5c0a7ab627fbe00a0116110d4c750faeaecba1e2",
|
||||||
|
"created_at": 1713883677,
|
||||||
|
"kind": 13194,
|
||||||
|
"tags": [
|
||||||
|
[
|
||||||
|
"notifications",
|
||||||
|
"payment_received payment_sent"
|
||||||
|
]
|
||||||
|
],
|
||||||
|
"content": "pay_invoice pay_keysend get_balance get_info make_invoice lookup_invoice list_transactions multi_pay_invoice multi_pay_keysend sign_message notifications",
|
||||||
|
"sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
4
50.md
4
50.md
|
@ -15,9 +15,9 @@ extensible framework for performing such queries.
|
||||||
## `search` filter field
|
## `search` filter field
|
||||||
|
|
||||||
A new `search` field is introduced for `REQ` messages from clients:
|
A new `search` field is introduced for `REQ` messages from clients:
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
...
|
// other fields on filter object...
|
||||||
"search": <string>
|
"search": <string>
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
4
51.md
4
51.md
|
@ -29,7 +29,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors
|
||||||
| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) |
|
| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) |
|
||||||
| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) |
|
| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) |
|
||||||
| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) |
|
| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) |
|
||||||
| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) |
|
| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL), `"r"` for each relay in use |
|
||||||
| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) |
|
| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) |
|
||||||
| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) |
|
| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) |
|
||||||
| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) |
|
| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) |
|
||||||
|
@ -111,7 +111,7 @@ Some clients have used these lists in the past, but they should work on transiti
|
||||||
|
|
||||||
### A _release artifact set_ of an Example App
|
### A _release artifact set_ of an Example App
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
|
"id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
|
||||||
"pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
|
"pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
|
||||||
|
|
6
52.md
6
52.md
|
@ -20,7 +20,7 @@ This kind of calendar event starts on a date and ends before a different date in
|
||||||
|
|
||||||
#### Format
|
#### Format
|
||||||
|
|
||||||
The format uses a parameterized replaceable event kind `31922`.
|
The format uses an _addressable event_ of `kind:31922`.
|
||||||
|
|
||||||
The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
|
The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
|
||||||
|
|
||||||
|
@ -79,7 +79,7 @@ This kind of calendar event spans between a start time and end time.
|
||||||
|
|
||||||
#### Format
|
#### Format
|
||||||
|
|
||||||
The format uses a parameterized replaceable event kind `31923`.
|
The format uses an _addressable event_ kind `31923`.
|
||||||
|
|
||||||
The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
|
The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
|
||||||
|
|
||||||
|
@ -193,7 +193,7 @@ The RSVP MAY tag the author of the calendar event it is in response to using a `
|
||||||
|
|
||||||
### Format
|
### Format
|
||||||
|
|
||||||
The format uses a parameterized replaceable event kind `31925`.
|
The format uses an _addressable 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 `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response.
|
||||||
|
|
||||||
|
|
12
53.md
12
53.md
|
@ -16,7 +16,7 @@ A special event with `kind:30311` "Live Event" is defined as an _addressable eve
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 30311,
|
"kind": 30311,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -35,10 +35,10 @@ For example:
|
||||||
["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"],
|
["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"],
|
||||||
["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"],
|
["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"],
|
||||||
["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"],
|
["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"],
|
||||||
["relays", "wss://one.com", "wss://two.com", ...]
|
["relays", "wss://one.com", "wss://two.com", /*...*/]
|
||||||
],
|
],
|
||||||
"content": "",
|
"content": "",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -64,14 +64,14 @@ This feature is important to avoid malicious event owners adding large account h
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1311,
|
"kind": 1311,
|
||||||
"tags": [
|
"tags": [
|
||||||
["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
|
["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
|
||||||
],
|
],
|
||||||
"content": "Zaps to live streams is beautiful.",
|
"content": "Zaps to live streams is beautiful.",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -119,4 +119,4 @@ Common use cases include meeting rooms/workshops, watch-together activities, or
|
||||||
"content": "Zaps to live streams is beautiful.",
|
"content": "Zaps to live streams is beautiful.",
|
||||||
"sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
|
"sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
|
||||||
}
|
}
|
||||||
````
|
```
|
||||||
|
|
28
54.md
28
54.md
|
@ -6,12 +6,12 @@ Wiki
|
||||||
|
|
||||||
`draft` `optional`
|
`draft` `optional`
|
||||||
|
|
||||||
This NIP defines `kind:30818` (an _addressable event_) for long-form text content similar to [NIP-23](23.md), but with one important difference: articles are meant to be descriptions, or encyclopedia entries, of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content.
|
This NIP defines `kind:30818` (an _addressable event_) for descriptions (or encyclopedia entries) of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content.
|
||||||
|
|
||||||
Articles are identified by lowercase, normalized ascii `d` tags.
|
Articles are identified by lowercase, normalized ascii `d` tags.
|
||||||
|
|
||||||
### Articles
|
### Articles
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
|
"content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -26,21 +26,25 @@ Articles are identified by lowercase, normalized ascii `d` tags.
|
||||||
- Any non-letter character MUST be converted to a `-`.
|
- Any non-letter character MUST be converted to a `-`.
|
||||||
- All letters MUST be converted to lowercase.
|
- All letters MUST be converted to lowercase.
|
||||||
|
|
||||||
### Content rules
|
### Content
|
||||||
|
|
||||||
The content should be Asciidoc, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags:
|
The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links.
|
||||||
|
|
||||||
- `title`: for when the display title should be different from the `d` tag.
|
Unlike normal Asciidoc links `http://example.com[]` that link to external webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink.
|
||||||
- `summary`: for display in lists.
|
|
||||||
- `a` and `e`: for referencing the original event a wiki article was forked from.
|
|
||||||
|
|
||||||
One extra functionality is added: **wikilinks**. Unlike normal Asciidoc links `[]()` that link to webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink.
|
|
||||||
|
|
||||||
Wikilinks can take these two forms:
|
Wikilinks can take these two forms:
|
||||||
|
|
||||||
1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`;
|
1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`;
|
||||||
2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`.
|
2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`.
|
||||||
|
|
||||||
|
`nostr:...` links, as per [NIP-21](21.md), should link to profiles or arbitrary Nostr events. Although it is not recommended to link to specific versions of articles -- instead the _wikilink_ syntax should be preferred, since it should be left to the reader and their client to decide what version of any given article they want to read.
|
||||||
|
|
||||||
|
### Optional extra tags
|
||||||
|
|
||||||
|
- `title`: for when the display title should be different from the `d` tag.
|
||||||
|
- `summary`: for display in lists.
|
||||||
|
- `a` and `e`: for referencing the original event a wiki article was forked from.
|
||||||
|
|
||||||
### Merge Requests
|
### Merge Requests
|
||||||
|
|
||||||
Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event.
|
Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event.
|
||||||
|
@ -96,13 +100,13 @@ Asciidoc has a strict spec, multiple implementations in many languages, and supp
|
||||||
# Appendix 1: Merge requests
|
# Appendix 1: Merge requests
|
||||||
Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
|
Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"content": "I added information about how to make hot ice-creams",
|
"content": "I added information about how to make hot ice-creams",
|
||||||
"kind": 818,
|
"kind": 818,
|
||||||
"tags": [
|
"tags": [
|
||||||
[ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
|
[ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
|
||||||
[ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ],
|
[ "e", "<version-against-which-the-modification-was-made>", "<relay-url>" ],
|
||||||
[ "p", "<destination-pubkey>" ],
|
[ "p", "<destination-pubkey>" ],
|
||||||
[ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
|
[ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
|
||||||
]
|
]
|
||||||
|
@ -114,4 +118,4 @@ Users can request other users to get their entries merged into someone else's en
|
||||||
`e` tag: optional version of the article in which this modifications is based
|
`e` tag: optional version of the article in which this modifications is based
|
||||||
`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP.
|
`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP.
|
||||||
|
|
||||||
The destination-pubkey (the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-`
|
The destination-pubkey is the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-`
|
||||||
|
|
207
55.md
207
55.md
|
@ -53,8 +53,8 @@ val launcher = rememberLauncherForActivityResult(
|
||||||
Toast.LENGTH_SHORT
|
Toast.LENGTH_SHORT
|
||||||
).show()
|
).show()
|
||||||
} else {
|
} else {
|
||||||
val signature = activityResult.data?.getStringExtra("signature")
|
val result = activityResult.data?.getStringExtra("result")
|
||||||
// Do something with signature ...
|
// Do something with result ...
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
@ -72,6 +72,35 @@ Set the Signer package name:
|
||||||
intent.`package` = "com.example.signer"
|
intent.`package` = "com.example.signer"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you are sending multiple intents without awaiting you can add some intent flags to sign all events without opening multiple times the signer
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP)
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are developing a signer application them you need to add this to your AndroidManifest.xml so clients can use the intent flags above
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
android:launchMode="singleTop"
|
||||||
|
```
|
||||||
|
|
||||||
|
Signer MUST answer multiple permissions with an array of results
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
|
||||||
|
val results = listOf(
|
||||||
|
Result(
|
||||||
|
package = signerPackageName,
|
||||||
|
result = eventSignture,
|
||||||
|
id = intentId
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
val json = results.toJson()
|
||||||
|
|
||||||
|
intent.putExtra("results", json)
|
||||||
|
```
|
||||||
|
|
||||||
Send the Intent:
|
Send the Intent:
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
|
@ -101,10 +130,10 @@ launcher.launch(intent)
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- If the user approved intent it will return the **npub** in the signature field
|
- If the user approved intent it will return the **pubkey** in the result field
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val npub = intent.data?.getStringExtra("signature")
|
val pubkey = intent.data?.getStringExtra("result")
|
||||||
// The package name of the signer application
|
// The package name of the signer application
|
||||||
val packageName = intent.data?.getStringExtra("package")
|
val packageName = intent.data?.getStringExtra("package")
|
||||||
```
|
```
|
||||||
|
@ -118,16 +147,16 @@ launcher.launch(intent)
|
||||||
intent.putExtra("type", "sign_event")
|
intent.putExtra("type", "sign_event")
|
||||||
// To handle results when not waiting between intents
|
// To handle results when not waiting between intents
|
||||||
intent.putExtra("id", event.id)
|
intent.putExtra("id", event.id)
|
||||||
// Send the current logged in user npub
|
// Send the current logged in user pubkey
|
||||||
intent.putExtra("current_user", npub)
|
intent.putExtra("current_user", pubkey)
|
||||||
|
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- If the user approved intent it will return the **signature**, **id** and **event** fields
|
- If the user approved intent it will return the **result**, **id** and **event** fields
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val signature = intent.data?.getStringExtra("signature")
|
val signature = intent.data?.getStringExtra("result")
|
||||||
// The id you sent
|
// The id you sent
|
||||||
val id = intent.data?.getStringExtra("id")
|
val id = intent.data?.getStringExtra("id")
|
||||||
val signedEventJson = intent.data?.getStringExtra("event")
|
val signedEventJson = intent.data?.getStringExtra("event")
|
||||||
|
@ -142,18 +171,18 @@ launcher.launch(intent)
|
||||||
intent.putExtra("type", "nip04_encrypt")
|
intent.putExtra("type", "nip04_encrypt")
|
||||||
// to control the result in your application in case you are not waiting the result before sending another intent
|
// to control the result in your application in case you are not waiting the result before sending another intent
|
||||||
intent.putExtra("id", "some_id")
|
intent.putExtra("id", "some_id")
|
||||||
// Send the current logged in user npub
|
// Send the current logged in user pubkey
|
||||||
intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
|
intent.putExtra("current_user", account.keyPair.pubkey)
|
||||||
// Send the hex pubKey that will be used for encrypting the data
|
// Send the hex pubkey that will be used for encrypting the data
|
||||||
intent.putExtra("pubKey", pubKey)
|
intent.putExtra("pubkey", pubkey)
|
||||||
|
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- If the user approved intent it will return the **signature** and **id** fields
|
- If the user approved intent it will return the **result** and **id** fields
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val encryptedText = intent.data?.getStringExtra("signature")
|
val encryptedText = intent.data?.getStringExtra("result")
|
||||||
// the id you sent
|
// the id you sent
|
||||||
val id = intent.data?.getStringExtra("id")
|
val id = intent.data?.getStringExtra("id")
|
||||||
```
|
```
|
||||||
|
@ -167,10 +196,10 @@ launcher.launch(intent)
|
||||||
intent.putExtra("type", "nip44_encrypt")
|
intent.putExtra("type", "nip44_encrypt")
|
||||||
// to control the result in your application in case you are not waiting the result before sending another intent
|
// to control the result in your application in case you are not waiting the result before sending another intent
|
||||||
intent.putExtra("id", "some_id")
|
intent.putExtra("id", "some_id")
|
||||||
// Send the current logged in user npub
|
// Send the current logged in user pubkey
|
||||||
intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
|
intent.putExtra("current_user", account.keyPair.pubkey)
|
||||||
// Send the hex pubKey that will be used for encrypting the data
|
// Send the hex pubkey that will be used for encrypting the data
|
||||||
intent.putExtra("pubKey", pubKey)
|
intent.putExtra("pubkey", pubkey)
|
||||||
|
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
|
@ -192,18 +221,18 @@ launcher.launch(intent)
|
||||||
intent.putExtra("type", "nip04_decrypt")
|
intent.putExtra("type", "nip04_decrypt")
|
||||||
// to control the result in your application in case you are not waiting the result before sending another intent
|
// to control the result in your application in case you are not waiting the result before sending another intent
|
||||||
intent.putExtra("id", "some_id")
|
intent.putExtra("id", "some_id")
|
||||||
// Send the current logged in user npub
|
// Send the current logged in user pubkey
|
||||||
intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
|
intent.putExtra("current_user", account.keyPair.pubkey)
|
||||||
// Send the hex pubKey that will be used for decrypting the data
|
// Send the hex pubkey that will be used for decrypting the data
|
||||||
intent.putExtra("pubKey", pubKey)
|
intent.putExtra("pubkey", pubkey)
|
||||||
|
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- If the user approved intent it will return the **signature** and **id** fields
|
- If the user approved intent it will return the **result** and **id** fields
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val plainText = intent.data?.getStringExtra("signature")
|
val plainText = intent.data?.getStringExtra("result")
|
||||||
// the id you sent
|
// the id you sent
|
||||||
val id = intent.data?.getStringExtra("id")
|
val id = intent.data?.getStringExtra("id")
|
||||||
```
|
```
|
||||||
|
@ -217,18 +246,41 @@ launcher.launch(intent)
|
||||||
intent.putExtra("type", "nip04_decrypt")
|
intent.putExtra("type", "nip04_decrypt")
|
||||||
// to control the result in your application in case you are not waiting the result before sending another intent
|
// to control the result in your application in case you are not waiting the result before sending another intent
|
||||||
intent.putExtra("id", "some_id")
|
intent.putExtra("id", "some_id")
|
||||||
// Send the current logged in user npub
|
// Send the current logged in user pubkey
|
||||||
intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
|
intent.putExtra("current_user", account.keyPair.pubkey)
|
||||||
// Send the hex pubKey that will be used for decrypting the data
|
// Send the hex pubkey that will be used for decrypting the data
|
||||||
intent.putExtra("pubKey", pubKey)
|
intent.putExtra("pubkey", pubkey)
|
||||||
|
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- If the user approved intent it will return the **signature** and **id** fields
|
- If the user approved intent it will return the **result** and **id** fields
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val plainText = intent.data?.getStringExtra("signature")
|
val plainText = intent.data?.getStringExtra("result")
|
||||||
|
// the id you sent
|
||||||
|
val id = intent.data?.getStringExtra("id")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **get_relays**
|
||||||
|
- params:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:"))
|
||||||
|
intent.`package` = "com.example.signer"
|
||||||
|
intent.putExtra("type", "get_relays")
|
||||||
|
// to control the result in your application in case you are not waiting the result before sending another intent
|
||||||
|
intent.putExtra("id", "some_id")
|
||||||
|
// Send the current logged in user pubkey
|
||||||
|
intent.putExtra("current_user", account.keyPair.pubkey)
|
||||||
|
|
||||||
|
context.startActivity(intent)
|
||||||
|
```
|
||||||
|
- result:
|
||||||
|
- If the user approved intent it will return the **result** and **id** fields
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val relayJsonText = intent.data?.getStringExtra("result")
|
||||||
// the id you sent
|
// the id you sent
|
||||||
val id = intent.data?.getStringExtra("id")
|
val id = intent.data?.getStringExtra("id")
|
||||||
```
|
```
|
||||||
|
@ -242,15 +294,15 @@ launcher.launch(intent)
|
||||||
intent.putExtra("type", "decrypt_zap_event")
|
intent.putExtra("type", "decrypt_zap_event")
|
||||||
// to control the result in your application in case you are not waiting the result before sending another intent
|
// to control the result in your application in case you are not waiting the result before sending another intent
|
||||||
intent.putExtra("id", "some_id")
|
intent.putExtra("id", "some_id")
|
||||||
// Send the current logged in user npub
|
// Send the current logged in user pubkey
|
||||||
intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
|
intent.putExtra("current_user", account.keyPair.pubkey)
|
||||||
context.startActivity(intent)
|
context.startActivity(intent)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- If the user approved intent it will return the **signature** and **id** fields
|
- If the user approved intent it will return the **result** and **id** fields
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val eventJson = intent.data?.getStringExtra("signature")
|
val eventJson = intent.data?.getStringExtra("result")
|
||||||
// the id you sent
|
// the id you sent
|
||||||
val id = intent.data?.getStringExtra("id")
|
val id = intent.data?.getStringExtra("id")
|
||||||
```
|
```
|
||||||
|
@ -259,11 +311,11 @@ launcher.launch(intent)
|
||||||
|
|
||||||
To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result.
|
To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result.
|
||||||
|
|
||||||
If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null
|
If the user did not check the "remember my choice" option, the pubkey is not in Signer Application or the signer type is not recognized the `contentResolver` will return null
|
||||||
|
|
||||||
For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json
|
For the SIGN_EVENT type Signer Application returns two columns "result" and "event". The column event is the signed event json
|
||||||
|
|
||||||
For the other types Signer Application returns the column "signature"
|
For the other types Signer Application returns the column "result"
|
||||||
|
|
||||||
If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application
|
If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application
|
||||||
|
|
||||||
|
@ -282,15 +334,15 @@ If the user chose to always reject the event, signer application will return the
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **npub** in the signature column
|
- Will return the **pubkey** in the result column
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
if (index < 0) return
|
if (index < 0) return
|
||||||
val npub = it.getString(index)
|
val pubkey = it.getString(index)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -300,20 +352,20 @@ If the user chose to always reject the event, signer application will return the
|
||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.SIGN_EVENT"),
|
Uri.parse("content://com.example.signer.SIGN_EVENT"),
|
||||||
listOf("$eventJson", "", "${logged_in_user_npub}"),
|
listOf("$eventJson", "", "${logged_in_user_pubkey}"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **signature** and the **event** columns
|
- Will return the **result** and the **event** columns
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
val indexJson = it.getColumnIndex("event")
|
val indexJson = it.getColumnIndex("event")
|
||||||
val signature = it.getString(index)
|
val signature = it.getString(index)
|
||||||
val eventJson = it.getString(indexJson)
|
val eventJson = it.getString(indexJson)
|
||||||
|
@ -326,20 +378,20 @@ If the user chose to always reject the event, signer application will return the
|
||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.NIP04_ENCRYPT"),
|
Uri.parse("content://com.example.signer.NIP04_ENCRYPT"),
|
||||||
listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"),
|
listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **signature** column
|
- Will return the **result** column
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
val encryptedText = it.getString(index)
|
val encryptedText = it.getString(index)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -350,20 +402,20 @@ If the user chose to always reject the event, signer application will return the
|
||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.NIP44_ENCRYPT"),
|
Uri.parse("content://com.example.signer.NIP44_ENCRYPT"),
|
||||||
listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"),
|
listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **signature** column
|
- Will return the **result** column
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
val encryptedText = it.getString(index)
|
val encryptedText = it.getString(index)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -374,20 +426,20 @@ If the user chose to always reject the event, signer application will return the
|
||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.NIP04_DECRYPT"),
|
Uri.parse("content://com.example.signer.NIP04_DECRYPT"),
|
||||||
listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"),
|
listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **signature** column
|
- Will return the **result** column
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
val encryptedText = it.getString(index)
|
val encryptedText = it.getString(index)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -398,44 +450,68 @@ If the user chose to always reject the event, signer application will return the
|
||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.NIP44_DECRYPT"),
|
Uri.parse("content://com.example.signer.NIP44_DECRYPT"),
|
||||||
listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"),
|
listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **signature** column
|
- Will return the **result** column
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
val encryptedText = it.getString(index)
|
val encryptedText = it.getString(index)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- **get_relays**
|
||||||
|
- params:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val result = context.contentResolver.query(
|
||||||
|
Uri.parse("content://com.example.signer.GET_RELAYS"),
|
||||||
|
listOf("${logged_in_user_pubkey}"),
|
||||||
|
null,
|
||||||
|
null,
|
||||||
|
null
|
||||||
|
)
|
||||||
|
```
|
||||||
|
- result:
|
||||||
|
- Will return the **result** column
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
if (result == null) return
|
||||||
|
|
||||||
|
if (result.moveToFirst()) {
|
||||||
|
val index = it.getColumnIndex("result")
|
||||||
|
val relayJsonText = it.getString(index)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
- **decrypt_zap_event**
|
- **decrypt_zap_event**
|
||||||
- params:
|
- params:
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"),
|
Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"),
|
||||||
listOf("$eventJson", "", "${logged_in_user_npub}"),
|
listOf("$eventJson", "", "${logged_in_user_pubkey}"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
- result:
|
- result:
|
||||||
- Will return the **signature** column
|
- Will return the **result** column
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
if (result == null) return
|
if (result == null) return
|
||||||
|
|
||||||
if (result.moveToFirst()) {
|
if (result.moveToFirst()) {
|
||||||
val index = it.getColumnIndex("signature")
|
val index = it.getColumnIndex("result")
|
||||||
val eventJson = it.getString(index)
|
val eventJson = it.getString(index)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -472,28 +548,35 @@ Android intents and browser urls have limitations, so if you are using the `retu
|
||||||
- params:
|
- params:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`;
|
window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`;
|
||||||
```
|
```
|
||||||
|
|
||||||
- **nip44_encrypt**
|
- **nip44_encrypt**
|
||||||
- params:
|
- params:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`;
|
window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`;
|
||||||
```
|
```
|
||||||
|
|
||||||
- **nip04_decrypt**
|
- **nip04_decrypt**
|
||||||
- params:
|
- params:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`;
|
window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`;
|
||||||
```
|
```
|
||||||
|
|
||||||
- **nip44_decrypt**
|
- **nip44_decrypt**
|
||||||
- params:
|
- params:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`;
|
window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`;
|
||||||
|
```
|
||||||
|
|
||||||
|
- **get_relays**
|
||||||
|
- params:
|
||||||
|
|
||||||
|
```js
|
||||||
|
window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_relays&callbackUrl=https://example.com/?event=`;
|
||||||
```
|
```
|
||||||
|
|
||||||
- **decrypt_zap_event**
|
- **decrypt_zap_event**
|
||||||
|
|
12
56.md
12
56.md
|
@ -41,7 +41,7 @@ further qualification and querying.
|
||||||
Example events
|
Example events
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1984,
|
"kind": 1984,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -50,9 +50,11 @@ Example events
|
||||||
["l", "NS-nud", "social.nos.ontology"]
|
["l", "NS-nud", "social.nos.ontology"]
|
||||||
],
|
],
|
||||||
"content": "",
|
"content": "",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1984,
|
"kind": 1984,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -60,16 +62,18 @@ Example events
|
||||||
["p", <pubkey>]
|
["p", <pubkey>]
|
||||||
],
|
],
|
||||||
"content": "He's insulting the king!",
|
"content": "He's insulting the king!",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1984,
|
"kind": 1984,
|
||||||
"tags": [
|
"tags": [
|
||||||
["p", <impersonator pubkey>, "impersonation"]
|
["p", <impersonator pubkey>, "impersonation"]
|
||||||
],
|
],
|
||||||
"content": "Profile is impersonating nostr:<victim bech32 pubkey>",
|
"content": "Profile is impersonating nostr:<victim bech32 pubkey>",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
4
57.md
4
57.md
|
@ -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
|
- `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`
|
- `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 in javascript:
|
This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize their zap. Here is an example flow in javascript:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
const senderPubkey // The sender's pubkey
|
const senderPubkey // The sender's pubkey
|
||||||
|
@ -171,7 +171,7 @@ 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 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`).
|
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
|
```jsonc
|
||||||
{
|
{
|
||||||
"tags": [
|
"tags": [
|
||||||
[ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25%
|
[ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25%
|
||||||
|
|
15
58.md
15
58.md
|
@ -13,8 +13,7 @@ user profiles:
|
||||||
|
|
||||||
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.
|
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
|
3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`.
|
||||||
with kind `30008` with a `d` tag with the value `profile_badges`.
|
|
||||||
Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed.
|
Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed.
|
||||||
|
|
||||||
### Badge Definition event
|
### Badge Definition event
|
||||||
|
@ -74,7 +73,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
|
||||||
|
|
||||||
### Example of a Badge Definition event
|
### Example of a Badge Definition event
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"pubkey": "alice",
|
"pubkey": "alice",
|
||||||
"kind": 30009,
|
"kind": 30009,
|
||||||
|
@ -85,13 +84,13 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
|
||||||
["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
|
["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
|
||||||
["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"]
|
["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Example of Badge Award event
|
### Example of Badge Award event
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": "<badge award event id>",
|
"id": "<badge award event id>",
|
||||||
"kind": 8,
|
"kind": 8,
|
||||||
|
@ -101,14 +100,14 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
|
||||||
["p", "bob", "wss://relay"],
|
["p", "bob", "wss://relay"],
|
||||||
["p", "charlie", "wss://relay"]
|
["p", "charlie", "wss://relay"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Example of a Profile Badges event
|
### Example of a Profile Badges event
|
||||||
|
|
||||||
Honorable Bob The Brave:
|
Honorable Bob The Brave:
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 30008,
|
"kind": 30008,
|
||||||
"pubkey": "bob",
|
"pubkey": "bob",
|
||||||
|
@ -119,6 +118,6 @@ Honorable Bob The Brave:
|
||||||
["a", "30009:alice:honor"],
|
["a", "30009:alice:honor"],
|
||||||
["e", "<honor badge award event id>", "wss://nostr.academy"]
|
["e", "<honor badge award event id>", "wss://nostr.academy"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
6
59.md
6
59.md
|
@ -41,7 +41,7 @@ A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key
|
||||||
to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for
|
to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for
|
||||||
without the receiver's or the sender's private key. The only public information in this event is who is signing it.
|
without the receiver's or the sender's private key. The only public information in this event is who is signing it.
|
||||||
|
|
||||||
```js
|
```json
|
||||||
{
|
{
|
||||||
"id": "<id>",
|
"id": "<id>",
|
||||||
"pubkey": "<real author's pubkey>",
|
"pubkey": "<real author's pubkey>",
|
||||||
|
@ -60,7 +60,7 @@ Tags MUST must always be empty in a `kind:13`. The inner event MUST always be un
|
||||||
A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information
|
A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information
|
||||||
needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work.
|
needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work.
|
||||||
|
|
||||||
```js
|
```json
|
||||||
{
|
{
|
||||||
"id": "<id>",
|
"id": "<id>",
|
||||||
"pubkey": "<random, one-time-use pubkey>",
|
"pubkey": "<random, one-time-use pubkey>",
|
||||||
|
@ -245,7 +245,7 @@ const rumor = createRumor(
|
||||||
const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey)
|
const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey)
|
||||||
const wrap = createWrap(seal, recipientPublicKey)
|
const wrap = createWrap(seal, recipientPublicKey)
|
||||||
|
|
||||||
// Recipient unwraps with his/her private key.
|
// Recipient unwraps with their private key.
|
||||||
|
|
||||||
const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey)
|
const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey)
|
||||||
const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey)
|
const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey)
|
||||||
|
|
205
60.md
Normal file
205
60.md
Normal file
|
@ -0,0 +1,205 @@
|
||||||
|
# NIP-60
|
||||||
|
## Cashu Wallet
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
This NIP defines the operations of a cashu-based wallet.
|
||||||
|
|
||||||
|
A cashu wallet is a wallet which information is stored in relays to make it accessible across applications.
|
||||||
|
|
||||||
|
The purpose of this NIP is:
|
||||||
|
* ease-of-use: new users immediately are able to receive funds without creating accounts with other services.
|
||||||
|
* interoperability: users' wallets follows them across applications.
|
||||||
|
|
||||||
|
This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet.
|
||||||
|
|
||||||
|
# High-level flow
|
||||||
|
1. A user has a `kind:37375` event that represents a wallet.
|
||||||
|
2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key.
|
||||||
|
3. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional.
|
||||||
|
|
||||||
|
## Wallet Event
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 37375,
|
||||||
|
"content": nip44_encrypt([
|
||||||
|
[ "balance", "100", "sat" ],
|
||||||
|
[ "privkey", "hexkey" ] // explained in NIP-61
|
||||||
|
]),
|
||||||
|
"tags": [
|
||||||
|
[ "d", "my-wallet" ],
|
||||||
|
[ "mint", "https://mint1" ],
|
||||||
|
[ "mint", "https://mint2" ],
|
||||||
|
[ "mint", "https://mint3" ],
|
||||||
|
[ "name", "my shitposting wallet" ],
|
||||||
|
[ "unit", "sat" ],
|
||||||
|
[ "description", "a wallet for my day-to-day shitposting" ],
|
||||||
|
[ "relay", "wss://relay1" ],
|
||||||
|
[ "relay", "wss://relay2" ],
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The wallet event is a parameterized replaceable event `kind:37375`.
|
||||||
|
|
||||||
|
Tags:
|
||||||
|
* `d` - wallet ID.
|
||||||
|
* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags.
|
||||||
|
* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [[NIP-65]].
|
||||||
|
* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc).
|
||||||
|
* `name` - Optional human-readable name for the wallet.
|
||||||
|
* `description` - Optional human-readable description of the wallet.
|
||||||
|
* `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs.
|
||||||
|
* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's nostr private key** -- This is only used when receiving funds from others, described in NIP-61.
|
||||||
|
|
||||||
|
Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field.
|
||||||
|
|
||||||
|
### Deleting a wallet event
|
||||||
|
Due to PRE being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag.
|
||||||
|
|
||||||
|
## Token Event
|
||||||
|
Token events are used to record the unspent proofs that come from the mint.
|
||||||
|
|
||||||
|
There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 7375,
|
||||||
|
"content": nip44_encrypt({
|
||||||
|
"mint": "https://stablenut.umint.cash",
|
||||||
|
"proofs": [
|
||||||
|
{
|
||||||
|
"id": "005c2502034d4f12",
|
||||||
|
"amount": 1,
|
||||||
|
"secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=",
|
||||||
|
"C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}),
|
||||||
|
"tags": [
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`.content` is a [[NIP-44]] encrypted payload storing the mint and the unencoded proofs.
|
||||||
|
* `a` an optional tag linking the token to a specific wallet.
|
||||||
|
|
||||||
|
### Spending proofs
|
||||||
|
When one or more proofs of a token are spent, the token event should be [[NIP-09]]-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event.
|
||||||
|
|
||||||
|
## Spending History Event
|
||||||
|
Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 7376,
|
||||||
|
"content": nip44_encrypt([
|
||||||
|
[ "direction", "in" ], // in = received, out = sent
|
||||||
|
[ "amount", "1", "sat" ],
|
||||||
|
[ "e", "<event-id-of-spent-token>", "<relay-hint>", "created" ],
|
||||||
|
]),
|
||||||
|
"tags": [
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ],
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
* `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds.
|
||||||
|
* `a` - The wallet the transaction is related to.
|
||||||
|
|
||||||
|
Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag:
|
||||||
|
* `created` - A new token event was created.
|
||||||
|
* `destroyed` - A token event was destroyed.
|
||||||
|
* `redeemed` - A [[NIP-61]] nutzap was redeemed.
|
||||||
|
|
||||||
|
All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted.
|
||||||
|
|
||||||
|
Multiple `e` tags can be added to a `kind:7376` event.
|
||||||
|
|
||||||
|
# Flow
|
||||||
|
A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [[NIP-65]] relays.
|
||||||
|
|
||||||
|
## Fetch wallet and token list
|
||||||
|
From those relays, the client should fetch wallet and token events.
|
||||||
|
|
||||||
|
`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]`
|
||||||
|
|
||||||
|
## Fetch proofs
|
||||||
|
While the client is fetching (and perhaps validating) proofs it can use the optional `balance` tag of the wallet event to display a estimate of the balance of the wallet.
|
||||||
|
|
||||||
|
## Spending token
|
||||||
|
If Alice spends 4 sats from this token event
|
||||||
|
```jsonconc
|
||||||
|
{
|
||||||
|
"kind": 7375,
|
||||||
|
"id": "event-id-1",
|
||||||
|
"content": nip44_encrypt({
|
||||||
|
"mint": "https://stablenut.umint.cash",
|
||||||
|
"proofs": [
|
||||||
|
{ "id": "1", "amount": 1 },
|
||||||
|
{ "id": "2", "amount": 2 },
|
||||||
|
{ "id": "3", "amount": 4 },
|
||||||
|
{ "id": "4", "amount": 8 },
|
||||||
|
]
|
||||||
|
}),
|
||||||
|
"tags": [
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Her client:
|
||||||
|
* MUST roll over the unspent proofs:
|
||||||
|
```jsonconc
|
||||||
|
{
|
||||||
|
"kind": 7375,
|
||||||
|
"id": "event-id-2",
|
||||||
|
"content": nip44_encrypt({
|
||||||
|
"mint": "https://stablenut.umint.cash",
|
||||||
|
"proofs": [
|
||||||
|
{ "id": "1", "amount": 1 },
|
||||||
|
{ "id": "2", "amount": 2 },
|
||||||
|
{ "id": "4", "amount": 8 },
|
||||||
|
]
|
||||||
|
}),
|
||||||
|
"tags": [
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
* MUST delete event `event-id-1`
|
||||||
|
* SHOULD create a `kind:7376` event to record the spend
|
||||||
|
```jsonconc
|
||||||
|
{
|
||||||
|
"kind": 7376,
|
||||||
|
"content": nip44_encrypt([
|
||||||
|
[ "direction", "out" ],
|
||||||
|
[ "amount", "4", "sats" ],
|
||||||
|
[ "e", "<event-id-1>", "<relay-hint>", "destroyed" ],
|
||||||
|
[ "e", "<event-id-2>", "<relay-hint>", "created" ],
|
||||||
|
]),
|
||||||
|
"tags": [
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ],
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Redeeming a quote (optional)
|
||||||
|
When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [[NIP-40]] matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events.
|
||||||
|
|
||||||
|
Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 7374,
|
||||||
|
"content": nip44_encrypt("quote-id"),
|
||||||
|
"tags": [
|
||||||
|
[ "expiration", "<expiration-timestamp>" ],
|
||||||
|
[ "mint", "<mint-url>" ],
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Appendix 1: Validating proofs
|
||||||
|
Clients can optionally validate proofs to make sure they are not working from an old state; this logic is left up to particular implementations to decide when and why to do it, but if some proofs are checked and deemed to have been spent, the client should delete the token and roll over any unspent proof.
|
132
61.md
Normal file
132
61.md
Normal file
|
@ -0,0 +1,132 @@
|
||||||
|
# NIP-61:
|
||||||
|
## Nut Zaps
|
||||||
|
|
||||||
|
A Nut Zap is a P2PK cashu token where the payment itself is the receipt.
|
||||||
|
|
||||||
|
# High-level flow
|
||||||
|
Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked.
|
||||||
|
|
||||||
|
## Alice nutzaps Bob
|
||||||
|
1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts.
|
||||||
|
2. She mints a token at that mint (or swaps some tokens she already had in that mint) p2pk-locked to the pubkey Bob has listed in his `kind:10019`.
|
||||||
|
3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted.
|
||||||
|
|
||||||
|
## Bob receives the nutzap
|
||||||
|
1. At some point, Bob's client fetches `kind:9321` events p-tagging him from his relays.
|
||||||
|
2. Bob's client swaps the token into his wallet.
|
||||||
|
|
||||||
|
# Nutzap informational event
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 10019,
|
||||||
|
"tags": [
|
||||||
|
[ "relay", "wss://relay1" ],
|
||||||
|
[ "relay", "wss://relay2" ],
|
||||||
|
[ "mint", "https://mint1", "usd", "sat" ],
|
||||||
|
[ "mint", "https://mint2", "sat" ],
|
||||||
|
[ "pubkey", "<p2pk-pubkey>" ]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`kind:10019` is an event that is useful for others to know how to send money to the user.
|
||||||
|
|
||||||
|
* `relay` - Relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays.
|
||||||
|
* `mint` - Mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint.
|
||||||
|
* `pubkey` - Pubkey that SHOULD be used to P2PK-lock receiving nutzaps. If not present, clients SHOULD use the pubkey of the recipient. This is explained in Appendix 1.
|
||||||
|
|
||||||
|
## Nutzap event
|
||||||
|
Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the pubkey the recipient indicated in their `kind:10019` event or to the recipient pubkey if the `kind:10019` event doesn't have a explicit pubkey.
|
||||||
|
|
||||||
|
Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility).
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
kind: 9321,
|
||||||
|
content: "Thanks for this great idea.",
|
||||||
|
pubkey: "sender-pubkey",
|
||||||
|
tags: [
|
||||||
|
[ "amount", "1" ],
|
||||||
|
[ "unit", "sat" ],
|
||||||
|
[ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ],
|
||||||
|
[ "u", "https://stablenut.umint.cash", ],
|
||||||
|
[ "e", "<zapped-event-id>", "<relay-hint>" ],
|
||||||
|
[ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
* `.content` is an optional comment for the nutzap
|
||||||
|
* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches.
|
||||||
|
* `unit` is the base unit of the amount.
|
||||||
|
* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event.
|
||||||
|
* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`.
|
||||||
|
* `e` zero or one event that is being nutzapped.
|
||||||
|
* `p` exactly one pubkey, specifying the recipient of the nutzap.
|
||||||
|
|
||||||
|
WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint.
|
||||||
|
|
||||||
|
# Sending a nutzap
|
||||||
|
|
||||||
|
* The sender fetches the recipient's `kind:10019`.
|
||||||
|
* The sender mints/swaps ecash on one of the recipient's listed mints.
|
||||||
|
* The sender p2pk locks to the recipient's specified pubkey in their
|
||||||
|
|
||||||
|
# Receiving nutzaps
|
||||||
|
|
||||||
|
Clients should REQ for nut zaps:
|
||||||
|
* Filtering with `#u` for mints they expect to receive ecash from.
|
||||||
|
* this is to prevent even interacting with mints the user hasn't explicitly signaled.
|
||||||
|
* Filtering with `since` of the most recent `kind:7376` event the same user has created.
|
||||||
|
* this can be used as a marker of the nut zaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach.
|
||||||
|
|
||||||
|
Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam.
|
||||||
|
|
||||||
|
`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`.
|
||||||
|
|
||||||
|
Upon receiving a new nut zap, the client should swap the tokens into a wallet the user controls, either a [[NIP-60]] wallet, their own LN wallet or anything else.
|
||||||
|
|
||||||
|
## Updating nutzap-redemption history
|
||||||
|
When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nut zap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed.
|
||||||
|
|
||||||
|
Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"kind": 7376,
|
||||||
|
"content": nip44_encrypt([
|
||||||
|
[ "direction", "in" ], // in = received, out = sent
|
||||||
|
[ "amount", "1", "sat" ],
|
||||||
|
[ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created
|
||||||
|
]),
|
||||||
|
"tags": [
|
||||||
|
[ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag
|
||||||
|
[ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed
|
||||||
|
[ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender)
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays.
|
||||||
|
|
||||||
|
## Verifying a Cashu Zap
|
||||||
|
* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted.
|
||||||
|
* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`.
|
||||||
|
|
||||||
|
## Final Considerations
|
||||||
|
|
||||||
|
1. Clients SHOULD guide their users to use NUT-11 (P2PK) compatible-mints in their `kind:10019` event to avoid receiving nut zaps anyone can spend
|
||||||
|
|
||||||
|
2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65.
|
||||||
|
|
||||||
|
3. A nut zap MUST be sent to a mint the recipient has listed in their `kind:10019` event or to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event.
|
||||||
|
|
||||||
|
## Appendix 1: Alternative P2PK pubkey
|
||||||
|
Clients might not have access to the user's private key (i.e. NIP-07, NIP-46 signing) and, as such, the private key to sign cashu spends might not be available, which would make spending the P2PK incoming nutzaps impossible.
|
||||||
|
|
||||||
|
For this scenarios clients can:
|
||||||
|
|
||||||
|
* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to)
|
||||||
|
* store the private key in the `kind:37375` event in the nip44-encrypted `content` field.
|
||||||
|
|
||||||
|
This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads.
|
12
64.md
12
64.md
|
@ -16,23 +16,23 @@ The `.content` of these notes is a string representing a [PGN-database][pgn_form
|
||||||
|
|
||||||
### Notes
|
### Notes
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 64,
|
"kind": 64,
|
||||||
"content": "1. e4 *",
|
"content": "1. e4 *",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 64,
|
"kind": 64,
|
||||||
"tags": [
|
"tags": [
|
||||||
["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"],
|
["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"],
|
||||||
...
|
// rest of tags...
|
||||||
],
|
],
|
||||||
"content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2"
|
"content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
8
65.md
8
65.md
|
@ -12,7 +12,7 @@ The event MUST include a list of `r` tags with relay URIs and a `read` or `write
|
||||||
|
|
||||||
The `.content` is not used.
|
The `.content` is not used.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 10002,
|
"kind": 10002,
|
||||||
"tags": [
|
"tags": [
|
||||||
|
@ -22,7 +22,7 @@ The `.content` is not used.
|
||||||
["r", "wss://nostr-relay.example.com", "read"]
|
["r", "wss://nostr-relay.example.com", "read"]
|
||||||
],
|
],
|
||||||
"content": "",
|
"content": "",
|
||||||
...other fields
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -62,3 +62,7 @@ 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.
|
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 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6).
|
6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6).
|
||||||
|
|
||||||
|
## Related articles
|
||||||
|
- [Outbox model](https://mikedilger.com/gossip-model/)
|
||||||
|
- [What is the Outbox Model?](https://habla.news/u/hodlbod@coracle.social/8YjqXm4SKY-TauwjOfLXS)
|
||||||
|
|
92
68.md
Normal file
92
68.md
Normal file
|
@ -0,0 +1,92 @@
|
||||||
|
NIP-68
|
||||||
|
======
|
||||||
|
|
||||||
|
Picture-first feeds
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags.
|
||||||
|
|
||||||
|
The idea is for this type of event to cater to Nostr clients resembling platforms like Instagram, Flickr, Snapchat, or 9GAG, where the picture itself takes center stage in the user experience.
|
||||||
|
|
||||||
|
## Picture Events
|
||||||
|
|
||||||
|
Picture events contain a `title` tag and description in the `.content`.
|
||||||
|
|
||||||
|
They may contain multiple images to be displayed as a single post.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
|
||||||
|
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
|
||||||
|
"created_at": <Unix timestamp in seconds>,
|
||||||
|
"kind": 20,
|
||||||
|
"content": "<description of post>",
|
||||||
|
"tags": [
|
||||||
|
["title", "<short title of post>"],
|
||||||
|
|
||||||
|
// Picture Data
|
||||||
|
[
|
||||||
|
"imeta",
|
||||||
|
"url https://nostr.build/i/my-image.jpg",
|
||||||
|
"m image/jpeg",
|
||||||
|
"blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$",
|
||||||
|
"dim 3024x4032",
|
||||||
|
"alt A scenic photo overlooking the coast of Costa Rica",
|
||||||
|
"x <sha256 hash as specified in NIP 94>",
|
||||||
|
"fallback https://nostrcheck.me/alt1.jpg",
|
||||||
|
"fallback https://void.cat/alt1.jpg"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"imeta",
|
||||||
|
"url https://nostr.build/i/my-image2.jpg",
|
||||||
|
"m image/jpeg",
|
||||||
|
"blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$",
|
||||||
|
"dim 3024x4032",
|
||||||
|
"alt Another scenic photo overlooking the coast of Costa Rica",
|
||||||
|
"x <sha256 hash as specified in NIP 94>",
|
||||||
|
"fallback https://nostrcheck.me/alt2.jpg",
|
||||||
|
"fallback https://void.cat/alt2.jpg",
|
||||||
|
|
||||||
|
"annotate-user <32-bytes hex of a pubkey>:<posX>:<posY>" // Tag users in specific locations in the picture
|
||||||
|
],
|
||||||
|
|
||||||
|
["content-warning", "<reason>"], // if NSFW
|
||||||
|
|
||||||
|
// Tagged users
|
||||||
|
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
|
||||||
|
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
|
||||||
|
|
||||||
|
// Specify the media type for filters to allow clients to filter by supported kinds
|
||||||
|
["m", "image/jpeg"],
|
||||||
|
|
||||||
|
// Hashes of each image to make them queryable
|
||||||
|
["x", "<sha256>"]
|
||||||
|
|
||||||
|
// Hashtags
|
||||||
|
["t", "<tag>"],
|
||||||
|
["t", "<tag>"],
|
||||||
|
|
||||||
|
// location
|
||||||
|
["location", "<location>"], // city name, state, country
|
||||||
|
["g", "<geohash>"],
|
||||||
|
|
||||||
|
// When text is written in the image, add the tag to represent the language
|
||||||
|
["L", "ISO-639-1"],
|
||||||
|
["l", "en", "ISO-639-1"]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `imeta` tag `annotate-user` places a user link in the specific position in the image.
|
||||||
|
|
||||||
|
Only the following media types are accepted:
|
||||||
|
- `image/apng`: Animated Portable Network Graphics (APNG)
|
||||||
|
- `image/avif`: AV1 Image File Format (AVIF)
|
||||||
|
- `image/gif`: Graphics Interchange Format (GIF)
|
||||||
|
- `image/jpeg`: Joint Photographic Expert Group image (JPEG)
|
||||||
|
- `image/png`: Portable Network Graphics (PNG)
|
||||||
|
- `image/webp`: Web Picture format (WEBP)
|
||||||
|
|
||||||
|
Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed.
|
86
69.md
Normal file
86
69.md
Normal file
|
@ -0,0 +1,86 @@
|
||||||
|
# NIP-69
|
||||||
|
|
||||||
|
## Peer-to-peer Order events
|
||||||
|
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
Peer-to-peer (P2P) platforms have seen an upturn in recent years, while having more and more options is positive, in the specific case of p2p, having several options contributes to the liquidity split, meaning sometimes there's not enough assets available for trading. If we combine all these individual solutions into one big pool of orders, it will make them much more competitive compared to centralized systems, where a single authority controls the liquidity.
|
||||||
|
|
||||||
|
This NIP defines a simple standard for peer-to-peer order events, which enables the creation of a big liquidity pool for all p2p platforms participating.
|
||||||
|
|
||||||
|
## The event
|
||||||
|
|
||||||
|
Events are [addressable events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31",
|
||||||
|
"pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a",
|
||||||
|
"created_at": 1702548701,
|
||||||
|
"kind": 38383,
|
||||||
|
"tags": [
|
||||||
|
["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"],
|
||||||
|
["k", "sell"],
|
||||||
|
["f", "VES"],
|
||||||
|
["s", "pending"],
|
||||||
|
["amt", "0"],
|
||||||
|
["fa", "100"],
|
||||||
|
["pm", "face to face", "bank transfer"],
|
||||||
|
["premium", "1"],
|
||||||
|
[
|
||||||
|
"rating",
|
||||||
|
"{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}"
|
||||||
|
],
|
||||||
|
["source", "https://t.me/p2plightning/xxxxxxx"],
|
||||||
|
["network", "mainnet"],
|
||||||
|
["layer", "lightning"],
|
||||||
|
["name", "Nakamoto"],
|
||||||
|
["g", "<geohash>"],
|
||||||
|
["bond", "0"],
|
||||||
|
["expiration", "1719391096"],
|
||||||
|
["y", "lnp2pbot"],
|
||||||
|
["z", "order"]
|
||||||
|
],
|
||||||
|
"content": "",
|
||||||
|
"sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tags
|
||||||
|
|
||||||
|
- `d` < Order ID >: A unique identifier for the order.
|
||||||
|
- `k` < Order type >: `sell` or `buy`.
|
||||||
|
- `f` < Currency >: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard.
|
||||||
|
- `s` < Status >: `pending`, `canceled`, `in-progress`, `success`.
|
||||||
|
- `amt` < Amount >: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order.
|
||||||
|
- `fa` < Fiat amount >: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount.
|
||||||
|
- `pm` < Payment method >: The payment method used for the trade, if the order has multiple payment methods, they should be separated by a comma.
|
||||||
|
- `premium` < Premium >: The percentage of the premium the maker is willing to pay.
|
||||||
|
- `source` [Source]: The source of the order, it can be a URL that redirects to the order.
|
||||||
|
- `rating` [Rating]: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it.
|
||||||
|
- `network` < Network >: The network used for the trade, it can be `mainnet`, `testnet`, `signet`, etc.
|
||||||
|
- `layer` < Layer >: The layer used for the trade, it can be `onchain`, `lightning`, `liquid`, etc.
|
||||||
|
- `name` [Name]: The name of the maker.
|
||||||
|
- `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade.
|
||||||
|
- `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay.
|
||||||
|
- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)).
|
||||||
|
- `y` < Platform >: The platform that created the order.
|
||||||
|
- `z` < Document >: `order`.
|
||||||
|
|
||||||
|
Mandatory tags are enclosed with `<tag>`, optional tags are enclosed with `[tag]`.
|
||||||
|
|
||||||
|
## Implementations
|
||||||
|
|
||||||
|
Currently implemented on the following platforms:
|
||||||
|
|
||||||
|
- [Mostro](https://github.com/MostroP2P/mostro)
|
||||||
|
- [@lnp2pBot](https://github.com/lnp2pBot/bot)
|
||||||
|
- [Robosats](https://github.com/RoboSats/robosats/pull/1362)
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
- [Mostro protocol specification](https://mostro.network/protocol/)
|
||||||
|
- [Messages specification for peer 2 peer NIP proposal](https://github.com/nostr-protocol/nips/blob/8250274a22f4882f621510df0054fd6167c10c9e/31001.md)
|
||||||
|
- [n3xB](https://github.com/nobu-maeda/n3xb)
|
121
71.md
121
71.md
|
@ -16,25 +16,64 @@ There are two types of video events represented by different kinds: horizontal a
|
||||||
|
|
||||||
#### Format
|
#### Format
|
||||||
|
|
||||||
The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos.
|
The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos.
|
||||||
|
|
||||||
The `.content` of these events is a summary or description on the video content.
|
The `.content` of these events is a summary or description on the video content.
|
||||||
|
|
||||||
The list of tags are as follows:
|
The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md)
|
||||||
* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event.
|
|
||||||
* `url` (required) the url to the video file
|
Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties.
|
||||||
* `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.
|
|
||||||
|
Example:
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
["imeta",
|
||||||
|
"dim 1920x1080",
|
||||||
|
"url https://myvideo.com/1080/12345.mp4",
|
||||||
|
"x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc",
|
||||||
|
"m video/mp4",
|
||||||
|
"image https://myvideo.com/1080/12345.jpg",
|
||||||
|
"image https://myotherserver.com/1080/12345.jpg",
|
||||||
|
"fallback https://myotherserver.com/1080/12345.mp4",
|
||||||
|
"fallback https://andanotherserver.com/1080/12345.mp4",
|
||||||
|
"service nip96",
|
||||||
|
],
|
||||||
|
["imeta",
|
||||||
|
"dim 1280x720",
|
||||||
|
"url https://myvideo.com/720/12345.mp4",
|
||||||
|
"x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d",
|
||||||
|
"m video/mp4",
|
||||||
|
"image https://myvideo.com/720/12345.jpg",
|
||||||
|
"image https://myotherserver.com/720/12345.jpg",
|
||||||
|
"fallback https://myotherserver.com/720/12345.mp4",
|
||||||
|
"fallback https://andanotherserver.com/720/12345.mp4",
|
||||||
|
"service nip96",
|
||||||
|
],
|
||||||
|
["imeta",
|
||||||
|
"dim 1280x720",
|
||||||
|
"url https://myvideo.com/720/12345.m3u8",
|
||||||
|
"x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f",
|
||||||
|
"m application/x-mpegURL",
|
||||||
|
"image https://myvideo.com/720/12345.jpg",
|
||||||
|
"image https://myotherserver.com/720/12345.jpg",
|
||||||
|
"fallback https://myotherserver.com/720/12345.m3u8",
|
||||||
|
"fallback https://andanotherserver.com/720/12345.m3u8",
|
||||||
|
"service nip96",
|
||||||
|
],
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `url` is the primary server url and `fallback` are other servers hosting the same file, both `url` and `fallback` should be weighted equally and clients are recommended to use any of the provided video urls.
|
||||||
|
|
||||||
|
The `image` tag contains a preview image (at the same resolution). Multiple `image` tags may be used to specify fallback copies in the same way `fallback` is used for `url`.
|
||||||
|
|
||||||
|
Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash.
|
||||||
|
|
||||||
|
### Other tags:
|
||||||
* `title` (required) title of the video
|
* `title` (required) title of the video
|
||||||
* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published
|
* `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published
|
||||||
* `x` containing the SHA-256 hexencoded string of the file.
|
|
||||||
* `size` (optional) size of file in bytes
|
|
||||||
* `dim` (optional) size of file in pixels in the form `<width>x<height>`
|
|
||||||
* `duration` (optional) video duration in seconds
|
* `duration` (optional) video duration in seconds
|
||||||
* `magnet` (optional) URI to magnet file
|
|
||||||
* `i` (optional) torrent infohash
|
|
||||||
* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code
|
* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code
|
||||||
* `thumb` (optional) url of thumbnail with same aspect ratio
|
|
||||||
* `image` (optional) url of preview image with same dimensions
|
|
||||||
* `content-warning` (optional) warning about content of NSFW video
|
* `content-warning` (optional) warning about content of NSFW video
|
||||||
* `alt` (optional) description for accessibility
|
* `alt` (optional) description for accessibility
|
||||||
* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url
|
* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url
|
||||||
|
@ -42,7 +81,7 @@ The list of tags are as follows:
|
||||||
* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL
|
* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL
|
||||||
* `r` (optional, repeated) references / links to web pages
|
* `r` (optional, repeated) references / links to web pages
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
|
"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>,
|
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
|
||||||
|
@ -53,19 +92,23 @@ The list of tags are as follows:
|
||||||
["d", "<UUID>"],
|
["d", "<UUID>"],
|
||||||
|
|
||||||
["title", "<title of video>"],
|
["title", "<title of video>"],
|
||||||
["thumb", "<thumbnail image for video>"],
|
|
||||||
["published_at", "<unix timestamp>"],
|
["published_at", "<unix timestamp>"],
|
||||||
["alt", <description>],
|
["alt", <description>],
|
||||||
|
|
||||||
// Video Data
|
// Video Data
|
||||||
["url",<string with URI of file>],
|
["imeta",
|
||||||
["m", <MIME type>],
|
"dim 1920x1080",
|
||||||
["x",<Hash SHA-256>],
|
"url https://myvideo.com/1080/12345.mp4",
|
||||||
["size", <size of file in bytes>],
|
"x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc",
|
||||||
|
"m video/mp4",
|
||||||
|
"image https://myvideo.com/1080/12345.jpg",
|
||||||
|
"image https://myotherserver.com/1080/12345.jpg",
|
||||||
|
"fallback https://myotherserver.com/1080/12345.mp4",
|
||||||
|
"fallback https://andanotherserver.com/1080/12345.mp4",
|
||||||
|
"service nip96",
|
||||||
|
],
|
||||||
|
|
||||||
["duration", <duration of video in seconds>],
|
["duration", <duration of video in seconds>],
|
||||||
["dim", <size of file in pixels>],
|
|
||||||
["magnet",<magnet URI> ],
|
|
||||||
["i",<torrent infohash>],
|
|
||||||
["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"],
|
["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"],
|
||||||
["content-warning", "<reason>"],
|
["content-warning", "<reason>"],
|
||||||
["segment", <start>, <end>, "<title>", "<thumbnail URL>"],
|
["segment", <start>, <end>, "<title>", "<thumbnail URL>"],
|
||||||
|
@ -83,36 +126,4 @@ The list of tags are as follows:
|
||||||
["r", "<url>"]
|
["r", "<url>"]
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Video View
|
|
||||||
|
|
||||||
A video event view is a response to a video event to track a user's view or progress viewing the video.
|
|
||||||
|
|
||||||
### Format
|
|
||||||
|
|
||||||
The format uses a parameterized replaceable event kind `34237`.
|
|
||||||
|
|
||||||
The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user.
|
|
||||||
|
|
||||||
The list of tags are as follows:
|
|
||||||
* `a` (required) reference tag to kind `34235` or `34236` video event being viewed
|
|
||||||
* `d` (required) same as `a` reference tag value
|
|
||||||
* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
|
|
||||||
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
|
|
||||||
"created_at": <Unix timestamp in seconds>,
|
|
||||||
"kind": 34237,
|
|
||||||
"content": "<note>",
|
|
||||||
"tags": [
|
|
||||||
["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"],
|
|
||||||
["e", "<event-id", "<relay-url>"]
|
|
||||||
["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"],
|
|
||||||
["viewed", <start>, <end>],
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
6
72.md
6
72.md
|
@ -35,7 +35,7 @@ The goal of this NIP is to enable public communities. It defines the replaceable
|
||||||
["relay", "<relay where to send and receive approvals>", "approvals"],
|
["relay", "<relay where to send and receive approvals>", "approvals"],
|
||||||
["relay", "<relay where to post requests to and fetch approvals from>"]
|
["relay", "<relay where to post requests to and fetch approvals from>"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ Any Nostr event can be posted to a community. Clients MUST add one or more commu
|
||||||
["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"],
|
["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"],
|
||||||
],
|
],
|
||||||
"content": "hello world",
|
"content": "hello world",
|
||||||
// ...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ Moderators MAY request deletion of their approval of a post at any time using [N
|
||||||
["k", "<post-request-kind>"]
|
["k", "<post-request-kind>"]
|
||||||
],
|
],
|
||||||
"content": "<the full approved event, JSON-encoded>",
|
"content": "<the full approved event, JSON-encoded>",
|
||||||
// ...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
24
73.md
24
73.md
|
@ -6,17 +6,29 @@ External Content IDs
|
||||||
|
|
||||||
`draft` `optional`
|
`draft` `optional`
|
||||||
|
|
||||||
There are certain established global content identifiers that would be useful to reference in nostr events so that clients can query all events assosiated with these ids.
|
There are certain established global content identifiers such as [Book ISBNs](https://en.wikipedia.org/wiki/ISBN), [Podcast GUIDs](https://podcastnamespace.org/tag/guid), and [Movie ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) that are useful to reference in nostr events so that clients can query all the events assosiated with these ids.
|
||||||
|
|
||||||
- Book [ISBNs](https://en.wikipedia.org/wiki/ISBN)
|
|
||||||
- Podcast [GUIDs](https://podcastnamespace.org/tag/guid)
|
|
||||||
- Movie [ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number)
|
|
||||||
|
|
||||||
Since the `i` tag is already used for similar references in kind-0 metadata events it makes sense to use it for these content ids as well.
|
|
||||||
|
|
||||||
|
`i` tags are used for referencing these external content ids, with `k` tags representing the external content id kind so that clients can query all the events for a specific kind.
|
||||||
|
|
||||||
## Supported IDs
|
## Supported IDs
|
||||||
|
|
||||||
|
| Type | `i` tag | `k` tag |
|
||||||
|
|- | - | - |
|
||||||
|
| URLs | "`<URL, normalized, no fragment>`" | "`<scheme-host, normalized>`" |
|
||||||
|
| Hashtags | "#`<topic, lowercase>`" | "#" |
|
||||||
|
| Geohashes| "geo:`<geohash, lowercase>`" | "geo" |
|
||||||
|
| Books | "isbn:`<id, without hyphens>`" | "isbn" |
|
||||||
|
| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" |
|
||||||
|
| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" |
|
||||||
|
| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" |
|
||||||
|
| Movies | "isan:`<id, without version part>`" | "isan" |
|
||||||
|
| Papers | "doi:`<id, lowercase>`" | "doi" |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
### Books:
|
### Books:
|
||||||
|
|
||||||
- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030
|
- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030
|
||||||
|
|
22
75.md
22
75.md
|
@ -21,15 +21,16 @@ The following tags are defined as REQUIRED.
|
||||||
|
|
||||||
Example event:
|
Example event:
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 9041,
|
"kind": 9041,
|
||||||
"tags": [
|
"tags": [
|
||||||
["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
|
["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/],
|
||||||
["amount", "210000"],
|
["amount", "210000"],
|
||||||
],
|
],
|
||||||
"content": "Nostrasia travel expenses",
|
"content": "Nostrasia travel expenses",
|
||||||
...
|
// other fields...
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The following tags are OPTIONAL.
|
The following tags are OPTIONAL.
|
||||||
|
@ -38,18 +39,18 @@ The following tags are OPTIONAL.
|
||||||
- `image` - an image for the goal
|
- `image` - an image for the goal
|
||||||
- `summary` - a brief description
|
- `summary` - a brief description
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 9041,
|
"kind": 9041,
|
||||||
"tags": [
|
"tags": [
|
||||||
["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
|
["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/],
|
||||||
["amount", "210000"],
|
["amount", "210000"],
|
||||||
["closed_at", "<unix timestamp in seconds>"],
|
["closed_at", "<unix timestamp in seconds>"],
|
||||||
["image", "<image URL>"],
|
["image", "<image URL>"],
|
||||||
["summary", "<description of the goal>"],
|
["summary", "<description of the goal>"],
|
||||||
],
|
],
|
||||||
"content": "Nostrasia travel expenses",
|
"content": "Nostrasia travel expenses",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -59,15 +60,14 @@ The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.
|
||||||
|
|
||||||
Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
|
Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
...
|
|
||||||
"kind": 3xxxx,
|
"kind": 3xxxx,
|
||||||
"tags": [
|
"tags": [
|
||||||
...
|
|
||||||
["goal", "<event id>", "<Relay URL (optional)>"],
|
["goal", "<event id>", "<Relay URL (optional)>"],
|
||||||
|
// rest of tags...
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -77,7 +77,7 @@ 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 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.
|
When zapping an addressable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request.
|
||||||
|
|
||||||
## Use cases
|
## Use cases
|
||||||
|
|
||||||
|
|
34
7D.md
Normal file
34
7D.md
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
NIP-7D
|
||||||
|
======
|
||||||
|
|
||||||
|
Threads
|
||||||
|
-------
|
||||||
|
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
A thread is a `kind 11` event. Threads SHOULD include a `subject` with a summary
|
||||||
|
of the thread's topic.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"kind": 11,
|
||||||
|
"content": "Good morning",
|
||||||
|
"tags": [
|
||||||
|
["subject", "GM"]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Replies to `kind 11` MUST use [NIP-22](./22.md) `kind 1111` comments. Replies should
|
||||||
|
always be to the root `kind 11` to avoid arbitrarily nested reply hierarchies.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"kind": 1111,
|
||||||
|
"content": "Cool beans",
|
||||||
|
"tags": [
|
||||||
|
["K", "11"],
|
||||||
|
["E", <event-id>, <relay-url>, <pubkey>]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
4
84.md
4
84.md
|
@ -26,14 +26,14 @@ useful when highlighting non-nostr content for which the client might be able to
|
||||||
(e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the
|
(e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the
|
||||||
last value of the tag.
|
last value of the tag.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"tags": [
|
"tags": [
|
||||||
["p", "<pubkey-hex>", "<relay-url>", "author"],
|
["p", "<pubkey-hex>", "<relay-url>", "author"],
|
||||||
["p", "<pubkey-hex>", "<relay-url>", "author"],
|
["p", "<pubkey-hex>", "<relay-url>", "author"],
|
||||||
["p", "<pubkey-hex>", "<relay-url>", "editor"]
|
["p", "<pubkey-hex>", "<relay-url>", "editor"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
90
86.md
Normal file
90
86.md
Normal file
|
@ -0,0 +1,90 @@
|
||||||
|
NIP-86
|
||||||
|
======
|
||||||
|
|
||||||
|
Relay Management API
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
Relays may provide an API for performing management tasks. This is made available as a JSON-RPC-like request-response protocol over HTTP, on the same URI as the relay's websocket.
|
||||||
|
|
||||||
|
When a relay receives an HTTP(s) request with a `Content-Type` header of `application/nostr+json+rpc` to a URI supporting WebSocket upgrades, it should parse the request as a JSON document with the following fields:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"method": "<method-name>",
|
||||||
|
"params": ["<array>", "<of>", "<parameters>"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then it should return a response in the format
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"result": {"<arbitrary>": "<value>"},
|
||||||
|
"error": "<optional error message, if the call has errored>"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is the list of **methods** that may be supported:
|
||||||
|
|
||||||
|
* `supportedmethods`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `["<method-name>", "<method-name>", ...]` (an array with the names of all the other supported methods)
|
||||||
|
* `banpubkey`:
|
||||||
|
- params: `["<32-byte-hex-public-key>", "<optional-reason>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `listbannedpubkeys`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects
|
||||||
|
* `allowpubkey`:
|
||||||
|
- params: `["<32-byte-hex-public-key>", "<optional-reason>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `listallowedpubkeys`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects
|
||||||
|
* `listeventsneedingmoderation`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}]`, an array of objects
|
||||||
|
* `allowevent`:
|
||||||
|
- params: `["<32-byte-hex-event-id>", "<optional-reason>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `banevent`:
|
||||||
|
- params: `["<32-byte-hex-event-id>", "<optional-reason>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `listbannedevents`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `[{"id": "<32-byte hex>", "reason": "<optional-reason>"}, ...]`, an array of objects
|
||||||
|
* `changerelayname`:
|
||||||
|
- params: `["<new-name>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `changerelaydescription`:
|
||||||
|
- params: `["<new-description>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `changerelayicon`:
|
||||||
|
- params: `["<new-icon-url>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `allowkind`:
|
||||||
|
- params: `[<kind-number>]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `disallowkind`:
|
||||||
|
- params: `[<kind-number>]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `listallowedkinds`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `[<kind-number>, ...]`, an array of numbers
|
||||||
|
* `blockip`:
|
||||||
|
- params: `["<ip-address>", "<optional-reason>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `unblockip`:
|
||||||
|
- params: `["<ip-address>"]`
|
||||||
|
- result: `true` (a boolean always set to `true`)
|
||||||
|
* `listblockedips`:
|
||||||
|
- params: `[]`
|
||||||
|
- result: `[{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...]`, an array of objects
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
The request must contain an `Authorization` header with a valid [NIP-98](./98.md) event, except the `payload` tag is required. The `u` tag is the relay URL.
|
||||||
|
|
||||||
|
If `Authorization` is not provided or is invalid, the endpoint should return a 401 response.
|
22
89.md
22
89.md
|
@ -27,7 +27,7 @@ There are three actors to this workflow:
|
||||||
## Events
|
## Events
|
||||||
|
|
||||||
### Recommendation event
|
### Recommendation event
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 31989,
|
"kind": 31989,
|
||||||
"pubkey": <recommender-user-pubkey>,
|
"pubkey": <recommender-user-pubkey>,
|
||||||
|
@ -35,7 +35,8 @@ There are three actors to this workflow:
|
||||||
["d", <supported-event-kind>],
|
["d", <supported-event-kind>],
|
||||||
["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"],
|
["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"],
|
||||||
["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"]
|
["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"]
|
||||||
]
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -47,7 +48,7 @@ The second value of the tag SHOULD be a relay hint.
|
||||||
The third value of the tag SHOULD be the platform where this recommendation might apply.
|
The third value of the tag SHOULD be the platform where this recommendation might apply.
|
||||||
|
|
||||||
## Handler information
|
## Handler information
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 31990,
|
"kind": 31990,
|
||||||
"pubkey": "<application-pubkey>",
|
"pubkey": "<application-pubkey>",
|
||||||
|
@ -59,7 +60,8 @@ The third value of the tag SHOULD be the platform where this recommendation migh
|
||||||
["web", "https://..../p/<bech32>", "nprofile"],
|
["web", "https://..../p/<bech32>", "nprofile"],
|
||||||
["web", "https://..../e/<bech32>"],
|
["web", "https://..../e/<bech32>"],
|
||||||
["ios", ".../<bech32>"]
|
["ios", ".../<bech32>"]
|
||||||
]
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -77,13 +79,13 @@ A tag without a second value in the array SHOULD be considered a generic handler
|
||||||
# Client tag
|
# Client tag
|
||||||
When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag.
|
When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1,
|
"kind": 1,
|
||||||
"tags": [
|
"tags": [
|
||||||
["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"]
|
["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"]
|
||||||
]
|
]
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -99,14 +101,14 @@ The client MIGHT query for the user's and the user's follows handler.
|
||||||
### 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.
|
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
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 31989,
|
"kind": 31989,
|
||||||
"tags": [
|
"tags": [
|
||||||
["d", "31337"],
|
["d", "31337"],
|
||||||
["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"]
|
["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -115,7 +117,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e
|
||||||
|
|
||||||
User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`:
|
User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`:
|
||||||
|
|
||||||
```json
|
```
|
||||||
["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }]
|
["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -126,6 +128,6 @@ User B's client sees the application's `kind:31990` which includes the informati
|
||||||
### Alternative query bypassing `kind:31989`
|
### 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.
|
Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers.
|
||||||
|
|
||||||
```json
|
```
|
||||||
["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }]
|
["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }]
|
||||||
```
|
```
|
||||||
|
|
26
90.md
26
90.md
|
@ -36,7 +36,7 @@ There are two actors in the workflow described in this NIP:
|
||||||
## Job request (`kind:5000-5999`)
|
## Job request (`kind:5000-5999`)
|
||||||
A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute.
|
A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 5xxx, // kind in 5000-5999 range
|
"kind": 5xxx, // kind in 5000-5999 range
|
||||||
"content": "",
|
"content": "",
|
||||||
|
@ -46,7 +46,8 @@ A request to process data, published by a customer. This event signals that a cu
|
||||||
[ "relays", "wss://..." ],
|
[ "relays", "wss://..." ],
|
||||||
[ "bid", "<msat-amount>" ],
|
[ "bid", "<msat-amount>" ],
|
||||||
[ "t", "bitcoin" ]
|
[ "t", "bitcoin" ]
|
||||||
]
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -81,19 +82,18 @@ If the user wants to keep the input parameters a secret, they can encrypt the `i
|
||||||
["param", "top-p", "0.7"],
|
["param", "top-p", "0.7"],
|
||||||
["param", "frequency_penalty", "1"]
|
["param", "frequency_penalty", "1"]
|
||||||
]
|
]
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This param data will be encrypted and added to the `content` field and `p` tag should be present
|
This param data will be encrypted and added to the `content` field and `p` tag should be present
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...",
|
"content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...",
|
||||||
"tags": [
|
"tags": [
|
||||||
["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"],
|
["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"],
|
||||||
["encrypted"]
|
["encrypted"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -102,7 +102,7 @@ This param data will be encrypted and added to the `content` field and `p` tag s
|
||||||
|
|
||||||
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.
|
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
|
```jsonc
|
||||||
{
|
{
|
||||||
"pubkey": "<service-provider pubkey>",
|
"pubkey": "<service-provider pubkey>",
|
||||||
"content": "<payload>",
|
"content": "<payload>",
|
||||||
|
@ -114,7 +114,7 @@ Service providers publish job results, providing the output of the job result. T
|
||||||
["p", "<customer's-pubkey>"],
|
["p", "<customer's-pubkey>"],
|
||||||
["amount", "requested-payment-amount", "<optional-bolt11>"]
|
["amount", "requested-payment-amount", "<optional-bolt11>"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -127,7 +127,7 @@ Service providers publish job results, providing the output of the job result. T
|
||||||
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`
|
Add a tag encrypted to mark the output content as `encrypted`
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"pubkey": "<service-provider pubkey>",
|
"pubkey": "<service-provider pubkey>",
|
||||||
"content": "<encrypted payload>",
|
"content": "<encrypted payload>",
|
||||||
|
@ -139,7 +139,7 @@ Add a tag encrypted to mark the output content as `encrypted`
|
||||||
["amount", "requested-payment-amount", "<optional-bolt11>"],
|
["amount", "requested-payment-amount", "<optional-bolt11>"],
|
||||||
["encrypted"]
|
["encrypted"]
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -147,7 +147,7 @@ Add a tag encrypted to mark the output content as `encrypted`
|
||||||
|
|
||||||
Service providers can give feedback about a job back to the customer.
|
Service providers can give feedback about a job back to the customer.
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 7000,
|
"kind": 7000,
|
||||||
"content": "<empty-or-payload>",
|
"content": "<empty-or-payload>",
|
||||||
|
@ -157,7 +157,7 @@ Service providers can give feedback about a job back to the customer.
|
||||||
["e", "<job-request-id>", "<relay-hint>"],
|
["e", "<job-request-id>", "<relay-hint>"],
|
||||||
["p", "<customer's-pubkey>"],
|
["p", "<customer's-pubkey>"],
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -211,7 +211,7 @@ This gives a higher level of flexibility to service providers (which sophisticat
|
||||||
# Appendix 2: Service provider discoverability
|
# Appendix 2: Service provider discoverability
|
||||||
Service Providers MAY use NIP-89 announcements to advertise their support for job kinds:
|
Service Providers MAY use NIP-89 announcements to advertise their support for job kinds:
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 31990,
|
"kind": 31990,
|
||||||
"pubkey": "<pubkey>",
|
"pubkey": "<pubkey>",
|
||||||
|
@ -223,7 +223,7 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo
|
||||||
["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"
|
["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains"
|
||||||
],
|
],
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
17
94.md
17
94.md
|
@ -26,27 +26,28 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
|
||||||
* `summary` (optional) text excerpt
|
* `summary` (optional) text excerpt
|
||||||
* `alt` (optional) description for accessibility
|
* `alt` (optional) description for accessibility
|
||||||
* `fallback` (optional) zero or more fallback file sources in case `url` fails
|
* `fallback` (optional) zero or more fallback file sources in case `url` fails
|
||||||
|
* `service` (optional) service type which is serving the file (eg. [NIP-96](96.md))
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 1063,
|
"kind": 1063,
|
||||||
"tags": [
|
"tags": [
|
||||||
["url",<string with URI of file>],
|
["url",<string with URI of file>],
|
||||||
["m", <MIME type>],
|
["m", <MIME type>],
|
||||||
["x",<Hash SHA-256>],
|
["x", <Hash SHA-256>],
|
||||||
["ox",<Hash SHA-256>],
|
["ox", <Hash SHA-256>],
|
||||||
["size", <size of file in bytes>],
|
["size", <size of file in bytes>],
|
||||||
["dim", <size of file in pixels>],
|
["dim", <size of file in pixels>],
|
||||||
["magnet",<magnet URI> ],
|
["magnet", <magnet URI> ],
|
||||||
["i",<torrent infohash>],
|
["i", <torrent infohash>],
|
||||||
["blurhash", <value>],
|
["blurhash", <value>],
|
||||||
["thumb", <string with thumbnail URI>],
|
["thumb", <string with thumbnail URI>, <Hash SHA-256>],
|
||||||
["image", <string with preview URI>],
|
["image", <string with preview URI>, <Hash SHA-256>],
|
||||||
["summary", <excerpt>],
|
["summary", <excerpt>],
|
||||||
["alt", <description>]
|
["alt", <description>]
|
||||||
],
|
],
|
||||||
"content": "<caption>",
|
"content": "<caption>",
|
||||||
...
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
51
96.md
51
96.md
|
@ -19,7 +19,7 @@ will not have to learn anything about nostr relays.
|
||||||
|
|
||||||
File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`:
|
File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`:
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
// Required
|
// Required
|
||||||
// File upload and deletion are served from this url
|
// File upload and deletion are served from this url
|
||||||
|
@ -59,7 +59,7 @@ File storage servers wishing to be accessible by nostr users should opt-in by ma
|
||||||
"file_expiration": [14, 90],
|
"file_expiration": [14, 90],
|
||||||
"media_transformations": {
|
"media_transformations": {
|
||||||
"image": [
|
"image": [
|
||||||
'resizing'
|
"resizing"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -127,14 +127,14 @@ The `server` MUST link the user's `pubkey` string as the owner of the file so to
|
||||||
|
|
||||||
The upload response is a json object as follows:
|
The upload response is a json object as follows:
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
// "success" if successful or "error" if not
|
// "success" if successful or "error" if not
|
||||||
status: "success",
|
"status": "success",
|
||||||
// Free text success, failure or info message
|
// Free text success, failure or info message
|
||||||
message: "Upload successful.",
|
"message": "Upload successful.",
|
||||||
// Optional. See "Delayed Processing" section
|
// Optional. See "Delayed Processing" section
|
||||||
processing_url: "...",
|
"processing_url": "...",
|
||||||
// This uses the NIP-94 event format but DO NOT need
|
// This uses the NIP-94 event format but DO NOT need
|
||||||
// to fill some fields like "id", "pubkey", "created_at" and "sig"
|
// to fill some fields like "id", "pubkey", "created_at" and "sig"
|
||||||
//
|
//
|
||||||
|
@ -143,9 +143,9 @@ The upload response is a json object as follows:
|
||||||
// and, optionally, all file metadata the server wants to make available
|
// and, optionally, all file metadata the server wants to make available
|
||||||
//
|
//
|
||||||
// nip94_event field is absent if unsuccessful upload
|
// nip94_event field is absent if unsuccessful upload
|
||||||
nip94_event: {
|
"nip94_event": {
|
||||||
// Required tags: "url" and "ox"
|
// Required tags: "url" and "ox"
|
||||||
tags: [
|
"tags": [
|
||||||
// Can be same from /.well-known/nostr/nip96.json's "download_url" field
|
// Can be same from /.well-known/nostr/nip96.json's "download_url" field
|
||||||
// (or "api_url" field if "download_url" is absent or empty) with appended
|
// (or "api_url" field if "download_url" is absent or empty) with appended
|
||||||
// original file hash.
|
// original file hash.
|
||||||
|
@ -166,12 +166,12 @@ The upload response is a json object as follows:
|
||||||
// The server can but does not need to store this value.
|
// The server can but does not need to store this value.
|
||||||
["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"],
|
["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"],
|
||||||
// Optional. Recommended for helping clients to easily know file type before downloading it.
|
// Optional. Recommended for helping clients to easily know file type before downloading it.
|
||||||
["m", "image/png"]
|
["m", "image/png"],
|
||||||
// Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it.
|
// Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it.
|
||||||
["dim", "800x600"]
|
["dim", "800x600"]
|
||||||
// ... other optional NIP-94 tags
|
// ... other optional NIP-94 tags
|
||||||
],
|
],
|
||||||
content: ""
|
"content": ""
|
||||||
},
|
},
|
||||||
// ... other custom fields (please consider adding them to this NIP or to NIP-94 tags)
|
// ... other custom fields (please consider adding them to this NIP or to NIP-94 tags)
|
||||||
}
|
}
|
||||||
|
@ -202,12 +202,12 @@ the file processing is done.
|
||||||
|
|
||||||
If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON:
|
If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON:
|
||||||
|
|
||||||
```
|
```jsonc
|
||||||
{
|
{
|
||||||
// It should be "processing". If "error" it would mean the processing failed.
|
// It should be "processing". If "error" it would mean the processing failed.
|
||||||
status: "processing",
|
"status": "processing",
|
||||||
message: "Processing. Please check again later for updated status.",
|
"message": "Processing. Please check again later for updated status.",
|
||||||
percentage: 15 // Processing percentage. An integer between 0 and 100.
|
"percentage": 15 // Processing percentage. An integer between 0 and 100.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -270,10 +270,10 @@ in the same file hash).
|
||||||
|
|
||||||
The successful response is a 200 OK one with just basic JSON fields:
|
The successful response is a 200 OK one with just basic JSON fields:
|
||||||
|
|
||||||
```
|
```json
|
||||||
{
|
{
|
||||||
status: "success",
|
"status": "success",
|
||||||
message: "File deleted."
|
"message": "File deleted."
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -287,7 +287,7 @@ Returns a list of files linked to the authenticated users pubkey.
|
||||||
|
|
||||||
Example Response:
|
Example Response:
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
"count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count))
|
"count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count))
|
||||||
"total": 1, // total number of files
|
"total": 1, // total number of files
|
||||||
|
@ -295,17 +295,16 @@ Example Response:
|
||||||
"files": [
|
"files": [
|
||||||
{
|
{
|
||||||
"tags": [
|
"tags": [
|
||||||
["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
|
["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
|
||||||
["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"],
|
["x", "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"],
|
||||||
["size", "123456"],
|
["size", "123456"],
|
||||||
["alt", "a meme that makes you laugh"],
|
["alt", "a meme that makes you laugh"],
|
||||||
["expiration", "1715691139"],
|
["expiration", "1715691139"],
|
||||||
// ...other metadata
|
// ...other metadata
|
||||||
]
|
],
|
||||||
"content": "haha funny meme", // caption
|
"content": "haha funny meme", // caption
|
||||||
"created_at": 1715691130 // upload timestamp
|
"created_at": 1715691130 // upload timestamp
|
||||||
},
|
}
|
||||||
...
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -324,14 +323,14 @@ Note: HTTP File Storage Server developers may skip this section. This is meant f
|
||||||
A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
|
A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
|
||||||
to upload files to. Servers are listed as `server` tags:
|
to upload files to. Servers are listed as `server` tags:
|
||||||
|
|
||||||
```js
|
```jsonc
|
||||||
{
|
{
|
||||||
// ...
|
|
||||||
"kind": 10096,
|
"kind": 10096,
|
||||||
"content": "",
|
"content": "",
|
||||||
"tags": [
|
"tags": [
|
||||||
["server", "https://file.server.one"],
|
["server", "https://file.server.one"],
|
||||||
["server", "https://file.server.two"]
|
["server", "https://file.server.two"]
|
||||||
]
|
],
|
||||||
|
// other fields...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
4
99.md
4
99.md
|
@ -26,7 +26,7 @@ The `.pubkey` field of these events are treated as the party creating the listin
|
||||||
|
|
||||||
### Metadata
|
### 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](12.md).
|
- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used.
|
||||||
- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily.
|
- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily.
|
||||||
|
|
||||||
The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary.
|
The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary.
|
||||||
|
@ -54,7 +54,7 @@ Other standard tags that might be useful.
|
||||||
|
|
||||||
## Example Event
|
## Example Event
|
||||||
|
|
||||||
```json
|
```jsonc
|
||||||
{
|
{
|
||||||
"kind": 30402,
|
"kind": 30402,
|
||||||
"created_at": 1675642635,
|
"created_at": 1675642635,
|
||||||
|
|
|
@ -5,6 +5,14 @@ reverse chronological order.
|
||||||
|
|
||||||
| Date | Commit | NIP | Change |
|
| Date | Commit | NIP | Change |
|
||||||
| ----------- | --------- | -------- | ------ |
|
| ----------- | --------- | -------- | ------ |
|
||||||
|
| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [NIP-29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) |
|
||||||
|
| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | NIP-05 login was removed |
|
||||||
|
| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `create_account` method was removed |
|
||||||
|
| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `connect` params and result were changed |
|
||||||
|
| 2024-10-29 | [f1e8d2c4](https://github.com/nostr-protocol/nips/commit/f1e8d2c4) | [NIP-46](46.md) | bunker URL should use `remote-signer-key` |
|
||||||
|
| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag |
|
||||||
|
| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped |
|
||||||
|
| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed |
|
||||||
| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc |
|
| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc |
|
||||||
| 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [NIP-45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted |
|
| 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [NIP-45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted |
|
||||||
| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated |
|
| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated |
|
||||||
|
@ -57,4 +65,3 @@ Breaking changes prior to 2023-03-01 are not yet documented.
|
||||||
|
|
||||||
- If it isn't clear that a change is breaking or not, we list it.
|
- If it isn't clear that a change is breaking or not, we list it.
|
||||||
- The date is the date it was merged, not necessarily the date of the commit.
|
- The date is the date it was merged, not necessarily the date of the commit.
|
||||||
|
|
||||||
|
|
29
C7.md
Normal file
29
C7.md
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
NIP-C7
|
||||||
|
======
|
||||||
|
|
||||||
|
Chats
|
||||||
|
-----
|
||||||
|
|
||||||
|
`draft` `optional`
|
||||||
|
|
||||||
|
A chat message is a `kind 9` event.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"kind": 9,
|
||||||
|
"content": "GM",
|
||||||
|
"tags": []
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A reply to a `kind 9` is an additional `kind 9` which quotes the parent using a `q` tag.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"kind": 9,
|
||||||
|
"content": "nostr:nevent1...\nyes",
|
||||||
|
"tags": [
|
||||||
|
["q", <event-id>, <relay-url>, <pubkey>]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
150
README.md
150
README.md
|
@ -40,6 +40,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
- [NIP-18: Reposts](18.md)
|
- [NIP-18: Reposts](18.md)
|
||||||
- [NIP-19: bech32-encoded entities](19.md)
|
- [NIP-19: bech32-encoded entities](19.md)
|
||||||
- [NIP-21: `nostr:` URI scheme](21.md)
|
- [NIP-21: `nostr:` URI scheme](21.md)
|
||||||
|
- [NIP-22: Comment](22.md)
|
||||||
- [NIP-23: Long-form Content](23.md)
|
- [NIP-23: Long-form Content](23.md)
|
||||||
- [NIP-24: Extra metadata fields and tags](24.md)
|
- [NIP-24: Extra metadata fields and tags](24.md)
|
||||||
- [NIP-25: Reactions](25.md)
|
- [NIP-25: Reactions](25.md)
|
||||||
|
@ -73,8 +74,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
- [NIP-57: Lightning Zaps](57.md)
|
- [NIP-57: Lightning Zaps](57.md)
|
||||||
- [NIP-58: Badges](58.md)
|
- [NIP-58: Badges](58.md)
|
||||||
- [NIP-59: Gift Wrap](59.md)
|
- [NIP-59: Gift Wrap](59.md)
|
||||||
|
- [NIP-60: Cashu Wallet](60.md)
|
||||||
|
- [NIP-61: Nutzaps](61.md)
|
||||||
- [NIP-64: Chess (PGN)](64.md)
|
- [NIP-64: Chess (PGN)](64.md)
|
||||||
- [NIP-65: Relay List Metadata](65.md)
|
- [NIP-65: Relay List Metadata](65.md)
|
||||||
|
- [NIP-68: Picture-first feeds](68.md)
|
||||||
|
- [NIP-69: Peer-to-peer Order events](69.md)
|
||||||
- [NIP-70: Protected Events](70.md)
|
- [NIP-70: Protected Events](70.md)
|
||||||
- [NIP-71: Video Events](71.md)
|
- [NIP-71: Video Events](71.md)
|
||||||
- [NIP-72: Moderated Communities](72.md)
|
- [NIP-72: Moderated Communities](72.md)
|
||||||
|
@ -82,6 +87,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
- [NIP-75: Zap Goals](75.md)
|
- [NIP-75: Zap Goals](75.md)
|
||||||
- [NIP-78: Application-specific data](78.md)
|
- [NIP-78: Application-specific data](78.md)
|
||||||
- [NIP-84: Highlights](84.md)
|
- [NIP-84: Highlights](84.md)
|
||||||
|
- [NIP-86: Relay Management API](86.md)
|
||||||
- [NIP-89: Recommended Application Handlers](89.md)
|
- [NIP-89: Recommended Application Handlers](89.md)
|
||||||
- [NIP-90: Data Vending Machines](90.md)
|
- [NIP-90: Data Vending Machines](90.md)
|
||||||
- [NIP-92: Media Attachments](92.md)
|
- [NIP-92: Media Attachments](92.md)
|
||||||
|
@ -89,6 +95,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
- [NIP-96: HTTP File Storage Integration](96.md)
|
- [NIP-96: HTTP File Storage Integration](96.md)
|
||||||
- [NIP-98: HTTP Auth](98.md)
|
- [NIP-98: HTTP Auth](98.md)
|
||||||
- [NIP-99: Classified Listings](99.md)
|
- [NIP-99: Classified Listings](99.md)
|
||||||
|
- [NIP-7D: Threads](7D.md)
|
||||||
|
- [NIP-C7: Chats](C7.md)
|
||||||
|
|
||||||
## Event Kinds
|
## Event Kinds
|
||||||
|
|
||||||
|
@ -103,10 +111,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `6` | Repost | [18](18.md) |
|
| `6` | Repost | [18](18.md) |
|
||||||
| `7` | Reaction | [25](25.md) |
|
| `7` | Reaction | [25](25.md) |
|
||||||
| `8` | Badge Award | [58](58.md) |
|
| `8` | Badge Award | [58](58.md) |
|
||||||
| `9` | Group Chat Message | [29](29.md) |
|
| `9` | Chat Message | [C7](C7.md) |
|
||||||
| `10` | Group Chat Threaded Reply | [29](29.md) |
|
| `10` | Group Chat Threaded Reply | 29 (deprecated) |
|
||||||
| `11` | Group Thread | [29](29.md) |
|
| `11` | Thread | [7D](7D.md) |
|
||||||
| `12` | Group Thread Reply | [29](29.md) |
|
| `12` | Group Thread Reply | 29 (deprecated) |
|
||||||
| `13` | Seal | [59](59.md) |
|
| `13` | Seal | [59](59.md) |
|
||||||
| `14` | Direct Message | [17](17.md) |
|
| `14` | Direct Message | [17](17.md) |
|
||||||
| `16` | Generic Repost | [18](18.md) |
|
| `16` | Generic Repost | [18](18.md) |
|
||||||
|
@ -123,6 +131,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `1040` | OpenTimestamps | [03](03.md) |
|
| `1040` | OpenTimestamps | [03](03.md) |
|
||||||
| `1059` | Gift Wrap | [59](59.md) |
|
| `1059` | Gift Wrap | [59](59.md) |
|
||||||
| `1063` | File Metadata | [94](94.md) |
|
| `1063` | File Metadata | [94](94.md) |
|
||||||
|
| `1111` | Comment | [22](22.md) |
|
||||||
| `1311` | Live Chat Message | [53](53.md) |
|
| `1311` | Live Chat Message | [53](53.md) |
|
||||||
| `1617` | Patches | [34](34.md) |
|
| `1617` | Patches | [34](34.md) |
|
||||||
| `1621` | Issues | [34](34.md) |
|
| `1621` | Issues | [34](34.md) |
|
||||||
|
@ -140,10 +149,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `5000`-`5999` | Job Request | [90](90.md) |
|
| `5000`-`5999` | Job Request | [90](90.md) |
|
||||||
| `6000`-`6999` | Job Result | [90](90.md) |
|
| `6000`-`6999` | Job Result | [90](90.md) |
|
||||||
| `7000` | Job Feedback | [90](90.md) |
|
| `7000` | Job Feedback | [90](90.md) |
|
||||||
|
| `7374` | Reserved Cashu Wallet Tokens | [60](60.md) |
|
||||||
|
| `7375` | Cashu Wallet Tokens | [60](60.md) |
|
||||||
|
| `7376` | Cashu Wallet History | [60](60.md) |
|
||||||
| `9000`-`9030` | Group Control Events | [29](29.md) |
|
| `9000`-`9030` | Group Control Events | [29](29.md) |
|
||||||
| `9041` | Zap Goal | [75](75.md) |
|
| `9041` | Zap Goal | [75](75.md) |
|
||||||
| `9734` | Zap Request | [57](57.md) |
|
| `9321` | Nutzap | [61](61.md) |
|
||||||
| `9467` | Tidal login | [Tidal-nostr] |
|
| `9467` | Tidal login | [Tidal-nostr] |
|
||||||
|
| `9734` | Zap Request | [57](57.md) |
|
||||||
| `9735` | Zap | [57](57.md) |
|
| `9735` | Zap | [57](57.md) |
|
||||||
| `9802` | Highlights | [84](84.md) |
|
| `9802` | Highlights | [84](84.md) |
|
||||||
| `10000` | Mute list | [51](51.md) |
|
| `10000` | Mute list | [51](51.md) |
|
||||||
|
@ -156,9 +169,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `10007` | Search relays list | [51](51.md) |
|
| `10007` | Search relays list | [51](51.md) |
|
||||||
| `10009` | User groups | [51](51.md), [29](29.md) |
|
| `10009` | User groups | [51](51.md), [29](29.md) |
|
||||||
| `10015` | Interests list | [51](51.md) |
|
| `10015` | Interests list | [51](51.md) |
|
||||||
|
| `10019` | Nutzap Mint Recommendation | [61](61.md) |
|
||||||
| `10030` | User emoji list | [51](51.md) |
|
| `10030` | User emoji list | [51](51.md) |
|
||||||
| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) |
|
| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) |
|
||||||
| `10063` | User server list | [blossom] |
|
| `10063` | User server list | [Blossom][blossom] |
|
||||||
| `10096` | File storage server list | [96](96.md) |
|
| `10096` | File storage server list | [96](96.md) |
|
||||||
| `13194` | Wallet Info | [47](47.md) |
|
| `13194` | Wallet Info | [47](47.md) |
|
||||||
| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
|
| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
|
||||||
|
@ -166,7 +180,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `23194` | Wallet Request | [47](47.md) |
|
| `23194` | Wallet Request | [47](47.md) |
|
||||||
| `23195` | Wallet Response | [47](47.md) |
|
| `23195` | Wallet Response | [47](47.md) |
|
||||||
| `24133` | Nostr Connect | [46](46.md) |
|
| `24133` | Nostr Connect | [46](46.md) |
|
||||||
| `24242` | Blobs stored on mediaservers | [blossom] |
|
| `24242` | Blobs stored on mediaservers | [Blossom][blossom] |
|
||||||
| `27235` | HTTP Auth | [98](98.md) |
|
| `27235` | HTTP Auth | [98](98.md) |
|
||||||
| `30000` | Follow sets | [51](51.md) |
|
| `30000` | Follow sets | [51](51.md) |
|
||||||
| `30001` | Generic lists | [51](51.md) |
|
| `30001` | Generic lists | [51](51.md) |
|
||||||
|
@ -174,6 +188,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `30003` | Bookmark sets | [51](51.md) |
|
| `30003` | Bookmark sets | [51](51.md) |
|
||||||
| `30004` | Curation sets | [51](51.md) |
|
| `30004` | Curation sets | [51](51.md) |
|
||||||
| `30005` | Video sets | [51](51.md) |
|
| `30005` | Video sets | [51](51.md) |
|
||||||
|
| `30007` | Kind mute sets | [51](51.md) |
|
||||||
| `30008` | Profile Badges | [58](58.md) |
|
| `30008` | Profile Badges | [58](58.md) |
|
||||||
| `30009` | Badge Definition | [58](58.md) |
|
| `30009` | Badge Definition | [58](58.md) |
|
||||||
| `30015` | Interest sets | [51](51.md) |
|
| `30015` | Interest sets | [51](51.md) |
|
||||||
|
@ -190,12 +205,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `30078` | Application-specific Data | [78](78.md) |
|
| `30078` | Application-specific Data | [78](78.md) |
|
||||||
| `30311` | Live Event | [53](53.md) |
|
| `30311` | Live Event | [53](53.md) |
|
||||||
| `30315` | User Statuses | [38](38.md) |
|
| `30315` | User Statuses | [38](38.md) |
|
||||||
|
| `30388` | Slide Set | [Corny Chat][cornychat-slideset] |
|
||||||
| `30402` | Classified Listing | [99](99.md) |
|
| `30402` | Classified Listing | [99](99.md) |
|
||||||
| `30403` | Draft Classified Listing | [99](99.md) |
|
| `30403` | Draft Classified Listing | [99](99.md) |
|
||||||
| `30617` | Repository announcements | [34](34.md) |
|
| `30617` | Repository announcements | [34](34.md) |
|
||||||
| `30618` | Repository state announcements | [34](34.md) |
|
| `30618` | Repository state announcements | [34](34.md) |
|
||||||
| `30818` | Wiki article | [54](54.md) |
|
| `30818` | Wiki article | [54](54.md) |
|
||||||
| `30819` | Redirects | [54](54.md) |
|
| `30819` | Redirects | [54](54.md) |
|
||||||
|
| `31388` | Link Set | [Corny Chat][cornychat-linkset] |
|
||||||
| `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] |
|
| `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] |
|
||||||
| `31922` | Date-Based Calendar Event | [52](52.md) |
|
| `31922` | Date-Based Calendar Event | [52](52.md) |
|
||||||
| `31923` | Time-Based Calendar Event | [52](52.md) |
|
| `31923` | Time-Based Calendar Event | [52](52.md) |
|
||||||
|
@ -205,17 +222,20 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
| `31990` | Handler information | [89](89.md) |
|
| `31990` | Handler information | [89](89.md) |
|
||||||
| `34235` | Video Event | [71](71.md) |
|
| `34235` | Video Event | [71](71.md) |
|
||||||
| `34236` | Short-form Portrait Video Event | [71](71.md) |
|
| `34236` | Short-form Portrait Video Event | [71](71.md) |
|
||||||
| `34237` | Video View Event | [71](71.md) |
|
|
||||||
| `34550` | Community Definition | [72](72.md) |
|
| `34550` | Community Definition | [72](72.md) |
|
||||||
|
| `37375` | Cashu Wallet Event | [60](60.md) |
|
||||||
|
| `38383` | Peer-to-peer Order events | [69](69.md) |
|
||||||
| `39000-9` | Group metadata events | [29](29.md) |
|
| `39000-9` | Group metadata events | [29](29.md) |
|
||||||
|
|
||||||
[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/
|
[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/
|
||||||
[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
|
[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
|
||||||
[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
|
[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
|
||||||
|
[cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset
|
||||||
|
[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset
|
||||||
[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md
|
[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md
|
||||||
[NKBIP-01]: https://wikistr.com/nkbip-01
|
[NKBIP-01]: https://wikistr.com/nkbip-01
|
||||||
[NKBIP-02]: https://wikistr.com/nkbip-02
|
[NKBIP-02]: https://wikistr.com/nkbip-02
|
||||||
[Blossom]: https://wikistr.com/blossom
|
[blossom]: https://github.com/hzrd149/blossom
|
||||||
[Tidal-nostr]: https://wikistr.com/tidal-nostr
|
[Tidal-nostr]: https://wikistr.com/tidal-nostr
|
||||||
|
|
||||||
## Message types
|
## Message types
|
||||||
|
@ -244,56 +264,68 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
|
|
||||||
## Standardized Tags
|
## Standardized Tags
|
||||||
|
|
||||||
| name | value | other parameters | NIP |
|
| name | value | other parameters | NIP |
|
||||||
| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- |
|
| ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- |
|
||||||
| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) |
|
| `a` | coordinates to an event | relay URL | [01](01.md) |
|
||||||
| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
|
| `A` | root address | relay URL | [22](22.md) |
|
||||||
| `a` | coordinates to an event | relay URL | [01](01.md) |
|
| `d` | identifier | -- | [01](01.md) |
|
||||||
| `d` | identifier | -- | [01](01.md) |
|
| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) |
|
||||||
| `-` | -- | -- | [70](70.md) |
|
| `E` | root event id | relay URL | [22](22.md) |
|
||||||
| `g` | geohash | -- | [52](52.md) |
|
| `f` | currency code | -- | [69](69.md) |
|
||||||
| `h` | group id | -- | [29](29.md) |
|
| `g` | geohash | -- | [52](52.md) |
|
||||||
| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) |
|
| `h` | group id | -- | [29](29.md) |
|
||||||
| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) |
|
| `i` | external identity | proof, url hint | [35](35.md), [39](39.md), [73](73.md) |
|
||||||
| `l` | label, label namespace | -- | [32](32.md) |
|
| `I` | root external identity | -- | [22](22.md) |
|
||||||
| `L` | label namespace | -- | [32](32.md) |
|
| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) |
|
||||||
| `m` | MIME type | -- | [94](94.md) |
|
| `K` | root scope | -- | [22](22.md) |
|
||||||
| `q` | event id (hex) | relay URL | [18](18.md) |
|
| `l` | label, label namespace | -- | [32](32.md) |
|
||||||
| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) |
|
| `L` | label namespace | -- | [32](32.md) |
|
||||||
| `r` | relay url | marker | [65](65.md) |
|
| `m` | MIME type | -- | [94](94.md) |
|
||||||
| `t` | hashtag | -- | [24](24.md) |
|
| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
|
||||||
| `alt` | summary | -- | [31](31.md) |
|
| `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) |
|
||||||
| `amount` | millisatoshis, stringified | -- | [57](57.md) |
|
| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) |
|
||||||
| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
|
| `r` | relay url | marker | [65](65.md) |
|
||||||
| `challenge` | challenge string | -- | [42](42.md) |
|
| `s` | status | -- | [69](69.md) |
|
||||||
| `client` | name, address | relay URL | [89](89.md) |
|
| `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) |
|
||||||
| `clone` | git clone URL | -- | [34](34.md) |
|
| `u` | url | -- | [61](61.md), [98](98.md) |
|
||||||
| `content-warning` | reason | -- | [36](36.md) |
|
| `x` | infohash | -- | [35](35.md) |
|
||||||
| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
|
| `y` | platform | -- | [69](69.md) |
|
||||||
| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) |
|
| `z` | order number | -- | [69](69.md) |
|
||||||
| `emoji` | shortcode, image URL | -- | [30](30.md) |
|
| `-` | -- | -- | [70](70.md) |
|
||||||
| `encrypted` | -- | -- | [90](90.md) |
|
| `alt` | summary | -- | [31](31.md) |
|
||||||
| `expiration` | unix timestamp (string) | -- | [40](40.md) |
|
| `amount` | millisatoshis, stringified | -- | [57](57.md) |
|
||||||
| `goal` | event id (hex) | relay URL | [75](75.md) |
|
| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
|
||||||
| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) |
|
| `challenge` | challenge string | -- | [42](42.md) |
|
||||||
| `imeta` | inline metadata | -- | [92](92.md) |
|
| `client` | name, address | relay URL | [89](89.md) |
|
||||||
| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
|
| `clone` | git clone URL | -- | [34](34.md) |
|
||||||
| `location` | location string | -- | [52](52.md), [99](99.md) |
|
| `content-warning` | reason | -- | [36](36.md) |
|
||||||
| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) |
|
| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
|
||||||
| `nonce` | random | difficulty | [13](13.md) |
|
| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) |
|
||||||
| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
|
| `emoji` | shortcode, image URL | -- | [30](30.md) |
|
||||||
| `price` | price | currency, frequency | [99](99.md) |
|
| `encrypted` | -- | -- | [90](90.md) |
|
||||||
| `proxy` | external ID | protocol | [48](48.md) |
|
| `expiration` | unix timestamp (string) | -- | [40](40.md) |
|
||||||
| `published_at` | unix timestamp (string) | -- | [23](23.md) |
|
| `file` | full path (string) | -- | [35](35.md) |
|
||||||
| `relay` | relay url | -- | [42](42.md), [17](17.md) |
|
| `goal` | event id (hex) | relay URL | [75](75.md) |
|
||||||
| `relays` | relay list | -- | [57](57.md) |
|
| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) |
|
||||||
| `server` | file storage server url | -- | [96](96.md) |
|
| `imeta` | inline metadata | -- | [92](92.md) |
|
||||||
| `subject` | subject | -- | [14](14.md), [17](17.md) |
|
| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
|
||||||
| `summary` | summary | -- | [23](23.md), [52](52.md) |
|
| `location` | location string | -- | [52](52.md), [99](99.md) |
|
||||||
| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
|
| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) |
|
||||||
| `title` | article title | -- | [23](23.md) |
|
| `nonce` | random | difficulty | [13](13.md) |
|
||||||
| `web` | webpage URL | -- | [34](34.md) |
|
| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
|
||||||
| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
|
| `price` | price | currency, frequency | [99](99.md) |
|
||||||
|
| `proxy` | external ID | protocol | [48](48.md) |
|
||||||
|
| `published_at` | unix timestamp (string) | -- | [23](23.md) |
|
||||||
|
| `relay` | relay url | -- | [42](42.md), [17](17.md) |
|
||||||
|
| `relays` | relay list | -- | [57](57.md) |
|
||||||
|
| `server` | file storage server url | -- | [96](96.md) |
|
||||||
|
| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) |
|
||||||
|
| `summary` | summary | -- | [23](23.md), [52](52.md) |
|
||||||
|
| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
|
||||||
|
| `title` | article title | -- | [23](23.md) |
|
||||||
|
| `tracker` | torrent tracker URL | -- | [35](35.md) |
|
||||||
|
| `web` | webpage URL | -- | [34](34.md) |
|
||||||
|
| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
|
||||||
|
|
||||||
Please update these lists when proposing new NIPs.
|
Please update these lists when proposing new NIPs.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user