Pubky.app Data Model Specification

Version 0.4.0

⚠️ Warning: Rapid Development Phase
This specification is in an early development phase and is evolving quickly. Expect frequent changes and updates as the system matures. Consider this a v0 draft.

When we reach the first stable, long-term support version of the schemas, paths will adopt the format: pubky.app/v1/ to indicate compatibility and stability.

JS package

The package is available as an npm module pubky-app-specs. Alternatively, you can build from source using the provided build scripts:

cd pkg
npm run build

Test with:

cd pkg
npm run install
npm run test

Examples with:

cd pkg
npm run example

Table of Contents

• Pubky.app Data Model Specification
  • JS package
  • Table of Contents
  • Introduction
  • Quick Start
    • Concepts:
  • Data Models
    • PubkyAppUser
    • PubkyAppFile
    • PubkyAppPost
    • PubkyAppTag
    • PubkyAppBookmark
    • PubkyAppFollow
    • PubkyAppFeed
  • Validation Rules
    • Common Rules
  • License

Introduction

This document specifies the data models and validation rules for the Pubky.app clients interactions. It defines the structure of data entities, their properties, and the validation rules to ensure data integrity and consistency. This is intended for developers building compatible libraries or clients.

This document intents to be a faithful representation of our Rust pubky.app models. If you intend to develop in Rust, use them directly. In case of disagreement between this document and the Rust implementation, the Rust implementation prevails.

Quick Start

Pubky.app models are designed for decentralized content sharing. The system uses a combination of timestamp-based IDs and Blake3-hashed IDs encoded in Crockford Base32 to ensure unique identifiers for each entity.

Concepts:

• Timestamp IDs for sequential objects like posts and files.
• Hash IDs for content-based uniqueness (e.g., tags and bookmarks).
• Validation Rules ensure consistent and interoperable data formats.

Data Models

PubkyAppUser

Description: Represents a user's profile information.

URI: /pub/pubky.app/profile.json

Validation Notes:

• Reserved keyword [DELETED] cannot be used for name.
• Each UserLink in links must have a valid title and URL.

Example: Valid User

{
  "name": "Alice",
  "bio": "Toxic maximalist.",
  "image": "pubky://user_id/pub/pubky.app/files/0000000000000",
  "links": [
    {
      "title": "GitHub",
      "url": "https://github.com/alice"
    }
  ],
  "status": "Exploring decentralized tech."
}

PubkyAppFile

Description: Represents a file uploaded by the user, containing its metadata, including a reference to the actual blob of the file in src property.

URI: /pub/pubky.app/files/:file_id

Validation Notes:

• The file_id in the URI must be a valid Timestamp ID.

PubkyAppPost

Description: Represents a user's post.

URI: /pub/pubky.app/posts/:post_id

Post Kinds:

• short
• long
• image
• video
• link
• file

Example: Valid Post

{
  "content": "Hello world! This is my first post.",
  "kind": "short",
  "parent": null,
  "embed": {
    "kind": "short",
    "uri": "pubky://user_id/pub/pubky.app/posts/0000000000000"
  },
  "attachments": ["pubky://user_id/pub/pubky.app/files/0000000000000"]
}

PubkyAppTag

Description: Represents a tag applied to a URI.

URI: /pub/pubky.app/tags/:tag_id

Validation Notes:

• The tag_id is a Hash ID derived from the uri and label.

PubkyAppBookmark

Description: Represents a bookmark to a URI.

URI: /pub/pubky.app/bookmarks/:bookmark_id

Validation Notes:

• The bookmark_id is a Hash ID derived from the uri.

PubkyAppFollow

Description: Represents a follow relationship.

URI: /pub/pubky.app/follows/:user_id

PubkyAppFeed

Description: Represents a feed configuration.

URI: /pub/pubky.app/feeds/:feed_id

Validation Rules

Common Rules

1. Timestamp IDs: 13-character Crockford Base32 strings derived from timestamps (in microseconds).
2. Hash IDs: First half of the bytes from the resulting Blake3-hashed strings encoded in Crockford Base32.
3. URLs: All URLs must pass standard validation.

License

This specification is released under the MIT License.