README
¶
gloomberg
⚠️ this is a wip poc (also the docs!) so I cant provide any support, sorry! you have to know how to use this code yourself for now ⚠️
random screenshots
requirements
- get your wallet address or ens yourDegenWallet.eth or 0x9e7DC5307940fa170F9093Ca548bDa0EDB602767
- get an account at Infura/Alchemy/whatever to get a websockets endpoint to an ethereum node wss://mainnet.infura.io/ws/v3/32e98f6ffb81456df24087ab5b
recommended ☝️
‼️ use redis as cache for collection & ENS names! it saves a lot of (limited) calls to a node and is also faster than calls to a node. you can use the redis docker image for this or install redis on a local machine.
most simple configuration example with redis running on 10.0.0.2:6379 (default port, database and no password):
# redis cache
redis:
# use redis as name & sale cache
enabled: true
# redis host
host: 10.0.0.2
there is also an ultra-simple built-in cache but without any persistence and therefore empty on every new start of gloomberg.
lfg! or getting started
# get link to latest linux amd64 binary
GBL=$(curl -L -s -H 'Accept: application/json' https://github.com/benleb/gloomberg/releases/latest | sed -e 's/.*"tag_name":"\([^"]*\)".*/\1/')
# download binary and extract it to /usr/local/bin
wget -qO- https://github.com/benleb/gloomberg/releases/download/${GBL}/gloomberg_${GBL/v/}_linux_amd64.tar.gz | sudo tar -C /usr/local/bin -vzx gloomberg
# run
gloomberg live -e "wss://mainnet.infura.io/ws/v3/32e9..." -w "yourDegenWallet.eth"
docker
docker run --rm -it \
--env "GLOOMBERG_ENDPOINTS=wss://mainnet.infura.io/ws/v3/32e9..."
--env "GLOOMBERG_WALLETS=yourDegenWallet.eth"
ghcr.io/benleb/gloomberg:latest live
gloomberg‽
The name is a homage to the famous gloomberg professional artwork created by OSF
Thanks also to all the other testers and contributors not shown in the git history! 💰 ❌ 💤
development (wip)
see the (development) docs for further information
issues closed, PRs open (ping me if you want to contribute)
pre-commit
we use pre-commit to run some checks before committing. install like described in the docs
see the pre-commit config for the checks. you can also run them manually on your machine with pre-commit run --all-files. for more information see the docs
GitHub actions
we use similar checks to the pre-commit ones in the golangci-lint workflow to also check this on the "server side" and do it for pull requests. you can also run them manually on your machine with golangci-lint run. for more information see the docs
docs
we use mkdocs material (insiders) (based on mkdocs.org) for documentation. install like described in the mkdocs material docs
the docs will be automatically be built and deployed to benleb.github.io/gloomberg/ via the docs workflow (on every push/merge to the main branch)
contribute
local preview
start a local server to preview the docs at http://localhost:8000/
mkdocs serve
build
build the docs to the site folder
mkdocs build
Documentation
Source Files
Directories