docs/config/packages: add v0.1 release prep, security status, and SDK enhancements
- Add Stage 23 roadmap for v0.1 release preparation with PyPI/npm publishing, deployment automation, and security audit milestones - Document competitive differentiators: zkML/FHE integration, hybrid TEE/ZK verification, on-chain model marketplace, and geo-low-latency matching - Update security documentation with smart contract audit results (0 vulnerabilities, 35 OpenZeppelin warnings) - Add security-first setup
This commit is contained in:
oib
150
packages/py/aitbc-sdk/README.md
Normal file
150
packages/py/aitbc-sdk/README.md
Normal file
@@ -0,0 +1,150 @@
|
||||
# AITBC SDK
|
||||
|
||||
Python client SDK for interacting with AITBC coordinator services, blockchain nodes, and marketplace components.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install aitbc-sdk
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from aitbc_sdk import AITBCClient
|
||||
|
||||
async def main():
|
||||
# Initialize client
|
||||
client = AITBCClient(base_url="https://aitbc.bubuit.net")
|
||||
|
||||
# Submit a job
|
||||
job = await client.submit_job({
|
||||
"service_type": "llm_inference",
|
||||
"model": "llama3.2",
|
||||
"prompt": "Hello, world!"
|
||||
})
|
||||
|
||||
# Check job status
|
||||
status = await client.get_job_status(job.id)
|
||||
print(f"Job status: {status.status}")
|
||||
|
||||
# Get results when complete
|
||||
if status.status == "completed":
|
||||
result = await client.get_job_result(job.id)
|
||||
print(f"Result: {result.output}")
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Job Management**: Submit, monitor, and retrieve computation jobs
|
||||
- **Receipt Verification**: Cryptographically verify job completion receipts
|
||||
- **Marketplace Integration**: Browse and participate in GPU marketplace
|
||||
- **Blockchain Integration**: Interact with AITBC blockchain for settlement
|
||||
- **Zero-Knowledge Support**: Private computation with ZK proof verification
|
||||
|
||||
## API Reference
|
||||
|
||||
### Client Initialization
|
||||
|
||||
```python
|
||||
from aitbc_sdk import AITBCClient
|
||||
|
||||
client = AITBCClient(
|
||||
base_url="https://aitbc.bubuit.net",
|
||||
api_key="your-api-key",
|
||||
timeout=30
|
||||
)
|
||||
```
|
||||
|
||||
### Job Operations
|
||||
|
||||
```python
|
||||
# Submit a job
|
||||
job = await client.submit_job({
|
||||
"service_type": "llm_inference",
|
||||
"model": "llama3.2",
|
||||
"parameters": {
|
||||
"prompt": "Explain quantum computing",
|
||||
"max_tokens": 500
|
||||
}
|
||||
})
|
||||
|
||||
# Get job status
|
||||
status = await client.get_job_status(job.id)
|
||||
|
||||
# Get job result
|
||||
result = await client.get_job_result(job.id)
|
||||
|
||||
# Cancel a job
|
||||
await client.cancel_job(job.id)
|
||||
```
|
||||
|
||||
### Receipt Operations
|
||||
|
||||
```python
|
||||
# Get job receipts
|
||||
receipts = await client.get_job_receipts(job.id)
|
||||
|
||||
# Verify receipt authenticity
|
||||
is_valid = await client.verify_receipt(receipt)
|
||||
```
|
||||
|
||||
### Marketplace Operations
|
||||
|
||||
```python
|
||||
# List available services
|
||||
services = await client.list_services()
|
||||
|
||||
# Get service details
|
||||
service = await client.get_service(service_id)
|
||||
|
||||
# Place bid for computation
|
||||
bid = await client.place_bid({
|
||||
"service_id": service_id,
|
||||
"max_price": 0.1,
|
||||
"requirements": {
|
||||
"gpu_memory": "8GB",
|
||||
"compute_capability": "7.5"
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The SDK can be configured via environment variables:
|
||||
|
||||
```bash
|
||||
export AITBC_BASE_URL="https://aitbc.bubuit.net"
|
||||
export AITBC_API_KEY="your-api-key"
|
||||
export AITBC_TIMEOUT=30
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
Install in development mode:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/oib/AITBC.git
|
||||
cd AITBC/packages/py/aitbc-sdk
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Run tests:
|
||||
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details.
|
||||
|
||||
## Support
|
||||
|
||||
- **Documentation**: https://aitbc.bubuit.net/docs/
|
||||
- **Issues**: https://github.com/oib/AITBC/issues
|
||||
- **Discussions**: https://github.com/oib/AITBC/discussions
|
||||
@@ -2,13 +2,62 @@
|
||||
name = "aitbc-sdk"
|
||||
version = "0.1.0"
|
||||
description = "AITBC client SDK for interacting with coordinator services"
|
||||
readme = "README.md"
|
||||
license = {text = "MIT"}
|
||||
requires-python = ">=3.11"
|
||||
authors = [
|
||||
{name = "AITBC Team", email = "team@aitbc.dev"}
|
||||
]
|
||||
keywords = ["ai-compute", "blockchain", "gpu-marketplace", "zk-proofs"]
|
||||
classifiers = [
|
||||
"Development Status :: 4 - Beta",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
"Topic :: Scientific/Engineering :: Artificial Intelligence"
|
||||
]
|
||||
dependencies = [
|
||||
"httpx>=0.27.0",
|
||||
"pydantic>=2.7.0",
|
||||
"aitbc-crypto @ file:///home/oib/windsurf/aitbc/packages/py/aitbc-crypto"
|
||||
"aitbc-crypto>=0.1.0"
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest>=7.0.0",
|
||||
"pytest-asyncio>=0.21.0",
|
||||
"black>=23.0.0",
|
||||
"isort>=5.12.0",
|
||||
"mypy>=1.5.0"
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/oib/AITBC"
|
||||
Documentation = "https://aitbc.bubuit.net/docs/"
|
||||
Repository = "https://github.com/oib/AITBC.git"
|
||||
"Bug Tracker" = "https://github.com/oib/AITBC/issues"
|
||||
|
||||
[build-system]
|
||||
requires = ["setuptools", "wheel"]
|
||||
requires = ["setuptools>=61.0", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
include = ["aitbc_sdk*"]
|
||||
|
||||
[tool.black]
|
||||
line-length = 88
|
||||
target-version = ['py311']
|
||||
|
||||
[tool.isort]
|
||||
profile = "black"
|
||||
line_length = 88
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.11"
|
||||
warn_return_any = true
|
||||
warn_unused_configs = true
|
||||
disallow_untyped_defs = true
|
||||
|
||||
@@ -2,7 +2,180 @@ Metadata-Version: 2.4
|
||||
Name: aitbc-sdk
|
||||
Version: 0.1.0
|
||||
Summary: AITBC client SDK for interacting with coordinator services
|
||||
Author-email: AITBC Team <team@aitbc.dev>
|
||||
License: MIT
|
||||
Project-URL: Homepage, https://github.com/oib/AITBC
|
||||
Project-URL: Documentation, https://aitbc.bubuit.net/docs/
|
||||
Project-URL: Repository, https://github.com/oib/AITBC.git
|
||||
Project-URL: Bug Tracker, https://github.com/oib/AITBC/issues
|
||||
Keywords: ai-compute,blockchain,gpu-marketplace,zk-proofs
|
||||
Classifier: Development Status :: 4 - Beta
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: License :: OSI Approved :: MIT License
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Programming Language :: Python :: 3.11
|
||||
Classifier: Programming Language :: Python :: 3.12
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
||||
Requires-Python: >=3.11
|
||||
Description-Content-Type: text/markdown
|
||||
Requires-Dist: httpx>=0.27.0
|
||||
Requires-Dist: pydantic>=2.7.0
|
||||
Requires-Dist: aitbc-crypto@ file:///home/oib/windsurf/aitbc/packages/py/aitbc-crypto
|
||||
Requires-Dist: aitbc-crypto>=0.1.0
|
||||
Provides-Extra: dev
|
||||
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
||||
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
|
||||
Requires-Dist: black>=23.0.0; extra == "dev"
|
||||
Requires-Dist: isort>=5.12.0; extra == "dev"
|
||||
Requires-Dist: mypy>=1.5.0; extra == "dev"
|
||||
|
||||
# AITBC SDK
|
||||
|
||||
Python client SDK for interacting with AITBC coordinator services, blockchain nodes, and marketplace components.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install aitbc-sdk
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from aitbc_sdk import AITBCClient
|
||||
|
||||
async def main():
|
||||
# Initialize client
|
||||
client = AITBCClient(base_url="https://aitbc.bubuit.net")
|
||||
|
||||
# Submit a job
|
||||
job = await client.submit_job({
|
||||
"service_type": "llm_inference",
|
||||
"model": "llama3.2",
|
||||
"prompt": "Hello, world!"
|
||||
})
|
||||
|
||||
# Check job status
|
||||
status = await client.get_job_status(job.id)
|
||||
print(f"Job status: {status.status}")
|
||||
|
||||
# Get results when complete
|
||||
if status.status == "completed":
|
||||
result = await client.get_job_result(job.id)
|
||||
print(f"Result: {result.output}")
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Job Management**: Submit, monitor, and retrieve computation jobs
|
||||
- **Receipt Verification**: Cryptographically verify job completion receipts
|
||||
- **Marketplace Integration**: Browse and participate in GPU marketplace
|
||||
- **Blockchain Integration**: Interact with AITBC blockchain for settlement
|
||||
- **Zero-Knowledge Support**: Private computation with ZK proof verification
|
||||
|
||||
## API Reference
|
||||
|
||||
### Client Initialization
|
||||
|
||||
```python
|
||||
from aitbc_sdk import AITBCClient
|
||||
|
||||
client = AITBCClient(
|
||||
base_url="https://aitbc.bubuit.net",
|
||||
api_key="your-api-key",
|
||||
timeout=30
|
||||
)
|
||||
```
|
||||
|
||||
### Job Operations
|
||||
|
||||
```python
|
||||
# Submit a job
|
||||
job = await client.submit_job({
|
||||
"service_type": "llm_inference",
|
||||
"model": "llama3.2",
|
||||
"parameters": {
|
||||
"prompt": "Explain quantum computing",
|
||||
"max_tokens": 500
|
||||
}
|
||||
})
|
||||
|
||||
# Get job status
|
||||
status = await client.get_job_status(job.id)
|
||||
|
||||
# Get job result
|
||||
result = await client.get_job_result(job.id)
|
||||
|
||||
# Cancel a job
|
||||
await client.cancel_job(job.id)
|
||||
```
|
||||
|
||||
### Receipt Operations
|
||||
|
||||
```python
|
||||
# Get job receipts
|
||||
receipts = await client.get_job_receipts(job.id)
|
||||
|
||||
# Verify receipt authenticity
|
||||
is_valid = await client.verify_receipt(receipt)
|
||||
```
|
||||
|
||||
### Marketplace Operations
|
||||
|
||||
```python
|
||||
# List available services
|
||||
services = await client.list_services()
|
||||
|
||||
# Get service details
|
||||
service = await client.get_service(service_id)
|
||||
|
||||
# Place bid for computation
|
||||
bid = await client.place_bid({
|
||||
"service_id": service_id,
|
||||
"max_price": 0.1,
|
||||
"requirements": {
|
||||
"gpu_memory": "8GB",
|
||||
"compute_capability": "7.5"
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The SDK can be configured via environment variables:
|
||||
|
||||
```bash
|
||||
export AITBC_BASE_URL="https://aitbc.bubuit.net"
|
||||
export AITBC_API_KEY="your-api-key"
|
||||
export AITBC_TIMEOUT=30
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
Install in development mode:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/oib/AITBC.git
|
||||
cd AITBC/packages/py/aitbc-sdk
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Run tests:
|
||||
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details.
|
||||
|
||||
## Support
|
||||
|
||||
- **Documentation**: https://aitbc.bubuit.net/docs/
|
||||
- **Issues**: https://github.com/oib/AITBC/issues
|
||||
- **Discussions**: https://github.com/oib/AITBC/discussions
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
README.md
|
||||
pyproject.toml
|
||||
src/aitbc_sdk/__init__.py
|
||||
src/aitbc_sdk/receipts.py
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
httpx>=0.27.0
|
||||
pydantic>=2.7.0
|
||||
aitbc-crypto@ file:///home/oib/windsurf/aitbc/packages/py/aitbc-crypto
|
||||
aitbc-crypto>=0.1.0
|
||||
|
||||
[dev]
|
||||
pytest>=7.0.0
|
||||
pytest-asyncio>=0.21.0
|
||||
black>=23.0.0
|
||||
isort>=5.12.0
|
||||
mypy>=1.5.0
|
||||
|
||||
Reference in New Issue
Block a user