org.ergoplatform.appkit.ErgoClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ergo-appkit_2.11 Show documentation

A Library for Polyglot Development of Ergo Applications

The newest version!

package org.ergoplatform.appkit;

import java.util.function.Function;

/**
 * This interface is used to represent Ergo blockchain client object. Each
 * instance of ErgoClient represents some kind of connection with Ergo network
 * node. The implementations of ErgoClient may range from communicating with the
 * Ergo network node using REST API down to direct accessing node's state when
 * ErgoClient is executed in the same JVM as Ergo node.
 * 

 * ErgoClient can be used as a runner of some action in a blockchain context.
 * The {@link BlockchainContext blockchain context} is created by the specific
 * ErgoClient implementation and passed to the action.

 * Some implementations may connect to network nodes, while others may use mock
 * web server to simulate connection in tests. The actual implementation to
 * fetch the data can be accessed from the {@link BlockchainDataSource}.
 */
public interface ErgoClient {

    /**
     * @return data source for this client
     */
    BlockchainDataSource getDataSource();

    /**
     * Execute the given action and return action's result. An instance of
     * {@link BlockchainContext} is created with the current state of the
     * blockchain and passed as the argument of the action.
     */
     T execute(Function action);

    /**
     * This message is used whenever the explorer is requested in "node-only" mode.
     */
    String explorerUrlNotSpecifiedMessage = "Explorer URL is not specified when RestApiErgoClient.create() is called.";
}