# Nimbus
# Copyright (c) 2018 Status Research & Development GmbH
# Licensed under either of
#  * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
#    http://www.apache.org/licenses/LICENSE-2.0)
#  * MIT license ([LICENSE-MIT](LICENSE-MIT) or
#    http://opensource.org/licenses/MIT)
# at your option. This file may not be copied, modified, or distributed except
# according to those terms.

## Transaction Pool Info Symbols & Error Codes
## ===========================================

{.push raises: [].}

type
  TxInfo* = enum
    txInfoOk =
      (0, "no error")

    txInfoPackedBlockIncluded = ##\
      ## The transaction was disposed after packing into block
      "not needed anymore"

    txInfoSenderNonceSuperseded = ##\
      ## Tx superseded by another one with same <sender,nonce> index
      "Sender/nonce index superseded"

    txInfoErrNonceGap = ##\
      ## Non consecutive nonces detected after moving back the block chain
      ## head. This should not happen and indicates an inconsistency between
      ## cached transactions and the ones on the block chain.
      "nonce gap"

    txInfoErrImpliedNonceGap = ##\
      ## Implied disposal, applies to transactions with higher nonces after
      ## a `txInfoErrNonceGap` error.
      "implied nonce gap"

    txInfoExplicitDisposal = ##\
      ## Unspecified disposal reason (fallback value)
      "on-demand disposal"

    txInfoImpliedDisposal = ##\
      ## Implied disposal, typically implied by greater nonces (fallback value)
      "implied disposal"

    # ------ Miscellaneous errors ----------------------------------------------

    txInfoErrUnspecified = ##\
      ## Some unspecified error occured
      "generic error"

    txInfoErrVoidDisposal = ##\
      ## Cannot dispose non-existing item
      "void disposal"

    txInfoErrAlreadyKnown = ##\
      ## The transactions is already contained within the pool
      "already known"

    txInfoErrSenderNonceIndex = ##\
      ## <sender,nonce> index for transaction exists, already.
      "Sender/nonce index error"

    txInfoErrTxPoolOverflow = ##\
      ## The transaction pool is full and can't accpet another remote
      ## transaction.
      "txpool is full"

    # ------ Transaction format/parsing problems -------------------------------

    txInfoErrOversizedData = ##\
      ## The input data of a transaction is greater than some meaningful
      ## limit a user might use. This is not a consensus error making the
      ## transaction invalid, rather a DOS protection.
      "Oversized tx data"

    txInfoErrNegativeValue = ##\
      ## A sanity error to ensure no one is able to specify a transaction
      ## with a negative value.
      "Negative value in tx"

    txInfoErrUnexpectedProtection = ##\
      ## Transaction type does not supported EIP-1559 protected signature
      "Unsupported EIP-1559 signature protection"

    txInfoErrInvalidTxType = ##\
      ## Transaction type not valid in this context
      "Unsupported tx type"

    txInfoErrTxTypeNotSupported = ##\
      ## Transaction type not supported
      "Unsupported transaction type"

    txInfoErrEmptyTypedTx = ##\
      ## Typed transaction, missing data
      "Empty typed transaction bytes"

    txInfoErrBasicValidatorFailed = ##\
      ## Running basic validator failed on current transaction
      "Tx rejected by basic validator"

    txInfoErrInvalidBlob = ##\
      ## Invalid EIP-4844 kzg validation on blob wrapper
      "Invalid EIP-4844 blob validation"

    # ------ Signature problems ------------------------------------------------

    txInfoErrInvalidSender = ##\
      ## The transaction contains an invalid signature.
      "invalid sender"

    txInfoErrInvalidSig = ##\
      ## invalid transaction v, r, s values
      "Invalid transaction signature"

    # ------ Gas fee and selection problems ------------------------------------

    txInfoErrUnderpriced = ##\
      ## A transaction's gas price is below the minimum configured for the
      ## transaction pool.
      "Tx underpriced"

    txInfoErrReplaceUnderpriced = ##\
      ## A transaction is attempted to be replaced with a different one
      ## without the required price bump.
      "Replacement tx underpriced"

    txInfoErrGasLimit = ##\
      ## A transaction's requested gas limit exceeds the maximum allowance
      ## of the current block.
      "Tx exceeds block gasLimit"

    txInfoErrGasFeeCapTooLow = ##\
      ## Gase fee cap less than base fee
      "Tx has feeCap < baseFee"

    # ------- operational events related to transactions -----------------------

    txInfoErrTxExpired = ##\
      ## A transaction has been on the system for too long so it was removed.
      "Tx expired"

    txInfoErrTxExpiredImplied = ##\
     ## Implied disposal for greater nonces for the same sender when the base
     ## tx was removed.
     "Tx expired implied"

    txInfoTxStashed = ##\
      ## A transaction was item was created and stored in the disposal bin
      ## to be recycled and processed later.
      "Tx stashed"

    txInfoTxErrorRemoteExpected = ##\
      ## The sender account of a transaction was expected non-local.
      "Tx non-local expected"

    txInfoTxErrorLocalExpected = ##\
      ## The sender account of a transaction was expected local.
      "Tx local expected"

    # ------- update/move block chain head -------------------------------------

    txInfoErrAncestorMissing = ##\
      ## Cannot forward current head as it is detached from the block chain
      "Lost header ancestor"

    txInfoErrChainHeadMissing = ##\
      ## Must not back move current head as it is detached from the block chain
      "Lost header position"

    txInfoErrForwardHeadMissing = ##\
      ## Cannot move forward current head to non-existing target position
      "Non-existing forward header"

    txInfoErrUnrootedCurChain = ##\
      ## Some orphan block found in current branch of the block chain
      "Orphan block in current branch"

    txInfoErrUnrootedNewChain = ##\
      ## Some orphan block found in new branch of the block chain
      "Orphan block in new branch"

    txInfoChainHeadUpdate = ##\
      ## Tx becomes obsolete as it is in a mined block, already
      "Tx obsoleted"

    # ---------- debugging error codes as used in verifier functions -----------

    # failed verifier codes
    txInfoVfyLeafQueue             ## Corrupted leaf item queue

    txInfoVfyItemIdList            ## Corrupted ID queue/fifo structure
    txInfoVfyRejectsList           ## Corrupted waste basket structure
    txInfoVfyNonceChain            ## Non-consecutive nonces

    txInfoVfySenderRbTree          ## Corrupted sender list structure
    txInfoVfySenderLeafEmpty       ## Empty sender list leaf record
    txInfoVfySenderLeafQueue       ## Corrupted sender leaf queue
    txInfoVfySenderTotal           ## Wrong number of leaves
    txInfoVfySenderGasLimits       ## Wrong gas accu values
    txInfoVfySenderProfits         ## Profits calculation error

    txInfoVfyStatusRbTree          ## Corrupted status list structure
    txInfoVfyStatusTotal           ## Wrong number of leaves
    txInfoVfyStatusGasLimits       ## Wrong gas accu values
    txInfoVfyStatusSenderList      ## Corrupted status-sender sub-list
    txInfoVfyStatusNonceList       ## Corrupted status-nonce sub-list

    txInfoVfyStatusSenderTotal     ## Sender vs status table mismatch
    txInfoVfyStatusSenderGasLimits ## Wrong gas accu values

    txInfoVfyRankAddrMismatch      ## Different ranks in address set
    txInfoVfyReverseZombies        ## Zombie addresses in reverse lookup
    txInfoVfyRankReverseLookup     ## Sender missing in reverse lookup
    txInfoVfyRankReverseMismatch   ## Ranks differ with revers lookup
    txInfoVfyRankDuplicateAddr     ## Same address with different ranks
    txInfoVfyRankTotal             ## Wrong number of leaves (i.e. adresses)

    # codes provided for other modules
    txInfoVfyJobQueue              ## Corrupted jobs queue/fifo structure
    txInfoVfyJobEvent              ## Event table sync error

# End