ff4554b9dd
chore: remove obsolete payment architecture and integration test documentation - Remove AITBC_PAYMENT_ARCHITECTURE.md (dual-currency system documentation) - Remove IMPLEMENTATION_COMPLETE_SUMMARY.md (integration test completion summary) - Remove INTEGRATION_TEST_FIXES.md (test fixes documentation) - Remove INTEGRATION_TEST_UPDATES.md (real features implementation notes) - Remove PAYMENT_INTEGRATION_COMPLETE.md (wallet-coordinator integration docs) - Remove WALLET_COORDINATOR_INTEGRATION.md (payment
37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
# AITBC Monorepo
|
|
|
|
This repository houses all components of the Artificial Intelligence Token Blockchain (AITBC) stack, including coordinator services, blockchain node, miner daemon, client-facing web apps, SDKs, and documentation.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
aitbc/
|
|
├── apps/ # Main applications (coordinator-api, blockchain-node, etc.)
|
|
├── packages/ # Shared packages and SDKs
|
|
├── scripts/ # Utility scripts
|
|
│ └── testing/ # Test scripts and utilities
|
|
├── tests/ # Pytest test suites
|
|
├── docs/ # Documentation
|
|
│ ├── guides/ # Development guides
|
|
│ └── reports/ # Generated reports and summaries
|
|
├── infra/ # Infrastructure and deployment configs
|
|
├── dev-utils/ # Development utilities
|
|
└── .windsurf/ # Windsurf IDE configuration
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
1. Review the bootstrap documents under `docs/bootstrap/` to understand stage-specific goals.
|
|
2. Fill in service-specific READMEs located under `apps/` and `packages/` as the implementations progress.
|
|
3. Use the provided directory scaffold as the starting point for coding each subsystem.
|
|
4. Explore the new Python receipt SDK under `packages/py/aitbc-sdk/` for helpers to fetch and verify coordinator receipts (see `docs/run.md` for examples).
|
|
5. Run `scripts/ci/run_python_tests.sh` (via Poetry) to execute coordinator, SDK, miner-node, and wallet-daemon test suites before submitting changes.
|
|
6. GitHub Actions (`.github/workflows/python-tests.yml`) automatically runs the same script on pushes and pull requests targeting `main`.
|
|
|
|
## Testing
|
|
|
|
- Test scripts are located in `scripts/testing/`
|
|
- Run individual tests: `python3 scripts/testing/test_block_import.py`
|
|
- Run pytest suite: `pytest tests/`
|
|
- See `docs/guides/WINDSURF_TESTING_GUIDE.md` for detailed testing instructions
|