Skip to content

Commit 4188e27

Browse files
docs: fix stale content across 9 pages (round 2) (#645)
* fix(ledger): use per-pool deposit map for deposits_stake in epoch-state dump `epoch_state_debug::capture` was computing the pool-deposit component of `deposited` as `pool_params.len() × curPParams.pool_deposit`. This breaks when `pool_deposit` changes via PPUP after some pools are already registered: pools registered before the change paid the old deposit, so the approximation drifts from the actual locked amount. `certs.pool_deposits` already tracks the exact deposit paid at registration time for each pool (same map used by shelley.rs and conway.rs for obligation calc). Switch the dump to sum that map instead. Ref: issue #615 (deposits_stake divergence sub-item). * style: rustfmt epoch_state_debug.rs * chore(docs): update crate count 14→15 in CLAUDE.md, add dugite-uplc and dugite-lsm * chore(conformance): update corpus to v20260524-075059; fix mithril stub check Mithril area now has 20 real fixture files at the pinned SHA, so the verification step's "mithril must be stub" assertion is no longer correct. Remove that check (it was based on an outdated observation). New corpus stats: ouroboros-consensus: 277 files cardano-ledger: 17 files cardano-node: 14 files plutus: 3001 files ledger-rules: 28295 files ← ImpSpec Haskell ledger-rules corpus cardano-base: 14 files mithril: 20 files ← now real (was stub) * fix(conformance): expand DELEG decoder to accept tags 2 and 13 The new ImpSpec corpus (conformance-corpus-v20260524-075059) includes DELEG vectors with: - tag 2: Shelley `StakeDelegation` (backwards-compat delegation in Conway) - tag 13: `ConwayRegDelegCert DelegStakeVote` (register + pool + DRep) The decoder previously only accepted tags 7–12. Extend to: tag == 2 || 7..=13 (matching the full Conway TxCert spec) Reference: cardano-ledger TxCert.hs ConwayTxCert encoding. * test(ledger): update capture_combines_stake_key_and_pool_deposits to use pool_deposits map The test was inserting pools into pool_params but not pool_deposits, so the new implementation (pool_deposits.values().sum()) returned 0 pool deposits. Update the test to: - populate pool_deposits with per-pool historical deposit amounts - demonstrate the key property: dumps use historical values even when pool_deposit has changed via PPUP (pool 0xaa at 400 ADA, pools 0x10/0x11 at 500 ADA, current param 600 ADA; expected total uses historical values) * docs: fix stale content across 9 pages (round 2) - quickstart.md: remove unpublished Docker image examples (#507) - running/configuration.md: fix peer target defaults (EstablishedPeers 40→30, ActivePeers 15→20, KnownPeers 85→150 to match code defaults) - running/config-editor.md: fix EstablishedPeers example 40→30 - running/relay.md: add dugite_ prefix to metric names in monitoring table - running/block-producer.md: add dugite_ prefix + _total suffix to metrics in deployment checklist - running/kubernetes.md: add "image not yet published" note (#507) - reference/upgrading.md: remove Docker pull example (image not published) - reference/mini-protocols.md: remove N2N V16/perasSupport (not implemented; Dugite supports V14/V15 only — #607) - architecture/networking.md: fix EstablishedPeers default 30→"40 (30 on preview)" to correctly reflect mainnet/preprod vs preview config difference
1 parent 3643abc commit 4188e27

9 files changed

Lines changed: 19 additions & 38 deletions

File tree

docs/src/architecture/networking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ The governor maintains six independent target counts (matching cardano-node defa
314314
| Target | Default | Description |
315315
|--------|---------|-------------|
316316
| `TargetNumberOfKnownPeers` | 85 | Total peers in the peer table (cold + warm + hot) |
317-
| `TargetNumberOfEstablishedPeers` | 30 | Warm + hot peers (TCP connected) |
317+
| `TargetNumberOfEstablishedPeers` | 40 (30 on preview) | Warm + hot peers (TCP connected) |
318318
| `TargetNumberOfActivePeers` | 15 | Hot peers (fully syncing) |
319319
| `TargetNumberOfKnownBigLedgerPeers` | 15 | Known big ledger peers |
320320
| `TargetNumberOfEstablishedBigLedgerPeers` | 10 | Established big ledger peers |

docs/src/quickstart.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,7 @@ tar xzf dugite-x86_64-linux.tar.gz
1212
sudo mv dugite-node dugite-cli dugite-monitor dugite-config /usr/local/bin/
1313
```
1414

15-
**Option B: Container image**
16-
17-
```bash
18-
docker pull ghcr.io/michaeljfazio/dugite:latest
19-
```
15+
**Option B: Container image** *(coming soon — [#507](https://github.com/michaeljfazio/dugite/issues/507))*
2016

2117
**Option C: Build from source**
2218

@@ -58,17 +54,6 @@ Or via the top-level [justfile](./development.md):
5854
just run-relay preview
5955
```
6056

61-
Or with Docker:
62-
63-
```bash
64-
docker run -d \
65-
--name dugite \
66-
-p 3001:3001 \
67-
-p 12798:12798 \
68-
-v dugite-data:/opt/dugite/db \
69-
ghcr.io/michaeljfazio/dugite:latest
70-
```
71-
7257
The node will:
7358
1. Load the configuration and genesis files
7459
2. Replay imported blocks through the ledger (builds UTxO set, protocol params, delegations)

docs/src/reference/mini-protocols.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,18 @@ MsgQueryReply = [3, versionTable]
173173
; Keys are encoded in ascending order.
174174
versionTable = { * versionNumber => versionData }
175175
176-
; N2N version numbers (V14=14, V15=15, V16=16, ...)
176+
; N2N version numbers implemented by Dugite (V14=14, V15=15)
177177
; Note: N2N does NOT set bit-15. Only N2C uses bit-15.
178-
versionNumber = 14 / 15 / 16
178+
; V16 (adds perasSupport) is defined in the Peras spec but not yet implemented.
179+
versionNumber = 14 / 15
179180
180181
; Version data for V14/V15: 4-element array
181182
versionData_v14 = [networkMagic, initiatorOnly, peerSharing, query]
182-
; Version data for V16+: 5-element array (adds perasSupport)
183-
versionData_v16 = [networkMagic, initiatorOnly, peerSharing, query, perasSupport]
184183
185184
networkMagic = uint .size 4 ; word32 (mainnet=764824073, preview=2, preprod=1)
186185
initiatorOnly = bool ; true=InitiatorOnly, false=InitiatorAndResponder
187186
peerSharing = 0 / 1 ; 0=Disabled, 1=Enabled
188187
query = bool
189-
perasSupport = bool
190188
191189
refuseReason
192190
= [0, [* versionNumber]] ; VersionMismatch

docs/src/reference/upgrading.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,7 @@ sudo cp target/release/dugite-node target/release/dugite-cli \
4242
/usr/local/bin/
4343
```
4444

45-
**Container:**
46-
47-
```bash
48-
docker pull ghcr.io/michaeljfazio/dugite:latest
49-
```
45+
**Container:** *(coming soon — [#507](https://github.com/michaeljfazio/dugite/issues/507))*
5046

5147
### 3. Clear Ledger Snapshots (if the snapshot format changed)
5248

docs/src/running/block-producer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,6 @@ graph TB
354354

355355
4. **Verify block production**
356356
- Confirm sync progress is 100% on all nodes
357-
- Check `peers_connected` metrics on relays and BP
358-
- Monitor `blocks_forged` metric on the BP after epoch transition
357+
- Check `dugite_peers_connected` metrics on relays and BP
358+
- Monitor `dugite_blocks_forged_total` metric on the BP after epoch transition
359359
- Set up [monitoring](./monitoring.md) and KES rotation reminders

docs/src/running/config-editor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ dugite-config init --out-file "$CONFIG" \
157157
dugite-config set "$CONFIG" EnableP2P true
158158
dugite-config set "$CONFIG" DiffusionMode InitiatorAndResponder
159159
dugite-config set "$CONFIG" TargetNumberOfActivePeers 15
160-
dugite-config set "$CONFIG" TargetNumberOfEstablishedPeers 40
160+
dugite-config set "$CONFIG" TargetNumberOfEstablishedPeers 30
161161
dugite-config set "$CONFIG" TargetNumberOfKnownPeers 85
162162
dugite-config validate "$CONFIG"
163163
```

docs/src/running/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The configuration file uses PascalCase keys (matching the cardano-node conventio
2222
"ConwayGenesisFile": "conway-genesis.json",
2323
"TargetNumberOfRootPeers": 60,
2424
"TargetNumberOfActivePeers": 15,
25-
"TargetNumberOfEstablishedPeers": 40,
25+
"TargetNumberOfEstablishedPeers": 30,
2626
"TargetNumberOfKnownPeers": 85,
2727
"TargetNumberOfActiveBigLedgerPeers": 5,
2828
"TargetNumberOfEstablishedBigLedgerPeers": 10,
@@ -78,9 +78,9 @@ These parameters control the P2P peer governor's target counts, matching the car
7878
| Field | Type | Default | Description |
7979
|-------|------|---------|-------------|
8080
| `TargetNumberOfRootPeers` | integer | 60 | Target number of root peers (bootstrap + local + public roots) |
81-
| `TargetNumberOfActivePeers` | integer | 15 | Target number of active (hot) peers — fully syncing with ChainSync + BlockFetch |
82-
| `TargetNumberOfEstablishedPeers` | integer | 40 | Target number of established (warm) peers — TCP connected, keepalive running |
83-
| `TargetNumberOfKnownPeers` | integer | 85 | Target number of known (cold) peers in the peer table |
81+
| `TargetNumberOfActivePeers` | integer | 20 | Target number of active (hot) peers — fully syncing with ChainSync + BlockFetch |
82+
| `TargetNumberOfEstablishedPeers` | integer | 30 | Target number of established (warm) peers — TCP connected, keepalive running |
83+
| `TargetNumberOfKnownPeers` | integer | 150 | Target number of known (cold) peers in the peer table |
8484
| `TargetNumberOfActiveBigLedgerPeers` | integer | 5 | Target number of active big ledger peers (high-stake SPOs, prioritised during sync) |
8585
| `TargetNumberOfEstablishedBigLedgerPeers` | integer | 10 | Target number of established big ledger peers |
8686
| `TargetNumberOfKnownBigLedgerPeers` | integer | 15 | Target number of known big ledger peers |

docs/src/running/kubernetes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Kubernetes Deployment
22

3+
> **Note:** The Dugite container image is not yet published to a registry ([#507](https://github.com/michaeljfazio/dugite/issues/507)). The Helm chart and instructions below describe the target deployment model; they will be fully operational once the image is available.
4+
35
Dugite includes a Helm chart for deploying to Kubernetes as either a **relay node** or a **block producer**.
46

57
## Prerequisites

docs/src/running/relay.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,10 @@ Dugite exposes Prometheus metrics on port 12798 by default. Key metrics to watch
167167

168168
| Metric | What it tells you |
169169
|--------|-------------------|
170-
| `peers_connected` | Number of active peer connections. Should be > 0 at all times |
171-
| `sync_progress_percent` | Sync progress (10000 = 100%). Must be at 100% for the BP to produce blocks |
172-
| `blocks_received` | Total blocks received from peers. Should increase steadily |
173-
| `slot_number` | Current slot. Compare against network tip to verify sync |
170+
| `dugite_peers_connected` | Number of active peer connections. Should be > 0 at all times |
171+
| `dugite_sync_progress_percent` | Sync progress (10000 = 100%). Must be at 100% for the BP to produce blocks |
172+
| `dugite_blocks_received_total` | Total blocks received from peers. Should increase steadily |
173+
| `dugite_slot_number` | Current slot. Compare against network tip to verify sync |
174174

175175
```bash
176176
curl -s http://localhost:12798/metrics | grep -E "peers_connected|sync_progress"

0 commit comments

Comments
 (0)