forked from TrueCloudLab/neoneo-go
7589733017
And include some node-specific configurations there with backwards compatibility. Note that in the future we'll remove Ledger's fields from the ProtocolConfiguration and it'll be possible to access them in Blockchain directly (not via .Ledger). The other option tried was using two configuration types separately, but that incurs more changes to the codebase, single structure that behaves almost like the old one is better for backwards compatibility. Fixes #2676.
96 lines
2.9 KiB
Go
96 lines
2.9 KiB
Go
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/nspcc-dev/neo-go/pkg/config/netmode"
|
|
"gopkg.in/yaml.v3"
|
|
)
|
|
|
|
const (
|
|
// UserAgentWrapper is a string that user agent string should be wrapped into.
|
|
UserAgentWrapper = "/"
|
|
// UserAgentPrefix is a prefix used to generate user agent string.
|
|
UserAgentPrefix = "NEO-GO:"
|
|
// UserAgentFormat is a formatted string used to generate user agent string.
|
|
UserAgentFormat = UserAgentWrapper + UserAgentPrefix + "%s" + UserAgentWrapper
|
|
// DefaultMaxIteratorResultItems is the default upper bound of traversed
|
|
// iterator items per JSON-RPC response.
|
|
DefaultMaxIteratorResultItems = 100
|
|
)
|
|
|
|
// Version is the version of the node, set at the build time.
|
|
var Version string
|
|
|
|
// Config top level struct representing the config
|
|
// for the node.
|
|
type Config struct {
|
|
ProtocolConfiguration ProtocolConfiguration `yaml:"ProtocolConfiguration"`
|
|
ApplicationConfiguration ApplicationConfiguration `yaml:"ApplicationConfiguration"`
|
|
}
|
|
|
|
// GenerateUserAgent creates a user agent string based on the build time environment.
|
|
func (c Config) GenerateUserAgent() string {
|
|
return fmt.Sprintf(UserAgentFormat, Version)
|
|
}
|
|
|
|
// Blockchain generates a Blockchain configuration based on Protocol and
|
|
// Application settings.
|
|
func (c Config) Blockchain() Blockchain {
|
|
return Blockchain{
|
|
ProtocolConfiguration: c.ProtocolConfiguration,
|
|
Ledger: c.ApplicationConfiguration.Ledger,
|
|
}
|
|
}
|
|
|
|
// Load attempts to load the config from the given
|
|
// path for the given netMode.
|
|
func Load(path string, netMode netmode.Magic) (Config, error) {
|
|
configPath := fmt.Sprintf("%s/protocol.%s.yml", path, netMode)
|
|
return LoadFile(configPath)
|
|
}
|
|
|
|
// LoadFile loads config from the provided path. It also applies backwards compatibility
|
|
// fixups if necessary.
|
|
func LoadFile(configPath string) (Config, error) {
|
|
if _, err := os.Stat(configPath); os.IsNotExist(err) {
|
|
return Config{}, fmt.Errorf("config '%s' doesn't exist", configPath)
|
|
}
|
|
|
|
configData, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
return Config{}, fmt.Errorf("unable to read config: %w", err)
|
|
}
|
|
|
|
config := Config{
|
|
ApplicationConfiguration: ApplicationConfiguration{
|
|
P2P: P2P{
|
|
PingInterval: 30,
|
|
PingTimeout: 30,
|
|
},
|
|
RPC: RPC{
|
|
MaxIteratorResultItems: DefaultMaxIteratorResultItems,
|
|
MaxFindResultItems: 100,
|
|
MaxNEP11Tokens: 100,
|
|
},
|
|
},
|
|
}
|
|
|
|
err = yaml.Unmarshal(configData, &config)
|
|
if err != nil {
|
|
return Config{}, fmt.Errorf("failed to unmarshal config YAML: %w", err)
|
|
}
|
|
|
|
if len(config.ApplicationConfiguration.UnlockWallet.Path) > 0 && len(config.ApplicationConfiguration.Consensus.UnlockWallet.Path) == 0 {
|
|
config.ApplicationConfiguration.Consensus.UnlockWallet = config.ApplicationConfiguration.UnlockWallet
|
|
config.ApplicationConfiguration.Consensus.Enabled = true
|
|
}
|
|
|
|
err = config.ProtocolConfiguration.Validate()
|
|
if err != nil {
|
|
return Config{}, err
|
|
}
|
|
|
|
return config, nil
|
|
}
|