MeshKit
Concepts

Metadata Service

The MeshKit metadata routes that stock IPFS nodes do not provide.

MeshKit production workflows need metadata beside encrypted provider bytes. A stock IPFS node can store and retrieve bytes, but it does not automatically provide MeshKit proofs, capsules, mailboxes, sync jobs, vaults, capabilities, logs, or policy state.

The metadata service is the part of a provider boundary that stores those MeshKit-specific records.

Why Raw IPFS Is Not Enough

WorkflowNeeds encrypted bytesAlso needs metadata
Read by CIDYesProof and envelope metadata
Share contentYesCapsule and revocation state
Send messagesYesMailbox records
Sync offline workSometimesDurable sync job records and checkpoints
Use vaults or capabilitiesYesVault and capability records
Audit provider behaviorYesLogs, health checks, proof summaries

If you only configure raw byte storage, some workflows will store content but fail later when they need MeshKit metadata.

Boundary Diagram

The byte store and metadata service can be implemented by the same provider or by coordinated services. The important requirement is that your app reads from the same boundary that wrote the object.

What The Metadata Service Stores

  • Proof records
  • Share capsules
  • Revoked capsule IDs
  • Message mailbox entries
  • Sync jobs and checkpoints
  • Vault records
  • Capability records
  • Provider logs
  • Health check results

Metadata can reveal operational relationships even when content is encrypted. Treat it as sensitive application data.

Production Checklist

Before production:

  1. Decide which service stores encrypted bytes.
  2. Decide which service stores MeshKit metadata.
  3. Ensure both services use the same environment, tenant, and retention model.
  4. Keep provider and metadata tokens out of source control.
  5. Run write, read, proof, share, message, sync, and cleanup validation for the workflows you ship.
  6. Record which validation output proves the environment is ready.

Common Failures

SymptomLikely causeAction
Bytes exist but read failsProof or envelope metadata missingCheck metadata service routing and retention
Share capsule missingCapsule was never written or metadata store differsRecreate or migrate capsule metadata
Message inbox emptyProvider does not support mailbox recordsUse a provider with mailbox support
Sync unsupportedProvider lacks sync job storageConfigure a provider with durable sync queues
Local works, Kubo failsKubo stores bytes but no MeshKit metadata API is configuredAdd a MeshKit-compatible metadata service

Next Steps

On this page