github.com/core-coin/go-core/v2@v2.1.9/xcb/config.go

// Copyright 2023 by the Authors
// This file is part of the go-core library.
//
// The go-core library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-core library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-core library. If not, see <http://www.gnu.org/licenses/>.

package xcb

import (
	"math/big"
	"os"
	"os/user"
	"time"

	"github.com/core-coin/go-core/v2/xcb/energyprice"

	"github.com/core-coin/go-core/v2/consensus/cryptore"

	"github.com/core-coin/go-core/v2/common"
	"github.com/core-coin/go-core/v2/core"
	"github.com/core-coin/go-core/v2/miner"
	"github.com/core-coin/go-core/v2/params"
	"github.com/core-coin/go-core/v2/xcb/downloader"
)

// DefaultFullGPOConfig contains default energyprice oracle settings for full node.
var DefaultFullGPOConfig = energyprice.Config{
	Blocks:     20,
	Percentile: 60,
	MaxPrice:   energyprice.DefaultMaxPrice,
}

// DefaultLightGPOConfig contains default energyprice oracle settings for light client.
var DefaultLightGPOConfig = energyprice.Config{
	Blocks:     2,
	Percentile: 60,
	MaxPrice:   energyprice.DefaultMaxPrice,
}

// DefaultConfig contains default settings for use on the Core main net.
var DefaultConfig = Config{
	SyncMode:                downloader.FullSync,
	Cryptore:                cryptore.Config{},
	NetworkId:               1,
	LightPeers:              100,
	UltraLightFraction:      75,
	DatabaseCache:           512,
	TrieCleanCache:          154,
	TrieCleanCacheJournal:   "triecache",
	TrieCleanCacheRejournal: 60 * time.Minute,
	TrieDirtyCache:          256,
	TrieTimeout:             60 * time.Minute,
	SnapshotCache:           102,
	Miner: miner.Config{
		EnergyFloor: 12500000,
		EnergyCeil:  14700000,
		EnergyPrice: big.NewInt(params.Nucle),
		Recommit:    3 * time.Second,
	},
	TxPool:      core.DefaultTxPoolConfig,
	GPO:         DefaultFullGPOConfig,
	RPCTxFeeCap: 1, // 1 core
}

func init() {
	home := os.Getenv("HOME")
	if home == "" {
		if user, err := user.Current(); err == nil {
			home = user.HomeDir
		}
	}
}

//go:generate gencodec -type Config -formats toml -out gen_config.go

type Config struct {
	// The genesis block, which is inserted if the database is empty.
	// If nil, the Core main net block is used.
	Genesis *core.Genesis `toml:",omitempty"`

	// Protocol options
	NetworkId uint64 // Network ID to use for selecting peers to connect to
	SyncMode  downloader.SyncMode

	// This can be set to list of enrtree:// URLs which will be queried for
	// for nodes to connect to.
	UseDNSDiscovery bool
	DiscoveryURLs   []string

	NoPruning  bool // Whether to disable pruning and flush everything to disk
	NoPrefetch bool // Whether to disable prefetching and only load state on demand

	TxLookupLimit uint64 `toml:",omitempty"` // The maximum number of blocks from head whose tx indices are reserved.

	// Whitelist of required block number -> hash values to accept
	Whitelist map[uint64]common.Hash `toml:"-"`

	// Light client options
	LightServ    int  `toml:",omitempty"` // Maximum percentage of time allowed for serving LES requests
	LightIngress int  `toml:",omitempty"` // Incoming bandwidth limit for light servers
	LightEgress  int  `toml:",omitempty"` // Outgoing bandwidth limit for light servers
	LightPeers   int  `toml:",omitempty"` // Maximum number of LES client peers
	LightNoPrune bool `toml:",omitempty"` // Whether to disable light chain pruning

	// Ultra Light client options
	UltraLightServers      []string `toml:",omitempty"` // List of trusted ultra light servers
	UltraLightFraction     int      `toml:",omitempty"` // Percentage of trusted servers to accept an announcement
	UltraLightOnlyAnnounce bool     `toml:",omitempty"` // Whether to only announce headers, or also serve them

	// Database options
	SkipBcVersionCheck bool `toml:"-"`
	DatabaseHandles    int  `toml:"-"`
	DatabaseCache      int
	DatabaseFreezer    string

	TrieCleanCache          int
	TrieCleanCacheJournal   string        `toml:",omitempty"` // Disk journal directory for trie cache to survive node restarts
	TrieCleanCacheRejournal time.Duration `toml:",omitempty"` // Time interval to regenerate the journal for clean cache
	TrieDirtyCache          int
	TrieTimeout             time.Duration
	SnapshotCache           int
	Preimages               bool

	// Mining options
	Miner miner.Config

	// Cryptore options
	Cryptore cryptore.Config

	// Transaction pool options
	TxPool core.TxPoolConfig

	// Energy Price Oracle options
	GPO energyprice.Config

	// Enables tracking of SHA3 preimages in the VM
	EnablePreimageRecording bool

	// Miscellaneous options
	DocRoot string `toml:"-"`

	// Type of the EWASM interpreter ("" for default)
	EWASMInterpreter string

	// Type of the CVM interpreter ("" for default)
	CVMInterpreter string

	// TrustedPeersBroadcasting enables broadcasting blocks to trusted peers and after to all connected peers
	TrustedPeersBroadcasting bool

	// RPCEnergyCap is the global energy cap for xcb-call variants.
	RPCEnergyCap uint64 `toml:",omitempty"`

	// RPCTxFeeCap is the global transaction fee(price * energylimit) cap for
	// send-transction variants. The unit is core.
	RPCTxFeeCap float64 `toml:",omitempty"`

	// Checkpoint is a hardcoded checkpoint which can be nil.
	Checkpoint *params.TrustedCheckpoint `toml:",omitempty"`

	// CheckpointOracle is the configuration for checkpoint oracle.
	CheckpointOracle *params.CheckpointOracleConfig `toml:",omitempty"`
}