Files
dchain/docs/api/README.md
vsecoder 7e7393e4f8 chore: initial commit for v0.0.1
DChain single-node blockchain + React Native messenger client.

Core:
- PBFT consensus with multi-sig validator admission + equivocation slashing
- BadgerDB + schema migration scaffold (CurrentSchemaVersion=0)
- libp2p gossipsub (tx/v1, blocks/v1, relay/v1, version/v1)
- Native Go contracts (username_registry) alongside WASM (wazero)
- WebSocket gateway with topic-based fanout + Ed25519-nonce auth
- Relay mailbox with NaCl envelope encryption (X25519 + Ed25519)
- Prometheus /metrics, per-IP rate limit, body-size cap

Deployment:
- Single-node compose (deploy/single/) with Caddy TLS + optional Prometheus
- 3-node dev compose (docker-compose.yml) with mocked internet topology
- 3-validator prod compose (deploy/prod/) for federation
- Auto-update from Gitea via /api/update-check + systemd timer
- Build-time version injection (ldflags → node --version)
- UI / Swagger toggle flags (DCHAIN_DISABLE_UI, DCHAIN_DISABLE_SWAGGER)

Client (client-app/):
- Expo / React Native / NativeWind
- E2E NaCl encryption, typing indicator, contact requests
- Auto-discovery of canonical contracts, chain_id aware, WS reconnect on node switch

Documentation:
- README.md, CHANGELOG.md, CONTEXT.md
- deploy/single/README.md with 6 operator scenarios
- deploy/UPDATE_STRATEGY.md with 4-layer forward-compat design
- docs/contracts/*.md per contract
2026-04-17 14:16:44 +03:00

46 lines
1.5 KiB
Markdown

# REST API
DChain-нода предоставляет HTTP API на порту `--stats-addr` (по умолчанию `:8080`).
## Базовые URL
| Окружение | URL |
|---------|-----|
| Локально | `http://localhost:8081` |
| Docker node1 | `http://node1:8080` |
| Docker node2 | `http://node2:8080` |
| Docker node3 | `http://node3:8080` |
## Разделы API
| Документ | Эндпоинты |
|---------|----------|
| [Chain API](chain.md) | Блоки, транзакции, балансы, адреса, stats |
| [Contracts API](contracts.md) | Деплой, вызов, state, логи |
| [Relay API](relay.md) | Отправка сообщений, inbox, контакты |
## Формат ошибок
```json
{"error": "описание ошибки"}
```
HTTP-статус: 400 для клиентских ошибок, 500 для серверных.
## Аутентификация
REST API не требует аутентификации. Транзакции подписываются на стороне клиента (CLI-командами) и отправляются как подписанные JSON-объекты. API не имеет admin-эндпоинтов требующих токенов.
## Пример
```bash
# Статистика сети
curl http://localhost:8081/api/stats
# Баланс адреса
curl http://localhost:8081/api/balance/03a1b2c3...
# Последние блоки
curl http://localhost:8081/api/blocks?limit=10
```