goduckbot/config.yaml.example at 16204f5d76db618c9075709359c445f0702ed0c6 · wcatz/goduckbot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# goduckbot configuration
#
# Mode: "lite" (default) or "full"
#   lite: Uses adder to tail chain from tip, Koios API for epoch nonces
#   full: Historical chain sync from Shelley genesis, builds local nonce history
mode: "lite"

poolId: "YOUR_POOL_ID"
ticker: "TICKER"
poolName: "Pool Name"
nodeAddress:
  # Docker Compose (UNIX socket — recommended):
  host1: "cardano-node:3001"            # NtN (chain sync)
  ntcHost: "/ipc/node.socket"           # NtC (direct UNIX socket)

  # Remote node (TCP via socat bridge):
  # host1: "your-node:3001"             # NtN (chain sync)
  # host2: "backup-node:3001"           # NtN (optional failover)
  # ntcHost: "your-node:30000"          # NtC (via socat TCP bridge)

networkMagic: 764824073  # mainnet. preprod is 1, preview is 2 and sancho is 4.

telegram:
  enabled: true  # set to false to disable Telegram notifications
  token: "YOUR_TELEGRAM_BOT_TOKEN"
  channel: "YOUR_TELEGRAM_CHANNEL_ID"
  allowedUsers: []     # Admin user IDs (full access to all commands)
  allowedGroups: []    # Group IDs where safe commands are allowed (e.g. [-1001234567890])

twitter:
  enabled: false  # set to true to enable Twitter/X notifications
  apiKey: ""
  apiKeySecret: ""
  accessToken: ""
  accessTokenSecret: ""

# Duck media for notifications and /duck command
duck:
  media: "both"      # "gif", "image", or "both" (default: both)
  # customUrl: ""    # Override random-d.uk with your own hosted URL.
                     # This interferes with core duckBot functionality
                     # but if you must... quack.

leaderlog:
  enabled: true
  vrfKeyValue: "5840..."     # inline CBOR hex from vrf.skey cborHex field (preferred)
  # vrfKeyPath: "/keys/vrf.skey"  # file path (fallback, not recommended)
  timezone: "America/New_York"
  timeFormat: "12h"           # "12h" or "24h"

  # Advanced (full mode only):
  # nonceIntegrityCheck: false  # After nonce backfill, verify computed nonces against Koios
  #                              # and log any mismatches. Safe to enable; adds ~1 API call/epoch.
  # backfillSchedules: false    # After nonce backfill, calculate and store leader schedules
  #                              # for all historical epochs where nonce data is available.

# Koios API configuration
# By default, goduckbot uses the public koios.rest endpoints:
#   mainnet: https://api.koios.rest/api/v1
#   preprod: https://preprod.koios.rest/api/v1
#   preview: https://preview.koios.rest/api/v1
# Set koios.url to point at a private Koios mirror (applies to all networks).
#koios:
#  url: "https://your-private-koios-mirror.example.com/api/v1"

# Database configuration (only used when leaderlog.enabled is true)
database:
  driver: "sqlite"              # "sqlite" (default) or "postgres"
  path: "/app/data/goduckbot.db" # SQLite path (use /app/data/ for docker volume)
  # PostgreSQL settings (only used with driver: postgres)
  host: "postgres"              # "postgres" for docker-compose, or your DB host
  port: 5432
  name: "goduckbot"
  user: "goduckbot"
  password: ""