filecoin-project / filecoin-project/devgrants

VaultProtocol: A Privacy-First Decentralized Notary System

Open
#2,101 0 comments 0 reactions 0 assignees View on GitHub
Open Grant
Dominant language
No language data
Stars
409
Forks
311
PR merge metrics
No merged PRs in 30d

Description

# Open Grant Proposal: VaultProtocol

## Project Overview

| Field | Details |
| :--- | :--- |
| **Project Name** | VaultProtocol |
| **Proposal Category** | Developer and data tooling |
| **Individual or Entity Name** | Algaz (Sole Founder & Architect) |
| **Proposer** | [magicorn62](https://github.com/magicorn62) |
| **Project Repo(s)** | [Vaultprotocol](https://github.com/magicorn62/vaultprotocol) |
| **Filecoin Ecosystem Affiliations** | None. While the current MVP utilizes Pinata for IPFS pinning to ensure reliability during development, the core architecture is designed to be storage-agnostic. The system decouples the encryption/anchoring logic from the specific storage provider, allowing for seamless integration with native Filecoin Storage Providers or other IPFS gateways in future iterations. |
| **Technical Sponsor** | N/A (No prior discussion). |
| **Open Source License Agreement** | **Yes**, I agree to open source all work done on behalf of this RFP under the MIT/Apache-2 dual-license. |

---

## Project Summary

**VaultProtocol** is a next-generation decentralized notary system designed to replace the traditional, often expensive, slow, and invasive process of human-mediated notarization with a fast, cheap, zero-trust, and private alternative.

By eliminating human intermediaries, VaultProtocol leverages mathematics, deliberate architecture, and decentralized consensus to provide an immutable chain of custody. This ensures stronger non-repudiation than traditional methods, as every act of notarization is cryptographically signed by the user’s wallet and anchored on a public blockchain.

## Impact

### Solving the Privacy Paradox in Decentralized Storage
The primary value of VaultProtocol lies in addressing the **privacy paradox of decentralized storage**. While IPFS and Filecoin offer immutable, censorship-resistant storage, they suffer from a critical flaw: **data visibility**.

Once a file is pinned via its Content Identifier (CID), that CID is public. Any user with the CID can download the content. This means sensitive documents (legal contracts, medical records, private intellectual property) cannot be stored on IPFS without leaking their existence or location to the entire network.

This project solves two major pain points:

1. **Data Integrity & Provenance:** It provides cryptographic proof of existence (timestamping) for files stored on IPFS, linking Identity and Signature immutably to a blockchain ledger to create a chain of custody (initially Hedera Testnet, with architecture ready for Filecoin/Ethereum). This prevents "hash swapping" where malicious actors replace the underlying asset while keeping the same CID.
2. **Privacy via Stealth CIDs:** Standard IPFS CIDs are public. If you store a sensitive file, anyone can download it if they have the CID. VaultProtocol introduces **"Stealth CIDs"**—encrypted representations of the actual IPFS hash that only the owner (holding the mask key) can decrypt to reveal the true storage location. This allows users to anchor proof of ownership without exposing the content or its exact storage path to the public ledger.

### Urgency in the Age of AI
This problem has become urgent as Large Language Models ingest vast amounts of public data for training. Unencrypted public storage exposes proprietary business logic, personal identity data, and confidential research to unauthorized model scraping. VaultProtocol solves this by enabling encrypted, private pinning, thereby unlocking high-value enterprise and healthcare sectors that were previously excluded from decentralized storage due to compliance and security risks.

---

### Outcomes
The benefit of getting this right is the creation of a **trustless, privacy-compliant layer for high-value data assets**. The risk of not addressing this is that enterprise and legal adoption of decentralized storage will remain hindered by fears of data leakage and inability to prove chain-of-custody.

Success looks like a robust SDK/API that allows any dApp to integrate "private notarization," enabling new verticals in:
* Legal Tech
* Medical Records
* IP Protection on the Decentralized Web

The final deliverable will be a production-grade decentralized notary system, hardened against real-world attacks, optimized for high-throughput transactions, and fully deployed on a mainnet environment (initially Hedera Mainnet or Ethereum Sepolia/Polygon). The project will transition from a testbed MVP to a robust service capable of handling enterprise-grade data volumes.

## Functionality

1. **Production-Grade Cryptographic Core (`vault-utils v2`):** Refactoring the existing crypto library to meet production security standards. This includes implementing secure memory clearing (to prevent key leakage in RAM), optimizing PBKDF2/Argon2 parameters for balance between security and performance, and adding rigorous fuzz testing to handle malformed inputs without crashing the client.
2. **Mainnet Deployment & Gas Optimization:** Deploying the `VaultNotary` smart contract on a mainnet-compatible environment (e.g., Hedera Mainnet or an EVM chain like Arbitrum One for lower gas costs). The smart contract will be optimized to minimize gas fees per transaction, ensuring scalability for high-volume users.
3. **Scalable Storage Abstraction Layer:** Decoupling the storage provider logic from Pinata-specific dependencies. The system will implement a modular **"Storage Adapter"** pattern that allows seamless switching between IPFS gateways, Filecoin Storage Providers (SPs), and other decentralized storage networks without changing the core application logic.
4. **Enterprise-Grade Verification Portal:** A polished, public-facing dApp with features for bulk verification, audit trail generation (JSON proofs), and API access for third-party developers to integrate notarization into their own workflows.

## Data Onboarding Projection

VaultProtocol acts as a gateway to decentralized storage. While the current MVP utilizes Pinata for reliability during early testing, the architecture is designed to seamlessly transition users to native IPFS Gateways and Filecoin Storage Providers (SPs). The metrics below reflect the projected volume of encrypted data stored on these networks as adoption grows.

| Timeframe | Projected Volume | Context |
| :--- | :--- | :--- |
| **Month 1**
Development & Beta Launch | ~50 MB – 100 MB | Initial testing by the dev team and small group of beta testers. Data consists primarily of small test files (PDFs, images, small code snippets) to validate encryption workflows and "Stealth CID" consistency. Storage currently utilizes Pinata (IPFS-pinned), serving as a baseline for future native integration. |
| **Month 3**
Developer Integration & Public Beta | ~500 MB – 1 GB | As `@vaultprotocol/core` is released to NPM, early partner dApps and indie creators begin integrating the SDK. User volume increases with medium-sized documents (contracts, source code archives, design assets). We aim to begin testing direct integration with a major Filecoin Storage Provider API for a subset of users, validating that data persists correctly via decentralized deals. |
| **Month 6**
Mainnet Migration & Scaling | ~5 GB – 10 GB | With the mainnet deployment on Hedera and optimization of gas/storage costs, we expect enterprise pilots to onboard larger datasets (e.g., medical records bundles, legal evidence packages). The "Storage Adapter" feature will be fully active, allowing users to choose Filecoin SPs for long-term persistence. This represents a significant shift from centralized pinning services to decentralized storage deals, contributing directly to network health. |
| **Month 12**
Ecosystem Growth & Enterprise Adoption | ~50 GB – 100 GB+ | By this stage, VaultProtocol aims to be the standard "Privacy Notary" layer for niche Web3 verticals (legal tech, digital rights management). With multiple dApp integrations and enterprise contracts, the cumulative volume of encrypted assets stored on IPFS/Filecoin networks will grow substantially. We project that a significant portion of this data will be actively committed to Filecoin Storage Providers via long-term deals, ensuring persistence and incentivizing network participation. |

### Success Metrics
* **Security Audit Completion:** The `vault-utils` library and Smart Contract undergo a formal static analysis or light external audit (using tools like Slither or Mythril) with zero critical/high vulnerabilities. All identified medium/low issues are resolved before mainnet deployment.
* **Mainnet Deployment Success:** Successfully deploy the notarization contract to the chosen mainnet/testnet environment, with at least 10 real-world transactions processed and verified by external users (non-team members), confirming end-to-end functionality in a live production environment.
* **Performance Benchmarking:** Demonstrate that the client-side encryption/decryption process completes within **<2 seconds** for files up to 50MB on standard consumer hardware, ensuring a smooth user experience at scale. Gas fees (where applicable) are optimized to remain below **$0.10 per transaction**.
* **Modularity Verification:** Successfully demonstrate the "Storage Adapter" pattern by swapping the backend from Pinata to a native IPFS node or Filecoin-compatible endpoint in **<5 minutes** of configuration, proving the system is ready for broader ecosystem integration (including Filecoin).

## Adoption, Reach, and Growth Strategies

### Target Audience
* **Legal & Compliance Tech:** Law firms and compliance officers who need to timestamp contracts, NDAs, or evidence without exposing the content publicly. They require immutable proof of existence (notary) but strict privacy.
* **IP & Creative Industries:** Artists, authors, and developers who need to prove ownership of digital assets or code repositories at a specific point in time without publishing the source code or file publicly.
* **Web3 Developers:** Builders looking for a "Privacy-Preserving Notary" SDK to integrate into their own dApps (e.g., a decentralized identity platform that needs to anchor user credentials privately).

### Growth Strategy: The "Tooling-First" Approach
Our primary growth engine is developer adoption. By releasing `vault-utils` as an open-source NPM package, we lower the barrier for entry for other projects. If 10 dApps integrate our SDK, those apps instantly gain access to our verification portal, driving organic traffic and user volume to VaultProtocol without direct marketing spend.

### Engagement Strategy
1. **Direct DMs & Beta Access:** I will personally reach out to 10 specific individuals in these communities who have publicly discussed issues with content theft or data privacy. I will provide them with exclusive "Early Adopter" status and direct support to ensure their first experience is flawless.
2. **GitHub Developer Outreach:** I will engage with open-source maintainers in privacy-focused repositories (e.g., IPFS, Filecoin, Zero-Knowledge groups). I will invite them to use `vault-utils` to anchor their repository hashes or sensitive configuration files as a test of the SDK’s reliability.
3. **"Proof of Creation" Campaign on Social Media:** I will launch a targeted campaign on Twitter/X and Discord communities focused on Web3 Art (e.g., Art Blocks, Foundation, Zora creators).

## Development Roadmap

The development of VaultProtocol is structured into three distinct phases, moving from a functional MVP to a production-grade, decentralized infrastructure tool.

### Phase 1: From MVP to Production-Ready Core Engine
* **Goal:** Transform the existing prototype into a secure, modular, and auditable NPM package (`@vaultprotocol/core`).
* **Objective:** Decouple the cryptographic logic from the monolithic `App.tsx` file and create a reusable library for other developers.
* **Key Actions:**
* Refactor `CryptoUtils` and Validators into a standalone TypeScript package with comprehensive type definitions.
* Implement secure memory handling to prevent key leakage in RAM.
* Optimize PBKDF2/Argon2 parameters for performance (<2s encryption on standard hardware).
* Conduct static security analysis (SonarQube/Snyk) and fix identified vulnerabilities.
* Publish the library to NPM with full documentation.
* **Outcome:** A developer-ready, secure SDK that users can import via `npm install @vaultprotocol/core`.

### Phase 2: Decoupling from Pinata & General IPFS Integration
* **Goal:** Remove hard dependencies on specific cloud providers (Pinata) and enable native support for any IPFS-compatible endpoint.
* **Objective:** Build a "Storage Adapter" pattern that allows users to choose their storage backend (e.g., local IPFS node, Web3.Storage, Pinata, or future Filecoin SPs) without changing core logic.
* **Key Actions:**
* Implement the `IStorageProvider` interface and develop standard adapters for:
* Generic IPFS Gateway: Using standard HTTP clients to pin to any public gateway.
* Web3.Storage / Pinata API: Maintaining legacy support for ease of migration.
* Refactor the frontend upload flow to allow dynamic selection of storage endpoints.
* Verify data integrity: Ensure that "Stealth CIDs" remain consistent regardless of where the file is pinned (IPFS vs. Pinata).
* **Outcome:** A fully decentralized storage layer that does not rely on a single third-party vendor, ensuring long-term resilience and censorship resistance.

### Phase 3: Mainnet Launch, Stability & Ecosystem Adoption
* **Goal:** Stabilize the Hedera-based system through rigorous bug fixing based on user feedback, followed by public launch and community outreach.
* **Objective:** Transition from Testnet to a stable production environment on Hedera, focusing on reliability, error handling, and real-world usability before expanding to other chains.
* **Key Actions:**
* **Stability & Bug Fixes:** Implement a feedback loop with early beta users to identify edge cases (e.g., network timeouts, large file failures) and patch them in the core library.
* **Mainnet Readiness:** Finalize the `VaultNotary` contract on Hedera Testnet for production-grade behavior, ensuring gas/fee estimates are accurate and transaction reverts are handled gracefully.
* **Public Verification Portal:** Launch a polished UI where anyone can verify asset integrity using a Stealth CID or Hash.
* **Adoption & Outreach:** Engage with Web3 communities, publish developer tutorials on GitHub, and gather feedback to iterate on the product roadmap for future multi-chain support.
* **Outcome:** A stable, bug-free notarization service available on Hedera, with an open-source SDK ready for ecosystem integration and a growing user base providing real-world validation.

---

## Milestones & Budget

### Milestone 1: Production Hardening & Security Audit of Core Engine
* **Focus:** Transforming the existing MVP’s cryptographic logic into a secure, auditable, NPM-publishable library (`@vaultprotocol/core`).
* **Functionality Expected After Completion:**
* **Modular Refactoring:** Extract `CryptoUtils` and Validators from `App.tsx` into a standalone TypeScript package with full type definitions and JSDoc documentation.
* **Secure Memory Handling:** Implement logic to ensure cryptographic keys and sensitive buffers are cleared from memory immediately after use, preventing extraction via memory dumps.
* **Performance Optimization:** Tune PBKDF2 iterations (600k+) to balance security with client-side performance, ensuring encryption/decryption of 50MB files completes in <2 seconds on standard hardware.
* **Comprehensive Unit Tests:** Add a test suite covering edge cases: corrupted files, invalid passwords, large payloads, and network timeouts.
* **Static Security Analysis:** Run the codebase through automated scanners (SonarQube/Snyk) to identify vulnerabilities. Provide a report showing zero critical/high issues.
* **Team & Roles:** Lead Full-Stack Developer; Security Consultant (Part-time).
* **Funding Required:** $5,000 USD
* **Timeframe:** 2-4 Weeks

### Milestone 2: Decoupling from Pinata & General IPFS Integration
* **Focus:** Removing hard dependencies on specific cloud providers (Pinata) and enabling native support for any IPFS-compatible endpoint via a "Storage Adapter" pattern.
* **Functionality Expected After Completion:**
* **Storage Adapter Pattern Implementation:** Create an `IStorageProvider` interface that allows swapping backends without changing core logic or the frontend UI significantly.
* **Generic IPFS Gateway Adapter:** Develop a standard adapter using `ipfs-http-client` or direct HTTP fetches to pin files to any public IPFS gateway (e.g., Pinata, Infura, or self-hosted nodes).
* **Legacy Support:** Maintain backward compatibility with the existing Pinata JWT flow for ease of migration.
* **Frontend Refactoring:** Update the upload UI to allow users to select their preferred storage endpoint (if multiple are configured) while keeping the "Stealth CID" masking logic intact.
* **Data Integrity Verification:** Prove that the Stealth CID generated is identical regardless of whether the file is pinned via Pinata or a generic IPFS gateway, ensuring consistency across providers.
* **Team & Roles:** Full-Stack Developer.
* **Funding Required:** $5,000 USD
* **Timeframe:** 3-4 Weeks

### Milestone 3: Mainnet Stability, Bug Fixes & Public Launch
* **Focus:** Stabilizing the Hedera-based system through rigorous bug fixing based on user feedback, followed by public launch and community outreach.
* **Functionality Expected After Completion:**
* **Stability & Bug Fixes:** Implement a feedback loop with beta users to identify and patch edge cases (e.g., transaction reverts, network timeouts, UI glitches). Ensure the `VaultNotary` contract interactions are robust on Hedera Testnet.
* **Mainnet Readiness Preparation:** Finalize gas/fee estimation logic for Hedera transactions to prevent user errors due to insufficient balance or incorrect fee assumptions.
* **Public Verification Portal Launch:** Deploy a polished, public-facing UI where anyone can verify an asset’s integrity by uploading a file (to check hash match) or entering a Stealth CID/Hash. Includes JSON audit trail downloads.
* **Documentation & SDK Release:** Finalize the `@vaultprotocol/core` NPM package with comprehensive README, integration examples for React/Node.js, and API references.
* **Community Outreach:** Establish a Discord channel, publish developer tutorials on GitHub, and gather initial user feedback to inform future roadmap items (like multi-chain support).
* **Team & Roles:** Full-Stack Developer; QA Tester / Community Manager (Part-time).
* **Funding Required:** $4,000 USD
* **Timeframe:** 3-4 Weeks

### (Optional) Milestone 4: Community Adoption & Long-Term Support Infrastructure
* **Focus:** Driving user adoption and establishing long-term maintenance processes.
* **Functionality Expected After Completion:**
* **Marketing Campaign:** Execute a targeted campaign to onboard the first 100 users (artists, developers, legal tech enthusiasts) using the public portal.
* **Feedback Integration Loop:** Set up an automated system for collecting user feedback and prioritizing bug fixes based on community votes/requests.
* **Long-Term Maintenance Plan:** Document a clear roadmap for post-grant development, including plans for eventual multi-chain support (EVM) once the Hedera base is fully stable.
* **Team & Roles:** Community Manager / Marketer; Lead Developer.
* **Funding Required:** $3,000 USD

## Total Budget Requested

**Total Funding Amount: $14,000 USD** ($17,000 USD with Growth Bracket)

The project will be maintained as an open-source utility. Long-term plans include:
* **Multi-Chain Support:** Adapting the anchoring logic to support Ethereum Mainnet/Testnets and potentially Filecoin (via FVM if applicable for smart contract interactions) or other EVM chains.
* **Advanced Privacy:** Exploring Zero-Knowledge Proof integrations to allow verification of file existence without revealing the Stealth CID structure itself in certain contexts.
* **Community Governance:** The core team will remain active on GitHub to address security patches and bug fixes for at least 1 year post-launch.

## Team Members

| Name | Role | Links |
| :--- | :--- | :--- |
| **Algaz** | Founder & Lead Architect | [GitHub](https://github.com/magicorn62) • [Project Repo](https://github.com/magicorn62/vaultprotocol) • [Live MVP](https://vaultprotocol-mu.vercel.app/) |

### Relevant Experience: Algaz
* **Ecosystem Immersion (2017–Present):** Active participant in the cryptocurrency and Web3 ecosystem since 2017. Deep intuitive understanding of decentralization philosophy, user psychology regarding wallets/gas fees, and security culture ("don't trust, verify").
* **From Concept to Functional MVP:** Systems engineering approach rooted in first-principles design. Successfully translated complex cryptographic concepts into a fully functional, production-ready prototype (`VaultProtocol`).
* **First-Principles Design:** Deconstructed the problem of proving data existence without revealing it, leading to the "Stealth CID" architecture.
* **Integration over Invention:** Leveraged battle-tested open-source libraries (`ethers.js`, `Web Crypto API`) while focusing engineering effort on unique masking and anchoring logic.
* **Rapid Prototyping:** Moved from concept to a live, testnet-deployed application in record time, validating the core value proposition for artists/developers needing privacy-preserving notarization.

### Why This Matters for VaultProtocol
My strength lies in system architecture and product-market fit. I understand what needs to be built and why it matters. For the next phase of development, I am seeking grant funding not just to code, but to bring on specialized talent (smart contract auditors and full stack engineers) to complement my architectural vision with enterprise-grade execution. This hybrid model—strong visionary architect + specialized technical team—is how high-impact Web3 tools are built.

**Team Code Repositories:**
* [Vaultprotocol](https://github.com/magicorn62/vaultprotocol)

## Additional Information

* **How did you learn about the Open Grants Program?:** Through research on decentralized storage solutions and Filecoin ecosystem opportunities.
* **Email for Grant Agreement & Next Steps:** defimwh@gmail.com

---

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.