Property Data Trust Framework

This repository serves as the central source for the Property Data Trust Framework (PDTF), providing:

📋 Key Components

1. Specifications & Documentation

2. Verifiable Data Registry

3. Tools & Utilities


🔍 Why This Registry?

Property transactions involve multiple parties and require verifiable data such as:

This registry serves as a trusted source of truth for:


✅ Features


📂 Directory Structure

.
├── docs/                      # Specifications and guides (source)
│   ├── governance.md          # Trust framework governance
│   ├── *.md                   # Implementation guides & specs
├── public/                    # Static site content & registry
│   ├── .well-known/
│   │   └── did.json          # DID document
│   ├── schemas/              # Credential schemas
│   │   └── epc-certificate.jsonld
│   ├── status/               # Bitstring revocation lists
│   │   └── test-2024-revocation-list.json
│   ├── trusted-issuers-registry.json    # Trusted issuer registry
│   └── web/                  # Auto-generated HTML documentation
│       ├── index.html        # Documentation home page
│       ├── governance.html   # HTML version of docs
│       └── *.html            # Other documentation pages
├── examples/                  # Example code and utilities
└── .github/workflows/         # CI/CD workflows
    └── build-docs.yml        # Auto-builds HTML from markdown

📦 NPM Package

Installation

npm install @pdtf/trust-framework

Usage

const { validateCredential } = require("@pdtf/trust-framework");

// Validate a credential against a schema
const result = await validateCredential(credential, "epc-certificate");

if (result.valid) {
  console.log("Credential is valid");
} else {
  console.log("Validation errors:", result.errors);
}

Exports


🧠 Getting Started

For Framework Participants

  1. Review the governance documentation in /docs/governance.md
  2. Follow the implementation guides for your use case
  3. Use the example code to integrate with your systems

For Developers

  1. Explore the specification documents in /docs/
  2. Check example implementations in /examples/
  3. Test your integration using the provided utilities

For Contributors

  1. Read the contribution guidelines
  2. Submit issues for bugs or feature requests
  3. Create pull requests for improvements

📚 Resources