Overview

Library for data integrity, signing, verifiable credentials, and content-addressable storage.

This crate provides tools for creating tamper-evident data structures using cryptographic hashing, digital signatures, and W3C standards like Verifiable Credentials and JSON-LD.

Static Contexts

The static_contexts/ directory contains JSON-LD context documents that define the vocabulary and semantics for the Integrity Fabric. These contexts enable interoperable, machine-readable metadata using linked data standards.

The schema is defined in https://github.com/eqtylab/integrity-schema

Structure

• http/ - W3C standard contexts cached locally for offline processing:

  • W3C Verifiable Credentials v1 and v2
  • W3C DID (Decentralized Identifiers) v1
  • W3C Security vocabularies v1 and v2

• cid/ - Custom Integrity Graph contexts stored by their content identifiers (CIDs):

  • Domain-specific terms for data lineage and provenance
  • Custom types like MetadataRegistration, ComputeRegistration, DataRegistration
  • Verifiable metadata schemas for the Integrity Fabric

Usage

The Integrity Graph common context is referenced in code via:

use integrity::json_ld::ig_common_context_link;

let context_urn = ig_common_context_link();
// Returns: "urn:cid:bafkr4ibtc72t26blsnipjniwpoawtopufixoe7bbloqk7ko65cizgnhgnq"

These contexts are embedded at compile time and used by the JSON-LD processor to:

• Expand compact JSON-LD documents to their canonical form
• Resolve context references without network requests
• Ensure deterministic content addressing of linked data

Regenerating Contexts

To update the static contexts (e.g., after schema changes):

just update-static-contexts

This downloads the latest W3C contexts and regenerates the CID-indexed files.

FFI (C ABI)

The crate includes a stable C ABI surface in src/ffi/ for SDK bindings (including the Go SDK). FFI is feature-gated and enabled with --features ffi.

• Public header: include/integrity_ffi.h
• ABI version functions:
  • ig_abi_version_major
  • ig_abi_version_minor
  • ig_abi_version_patch
  • ig_abi_version_string
• Runtime and handle model:
  • Create one runtime with ig_runtime_new
  • Create and reuse opaque handles (signers, blob stores)
  • Release memory with ig_string_free, ig_error_free, ig_bytes_free
  • Release handles with their corresponding *_free function

The current ABI version is 0.2.0.

Native Artifact Releases

GitHub Actions can publish prebuilt native FFI artifacts for each supported system:

• Linux x86_64 (libintegrity.so)
• macOS 13 x86_64 (libintegrity.dylib)
• macOS 14 aarch64 (libintegrity.dylib)
• macOS 15 x86_64 (libintegrity.dylib)
• macOS 15 aarch64 (libintegrity.dylib)
• Windows x86_64 (integrity.dll plus import library when produced)

Workflow: .github/workflows/release-native-ffi.yml

• Push a version tag like v0.2.0 to build and attach release assets to that GitHub Release.
• Use workflow_dispatch to run the build matrix and collect workflow artifacts without publishing a Release.

Build native FFI artifacts locally:

cargo build --release --locked --features ffi

Development

Nix flake creates a dev environment with all the dependencies.

prek is used for formatting and linting.

Just Commands

The project uses Just for common development tasks.

Available recipes:
    build                  # Build the project for native target
    build-wasm             # Build WebAssembly package with wasm-pack
    ci                     # Run all CI checks (format, build, lint, test)
    fix                    # Auto-fix clippy warnings where possible
    fmt                    # Format Rust code using rustfmt
    fmt-check              # Check if code is formatted correctly without modifying files
    lint                   # Run clippy lints to check code quality
    lint-docs              # Check that all public items have documentation
    pre-commit             # Run all prek pre-commit hooks on all files
    readme-check           # Check if README.md is up to date with auto-generated content
    readme-update          # Update README.md with auto-generated content (Justfile commands, etc.)
    test                   # Run unit tests with cargo
    test-wasm              # Run WASM tests in Node.js and browsers (Chrome, Firefox) Note: for macOS test Safari with --safari
    update-static-contexts # Rebuild static JSON-LD context files