Docs update concerning consensus

This commit is contained in:
Raven Scott
2026-05-31 00:02:00 -04:00
parent cd23ca7bba
commit 1aff73eada
15 changed files with 258 additions and 78 deletions
+27 -4
View File
@@ -11,6 +11,9 @@ The Domain Consensus plugin offers an advanced dashboard for monitoring and unde
- Claims and claimants
- Quorum progress and requirements
- Real-time consensus metrics
- Sidecar health (`open`, `bootstrapComplete`, event/domain counts) on the overview dashboard
Resolution data comes from the Autobase consensus sidecar ([RFC 0001](../../docs/rfcs/0001-autobase-consensus.md)); see [CONSENSUS.md](../../docs/CONSENSUS.md) for algorithm details.
## Features
@@ -91,7 +94,7 @@ https://domain.consensus
The plugin exposes the following API endpoints:
- `GET /api/overview` - Returns aggregate consensus metrics and statistics
- `GET /api/overview` - Returns aggregate consensus metrics, statistics, and sidecar health
- `GET /api/domains` - Returns list of all domains with consensus status
- `GET /api/domain/:domain` - Returns detailed consensus state for a specific domain
- `GET /api/metrics` - Returns consensus metrics
@@ -117,6 +120,25 @@ The plugin uses WebSocket connections to receive real-time updates:
## Technical Details
### Overview Response (sidecar)
The overview endpoint includes a `sidecar` object (same shape as admin `GET /api/consensus/status`):
```javascript
{
open: boolean,
ready: boolean,
writable: boolean,
bootstrapComplete: boolean,
eventCount: number,
domainCount: number,
lastApplyAt: number | null,
indexedLength: number,
length: number,
key: string | null // hex
}
```
### Consensus State Structure
Each domain's consensus state includes:
@@ -240,7 +262,8 @@ P2NS Team
## Related Documentation
- [P2NS Plugin System Documentation](../../docs/PLUGINS.md)
- [Plugin SDK Reference](../../docs/PLUGIN_SDK.md)
- [Consensus Mechanism](../../README.md#dns-conflict-selector)
- [P2NS Plugin System Documentation](../../docs/plugins/README.md)
- [Plugin SDK Reference](../../docs/plugins/PLUGIN_SDK.md)
- [Consensus Mechanism](../../docs/CONSENSUS.md)
- [RFC 0001: Autobase Consensus](../../docs/rfcs/0001-autobase-consensus.md)