Verdikta Common¶

Welcome to the Verdikta Common library documentation. This package provides essential shared utilities for building applications that interact with the Verdikta blockchain ecosystem.

What is Verdikta Common?¶

Verdikta Common (@verdikta/common) is a JavaScript/Node.js library that provides:

• Manifest Parsing: Parse and validate Verdikta manifest.json files
• IPFS Integration: Seamless IPFS content fetching and upload capabilities
• Archive Management: Handle compressed archives for arbitration cases
• Multi-CID Support: Process complex multi-party arbitration scenarios
• Validation Utilities: Comprehensive validation for manifests and requests

Key Features¶

🚀 Easy Integration¶

Simple factory function to get started quickly with sensible defaults.

📋 Manifest Specification v2.0¶

Complete support for the latest Verdikta manifest format including multi-CID and addendum features.

🌐 IPFS Ready¶

Built-in IPFS client with retry logic, multiple gateways, and caching support.

🔒 Validation & Security¶

Joi-based validation with sanitization for safe content processing.

🔧 Configurable¶

Flexible configuration options for different environments and use cases.

Quick Start¶

npm install @verdikta/common

const { parseManifest, validateRequest } = require('@verdikta/common');

// Parse a manifest from an extracted archive
const result = await parseManifest('/path/to/extracted/archive');

// Validate a request object
await validateRequest(requestObject);

Architecture Overview¶

graph TD
    A[Client Application] --> B[Verdikta Common]
    B --> C[Manifest Parser]
    B --> D[IPFS Client]
    B --> E[Archive Service]
    B --> F[Validator]

    C --> G[Multi-CID Processing]
    C --> H[Addendum Injection]

    D --> I[IPFS Gateways]
    D --> J[Pinning Services]

    E --> K[Archive Extraction]
    E --> L[File Management]

    F --> M[Joi Schemas]
    F --> N[Content Sanitization]

Use Cases¶

Arbitration Platforms¶

Build applications that submit cases to Verdikta arbiters with proper manifest formatting.

Content Management¶

Handle IPFS-based content archives for decentralized storage and retrieval.

Multi-Party Disputes¶

Process complex arbitration scenarios with multiple parties and evidence sources.

Testing & Development¶

Use the library's testing utilities for developing Verdikta-compatible applications.

Core Concepts¶

Manifests¶

JSON configuration files that define arbitration cases, including: - Primary query definitions - Supporting file references
- Jury parameter configurations - Multi-party content organization

Multi-CID Support¶

Handle arbitration cases that involve multiple content archives: - Primary disputes with rebuttals - Complex evidence chains - Hierarchical content organization

IPFS Integration¶

Seamless blockchain storage integration: - Content addressing via CIDs - Automatic retry and fallback - Local caching for performance

Getting Started¶

Choose your path:

Latest Updates¶

Community & Support¶

• GitHub: verdikta/verdikta-common
• Issues: Report bugs and request features on GitHub
• Documentation: Complete guides and API reference available here

Ready to start building with Verdikta? Check out the Quick Start Guide or explore the API Reference.