oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity
Files
6ef15bfe5521d1b6ca2e8e6ebd8fb210ca33bbce
aitbc/docs/README.md
AITBC System b033923756 chore: normalize file permissions across repository 
- Remove executable permissions from configuration files (.editorconfig, .env.example, .gitignore)
- Remove executable permissions from documentation files (README.md, LICENSE, SECURITY.md)
- Remove executable permissions from web assets (HTML, CSS, JS files)
- Remove executable permissions from data files (JSON, SQL, YAML, requirements.txt)
- Remove executable permissions from source code files across all apps
- Add executable permissions to Python
2026-03-08 11:26:18 +01:00

181 lines
7.0 KiB
Markdown
Raw Blame History

# AITBC Documentation
**AI Training Blockchain - Privacy-Preserving ML & Edge Computing Platform**
Welcome to the AITBC documentation! This guide will help you navigate the documentation based on your role.
AITBC now features **advanced privacy-preserving machine learning** with zero-knowledge proofs, **fully homomorphic encryption**, and **edge GPU optimization** for consumer hardware. The platform combines decentralized GPU computing with cutting-edge cryptographic techniques for secure, private AI inference and training.
## 📊 **Current Status: 100% Infrastructure Complete**
### ✅ **Completed Features**
- **Core Infrastructure**: Coordinator API, Blockchain Node, Miner Node fully operational
- **Enhanced CLI System**: 100% test coverage with 67/67 tests passing
- **Exchange Infrastructure**: Complete exchange CLI commands and market integration
- **Oracle Systems**: Full price discovery mechanisms and market data
- **Market Making**: Complete market infrastructure components
- **Security**: Multi-sig, time-lock, and compliance features implemented
- **Testing**: Comprehensive test suite with full automation
- **Development Environment**: Complete setup with permission configuration
### 🎯 **Next Milestone: Q2 2026**
- Exchange ecosystem completion
- AI agent integration
- Cross-chain functionality
- Enhanced developer ecosystem
## 📁 **Documentation Organization**
### **Main Documentation Categories**
- [`0_getting_started/`](./0_getting_started/) - Getting started guides with enhanced CLI
- [`1_project/`](./1_project/) - Project overview and architecture
- [`2_clients/`](./2_clients/) - Enhanced client documentation
- [`3_miners/`](./3_miners/) - Enhanced miner documentation
- [`4_blockchain/`](./4_blockchain/) - Blockchain documentation
- [`5_reference/`](./5_reference/) - Reference materials
- [`6_architecture/`](./6_architecture/) - System architecture
- [`7_deployment/`](./7_deployment/) - Deployment guides
- [`8_development/`](./8_development/) - Development documentation
- [`9_security/`](./9_security/) - Security documentation
- [`10_plan/`](./10_plan/) - Development plans and roadmaps
- [`11_agents/`](./11_agents/) - AI agent documentation
- [`12_issues/`](./12_issues/) - Archived issues
- [`13_tasks/`](./13_tasks/) - Task documentation
- [`14_agent_sdk/`](./14_agent_sdk/) - Agent Identity SDK documentation
- [`15_completion/`](./15_completion/) - Phase implementation completion summaries
- [`16_cross_chain/`](./16_cross_chain/) - Cross-chain integration documentation
- [`17_developer_ecosystem/`](./17_developer_ecosystem/) - Developer ecosystem documentation
- [`18_explorer/`](./18_explorer/) - Explorer implementation with CLI parity
- [`19_marketplace/`](./19_marketplace/) - Global marketplace implementation
- [`20_phase_reports/`](./20_phase_reports/) - Comprehensive phase reports and guides
- [`21_reports/`](./21_reports/) - Project completion reports
- [`22_workflow/`](./22_workflow/) - Workflow completion summaries
- [`23_cli/`](./23_cli/) - **ENHANCED: Complete CLI Documentation**
### **🆕 Enhanced CLI Documentation**
- [`23_cli/README.md`](./23_cli/README.md) - Complete CLI reference with testing integration
- [`23_cli/permission-setup.md`](./23_cli/permission-setup.md) - Development environment setup
- [`23_cli/testing.md`](./23_cli/testing.md) - CLI testing procedures and results
- [`0_getting_started/3_cli.md`](./0_getting_started/3_cli.md) - CLI usage guide
### **🧪 Testing Documentation**
- [`23_cli/testing.md`](./23_cli/testing.md) - Complete CLI testing results (67/67 tests)
- [`tests/`](../tests/) - Complete test suite with automation
- [`cli/tests/`](../cli/tests/) - CLI-specific test suite
### **🔄 Exchange Infrastructure**
- [`19_marketplace/`](./19_marketplace/) - Exchange and marketplace documentation
- [`10_plan/01_core_planning/exchange_implementation_strategy.md`](./10_plan/01_core_planning/exchange_implementation_strategy.md) - Exchange implementation strategy
- [`10_plan/01_core_planning/trading_engine_analysis.md`](./10_plan/01_core_planning/trading_engine_analysis.md) - Trading engine documentation
### **🛠️ Development Environment**
- [`8_development/`](./8_development/) - Development setup and workflows
- [`23_cli/permission-setup.md`](./23_cli/permission-setup.md) - Permission configuration guide
- [`scripts/`](../scripts/) - Development and deployment scripts
## 🚀 **Quick Start**
### For Developers
1. **Setup Development Environment**:
```bash
source /opt/aitbc/.env.dev
```
2. **Test CLI Installation**:
```bash
aitbc --help
aitbc version
```
3. **Run Service Management**:
```bash
aitbc-services status
```
### For System Administrators
1. **Deploy Services**:
```bash
sudo systemctl start aitbc-coordinator-api.service
sudo systemctl start aitbc-blockchain-node.service
```
2. **Check Status**:
```bash
sudo systemctl status aitbc-*
```
### For Users
1. **Create Wallet**:
```bash
aitbc wallet create
```
2. **Check Balance**:
```bash
aitbc wallet balance
```
3. **Start Trading**:
```bash
aitbc exchange register --name "ExchangeName" --api-key <key>
aitbc exchange create-pair AITBC/BTC
```
## 📈 **Implementation Status**
### ✅ **Completed (100%)**
- **Stage 1**: Blockchain Node Foundations ✅
- **Stage 2**: Core Services (MVP) ✅
- **CLI System**: Enhanced with 100% test coverage ✅
- **Exchange Infrastructure**: Complete implementation ✅
- **Security Features**: Multi-sig, compliance, surveillance ✅
- **Testing Suite**: 67/67 tests passing ✅
### 🎯 **In Progress (Q2 2026)**
- **Exchange Ecosystem**: Market making and liquidity
- **AI Agents**: Integration and SDK development
- **Cross-Chain**: Multi-chain functionality
- **Developer Ecosystem**: Enhanced tools and documentation
## 📚 **Key Documentation Sections**
### **🔧 CLI Operations**
- Complete command reference with examples
- Permission setup and development environment
- Testing procedures and troubleshooting
- Service management guides
### **💼 Exchange Integration**
- Exchange registration and configuration
- Trading pair management
- Oracle system integration
- Market making infrastructure
### **🛡️ Security & Compliance**
- Multi-signature wallet operations
- KYC/AML compliance procedures
- Transaction surveillance
- Regulatory reporting
### **🧪 Testing & Quality**
- Comprehensive test suite results
- CLI testing automation
- Performance testing
- Security testing procedures
## 🔗 **Related Resources**
- **GitHub Repository**: [AITBC Source Code](https://github.com/oib/AITBC)
- **CLI Reference**: [Complete CLI Documentation](./23_cli/)
- **Testing Suite**: [Test Results and Procedures](./23_cli/testing.md)
- **Development Setup**: [Environment Configuration](./23_cli/permission-setup.md)
- **Exchange Integration**: [Market and Trading Documentation](./19_marketplace/)
---
**Last Updated**: March 8, 2026
**Infrastructure Status**: 100% Complete
**CLI Test Coverage**: 67/67 tests passing
**Next Milestone**: Q2 2026 Exchange Ecosystem
**Documentation Version**: 2.0
Reference in New Issue View Git Blame Copy Permalink