Contract Overview

// Root container for a publication. Shared object  - key only (no store).
public struct Publication has key {
  id: UID,
  name: String,
  slug: String,
  collections: VecMap<String, Collection>,
  revoked_publisher_caps: Table<ID, bool>,
}

// Shared singleton. Created by the package initializer. Holds slug-to-ID mapping.
public struct PublicationRegistry has key {
  id: UID,
  slugs: Table<String, ID>,
}

// Proves ownership. One per publication. Transferable.
public struct OwnerCap has key {
  id: UID,
  publication_id: ID,
}

// Grants write access. Many per publication. Holder-bound.
public struct PublisherCap has key {
  id: UID,
  publication_id: ID,
  holder: address,
}

// Stored value inside Publication.collections VecMap.
public struct Collection has store {
  name: String,
  storage_mode: u8,       // 0 = STORAGE_MODE_BLOB, 1 = STORAGE_MODE_QUILT. Immutable.
  next_entry_id: u64,     // Monotonic counter; never decremented on delete.
  entries: Table<u64, Entry>,
}

// Stored value inside Collection.entries Table.
public struct Entry has store, drop {
  name: String,
  revisions: vector<EntryRevision>,
  draft_head: Option<u64>,
  public_head: Option<u64>,
}

// Immutable revision metadata appended to Entry.revisions.
public struct EntryRevision has store, drop {
  blob_ref: BlobRef,
  content_type: String,
  encrypted: bool,
  access_policy: u8,
  seal_id: Option<vector<u8>>,
  author: address,
}

// Identifies the Walrus content for a revision.
// Blob(ID): Sui object ID of a standalone Walrus Blob (STORAGE_MODE_BLOB).
// QuiltPatch(vector<u8>): 37-byte QuiltPatchId  - quilt_blob_id (32) || version (1) || start_index (2) || end_index (2).
public enum BlobRef has copy, drop, store {
  Blob(ID),
  QuiltPatch(vector<u8>),
}