diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 110 |
1 files changed, 59 insertions, 51 deletions
| @@ -51,6 +51,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 51 | - [NIP-31: Dealing with Unknown Events](31.md) | 51 | - [NIP-31: Dealing with Unknown Events](31.md) |
| 52 | - [NIP-32: Labeling](32.md) | 52 | - [NIP-32: Labeling](32.md) |
| 53 | - [NIP-34: `git` stuff](34.md) | 53 | - [NIP-34: `git` stuff](34.md) |
| 54 | - [NIP-35: Torrents](35.md) | ||
| 54 | - [NIP-36: Sensitive Content](36.md) | 55 | - [NIP-36: Sensitive Content](36.md) |
| 55 | - [NIP-38: User Statuses](38.md) | 56 | - [NIP-38: User Statuses](38.md) |
| 56 | - [NIP-39: External Identities in Profiles](39.md) | 57 | - [NIP-39: External Identities in Profiles](39.md) |
| @@ -67,6 +68,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 67 | - [NIP-52: Calendar Events](52.md) | 68 | - [NIP-52: Calendar Events](52.md) |
| 68 | - [NIP-53: Live Activities](53.md) | 69 | - [NIP-53: Live Activities](53.md) |
| 69 | - [NIP-54: Wiki](54.md) | 70 | - [NIP-54: Wiki](54.md) |
| 71 | - [NIP-55: Android Signer Application](100.md) | ||
| 70 | - [NIP-56: Reporting](56.md) | 72 | - [NIP-56: Reporting](56.md) |
| 71 | - [NIP-57: Lightning Zaps](57.md) | 73 | - [NIP-57: Lightning Zaps](57.md) |
| 72 | - [NIP-58: Badges](58.md) | 74 | - [NIP-58: Badges](58.md) |
| @@ -123,6 +125,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 123 | | `1971` | Problem Tracker | [nostrocket][nostrocket] | | 125 | | `1971` | Problem Tracker | [nostrocket][nostrocket] | |
| 124 | | `1984` | Reporting | [56](56.md) | | 126 | | `1984` | Reporting | [56](56.md) | |
| 125 | | `1985` | Label | [32](32.md) | | 127 | | `1985` | Label | [32](32.md) | |
| 128 | | `2003` | Torrent | [35](35.md) | | ||
| 129 | | `2004` | Torrent Comment | [35](35.md) | | ||
| 130 | | `2022` | Coinjoin Pool | [joinstr][joinstr] | | ||
| 126 | | `4550` | Community Post Approval | [72](72.md) | | 131 | | `4550` | Community Post Approval | [72](72.md) | |
| 127 | | `5000`-`5999` | Job Request | [90](90.md) | | 132 | | `5000`-`5999` | Job Request | [90](90.md) | |
| 128 | | `6000`-`6999` | Job Result | [90](90.md) | | 133 | | `6000`-`6999` | Job Result | [90](90.md) | |
| @@ -177,6 +182,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 177 | | `30617` | Repository announcements | [34](34.md) | | 182 | | `30617` | Repository announcements | [34](34.md) | |
| 178 | | `30818` | Wiki article | [54](54.md) | | 183 | | `30818` | Wiki article | [54](54.md) | |
| 179 | | `30819` | Redirects | [54](54.md) | | 184 | | `30819` | Redirects | [54](54.md) | |
| 185 | | `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) | | ||
| 180 | | `31922` | Date-Based Calendar Event | [52](52.md) | | 186 | | `31922` | Date-Based Calendar Event | [52](52.md) | |
| 181 | | `31923` | Time-Based Calendar Event | [52](52.md) | | 187 | | `31923` | Time-Based Calendar Event | [52](52.md) | |
| 182 | | `31924` | Calendar | [52](52.md) | | 188 | | `31924` | Calendar | [52](52.md) | |
| @@ -189,8 +195,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 189 | | `34550` | Community Definition | [72](72.md) | | 195 | | `34550` | Community Definition | [72](72.md) | |
| 190 | | `39000-9` | Group metadata events | [29](29.md) | | 196 | | `39000-9` | Group metadata events | [29](29.md) | |
| 191 | 197 | ||
| 198 | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 | ||
| 192 | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md | 199 | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md |
| 193 | [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md | 200 | [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md |
| 201 | [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md | ||
| 194 | 202 | ||
| 195 | ## Message types | 203 | ## Message types |
| 196 | 204 | ||
| @@ -216,62 +224,62 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 216 | | `AUTH` | used to send authentication challenges | [42](42.md) | | 224 | | `AUTH` | used to send authentication challenges | [42](42.md) | |
| 217 | | `COUNT` | used to send requested event counts to clients | [45](45.md) | | 225 | | `COUNT` | used to send requested event counts to clients | [45](45.md) | |
| 218 | 226 | ||
| 219 | Please update these lists when proposing NIPs introducing new event kinds. | ||
| 220 | |||
| 221 | ## Standardized Tags | 227 | ## Standardized Tags |
| 222 | 228 | ||
| 223 | | name | value | other parameters | NIP | | 229 | | name | value | other parameters | NIP | |
| 224 | | ----------------- | ------------------------------------ | -------------------- | ------------------------------------- | | 230 | | ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | |
| 225 | | `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | | 231 | | `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | |
| 226 | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | 232 | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | |
| 227 | | `a` | coordinates to an event | relay URL | [01](01.md) | | 233 | | `a` | coordinates to an event | relay URL | [01](01.md) | |
| 228 | | `d` | identifier | -- | [01](01.md) | | 234 | | `d` | identifier | -- | [01](01.md) | |
| 229 | | `g` | geohash | -- | [52](52.md) | | 235 | | `g` | geohash | -- | [52](52.md) | |
| 230 | | `i` | identity | proof | [39](39.md) | | 236 | | `i` | identity | proof | [39](39.md) | |
| 231 | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | | 237 | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | |
| 232 | | `l` | label, label namespace | annotations | [32](32.md) | | 238 | | `l` | label, label namespace | annotations | [32](32.md) | |
| 233 | | `L` | label namespace | -- | [32](32.md) | | 239 | | `L` | label namespace | -- | [32](32.md) | |
| 234 | | `m` | MIME type | -- | [94](94.md) | | 240 | | `m` | MIME type | -- | [94](94.md) | |
| 235 | | `q` | event id (hex) | relay URL | [18](18.md) | | 241 | | `q` | event id (hex) | relay URL | [18](18.md) | |
| 236 | | `r` | a reference (URL, etc) | petname | | | 242 | | `r` | a reference (URL, etc) | petname | [24](24.md) | |
| 237 | | `r` | relay url | marker | [65](65.md) | | 243 | | `r` | relay url | marker | [65](65.md) | |
| 238 | | `t` | hashtag | -- | | | 244 | | `t` | hashtag | -- | | |
| 239 | | `alt` | summary | -- | [31](31.md) | | 245 | | `alt` | summary | -- | [31](31.md) | |
| 240 | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | 246 | | `amount` | millisatoshis, stringified | -- | [57](57.md) | |
| 241 | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | | 247 | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | |
| 242 | | `challenge` | challenge string | -- | [42](42.md) | | 248 | | `challenge` | challenge string | -- | [42](42.md) | |
| 243 | | `client` | name, address | relay URL | [89](89.md) | | 249 | | `client` | name, address | relay URL | [89](89.md) | |
| 244 | | `clone` | git clone URL | -- | [34](34.md) | | 250 | | `clone` | git clone URL | -- | [34](34.md) | |
| 245 | | `content-warning` | reason | -- | [36](36.md) | | 251 | | `content-warning` | reason | -- | [36](36.md) | |
| 246 | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | 252 | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | |
| 247 | | `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | | 253 | | `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | |
| 248 | | `emoji` | shortcode, image URL | -- | [30](30.md) | | 254 | | `emoji` | shortcode, image URL | -- | [30](30.md) | |
| 249 | | `encrypted` | -- | -- | [90](90.md) | | 255 | | `encrypted` | -- | -- | [90](90.md) | |
| 250 | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | 256 | | `expiration` | unix timestamp (string) | -- | [40](40.md) | |
| 251 | | `goal` | event id (hex) | relay URL | [75](75.md) | | 257 | | `goal` | event id (hex) | relay URL | [75](75.md) | |
| 252 | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | 258 | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | |
| 253 | | `imeta` | inline metadata | -- | [92](92.md) | | 259 | | `imeta` | inline metadata | -- | [92](92.md) | |
| 254 | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | 260 | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | |
| 255 | | `location` | location string | -- | [52](52.md), [99](99.md) | | 261 | | `location` | location string | -- | [52](52.md), [99](99.md) | |
| 256 | | `name` | name | -- | [34](34.md), [58](58.md) | | 262 | | `name` | name | -- | [34](34.md), [58](58.md) | |
| 257 | | `nonce` | random | -- | [13](13.md) | | 263 | | `nonce` | random | difficulty | [13](13.md) | |
| 258 | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | 264 | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | |
| 259 | | `price` | price | currency, frequency | [99](99.md) | | 265 | | `price` | price | currency, frequency | [99](99.md) | |
| 260 | | `proxy` | external ID | protocol | [48](48.md) | | 266 | | `proxy` | external ID | protocol | [48](48.md) | |
| 261 | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | 267 | | `published_at` | unix timestamp (string) | -- | [23](23.md) | |
| 262 | | `relay` | relay url | -- | [42](42.md), [17](17.md) | | 268 | | `relay` | relay url | -- | [42](42.md), [17](17.md) | |
| 263 | | `relays` | relay list | -- | [57](57.md) | | 269 | | `relays` | relay list | -- | [57](57.md) | |
| 264 | | `server` | file storage server url | -- | [96](96.md) | | 270 | | `server` | file storage server url | -- | [96](96.md) | |
| 265 | | `subject` | subject | -- | [14](14.md), [17](17.md) | | 271 | | `subject` | subject | -- | [14](14.md), [17](17.md) | |
| 266 | | `summary` | article summary | -- | [23](23.md) | | 272 | | `summary` | article summary | -- | [23](23.md) | |
| 267 | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | 273 | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | |
| 268 | | `title` | article title | -- | [23](23.md) | | 274 | | `title` | article title | -- | [23](23.md) | |
| 269 | | `web` | webpage URL | -- | [34](34.md) | | 275 | | `web` | webpage URL | -- | [34](34.md) | |
| 270 | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | | 276 | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | |
| 277 | |||
| 278 | Please update these lists when proposing new NIPs. | ||
| 271 | 279 | ||
| 272 | ## Criteria for acceptance of NIPs | 280 | ## Criteria for acceptance of NIPs |
| 273 | 281 | ||
| 274 | 1. They should be implemented in at least two clients and one relay -- when applicable. | 282 | 1. They should be fully implemented in at least two clients and one relay -- when applicable. |
| 275 | 2. They should make sense. | 283 | 2. They should make sense. |
| 276 | 3. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to. | 284 | 3. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to. |
| 277 | 4. There should be no more than one way of doing the same thing. | 285 | 4. There should be no more than one way of doing the same thing. |