TxParser.java

/*
 * This file is part of Bisq.
 *
 * bisq is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * bisq is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with bisq. If not, see <http://www.gnu.org/licenses/>.
 */

package bisq.core.dao.node.parser;

import bisq.core.dao.node.parser.exceptions.InvalidGenesisTxException;
import bisq.core.dao.state.BsqStateService;
import bisq.core.dao.state.blockchain.OpReturnType;
import bisq.core.dao.state.blockchain.RawTx;
import bisq.core.dao.state.blockchain.TempTx;
import bisq.core.dao.state.blockchain.TempTxOutput;
import bisq.core.dao.state.blockchain.Tx;
import bisq.core.dao.state.blockchain.TxInput;
import bisq.core.dao.state.blockchain.TxOutputKey;
import bisq.core.dao.state.blockchain.TxOutputType;
import bisq.core.dao.state.blockchain.TxType;
import bisq.core.dao.state.governance.Param;
import bisq.core.dao.state.period.DaoPhase;
import bisq.core.dao.state.period.PeriodService;

import bisq.common.app.DevEnv;

import org.bitcoinj.core.Coin;

import javax.inject.Inject;

import com.google.common.annotations.VisibleForTesting;

import java.util.List;
import java.util.Optional;

import lombok.extern.slf4j.Slf4j;

import static com.google.common.base.Preconditions.checkArgument;

/**
 * Verifies if a given transaction is a BSQ transaction.
 */
@Slf4j
public class TxParser {
    private final PeriodService periodService;
    private final BsqStateService bsqStateService;
    private long remainingInputValue;
    private TxOutputParser txOutputParser;
    private TxInputParser txInputParser;

    @Inject
    public TxParser(PeriodService periodService,
                    BsqStateService bsqStateService) {
        this.periodService = periodService;
        this.bsqStateService = bsqStateService;
    }

    // Apply state changes to tx, inputs and outputs
    // return true if any input contained BSQ
    // Any tx with BSQ input is a BSQ tx (except genesis tx but that is not handled in
    // that class).
    // There might be txs without any valid BSQ txOutput but we still keep track of it,
    // for instance to calculate the total burned BSQ.
    public Optional<Tx> findTx(RawTx rawTx, String genesisTxId, int genesisBlockHeight, Coin genesisTotalSupply) {
        txInputParser = new TxInputParser(bsqStateService);
        txOutputParser = new TxOutputParser(bsqStateService);

        // Let's see if we have a genesis tx
        Optional<TempTx> optionalGenesisTx = TxParser.findGenesisTx(
                genesisTxId,
                genesisBlockHeight,
                genesisTotalSupply,
                rawTx);
        if (optionalGenesisTx.isPresent()) {
            TempTx genesisTx = optionalGenesisTx.get();
            txOutputParser.processGenesisTxOutput(genesisTx);
            return Optional.of(Tx.fromTempTx(genesisTx));
        }

        // If it is not a genesis tx we continue to parse to see if it is a valid BSQ tx.
        int blockHeight = rawTx.getBlockHeight();
        // We could pass tx also to the sub validators but as long we have not refactored the validators to pure
        // functions lets use the parsingModel.
        TempTx tempTx = TempTx.fromRawTx(rawTx);

        for (int inputIndex = 0; inputIndex < tempTx.getTxInputs().size(); inputIndex++) {
            TxInput input = tempTx.getTxInputs().get(inputIndex);
            TxOutputKey outputKey = input.getConnectedTxOutputKey();
            txInputParser.process(outputKey, blockHeight, rawTx.getId(), inputIndex);
        }

        long accumulatedInputValue = txInputParser.getAccumulatedInputValue();
        txOutputParser.setAvailableInputValue(accumulatedInputValue);
        txOutputParser.setUnlockBlockHeight(txInputParser.getUnlockBlockHeight());
        txOutputParser.setOptionalSpentLockupTxOutput(txInputParser.getOptionalSpentLockupTxOutput());
        txOutputParser.setTempTx(tempTx); //TODO remove

        boolean hasBsqInputs = accumulatedInputValue > 0;
        if (hasBsqInputs) {
            final List<TempTxOutput> outputs = tempTx.getTempTxOutputs();
            // We start with last output as that might be an OP_RETURN output and gives us the specific tx type, so it is
            // easier and cleaner at parsing the other outputs to detect which kind of tx we deal with.
            // Setting the opReturn type here does not mean it will be a valid BSQ tx as the checks are only partial and
            // BSQ inputs are not verified yet.
            // We keep the temporary opReturn type in the parsingModel object.
            checkArgument(!outputs.isEmpty(), "outputs must not be empty");
            int lastIndex = outputs.size() - 1;
            txOutputParser.processOpReturnCandidate(outputs.get(lastIndex));

            // We use order of output index. An output is a BSQ utxo as long there is enough input value
            // We iterate all outputs including the opReturn to do a full validation including the BSQ fee
            for (int index = 0; index < outputs.size(); index++) {
                boolean isLastOutput = index == lastIndex;
                txOutputParser.processTxOutput(isLastOutput,
                        outputs.get(index),
                        index
                );
            }

            remainingInputValue = txOutputParser.getAvailableInputValue();

            processOpReturnType(blockHeight, tempTx);

            // We don't allow multiple opReturn outputs (they are non-standard but to be safe lets check it)
            long numOpReturnOutputs = tempTx.getTempTxOutputs().stream().filter(txOutputParser::isOpReturnOutput).count();
            if (numOpReturnOutputs <= 1) {
                boolean isAnyTxOutputTypeUndefined = tempTx.getTempTxOutputs().stream()
                        .anyMatch(txOutput -> TxOutputType.UNDEFINED == txOutput.getTxOutputType());
                if (!isAnyTxOutputTypeUndefined) {
                    // TODO(chirhonul): we don't modify the tempTx within the call below, so maybe we should
                    // use RawTx?
                    TxType txType = TxParser.getBisqTxType(
                            tempTx,
                            txOutputParser.getOptionalOpReturnTypeCandidate().isPresent(),
                            remainingInputValue,
                            getOptionalOpReturnType()
                    );
                    tempTx.setTxType(txType);
                    if (remainingInputValue > 0)
                        tempTx.setBurntFee(remainingInputValue);
                } else {
                    tempTx.setTxType(TxType.INVALID);
                    String msg = "We have undefined txOutput types which must not happen. tx=" + tempTx;
                    DevEnv.logErrorAndThrowIfDevMode(msg);
                }
            } else {
                // We don't consider a tx with multiple OpReturn outputs valid.
                tempTx.setTxType(TxType.INVALID);
                String msg = "Invalid tx. We have multiple opReturn outputs. tx=" + tempTx;
                log.warn(msg);
            }
        }

        // TODO || parsingModel.getBurntBondValue() > 0; should not be necessary
        // How should we consider the burnt BSQ from spending a LOCKUP tx with the wrong format.
        // Example: LOCKUP txOutput is 1000 satoshi but first txOutput in spending tx is 900
        // satoshi, this burns the 1000 satoshi and is currently not considered in the
        // bsqInputBalancePositive, hence the need to check for parsingModel.getBurntBondValue
        // Perhaps adding boolean parsingModel.isBSQTx and checking for that would be better?

        if (hasBsqInputs || txInputParser.getBurntBondValue() > 0)
            return Optional.of(Tx.fromTempTx(tempTx));
        else
            return Optional.empty();
    }

    private void processOpReturnType(int blockHeight, TempTx tempTx) {
        // We might have a opReturn output
        OpReturnType verifiedOpReturnType = null;
        Optional<OpReturnType> optionalVerifiedOpReturnType = txOutputParser.getOptionalVerifiedOpReturnType();
        if (optionalVerifiedOpReturnType.isPresent()) {
            verifiedOpReturnType = optionalVerifiedOpReturnType.get();

            long bsqFee = remainingInputValue;

            boolean isFeeAndPhaseValid;
            switch (verifiedOpReturnType) {
                case PROPOSAL:
                    isFeeAndPhaseValid = isFeeAndPhaseValid(blockHeight, bsqFee, DaoPhase.Phase.PROPOSAL, Param.PROPOSAL_FEE);
                    if (!isFeeAndPhaseValid) {
                        tempTx.setTxType(TxType.INVALID);
                    }
                    break;
                case COMPENSATION_REQUEST:
                    isFeeAndPhaseValid = isFeeAndPhaseValid(blockHeight, bsqFee, DaoPhase.Phase.PROPOSAL, Param.PROPOSAL_FEE);
                    Optional<TempTxOutput> optionalIssuanceCandidate = txOutputParser.getOptionalIssuanceCandidate();
                    if (isFeeAndPhaseValid) {
                        if (optionalIssuanceCandidate.isPresent()) {
                            // Now after we have validated the opReturn data we will apply the TxOutputType
                            optionalIssuanceCandidate.get().setTxOutputType(TxOutputType.ISSUANCE_CANDIDATE_OUTPUT);
                        } else {
                            log.warn("It can be that we have a opReturn which is correct from its structure but the whole tx " +
                                    "in not valid as the issuanceCandidate in not there. " +
                                    "As the BSQ fee is set it must be either a buggy tx or an manually crafted invalid tx.");
                        }
                    } else {
                        tempTx.setTxType(TxType.INVALID);
                        optionalIssuanceCandidate.ifPresent(tempTxOutput -> tempTxOutput.setTxOutputType(TxOutputType.BTC_OUTPUT));
                        // Empty Optional case is a possible valid case where a random tx matches our opReturn rules but it is not a
                        // valid BSQ tx.
                    }
                    break;
                case BLIND_VOTE:
                    isFeeAndPhaseValid = isFeeAndPhaseValid(blockHeight, bsqFee, DaoPhase.Phase.BLIND_VOTE, Param.BLIND_VOTE_FEE);
                    if (!isFeeAndPhaseValid) {
                        tempTx.setTxType(TxType.INVALID);
                        Optional<TempTxOutput> optionalBlindVoteLockStakeOutput = txOutputParser.getOptionalBlindVoteLockStakeOutput();
                        optionalBlindVoteLockStakeOutput.ifPresent(tempTxOutput -> tempTxOutput.setTxOutputType(TxOutputType.BTC_OUTPUT));
                        // Empty Optional case is a possible valid case where a random tx matches our opReturn rules but it is not a
                        // valid BSQ tx.
                    }
                    break;
                case VOTE_REVEAL:
                    boolean isPhaseValid = isPhaseValid(blockHeight, DaoPhase.Phase.VOTE_REVEAL);
                    boolean isVoteRevealInputInValid = txInputParser.getVoteRevealInputState() != TxInputParser.VoteRevealInputState.VALID;
                    if (!isPhaseValid) {
                        tempTx.setTxType(TxType.INVALID);
                    }
                    if (!isPhaseValid || isVoteRevealInputInValid) {
                        Optional<TempTxOutput> optionalVoteRevealUnlockStakeOutput = txOutputParser
                                .getOptionalVoteRevealUnlockStakeOutput();
                        optionalVoteRevealUnlockStakeOutput.ifPresent(
                                tempTxOutput -> tempTxOutput
                                        .setTxOutputType(TxOutputType.BTC_OUTPUT));
                        // Empty Optional case is a possible valid case where a random tx matches our opReturn rules but it is not a
                        // valid BSQ tx.
                    }
                    break;
                case LOCKUP:
                    // do nothing
                    break;
            }
        }

        // We need to check if any temp txOutput is available and if so and the OpRetrun data is invalid we
        // set the output to a BTC output. We must not use if else cases here!
        if (verifiedOpReturnType != OpReturnType.COMPENSATION_REQUEST) {
            txOutputParser.getOptionalIssuanceCandidate().ifPresent(tempTxOutput -> tempTxOutput.setTxOutputType(TxOutputType.BTC_OUTPUT));
        }

        if (verifiedOpReturnType != OpReturnType.BLIND_VOTE) {
            txOutputParser.getOptionalBlindVoteLockStakeOutput().ifPresent(tempTxOutput -> tempTxOutput.setTxOutputType(TxOutputType.BTC_OUTPUT));
        }

        if (verifiedOpReturnType != OpReturnType.VOTE_REVEAL) {
            txOutputParser.getOptionalVoteRevealUnlockStakeOutput().ifPresent(tempTxOutput -> tempTxOutput.setTxOutputType(TxOutputType.BTC_OUTPUT));
        }

        if (verifiedOpReturnType != OpReturnType.LOCKUP) {
            txOutputParser.getOptionalLockupOutput().ifPresent(tempTxOutput -> tempTxOutput.setTxOutputType(TxOutputType.BTC_OUTPUT));
        }
    }

    /**
     * Whether the BSQ fee and phase is valid for a transaction.
     *
     * @param blockHeight The height of the block that the transaction is in.
     * @param bsqFee      The fee in BSQ, in satoshi.
     * @param phase       The current phase of the DAO, e.g {@code DaoPhase.Phase.PROPOSAL}.
     * @param param       The parameter for the fee, e.g {@code Param.PROPOSAL_FEE}.
     * @return True if the fee and phase was valid, false otherwise.
     */
    private boolean isFeeAndPhaseValid(int blockHeight, long bsqFee, DaoPhase.Phase phase, Param param) {
        // The leftover BSQ balance from the inputs is the BSQ fee in case we are in an OP_RETURN output

        if (!isPhaseValid(blockHeight, phase)) {
            return false;
        }

        long paramValue = bsqStateService.getParamValue(param, blockHeight);
        boolean isFeeCorrect = bsqFee == paramValue;
        if (!isFeeCorrect) {
            log.warn("Invalid fee. used fee={}, required fee={}", bsqFee, paramValue);
        }
        return isFeeCorrect;
    }

    private boolean isPhaseValid(int blockHeight, DaoPhase.Phase phase) {
        boolean isInPhase = periodService.isInPhase(blockHeight, phase);
        if (!isInPhase) {
            log.warn("Not in {} phase. blockHeight={}", phase, blockHeight);
        }
        return isInPhase;
    }

    /**
     * Retrieve the type of the transaction, assuming it is relevant to bisq.
     *
     * @param tx                   The temporary transaction.
     * @param hasOpReturnCandidate True if we have a candidate for an OP_RETURN.
     * @param remainingInputValue  The remaining value of inputs not yet accounted for, in satoshi.
     * @param optionalOpReturnType If present, the OP_RETURN type of the transaction.
     * @return The type of the transaction, if it is relevant to bisq.
     */
    @VisibleForTesting
    static TxType getBisqTxType(TempTx tx, boolean hasOpReturnCandidate, long remainingInputValue, Optional<OpReturnType> optionalOpReturnType) {
        TxType txType;
        // We need to have at least one BSQ output
        if (optionalOpReturnType.isPresent()) {
            log.debug("Optional OP_RETURN type is present for tx.");
            txType = TxParser.getTxTypeForOpReturn(tx, optionalOpReturnType.get());
        } else if (!hasOpReturnCandidate) {
            log.debug("No optional OP_RETURN type and no OP_RETURN candidate is present for tx.");

            boolean bsqFeesBurnt = remainingInputValue > 0;
            if (bsqFeesBurnt) {
                // Burned fee but no opReturn
                txType = TxType.PAY_TRADE_FEE;
            } else if (tx.getTempTxOutputs().get(0).getTxOutputType() == TxOutputType.UNLOCK) {
                txType = TxType.UNLOCK;
            } else {
                log.debug("No burned fee and no OP_RETURN, so this is a TRANSFER_BSQ tx.");
                txType = TxType.TRANSFER_BSQ;
            }
        } else {
            log.debug("No optional OP_RETURN type is present for tx but we do have an OP_RETURN candidate, so it failed validation.");
            txType = TxType.INVALID;
        }

        return txType;
    }

    private static TxType getTxTypeForOpReturn(TempTx tx, OpReturnType opReturnType) {
        switch (opReturnType) {
            case COMPENSATION_REQUEST:
                boolean hasCorrectNumOutputs = tx.getTempTxOutputs().size() >= 3;
                if (!hasCorrectNumOutputs) {
                    log.warn("Compensation request tx need to have at least 3 outputs");
                    return TxType.INVALID;
                }

                TempTxOutput issuanceTxOutput = tx.getTempTxOutputs().get(1);
                boolean hasIssuanceOutput = issuanceTxOutput.getTxOutputType() == TxOutputType.ISSUANCE_CANDIDATE_OUTPUT;
                if (!hasIssuanceOutput) {
                    log.warn("Compensation request txOutput type of output at index 1 need to be ISSUANCE_CANDIDATE_OUTPUT. " +
                            "TxOutputType={}", issuanceTxOutput.getTxOutputType());
                    return TxType.INVALID;
                }

                return TxType.COMPENSATION_REQUEST;
            case PROPOSAL:
                return TxType.PROPOSAL;
            case BLIND_VOTE:
                return TxType.BLIND_VOTE;
            case VOTE_REVEAL:
                return TxType.VOTE_REVEAL;
            case LOCKUP:
                return TxType.LOCKUP;
            default:
                log.warn("We got a BSQ tx with fee and unknown OP_RETURN. tx={}", tx);
                return TxType.INVALID;
        }
    }

    /**
     * The type of the OP_RETURN value of the transaction, if it has such a BSQ output.
     *
     * @return The OP_RETURN type if applicable, otherwise Optional.empty().
     */
    private Optional<OpReturnType> getOptionalOpReturnType() {
        if (txOutputParser.isBsqOutputFound()) {
            // We want to be sure that the initial assumption of the opReturn type was matching the result after full
            // validation.
            Optional<OpReturnType> optionalOpReturnTypeCandidate = txOutputParser.getOptionalOpReturnTypeCandidate();
            Optional<OpReturnType> optionalVerifiedOpReturnType = txOutputParser.getOptionalVerifiedOpReturnType();
            if (optionalOpReturnTypeCandidate.isPresent() && optionalVerifiedOpReturnType.isPresent()) {
                if (optionalOpReturnTypeCandidate.get() == optionalVerifiedOpReturnType.get()) {
                    return optionalVerifiedOpReturnType;
                } else {
                    String msg = "We got a different opReturn type after validation as we expected initially. " +
                            "optionalOpReturnTypeCandidate=" + optionalOpReturnTypeCandidate +
                            ", optionalVerifiedOpReturnType=" + txOutputParser.getOptionalVerifiedOpReturnType();
                    log.warn(msg);
                }
            }
        } else {
            String msg = "We got a tx without any valid BSQ output but with burned BSQ. " +
                    "Burned fee=" + remainingInputValue / 100D + " BSQ.";
            log.warn(msg);
        }
        return Optional.empty();
    }

    /**
     * Parse and return the genesis transaction for bisq, if applicable.
     *
     * @param genesisTxId        The transaction id of the bisq genesis transaction.
     * @param genesisBlockHeight The block height of the bisq genesis transaction.
     * @param genesisTotalSupply The total supply of the genesis issuance for bisq.
     * @param rawTx              The candidate transaction.
     * @return The genesis transaction if applicable, or Optional.empty() otherwise.
     */
    public static Optional<TempTx> findGenesisTx(String genesisTxId, int genesisBlockHeight, Coin genesisTotalSupply,
                                                 RawTx rawTx) {
        boolean isGenesis = rawTx.getBlockHeight() == genesisBlockHeight &&
                rawTx.getId().equals(genesisTxId);
        if (!isGenesis)
            return Optional.empty();

        TempTx tempTx = TempTx.fromRawTx(rawTx);
        tempTx.setTxType(TxType.GENESIS);
        long remainingInputValue = genesisTotalSupply.getValue();
        for (int i = 0; i < tempTx.getTempTxOutputs().size(); ++i) {
            TempTxOutput txOutput = tempTx.getTempTxOutputs().get(i);
            long value = txOutput.getValue();
            boolean isValid = value <= remainingInputValue;
            if (!isValid)
                throw new InvalidGenesisTxException("Genesis tx is invalid; using more than available inputs. " +
                        "Remaining input value is " + remainingInputValue + " sat; tx info: " + tempTx.toString());

            remainingInputValue -= value;
            txOutput.setTxOutputType(TxOutputType.GENESIS_OUTPUT);
        }
        if (remainingInputValue > 0) {
            throw new InvalidGenesisTxException("Genesis tx is invalid; not using all available inputs. " +
                    "Remaining input value is " + remainingInputValue + " sat, tx info: " + tempTx.toString());
        }
        return Optional.of(tempTx);
    }
}