github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/core/node/options.go

/*
 * Copyright (C) 2018 The "MysteriumNetwork/node" Authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package node

import (
	"path"
	"time"

	"github.com/rs/zerolog"
	"github.com/rs/zerolog/log"

	"github.com/mysteriumnetwork/node/config"
	"github.com/mysteriumnetwork/node/logconfig"
	"github.com/mysteriumnetwork/node/metadata"
	openvpn_core "github.com/mysteriumnetwork/node/services/openvpn/core"
)

// Openvpn interface is abstraction over real openvpn options to unblock mobile development
// will disappear as soon as go-openvpn will unify common factory for openvpn creation
type Openvpn interface {
	Check() error
	BinaryPath() string
}

// TODO this struct will disappear when we unify go-openvpn embedded lib and external process based session creation/handling
type wrapper struct {
	nodeOptions openvpn_core.NodeOptions
}

func (w wrapper) Check() error {
	return w.nodeOptions.Check()
}

func (w wrapper) BinaryPath() string {
	return w.nodeOptions.BinaryPath
}

var _ Openvpn = wrapper{}

// Options describes options which are required to start Node
type Options struct {
	Directories OptionsDirectory

	TequilapiAddress       string
	TequilapiPort          int
	FlagTequilapiDebugMode bool
	TequilapiEnabled       bool
	TequilapiSecured       bool
	BindAddress            string
	UI                     OptionsUI
	FeedbackURL            string

	Keystore OptionsKeystore

	logconfig.LogOptions
	OptionsNetwork
	Discovery  OptionsDiscovery
	Quality    OptionsQuality
	Location   OptionsLocation
	Transactor OptionsTransactor
	Affiliator OptionsAffiliator
	Chains     OptionsChains

	Openvpn  Openvpn
	Firewall OptionsFirewall

	Payments OptionsPayments

	Consumer bool
	Mobile   bool

	SwarmDialerDNSHeadstart time.Duration
	PilvytisAddress         string
	ObserverAddress         string
	SSE                     OptionsSSE
}

// GetOptions retrieves node options from the app configuration.
func GetOptions() *Options {
	network := OptionsNetwork{
		Network:          config.GetBlockchainNetwork(config.FlagBlockchainNetwork),
		DiscoveryAddress: config.GetString(config.FlagDiscoveryAddress),
		BrokerAddresses:  config.GetStringSlice(config.FlagBrokerAddress),
		EtherClientRPCL1: config.GetStringSlice(config.FlagEtherRPCL1),
		EtherClientRPCL2: config.GetStringSlice(config.FlagEtherRPCL2),
		ChainID:          config.GetInt64(config.FlagChainID),
		DNSMap: map[string][]string{
			"location.mysterium.network": {"51.158.129.204"},
			"quality.mysterium.network":  {"51.158.129.204"},
			"feedback.mysterium.network": {"116.203.17.150"},
			"api.ipify.org": {
				"54.204.14.42", "54.225.153.147", "54.235.83.248", "54.243.161.145",
				"23.21.109.69", "23.21.126.66",
				"50.19.252.36",
				"174.129.214.20",
			},
			"badupnp.benjojo.co.uk": {"104.22.70.70", "104.22.71.70", "172.67.25.154"},
		},
	}
	return &Options{
		Directories:            *GetOptionsDirectory(&network),
		TequilapiAddress:       config.GetString(config.FlagTequilapiAddress),
		TequilapiPort:          config.GetInt(config.FlagTequilapiPort),
		FlagTequilapiDebugMode: config.GetBool(config.FlagTequilapiDebugMode),
		TequilapiEnabled:       true,
		BindAddress:            config.GetString(config.FlagBindAddress),
		UI: OptionsUI{
			UIEnabled:     config.GetBool(config.FlagUIEnable),
			UIBindAddress: config.GetString(config.FlagUIAddress),
			UIPort:        config.GetInt(config.FlagUIPort),
		},
		SwarmDialerDNSHeadstart: config.GetDuration(config.FlagDNSResolutionHeadstart),
		FeedbackURL:             config.GetString(config.FlagFeedbackURL),
		Keystore: OptionsKeystore{
			UseLightweight: config.GetBool(config.FlagKeystoreLightweight),
		},
		LogOptions:     *GetLogOptions(),
		OptionsNetwork: network,
		Discovery:      *GetDiscoveryOptions(),
		Quality: OptionsQuality{
			Type:    QualityType(config.GetString(config.FlagQualityType)),
			Address: config.GetString(config.FlagQualityAddress),
		},
		Location: OptionsLocation{
			IPDetectorURL: config.GetString(config.FlagIPDetectorURL),
			Type:          LocationType(config.GetString(config.FlagLocationType)),
			Address:       config.GetString(config.FlagLocationAddress),
			Country:       config.GetString(config.FlagLocationCountry),
			City:          config.GetString(config.FlagLocationCity),
			IPType:        config.GetString(config.FlagLocationIPType),
		},
		Transactor: OptionsTransactor{
			TransactorEndpointAddress:       config.GetString(config.FlagTransactorAddress),
			ProviderMaxRegistrationAttempts: config.GetInt(config.FlagTransactorProviderMaxRegistrationAttempts),
			TransactorFeesValidTime:         config.GetDuration(config.FlagTransactorFeesValidTime),
			TryFreeRegistration:             config.GetBool(config.FlagProviderTryFreeRegistration),
		},
		Affiliator: OptionsAffiliator{
			AffiliatorEndpointAddress: config.GetString(config.FlagAffiliatorAddress),
		},
		Payments: OptionsPayments{
			MaxAllowedPaymentPercentile:    config.GetInt(config.FlagPaymentsMaxHermesFee),
			BCTimeout:                      config.GetDuration(config.FlagPaymentsBCTimeout),
			HermesPromiseSettlingThreshold: config.GetFloat64(config.FlagPaymentsHermesPromiseSettleThreshold),
			MaxFeeSettlingThreshold:        config.GetFloat64(config.FlagPaymentsPromiseSettleMaxFeeThreshold),
			MaxUnSettledAmount:             config.GetFloat64(config.FlagPaymentsUnsettledMaxAmount),
			SettlementTimeout:              config.GetDuration(config.FlagPaymentsHermesPromiseSettleTimeout),
			SettlementRecheckInterval:      config.GetDuration(config.FlagPaymentsHermesPromiseSettleCheckInterval),
			BalanceLongPollInterval:        config.GetDuration(config.FlagPaymentsLongBalancePollInterval),
			BalanceFastPollInterval:        config.GetDuration(config.FlagPaymentsFastBalancePollInterval),
			BalanceFastPollTimeout:         config.GetDuration(config.FlagPaymentsFastBalancePollTimeout),
			RegistryTransactorPollInterval: config.GetDuration(config.FlagPaymentsRegistryTransactorPollInterval),
			RegistryTransactorPollTimeout:  config.GetDuration(config.FlagPaymentsRegistryTransactorPollTimeout),
			ConsumerDataLeewayMegabytes:    config.GetUInt64(config.FlagPaymentsConsumerDataLeewayMegabytes),
			HermesStatusRecheckInterval:    config.GetDuration(config.FlagPaymentsHermesStatusRecheckInterval),
			MinAutoSettleAmount:            config.GetFloat64(config.FlagPaymentsZeroStakeUnsettledAmount),

			ProviderInvoiceFrequency:      config.GetDuration(config.FlagPaymentsProviderInvoiceFrequency),
			ProviderLimitInvoiceFrequency: config.GetDuration(config.FlagPaymentsLimitProviderInvoiceFrequency),
			MaxUnpaidInvoiceValue:         config.GetBigInt(config.FlagPaymentsUnpaidInvoiceValue),
			LimitUnpaidInvoiceValue:       config.GetBigInt(config.FlagPaymentsLimitUnpaidInvoiceValue),
		},
		Chains: OptionsChains{
			Chain1: metadata.ChainDefinition{
				RegistryAddress:    config.GetString(config.FlagChain1RegistryAddress),
				HermesID:           config.GetString(config.FlagChain1HermesAddress),
				ChannelImplAddress: config.GetString(config.FlagChain1ChannelImplementationAddress),
				ChainID:            config.GetInt64(config.FlagChain1ChainID),
				MystAddress:        config.GetString(config.FlagChain1MystAddress),
				KnownHermeses:      config.GetStringSlice(config.FlagChain1KnownHermeses),
			},
			Chain2: metadata.ChainDefinition{
				RegistryAddress:    config.GetString(config.FlagChain2RegistryAddress),
				HermesID:           config.GetString(config.FlagChain2HermesAddress),
				ChannelImplAddress: config.GetString(config.FlagChain2ChannelImplementationAddress),
				ChainID:            config.GetInt64(config.FlagChain2ChainID),
				MystAddress:        config.GetString(config.FlagChain2MystAddress),
				KnownHermeses:      config.GetStringSlice(config.FlagChain2KnownHermeses),
			},
		},
		Openvpn: wrapper{nodeOptions: openvpn_core.NodeOptions{
			BinaryPath: config.GetString(config.FlagOpenvpnBinary),
		}},
		Firewall: OptionsFirewall{
			BlockAlways: config.GetBool(config.FlagFirewallKillSwitch),
		},
		Consumer:        config.GetBool(config.FlagConsumer),
		PilvytisAddress: config.GetString(config.FlagPilvytisAddress),
		ObserverAddress: config.GetString(config.FlagObserverAddress),
		SSE: OptionsSSE{
			Enabled: config.GetBool(config.FlagSSEEnable),
		},
	}
}

// GetLogOptions retrieves logger options from the app configuration.
func GetLogOptions() *logconfig.LogOptions {
	filepath := ""
	if logDir := config.GetString(config.FlagLogDir); logDir != "" {
		filepath = path.Join(logDir, "mysterium-node")
	}
	level, err := zerolog.ParseLevel(config.GetString(config.FlagLogLevel))
	if err != nil {
		log.Error().Err(err).Msg("Failed to parse logging level")
		level = zerolog.DebugLevel
	}
	return &logconfig.LogOptions{
		LogLevel: level,
		LogHTTP:  config.GetBool(config.FlagLogHTTP),
		Filepath: filepath,
	}
}

// GetDiscoveryOptions retrieves discovery options from the app configuration.
func GetDiscoveryOptions() *OptionsDiscovery {
	typeValues := config.GetStringSlice(config.FlagDiscoveryType)
	types := make([]DiscoveryType, len(typeValues))
	for i, typeValue := range typeValues {
		types[i] = DiscoveryType(typeValue)
	}

	return &OptionsDiscovery{
		Types:         types,
		PingInterval:  config.GetDuration(config.FlagDiscoveryPingInterval),
		FetchEnabled:  true,
		FetchInterval: config.GetDuration(config.FlagDiscoveryFetchInterval),
		DHT:           *GetDHTOptions(),
	}
}

// GetDHTOptions retrieves DHT options from the app configuration.
func GetDHTOptions() *OptionsDHT {
	return &OptionsDHT{
		Address:        config.GetString(config.FlagDHTAddress),
		Port:           config.GetInt(config.FlagDHTPort),
		Protocol:       config.GetString(config.FlagDHTProtocol),
		BootstrapPeers: config.GetStringSlice(config.FlagDHTBootstrapPeers),
	}
}

// OptionsKeystore stores the keystore configuration
type OptionsKeystore struct {
	UseLightweight bool
}