laantungir
/
nips
mirror of https://github.com/nostr-protocol/nips.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deeleted C0

This commit is contained in:
Niel Liesmons 2025-05-27 12:46:21 +02:00
parent 9e4399cb2f
commit ca3863a539
1 changed files with 0 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

204
C0.md
View File

@ -1,204 +0,0 @@
NIP-C0
======
<<<<<<< HEAD
Code Snippets
-------------
`draft` `optional`
## Abstract
This NIP defines a new event kind for sharing and storing code snippets. Unlike regular text notes (`kind:1`), code snippets have specialized metadata like language, extension, and other code-specific attributes that enhance discoverability, syntax highlighting, and improved user experience.
## Event Kind
This NIP defines `kind:1337` as a code snippet event.
The `.content` field contains the actual code snippet text.
## Optional Tags
- `l` - Programming language name (lowercase). Examples: "javascript", "python", "rust"
- `name` - Name of the code snippet, commonly a filename. Examples: "hello-world.js", "quick-sort.py"
- `extension` - File extension (without the dot). Examples: "js", "py", "rs"
- `description` - Brief description of what the code does
- `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11")
- `license` - License under which the code is shared (e.g., "MIT", "GPL-3.0", "Apache-2.0")
- `dep` - Dependency required for the code to run (can be repeated)
- `repo` - Reference to a repository where this code originates
## Format
```json
{
"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": 1337,
"content": "function helloWorld() {\n console.log('Hello, Nostr!');\n}\n\nhelloWorld();",
"tags": [
["l", "javascript"],
["extension", "js"],
["name", "hello-world.js"],
["description", "A basic JavaScript function that prints 'Hello, Nostr!' to the console"],
["runtime", "node v18.15.0"],
["license", "MIT"],
["repo", "https://github.com/nostr-protocol/nostr"]
],
"sig": "<64-bytes signature of the id>"
}
```
## Client Behavior
Clients that support this NIP SHOULD:
1. Display code snippets with proper syntax highlighting based on the language.
2. Allow copying the full code snippet with a single action.
3. Render the code with appropriate formatting, preserving whitespace and indentation.
4. Display the language and extension prominently.
5. Provide "run" functionality for supported languages when possible.
6. Display the description (if available) as part of the snippet presentation.
Clients MAY provide additional functionality such as:
1. Code editing capabilities
2. Forking/modifying snippets
3. Creating executable environments based on the runtime/dependencies
4. Downloading the snippet as a file using the provided extension
5. Sharing the snippet with attribution
=======
Communi-keys
-------------------------------------------------
`draft` `optional`
This NIP defines a standard for creating, managing and publishing to communities by leveraging existing key pairs and relays, introducing the concept of "Communi-keys". This approach allows any existing npub to become a community (identity + manager) while maintaining compatibility with existing relay infrastructure.
## Motivation
Current community management solutions on Nostr often require complex relay-specific implementations, lack proper decentralization and don't allow publications to be targeted at more than one community.
This proposal aims to simplify community management by utilizing existing Nostr primitives (key pairs and relays) while adding minimal new event kinds.
## Specification
### Community Creation Event
A community is created when a key pair publishes a `kind:32221` event with the following structure:
```json
{
"kind": 32221,
"content": "",
"tags": [
["relay", "<main-relay-url>"],
["relay", "<backup-relay-url-1>", "backup"],
["relay", "<backup-relay-url-2>", "backup"],
["blossom", "<main-blossom-server-url>"],
["blossom", "<backup-blossom-server-url>", "backup"],
["p", "<pubkey>", "<role>"],
["mint", "<community-mint-url>"],
["welcome", "<event-id>"]
]
}
```
Tag definitions:
- `relay`: URLs of relays where community content should be published. First one is considered main relay.
- `blossom`: URLs of blossom servers for additional community features (optional).
- `p`: Community role assignments. Multiple allowed. Format: `["p", "<pubkey>", "<role-name>"]`.
- `mint`: URL of community mint for token/payment features (optional).
- `welcome`: Event ID of a welcome/introduction post (optional).
The pubkey of the key pair that creates this event serves as the unique identifier for the community. This means:
1. Each key pair can only represent one community
2. Communities can be easily discovered by querying for the most recent `kind:32221` event for a given pubkey
3. Community managers can update their settings by publishing a new `kind:32221` event
### Community Identifier Format
Communities can be referenced using an "ncommunity" format:
`ncommunity://<pubkey>?relay=<url-encoded-relay-1>&relay=<url-encoded-relay-2>`
This format follows the same principles as nprofile, but specifically for community identification. While the ncommunity format is recommended for complete relay information, the standard pubkey format can also be used when relay discovery is not needed.
### Targeted Publication Event
To target an existing publication at specific communities, users create a `kind:32222` event:
```json
{
"kind": 32222,
"content": "",
"tags": [
["e", "<event-id-of-original-publication>"],
["p", "<community-pubkey>"],
["c", "<ncommunity-identifier>"],
["r", "<main-relay-url>"]
]
}
```
The event must be found on the community's specified main relay to be considered valid. The `e` tag references the original publication event that is being targeted at the communities. Communities can be referenced either using:
- The `p` tag with the community's pubkey (for simple cases where relay discovery is not needed)
- The `c` tag with a bech32-encoded ncommunity identifier (which includes both the community pubkey and its relay information)
### Community Chat Messages
For chat messages within a community, users should use `kind:9` events with a community tag:
```json
{
"kind": 9,
"content": "<message>",
"tags": [
["h", "<community-pubkey>"]
]
}
```
## Implementation Notes
1. Clients SHOULD verify that targeted publications (`kind:32222`) are present on the community's main relays. The main relay specified in the community creation event SHOULD be considered authoritative for community-related events. Clients MAY, however, fall back on a backup relay (as the authority) when the main relay is offline.
2. Clients MAY cache community metadata (`kind:30003`) events to reduce relay queries.
3. Relay operators MAY implement/automate additional filtering or moderation based on community specifications.
4. When encountering a `p` tag without corresponding relay information, clients SHOULD attempt to discover the community's relays through other means (e.g., known community relays, cached metadata).
## Benefits
1. Any existing npub can become a community
2. Communities are not permanently tied to specific relays
3. Simplified relay operator implementation compared to other community proposals
4. Supports relay-per-community model while remaining flexible
5. Enables cross-community interaction through targeted publications
6. The abilty to target publications to more than one community and the access to any desired content type eliminates the need for #channels or rooms
7. Flexible referencing allows for both simple and complete community identification
## Security Considerations
1. Clients MUST verify event signatures from community managers
2. Relays SHOULD implement rate limiting for community-related events
3. Clients SHOULD respect the relay hierarchy specified in community creation events
4. When using simple pubkey references, clients should be aware of potential relay discovery challenges
## Use Case for Private Groups and DMs
The Communi-keys structure naturally extends to private groups and DMs by leveraging relay-side authentication:
### Private Groups
- The community's profile metadata and relay address remain publicly readable
- All content (chats, posts, articles, polls, etc.) is only readable by npubs that meet the group's conditions
### Direct Messages (DMs)
- DMs are simply a private groups of two
- The npub representing the DM "room" doesn't need public metadata
- Clients can display the room using the other participant's name
- The room's npub can be stored locally or in encrypted form elsewhere for multi-device access
- Provides a clean separation between the chat identity and the participants' identities
This approach unifies community, group, and DM management under a single model while maintaining privacy through relay-side authentication.
>>>>>>> 5adcdda2e6030f5e9fb420aecfebd1d9762a9625