io.mokamint.node.local.api.LocalNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-mokamint-node-local-api Show documentation

This module defines the API of a Mokamint local node, that is, a node that actually works on the local machine where it is executed.

The newest version!

/*
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.mokamint.node.local.api;

import java.util.Optional;

import io.hotmoka.annotations.ThreadSafe;
import io.mokamint.miner.api.Miner;
import io.mokamint.node.api.FullNode;
import io.mokamint.node.api.MinerInfo;
import io.mokamint.node.api.NodeException;

/**
 * A local node of a Mokamint blockchain.
 */
@ThreadSafe
public interface LocalNode extends FullNode {

	/**
	 * Yields the configuration of this node.
	 * 
	 * @return the configuration of this node
	 */
	@Override
	LocalNodeConfig getConfig();

	/**
	 * Adds the given miner to the miners of this node.
	 * 
	 * @param miner the miner
	 * @return the information about the added miner; this is empty if the miner has not been added
	 * @throws NodeException if the node could not complete the operation
	 */
	Optional add(Miner miner) throws NodeException;
}