nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-11-09 22:09:06 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update readme (#1408)

Browse Source 
* README: add kind 30618 repository state announcements

* README: add NIP-72 link to `name` tag

* README: use reference link for NUD: Custom Feeds

* Format kinds table
This commit is contained in:
Asai Toshiya 2024-08-03 08:47:59 +09:00 committed by GitHub
parent 788ffb03a0
commit 8e5083b28f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 109 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

216
README.md
View File

@ -89,112 +89,114 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
- [NIP-99: Classified Listings](99.md) - [NIP-99: Classified Listings](99.md)
## Event Kinds ## Event Kinds
| kind | description | NIP |
| ------------- | -------------------------- | ------------------------ | | kind | description | NIP |
| `0` | User Metadata | [01](01.md) | | ------------- | ------------------------------- | -------------------------------------- |
| `1` | Short Text Note | [01](01.md) | | `0` | User Metadata | [01](01.md) |
| `2` | Recommend Relay | 01 (deprecated) | | `1` | Short Text Note | [01](01.md) |
| `3` | Follows | [02](02.md) | | `2` | Recommend Relay | 01 (deprecated) |
| `4` | Encrypted Direct Messages | [04](04.md) | | `3` | Follows | [02](02.md) |
| `5` | Event Deletion | [09](09.md) | | `4` | Encrypted Direct Messages | [04](04.md) |
| `6` | Repost | [18](18.md) | | `5` | Event Deletion | [09](09.md) |
| `7` | Reaction | [25](25.md) | | `6` | Repost | [18](18.md) |
| `8` | Badge Award | [58](58.md) | | `7` | Reaction | [25](25.md) |
| `9` | Group Chat Message | [29](29.md) | | `8` | Badge Award | [58](58.md) |
| `10` | Group Chat Threaded Reply | [29](29.md) | | `9` | Group Chat Message | [29](29.md) |
| `11` | Group Thread | [29](29.md) | | `10` | Group Chat Threaded Reply | [29](29.md) |
| `12` | Group Thread Reply | [29](29.md) | | `11` | Group Thread | [29](29.md) |
| `13` | Seal | [59](59.md) | | `12` | Group Thread Reply | [29](29.md) |
| `14` | Direct Message | [17](17.md) | | `13` | Seal | [59](59.md) |
| `16` | Generic Repost | [18](18.md) | | `14` | Direct Message | [17](17.md) |
| `40` | Channel Creation | [28](28.md) | | `16` | Generic Repost | [18](18.md) |
| `41` | Channel Metadata | [28](28.md) | | `40` | Channel Creation | [28](28.md) |
| `42` | Channel Message | [28](28.md) | | `41` | Channel Metadata | [28](28.md) |
| `43` | Channel Hide Message | [28](28.md) | | `42` | Channel Message | [28](28.md) |
| `44` | Channel Mute User | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) |
| `818` | Merge Requests | [54](54.md) | | `44` | Channel Mute User | [28](28.md) |
| `1021` | Bid | [15](15.md) | | `818` | Merge Requests | [54](54.md) |
| `1022` | Bid confirmation | [15](15.md) | | `1021` | Bid | [15](15.md) |
| `1040` | OpenTimestamps | [03](03.md) | | `1022` | Bid confirmation | [15](15.md) |
| `1059` | Gift Wrap | [59](59.md) | | `1040` | OpenTimestamps | [03](03.md) |
| `1063` | File Metadata | [94](94.md) | | `1059` | Gift Wrap | [59](59.md) |
| `1311` | Live Chat Message | [53](53.md) | | `1063` | File Metadata | [94](94.md) |
| `1617` | Patches | [34](34.md) | | `1311` | Live Chat Message | [53](53.md) |
| `1621` | Issues | [34](34.md) | | `1617` | Patches | [34](34.md) |
| `1622` | Replies | [34](34.md) | | `1621` | Issues | [34](34.md) |
| `1630`-`1633` | Status | [34](34.md) | | `1622` | Replies | [34](34.md) |
| `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1630`-`1633` | Status | [34](34.md) |
| `1984` | Reporting | [56](56.md) | | `1971` | Problem Tracker | [nostrocket][nostrocket] |
| `1985` | Label | [32](32.md) | | `1984` | Reporting | [56](56.md) |
| `2003` | Torrent | [35](35.md) | | `1985` | Label | [32](32.md) |
| `2004` | Torrent Comment | [35](35.md) | | `2003` | Torrent | [35](35.md) |
| `2022` | Coinjoin Pool | [joinstr][joinstr] | | `2004` | Torrent Comment | [35](35.md) |
| `4550` | Community Post Approval | [72](72.md) | | `2022` | Coinjoin Pool | [joinstr][joinstr] |
| `5000`-`5999` | Job Request | [90](90.md) | | `4550` | Community Post Approval | [72](72.md) |
| `6000`-`6999` | Job Result | [90](90.md) | | `5000`-`5999` | Job Request | [90](90.md) |
| `7000` | Job Feedback | [90](90.md) | | `6000`-`6999` | Job Result | [90](90.md) |
| `9000`-`9030` | Group Control Events | [29](29.md) | | `7000` | Job Feedback | [90](90.md) |
| `9041` | Zap Goal | [75](75.md) | | `9000`-`9030` | Group Control Events | [29](29.md) |
| `9734` | Zap Request | [57](57.md) | | `9041` | Zap Goal | [75](75.md) |
| `9735` | Zap | [57](57.md) | | `9734` | Zap Request | [57](57.md) |
| `9802` | Highlights | [84](84.md) | | `9735` | Zap | [57](57.md) |
| `10000` | Mute list | [51](51.md) | | `9802` | Highlights | [84](84.md) |
| `10001` | Pin list | [51](51.md) | | `10000` | Mute list | [51](51.md) |
| `10002` | Relay List Metadata | [65](65.md) | | `10001` | Pin list | [51](51.md) |
| `10003` | Bookmark list | [51](51.md) | | `10002` | Relay List Metadata | [65](65.md) |
| `10004` | Communities list | [51](51.md) | | `10003` | Bookmark list | [51](51.md) |
| `10005` | Public chats list | [51](51.md) | | `10004` | Communities list | [51](51.md) |
| `10006` | Blocked relays list | [51](51.md) | | `10005` | Public chats list | [51](51.md) |
| `10007` | Search relays list | [51](51.md) | | `10006` | Blocked relays list | [51](51.md) |
| `10009` | User groups | [51](51.md), [29](29.md) | | `10007` | Search relays list | [51](51.md) |
| `10015` | Interests list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) |
| `10030` | User emoji list | [51](51.md) | | `10015` | Interests list | [51](51.md) |
| `10050` | Relay list to receive DMs | [17](17.md) | | `10030` | User emoji list | [51](51.md) |
| `10096` | File storage server list | [96](96.md) | | `10050` | Relay list to receive DMs | [17](17.md) |
| `13194` | Wallet Info | [47](47.md) | | `10096` | File storage server list | [96](96.md) |
| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `13194` | Wallet Info | [47](47.md) |
| `22242` | Client Authentication | [42](42.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
| `23194` | Wallet Request | [47](47.md) | | `22242` | Client Authentication | [42](42.md) |
| `23195` | Wallet Response | [47](47.md) | | `23194` | Wallet Request | [47](47.md) |
| `24133` | Nostr Connect | [46](46.md) | | `23195` | Wallet Response | [47](47.md) |
| `27235` | HTTP Auth | [98](98.md) | | `24133` | Nostr Connect | [46](46.md) |
| `30000` | Follow sets | [51](51.md) | | `27235` | HTTP Auth | [98](98.md) |
| `30001` | Generic lists | [51](51.md) | | `30000` | Follow sets | [51](51.md) |
| `30002` | Relay sets | [51](51.md) | | `30001` | Generic lists | [51](51.md) |
| `30003` | Bookmark sets | [51](51.md) | | `30002` | Relay sets | [51](51.md) |
| `30004` | Curation sets | [51](51.md) | | `30003` | Bookmark sets | [51](51.md) |
| `30005` | Video sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) |
| `30008` | Profile Badges | [58](58.md) | | `30005` | Video sets | [51](51.md) |
| `30009` | Badge Definition | [58](58.md) | | `30008` | Profile Badges | [58](58.md) |
| `30015` | Interest sets | [51](51.md) | | `30009` | Badge Definition | [58](58.md) |
| `30017` | Create or update a stall | [15](15.md) | | `30015` | Interest sets | [51](51.md) |
| `30018` | Create or update a product | [15](15.md) | | `30017` | Create or update a stall | [15](15.md) |
| `30019` | Marketplace UI/UX | [15](15.md) | | `30018` | Create or update a product | [15](15.md) |
| `30020` | Product sold as an auction | [15](15.md) | | `30019` | Marketplace UI/UX | [15](15.md) |
| `30023` | Long-form Content | [23](23.md) | | `30020` | Product sold as an auction | [15](15.md) |
| `30024` | Draft Long-form Content | [23](23.md) | | `30023` | Long-form Content | [23](23.md) |
| `30030` | Emoji sets | [51](51.md) | | `30024` | Draft Long-form Content | [23](23.md) |
| `30063` | Release artifact sets | [51](51.md) | | `30030` | Emoji sets | [51](51.md) |
| `30078` | Application-specific Data | [78](78.md) | | `30063` | Release artifact sets | [51](51.md) |
| `30311` | Live Event | [53](53.md) | | `30078` | Application-specific Data | [78](78.md) |
| `30315` | User Statuses | [38](38.md) | | `30311` | Live Event | [53](53.md) |
| `30402` | Classified Listing | [99](99.md) | | `30315` | User Statuses | [38](38.md) |
| `30403` | Draft Classified Listing | [99](99.md) | | `30402` | Classified Listing | [99](99.md) |
| `30617` | Repository announcements | [34](34.md) | | `30403` | Draft Classified Listing | [99](99.md) |
| `30818` | Wiki article | [54](54.md) | | `30617` | Repository announcements | [34](34.md) |
| `30819` | Redirects | [54](54.md) | | `30618` | Repository state announcements | [34](34.md) |
| `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) | | `30818` | Wiki article | [54](54.md) |
| `31922` | Date-Based Calendar Event | [52](52.md) | | `30819` | Redirects | [54](54.md) |
| `31923` | Time-Based Calendar Event | [52](52.md) | | `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] |
| `31924` | Calendar | [52](52.md) | | `31922` | Date-Based Calendar Event | [52](52.md) |
| `31925` | Calendar Event RSVP | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) |
| `31989` | Handler recommendation | [89](89.md) | | `31924` | Calendar | [52](52.md) |
| `31990` | Handler information | [89](89.md) | | `31925` | Calendar Event RSVP | [52](52.md) |
| `34235` | Video Event | [71](71.md) | | `31989` | Handler recommendation | [89](89.md) |
| `34236` | Short-form Portrait Video Event | [71](71.md) | | `31990` | Handler information | [89](89.md) |
| `34237` | Video View Event | [71](71.md) | | `34235` | Video Event | [71](71.md) |
| `34550` | Community Definition | [72](72.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) |
| `39000-9` | Group metadata events | [29](29.md) | | `34237` | Video View Event | [71](71.md) |
| `34550` | Community Definition | [72](72.md) |
| `39000-9` | Group metadata events | [29](29.md) |
[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1
[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
@ -262,7 +264,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
| `imeta` | inline metadata | -- | [92](92.md) | | `imeta` | inline metadata | -- | [92](92.md) |
| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
| `location` | location string | -- | [52](52.md), [99](99.md) | | `location` | location string | -- | [52](52.md), [99](99.md) |
| `name` | name | -- | [34](34.md), [58](58.md) | | `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) |
| `nonce` | random | difficulty | [13](13.md) | | `nonce` | random | difficulty | [13](13.md) |
| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
| `price` | price | currency, frequency | [99](99.md) | | `price` | price | currency, frequency | [99](99.md) |