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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
neow3j: Java/Kotlin/Android Development Toolkit for the Neo Blockchain
There is a newer version: 3.23.0
package io.neow3j.protocol;

import io.neow3j.protocol.core.JsonRpc2_0Neow3j;
import io.neow3j.protocol.core.NeoExpress;
import io.neow3j.protocol.core.Request;
import io.neow3j.protocol.core.response.NeoExpressCreateCheckpoint;
import io.neow3j.protocol.core.response.NeoExpressCreateOracleResponseTx;
import io.neow3j.protocol.core.response.NeoExpressGetContractStorage;
import io.neow3j.protocol.core.response.NeoExpressGetNep17Contracts;
import io.neow3j.protocol.core.response.NeoExpressGetPopulatedBlocks;
import io.neow3j.protocol.core.response.NeoExpressListContracts;
import io.neow3j.protocol.core.response.NeoExpressListOracleRequests;
import io.neow3j.protocol.core.response.NeoExpressShutdown;
import io.neow3j.protocol.core.response.OracleResponse;
import io.neow3j.types.Hash160;

import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;

/**
 * JSON-RPC 2.0 factory implementation specific to Neo-express nodes.
 */
public class Neow3jExpress extends JsonRpc2_0Neow3j implements NeoExpress {

    private Neow3jExpress(Neow3jService neow3jService, Neow3jConfig config) {
        super(neow3jService, config);
    }

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

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

    @Override
    public Request expressGetPopulatedBlocks() {
        return new Request<>(
                "expressgetpopulatedblocks",
                emptyList(),
                neow3jService,
                NeoExpressGetPopulatedBlocks.class);
    }

    /**
     * Gets all deployed contracts that follow the NEP-17 standard.
     * 
     * Can only be used on a Neo-express node.
     *
     * @return the request object.
     */
    @Override
    public Request expressGetNep17Contracts() {
        return new Request<>(
                "expressgetnep17contracts",
                emptyList(),
                neow3jService,
                NeoExpressGetNep17Contracts.class);
    }

    /**
     * Gets the contract storage.
     * 

     * Can only be used on a Neo-express node.
     *
     * @param contractHash The contract hash.
     * @return the request object.
     */
    @Override
    public Request expressGetContractStorage(Hash160 contractHash) {
        return new Request<>(
                "expressgetcontractstorage",
                asList(contractHash),
                neow3jService,
                NeoExpressGetContractStorage.class);
    }

    /**
     * Gets a list of all deployed contracts.
     * 

     * Can only be used on a Neo-express node.
     *
     * @return the request object.
     */
    @Override
    public Request expressListContracts() {
        return new Request<>(
                "expresslistcontracts",
                emptyList(),
                neow3jService,
                NeoExpressListContracts.class);
    }

    /**
     * Creates a checkpoint of the Neo-express node and writes it to a file in the root of the
     * Neo-express instance.
     * 

     * Can only be used on a Neo-express node.
     *
     * @param filename the filename of the checkpoint file.
     * @return the request object.
     */
    @Override
    public Request expressCreateCheckpoint(String filename) {
        return new Request<>(
                "expresscreatecheckpoint",
                asList(filename),
                neow3jService,
                NeoExpressCreateCheckpoint.class);
    }

    /**
     * Gets a list of all current oracle requests.
     * 

     * Can only be used on a Neo-express node.
     *
     * @return the request object.
     */
    @Override
    public Request expressListOracleRequests() {
        return new Request<>(
                "expresslistoraclerequests",
                emptyList(),
                neow3jService,
                NeoExpressListOracleRequests.class);
    }

    /**
     * Creates an oracle response transaction.
     * 

     * Can only be used on a Neo-express node.
     *
     * @param response the oracle response object.
     * @return the request object.
     */
    @Override
    public Request expressCreateOracleResponseTx(OracleResponse response) {
        return new Request<>(
                "expresscreateoracleresponsetx",
                asList(response),
                neow3jService,
                NeoExpressCreateOracleResponseTx.class);
    }

    /**
     * Shuts down the neo-express instance.
     * 
     * Can only be used on a Neo-express node.
     *
     * @return the request object.
     */
    @Override
    public Request expressShutdown() {
        return new Request<>(
                "expressshutdown",
                emptyList(),
                neow3jService,
                NeoExpressShutdown.class);
    }

}