config

Documentation

Index

• Variables
• type Config
  • func New(ctx *cli.Context) *Config

Variables

var (
	NodeIdentityKeyPassphrase = cli.StringFlag{
		Name:  "node_identity_passphrase",
		Usage: "Passphrase to unlock the node identity file",
	}

	LogPathLine = cli.BoolFlag{
		Name:  "log_path_line",
		Usage: "Logs include file path and line number",
	}

	LogLevelFlag = cli.StringFlag{
		Name:  "log_level",
		Usage: "Logging level",
	}

	DataDirFlag = cli.StringFlag{
		Name:  "data_dir",
		Value: common.DefaultDataDir(),
		Usage: "Data directory to store data/metadata",
	}

	KeystoreDirFlag = cli.StringFlag{
		Name:  "keystore_dir",
		Value: filepath.Join(common.DefaultDataDir(), "keystore"),
		Usage: "Keystore directory",
	}

	ValidatorFlag = cli.BoolFlag{
		Name:  "validator",
		Usage: "Enable Validator",
	}

	ValidatorKeypath = cli.StringFlag{
		Name:  "validator_keypath",
		Usage: "Path to the key for sealing blocks",
	}

	ValidatorPass = cli.StringFlag{
		Name:    "validator_key_pass",
		Usage:   "Passphrase of keyfile",
		EnvVars: []string{"FFG_VERIFIER_PASSPHRASE"},
	}

	SearchEngine = cli.BoolFlag{
		Name:  "search_engine",
		Usage: "Enable full-text indexing",
	}

	SearchEngineResultCount = cli.IntFlag{
		Name:  "search_engine_result_count",
		Usage: "Max number of documents per search query",
	}

	StorageCapacity = cli.BoolFlag{
		Name:  "show_storage_capacity",
		Usage: "Show storage capacity to other nodes",
	}

	Storage = cli.BoolFlag{
		Name:  "storage",
		Usage: "Enable storage",
	}

	StoragePublic = cli.BoolFlag{
		Name:  "storage_public",
		Usage: "Enable other nodes without access to store data on this node",
	}

	StorageNodeLocation = cli.StringFlag{
		Name:  "storage_node_location",
		Usage: "Indicate the location of the node",
	}

	StorageDir = cli.StringFlag{
		Name:  "storage_dir",
		Usage: "Storage location",
	}

	StorageToken = cli.StringFlag{
		Name:  "storage_token",
		Usage: "Access token for storage engine",
	}

	StorageFeesPerByte = cli.StringFlag{
		Name:  "storage_fees_byte",
		Usage: "Storage fees per Byte of data",
	}

	StorageFileMerkleTreeTotalSegments = cli.IntFlag{
		Name:  "storage_file_merkle_tree_total_segments",
		Usage: "File's total segments for merkle tree generation",
	}

	StorageFileSegmentsEncryptionPercentage = cli.IntFlag{
		Name:  "storage_file_segments_encryption_percentage",
		Usage: "File's segments total encryption",
	}

	DataVerifier = cli.BoolFlag{
		Name:  "verify",
		Usage: "Enable data verification(if verifier in genesis)",
	}

	DataVerifierVerificationFees = cli.StringFlag{
		Name:  "data_verification_fees",
		Usage: "Data verification fees",
	}

	DataVerifierTransactionFees = cli.StringFlag{
		Name:  "data_verification_transaction_fees",
		Usage: "Data verification transaction fees for releasing file hoster fees",
	}

	DataDownloadsPath = cli.StringFlag{
		Name:  "data_downloads_path",
		Usage: "Directory path for data downloads",
	}

	SuperLightNode = cli.BoolFlag{
		Name:  "super_light_node",
		Usage: "Runs a super light node",
	}

	DebugMode = cli.BoolFlag{
		Name:  "debug",
		Usage: "Runs a node with debugging",
	}

	VerifyBlocks = cli.BoolFlag{
		Name:  "verify_blocks",
		Usage: "Verifies all downloaded blocks",
	}

	GeoLiteDBPath = cli.StringFlag{
		Name:  "geolite_db_path",
		Usage: "GeoLite DB path",
	}

	AllowFeesOverride = cli.BoolFlag{
		Name:  "allow_fees_override",
		Usage: "Allow user to override the global storage fees per byte",
	}

	RPCWhitelistFlag = cli.StringFlag{
		Name:  "rpc_whitelist",
		Usage: "Allow IP addresses to access the RPC servers",
	}

	RPCServicesFlag = cli.StringFlag{
		Name:  "rpc_services",
		Usage: "List of rpc services allowed",
	}

	RPCDisabledMethodsFlag = cli.StringFlag{
		Name:  "rpc_disabled_methods",
		Usage: "List of rpc disabled methods",
	}

	// http
	RPCHTTPEnabledFlag = cli.BoolFlag{
		Name:  "http",
		Usage: "Enable the HTTP-RPC server",
	}

	RPCHTTPPortFlag = cli.IntFlag{
		Name:  "http_port",
		Usage: "HTTP-RPC server listening port",
	}

	RPCHTTPAddrFlag = cli.StringFlag{
		Name:  "http_addr",
		Usage: "HTTP-RPC server listening interface",
	}

	RPCHTTPCrossOriginFlag = cli.StringFlag{
		Name:  "http_origin",
		Usage: "HTTP-RPC cross-origin value",
	}

	// unix socket
	RPCSocketEnabledFlag = cli.BoolFlag{
		Name:  "unix_socket",
		Usage: "Enable IPC-RPC interface",
	}

	RPCSocketPathFlag = cli.StringFlag{
		Name:  "unix_socket_path",
		Usage: "Path of the socker/pipe file",
	}

	// ws
	RPCWSEnabledFlag = cli.BoolFlag{
		Name:  "ws",
		Usage: "Enable the WS-RPC server",
	}

	RPCWSPortFlag = cli.IntFlag{
		Name:  "ws_port",
		Usage: "WS-RPC server listening port",
	}

	RPCWSAddrFlag = cli.StringFlag{
		Name:  "ws_addr",
		Usage: "WS-RPC server listening interface",
	}

	RPCWSCrossOriginFlag = cli.StringFlag{
		Name:  "ws_origin",
		Usage: "WS-RPC cross-origin value",
	}

	// p2p
	P2PMaxGossipSize = cli.IntFlag{
		Name:  "max_gossip_size",
		Usage: "Maximum gossip size",
	}

	MaxPeersFlag = cli.IntFlag{
		Name:  "max_peers",
		Usage: "Maximum number of peers to connect",
	}

	P2PListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "P2P listening port",
	}

	P2PListenAddrFlag = cli.StringFlag{
		Name:  "addr",
		Usage: "P2P listening interface",
	}

	P2PMinPeersFlag = cli.IntFlag{
		Name:  "min_peers",
		Usage: "Minimum number of peers to start periodic bootstraper",
	}

	P2PBootstraperFlag = cli.StringFlag{
		Name:  "bootstrap_nodes",
		Usage: "Bootstraping nodes",
	}

	P2PFrequencyFlag = cli.IntFlag{
		Name:  "bootstrap_freq",
		Usage: "Bootstraping frequency",
	}
)

var AppFlags = []cli.Flag{
	&cli.StringFlag{
		Name:  "config, c",
		Usage: "Load configuration from `FILE`",
	},
	&NodeIdentityKeyPassphrase,
	&LogPathLine,
	&LogLevelFlag,
	&DataDirFlag,
	&KeystoreDirFlag,

	&ValidatorFlag,
	&ValidatorKeypath,
	&ValidatorPass,
	&SearchEngine,
	&SearchEngineResultCount,
	&StorageCapacity,
	&Storage,
	&StoragePublic,
	&StorageNodeLocation,
	&StorageDir,
	&StorageToken,
	&StorageFeesPerByte,
	&StorageFileMerkleTreeTotalSegments,
	&StorageFileSegmentsEncryptionPercentage,
	&DataVerifier,
	&DataVerifierVerificationFees,
	&DataVerifierTransactionFees,
	&DataDownloadsPath,
	&SuperLightNode,
	&DebugMode,
	&VerifyBlocks,
	&GeoLiteDBPath,
	&AllowFeesOverride,

	&RPCServicesFlag,
	&RPCDisabledMethodsFlag,
	&RPCWhitelistFlag,
	&RPCSocketEnabledFlag,
	&RPCSocketPathFlag,
	&RPCHTTPEnabledFlag,
	&RPCHTTPPortFlag,
	&RPCHTTPAddrFlag,
	&RPCHTTPCrossOriginFlag,
	&RPCWSEnabledFlag,
	&RPCWSPortFlag,
	&RPCWSAddrFlag,
	&RPCWSCrossOriginFlag,

	&P2PMaxGossipSize,
	&MaxPeersFlag,
	&P2PListenPortFlag,
	&P2PListenAddrFlag,
	&P2PMinPeersFlag,
	&P2PBootstraperFlag,
	&P2PFrequencyFlag,
}

Types

type Config

type Config struct {
	Global global
	RPC    rpc
	P2P    p2p
}

Config represents the configuration.

func New

func New(ctx *cli.Context) *Config

New creates a new configuration.