io.hotmoka.node.SimpleValidatorsConsensusConfigBuilders Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-hotmoka-node Show documentation

This module implements the shared code of all Hotmoka nodes.

There is a newer version: 1.6.0

/*
Copyright 2023 Fausto Spoto

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package io.hotmoka.node;

import java.io.FileNotFoundException;
import java.nio.file.Path;
import java.security.NoSuchAlgorithmException;

import io.hotmoka.node.api.SimpleValidatorsConsensusConfigBuilder;
import io.hotmoka.node.internal.SimpleValidatorsConsensusConfigImpl.SimpleValidatorsConsensusConfigBuilderImpl;

/**
 * Providers of consensus configuration builders for Hotmoka nodes with validators.
 */
public abstract class SimpleValidatorsConsensusConfigBuilders {

	private SimpleValidatorsConsensusConfigBuilders() {}

	/**
	 * Creates a builder containing default data.
	 * 
	 * @return the builder
	 * @throws NoSuchAlgorithmException if some signature algorithm is not available
	 */
	public static SimpleValidatorsConsensusConfigBuilder defaults() throws NoSuchAlgorithmException {
		return new SimpleValidatorsConsensusConfigBuilderImpl();
	}

	/**
	 * Creates a builder from the given TOML configuration file.
	 * The resulting builder will contain the information in the file,
	 * and use defaults for the data not contained in the file.
	 * 
	 * @param path the path to the TOML file
	 * @return the builder
	 * @throws FileNotFoundException if {@code path} cannot be found
	 * @throws NoSuchAlgorithmException if some signature algorithm in the TOML file is not available
	 */
	public static SimpleValidatorsConsensusConfigBuilder load(Path path) throws FileNotFoundException, NoSuchAlgorithmException {
		return new SimpleValidatorsConsensusConfigBuilderImpl(path);
	}
}