Jackal

HW & SW Requeriments

• 1 vCPU

• 2 GB of ram

• 20 GB of free space (for signing logs)

• Tested in Ubuntu Server 22.04 / Rocky Linux 8 x64

Make the updates and install the necessary packages.

sudo apt update && sudo apt upgrade
sudo apt install golang-go

install tenderduty

sudo addgroup --system tenderduty 
sudo adduser --ingroup tenderduty --system --home /var/lib/tenderduty tenderduty

sudo -su tenderduty
cd ~
echo 'export PATH=$PATH:~/go/bin' >> .bashrc
. .bashrc
git clone https://github.com/blockpane/tenderduty
cd tenderduty
go install
cp example-config.yml ../config.yml
cd

1. Open the Telegram App: Launch the Telegram application on your mobile device or desktop computer.

2. Find BotFather: Type "BotFather" in the search bar to locate Telegram's official bot creation service.

3. Start a Chat with BotFather: Navigate to the BotFather profile and start a conversation.

4. Create a New Bot: Use the /newbot command to initiate the process of creating a new bot. BotFather will ask you a series of questions following this command.

   

   Follow these steps for the CHANNEL section:

   1. Add the Telegram BOT to the group.

   2. Get the list of updates for your BOT:

   https://api.telegram.org/bot<YourBOTToken>/getUpdates

   Ex:

   https://api.telegram.org/bot123456789:jbd78sadvbdy63d37gda37bd8/getUpdates

   1. Look for the "chat" object:

   {
       "update_id": 8393,
       "message": {
           "message_id": 3,
           "from": {
               "id": 7474,
               "first_name": "AAA"
           },
           "chat": {
               "id": <group_ID>,
               "title": "<Group name>"
           },
           "date": 25497,
           "new_chat_participant": {
               "id": 71, 
               "first_name": "NAME",
               "username": "YOUR_BOT_NAME"
           }
       }
   }

   This is a sample of the response when you add your BOT into a group.

   1. Add the group ID to the CHANNEL section.

Fill with your info

API_KEY=6549793165xx
CHANNEL=-100xxx
CHAIN_NAME=Jackal
CHAIN_ID=jackal-1
VALOPER_ADDRESS=jklvaloper1xxxx

Setting config.yml (one command, dont touch anything)

tee <<EOF >/dev/null config.yml
---

enable_dashboard: yes
listen_port: 8888
hide_logs: yes
node_down_alert_minutes: 3
prometheus_enabled: yes
prometheus_listen_port: 28686

pagerduty:
  enabled: no
  api_key: aaaaaaaaaaaabbbbbbbbbbbbbcccccccccccc
  default_severity: alert
discord:
  enabled: no
  webhook: https://discord.com/api/webhooks/999999999999999999/zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
telegram:
  enabled: yes
  api_key: '${API_KEY}'
  channel: "${CHANNEL}"

chains:
  "${CHAIN_NAME}":
    chain_id: ${CHAIN_ID}
    valoper_address: ${VALOPER_ADDRESS}
    public_fallback: yes
    alerts:
      # If the chain stops seeing new blocks, should an alert be sent?
      stalled_enabled: yes
      # How long a halted chain takes in minutes to generate an alarm
      stalled_minutes: 10
      # Most basic alarm, you just missed x blocks ... would you like to know?
      consecutive_enabled: yes
      # How many missed blocks should trigger a notification?
      consecutive_missed: 1
      # NOT USED: future hint for pagerduty's routing
      consecutive_priority: critical
      # For each chain there is a specific window of blocks and a percentage of missed blocks that will result in
      # a downtime jail infraction. Should an alert be sent if a certain percentage of this window is exceeded?
      percentage_enabled: yes
      # What percentage should trigger the alert
      percentage_missed: 10
      # Not used yet, pagerduty routing hint
      percentage_priority: warning
      # Should an alert be sent if the validator is not in the active set ie, jailed,
      # tombstoned, unbonding?
      alert_if_inactive: yes
      # Should an alert be sent if no RPC servers are responding? (Note this alarm is instantaneous with no delay)
      alert_if_no_servers: yes

      # Chain specific setting for pagerduty
      pagerduty:
        enabled: no
        api_key: "" # uses default if blank
      # Discord settings
      discord:
        enabled: no
        webhook: "" # uses default if blank
      # Telegram settings
      telegram:
        enabled: yes
        api_key: "${API_KEY}" # uses default if blank
        channel: "${CHANNEL}" # uses default if blank

       nodes:
      - url: https://rpc-jackal.whispernode.com:443
        alert_if_down: no
      - url: https://rpc-jackal.huginn.tech:443
        alert_if_down: no


EOF

Exit from tenderduty user

exit

Create and enable the service (one command)

sudo tee /etc/systemd/system/tenderduty.service << EOF
[Unit]
Description=Tenderduty
After=network.target
ConditionPathExists=/var/lib/tenderduty/go/bin/tenderduty

[Service]
Type=simple
Restart=always
RestartSec=5
TimeoutSec=180

User=tenderduty
WorkingDirectory=/var/lib/tenderduty
ExecStart=/var/lib/tenderduty/go/bin/tenderduty

# there may be a large number of network connections if a lot of chains
LimitNOFILE=infinity

# extra process isolation
NoNewPrivileges=true
ProtectSystem=strict
RestrictSUIDSGID=true
LockPersonality=true
PrivateUsers=true
PrivateDevices=true
PrivateTmp=true

[Install]
WantedBy=multi-user.target
EOF

Start systemd service

sudo systemctl daemon-reload
sudo systemctl enable tenderduty
sudo systemctl start tenderduty

# Check logs 
sudo journalctl -fu tenderduty