Index

nip11 ¶

NIP-11 Relay Information Document models.

Implements NIP-11 -- retrieval, parsing, and validation of relay information documents. Raw JSON responses are sanitized through parse() methods and validated into typed, frozen Pydantic models. Invalid fields or wrong types are silently dropped to handle non-conformant relays.

Model hierarchy:

Nip11                                    Top-level container
+-- relay: Relay                         Source relay reference
+-- generated_at: int                    Unix timestamp
+-- info: Nip11InfoMetadata              Data + logs container
    +-- data: Nip11InfoData              Parsed NIP-11 document
    |   +-- name, description, banner, icon, pubkey, ...
    |   +-- supported_nips: list[int]
    |   +-- limitation: Nip11InfoDataLimitation
    |   +-- retention: list[Nip11InfoDataRetentionEntry]
    |   +-- fees: Nip11InfoDataFees
    |       +-- admission / subscription / publication
    |           +-- list[Nip11InfoDataFeeEntry]
    +-- logs: Nip11InfoLogs              Operation result status
        +-- success: bool
        +-- reason: str | None

Note

NIP-11 results are stored as MetadataType.NIP11_INFO records in the database via Nip11.to_relay_metadata_tuple.