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

Go to download
package org.ergoplatform.appkit;

import java.util.List;

/**
 * This interface represents a transaction which is signed by a prover
 * and can be sent to blockchain.
 * All inputs of the signed transaction has attached signatures (aka proofs)
 * which evidence that the prover knows the required secretes.
 *
 * @see ErgoProver
 * @see UnsignedTransaction
 */
public interface SignedTransaction extends Transaction {

    /**
     * Json representation of this transaction.
     *
     * @param prettyPrint if true, the ErgoTrees will be pretty printed, otherwise they
     *                    will be output as hex strings
     * @return formatted (pretty printed) JSON string
     */
    String toJson(boolean prettyPrint);

    /**
     * Json representation of this transaction.
     * Note, Json formatting is pretty-printed if either prettyPrint or formatJson is set
     * to true.
     *
     * @param prettyPrint if `true` then ergoTree is pretty-printed, otherwise
     *                    encoded bytes are used.
     * @param formatJson  if `true` then json pretty printer is used to format json output.
     *
     * @return string with json text
     */
    String toJson(boolean prettyPrint, boolean formatJson);

    /**
     * All signed inputs which will be spent when this transaction will be included in the blockchain.
     */
    List getSignedInputs();

    /**
     * Outputs of this transaction represented as {@link InputBox} objects ready to be spent in the next
     * chained transaction.
     * This method can be used to create a chain of transactions. Thus {@code tx1.getOutputsToSpend()} returns
     * a list of boxes which are ready to be included as input boxes to a new tx2.
     */
    List getOutputsToSpend();

    /**
     * Returns the estimated cost of this transaction.
     * NOTE, this cost is only an approximation of the actual cost of the transaction.
     * The actual cost may depend on the blockchain context, which may differ at the time
     * the transaction is picked up into a block candidate.
     */
    int getCost();

    /**
     * Returns the serialized bytes of this transaction.
     */
    byte[] toBytes();
}