Skip to content

docs: fix README inaccuracies from code review #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wcatz merged 1 commit into from
Mar 13, 2026
Merged

docs: fix README inaccuracies from code review #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Edit `config.yaml`:
```yaml
mode: "lite"
poolId: "YOUR_POOL_ID_HEX"
ticker: "DUCK"
poolName: "My Pool"
nodeAddress:
host1: "your-node:3001"
Expand Down Expand Up @@ -63,7 +62,8 @@ Adds full chain sync, self-computed nonces, and local leader schedule calculatio
```yaml
mode: "full"
nodeAddress:
host1: "your-node:3001"
host1: "your-node:3001" # NtN (chain sync)
ntcHost: "your-node:30000" # NtC (stake queries, tip) — or UNIX socket path

leaderlog:
enabled: true
Expand Down Expand Up @@ -139,10 +139,10 @@ Epoch 259's nonce is hardcoded because it is the only mainnet epoch where the `e

The next epoch's nonce becomes deterministic after the stability window. duckBot triggers leader schedule calculation automatically at this point.

| Era | Stability Window | Slots Before Epoch End |
|-----|-----------------|----------------------|
| Shelley–Babbage | `3k/f` = 302,400 slots | 129,600 (~1.5 days) |
| Conway | `4k/f` = 259,200 slots | 172,800 (~2 days) |
| Era | Margin (`k`/`f`) | Freeze Point | Slots Before Epoch End |
|-----|-------------------|-------------|----------------------|
| Shelley–Babbage | `3k/f` = 129,600 | 302,400 (70%) | 129,600 (~1.5 days) |
| Conway | `4k/f` = 172,800 | 259,200 (60%) | 172,800 (~2 days) |

### Historical Sync Pipeline

Expand Down Expand Up @@ -172,7 +172,7 @@ sync.go (NtN ChainSync) → blockCh [10,000 buf] → batch writer → InsertBloc
| **Set** | End of epoch N-2 | Current epoch |
| **Go** | End of epoch N-3 | Previous epoch |

Queried via Koios API.
Queried via NtC `QueryPoolStakeSnapshots` (primary) with Koios API fallback.

### DB Integrity Check

Expand All @@ -188,6 +188,7 @@ If nonce is stale but blocks valid: recompute from `blocks` table.

| Command | Description |
|---------|-------------|
| `/menu` | Inline keyboard with all commands (primary group chat interface) |
| `/help` | Available commands |
| `/status` | DB sync status |
| `/tip` | Current chain tip |
Expand Down Expand Up @@ -254,8 +255,10 @@ helm install goduckbot oci://ghcr.io/wcatz/helm-charts/goduckbot
| `cli.go` | CLI subcommands (version, leaderlog, nonce, history) |
| `commands.go` | Telegram bot command handlers |
| `integrity.go` | Startup DB validation (FindIntersect + nonce repair) |
| `localquery.go` | NtC local state queries (QueryTip, QueryPoolStakeSnapshots) |
| `store.go` | Store interface + SQLite implementation |
| `db.go` | PostgreSQL implementation (pgx CopyFrom) |
| `securekey.go` | mmap/mlock/mprotect for VRF key material |

### Key Dependencies

Expand Down
1 change: 0 additions & 1 deletion config.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
mode: "lite"

poolId: "YOUR_POOL_ID"
ticker: "TICKER"
poolName: "Pool Name"
nodeAddress:
# Docker Compose (UNIX socket — recommended):
Expand Down
Loading