go-p2pool/main.go

package main

import (
	"bufio"
	"flag"
	"fmt"
	"git.gammaspectra.live/P2Pool/consensus/v3/monero/client"
	"git.gammaspectra.live/P2Pool/consensus/v3/p2pool/p2p"
	"git.gammaspectra.live/P2Pool/consensus/v3/p2pool/sidechain"
	"git.gammaspectra.live/P2Pool/consensus/v3/p2pool/stratum"
	"git.gammaspectra.live/P2Pool/consensus/v3/p2pool/types"
	"git.gammaspectra.live/P2Pool/consensus/v3/utils"
	"log"
	"net"
	"net/http"
	_ "net/http/pprof"
	"net/netip"
	"os"
	"os/signal"
	"runtime"
	"runtime/debug"
	"slices"
	"strconv"
	"strings"
	"sync"
	"syscall"
	"time"
)

func main() {
	currentConsensus := sidechain.ConsensusDefault

	//monerod related
	moneroHost := flag.String("host", "127.0.0.1", "IP address of your Monero node")
	moneroRpcPort := flag.Uint("rpc-port", 18081, "monerod RPC API port number")
	moneroZmqPort := flag.Uint("zmq-port", 18083, "monerod ZMQ pub port number")

	// consensus related
	consensusConfigFile := flag.String("consensus-config", "", "Name of the p2pool consensus config file")
	useMiniSidechain := flag.Bool("mini", false, "Connect to p2pool-mini sidechain. Note that it will also change default p2p port.")

	//p2p peering related
	p2pListen := flag.String("p2p", fmt.Sprintf("0.0.0.0:%d", currentConsensus.DefaultPort()), "IP:port for p2p server to listen on.")
	p2pExternalPort := flag.Uint64("p2p-external-port", 0, "Port number that your router uses for mapping to your local p2p port. Use it if you are behind a NAT and still want to accept incoming connections")
	outPeers := flag.Uint64("out-peers", 10, "Maximum number of outgoing connections for p2p server (any value between 10 and 450)")
	inPeers := flag.Uint64("in-peers", 10, "Maximum number of incoming connections for p2p server (any value between 10 and 450)")
	addPeers := flag.String("addpeers", "", "Comma-separated list of IP:port of other p2pool nodes to connect to")
	addSelf := flag.Bool("add-self-peer", false, "Adds itself to the peer list regularly, based on found local interfaces for IPv4/IPv6")
	peerList := flag.String("peer-list", "p2pool_peers.txt", "Either a path or an URL to obtain peer lists from. If it is a path, new peers will be saved to this path. Set to empty to disable")

	//stratum related
	stratumListen := flag.String("stratum", "", "IP:port for stratum server to listen on. Empty to disable.")

	//other settings
	lightMode := flag.Bool("light-mode", false, "Don't allocate RandomX dataset, saves 2GB of RAM")
	noDns := flag.Bool("no-dns", false, "Disable DNS queries, use only IP addresses to connect to peers (seed node DNS will be unavailable too)")
	memoryLimitInGiB := flag.Uint64("memory-limit", 0, "Memory limit for go managed sections in GiB, set 0 to disable")

	apiBind := flag.String("api-bind", "", "Bind to this address to serve blocks, and other utility methods. If -archive is specified, serve archived blocks.")
	createArchive := flag.String("archive", "", "If specified, create an archive store of sidechain blocks on this path.")
	blockCache := flag.String("block-cache", "p2pool.cache", "Block cache for faster startups. Set to empty to disable")

	//testing settings
	doDebug := flag.Bool("debug", false, "Log more details. Default false")
	ipv6Only := flag.Bool("ipv6-only", false, "Use only IPv6. Default false")

	debugListen := flag.String("debug-listen", "", "Provide a bind address and port to expose a pprof HTTP API on it.")

	//TODO extend verbosity to debug flag
	flag.Parse()

	if *doDebug {
		utils.LogFile = true
		utils.GlobalLogLevel |= utils.LogLevelNotice | utils.LogLevelDebug
	}

	if buildInfo, _ := debug.ReadBuildInfo(); buildInfo != nil {
		utils.Logf("P2Pool", "Consensus Software %s %s %s (%s)", types.CurrentSoftwareId, types.CurrentSoftwareVersion, buildInfo.Main.Version, buildInfo.GoVersion)
	} else {
		utils.Logf("P2Pool", "Consensus Software %s %s (%s)", types.CurrentSoftwareId, types.CurrentSoftwareVersion, runtime.Version())
	}

	client.SetDefaultClientSettings(fmt.Sprintf("http://%s:%d", *moneroHost, *moneroRpcPort))

	debug.SetTraceback("all")
	if *memoryLimitInGiB != 0 {
		debug.SetMemoryLimit(int64(*memoryLimitInGiB) * 1024 * 1024 * 1024)
	}

	settings := make(map[string]string)
	settings["listen"] = *p2pListen

	changeConsensus := func(newConsensus *sidechain.Consensus) {
		oldListen := netip.MustParseAddrPort(settings["listen"])
		// if default exists, change port to match
		if settings["listen"] == fmt.Sprintf("%s:%d", oldListen.Addr().String(), currentConsensus.DefaultPort()) {
			settings["listen"] = fmt.Sprintf("%s:%d", oldListen.Addr().String(), newConsensus.DefaultPort())
		}
		currentConsensus = newConsensus
	}

	settings["rpc-url"] = fmt.Sprintf("http://%s:%d", *moneroHost, *moneroRpcPort)
	settings["zmq-url"] = fmt.Sprintf("tcp://%s:%d", *moneroHost, *moneroZmqPort)
	if *useMiniSidechain {
		changeConsensus(sidechain.ConsensusMini)
	}

	if *consensusConfigFile != "" {
		consensusData, err := os.ReadFile(*consensusConfigFile)
		if err != nil {
			utils.Panic(err)
		}

		if newConsensus, err := sidechain.NewConsensusFromJSON(consensusData); err != nil {
			utils.Panic(err)
		} else {
			changeConsensus(newConsensus)
		}
	}

	settings["out-peers"] = strconv.FormatUint(*outPeers, 10)
	settings["in-peers"] = strconv.FormatUint(*inPeers, 10)
	settings["external-port"] = strconv.FormatUint(*p2pExternalPort, 10)

	if *ipv6Only {
		settings["ipv6-only"] = "true"
	}

	if *blockCache != "" {
		settings["cache"] = *blockCache
	}

	if *createArchive != "" {
		settings["archive"] = *createArchive
	}

	if !*lightMode {
		settings["full-mode"] = "true"
	}

	if instance, err := NewP2Pool(currentConsensus, settings); err != nil {
		utils.Fatalf("Could not start p2pool: %s", err)
	} else {
		defer instance.Close(nil)

		if *apiBind != "" {

			serveMux := getServerMux(instance)

			server := &http.Server{
				Addr:        *apiBind,
				ReadTimeout: time.Second * 2,
				Handler: http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
					if request.Method != "GET" && request.Method != "HEAD" && request.Method != "POST" {
						writer.WriteHeader(http.StatusForbidden)
						return
					}

					utils.Logf("API", "Handling %s %s", request.Method, request.URL.String())

					serveMux.ServeHTTP(writer, request)
				}),
			}

			go func() {
				//TODO: context/wait
				if err := server.ListenAndServe(); err != nil {
					utils.Panic(err)
				}

			}()
		}

		if *debugListen != "" {
			go func() {
				if err := http.ListenAndServe(*debugListen, nil); err != nil {
					utils.Panic(err)
				}
			}()
		}

		if *stratumListen != "" {
			stratumServer := stratum.NewServer(instance.SideChain(), func(block *sidechain.PoolBlock) error {
				block.WantBroadcast.Store(true)
				block.Metadata = sidechain.PoolBlockReceptionMetadata{
					LocalTime: time.Now().UTC(),
				}
				if _, err, _ := instance.SideChain().AddPoolBlockExternal(block); err != nil {
					log.Printf("[Stratum] ERROR: Submitted block template id = %s, side height = %d, main height = %d, main_id = %s, nonce = %d, extra_nonce = %d add_pool_block_external error: %s", block.SideTemplateId(instance.Consensus()), block.Side.Height, block.Main.Coinbase.GenHeight, block.MainId(), block.Main.Nonce, block.ExtraNonce(), err)
					return err
				} else {
					log.Printf("[Stratum] SUCCESS: Submitted block template id = %s, side height = %d, main height = %d, main_id = %s, nonce = %d, extra_nonce = %d", block.SideTemplateId(instance.Consensus()), block.Side.Height, block.Main.Coinbase.GenHeight, block.MainId(), block.Main.Nonce, block.ExtraNonce())
				}
				return nil
			})
			listenerId := instance.AddListener(stratumServer.HandleTip, stratumServer.HandleBroadcast, nil, nil, stratumServer.HandleMinerData, stratumServer.HandleMempoolData)
			go func() {
				defer instance.RemoveListener(listenerId)
				if err := stratumServer.Listen(*stratumListen); err != nil {
					log.Panic(err)
				}
			}()
		}

		var connectList []netip.AddrPort
		for _, peerAddr := range strings.Split(*addPeers, ",") {
			if peerAddr == "" {
				continue
			}

			//TODO: dns resolution of hosts

			if addrPort, err := netip.ParseAddrPort(peerAddr); err != nil {
				utils.Panic(err)
			} else {
				instance.Server().AddToPeerList(addrPort)
				connectList = append(connectList, addrPort)
			}
		}

		if seedNodes := currentConsensus.SeedNodes(); !*noDns && len(seedNodes) > 0 {
			for _, seedNode := range seedNodes {
				utils.Logf("P2Pool", "Loading seed peers from %s", seedNode)
				records, _ := net.LookupTXT(seedNode)
				if len(records) > 0 {
					for _, r := range records {
						for _, e := range strings.Split(r, ",") {
							if seedNodeAddr, err := netip.ParseAddrPort(e); err == nil {
								instance.Server().AddToPeerList(seedNodeAddr)
							}
						}
					}
				} else {
					ips, _ := net.LookupIP(seedNode)
					for _, seedNodeIp := range ips {
						seedNodeAddr := netip.AddrPortFrom(netip.MustParseAddr(seedNodeIp.String()), currentConsensus.DefaultPort())
						instance.Server().AddToPeerList(seedNodeAddr)
					}
				}
			}
		}

		if *peerList != "" {
			utils.Logf("P2Pool", "Loading peers from %s", *peerList)
			if len(*peerList) > 4 && (*peerList)[:4] == "http" {
				func() {
					r, err := http.DefaultClient.Get(*peerList)
					if err == nil {
						defer r.Body.Close()
						scanner := bufio.NewScanner(r.Body)
						for scanner.Scan() {
							if addrPort, err := netip.ParseAddrPort(strings.TrimSpace(scanner.Text())); err == nil {
								instance.Server().AddToPeerList(addrPort)
							}
						}
					}
				}()
			} else {
				func() {
					f, err := os.Open(*peerList)
					if err == nil {
						defer f.Close()
						scanner := bufio.NewScanner(f)
						for scanner.Scan() {
							if addrPort, err := netip.ParseAddrPort(strings.TrimSpace(scanner.Text())); err == nil {
								instance.Server().AddToPeerList(addrPort)
							}
						}
					}
				}()

				go func() {
					contents := make([]byte, 0, 4096)
					for range utils.ContextTick(instance.Context(), time.Minute*1) {
						contents = contents[:0]
						peerListEntries := instance.Server().PeerList()
						slices.SortFunc(peerListEntries, func(a, b *p2p.PeerListEntry) int {
							return a.AddressPort.Compare(b.AddressPort)
						})
						for _, addrPort := range peerListEntries {
							contents = append(contents, []byte(addrPort.AddressPort.String())...)
							contents = append(contents, '\n')
						}
						if err := os.WriteFile(*peerList, contents, 0644); err != nil {
							utils.Errorf("P2Pool", "error writing peer list %s: %s", *peerList, err.Error())
							break
						}
					}
				}()
			}
		}

		if *addSelf {
			if addrs, err := utils.GetOutboundIPv6(); err != nil {
				utils.Errorf("P2Pool", "Could not get interface ipv6 addresses: %s", err)
			} else {
				for _, addr := range addrs {
					if addr.Is6() {
						//use own port directly?
						instance.Server().AddToPeerList(netip.AddrPortFrom(addr, instance.Server().ListenPort()))
					} else {
						instance.Server().AddToPeerList(netip.AddrPortFrom(addr, instance.Server().ExternalListenPort()))
					}
				}
			}
		}

		go func() {
			for !instance.Started() {
				time.Sleep(time.Second * 1)
			}

			var wg sync.WaitGroup
			for _, addrPort := range connectList {
				wg.Add(1)
				go func(addrPort netip.AddrPort) {
					defer wg.Done()
					if err := instance.Server().Connect(addrPort); err != nil {
						utils.Errorf("error connecting to initial peer %s: %s", addrPort.String(), err.Error())
					}
				}(addrPort)
			}
			wg.Wait()
			instance.Server().UpdateClientConnections()
		}()

		sigHandler := make(chan os.Signal, 1)
		signal.Notify(sigHandler, syscall.SIGINT)
		go func() {
			for s := range sigHandler {
				if s == syscall.SIGKILL || s == syscall.SIGINT {
					instance.Close(nil)
				}
			}
		}()

		if err := instance.Run(); err != nil {
			instance.Close(err)
			if instance.Started() {
				instance.WaitUntilClosed()
			}
			if closeError := instance.CloseError(); closeError != nil {
				utils.Panic(err)
			} else {
				os.Exit(0)
			}
		}
	}
}