smartcontractkit / notify-wallet-balance

A simple way to notify through slack when wallet funds are low.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Notify Wallet Balance

Linting

A basic micro service to track wallet addresses on different chains, and notify based on low balance thresholds.

Config

Configuration is done entirely through environment variables.

The app can notify you through slack. To do so, you need to install your own slack bot, and use its auth.

SLACK_API_KEY="xoxb-abc" ## Slack API key for bot
SLACK_CHANNEL="C123" ## Slack Channel to send messages to
SLACK_USER="U111" ## Slack User ID to notify for slack messages

Set which networks you would like to check on with NETWORK_PREFIXES.

NETWORK_PREFIXES="GOERLI,OPTIMISM_GOERLI"

Each Network listed is used as a prefix for other env vars.

# Goerli
GOERLI_URL="wss://goerli-url" ## Websocket URL for the network
GOERLI_ADDRESSES="0xaaa,0xbbb" ## List of addresses to monitor
GOERLI_LOWER_LIMIT=30 ## How many ETH to consider worth notifying about a low balance
GOERLI_POLL_INTERVAL="30m" ## Time string on how often to check the address balances

# Optimism Goerli
OPTIMISM_GOERLI_URL="wss://optimism-url"
OPTIMISM_GOERLI_ADDRESSES="0xaaa,0xbbb"
OPTIMISM_GOERLI_LOWER_LIMIT=10
OPTIMISM_GOERLI_POLL_INTERVAL="10m" 

Run

When running locally, you can use plain go.

go run .

A docker image can be found at kalverra/notify-wallet-balance.

About

A simple way to notify through slack when wallet funds are low.

License:MIT License


Languages

Language:Go 96.9%Language:Dockerfile 3.1%