Heirloom - Digital Inheritance Platform 🏛️

A comprehensive blockchain-based digital inheritance and emergency planning platform built on Aptos, enabling secure transfer of digital assets, documents, and cryptocurrency to beneficiaries through automated heartbeat monitoring and witness verification.

🌟 Overview

Heirloom provides a decentralized solution for digital inheritance planning, allowing users to create emergency plans that automatically trigger asset transfers to designated beneficiaries when certain conditions are met (missed heartbeats, witness confirmation, or manual triggers).

🏗️ Project Structure

Rentsplit/
├── heirloom-contracts/          # Aptos Move Smart Contracts
│   ├── sources/                 # Smart contract source code
│   ├── Move.toml               # Move package configuration
│   └── README.md               # Contract documentation
├── rentsplit-frontend/         # Next.js Frontend Application
│   ├── src/                    # Source code
│   ├── public/                 # Static assets
│   ├── package.json            # Node.js dependencies
│   └── README.md               # Frontend documentation
└── README.md                   # This file

✨ Key Features

🔐 Digital Asset Management

• Cryptocurrency Wallets: Store recovery phrases and private keys securely
• Important Documents: PDFs, images, legal documents via IPFS
• Passwords & Credentials: Encrypted storage of account information
• Digital Certificates: SSL certificates, API keys, domain ownership
• Personal Notes: Medical information, family messages, instructions

👥 Beneficiary Management

• Multiple Beneficiaries: Support for unlimited beneficiaries with percentage allocation
• Relationship Tracking: Define relationships (spouse, child, friend, etc.)
• Verification Requirements: Optional verification codes for enhanced security
• Emergency Contacts: Backup communication channels

💓 Heartbeat Monitoring

• Customizable Frequency: Set heartbeat intervals (1-365 days)
• Grace Periods: Configurable grace periods before triggering
• Automatic Triggers: Plans activate when heartbeats are missed
• Status Tracking: Real-time monitoring of plan status

👁️ Witness System

• Witness Verification: Trusted parties can confirm triggers
• Manual Triggers: Emergency activation by authorized witnesses
• Multi-signature Support: Enhanced security through witness consensus

🔒 Security Features

• Encryption: End-to-end encryption for sensitive data
• IPFS Integration: Decentralized file storage
• Access Controls: Role-based permissions and authorization
• Audit Trail: Complete transaction and event history

🚀 Quick Start

Prerequisites

• Node.js 18+ and npm/yarn
• Aptos CLI
• Git

1. Clone the Repository

git clone <repository-url>
cd Rentsplit

2. Smart Contract Setup

cd heirloom-contracts
aptos init --profile heirloom --network testnet
aptos account fund-with-faucet --profile heirloom
aptos move compile
aptos move publish --profile heirloom

3. Frontend Setup

cd ../rentsplit-frontend
npm install
npm run dev

4. Access the Application

Open http://localhost:3000 in your browser.

📱 User Journey

Creating an Emergency Plan

1. Connect Wallet: Link your Aptos wallet (Petra recommended)
2. Plan Details: Set name, description, and trigger conditions
3. Add Beneficiaries: Define beneficiaries with percentage allocations
4. Asset Management: Upload documents, store credentials, add crypto assets
5. Heartbeat Setup: Configure monitoring frequency and grace periods
6. Deploy Plan: Smart contract deployment with all configurations

Managing Your Plan

• Send Heartbeats: Regular check-ins to maintain plan status
• Update Assets: Modify documents, credentials, and allocations
• Monitor Status: Track heartbeat history and plan health
• Emergency Triggers: Manual activation when needed

Beneficiary Experience

• Notification: Automatic alerts when plans are triggered
• Verification: Complete any required verification steps
• Asset Access: Secure access to inherited digital assets
• Claim Process: Blockchain-verified inheritance claims

🛠️ Technology Stack

Smart Contracts

• Aptos Move: Smart contract development
• Aptos Framework: Blockchain infrastructure
• Event System: Real-time notifications
• Resource Management: Secure state management

Frontend

• Next.js 15: React framework with App Router
• TypeScript: Type-safe development
• Tailwind CSS: Utility-first styling
• Aptos Wallet Adapter: Wallet integration
• React Hooks: State management

Infrastructure

• IPFS: Decentralized file storage
• Aptos Testnet: Blockchain network
• Vercel: Frontend deployment
• GitHub: Version control

📊 Smart Contract Architecture

Core Modules

• Heirloom Module: Emergency plan management
• Asset Manager: Digital asset handling
• Event System: Real-time notifications

Key Functions

• create_emergency_plan(): Deploy new inheritance plans
• send_heartbeat(): Maintain plan activity
• trigger_emergency_plan(): Activate inheritance
• claim_inheritance(): Beneficiary asset claims

Data Structures

• EmergencyPlan: Complete plan configuration
• Beneficiary: Heir information and allocations
• Asset: Digital asset metadata and access
• Heartbeat: Activity monitoring records

🔧 Configuration

Environment Variables

NEXT_PUBLIC_NETWORK=testnet
NEXT_PUBLIC_CONTRACT_ADDRESS=0x...
NEXT_PUBLIC_IPFS_GATEWAY=https://ipfs.io/ipfs/

Contract Addresses

• Testnet: 0xd839b90e74e58b2f362c047e40cff83771ec39c9e54023c33327dc4bda5bebc5
• Mainnet: Coming soon

🧪 Testing

Smart Contract Tests

cd heirloom-contracts
aptos move test

Frontend Tests

cd rentsplit-frontend
npm test
npm run test:e2e

📚 Documentation

• Smart Contract Documentation
• Frontend Documentation
• API Reference
• User Guide

🤝 Contributing

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

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🚨 Security Notice

This is experimental software. Use at your own risk. Always:

• Test thoroughly on testnet before mainnet deployment
• Keep private keys secure and backed up
• Verify all transactions before signing
• Use strong encryption for sensitive data

🆘 Support

• Documentation: Check the docs/ directory
• Issues: GitHub Issues for bug reports
• Discussions: GitHub Discussions for questions
• Security: Email security@heirloom.example for vulnerabilities

🗺️ Roadmap

Phase 1 (Current)

• ✅ Core smart contract development
• ✅ Basic frontend interface
• ✅ Wallet integration
• ✅ Emergency plan creation

Phase 2 (Next)

• 🔄 Enhanced UI/UX
• 🔄 Mobile application
• 🔄 Advanced encryption
• 🔄 Multi-chain support

Phase 3 (Future)

• 📋 Legal compliance tools
• 📋 Professional integrations
• 📋 Insurance partnerships
• 📋 Enterprise features

💎 Built With Love

Created with ❤️ for the future of digital inheritance and asset protection.

---

Note: This is a proof-of-concept implementation. Always consult with legal professionals for inheritance planning and ensure compliance with local regulations.