code.vegaprotocol.io/vega@v0.79.0/visor/config/run_config.go

// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package config

import (
	"fmt"

	"code.vegaprotocol.io/vega/paths"
)

/*
description: Configuration options for the Vega binary and its arguments.
example:

	type: toml
	value: |
		path = "/path/binary"
		args = ["--arg1", "val1", "--arg2"]
*/
type BinaryConfig struct {
	/*
		description: Path to the Vega binary.
		note: |
			The absolute or relative path can be used.
			Relative path is relative to a parent folder of this config file.
	*/
	Path string `toml:"path"`
	/*
		description: Arguments that will be applied to the binary.
		note: |
			Each element the list represents one space separated argument.
	*/
	Args []string `toml:"args"`
}

/*
description: Configures a connection to a core node's exposed UNIX socket RPC API.
example:

	type: toml
	value: |
		[vega.rpc]
			socketPath = "/path/socket.sock"
			httpPath = "/rpc"
*/
type RPCConfig struct {
	/*
		description: Path of the mounted socket.
		note: This path can be configured in the Vega core node configuration and can be found in the [Admin.Server] section.
	*/
	SocketPath string `toml:"socketPath"`
	/*
		description: HTTP path of the socket path.
		note: This path can be configured in the Vega core node configuration and can be found in the [Admin.Server] section.
	*/
	HTTPPath string `toml:"httpPath"`
}

/*
description: Configuration options for the Vega binary and its arguments.
example:

	type: toml
	value: |
		[vega]
			[vega.binary]
				path = "/path/vega-binary"
				args = ["--arg1", "val1", "--arg2"]
			[vega.rpc]
				socketPath = "/path/socket.sock"
				httpPath = "/rpc"
*/
type VegaConfig struct {
	/*
		description: Configuration of Vega binary and the arguments to run it.
		example:
			type: toml
			value: |
				[vega.binary]
					path = "/path/vega-binary"
					args = ["--arg1", "val1", "--arg2"]
	*/
	Binary BinaryConfig `toml:"binary"`

	/*
		description: |
			Visor communicates with the core node via RPC API that runs over a UNIX socket.
			This parameter configures the UNIX socket to match the core node configuration.
			This value can be found in the config.toml file used by the core node under the heading [Admin.Server]
		example:
			type: toml
			value: |
				[vega.binary]
					path = "/path/vega-binary"
					args = ["--arg1", "val1", "--arg2"]
	*/
	RCP RPCConfig `toml:"rpc"`
}

/*
description: Configures a data node binary and its arguments.
example:

	type: toml
	value: |
		[data_node]
			[data_node.binary]
				path = "/path/data-node-binary"
				args = ["--arg1", "val1", "--arg2"]
*/
type DataNodeConfig struct {
	Binary BinaryConfig `toml:"binary"`
}

/*
description: Root of the config file
example:

	type: toml
	value: |
		name = "v1.65.0"

		[vega]
			[vega.binary]
				path = "/path/vega-binary"
				args = ["--arg1", "val1", "--arg2"]
			[vega.rpc]
				socketPath = "/path/socket.sock"
				httpPath = "/rpc"
*/
type RunConfig struct {
	/*
		description: Name of the upgrade.
		note: |
			It is recommended to use the Vega version you wish to upgrade to as the name. These can be found in the releases list of the Vega Github repository
			(https://github.com/vegaprotocol/vega/releases).

	*/
	Name string `toml:"name"`
	// description: Configuration of a Vega node.
	Vega VegaConfig `toml:"vega"`
	// description: Configuration of a data node.
	DataNode *DataNodeConfig `toml:"data_node"`
}

func ExampleRunConfig(name string, withDataNode bool) *RunConfig {
	c := &RunConfig{
		Name: name,
		Vega: VegaConfig{
			Binary: BinaryConfig{
				Path: "vega",
				Args: []string{"arg1", "arg2", "..."},
			},
		},
	}

	if withDataNode {
		c.DataNode = &DataNodeConfig{
			Binary: BinaryConfig{
				Path: "vega data-node",
				Args: []string{"arg1", "arg2", "..."},
			},
		}
	}

	return c
}

func ParseRunConfig(path string) (*RunConfig, error) {
	conf := RunConfig{}
	if err := paths.ReadStructuredFile(path, &conf); err != nil {
		return nil, fmt.Errorf("failed to parse RunConfig: %w", err)
	}

	return &conf, nil
}

func (rc *RunConfig) WriteToFile(path string) error {
	return paths.WriteStructuredFile(path, rc)
}