2.4 KiB

Raw Blame History

Ditto custom events

Instead of using database tables, the Ditto server publishes Nostr events that describe its state. It then reads these events using Nostr filters.

User Event (kind 30361)

The Ditto server publishes kind 30361 events to represent users. These events are parameterized replaceable events of kind 30361 where the d tag is a pubkey. These events are published by Ditto's internal admin keypair.

User events have the following tags:

d - pubkey of the user.
name - NIP-05 username granted to the user, without the domain.
role - one of admin or user.
origin - the origin of the user's NIP-05, at the time the event was published.

Example:

{
  "id": "d6ae2f320ae163612bf28080e7c6e55b228ee39bfa04ad50baab2e51022d4d59",
  "kind": 30361,
  "pubkey": "4cfc6ceb07bbe2f5e75f746f3e6f0eda53973e0374cd6bdbce7a930e10437e06",
  "content": "",
  "created_at": 1691568245,
  "tags": [
    ["d", "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6"],
    ["name", "alex"],
    ["role", "user"],
    ["origin", "https://ditto.ngrok.app"],
    ["alt", "@alex@ditto.ngrok.app's account was updated by the admins of ditto.ngrok.app"]
  ],
  "sig": "fc12db77b1c8f8aa86c73b617f0cd4af1e6ba244239eaf3164a292de6d39363f32d6b817ffff796ace7a103d75e1d8e6a0fb7f618819b32d81a953b4a75d7507"
}

Invite Request Event (kind 3036)

Clients wishing to join a Ditto server should publish a kind 3036 event to the Ditto relay, mentioning the admin pubkey.

The event's content is NIP-44 encrypted JSON, containing the following fields:

nip05 - desired NIP-05 username, including the domain.
email - email address of the user.
reason - reason for joining the server.

Only nip05 is always required. Other fields may be required depending on the policy of the server.

NIP-78

NIP-78 defines events of kind 30078 with a globally unique d tag. These events are queried by the d tag, which allows Ditto to store custom data on relays. Ditto uses reverse DNS names like pub.ditto.<thing> for d tags.

The sections below describe the content field. Some are encrypted and some are not, depending on whether the data should be public. Also, some events are user events, and some are admin events.

`pub.ditto.pleroma.config`

NIP-04 encrypted JSON array of Pleroma ConfigDB objects. Pleroma admin API endpoints set this config, and Ditto reads from it.

2.4 KiB Raw Blame History