org.ergoplatform.appkit.TransactionBox 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.List;

import org.ergoplatform.sdk.ErgoToken;
import sigmastate.Values;

/**
 * This interface represents a box on a transaction, either an InputBox or an OutBox.
 *
 * @see InputBox
 * @see OutBox
 */
public interface TransactionBox {
    /**
     * Returns the nanoERG value stored in this box, i.e. unspent value in UTXO.
     */
    long getValue();

    /**
     * The height (block number) when the transaction containing this output box was
     * created.
     */
    int getCreationHeight();

    /**
     * Returns the tokens stored in this box.
     */
    List getTokens();

    /**
     * Returns values of the non-mandatory registers which are stored in the box (R4, R5, R6, R7, R8, R9)
     * Index 0 corresponds to R4, 1 -> R5, etc.
     */
    List> getRegisters();

    /**
     * Returns the ErgoTree of the script guarding the box
     */
    Values.ErgoTree getErgoTree();

    /** Returns {@link BoxAttachment} stored in this box or null. */
    BoxAttachment getAttachment();
}