vcp-explorer-api
VCP Explorer
Official GUI for the VeritasChain Protocol
Features • Quick Start • Documentation • Contributing
Overview
VCP Explorer is the official graphical interface for exploring, verifying, and auditing VeritasChain Protocol (VCP) events. Built for regulatory compliance officers, algorithmic traders, and audit professionals.
“Verify, Don’t Trust” — Every cryptographic proof can be independently verified client-side.
🌐 Live Demo: veritaschain.org/explorer/app/
Features
Core Functionality
| Feature | Description |
|---|---|
| 🔍 Event Search | Query events by ID, type, symbol, or time range |
| ✅ Merkle Verification | Client-side RFC 6962 proof validation |
| 🔗 Chain Visualization | Interactive SIG→ORD→ACK→EXE lifecycle |
| 📄 Certificates | Export compliance certificates as PDF |
Monitoring
| Feature | Description |
|---|---|
| 🛡️ Integrity Alerts | Merkle mismatch, chain breaks, timestamp violations |
| 📊 Usage Monitoring | API quota and rate limit warnings |
| 🔔 Notifications | Real-time system and event alerts |
Internationalization
| 🇺🇸 English | 🇯🇵 日本語 | 🇨🇳 中文 | 🇪🇸 Español | 🇩🇪 Deutsch | 🇫🇷 Français | 🇨🇿 Čeština | |————|———-|———|————|————|————-|————-|
Quick Start
Prerequisites
- Node.js 18+
- npm 9+
Installation
# Clone the repository
git clone https://github.com/veritaschain/vcp-explorer.git
cd vcp-explorer
# Install dependencies
npm install
# Start development server
npm run dev
Open http://localhost:5173 in your browser.
Build for Production
npm run build
Output will be in the dist/ directory.
Configuration
Environment
Create .env.local for local configuration:
VITE_API_BASE_URL=https://explorer.veritaschain.org/api/v1
Subdirectory Deployment
For deployment to a subdirectory, update vite.config.ts:
export default defineConfig({
base: '/explorer/app/',
// ...
});
Project Structure
vcp-explorer/
├── src/
│ ├── components/
│ │ ├── features/ # Feature-specific components
│ │ ├── layout/ # Header, Sidebar, Layout
│ │ └── ui/ # Reusable UI components
│ ├── i18n/
│ │ ├── locales/ # Translation files (7 languages)
│ │ └── index.ts # i18n configuration
│ ├── lib/
│ │ ├── api-client.ts # API integration
│ │ └── crypto.ts # Cryptographic utilities
│ ├── pages/ # Route components
│ ├── types/ # TypeScript definitions
│ └── App.tsx # Application root
├── public/
│ └── vcp-logo.svg
├── dist/ # Production build output
└── package.json
Technology Stack
| Category | Technology |
|---|---|
| Framework | React 18 |
| Language | TypeScript |
| Styling | TailwindCSS |
| Build | Vite 5.4 |
| Routing | React Router |
| i18n | react-i18next |
| Icons | Lucide React |
| Crypto | Web Crypto API |
API Reference
VCP Explorer connects to the VCP Explorer API:
| Endpoint | Method | Description |
|---|---|---|
/events |
GET | List events |
/events/:id |
GET | Get event by ID |
/events/:id/proof |
GET | Get Merkle proof |
/chain/:trace_id |
GET | Get event chain |
/verify |
POST | Verify proof |
/certificates/:id |
GET | Get certificate |
See API Documentation for details.
Browser Support
| Browser | Version |
|---|---|
| Chrome | 90+ |
| Firefox | 88+ |
| Safari | 14+ |
| Edge | 90+ |
Documentation
Contributing
We welcome contributions! Please see CONTRIBUTING.md for guidelines.
Development Workflow
- Fork the repository
- Create a feature branch:
git checkout -b feature/my-feature - Make your changes
- Run tests:
npm run test - Submit a pull request
Code Style
- ESLint + Prettier configuration included
- Run
npm run lintbefore committing
License
Apache License 2.0
Copyright © 2025 VeritasChain Standards Organization (VSO)
See LICENSE for details.
Related Projects
| Project | Description |
|---|---|
| vcp-spec | VCP Specification v1.0 |
Support
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: support@veritaschain.org
VeritasChain Standards Organization
"Encoding Trust in the Algorithmic Age"
veritaschain.org