Heira

Pronounced like the word "era" (ˈerə)

Automated and permissionless Web3 inheritance management.

Overview

Heira is a Web3 dApp for handling inheritances through escrow smart contracts. Users can create escrow contracts that automatically transfer their tokens to designated beneficiaries after a period of inactivity.

Features

Phase 1 (Implemented)

• ✅ Smart contract escrow system with factory pattern
• ✅ ENS name and avatar support
• ✅ Wallet connection (MetaMask, WalletConnect, Ledger)
• ✅ Multichain token balance display (Ethereum, Base)
• ✅ Chainlink price feeds integration
• ✅ Coinbase CDP Trade API integration
• ✅ Escrow creation UI
• ✅ Dashboard with countdown timers

Phase 2 (Implemented)

• ✅ Filecoin hosting (see FILECOIN_DEPLOYMENT.md)
• ✅ Backend API and keeper service (see backend/README.md)
• ✅ Fluence deployment

Phase 3 (WIP)

• ✅ BTC support
• AuditAgent verification (will be done after final changes to SCs)
• Coinbase Embedded Wallets
• World ID authentication

Project Structure

heira/
├── contracts/          # HardHat smart contracts
│   ├── InheritanceEscrow.sol
│   ├── InheritanceEscrowFactory.sol
│   └── test/
├── frontend/          # SvelteKit application (static site)
│   └── src/
│       ├── lib/       # Utilities (wallet, ENS, tokens, prices)
│       ├── components/
│       └── routes/
├── backend/           # Node.js API and keeper service
│   ├── src/
│   │   ├── routes/    # API endpoints
│   │   └── services/  # Keeper service for escrow monitoring
│   └── README.md
└── scripts/           # Deployment scripts

Quick Start

See QUICKSTART.md for a 5-minute setup guide.

Setup

Smart Contracts

cd contracts
npm install
cp .env.example .env
# Edit .env with your private key and RPC URLs
npx hardhat compile
npx hardhat test
npx hardhat run scripts/deploy.js --network sepolia

Frontend

cd frontend
npm install
cp .env.example .env
# Edit .env with API keys, factory addresses, and backend URL
npm run dev

Backend

cd backend
npm install
cp .env.example .env
# Edit .env with private key and network configuration
npm run dev

See backend/README.md for detailed backend setup instructions.

Testing & Deployment

See TESTING.md for detailed instructions on:

• Running tests
• Deploying contracts
• Testing the full flow
• Troubleshooting

Environment Variables

See contracts/.env.example, frontend/.env.example, and backend/.env.example for required environment variables.

Development

Running Tests

# Smart contracts
cd contracts
npx hardhat test

# Frontend type checking
cd frontend
npm run check

Deployment

1. Deploy factory contract to testnet/mainnet
2. Update frontend/.env with factory address and VITE_BACKEND_API_URL
3. Deploy backend API (see backend/README.md)
4. Build frontend: cd frontend && npm run build
5. Deploy to Filecoin: See FILECOIN_DEPLOYMENT.md

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

You may use, modify, and distribute this software under the terms of the AGPL-3.0. See the LICENSE file for details.

TL;DR: The AGPL-3.0 ensures that all changes and derivative works must also be licensed under AGPL-3.0, and that attribution is preserved. If you run a modified version as a network service, you must make the source code available to users. This code is provided as-is, without warranties.