mirror of
https://github.com/nostr-protocol/nips.git
synced 2025-12-15 03:18:51 +00:00
Compare commits
1 Commits
d54c426709
...
nip71-addr
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a5ab7da4d2 |
22
45.md
22
45.md
@@ -14,17 +14,17 @@ Some queries a client may want to execute against connected relays are prohibiti
|
|||||||
|
|
||||||
## Filters and return values
|
## Filters and return values
|
||||||
|
|
||||||
This NIP defines the verb `COUNT`, which accepts a query id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result.
|
This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result.
|
||||||
|
|
||||||
```
|
```
|
||||||
["COUNT", <query_id>, <filters JSON>...]
|
["COUNT", <subscription_id>, <filters JSON>...]
|
||||||
```
|
```
|
||||||
|
|
||||||
Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
|
Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
|
||||||
In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`.
|
In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`.
|
||||||
|
|
||||||
```
|
```
|
||||||
["COUNT", <query_id>, {"count": <integer>}]
|
["COUNT", <subscription_id>, {"count": <integer>}]
|
||||||
```
|
```
|
||||||
|
|
||||||
Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message.
|
Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message.
|
||||||
@@ -34,27 +34,27 @@ Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST ret
|
|||||||
### Followers count
|
### Followers count
|
||||||
|
|
||||||
```
|
```
|
||||||
["COUNT", <query_id>, {"kinds": [3], "#p": [<pubkey>]}]
|
["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
|
||||||
["COUNT", <query_id>, {"count": 238}]
|
["COUNT", <subscription_id>, {"count": 238}]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Count posts and reactions
|
### Count posts and reactions
|
||||||
|
|
||||||
```
|
```
|
||||||
["COUNT", <query_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
|
["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
|
||||||
["COUNT", <query_id>, {"count": 5}]
|
["COUNT", <subscription_id>, {"count": 5}]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Count posts approximately
|
### Count posts approximately
|
||||||
|
|
||||||
```
|
```
|
||||||
["COUNT", <query_id>, {"kinds": [1]}]
|
["COUNT", <subscription_id>, {"kinds": [1]}]
|
||||||
["COUNT", <query_id>, {"count": 93412452, "approximate": true}]
|
["COUNT", <subscription_id>, {"count": 93412452, "approximate": true}]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Relay refuses to count
|
### Relay refuses to count
|
||||||
|
|
||||||
```
|
```
|
||||||
["COUNT", <query_id>, {"kinds": [1059], "#p": [<pubkey>]}]
|
["COUNT", <subscription_id>, {"kinds": [4], "authors": [<pubkey>], "#p": [<pubkey>]}]
|
||||||
["CLOSED", <query_id>, "auth-required: cannot count other people's DMs"]
|
["CLOSED", <subscription_id>, "auth-required: cannot count other people's DMs"]
|
||||||
```
|
```
|
||||||
|
|||||||
18
47.md
18
47.md
@@ -667,21 +667,3 @@ Here are some properties that are recognized by some NWC clients:
|
|||||||
"sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8"
|
"sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deep-links
|
|
||||||
|
|
||||||
Wallet applications can register deeplinks in mobile systems to make it possible to create a linking UX that doesn't require the user scanning a QR code or pasting some code.
|
|
||||||
|
|
||||||
`nostrnwc://connect` and `nostrnwc+{app_name}://connect` can be registered by wallet apps and queried by apps that want to receive an NWC pairing code.
|
|
||||||
|
|
||||||
All URI parameters, MUST be URI-encoded.
|
|
||||||
|
|
||||||
URI parameters:
|
|
||||||
* `appicon` -- URL to an icon of the client that wants to create a connection.
|
|
||||||
* `appname` -- Name of the client that wants to create a connection.
|
|
||||||
* `callback` -- URI schema the wallet should open with the connection string
|
|
||||||
|
|
||||||
Once a connection has been created by the wallet, it should be returned to the client by opening the callback with the following parameters
|
|
||||||
* `value` -- NWC pairing code (e.g. `nostr+walletconnect://...`)
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
4
55.md
4
55.md
@@ -295,8 +295,6 @@ 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
|
||||||
|
|
||||||
Clients SHOULD save the user pubkey locally and avoid calling the `get_public_key` after the user is logged in to the Client
|
|
||||||
|
|
||||||
#### Methods
|
#### Methods
|
||||||
|
|
||||||
- **get_public_key**
|
- **get_public_key**
|
||||||
@@ -305,7 +303,7 @@ Clients SHOULD save the user pubkey locally and avoid calling the `get_public_ke
|
|||||||
```kotlin
|
```kotlin
|
||||||
val result = context.contentResolver.query(
|
val result = context.contentResolver.query(
|
||||||
Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"),
|
Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"),
|
||||||
listOf(hex_pub_key),
|
listOf("login"),
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
null
|
null
|
||||||
|
|||||||
2
66.md
2
66.md
@@ -53,7 +53,7 @@ Example:
|
|||||||
["g", "ww8p1r4t8"],
|
["g", "ww8p1r4t8"],
|
||||||
["l", "en", "ISO-639-1"],
|
["l", "en", "ISO-639-1"],
|
||||||
["t", "nsfw" ],
|
["t", "nsfw" ],
|
||||||
["rtt-open", "234" ]
|
["rtt-open", 234 ]
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
73
71.md
73
71.md
@@ -20,6 +20,20 @@ Nothing except cavaliership and common sense prevents a _short_ video from being
|
|||||||
|
|
||||||
The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos.
|
The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos.
|
||||||
|
|
||||||
|
## Addressable Video Events
|
||||||
|
|
||||||
|
For content that may need updates after publication (such as correcting metadata, descriptions, or handling URL migrations), addressable versions are available:
|
||||||
|
|
||||||
|
- Kind `34235` for _addressable normal videos_
|
||||||
|
- Kind `34236` for _addressable short videos_
|
||||||
|
|
||||||
|
These addressable events follow the same format as their regular counterparts but include a `d` tag as a unique identifier and can be updated while maintaining the same addressable reference. This is particularly useful for:
|
||||||
|
|
||||||
|
- Metadata corrections (descriptions, titles, tags) without republishing
|
||||||
|
- Preservation of imported content IDs from legacy platforms
|
||||||
|
- URL migration when hosting changes
|
||||||
|
- Platform migration tracking
|
||||||
|
|
||||||
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 primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md)
|
The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md)
|
||||||
@@ -71,6 +85,9 @@ The `image` tag contains a preview image (at the same resolution). Multiple `ima
|
|||||||
|
|
||||||
Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash.
|
Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash.
|
||||||
|
|
||||||
|
### Required tags for addressable events:
|
||||||
|
* `d` - Unique identifier for this video (user-chosen string, required for kinds 34235, 34236)
|
||||||
|
|
||||||
### Other tags:
|
### 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
|
||||||
@@ -83,6 +100,9 @@ Additionally `service nip96` may be included to allow clients to search the auth
|
|||||||
* `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
|
||||||
|
|
||||||
|
### Optional tags for imported content:
|
||||||
|
* `origin` - Track original platform and ID: `["origin", "<platform>", "<external-id>", "<original-url>", "<optional-metadata>"]`
|
||||||
|
|
||||||
```jsonc
|
```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>",
|
||||||
@@ -127,3 +147,56 @@ Additionally `service nip96` may be included to allow clients to search the auth
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Addressable Event Example
|
||||||
|
|
||||||
|
```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": 34235 | 34236,
|
||||||
|
"content": "<summary / description of video>",
|
||||||
|
"tags": [
|
||||||
|
["d", "<unique-identifier>"],
|
||||||
|
["title", "<title of video>"],
|
||||||
|
["published_at", "<unix timestamp>"],
|
||||||
|
["alt", "<description for accessibility>"],
|
||||||
|
|
||||||
|
// video data
|
||||||
|
["imeta",
|
||||||
|
"url https://example.com/media.mp4",
|
||||||
|
"m video/mp4",
|
||||||
|
"dim 480x480",
|
||||||
|
"blurhash eVF$^OI:${M{%LRjWBoLoLaeR*",
|
||||||
|
"image https://example.com/thumb.jpg",
|
||||||
|
"x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc"
|
||||||
|
],
|
||||||
|
|
||||||
|
["duration", <duration in seconds>],
|
||||||
|
["content-warning", "<reason>"],
|
||||||
|
|
||||||
|
// origin tracking for imported content
|
||||||
|
["origin", "<platform>", "<external-id>", "<original-url>", "<optional-metadata>"],
|
||||||
|
|
||||||
|
// participants
|
||||||
|
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
|
||||||
|
|
||||||
|
// hashtags
|
||||||
|
["t", "<tag>"],
|
||||||
|
["t", "<tag>"],
|
||||||
|
|
||||||
|
// reference links
|
||||||
|
["r", "<url>"]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Referencing Addressable Events
|
||||||
|
|
||||||
|
To reference an addressable video:
|
||||||
|
|
||||||
|
```
|
||||||
|
["a", "34235:<pubkey>:<d-tag-value>", "<relay-url>"] // for normal videos
|
||||||
|
["a", "34236:<pubkey>:<d-tag-value>", "<relay-url>"] // for short videos
|
||||||
|
```
|
||||||
|
|||||||
@@ -263,6 +263,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
|||||||
| `31989` | Handler recommendation | [89](89.md) |
|
| `31989` | Handler recommendation | [89](89.md) |
|
||||||
| `31990` | Handler information | [89](89.md) |
|
| `31990` | Handler information | [89](89.md) |
|
||||||
| `32267` | Software Application | |
|
| `32267` | Software Application | |
|
||||||
|
| `34235` | Addressable Video Event | [71](71.md) |
|
||||||
|
| `34236` | Addressable Short Video Event | [71](71.md) |
|
||||||
| `34550` | Community Definition | [72](72.md) |
|
| `34550` | Community Definition | [72](72.md) |
|
||||||
| `38172` | Cashu Mint Announcement | [87](87.md) |
|
| `38172` | Cashu Mint Announcement | [87](87.md) |
|
||||||
| `38173` | Fedimint Announcement | [87](87.md) |
|
| `38173` | Fedimint Announcement | [87](87.md) |
|
||||||
|
|||||||
Reference in New Issue
Block a user