notify-wallet-balance

command module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2023 License: MIT Imports: 16 Imported by: 0

README

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
NOTIFICATION_INTERVAL="4h" ## How often to check and notify

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

NETWORK_PREFIXES="OPTIMISM_GOERLI,ARBITRUM_GOERLI"

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

# Arbitrum Goerli
ARBITRUM_GOERLI_URL="wss://goerli-url" ## Websocket URL for the network
ARBITRUM_GOERLI_ADDRESSES="0xaaa,0xbbb" ## List of addresses to monitor
ARBITRUM_GOERLI_LOWER_LIMIT=30 ## How many ETH to consider worth notifying about a low balance
ARBITRUM_GOERLI_EXPLORER_URL="https://goerli.arbiscan.io/" ## URL to explorer if available for convenient links

# Optimism Goerli
OPTIMISM_GOERLI_URL="wss://optimism-url"
OPTIMISM_GOERLI_ADDRESSES="0xaaa,0xbbb"
OPTIMISM_GOERLI_LOWER_LIMIT=10
OPTIMISM_GOERLI_EXPLORER_URL="https://goerli-optimism.etherscan.io/"

Run

When running locally, you can use plain go.

go run .

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

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL