Kind 10030: Emojis

Overview

Kind 10030 represents "Emojis", which is a standard list for user preferred emojis and pointers to emoji sets. It's part of the "Standard lists" category defined in NIP-51, meaning users can only have a single instance of this kind. This list helps users maintain their preferred custom emojis and references to emoji sets across different clients.

Specification

Property	Value
Kind Number	10030
Event Range	Replaceable
Defined in	[NIP-51]

Content Format

The content field may be empty or contain encrypted emoji definitions using the NIP-04 encryption scheme for private items. When encrypted, the content contains a JSON array that mimics the structure of the event tags array but contains private emoji definitions that the user doesn't want to share publicly.

Schema

When the content contains encrypted data, the decrypted content would follow this structure:

[
  ["emoji", "shortcode", "url"],
  ["emoji", "another_shortcode", "another_url"],
  ["a", "30030:pubkey:identifier"]
]

Tags

Tag Name	Description	Format	Required
emoji	Custom emoji definition	["emoji", "<shortcode>", "<url>"]	No
a	Reference to an emoji set	["a", "30030:<pubkey>:<identifier>"]	No

Client Behavior

Clients that support the Emojis list should:

1. Use it to store the user's preferred custom emojis.
2. Display and make these emojis available for the user when composing messages.
3. Support both public emojis (specified in the tags) and private emojis (if encrypted in the content).
4. Allow users to reference emoji sets (kind 30030) for organized collections.
5. Load and display emojis from referenced emoji sets.
6. Handle the list as replaceable, meaning a new version completely replaces the old one.

Relay Behavior

Relays should treat kind 10030 events as replaceable events. When a new kind 10030 event is received from a user, relays should replace any existing event of the same kind from that user.

Use Cases

• Storing a user's frequently used custom emojis
• Creating a personal collection of favorite emojis
• Referencing emoji sets created by the user or others
• Maintaining consistent emoji availability across different clients and devices
• Keeping some emoji definitions private through encryption

Example

{
  "id": "a94a316b75e44cfdc19986c634049158d4206fcc0b7b9c7ccbcdabe28beebcd0",
  "pubkey": "854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb",
  "created_at": 1699597889,
  "kind": 10030,
  "tags": [
    ["emoji", "cat", "https://example.com/emojis/cat.png"],
    ["emoji", "dog", "https://example.com/emojis/dog.png"],
    ["emoji", "happy", "https://example.com/emojis/happy.gif"],
    ["a", "30030:854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb:animal_emojis"]
  ],
  "content": "",
  "sig": "1173822c53261f8cffe7efbf43ba4a97a9198b3e402c2a1df130f42a8985a2d0d3430f4de350db184141e45ca844ab4e5364ea80f11d720e36357e1853dba6ca"
}

References

• NIP-51: Lists
• NIP-30: Custom Emoji
• NIP-04: Encrypted Direct Messages

Related Kinds

• Kind 30030: Emoji Sets - Parameterized replaceable lists for categorized emoji groups

Notes

The Emojis list (kind 10030) is a standard replaceable list, meaning a user can only have one such list at a time. Unlike the Emoji sets (kind 30030) which are parameterized replaceable and allow users to have multiple sets with different identifiers.

The emoji tag format follows the convention defined in NIP-30, with a shortcode and a URL to the emoji image. Clients should render these emojis when they appear in text content, replacing the shortcode with the image from the URL.

The list can also reference emoji sets through the a tag, allowing users to access organized collections of emojis that they or other users have created.