io.neow3j.devpack.contracts.LedgerContract Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of devpack Show documentation
neow3j: Java Development Package for Neo Smart Contracts
There is a newer version: 3.23.0
package io.neow3j.devpack.contracts;

import io.neow3j.devpack.Block;
import io.neow3j.devpack.Hash256;
import io.neow3j.devpack.Signer;
import io.neow3j.devpack.Transaction;
import io.neow3j.devpack.constants.NativeContract;

/**
 * Represents an interface to the native LedgerContract that stores all blocks and transactions.
 */
public class LedgerContract extends ContractInterface {

    /**
     * Initializes an interface to the native LedgerContract.
     */
    public LedgerContract() {
        super(NativeContract.LedgerContractScriptHash);
    }

    /**
     * @return the latest block hash.
     */
    public native Hash256 currentHash();

    /**
     * @return the current block height.
     */
    public native int currentIndex();

    /**
     * Gets the block at the given index/height.
     *
     * @param index the block index.
     * @return the block at the given index or {@code null} if it doesn't exist.
     */
    public native Block getBlock(int index);

    /**
     * Gets the block with the given hash.
     *
     * @param hash the block hash.
     * @return the block with the given hash or {@code null} if it doesn't exist.
     */
    public native Block getBlock(Hash256 hash);

    /**
     * Gets the transaction with the given hash.
     *
     * @param hash the transaction hash.
     * @return the transaction with the given hash or {@code null} if it doesn't exist.
     */
    public native Transaction getTransaction(Hash256 hash);

    /**
     * Gets the transaction at {@code index} in the block with {@code blockHash}.
     *
     * @param blockHash the block hash.
     * @param index     the transaction index in the block.
     * @return the transaction or {@code null} if it doesn't exist.
     */
    public native Transaction getTransactionFromBlock(Hash256 blockHash, int index);

    /**
     * Gets the transaction at {@code index} in the block at index {@code blockIndex}.
     *
     * @param blockIndex the block index/height.
     * @param index      the transaction index in the block.
     * @return the transaction or {@code null} if it doesn't exist.
     */
    public native Transaction getTransactionFromBlock(int blockIndex, int index);

    /**
     * Gets the signers of the transaction with the specified hash.
     *
     * @param txHash the transaction hash.
     * @return the signers of the transaction with the specified hash.
     */
    public native Signer[] getTransactionSigners(Hash256 txHash);

    /**
     * Gets the VM state of the transaction with the given hash.
     * 
     * Compare the state byte with the values in {@link io.neow3j.devpack.constants.VMState}.
     *
     * @param hash the transaction hash.
     * @return the transaction's VM state.
     */
    public native byte getTransactionVMState(Hash256 hash);

    /**
     * Gets the index of the block that contains the transaction with the given hash.
     *
     * @param hash the transaction hash.
     * @return the block index.
     */
    public native int getTransactionHeight(Hash256 hash);

}