article

README

NIPs

NIPs stand for Nostr Implementation Possibilities.

They exist to document what may be implemented by Nostr-compatible relay and client software.

List
Event Kinds
Message Types
- Client to Relay
- Relay to Client
Standardized Tags
Criteria for acceptance of NIPs
Is this repository a centralizing factor?
How this repository works
Breaking Changes
License

List

Event Kinds

| kind | ------------- | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 20 | 21 | 22 | 30 | 31 | 32 | 33 | 40 | 41 | 42 | 43 | 44 | 62 | 64 | 818 | 1018 | 1021 | 1022 | 1040 | 1059 | 1063 | 1068 | 1111 | 1311 | 1337 | 1617 | 1621 | 1622 | 1630- | 1971 | 1984 | 1985 | 1986 | 1987 | 2003 | 2004 | 2022 | 4550 | 5000- | 6000- | 7000 | 7374 | 7375 | 7376 | 9000- | 9041 | 9321 | 9467 | 9734 | 9735 | 9802 | 10000 | 10001 | 10002 | 10003 | 10004 | 10005 | 10006 | 10007 | 10009 | 10012 | 10013 | 10015 | 10019 | 10020 | 10030 | 10050 | 10063 | 10096 | 10166 | 13194 | 17375 | 21000 | 22242 | 23194 | 23195 | 24133 | 24242 | 27235 | 30000 | 30001 | 30002 | 30003 | 30004 | 30005 | 30007 | 30008 | 30009 | 30015 | 30017 | 30018 | 30019 | 30020 | 30023 | 30024 | 30030 | 30040 | 30041 | 30063 | 30078 | 30166 | 30267 | 30311 | 30315 | 30388 | 30402 | 30403 | 30617 | 30618 | 30818 | 30819 | 31234 | 31388 | 31890 | 31922 | 31923 | 31924 | 31925 | 31989 | 31990 | 32267 | 34550 | 38383 | 39000-9 | 39089 | 39092 | 39701 | description | NIP | | ------------------------------- | -------------------------------------- | | User Metadata | 01 | | Short Text Note | 10 | | Recommend Relay | 01 (deprecated) | | Follows | 02 | | Encrypted Direct Messages | 04 | | Event Deletion Request | 09 | | Repost | 18 | | Reaction | 25 | | Badge Award | 58 | | Chat Message | C7 | | Group Chat Threaded Reply | 29 (deprecated) | | Thread | 7D | | Group Thread Reply | 29 (deprecated) | | Seal | 59 | | Direct Message | 17 | | File Message | 17 | | Generic Repost | 18 | | Reaction to a website | 25 | | Picture | 68 | | Video Event | 71 | | Short-form Portrait Video Event | 71 | | internal reference | NKBIP-03 | | external web reference | NKBIP-03 | | hardcopy reference | NKBIP-03 | | prompt reference | NKBIP-03 | | Channel Creation | 28 | | Channel Metadata | 28 | | Channel Message | 28 | | Channel Hide Message | 28 | | Channel Mute User | 28 | | Request to Vanish | 62 | | Chess (PGN) | 64 | | Merge Requests | 54 | | Poll Response | 88 | | Bid | 15 | | Bid confirmation | 15 | | OpenTimestamps | 03 | | Gift Wrap | 59 | | File Metadata | 94 | | Poll | 88 | | Comment | 22 | | Live Chat Message | 53 | | Code Snippet | C0 | | Patches | 34 | | Issues | 34 | | Git Replies (deprecated) | 34 | 1633 | Status | 34 | | Problem Tracker | nostrocket | | Reporting | 56 | | Label | 32 | | Relay reviews | | | AI Embeddings / Vector lists | NKBIP-02 | | Torrent | 35 | | Torrent Comment | 35 | | Coinjoin Pool | joinstr | | Community Post Approval | 72 | 5999 | Job Request | 90 | 6999 | Job Result | 90 | | Job Feedback | 90 | | Reserved Cashu Wallet Tokens | 60 | | Cashu Wallet Tokens | 60 | | Cashu Wallet History | 60 | 9030 | Group Control Events | 29 | | Zap Goal | 75 | | Nutzap | 61 | | Tidal login | Tidal-nostr | | Zap Request | 57 | | Zap | 57 | | Highlights | 84 | | Mute list | 51 | | Pin list | 51 | | Relay List Metadata | 65, 51 | | Bookmark list | 51 | | Communities list | 51 | | Public chats list | 51 | | Blocked relays list | 51 | | Search relays list | 51 | | User groups | 51, 29 | | Favorite relays list | 51 | | Private event relay list | 37 | | Interests list | 51 | | Nutzap Mint Recommendation | 61 | | Media follows | 51 | | User emoji list | 51 | | Relay list to receive DMs | 51, 17 | | User server list | Blossom | | File storage server list | 96 | | Relay Monitor Announcement | 66 | | Wallet Info | 47 | | Cashu Wallet Event | 60 | | Lightning Pub RPC | Lightning.Pub | | Client Authentication | 42 | | Wallet Request | 47 | | Wallet Response | 47 | | Nostr Connect | 46 | | Blobs stored on mediaservers | Blossom | | HTTP Auth | 98 | | Follow sets | 51 | | Generic lists | 51 (deprecated) | | Relay sets | 51 | | Bookmark sets | 51 | | Curation sets | 51 | | Video sets | 51 | | Kind mute sets | 51 | | Profile Badges | 58 | | Badge Definition | 58 | | Interest sets | 51 | | Create or update a stall | 15 | | Create or update a product | 15 | | Marketplace UI/UX | 15 | | Product sold as an auction | 15 | | Long-form Content | 23 | | Draft Long-form Content | 23 | | Emoji sets | 51 | | Curated Publication Index | NKBIP-01 | | Curated Publication Content | NKBIP-01 | | Release artifact sets | 51 | | Application-specific Data | 78 | | Relay Discovery | 66 | | App curation sets | 51 | | Live Event | 53 | | User Statuses | 38 | | Slide Set | Corny Chat | | Classified Listing | 99 | | Draft Classified Listing | 99 | | Repository announcements | 34 | | Repository state announcements | 34 | | Wiki article | 54 | | Redirects | 54 | | Draft Event | 37 | | Link Set | Corny Chat | | Feed | NUD: Custom Feeds | | Date-Based Calendar Event | 52 | | Time-Based Calendar Event | 52 | | Calendar | 52 | | Calendar Event RSVP | 52 | | Handler recommendation | 89 | | Handler information | 89 | | | Software Application | | | | Community Definition | 72 | | Peer-to-peer Order events | 69 | | Group metadata events | 29 | | Starter packs | 51 | | Media starter packs | 51 | | Web bookmarks | B0 |

Message types

Client to Relay

| type | description | NIP | | ------- | --------------------------------------------------- | ----------- | | EVENT | used to publish events | 01 | | REQ | used to request events and subscribe to new updates | 01 | | CLOSE | used to stop previous subscriptions | 01 | | AUTH | used to send authentication events | 42 | | COUNT | used to request event counts | 45 |

Relay to Client

| type | description | NIP | | -------- | ------------------------------------------------------- | ----------- | | EOSE | used to notify clients all stored events have been sent | 01 | | EVENT | used to send events requested to clients | 01 | | NOTICE | used to send human-readable messages to clients | 01 | | OK | used to notify clients if an EVENT was successful | 01 | | CLOSED | used to notify clients that a REQ was ended and why | 01 | | AUTH | used to send authentication challenges | 42 | | COUNT | used to send requested event counts to clients | 45 |

Standardized Tags

| name | value | other parameters | NIP | | ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | | a | coordinates to an event | relay URL | 01 | | A | root address | relay URL | 22 | | d | identifier | -- | 01 | | e | event id (hex) | relay URL, marker, pubkey (hex) | 01, 10 | | E | root event id | relay URL | 22 | | f | currency code | -- | 69 | | g | geohash | -- | 52 | | h | group id | -- | 29 | | i | external identity | proof, url hint | 35, 39, 73 | | I | root external identity | -- | 22 | | k | kind | -- | 18, 25, 72, 73 | | K | root scope | -- | 22 | | l | label, label namespace, language name| -- | 32, C0 | | L | label namespace | -- | 32 | | m | MIME type | -- | 94 | | p | pubkey (hex) | relay URL, petname | 01, 02, 22 | | P | pubkey (hex) | -- | 22, 57 | | q | event id (hex) | relay URL, pubkey (hex) | 18 | | r | a reference (URL, etc) | -- | 24, 25 | | r | relay url | marker | 65 | | s | status | -- | 69 | | t | hashtag | -- | 24, 34, 35 | | u | url | -- | 61, 98 | | x | hash | -- | 35, 56 | | y | platform | -- | 69 | | z | order number | -- | 69 | | - | -- | -- | 70 | | alt | summary | -- | 31 | | amount | millisatoshis, stringified | -- | 57 | | bolt11 | bolt11 invoice | -- | 57 | | challenge | challenge string | -- | 42 | | client | name, address | relay URL | 89 | | clone | git clone URL | -- | 34 | | content-warning | reason | -- | 36 | | delegation | pubkey, conditions, delegation token | -- | 26 | | dep | Required dependency | -- | C0 | | description | description | -- | 34, 57, 58, C0 | | emoji | shortcode, image URL | -- | 30 | | encrypted | -- | -- | 90 | | extension | File extension | -- | C0 | | expiration | unix timestamp (string) | -- | 40 | | file | full path (string) | -- | 35 | | goal | event id (hex) | relay URL | 75 | | image | image URL | dimensions in pixels | 23, 52, 58 | | imeta | inline metadata | -- | 92 | | license | License of the shared content | -- | C0 | | lnurl | bech32 encoded lnurl | -- | 57 | | location | location string | -- | 52, 99 | | name | name | -- | 34, 58, 72, C0 | | nonce | random | difficulty | 13 | | preimage | hash of bolt11 invoice | -- | 57 | | price | price | currency, frequency | 99 | | proxy | external ID | protocol | 48 | | published_at | unix timestamp (string) | -- | 23, B0 | | relay | relay url | -- | 42, 17 | | relays | relay list | -- | 57 | | repo | Reference to the origin repository | -- | C0 | | runtime | Runtime or environment specification | -- | C0 | | server | file storage server url | -- | 96 | | subject | subject | -- | 14, 17, 34 | | summary | summary | -- | 23, 52 | | thumb | badge thumbnail | dimensions in pixels | 58 | | title | title | -- | 23, B0 | | tracker | torrent tracker URL | -- | 35 | | web | webpage URL | -- | 34 | | zap | pubkey (hex), relay URL | weight | 57 |

Please update these lists when proposing new NIPs.

Criteria for acceptance of NIPs

They should be fully implemented in at least two clients and one relay -- when applicable.
They should make sense.
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.
There should be no more than one way of doing the same thing.
Other rules will be made up when necessary.

Is this repository a centralizing factor?

To promote interoperability, we need 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 an 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.

It can even fork into multiple versions, 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.

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.

How this repository works

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.

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.

Breaking Changes

License

All NIPs are public domain.

Nostr 实现可能性