p2pool-observer

P2Pool Observer

This repository contains several libraries and utilities to produce statistics and historical archives of Monero P2Pool decentralized pool, including consensus-compatible reimplementation of a P2Pool server instance.

Other general tools to work with Monero cryptography are also included.

Reporting issues

You can give feedback or report / discuss issues on:

• The issue tracker on git.gammaspectra.live/P2Pool/p2pool-observer
• Via IRC on #p2pool-observer@libera.chat, or via Matrix
• Any of the relevant rooms for the specific observer instances listed below.

Maintainer-run Observer Instances

Donations

This project is provided for everyone to use, for free, as a hobby project. Any support is appreciated.

Donate to support this project, its development, and running the Observer Instances on 4AeEwC2Uik2Zv4uooAUWjQb2ZvcLDBmLXN4rzSn3wjBoY8EKfNkSUqeg5PxcnWTwB1b2V39PDwU9gaNE5SnxSQPYQyoQtr7

You can also use the OpenAlias p2pool.observer directly on the GUI.

Operational instructions

A docker-compose setup is provided and documented.

If desired each tool can be run individually, but that is left to the user to configure, refer to Docker setup as reference.

Requirements

• docker-compose or similar
• git installed
• Disk space for new incoming historic data. Assume a few tens of MiB per day
• A monerod non-pruned node running in unrestricted mode preferably, but can work with restricted mode.
• Enough RAM to fit state and incoming queries. It can run with lower with adjustment of settings, but 8 GiB per instance should be fine.

Initial setup

$ git clone https://git.gammaspectra.live/P2Pool/p2pool-observer.git test-instance
$ cd test-instance
$ cp .env.example .env

Edit .env via your preferred editor, specifically around the monerod host options and generate keys for the Tor hidden service.

If you want to make changes to additional docker-compose settings, do not edit docker-compose.yml. Instead create docker-compose.override.yml and place new settings there. See Multiple Compose files documentation.

Update / Apply new settings

Within the instance folder, run this command

$ git checkout -- '*/default.pgo'; \
git pull && \
docker-compose build --pull && \
docker-compose up -d && \
docker-compose restart tor site pgo-p2pool pgo-daemon pgo-web pgo-api

docker-compose restart tor is necessary due to the tor server not refreshing DNS of the containers.

It is recommended to run docker system prune regularly or after update to cleanup no longer used images.

Backfill likely sweep transactions

When a new instance starts with previously imported archives you might want to backfill sweep transactions. For new instances this is not necessary, and you can also skip this step and just rely on future data.

$ docker-compose exec --workdir /usr/src/p2pool daemon \
go run -v git.gammaspectra.live/P2Pool/p2pool-observer/cmd/scansweeps \
-host MONEROD_HOST -rpc-port MONEROD_RPC_PORT \
-api-host "http://p2pool:3131" \
-db="host=db port=5432 dbname=p2pool user=p2pool password=p2pool sslmode=disable"

Can also specify -e TRANSACTION_LOOKUP_OTHER=https://OTHER_INSTANCE just before daemon to query other instances additionally with alternate or longer history.

Development notes

Requires using CGO when running the main modes where RandomX hashes are used, but can be used with CGO_ENABLED=0 specifically as a library.

You can install the RandomX dependency via this command:

$ git clone --depth 1 --branch master https://github.com/tevador/RandomX.git /tmp/RandomX && cd /tmp/RandomX && \
    mkdir build && cd build && \
    cmake .. -DCMAKE_BUILD_TYPE=Release -D CMAKE_INSTALL_PREFIX:PATH=/usr && \
    make -j$(nproc) && \
    sudo make install && \
    cd ../ && \
    rm -rf /tmp/RandomX

To generate web templates, run this command:

$ go run github.com/valyala/quicktemplate/qtc@v1.7.0

To update module dependencies, use these commands:

$ for f in $(find . -name go.mod); do (cd $(dirname $f); GOPROXY=direct go get -u ./...); done
$ for f in $(find . -name go.mod); do (cd $(dirname $f); GOPROXY=direct go mod tidy); done
$ go work sync