🚀 VLayer Web Proof

vLayer proof mechanism - inspired by vlayer's rust repository.

📋 Project Structure

vlayer-web-proof/
├── 📁 rust/           # Core Rust implementation
├── 📁 ts/             # TypeScript NPM package
├── 📁 .github/        # CI/CD workflows
└── 📄 README.md       # This file

🎯 Features

• ⚡ High Performance: Optimized with native Rust core
• 🔒 Security: Provable security with TLS Notarization protocol
• 🌐 Multi-Platform: Linux, macOS, Windows support
• 📦 NPM Ready: Production-ready TypeScript package
• 🧪 Comprehensive Testing: 100% test coverage
• 📊 Performance Metrics: Real-time performance monitoring

🚀 Quick Start

NPM Package (Recommended)

npm install vlayer-web-proof

import { webProof } from 'vlayer-web-proof';

const result = await webProof('https://api.example.com/data',{
    notary_url: "http://0.0.0.0:7047",
    headers: {
        "Content-Type": "application/json",
        "Authorization": "Bearer 1234567890"
    }
});
console.log('Proof:', result.proof);

Rust Library

cd rust/
cargo add vlayer-web-proof

use vlayer_web_proof::simple_web_proof;

let proof = simple_web_proof("notary.vlayer.xyz", 7047, "https://api.example.com").await?;

📁 Project Details

🦀 Rust Core (/rust/)

• Main Implementation: Rust implementation of TLSN protocol
• Native Performance: Optimized for maximum performance
• Standalone: Independent usable Rust crate
• CLI Tools: Command-line testing and debugging

Features:

• ✅ Async web proof generation
• ✅ All HTTP methods support
• ✅ Customizable headers
• ✅ CLI interface
• ✅ Comprehensive test suite

🟦 TypeScript Package (/ts/)

• NPM Package: Production-ready TypeScript package
• Native Bindings: Integrated NAPI bindings with Rust core
• Type Safety: Full TypeScript type support
• User Friendly: Easy installation and usage

Features:

• ✅ Dual ESM/CommonJS builds
• ✅ TypeScript definitions
• ✅ Performance monitoring
• ✅ Graceful fallbacks
• ✅ User-friendly error messages

🛠️ Development

Rust Development

cd rust/
cargo build --release
cargo test
cargo run --example cli test

TypeScript Development

cd ts/
npm install
npm run build
npm test
npm run lint

Package Creation

cd ts/
npm run build
npm pack

📊 Performance

• Package Size: 4.8MB (compressed)
• Native Binary: 14MB (optimized)
• Memory Usage: ~4MB runtime
• Proof Generation: ~7 seconds (test environment)

🌍 Platform Support

Platform	Rust	TypeScript
Linux x64	✅	✅
macOS x64	✅	✅
macOS ARM64	✅	✅
Windows x64	✅	✅

📚 Documentation

• 📖 Rust API Documentation
• 📖 TypeScript API Documentation

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push your branch (git push origin feature/amazing-feature)
5. Create a Pull Request

🆘 Support

• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Discussions
• 📧 Email: 0xkutluer@proton.me
• 💬 Discord: batikankutluer

🎯 Roadmap

• Rust core implementation
• TypeScript NPM package
• Cross-platform binaries
• Comprehensive testing
• Documentation website
• Advanced proof verification tools
• Browser compatibility
• Performance optimizations

---

Developed by Batıkan Kutluer • github.com/batikankutluer