nips/22.md

NIP-22

Smart Widgets

draft optional

Smart Widgets are customizable, interactive components that can be embedded within Nostr events and allow to create rich, dynamic content. This proposal outlines the structure, implementation, and potential use cases of Smart Widgets.

Motivation

Traditional static content limits user interaction and engagement. Smart Widgets provide a way to embed dynamic components, such as buttons, images, and polls, directly into Nostr events, enabling more interactive and responsive content.

Event kind

A new addressable event kind is proposed for Smart Widgets kind 30031. This event kind will encapsulate the data necessary to render and interact with the Smart Widgets.

Event Structure

The content of these events MUST be of a specified MIME type in a corresponding m tag. It is required and can't be empty. For more info about MIME type see

The list of tags are as follows:

d (required) universally unique identifier (UUID). Generated by the client creating the smart widget event.

m (required) allows clients to easily know MIME type before proceeding it.

title (optional) title of the smart widget.

summary (optional) description of the smart widget and its usage.

client (optional) reference for the used client for creating the smart widget according to NIP-89.

published_at (optional) Publishing time of the smart widget differs from the created_at for edited smart widgets.

{
	"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": 30031,
	"content": <JSON-stringified-data>,
	"tags": [
		["d", "UUID"],
		["m", <MIME-type>],
		["title", "<title of smart widget event>"],
		["summary", "<description of smart widget event>"],
		["client", "<client_name>", "31990:app1_pubkey:<d_identifier>"],
		["published_at", "<Unix timestamp in seconds>"]
	]
}

Important

Client MUST validate its support for MIME type and, in case it is unsupported, turn that into a nostr:naddr1... link to some client capable of displaying such events according to NIP-19.

A stringified JSON of the kind 30031 smart widget would look like this:

{
    "created_at": 1725194263529,
    "kind": 30031,
    "tags": [
        ["d", "534304df-be5e-47bf-a761-1e6515e3ca75"],
        ["m", "image/svg+xml"],
        ["client", "My Client", "31990:app1-pubkey:<d-identifier>"],
        ["title", "Learn how to set up Nostr Relay with relays.xport.top article"],
        ["summary", "Take control of your relay lists, or let them control you."]
    ],
    "content": "<svg viewBox=\"0 0 10 5\" xmlns=\"http://www.w3.org/2000/svg\"><a href=\"https://relays.xport.top\" target=\"_blank\"><rect width=\"10\" height=\"5\"><animate attributeName=\"rx\" values=\"0;5;0\" dur=\"2s\" repeatCount=\"indefinite\" /></rect></a></svg>",
    "pubkey": "b12e28991eae808d408208743f382d99b777c51887286c6002258b5bed9d9c8b",
    "id": "fbd1d692610c0dc1090fd37058d36d749b753d57b9ad5521f1d84dad3914a044",
    "sig": "8d51e221ebd570f0eb3c899ebe1a8248e468a0db44f35591901c7ccb668db6e6f02d787216eaae58dfdced41e6677f270467933cb36b67d6297417fcda09a60e"
}