io.neow3j.protocol.Neow3j Maven / Gradle / Ivy

Go to download
package io.neow3j.protocol;

import io.neow3j.protocol.core.JsonRpc2_0Neow3j;
import io.neow3j.protocol.core.Neo;
import io.neow3j.protocol.rx.Neow3jRx;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledThreadPoolExecutor;

/**
 * JSON-RPC Request object building factory.
 */
public abstract class Neow3j implements Neo, Neow3jRx {

    private final Neow3jConfig config;

    protected Neow3j(Neow3jConfig config) {
        this.config = config;
    }

    /**
     * Constructs a new Neow3j instance with the default configuration.
     *
     * @param neow3jService neow3j service instance - i.e. HTTP or IPC
     * @return new Neow3j instance
     */
    public static Neow3j build(Neow3jService neow3jService) {
        return new JsonRpc2_0Neow3j(neow3jService, new Neow3jConfig());
    }

    /**
     * Constructs a new Neow3j instance using the given configuration.
     *
     * @param neow3jService neow3j service instance - i.e. HTTP or IPC
     * @param config        The configuration to use.
     * @return new Neow3j instance.
     */
    public static Neow3j build(Neow3jService neow3jService, Neow3jConfig config) {
        return new JsonRpc2_0Neow3j(neow3jService, config);
    }

    /**
     * Shutdowns a Neow3j instance and closes opened resources.
     */
    public abstract void shutdown();

    /**
     * Gets the configured network magic number.
     * 
     * The magic number is an ingredient, e.g., when generating the hash of a transaction.
     * 

     * The default value is null. Only once this method is called for the first time the value is
     * fetched from the connected Neo node.
     *
     * @return The network's magic number.
     * @throws IOException if something goes wrong when communicating with the Neo node.
     */
    public byte[] getNetworkMagicNumberBytes() throws IOException {
        if (config.getNetworkMagic() == null) {
            config.setNetworkMagic(getVersion().send().getVersion().getNetwork());
        }
        // transform from long to unsigned int:
        int networkMagicAsInt = (int) (config.getNetworkMagic() & 0xFFFFFFFFL);
        byte[] array = new byte[4];
        ByteBuffer.wrap(array).order(ByteOrder.LITTLE_ENDIAN).putInt(networkMagicAsInt);
        return array;
    }

    /**
     * Gets the configured network magic number as an integer.
     * 

     * The magic number is an ingredient, e.g., when generating the hash of a transaction.
     * 

     * The default value is null. Only once this method is called for the first time the value is
     * fetched from the connected Neo node.
     *
     * @return The network's magic number.
     * @throws IOException if something goes wrong when communicating with the Neo node.
     */
    public long getNetworkMagicNumber() throws IOException {
        if (config.getNetworkMagic() == null) {
            config.setNetworkMagic(getVersion().send().getVersion().getNetwork());
        }
        return config.getNetworkMagic();
    }

    /**
     * Gets the executor service used for polling new blocks from the Neo node.
     * 

     * The default executor service is a {@link ScheduledThreadPoolExecutor} with as many threads
     * as CPUs available to the JVM.
     *
     * @return the configured executor service.
     */
    public ScheduledExecutorService getScheduledExecutorService() {
        return config.getScheduledExecutorService();
    }

    /**
     * Gets the interval in milliseconds in which blocks are produced.
     * 

     * Defaults to {@link Neow3jConfig#DEFAULT_BLOCK_TIME}.
     *
     * @return the block interval in milliseconds.
     */
    public int getBlockInterval() {
        return config.getBlockInterval();
    }

    /**
     * Gets the interval in milliseconds in which {@code Neow3j} should poll the Neo node for new
     * block information when observing the blockchain.
     * 

     * Defaults to {@link Neow3jConfig#DEFAULT_BLOCK_TIME}.
     *
     * @return the polling interval in milliseconds.
     */
    public int getPollingInterval() {
        return config.getPollingInterval();
    }

    /**
     * Gets the maximum time in milliseconds that can pass form the construction of a transaction
     * until it gets included in a block. A transaction becomes invalid after this time increment
     * is surpassed. @return the
     * 
     * Defaults to {@link Neow3jConfig#MAX_VALID_UNTIL_BLOCK_INCREMENT_BASE} divided by the
     * configured block interval.
     *
     * @return the maximum valid until block time increment.
     */
    public long getMaxValidUntilBlockIncrement() {
        return config.getMaxValidUntilBlockIncrement();
    }

}