diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 311 |
1 files changed, 197 insertions, 114 deletions
| @@ -1,18 +1,21 @@ | |||
| 1 | # NIPs | 1 | # NIPs |
| 2 | 2 | ||
| 3 | NIPs stand for **Nostr Implementation Possibilities**. | 3 | NIPs stand for **Nostr Implementation Possibilities**. |
| 4 | |||
| 4 | They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software. | 5 | They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software. |
| 5 | 6 | ||
| 6 | --- | 7 | --- |
| 7 | 8 | ||
| 8 | - [List](#list) | 9 | - [List](#list) |
| 9 | - [Event Kinds](#event-kinds) | 10 | - [Event Kinds](#event-kinds) |
| 10 | - [Event Kind Ranges](#event-kind-ranges) | ||
| 11 | - [Message Types](#message-types) | 11 | - [Message Types](#message-types) |
| 12 | - [Client to Relay](#client-to-relay) | 12 | - [Client to Relay](#client-to-relay) |
| 13 | - [Relay to Client](#relay-to-client) | 13 | - [Relay to Client](#relay-to-client) |
| 14 | - [Standardized Tags](#standardized-tags) | 14 | - [Standardized Tags](#standardized-tags) |
| 15 | - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) | 15 | - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) |
| 16 | - [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) | ||
| 17 | - [How this repository works](#how-this-repository-works) | ||
| 18 | - [Breaking Changes](#breaking-changes) | ||
| 16 | - [License](#license) | 19 | - [License](#license) |
| 17 | 20 | ||
| 18 | --- | 21 | --- |
| @@ -20,9 +23,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 20 | ## List | 23 | ## List |
| 21 | 24 | ||
| 22 | - [NIP-01: Basic protocol flow description](01.md) | 25 | - [NIP-01: Basic protocol flow description](01.md) |
| 23 | - [NIP-02: Contact List and Petnames](02.md) | 26 | - [NIP-02: Follow List](02.md) |
| 24 | - [NIP-03: OpenTimestamps Attestations for Events](03.md) | 27 | - [NIP-03: OpenTimestamps Attestations for Events](03.md) |
| 25 | - [NIP-04: Encrypted Direct Message](04.md) | 28 | - [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md) |
| 26 | - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) | 29 | - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) |
| 27 | - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) | 30 | - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) |
| 28 | - [NIP-07: `window.nostr` capability for web browsers](07.md) | 31 | - [NIP-07: `window.nostr` capability for web browsers](07.md) |
| @@ -33,105 +36,168 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 33 | - [NIP-13: Proof of Work](13.md) | 36 | - [NIP-13: Proof of Work](13.md) |
| 34 | - [NIP-14: Subject tag in text events](14.md) | 37 | - [NIP-14: Subject tag in text events](14.md) |
| 35 | - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) | 38 | - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) |
| 39 | - [NIP-17: Private Direct Messages](17.md) | ||
| 36 | - [NIP-18: Reposts](18.md) | 40 | - [NIP-18: Reposts](18.md) |
| 37 | - [NIP-19: bech32-encoded entities](19.md) | 41 | - [NIP-19: bech32-encoded entities](19.md) |
| 38 | - [NIP-21: `nostr:` URI scheme](21.md) | 42 | - [NIP-21: `nostr:` URI scheme](21.md) |
| 39 | - [NIP-22: Event `created_at` Limits](22.md) | ||
| 40 | - [NIP-23: Long-form Content](23.md) | 43 | - [NIP-23: Long-form Content](23.md) |
| 41 | - [NIP-24: Extra metadata fields and tags](24.md) | 44 | - [NIP-24: Extra metadata fields and tags](24.md) |
| 42 | - [NIP-25: Reactions](25.md) | 45 | - [NIP-25: Reactions](25.md) |
| 43 | - [NIP-26: Delegated Event Signing](26.md) | 46 | - [NIP-26: Delegated Event Signing](26.md) |
| 44 | - [NIP-27: Text Note References](27.md) | 47 | - [NIP-27: Text Note References](27.md) |
| 45 | - [NIP-28: Public Chat](28.md) | 48 | - [NIP-28: Public Chat](28.md) |
| 49 | - [NIP-29: Relay-based Groups](29.md) | ||
| 46 | - [NIP-30: Custom Emoji](30.md) | 50 | - [NIP-30: Custom Emoji](30.md) |
| 47 | - [NIP-31: Dealing with Unknown Events](31.md) | 51 | - [NIP-31: Dealing with Unknown Events](31.md) |
| 48 | - [NIP-32: Labeling](32.md) | 52 | - [NIP-32: Labeling](32.md) |
| 53 | - [NIP-34: `git` stuff](34.md) | ||
| 54 | - [NIP-35: Torrents](35.md) | ||
| 49 | - [NIP-36: Sensitive Content](36.md) | 55 | - [NIP-36: Sensitive Content](36.md) |
| 50 | - [NIP-38: User Statuses](38.md) | 56 | - [NIP-38: User Statuses](38.md) |
| 51 | - [NIP-39: External Identities in Profiles](39.md) | 57 | - [NIP-39: External Identities in Profiles](39.md) |
| 52 | - [NIP-40: Expiration Timestamp](40.md) | 58 | - [NIP-40: Expiration Timestamp](40.md) |
| 53 | - [NIP-42: Authentication of clients to relays](42.md) | 59 | - [NIP-42: Authentication of clients to relays](42.md) |
| 60 | - [NIP-44: Versioned Encryption](44.md) | ||
| 54 | - [NIP-45: Counting results](45.md) | 61 | - [NIP-45: Counting results](45.md) |
| 55 | - [NIP-46: Nostr Connect](46.md) | 62 | - [NIP-46: Nostr Connect](46.md) |
| 56 | - [NIP-47: Wallet Connect](47.md) | 63 | - [NIP-47: Wallet Connect](47.md) |
| 57 | - [NIP-48: Proxy Tags](48.md) | 64 | - [NIP-48: Proxy Tags](48.md) |
| 65 | - [NIP-49: Private Key Encryption](49.md) | ||
| 58 | - [NIP-50: Search Capability](50.md) | 66 | - [NIP-50: Search Capability](50.md) |
| 59 | - [NIP-51: Lists](51.md) | 67 | - [NIP-51: Lists](51.md) |
| 60 | - [NIP-52: Calendar Events](52.md) | 68 | - [NIP-52: Calendar Events](52.md) |
| 61 | - [NIP-53: Live Activities](53.md) | 69 | - [NIP-53: Live Activities](53.md) |
| 70 | - [NIP-54: Wiki](54.md) | ||
| 62 | - [NIP-56: Reporting](56.md) | 71 | - [NIP-56: Reporting](56.md) |
| 63 | - [NIP-57: Lightning Zaps](57.md) | 72 | - [NIP-57: Lightning Zaps](57.md) |
| 64 | - [NIP-58: Badges](58.md) | 73 | - [NIP-58: Badges](58.md) |
| 74 | - [NIP-59: Gift Wrap](59.md) | ||
| 65 | - [NIP-65: Relay List Metadata](65.md) | 75 | - [NIP-65: Relay List Metadata](65.md) |
| 76 | - [NIP-71: Video Events](71.md) | ||
| 66 | - [NIP-72: Moderated Communities](72.md) | 77 | - [NIP-72: Moderated Communities](72.md) |
| 67 | - [NIP-75: Zap Goals](75.md) | 78 | - [NIP-75: Zap Goals](75.md) |
| 68 | - [NIP-78: Application-specific data](78.md) | 79 | - [NIP-78: Application-specific data](78.md) |
| 69 | - [NIP-84: Highlights](84.md) | 80 | - [NIP-84: Highlights](84.md) |
| 70 | - [NIP-89: Recommended Application Handlers](89.md) | 81 | - [NIP-89: Recommended Application Handlers](89.md) |
| 71 | - [NIP-90: Data Vending Machines](90.md) | 82 | - [NIP-90: Data Vending Machines](90.md) |
| 83 | - [NIP-92: Media Attachments](92.md) | ||
| 72 | - [NIP-94: File Metadata](94.md) | 84 | - [NIP-94: File Metadata](94.md) |
| 85 | - [NIP-96: HTTP File Storage Integration](96.md) | ||
| 73 | - [NIP-98: HTTP Auth](98.md) | 86 | - [NIP-98: HTTP Auth](98.md) |
| 74 | - [NIP-99: Classified Listings](99.md) | 87 | - [NIP-99: Classified Listings](99.md) |
| 75 | 88 | ||
| 76 | ## Event Kinds | 89 | ## Event Kinds |
| 90 | | kind | description | NIP | | ||
| 91 | | ------------- | -------------------------- | ------------------------ | | ||
| 92 | | `0` | Metadata | [01](01.md) | | ||
| 93 | | `1` | Short Text Note | [01](01.md) | | ||
| 94 | | `2` | Recommend Relay | 01 (deprecated) | | ||
| 95 | | `3` | Follows | [02](02.md) | | ||
| 96 | | `4` | Encrypted Direct Messages | [04](04.md) | | ||
| 97 | | `5` | Event Deletion | [09](09.md) | | ||
| 98 | | `6` | Repost | [18](18.md) | | ||
| 99 | | `7` | Reaction | [25](25.md) | | ||
| 100 | | `8` | Badge Award | [58](58.md) | | ||
| 101 | | `9` | Group Chat Message | [29](29.md) | | ||
| 102 | | `10` | Group Chat Threaded Reply | [29](29.md) | | ||
| 103 | | `11` | Group Thread | [29](29.md) | | ||
| 104 | | `12` | Group Thread Reply | [29](29.md) | | ||
| 105 | | `13` | Seal | [59](59.md) | | ||
| 106 | | `14` | Direct Message | [17](17.md) | | ||
| 107 | | `16` | Generic Repost | [18](18.md) | | ||
| 108 | | `40` | Channel Creation | [28](28.md) | | ||
| 109 | | `41` | Channel Metadata | [28](28.md) | | ||
| 110 | | `42` | Channel Message | [28](28.md) | | ||
| 111 | | `43` | Channel Hide Message | [28](28.md) | | ||
| 112 | | `44` | Channel Mute User | [28](28.md) | | ||
| 113 | | `818` | Merge Requests | [54](54.md) | | ||
| 114 | | `1021` | Bid | [15](15.md) | | ||
| 115 | | `1022` | Bid confirmation | [15](15.md) | | ||
| 116 | | `1040` | OpenTimestamps | [03](03.md) | | ||
| 117 | | `1059` | Gift Wrap | [59](59.md) | | ||
| 118 | | `1063` | File Metadata | [94](94.md) | | ||
| 119 | | `1311` | Live Chat Message | [53](53.md) | | ||
| 120 | | `1617` | Patches | [34](34.md) | | ||
| 121 | | `1621` | Issues | [34](34.md) | | ||
| 122 | | `1622` | Replies | [34](34.md) | | ||
| 123 | | `1630`-`1633` | Status | [34](34.md) | | ||
| 124 | | `1971` | Problem Tracker | [nostrocket][nostrocket] | | ||
| 125 | | `1984` | Reporting | [56](56.md) | | ||
| 126 | | `1985` | Label | [32](32.md) | | ||
| 127 | | `2003` | Torrent | [35](35.md) | | ||
| 128 | | `2004` | Torrent Comment | [35](35.md) | | ||
| 129 | | `2022` | Coinjoin Pool | [joinstr][joinstr] | | ||
| 130 | | `4550` | Community Post Approval | [72](72.md) | | ||
| 131 | | `5000`-`5999` | Job Request | [90](90.md) | | ||
| 132 | | `6000`-`6999` | Job Result | [90](90.md) | | ||
| 133 | | `7000` | Job Feedback | [90](90.md) | | ||
| 134 | | `9000`-`9030` | Group Control Events | [29](29.md) | | ||
| 135 | | `9041` | Zap Goal | [75](75.md) | | ||
| 136 | | `9734` | Zap Request | [57](57.md) | | ||
| 137 | | `9735` | Zap | [57](57.md) | | ||
| 138 | | `9802` | Highlights | [84](84.md) | | ||
| 139 | | `10000` | Mute list | [51](51.md) | | ||
| 140 | | `10001` | Pin list | [51](51.md) | | ||
| 141 | | `10002` | Relay List Metadata | [65](65.md) | | ||
| 142 | | `10003` | Bookmark list | [51](51.md) | | ||
| 143 | | `10004` | Communities list | [51](51.md) | | ||
| 144 | | `10005` | Public chats list | [51](51.md) | | ||
| 145 | | `10006` | Blocked relays list | [51](51.md) | | ||
| 146 | | `10007` | Search relays list | [51](51.md) | | ||
| 147 | | `10009` | User groups | [51](51.md), [29](29.md) | | ||
| 148 | | `10015` | Interests list | [51](51.md) | | ||
| 149 | | `10030` | User emoji list | [51](51.md) | | ||
| 150 | | `10050` | Relay list to receive DMs | [17](17.md) | | ||
| 151 | | `10096` | File storage server list | [96](96.md) | | ||
| 152 | | `13194` | Wallet Info | [47](47.md) | | ||
| 153 | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | ||
| 154 | | `22242` | Client Authentication | [42](42.md) | | ||
| 155 | | `23194` | Wallet Request | [47](47.md) | | ||
| 156 | | `23195` | Wallet Response | [47](47.md) | | ||
| 157 | | `24133` | Nostr Connect | [46](46.md) | | ||
| 158 | | `27235` | HTTP Auth | [98](98.md) | | ||
| 159 | | `30000` | Follow sets | [51](51.md) | | ||
| 160 | | `30001` | Generic lists | [51](51.md) | | ||
| 161 | | `30002` | Relay sets | [51](51.md) | | ||
| 162 | | `30003` | Bookmark sets | [51](51.md) | | ||
| 163 | | `30004` | Curation sets | [51](51.md) | | ||
| 164 | | `30005` | Video sets | [51](51.md) | | ||
| 165 | | `30008` | Profile Badges | [58](58.md) | | ||
| 166 | | `30009` | Badge Definition | [58](58.md) | | ||
| 167 | | `30015` | Interest sets | [51](51.md) | | ||
| 168 | | `30017` | Create or update a stall | [15](15.md) | | ||
| 169 | | `30018` | Create or update a product | [15](15.md) | | ||
| 170 | | `30019` | Marketplace UI/UX | [15](15.md) | | ||
| 171 | | `30020` | Product sold as an auction | [15](15.md) | | ||
| 172 | | `30023` | Long-form Content | [23](23.md) | | ||
| 173 | | `30024` | Draft Long-form Content | [23](23.md) | | ||
| 174 | | `30030` | Emoji sets | [51](51.md) | | ||
| 175 | | `30063` | Release artifact sets | [51](51.md) | | ||
| 176 | | `30078` | Application-specific Data | [78](78.md) | | ||
| 177 | | `30311` | Live Event | [53](53.md) | | ||
| 178 | | `30315` | User Statuses | [38](38.md) | | ||
| 179 | | `30402` | Classified Listing | [99](99.md) | | ||
| 180 | | `30403` | Draft Classified Listing | [99](99.md) | | ||
| 181 | | `30617` | Repository announcements | [34](34.md) | | ||
| 182 | | `30818` | Wiki article | [54](54.md) | | ||
| 183 | | `30819` | Redirects | [54](54.md) | | ||
| 184 | | `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) | | ||
| 185 | | `31922` | Date-Based Calendar Event | [52](52.md) | | ||
| 186 | | `31923` | Time-Based Calendar Event | [52](52.md) | | ||
| 187 | | `31924` | Calendar | [52](52.md) | | ||
| 188 | | `31925` | Calendar Event RSVP | [52](52.md) | | ||
| 189 | | `31989` | Handler recommendation | [89](89.md) | | ||
| 190 | | `31990` | Handler information | [89](89.md) | | ||
| 191 | | `34235` | Video Event | [71](71.md) | | ||
| 192 | | `34236` | Short-form Portrait Video Event | [71](71.md) | | ||
| 193 | | `34237` | Video View Event | [71](71.md) | | ||
| 194 | | `34550` | Community Definition | [72](72.md) | | ||
| 195 | | `39000-9` | Group metadata events | [29](29.md) | | ||
| 77 | 196 | ||
| 78 | | kind | description | NIP | | 197 | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 |
| 79 | | ------- | -------------------------- | ----------- | | 198 | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md |
| 80 | | `0` | Metadata | [1](01.md) | | 199 | [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md |
| 81 | | `1` | Short Text Note | [1](01.md) | | 200 | [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md |
| 82 | | `2` | Recommend Relay | | | ||
| 83 | | `3` | Contacts | [2](02.md) | | ||
| 84 | | `4` | Encrypted Direct Messages | [4](04.md) | | ||
| 85 | | `5` | Event Deletion | [9](09.md) | | ||
| 86 | | `6` | Repost | [18](18.md) | | ||
| 87 | | `7` | Reaction | [25](25.md) | | ||
| 88 | | `8` | Badge Award | [58](58.md) | | ||
| 89 | | `16` | Generic Repost | [18](18.md) | | ||
| 90 | | `40` | Channel Creation | [28](28.md) | | ||
| 91 | | `41` | Channel Metadata | [28](28.md) | | ||
| 92 | | `42` | Channel Message | [28](28.md) | | ||
| 93 | | `43` | Channel Hide Message | [28](28.md) | | ||
| 94 | | `44` | Channel Mute User | [28](28.md) | | ||
| 95 | | `1063` | File Metadata | [94](94.md) | | ||
| 96 | | `1311` | Live Chat Message | [53](53.md) | | ||
| 97 | | `1040` | OpenTimestamps | [03](03.md) | | ||
| 98 | | `1984` | Reporting | [56](56.md) | | ||
| 99 | | `1985` | Label | [32](32.md) | | ||
| 100 | | `4550` | Community Post Approval | [72](72.md) | | ||
| 101 | | `7000` | Job Feedback | [90](90.md) | | ||
| 102 | | `9041` | Zap Goal | [75](75.md) | | ||
| 103 | | `9734` | Zap Request | [57](57.md) | | ||
| 104 | | `9735` | Zap | [57](57.md) | | ||
| 105 | | `9802` | Highlights | [84](84.md) | | ||
| 106 | | `10000` | Mute List | [51](51.md) | | ||
| 107 | | `10001` | Pin List | [51](51.md) | | ||
| 108 | | `10002` | Relay List Metadata | [65](65.md) | | ||
| 109 | | `13194` | Wallet Info | [47](47.md) | | ||
| 110 | | `22242` | Client Authentication | [42](42.md) | | ||
| 111 | | `23194` | Wallet Request | [47](47.md) | | ||
| 112 | | `23195` | Wallet Response | [47](47.md) | | ||
| 113 | | `24133` | Nostr Connect | [46](46.md) | | ||
| 114 | | `27235` | HTTP Auth | [98](98.md) | | ||
| 115 | | `30000` | Categorized People List | [51](51.md) | | ||
| 116 | | `30001` | Categorized Bookmark List | [51](51.md) | | ||
| 117 | | `30008` | Profile Badges | [58](58.md) | | ||
| 118 | | `30009` | Badge Definition | [58](58.md) | | ||
| 119 | | `30017` | Create or update a stall | [15](15.md) | | ||
| 120 | | `30018` | Create or update a product | [15](15.md) | | ||
| 121 | | `30023` | Long-form Content | [23](23.md) | | ||
| 122 | | `30024` | Draft Long-form Content | [23](23.md) | | ||
| 123 | | `30078` | Application-specific Data | [78](78.md) | | ||
| 124 | | `30311` | Live Event | [53](53.md) | | ||
| 125 | | `30315` | User Statuses | [38](38.md) | | ||
| 126 | | `30402` | Classified Listing | [99](99.md) | | ||
| 127 | | `30403` | Draft Classified Listing | [99](99.md) | | ||
| 128 | | `31922` | Date-Based Calendar Event | [52](52.md) | | ||
| 129 | | `31923` | Time-Based Calendar Event | [52](52.md) | | ||
| 130 | | `31924` | Calendar | [52](52.md) | | ||
| 131 | | `31925` | Calendar Event RSVP | [52](52.md) | | ||
| 132 | | `31989` | Handler recommendation | [89](89.md) | | ||
| 133 | | `31990` | Handler information | [89](89.md) | | ||
| 134 | | `34550` | Community Definition | [72](72.md) | | ||
| 135 | 201 | ||
| 136 | ## Message types | 202 | ## Message types |
| 137 | 203 | ||
| @@ -153,6 +219,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 153 | | `EVENT` | used to send events requested to clients | [01](01.md) | | 219 | | `EVENT` | used to send events requested to clients | [01](01.md) | |
| 154 | | `NOTICE` | used to send human-readable messages to clients | [01](01.md) | | 220 | | `NOTICE` | used to send human-readable messages to clients | [01](01.md) | |
| 155 | | `OK` | used to notify clients if an EVENT was successful | [01](01.md) | | 221 | | `OK` | used to notify clients if an EVENT was successful | [01](01.md) | |
| 222 | | `CLOSED` | used to notify clients that a REQ was ended and why | [01](01.md) | | ||
| 156 | | `AUTH` | used to send authentication challenges | [42](42.md) | | 223 | | `AUTH` | used to send authentication challenges | [42](42.md) | |
| 157 | | `COUNT` | used to send requested event counts to clients | [45](45.md) | | 224 | | `COUNT` | used to send requested event counts to clients | [45](45.md) | |
| 158 | 225 | ||
| @@ -160,71 +227,87 @@ Please update these lists when proposing NIPs introducing new event kinds. | |||
| 160 | 227 | ||
| 161 | ## Standardized Tags | 228 | ## Standardized Tags |
| 162 | 229 | ||
| 163 | | name | value | other parameters | NIP | | 230 | | name | value | other parameters | NIP | |
| 164 | | ----------------- | ------------------------------------ | -------------------- | ------------------------------------- | | 231 | | ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | |
| 165 | | `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | | 232 | | `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | |
| 166 | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | 233 | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | |
| 167 | | `a` | coordinates to an event | relay URL | [01](01.md) | | 234 | | `a` | coordinates to an event | relay URL | [01](01.md) | |
| 168 | | `d` | identifier | -- | [01](01.md) | | 235 | | `d` | identifier | -- | [01](01.md) | |
| 169 | | `alt` | summary | -- | [31](31.md) | | 236 | | `g` | geohash | -- | [52](52.md) | |
| 170 | | `g` | geohash | -- | [52](52.md) | | 237 | | `i` | identity | proof | [39](39.md) | |
| 171 | | `i` | identity | proof | [39](39.md) | | 238 | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | |
| 172 | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | | 239 | | `l` | label, label namespace | annotations | [32](32.md) | |
| 173 | | `l` | label, label namespace | annotations | [32](32.md) | | 240 | | `L` | label namespace | -- | [32](32.md) | |
| 174 | | `L` | label namespace | -- | [32](32.md) | | 241 | | `m` | MIME type | -- | [94](94.md) | |
| 175 | | `m` | MIME type | -- | [94](94.md) | | 242 | | `q` | event id (hex) | relay URL | [18](18.md) | |
| 176 | | `r` | a reference (URL, etc) | petname | | | 243 | | `r` | a reference (URL, etc) | petname | | |
| 177 | | `r` | relay url | marker | [65](65.md) | | 244 | | `r` | relay url | marker | [65](65.md) | |
| 178 | | `t` | hashtag | -- | | | 245 | | `t` | hashtag | -- | | |
| 179 | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | 246 | | `alt` | summary | -- | [31](31.md) | |
| 180 | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | | 247 | | `amount` | millisatoshis, stringified | -- | [57](57.md) | |
| 181 | | `challenge` | challenge string | -- | [42](42.md) | | 248 | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | |
| 182 | | `content-warning` | reason | -- | [36](36.md) | | 249 | | `challenge` | challenge string | -- | [42](42.md) | |
| 183 | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | 250 | | `client` | name, address | relay URL | [89](89.md) | |
| 184 | | `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | | 251 | | `clone` | git clone URL | -- | [34](34.md) | |
| 185 | | `emoji` | shortcode, image URL | -- | [30](30.md) | | 252 | | `content-warning` | reason | -- | [36](36.md) | |
| 186 | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | 253 | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | |
| 187 | | `goal` | event id (hex) | relay URL | [75](75.md) | | 254 | | `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | |
| 188 | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | 255 | | `emoji` | shortcode, image URL | -- | [30](30.md) | |
| 189 | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | 256 | | `encrypted` | -- | -- | [90](90.md) | |
| 190 | | `location` | location string | -- | [52](52.md), [99](99.md) | | 257 | | `expiration` | unix timestamp (string) | -- | [40](40.md) | |
| 191 | | `name` | badge name | -- | [58](58.md) | | 258 | | `goal` | event id (hex) | relay URL | [75](75.md) | |
| 192 | | `nonce` | random | -- | [13](13.md) | | 259 | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | |
| 193 | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | 260 | | `imeta` | inline metadata | -- | [92](92.md) | |
| 194 | | `price` | price | currency, frequency | [99](99.md) | | 261 | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | |
| 195 | | `proxy` | external ID | protocol | [48](48.md) | | 262 | | `location` | location string | -- | [52](52.md), [99](99.md) | |
| 196 | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | 263 | | `name` | name | -- | [34](34.md), [58](58.md) | |
| 197 | | `relay` | relay url | -- | [42](42.md) | | 264 | | `nonce` | random | difficulty | [13](13.md) | |
| 198 | | `relays` | relay list | -- | [57](57.md) | | 265 | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | |
| 199 | | `subject` | subject | -- | [14](14.md) | | 266 | | `price` | price | currency, frequency | [99](99.md) | |
| 200 | | `summary` | article summary | -- | [23](23.md) | | 267 | | `proxy` | external ID | protocol | [48](48.md) | |
| 201 | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | 268 | | `published_at` | unix timestamp (string) | -- | [23](23.md) | |
| 202 | | `title` | article title | -- | [23](23.md) | | 269 | | `relay` | relay url | -- | [42](42.md), [17](17.md) | |
| 203 | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | | 270 | | `relays` | relay list | -- | [57](57.md) | |
| 271 | | `server` | file storage server url | -- | [96](96.md) | | ||
| 272 | | `subject` | subject | -- | [14](14.md), [17](17.md) | | ||
| 273 | | `summary` | article summary | -- | [23](23.md) | | ||
| 274 | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | ||
| 275 | | `title` | article title | -- | [23](23.md) | | ||
| 276 | | `web` | webpage URL | -- | [34](34.md) | | ||
| 277 | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | | ||
| 204 | 278 | ||
| 205 | ## Criteria for acceptance of NIPs | 279 | ## Criteria for acceptance of NIPs |
| 206 | 280 | ||
| 207 | 1. They should be implemented in at least two clients and one relay -- when applicable. | 281 | 1. They should be fully implemented in at least two clients and one relay -- when applicable. |
| 208 | 2. They should make sense. | 282 | 2. They should make sense. |
| 209 | 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. | 283 | 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. |
| 210 | 4. There should be no more than one way of doing the same thing. | 284 | 4. There should be no more than one way of doing the same thing. |
| 211 | 5. Other rules will be made up when necessary. | 285 | 5. Other rules will be made up when necessary. |
| 212 | 286 | ||
| 213 | ## Mailing Lists | 287 | ## Is this repository a centralizing factor? |
| 288 | |||
| 289 | To promote interoperability, we standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. | ||
| 290 | |||
| 291 | It can even fork into multiple and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. | ||
| 292 | |||
| 293 | There is a list of notable Nostr software developers who have commit access to this repository, but that exists mostly for practical reasons, as by the nature of the thing we're dealing with the repository owner can revoke membership and rewrite history as they want -- and if these actions are unjustified or perceived as bad or evil the community must react. | ||
| 214 | 294 | ||
| 215 | The nostr ecosystem is getting large with many different organizations, relays | 295 | ## How this repository works |
| 216 | and clients. Following the nips repo on github is becoming more difficult and | ||
| 217 | noisy. To coordinate on protocol development outside of github, there are | ||
| 218 | mailing lists where you can work on NIPs before submitting them here: | ||
| 219 | 296 | ||
| 220 | * [w3c nostr community group][w3-nostr] - [public-nostr@w3.org][mailto-w3] - requires signup | 297 | Standards may emerge in two ways: the first way is that someone starts doing something, then others copy it; the second way is that someone has an idea of a new standard that could benefit multiple clients and the protocol in general without breaking **backwards-compatibility** and the principle of having **a single way of doing things**, then they write that idea and submit it to this repository, other interested parties read it and give their feedback, then once most people reasonably agree we codify that in a NIP which client and relay developers that are interested in the feature can proceed to implement. |
| 221 | * [nostr-protocol google group][nostr-google-group] - [nostr-protocol@googlegroups.com][mailto-google] - no signup required | ||
| 222 | 298 | ||
| 223 | [w3-nostr]: https://www.w3.org/community/nostr/ | 299 | These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful. |
| 224 | [mailto-w3]: mailto:public-nostr@w3.org | 300 | |
| 225 | [nostr-google-group]: https://groups.google.com/g/nostr-protocol | 301 | ## Breaking Changes |
| 226 | [mailto-google]: mailto:nostr-protocol@googlegroups.com | 302 | |
| 303 | [Breaking Changes](BREAKING.md) | ||
| 227 | 304 | ||
| 228 | ## License | 305 | ## License |
| 229 | 306 | ||
| 230 | All NIPs are public domain. | 307 | All NIPs are public domain. |
| 308 | |||
| 309 | ## Contributors | ||
| 310 | |||
| 311 | <a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors"> | ||
| 312 | <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" /> | ||
| 313 | </a> | ||