Framework

The SnapsVault Framework defines the standardized formats, metadata conventions, and best practices that make all snapshots reliable, verifiable, and interoperable across the ecosystem.

Together with the Marketplace and SnapsOS CLI, it forms the foundation of the SnapsVault architecture.

Purpose

The Framework ensures consistency and automation through:

• Standardization: Unified formats and naming conventions to minimize errors and incompatibility.
• Verification: Integrity checks (SHA-256) and block-height validation for trusted distribution.
• Automation: Predictable structures and JSON schemas enabling full automation.
• Interoperability: Seamless integration across networks, Marketplace, and SnapsOS.

File Types in the Framework

The Framework defines three primary JSON schemas that together describe how snapshots are structured and published across the ecosystem:

File	Purpose
snapshot.json	Defines metadata for a specific snapshot (consumed by tools and validators)
contributor.json	Describes the publisher and points to the maintained snapshots.json feed(s)
chain.json	Defines network-level properties (ID, layer type, DA, etc.)

These formats create a unified, machine-readable registry connecting snapshots, contributors, and chains.

Snapshot Entries

Each snapshot is described by a metadata JSON entry that enables verification, filtering, and automation.

• url: Direct link to the snapshot archive
• period: Update frequency (e.g. 4h, 12h, 1d)
• type: Snapshot type (archival or pruned)
• size: Human-readable size (e.g. 5GB)
• creation_date: ISO 8601 UTC timestamp when the snapshot was created
• latest_block_height: Highest block height included (number)
• sha256sum: SHA-256 checksum for integrity validation

Example:

{
  "url": "https://example.com/snapshots/snapshot_12345.tar.lz4",
  "period": "4h",
  "type": "pruned",
  "size": "5GB",
  "creation_date": "2025-07-21T00:00:17Z",
  "latest_block_height": 12345,
  "sha256sum": "df5b46912b04b73f93e9adc7ba3bb451a19e8ac704349c5870c166125fd3810"
}

Snapshot Types

• Archival: Contains the full history from genesis to the specified block. Useful for developers, explorers, and archive nodes.
• Pruned: Contains recent state and essential history. Optimized for validators and full nodes.

Snapshot Archives

Snapshots are compressed node states (typically .tar.lz4) containing everything needed to initialize a node from a specific block height. They should be efficiently compressed, include data appropriate to the snapshot type (archival or pruned), and be accessible via HTTPS.

Contributor Feeds

A contributor feed is a JSON file that describes the publisher and points to a dynamic snapshots.json feed listing their latest snapshots.

Each entry in that feed references a separate snapshot file with its own metadata (period, type, size, etc.), allowing maintainers to offer multiple snapshots across different block heights and update frequencies.

Note: The URL in this record does not link to an archive directly. It links to the 'snapshots.json' file.

Field	Description
contributor	Object with publisher details (name, contacts, site, identity)
snapshots	Array of objects each referencing a snapshots.json feed maintained by this contributor

Example contributor.json:

{
  "contributor": {
    "name": "deNodes",
    "email": "hello@denodes.xyz",
    "discord": "bombermine",
    "telegram": "https://t.me/denodes",
    "x": "https://x.com/denodes_io",
    "description": "An institutional-grade staking provider delivering secure operations and superior performance for PoS networks",
    "website": "https://denodes.io",
    "identity": "C89053F92B77D8C0"
  },
  "snapshots": [
    {
      "snapshots": "https://example.com/snapshots.json"
    }
  ]
}

This separation enables automatic discovery, validation, and updates without manual registry edits.

Why the Framework Matters

• Consistency and trust: Standardized fields and verification allow users to trust and compare snapshots.
• Automation and scale: Predictable formats support automation and large-scale operations across networks.
• Foundation of the ecosystem: The Framework underpins other components like the Marketplace and SnapsOS, ensuring interoperability.

---

For step-by-step instructions on generating and submitting snapshots, refer to the Contribute Snapshots guide.