posture: 001110
dims: memory connection computation
by: keeper
Implementation Roadmap
Integration checklist and progress tracking
Overview
This roadmap tracks your progress through building the Proverb Revelation Protocol. Mark items as you complete them to maintain clear visibility of what's done and what's next.
Estimated Timeline: 3-4 weeks from setup to production
Phase 0: Prerequisites (1-2 days)
System Setup
- Ubuntu 20.04+ installed (or WSL2)
- Build essentials installed
- Git installed and configured
- 50GB+ storage available
Tool Installation
- Rust installed (v1.70+)
- Node.js 20 installed
- Python 3.8+ installed
- PostgreSQL 12+ installed
Account Creation
- Nillion Discord account
- Nillion API key requested
- NEAR Cloud AI account created
- NEAR Cloud AI API key generated
- Pinata account created
- Pinata JWT obtained
Project Structure
- Main directory created:
~/proverb-protocol - Subdirectories created:
oracle-swordsman,mage-agent,scripts,logs,spellbook - Git repository initialized
-
.gitignoreconfigured -
.envfile created
Verification
-
rustc --versionshows 1.70+ -
node --versionshows v20.x -
psql --versionshows 12+ - All API keys saved in
.env
Status: โฌ Not Started | ๐ In Progress | โ Complete
Phase 1: Foundation (Week 1)
Database Setup
- PostgreSQL service running
- Database user created:
proverb_user - Database created:
proverb_protocol - Schema applied successfully
- Test connection successful
- All tables created:
-
submissions -
verifications -
inscriptions -
spellbook_acts -
oracle_status
-
- Views created:
-
submission_pipeline -
proverb_stats
-
- Indexes created
Zcash Setup
-
zecwallet-cliinstalled - Wallet directory created
- Light client synced (testnet)
- Transparent address generated
- Shielded address generated
- Testnet ZEC received from faucet
- Balance confirmed
Spellbook Creation
-
spellbook-acts.jsoncreated - Spellbook uploaded to Pinata
- IPFS CID obtained
- CID added to
.env - Spellbook accessible via gateway
- Content validated
Oracle Swordsman Project
- TypeScript project initialized
- Dependencies installed:
-
@nillion/client-web -
axios -
pg -
dotenv -
winston
-
-
tsconfig.jsonconfigured -
package.jsonscripts added -
src/directory structure created
Core Modules Created
-
src/config.ts- Configuration management -
src/database.ts- Database operations -
src/zcash-client.ts- Zcash wrapper -
src/logger.ts- Winston logger
Foundation Testing
- Configuration loads correctly
- Database connection works
- Zcash client connects
- Can create test submission
- Can query database
- Logs are being written
Week 1 Deliverables:
- โ All tools installed and configured
- โ Database operational
- โ Zcash wallet synced with testnet ZEC
- โ Basic project structure in place
Status: โฌ Not Started | ๐ In Progress | โ Complete
Phase 2: Backend Integration (Week 2)
IPFS Integration
-
src/ipfs-client.tscreated - Can fetch spellbook from IPFS
- Caching implemented
- Error handling added
- Test: Fetch spellbook successfully
- Test: Cache working
NEAR Cloud AI Integration
-
src/near-verifier.tscreated - Can call verification API
- Response parsing works
- Fallback verification implemented
- Retry logic added
- Test: Verify sample proverb
- Test: Fallback triggers on error
Nillion Integration
-
src/nillion-signer.tscreated - Nillion SDK installed
- Client initialized
- Test: Can connect to Nillion
- SecretSigner: Key stored
- SecretSigner: Can sign test message
- Attestation retrieved
- Attestation verified
Main Oracle Loop
-
src/index.tscreated - Transaction monitoring implemented
- Memo parsing working
- Submission creation functional
- IPFS fetching integrated
- AI verification integrated
- Database updates working
- Error handling comprehensive
- Logging comprehensive
Transaction Processing
- Can detect new Zcash transactions
- Extracts tracking code from memo
- Extracts proverb from memo
- Creates submission record
- Fetches spellbook from IPFS
- Calls NEAR Cloud AI for verification
- Records verification result
- Updates submission status
Transaction Signing
- Public inscription transaction created
- Private shielded transaction created
- 61.8/38.2 golden ratio split calculated correctly
- Network fee included
- Both transactions signed
- Both transactions broadcast
- Confirmation monitoring working
End-to-End Test
- Send test transaction with memo
- Oracle detects transaction
- Proverb extracted correctly
- Verification completes
- Inscription transactions created
- Both transactions confirmed
- Database records complete
Week 2 Deliverables:
- โ Complete backend working
- โ TEE integration functional
- โ AI verification operational
- โ End-to-end test passing
Status: โฌ Not Started | ๐ In Progress | โ Complete
Phase 3: Frontend Development (Week 3)
Mage Agent Setup
- Next.js project initialized
- TypeScript configured
- Tailwind CSS installed
- Dependencies installed:
-
axios -
qrcode.react
-
- Project structure created
API Routes
-
/api/submitendpoint created -
/api/status/:codeendpoint created -
/api/statsendpoint created - Database connection in API routes
- Error handling in place
- CORS configured
Main Page
-
app/page.tsxcreated - Proverb submission form
- Character counter
- Validation (min/max length)
- Submit button functionality
Payment Display
- Payment address shown
- Amount displayed (0.01 ZEC)
- Memo text displayed
- QR code generated
- Copy buttons for address/memo
- Mobile responsive
Status Tracking
- Status polling implemented
- Status display (pending/verified/inscribed)
- Quality score display
- Matched act display
- Reasoning text display
- Blockchain link (when inscribed)
- Auto-refresh until complete
AI Writing Assistance (Optional)
- "Get AI Help" button
- AI suggestion modal
- Calls NEAR Cloud AI for suggestions
- User can accept/edit suggestions
- Loading states
Styling & UX
- Mobile responsive design
- Loading spinners
- Error messages
- Success notifications
- Smooth transitions
- Accessibility (ARIA labels)
Testing
- Can submit proverb
- Payment info displays
- QR code renders
- Status updates correctly
- Quality score shows
- Links work
- Mobile view works
Week 3 Deliverables:
- โ Complete user interface
- โ Payment flow working
- โ Status tracking functional
- โ Mobile responsive
Status: โฌ Not Started | ๐ In Progress | โ Complete
Phase 4: Production Deployment (Week 4)
Pre-Deployment Testing
- End-to-end test on testnet
- Multiple proverbs processed
- All inscriptions confirmed
- 61.8/38.2 golden ratio split verified
- Quality scores accurate
- No errors in logs
- Performance acceptable
Security Hardening
- Environment variables secured
- API keys not in code
- Database credentials encrypted
- HTTPS configured
- CORS properly restricted
- Input validation comprehensive
- SQL injection prevented
- Rate limiting implemented
Production Configuration
- Mainnet Zcash addresses generated
- Mainnet wallet synced
- Production database created
- Production schema applied
- Production
.envconfigured - Nillion production API key
- NEAR Cloud AI production tier
Oracle Deployment
- Production build created
- Systemd service file created
- Service installed
- Service started
- Service auto-starts on boot
- Logs rotating properly
Frontend Deployment
- Production build created
- Nginx configured
- SSL certificate installed
- Domain name configured
- Deployed and accessible
- Performance optimized
Monitoring Setup
- Logging configured
- Error tracking
- Uptime monitoring
- Zcash balance alerts
- Database space monitoring
- API response time tracking
Backup Strategy
- Database backup script
- Automated daily backups
- Wallet backup secured
- Recovery procedure documented
- Test restore successful
Documentation
- Deployment guide written
- Troubleshooting guide written
- Maintenance procedures documented
- API documentation complete
- User guide created
Launch Checklist
- All tests passing
- Security audit complete
- Backups configured
- Monitoring active
- Team trained
- Support channels ready
Post-Launch
- First 10 proverbs processed
- No critical errors
- Performance metrics good
- User feedback positive
- Monitoring showing green
- Ready for scale
Week 4 Deliverables:
- โ Production system live
- โ All monitoring active
- โ Documentation complete
- โ Successfully processing proverbs
Status: โฌ Not Started | ๐ In Progress | โ Complete
Integration Status Matrix
Core Components
| Component | Setup | Development | Testing | Integration | Production |
|---|---|---|---|---|---|
| PostgreSQL | โฌ | โฌ | โฌ | โฌ | โฌ |
| Zcash Light Client | โฌ | โฌ | โฌ | โฌ | โฌ |
| Nillion TEE | โฌ | โฌ | โฌ | โฌ | โฌ |
| NEAR Cloud AI | โฌ | โฌ | โฌ | โฌ | โฌ |
| IPFS/Pinata | โฌ | โฌ | โฌ | โฌ | โฌ |
| Oracle Backend | โฌ | โฌ | โฌ | โฌ | โฌ |
| Mage Frontend | โฌ | โฌ | โฌ | โฌ | โฌ |
Legend: โฌ Not Started | ๐ In Progress | โ Complete
Data Flow Verification
Complete Transaction Path
User Submission โฌ
- User writes proverb
- Generates tracking code
- Sends 0.01 ZEC with memo
Transaction Detection โฌ
- Oracle monitors Zcash
- Detects incoming transaction
- Extracts memo data
Submission Creation โฌ
- Parses tracking code
- Parses proverb text
- Creates database record
Knowledge Fetch โฌ
- Fetches spellbook from IPFS
- Caches locally
- Validates structure
AI Verification โฌ
- Calls NEAR Cloud AI API
- Receives quality score
- Records reasoning
Verification Storage โฌ
- Saves to database
- Updates submission status
- Logs result
Transaction Preparation โฌ
- Calculates 61.8/38.2 golden ratio split
- Creates inscription memo
- Prepares both transactions
Signing โฌ
- Requests Nillion signature
- Both transactions signed
- Signatures validated
Broadcasting โฌ
- Broadcasts public transaction
- Broadcasts private transaction
- Records TXIDs
Confirmation โฌ
- Monitors for confirmations
- Updates inscription record
- Notifies user
All 10 Steps Working: โฌ Yes | โฌ No
Cost Tracking
Monthly Costs (Production)
| Item | Estimated | Actual | Notes |
|---|---|---|---|
| VPS | $24/month | DigitalOcean/AWS | |
| Nillion | $50/month | TEE compute | |
| NEAR Cloud AI | $0.03/proverb | Variable | |
| Pinata | $20/month | IPFS pinning | |
| Domain | $1/month | Optional | |
| SSL | $0 | Let's Encrypt | |
| Monitoring | $0 | Self-hosted | |
| Total Fixed | $95/month | ||
| Total Variable | $0.03/proverb |
At 100 proverbs/month: ~$98 total
Performance Metrics
Target Metrics
| Metric | Target | Current | Status |
|---|---|---|---|
| Submission โ Inscription | <3 minutes | โฌ | |
| AI Verification | <5 seconds | โฌ | |
| IPFS Fetch | <2 seconds | โฌ | |
| Database Query | <100ms | โฌ | |
| Uptime | >99% | โฌ | |
| Error Rate | <1% | โฌ |
Known Issues
Open Issues
- Issue 1: [Description]
- Issue 2: [Description]
- Issue 3: [Description]
Resolved Issues
- Issue: [Description] - Resolved: [Date] - Solution: [Description]
Future Enhancements
Phase 5: Advanced Features (Post-Launch)
- Multi-language support
- Proverb archive browser
- Search by quality score
- Leaderboard (top proverbs)
- Social sharing
- Email notifications
- Webhook support
- Analytics dashboard
Phase 6: Scaling (Month 2+)
- Multiple Oracle instances
- Load balancing
- CDN for frontend
- Database read replicas
- Caching layer (Redis)
- Batch processing optimization
Phase 7: New Features (Month 3+)
- NFT minting option
- Community voting
- Proverb challenges
- AI training on best proverbs
- API for third parties
- Mobile app
Weekly Progress Tracker
Week 1: Foundation
Goal: Database + Zcash operational
Status: โฌ Not Started | ๐ In Progress | โ
Complete
Blockers: [None]
Notes: [Add notes here]
Week 2: Backend
Goal: Complete Oracle with TEE + AI
Status: โฌ Not Started | ๐ In Progress | โ
Complete
Blockers: [None]
Notes: [Add notes here]
Week 3: Frontend
Goal: User interface complete
Status: โฌ Not Started | ๐ In Progress | โ
Complete
Blockers: [None]
Notes: [Add notes here]
Week 4: Production
Goal: Live system processing proverbs
Status: โฌ Not Started | ๐ In Progress | โ
Complete
Blockers: [None]
Notes: [Add notes here]
Success Criteria
MVP Success (First 10 Proverbs)
- All 10 submitted successfully
- All 10 verified by AI
- All 10 inscribed on blockchain
- Perfect 61.8/38.2 golden ratio split maintained
- Average quality score >0.7
- Zero critical errors
- <3 minute processing time
Production Success (First 100 Proverbs)
- 100 submissions processed
-
95% inscription success rate
- Average quality score >0.8
- <1% error rate
- 99%+ uptime
- Positive user feedback
- System stable and scalable
Deployment Timeline
Week 1 (Foundation)
โโ Day 1-2: Setup & Installation
โโ Day 3-4: Database + Zcash
โโ Day 5-6: Core modules
โโ Day 7: Testing & validation
Week 2 (Backend)
โโ Day 8-9: IPFS + NEAR Cloud AI
โโ Day 10-11: Nillion integration
โโ Day 12-13: Main oracle loop
โโ Day 14: End-to-end testing
Week 3 (Frontend)
โโ Day 15-16: Next.js setup + API routes
โโ Day 17-18: Submission UI
โโ Day 19-20: Status tracking
โโ Day 21: Testing + refinement
Week 4 (Production)
โโ Day 22-23: Security hardening
โโ Day 24-25: Deployment
โโ Day 26-27: Monitoring + docs
โโ Day 28: Launch! รฐลธลกโฌ
Daily Standup Template
Date: [YYYY-MM-DD]
Yesterday:
- [What did you complete?]
Today:
- [What will you work on?]
Blockers:
- [Any issues preventing progress?]
Notes:
- [Additional context]
Emergency Contacts
Services
- Nillion Support: Discord #developers
- NEAR Cloud AI Support: https://cloud.near.ai
- Pinata Support: team@pinata.cloud
- Zcash Community: Discord/Forum
Critical Procedures
- Oracle Down: Check logs, restart service
- Database Full: Expand storage, archive old data
- Zcash Sync Issue: Restart light client, check server
- API Rate Limit: Wait for reset, upgrade tier
Completion Certificate
Project: Proverb Revelation Protocol
Version: 4.0
Status: โฌ Complete
Sign-off:
- All phases complete
- All tests passing
- Production deployed
- Documentation complete
- Successfully processing proverbs
Completed by: [Your Name]
Date: [YYYY-MM-DD]
Congratulations on building a privacy-first protocol! ๐ก๏ธ๐ช๐ค
Quick Status Overview
Phase 0 (Prerequisites): โฌ Complete (__ / __ items)
Phase 1 (Foundation): โฌ Complete (__ / __ items)
Phase 2 (Backend): โฌ Complete (__ / __ items)
Phase 3 (Frontend): โฌ Complete (__ / __ items)
Phase 4 (Production): โฌ Complete (__ / __ items)
Overall Progress: __% complete
Estimated Completion: [Date]
Notes Section
Use this space for implementation notes, decisions, and discoveries:
[Add your notes here as you build]