atomic-swap/common/config.go

// Copyright 2023 The AthanorLabs/atomic-swap Authors
// SPDX-License-Identifier: LGPL-3.0-only

package common

import (
	"os"
	"path"
	"time"

	ethcommon "github.com/ethereum/go-ethereum/common"
)

const (
	// DefaultMoneroWalletName is the default wallet name in {DATA_DIR}/wallet/
	DefaultMoneroWalletName = "swap-wallet"

	// DefaultLibp2pKeyFileName is the default libp2p private key file name in {DATA_DIR}
	DefaultLibp2pKeyFileName = "net.key"

	// DefaultEthKeyFileName is the default ethereum private key file name in {DATA_DIR}
	DefaultEthKeyFileName = "eth.key"
)

var homeDir, _ = os.UserHomeDir()
var baseDir = path.Join(homeDir, ".atomicswap")

// publicBootnodes are bootnodes with public IP addresses that are used in every
// environment other than development.
var publicBootnodes = []string{
	"/ip4/104.194.157.27/tcp/9909/p2p/12D3KooWMYfJHQAjL1F6EVk2s9CJvsEvdYMW8CD7uBMs15sdFJzd",
	"/ip4/134.122.115.208/tcp/9909/p2p/12D3KooWCAMMJMDV99GQA78MiaGgnqNmZSD1FAo5uHaZUbeqL4XR",
	"/ip4/143.198.123.27/tcp/9909/p2p/12D3KooWD7JjjRyohDPPm8TMT8v8dEfwoVHxfBN2ytZHpS9VJ3Vz",
	"/ip4/185.130.46.66/tcp/9909/p2p/12D3KooWDKf2FJG1AWTJthbs7fcCcsQa26f4pmCR25cktRg2X2aY",
	"/ip4/67.205.131.11/tcp/9909/p2p/12D3KooWPnZyeGvsDgpQtMCUKdSiFi5K1pxk6NR6gNo5nGhFCseK",
	"/ip4/67.207.89.83/tcp/9909/p2p/12D3KooWGQ7L8ruTKtvLDwDyrVv5DdjPnLB7HeTdpsLGiWPi6oqw",
}

// MoneroNode represents the host and port of monerod's RPC endpoint
type MoneroNode struct {
	Host string
	Port uint
}

// Config contains constants that are defaults for various environments
type Config struct {
	Env             Environment
	DataDir         string
	EthEndpoint     string
	MoneroNodes     []*MoneroNode
	SwapCreatorAddr ethcommon.Address
	Bootnodes       []string
}

// MainnetConfig is the mainnet ethereum and monero configuration
func MainnetConfig() *Config {
	return &Config{
		Env:         Mainnet,
		DataDir:     path.Join(baseDir, "mainnet"),
		EthEndpoint: "", // No mainnet default (permissionless URLs are not reliable)
		MoneroNodes: []*MoneroNode{
			{
				Host: "xmr-node.cakewallet.com",
				Port: DefaultMoneroDaemonMainnetPort,
			},
			{
				Host: "node.community.rino.io",
				Port: DefaultMoneroDaemonMainnetPort,
			},
			{
				Host: "node.monerodevs.org",
				Port: 18089,
			},
		},
		SwapCreatorAddr: ethcommon.HexToAddress("0x377ed3a60007048DF00135637521170628De89E5"),
		Bootnodes:       publicBootnodes,
	}
}

// StagenetConfig is the monero stagenet and ethereum Sepolia configuration
func StagenetConfig() *Config {
	return &Config{
		Env:         Stagenet,
		DataDir:     path.Join(baseDir, "stagenet"),
		EthEndpoint: "https://rpc.sepolia.org/",
		MoneroNodes: []*MoneroNode{
			{
				Host: "stagenet.community.rino.io",
				Port: 38081,
			},
			{
				Host: "node.monerodevs.org",
				Port: 38089,
			},
		},
		SwapCreatorAddr: ethcommon.HexToAddress("0x377ed3a60007048DF00135637521170628De89E5"),
		Bootnodes:       publicBootnodes,
	}
}

// DevelopmentConfig is the monero and ethereum development environment configuration
func DevelopmentConfig() *Config {
	return &Config{
		Env:         Development,
		DataDir:     path.Join(baseDir, "dev"),
		EthEndpoint: DefaultGanacheEndpoint,
		MoneroNodes: []*MoneroNode{
			{
				Host: "127.0.0.1",
				Port: DefaultMoneroDaemonMainnetPort,
			},
		},
	}
}

// BootnodeConfig is environment for bootnodes, which act across multiple environments
func BootnodeConfig() *Config {
	return &Config{
		Env:             Bootnode,
		DataDir:         path.Join(baseDir, "bootnode"),
		EthEndpoint:     "",
		MoneroNodes:     nil,
		SwapCreatorAddr: ethcommon.Address{},
		Bootnodes:       publicBootnodes,
	}
}

// MoneroWalletPath returns the path to the wallet file, whose default value
// depends on current value of the data dir.
func (c Config) MoneroWalletPath() string {
	return path.Join(c.DataDir, "wallet", DefaultMoneroWalletName)
}

// LibP2PKeyFile returns the path to the libp2p key file, whose default value
// depends on current value of the data dir.
func (c Config) LibP2PKeyFile() string {
	return path.Join(c.DataDir, DefaultLibp2pKeyFileName)
}

// EthKeyFileName returns the path to the ethereum key file, whose default value
// depends on current value of the data dir.
func (c Config) EthKeyFileName() string {
	return path.Join(c.DataDir, DefaultEthKeyFileName)
}

// ConfigDefaultsForEnv returns the configuration defaults for the given environment.
func ConfigDefaultsForEnv(env Environment) *Config {
	switch env {
	case Mainnet:
		return MainnetConfig()
	case Stagenet:
		return StagenetConfig()
	case Development:
		return DevelopmentConfig()
	case Bootnode:
		return BootnodeConfig()
	default:
		panic("invalid environment")
	}
}

// SwapTimeoutFromEnv returns the duration between swap timeouts given the environment.
func SwapTimeoutFromEnv(env Environment) time.Duration {
	switch env {
	case Mainnet, Stagenet:
		return time.Hour
	case Development:
		return time.Minute * 2
	default:
		panic("invalid environment")
	}
}

// DefaultMoneroPortFromEnv returns the default Monerod RPC port for an environment
// Reference: https://monerodocs.org/interacting/monerod-reference/
func DefaultMoneroPortFromEnv(env Environment) uint {
	switch env {
	case Mainnet:
		return DefaultMoneroDaemonMainnetPort
	case Stagenet:
		return DefaultMoneroDaemonStagenetPort
	case Development:
		return DefaultMoneroDaemonDevPort
	default:
		panic("invalid environment")
	}
}

// ChainNameFromEnv returns the expected chainID that we should find on the
// ethereum endpoint when running int the passed environment.
func ChainNameFromEnv(env Environment) string {
	//nolint:goconst
	switch env {
	case Development:
		return "ganache"
	case Stagenet:
		return "sepolia"
	case Mainnet:
		return "mainnet"
	case Bootnode:
		// bootnodes work across chains, so they get their own name
		return "bootnode"
	default:
		panic("invalid environment")
	}
}