chore: remove obsolete files and add Solidity build artifacts to .gitignore

- Add ignore patterns for Solidity build artifacts (typechain-types, artifacts, cache)
- Remove unused exchange mock API server (api/exchange_mock_api.py)
- Remove obsolete client-web README placeholder
- Remove deprecated marketplace-ui HTML implementation
```
This commit is contained in:
oib
2026-01-24 15:46:23 +01:00
parent 9b9c5beb23
commit 55ced77928
195 changed files with 951 additions and 30090 deletions

View File

@@ -0,0 +1,333 @@
# Governance Module
The AITBC governance module enables decentralized decision-making through proposal voting and parameter changes.
## Overview
The governance system allows AITBC token holders to:
- Create proposals for protocol changes
- Vote on active proposals
- Execute approved proposals
- Track governance history
## API Endpoints
### Get Governance Parameters
Retrieve current governance system parameters.
```http
GET /api/v1/governance/parameters
```
**Response:**
```json
{
"min_proposal_voting_power": 1000,
"max_proposal_title_length": 200,
"max_proposal_description_length": 5000,
"default_voting_period_days": 7,
"max_voting_period_days": 30,
"min_quorum_threshold": 0.01,
"max_quorum_threshold": 1.0,
"min_approval_threshold": 0.01,
"max_approval_threshold": 1.0,
"execution_delay_hours": 24
}
```
### List Proposals
Get a list of governance proposals.
```http
GET /api/v1/governance/proposals?status={status}&limit={limit}&offset={offset}
```
**Query Parameters:**
- `status` (optional): Filter by proposal status (`active`, `passed`, `rejected`, `executed`)
- `limit` (optional): Number of proposals to return (default: 20)
- `offset` (optional): Number of proposals to skip (default: 0)
**Response:**
```json
[
{
"id": "proposal-uuid",
"title": "Proposal Title",
"description": "Description of the proposal",
"type": "parameter_change",
"target": {},
"proposer": "user-address",
"status": "active",
"created_at": "2025-12-28T18:00:00Z",
"voting_deadline": "2025-12-28T18:00:00Z",
"quorum_threshold": 0.1,
"approval_threshold": 0.5,
"current_quorum": 0.15,
"current_approval": 0.75,
"votes_for": 150,
"votes_against": 50,
"votes_abstain": 10,
"total_voting_power": 1000000
}
]
```
### Create Proposal
Create a new governance proposal.
```http
POST /api/v1/governance/proposals
```
**Request Body:**
```json
{
"title": "Reduce Transaction Fees",
"description": "This proposal suggests reducing transaction fees...",
"type": "parameter_change",
"target": {
"fee_percentage": "0.05"
},
"voting_period": 7,
"quorum_threshold": 0.1,
"approval_threshold": 0.5
}
```
**Fields:**
- `title`: Proposal title (10-200 characters)
- `description`: Detailed description (50-5000 characters)
- `type`: Proposal type (`parameter_change`, `protocol_upgrade`, `fund_allocation`, `policy_change`)
- `target`: Target configuration for the proposal
- `voting_period`: Voting period in days (1-30)
- `quorum_threshold`: Minimum participation percentage (0.01-1.0)
- `approval_threshold`: Minimum approval percentage (0.01-1.0)
### Get Proposal
Get details of a specific proposal.
```http
GET /api/v1/governance/proposals/{proposal_id}
```
### Submit Vote
Submit a vote on a proposal.
```http
POST /api/v1/governance/vote
```
**Request Body:**
```json
{
"proposal_id": "proposal-uuid",
"vote": "for",
"reason": "I support this change because..."
}
```
**Fields:**
- `proposal_id`: ID of the proposal to vote on
- `vote`: Vote option (`for`, `against`, `abstain`)
- `reason` (optional): Reason for the vote (max 500 characters)
### Get Voting Power
Check a user's voting power.
```http
GET /api/v1/governance/voting-power/{user_id}
```
**Response:**
```json
{
"user_id": "user-address",
"voting_power": 10000
}
```
### Execute Proposal
Execute an approved proposal.
```http
POST /api/v1/governance/execute/{proposal_id}
```
**Note:** Proposals can only be executed after:
1. Voting period has ended
2. Quorum threshold is met
3. Approval threshold is met
4. 24-hour execution delay has passed
## Proposal Types
### Parameter Change
Modify system parameters like fees, limits, or thresholds.
**Example Target:**
```json
{
"transaction_fee": "0.05",
"min_stake_amount": "1000",
"max_block_size": "2000"
}
```
### Protocol Upgrade
Initiate a protocol upgrade with version changes.
**Example Target:**
```json
{
"version": "1.2.0",
"upgrade_type": "hard_fork",
"activation_block": 1000000,
"changes": {
"new_features": ["feature1", "feature2"],
"breaking_changes": ["change1"]
}
}
```
### Fund Allocation
Allocate funds from the treasury.
**Example Target:**
```json
{
"amount": "1000000",
"recipient": "0x123...",
"purpose": "Ecosystem development fund",
"milestones": [
{
"description": "Phase 1 development",
"amount": "500000",
"deadline": "2025-06-30"
}
]
}
```
### Policy Change
Update governance or operational policies.
**Example Target:**
```json
{
"policy_name": "voting_period",
"new_value": "14 days",
"rationale": "Longer voting period for better participation"
}
```
## Voting Process
1. **Proposal Creation**: Any user with sufficient voting power can create a proposal
2. **Voting Period**: Token holders vote during the specified voting period
3. **Quorum Check**: Minimum participation must be met
4. **Approval Check**: Minimum approval ratio must be met
5. **Execution Delay**: 24-hour delay before execution
6. **Execution**: Approved changes are implemented
## Database Schema
### GovernanceProposal
- `id`: Unique proposal identifier
- `title`: Proposal title
- `description`: Detailed description
- `type`: Proposal type
- `target`: Target configuration (JSON)
- `proposer`: Address of the proposer
- `status`: Current status
- `created_at`: Creation timestamp
- `voting_deadline`: End of voting period
- `quorum_threshold`: Minimum participation required
- `approval_threshold`: Minimum approval required
- `executed_at`: Execution timestamp
- `rejection_reason`: Reason for rejection
### ProposalVote
- `id`: Unique vote identifier
- `proposal_id`: Reference to proposal
- `voter_id`: Address of the voter
- `vote`: Vote choice (for/against/abstain)
- `voting_power`: Power at time of vote
- `reason`: Vote reason
- `voted_at`: Vote timestamp
### TreasuryTransaction
- `id`: Unique transaction identifier
- `proposal_id`: Reference to proposal
- `from_address`: Source address
- `to_address`: Destination address
- `amount`: Transfer amount
- `status`: Transaction status
- `transaction_hash`: Blockchain hash
## Security Considerations
1. **Voting Power**: Based on AITBC token holdings
2. **Double Voting**: Prevented by tracking voter addresses
3. **Execution Delay**: Prevents rush decisions
4. **Quorum Requirements**: Ensures sufficient participation
5. **Proposal Thresholds**: Prevents spam proposals
## Integration Guide
### Frontend Integration
```javascript
// Fetch proposals
const response = await fetch('/api/v1/governance/proposals');
const proposals = await response.json();
// Submit vote
await fetch('/api/v1/governance/vote', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
proposal_id: 'uuid',
vote: 'for',
reason: 'Support this proposal'
})
});
```
### Smart Contract Integration
The governance system can be integrated with smart contracts for:
- On-chain voting
- Automatic execution
- Treasury management
- Parameter enforcement
## Best Practices
1. **Clear Proposals**: Provide detailed descriptions and rationales
2. **Reasonable Thresholds**: Set achievable quorum and approval thresholds
3. **Community Discussion**: Use forums for proposal discussion
4. **Gradual Changes**: Implement major changes in phases
5. **Monitoring**: Track proposal outcomes and system impact
## Future Enhancements
1. **Delegated Voting**: Allow users to delegate voting power
2. **Quadratic Voting**: Implement more sophisticated voting mechanisms
3. **Time-locked Voting**: Lock tokens for voting power boosts
4. **Multi-sig Execution**: Require multiple signatures for execution
5. **Proposal Templates**: Standardize proposal formats
## Support
For governance-related questions:
- Check the API documentation
- Review proposal history
- Contact the governance team
- Participate in community discussions

View File

@@ -0,0 +1,204 @@
# AITBC Roadmap Retrospective - [Period]
**Date**: [Date]
**Period**: [e.g., H1 2024, H2 2024]
**Authors**: AITBC Core Team
## Executive Summary
[Brief 2-3 sentence summary of the period's achievements and challenges]
## KPI Performance Review
### Key Metrics
| KPI | Target | Actual | Status | Notes |
|-----|--------|--------|--------|-------|
| Active Marketplaces | [target] | [actual] | ✅/⚠️/❌ | [comments] |
| Cross-Chain Volume | [target] | [actual] | ✅/⚠️/❌ | [comments] |
| Active Developers | [target] | [actual] | ✅/⚠️/❌ | [comments] |
| TVL (Total Value Locked) | [target] | [actual] | ✅/⚠️/❌ | [comments] |
| Transaction Volume | [target] | [actual] | ✅/⚠️/❌ | [comments] |
### Performance Analysis
#### Achievements
- [List 3-5 major achievements]
- [Include metrics and impact]
#### Challenges
- [List 2-3 key challenges]
- [Include root causes if known]
#### Learnings
- [Key insights from the period]
- [What worked well]
- [What didn't work as expected]
## Roadmap Progress
### Completed Items
#### Stage 7 - Community & Governance
- ✅ [Item] - [Date completed] - [Brief description]
- ✅ [Item] - [Date completed] - [Brief description]
#### Stage 8 - Frontier R&D & Global Expansion
- ✅ [Item] - [Date completed] - [Brief description]
- ✅ [Item] - [Date completed] - [Brief description]
### In Progress Items
#### [Stage Name]
- ⏳ [Item] - [Progress %] - [ETA] - [Blockers if any]
- ⏳ [Item] - [Progress %] - [ETA] - [Blockers if any]
### Delayed Items
#### [Stage Name]
- ⏸️ [Item] - [Original date] → [New date] - [Reason for delay]
- ⏸️ [Item] - [Original date] → [New date] - [Reason for delay]
### New Items Added
- 🆕 [Item] - [Added date] - [Priority] - [Rationale]
## Ecosystem Health
### Developer Ecosystem
- **New Developers**: [number]
- **Active Projects**: [number]
- **GitHub Stars**: [number]
- **Community Engagement**: [description]
### User Adoption
- **Active Users**: [number]
- **Transaction Growth**: [percentage]
- **Geographic Distribution**: [key regions]
### Partner Ecosystem
- **New Partners**: [number]
- **Integration Status**: [description]
- **Success Stories**: [1-2 examples]
## Technical Achievements
### Major Releases
- [Release Name] - [Date] - [Key features]
- [Release Name] - [Date] - [Key features]
### Research Outcomes
- [Paper/Prototype] - [Status] - [Impact]
- [Research Area] - [Findings] - [Next steps]
### Infrastructure Improvements
- [Improvement] - [Impact] - [Metrics]
## Community & Governance
### Governance Participation
- **Proposal Submissions**: [number]
- **Voting Turnout**: [percentage]
- **Community Discussions**: [key topics]
### Community Initiatives
- [Initiative] - [Participation] - [Outcomes]
- [Initiative] - [Participation] - [Outcomes]
### Events & Activities
- [Event] - [Attendance] - [Feedback]
- [Event] - [Attendance] - [Feedback]
## Financial Overview
### Treasury Status
- **Balance**: [amount]
- **Burn Rate**: [amount/month]
- **Runway**: [months]
### Grant Program
- **Grants Awarded**: [number]
- **Total Amount**: [amount]
- **Success Rate**: [percentage]
## Risk Assessment
### Technical Risks
- [Risk] - [Probability] - [Impact] - [Mitigation]
### Market Risks
- [Risk] - [Probability] - [Impact] - [Mitigation]
### Operational Risks
- [Risk] - [Probability] - [Impact] - [Mitigation]
## Next Period Goals
### Primary Objectives
1. [Objective] - [Success criteria]
2. [Objective] - [Success criteria]
3. [Objective] - [Success criteria]
### Key Initiatives
- [Initiative] - [Owner] - [Timeline]
- [Initiative] - [Owner] - [Timeline]
- [Initiative] - [Owner] - [Timeline]
### Resource Requirements
- **Team**: [needs]
- **Budget**: [amount]
- **Partnerships**: [requirements]
## Long-term Vision Updates
### Strategy Adjustments
- [Adjustment] - [Rationale] - [Expected impact]
### New Opportunities
- [Opportunity] - [Potential] - [Next steps]
### Timeline Revisions
- [Milestone] - [Original] → [Revised] - [Reason]
## Feedback & Suggestions
### Community Feedback
- [Summary of key feedback]
- [Action items]
### Partner Feedback
- [Summary of key feedback]
- [Action items]
### Internal Feedback
- [Summary of key feedback]
- [Action items]
## Appendices
### A. Detailed Metrics
[Additional charts and data]
### B. Project Timeline
[Visual timeline with dependencies]
### C. Risk Register
[Detailed risk matrix]
### D. Action Item Tracker
[List of action items with owners and due dates]
---
**Next Review Date**: [Date]
**Document Version**: [version]
**Distribution**: [list of recipients]
## Approval
| Role | Name | Signature | Date |
|------|------|-----------|------|
| Project Lead | | | |
| Tech Lead | | | |
| Community Lead | | | |
| Ecosystem Lead | | | |

View File

@@ -0,0 +1,271 @@
# AITBC Annual Transparency Report - [Year]
**Published**: [Date]
**Reporting Period**: [Start Date] to [End Date]
**Prepared By**: AITBC Foundation
## Executive Summary
[2-3 paragraph summary of the year's achievements, challenges, and strategic direction]
## Mission & Vision Alignment
### Mission Progress
- [Progress towards decentralizing AI/ML marketplace]
- [Key metrics showing mission advancement]
- [Community impact stories]
### Vision Milestones
- [Technical milestones achieved]
- [Ecosystem growth metrics]
- [Strategic partnerships formed]
## Governance Transparency
### Governance Structure
- **Current Model**: [Description of governance model]
- **Decision Making Process**: [How decisions are made]
- **Community Participation**: [Governance participation metrics]
### Key Governance Actions
| Date | Action | Outcome | Community Feedback |
|------|--------|---------|-------------------|
| [Date] | [Proposal/Decision] | [Result] | [Summary] |
| [Date] | [Proposal/Decision] | [Result] | [Summary] |
### Treasury & Financial Transparency
- **Total Treasury**: [Amount] AITBC
- **Annual Expenditure**: [Amount] AITBC
- **Funding Sources**: [Breakdown]
- **Expense Categories**: [Breakdown]
#### Budget Allocation
| Category | Budgeted | Actual | Variance | Notes |
|----------|----------|--------|----------|-------|
| Development | [Amount] | [Amount] | [Amount] | [Explanation] |
| Operations | [Amount] | [Amount] | [Amount] | [Explanation] |
| Community | [Amount] | [Amount] | [Amount] | [Explanation] |
| Research | [Amount] | [Amount] | [Amount] | [Explanation] |
## Technical Development
### Protocol Updates
#### Major Releases
- [Version] - [Date] - [Key Features]
- [Version] - [Date] - [Key Features]
- [Version] - [Date] - [Key Features]
#### Research & Development
- **Research Papers Published**: [Number]
- **Prototypes Developed**: [Number]
- **Patents Filed**: [Number]
- **Open Source Contributions**: [Details]
### Security & Reliability
- **Security Audits**: [Number] completed
- **Critical Issues**: [Number] found and fixed
- **Uptime**: [Percentage]
- **Incidents**: [Number] with details
### Performance Metrics
| Metric | Target | Actual | Status |
|--------|--------|--------|--------|
| TPS | [Target] | [Actual] | ✅/⚠️/❌ |
| Block Time | [Target] | [Actual] | ✅/⚠️/❌ |
| Finality | [Target] | [Actual] | ✅/⚠️/❌ |
| Gas Efficiency | [Target] | [Actual] | ✅/⚠️/❌ |
## Ecosystem Health
### Network Statistics
- **Total Transactions**: [Number]
- **Active Addresses**: [Number]
- **Total Value Locked (TVL)**: [Amount]
- **Cross-Chain Volume**: [Amount]
- **Marketplaces**: [Number]
### Developer Ecosystem
- **Active Developers**: [Number]
- **Projects Built**: [Number]
- **GitHub Stars**: [Number]
- **Developer Grants Awarded**: [Number]
### Community Metrics
- **Community Members**: [Discord/Telegram/etc.]
- **Monthly Active Users**: [Number]
- **Social Media Engagement**: [Metrics]
- **Event Participation**: [Number of events, attendance]
### Geographic Distribution
| Region | Users | Developers | Partners | Growth |
|--------|-------|------------|----------|--------|
| North America | [Number] | [Number] | [Number] | [%] |
| Europe | [Number] | [Number] | [Number] | [%] |
| Asia Pacific | [Number] | [Number] | [Number] | [%] |
| Other | [Number] | [Number] | [Number] | [%] |
## Sustainability Metrics
### Environmental Impact
- **Energy Consumption**: [kWh/year]
- **Carbon Footprint**: [tCO2/year]
- **Renewable Energy Usage**: [Percentage]
- **Efficiency Improvements**: [Year-over-year change]
### Economic Sustainability
- **Revenue Streams**: [Breakdown]
- **Cost Optimization**: [Achievements]
- **Long-term Funding**: [Strategy]
- **Risk Management**: [Approach]
### Social Impact
- **Education Programs**: [Number of participants]
- **Accessibility Features**: [Improvements]
- **Inclusion Initiatives**: [Programs launched]
- **Community Benefits**: [Stories/examples]
## Partnerships & Collaborations
### Strategic Partners
| Partner | Type | Since | Key Achievements |
|---------|------|-------|-----------------|
| [Partner] | [Type] | [Year] | [Achievements] |
| [Partner] | [Type] | [Year] | [Achievements] |
### Academic Collaborations
- **University Partnerships**: [Number]
- **Research Projects**: [Number]
- **Student Programs**: [Participants]
- **Publications**: [Number]
### Industry Alliances
- **Consortium Members**: [Number]
- **Working Groups**: [Active groups]
- **Standardization Efforts**: [Contributions]
- **Joint Initiatives**: [Projects]
## Compliance & Legal
### Regulatory Compliance
- **Jurisdictions**: [Countries/regions of operation]
- **Licenses**: [Held licenses]
- **Compliance Programs**: [Active programs]
- **Audits**: [Results]
### Data Privacy
- **Privacy Policy Updates**: [Changes made]
- **Data Protection**: [Measures implemented]
- **User Rights**: [Enhancements]
- **Incidents**: [Any breaches/issues]
### Intellectual Property
- **Patents**: [Portfolio summary]
- **Trademarks**: [Registered marks]
- **Open Source**: [Licenses used]
- **Contributions**: [Policy]
## Risk Management
### Identified Risks
| Risk Category | Risk Level | Mitigation | Status |
|---------------|------------|------------|--------|
| Technical | [Level] | [Strategy] | [Status] |
| Market | [Level] | [Strategy] | [Status] |
| Regulatory | [Level] | [Strategy] | [Status] |
| Operational | [Level] | [Strategy] | [Status] |
### Incident Response
- **Security Incidents**: [Number] with details
- **Response Time**: [Average time]
- **Recovery Time**: [Average time]
- **Lessons Learned**: [Key takeaways]
## Community Feedback & Engagement
### Feedback Channels
- **Proposals Received**: [Number]
- **Community Votes**: [Number]
- **Feedback Implementation Rate**: [Percentage]
- **Response Time**: [Average time]
### Major Community Initiatives
- [Initiative 1] - [Participation] - [Outcome]
- [Initiative 2] - [Participation] - [Outcome]
- [Initiative 3] - [Participation] - [Outcome]
### Challenges & Concerns
- **Top Issues Raised**: [Summary]
- **Actions Taken**: [Responses]
- **Ongoing Concerns**: [Status]
## Future Outlook
### Next Year Goals
1. [Goal 1] - [Success criteria]
2. [Goal 2] - [Success criteria]
3. [Goal 3] - [Success criteria]
### Strategic Priorities
- [Priority 1] - [Rationale]
- [Priority 2] - [Rationale]
- [Priority 3] - [Rationale]
### Resource Allocation
- **Development**: [Planned investment]
- **Community**: [Planned investment]
- **Research**: [Planned investment]
- **Operations**: [Planned investment]
## Acknowledgments
### Contributors
- **Core Team**: [Number of contributors]
- **Community Contributors**: [Number]
- **Top Contributors**: [Recognition]
### Special Thanks
- [Individual/Organization 1]
- [Individual/Organization 2]
- [Individual/Organization 3]
## Appendices
### A. Detailed Financial Statements
[Link to detailed financial reports]
### B. Technical Specifications
[Link to technical documentation]
### C. Governance Records
[Link to governance documentation]
### D. Community Survey Results
[Key findings from community surveys]
### E. Third-Party Audits
[Links to audit reports]
---
## Contact & Verification
### Verification
- **Financial Audit**: [Auditor] - [Report link]
- **Technical Audit**: [Auditor] - [Report link]
- **Security Audit**: [Auditor] - [Report link]
### Contact Information
- **Transparency Questions**: transparency@aitbc.io
- **General Inquiries**: info@aitbc.io
- **Security Issues**: security@aitbc.io
- **Media Inquiries**: media@aitbc.io
### Document Information
- **Version**: [Version number]
- **Last Updated**: [Date]
- **Next Report Due**: [Date]
- **Archive**: [Link to past reports]
---
*This transparency report is published annually as part of AITBC's commitment to openness and accountability. All data presented is accurate to the best of our knowledge. For questions or clarifications, please contact us at transparency@aitbc.io.*