{-# LANGUAGE PatternSynonyms #-}

-- | The interface to Plutus V1 for the ledger.
module PlutusLedgerApi.Data.V1
  ( -- * Scripts
    SerialisedScript
  , ScriptForEvaluation
  , serialisedScript
  , deserialisedScript
  , serialiseCompiledCode
  , serialiseUPLC
  , deserialiseScript
  , uncheckedDeserialiseUPLC

    -- * Running scripts
  , evaluateScriptRestricting
  , evaluateScriptCounting

    -- ** Protocol version
  , MajorProtocolVersion (..)

    -- ** Verbose mode and log output
  , VerboseMode (..)
  , LogOutput

    -- * Costing-related types
  , ExBudget (..)
  , ExCPU (..)
  , ExMemory (..)
  , SatInt (unSatInt)
  , fromSatInt

    -- ** Cost model
  , EvaluationContext
  , mkEvaluationContext
  , ParamName (..)
  , CostModelApplyError (..)
  , CostModelParams
  , assertWellFormedCostModelParams

    -- * Context types
  , ScriptContext
  , pattern ScriptContext
  , scriptContextTxInfo
  , scriptContextPurpose
  , ScriptPurpose
  , pattern Minting
  , pattern Spending
  , pattern Rewarding
  , pattern Certifying

    -- ** Supporting types used in the context types

    -- *** ByteStrings
  , BuiltinByteString
  , toBuiltin
  , fromBuiltin

    -- *** Bytes
  , LedgerBytes (..)
  , fromBytes

    -- *** Certificates
  , DCert
  , pattern DCertDelegRegKey
  , pattern DCertDelegDeRegKey
  , pattern DCertDelegDelegate
  , pattern DCertPoolRegister
  , pattern DCertPoolRetire
  , pattern DCertGenesis
  , pattern DCertMir

    -- *** Credentials
  , StakingCredential
  , pattern StakingHash
  , pattern StakingPtr
  , Credential
  , pattern PubKeyCredential
  , pattern ScriptCredential

    -- *** Value
  , Value (..)
  , CurrencySymbol (..)
  , TokenName (..)
  , singleton
  , unionWith
  , adaSymbol
  , adaToken
  , Lovelace (..)

    -- *** Time
  , POSIXTime (..)
  , POSIXTimeRange

    -- *** Types for representing transactions
  , Address
  , pattern Address
  , addressCredential
  , addressStakingCredential
  , PubKeyHash (..)
  , TxId (..)
  , TxInfo
  , pattern TxInfo
  , txInfoInputs
  , txInfoOutputs
  , txInfoFee
  , txInfoMint
  , txInfoDCert
  , txInfoWdrl
  , txInfoValidRange
  , txInfoSignatories
  , txInfoData
  , txInfoId
  , TxOut
  , pattern TxOut
  , txOutAddress
  , txOutValue
  , txOutDatumHash
  , TxOutRef
  , pattern TxOutRef
  , txOutRefId
  , txOutRefIdx
  , TxInInfo
  , pattern TxInInfo
  , txInInfoOutRef
  , txInInfoResolved

    -- *** Intervals
  , Interval
  , pattern Interval
  , ivFrom
  , ivTo
  , Extended
  , pattern NegInf
  , pattern PosInf
  , pattern Finite
  , Closure
  , UpperBound
  , pattern UpperBound
  , LowerBound
  , pattern LowerBound
  , always
  , from
  , to
  , lowerBound
  , upperBound
  , strictLowerBound
  , strictUpperBound

    -- *** Newtypes and hash types
  , ScriptHash (..)
  , Redeemer (..)
  , RedeemerHash (..)
  , Datum (..)
  , DatumHash (..)

    -- * Data
  , PLC.Data (..)
  , BuiltinData (..)
  , ToData (..)
  , FromData (..)
  , UnsafeFromData (..)
  , toData
  , fromData
  , dataToBuiltinData
  , builtinDataToData

    -- * Errors
  , EvaluationError (..)
  , ScriptDecodeError (..)
  ) where

import Data.SatInt
import PlutusCore.Data qualified as PLC
import PlutusCore.Evaluation.Machine.ExBudget as PLC
import PlutusLedgerApi.Common as Common hiding
  ( deserialiseScript
  , evaluateScriptCounting
  , evaluateScriptRestricting
  )
import PlutusLedgerApi.Common qualified as Common
  ( deserialiseScript
  , evaluateScriptCounting
  , evaluateScriptRestricting
  )
import PlutusLedgerApi.V1.Bytes
import PlutusLedgerApi.V1.Crypto
import PlutusLedgerApi.V1.Data.Address
import PlutusLedgerApi.V1.Data.Contexts
import PlutusLedgerApi.V1.Data.Credential
import PlutusLedgerApi.V1.Data.DCert
import PlutusLedgerApi.V1.Data.Interval hiding (singleton)
import PlutusLedgerApi.V1.Data.Time
import PlutusLedgerApi.V1.Data.Value
import PlutusLedgerApi.V1.EvaluationContext
import PlutusLedgerApi.V1.ParamName
import PlutusLedgerApi.V1.Scripts as Scripts

{-| An alias to the Plutus ledger language this module exposes at runtime.
 MAYBE: Use CPP '__FILE__' + some TH to automate this. -}
thisLedgerLanguage :: PlutusLedgerLanguage
thisLedgerLanguage :: PlutusLedgerLanguage
thisLedgerLanguage = PlutusLedgerLanguage
PlutusV1

{- Note [Abstract types in the ledger API]
We need to support old versions of the ledger API as we update the code that
it depends on. You might think that we should therefore make the types that
we expose abstract, and only expose specific functions for constructing and
working with them. However the situation is slightly different for us.

Normally, when you are in this situation, you want to retain the same *interface*
as the old version, but with the new types and functions underneath. Abstraction
lets you do this easily. But we actually want to keep the old *implementation*,
because things really have to work the same, bug-for-bug. And the types have to
translate into Plutus Core in exactly the same way, and so on.

So we're going to end up with multiple versions of the types and functions that
we expose here, even internally. That means we don't lose anything by exposing
all the details: we're never going to remove anything, we're just going to create
new versions.
-}

{-| The deserialization from a serialised script into a `ScriptForEvaluation`,
ready to be evaluated on-chain.
Called inside phase-1 validation (i.e., deserialisation error is a phase-1 error). -}
deserialiseScript
  :: forall m
   . MonadError ScriptDecodeError m
  => MajorProtocolVersion
  -- ^ which major protocol version the script was submitted in.
  -> SerialisedScript
  -- ^ the script to deserialise.
  -> m ScriptForEvaluation
deserialiseScript :: forall (m :: * -> *).
MonadError ScriptDecodeError m =>
MajorProtocolVersion -> SerialisedScript -> m ScriptForEvaluation
deserialiseScript = PlutusLedgerLanguage
-> MajorProtocolVersion
-> SerialisedScript
-> m ScriptForEvaluation
forall (m :: * -> *).
MonadError ScriptDecodeError m =>
PlutusLedgerLanguage
-> MajorProtocolVersion
-> SerialisedScript
-> m ScriptForEvaluation
Common.deserialiseScript PlutusLedgerLanguage
thisLedgerLanguage

{-| Evaluates a script, returning the minimum budget that the script would need
to evaluate successfully. lalaThis will take as long as the script takes, if you need to
limit the execution time of the script also, you can use 'evaluateScriptRestricting', which
also returns the used budget. -}
evaluateScriptCounting
  :: MajorProtocolVersion
  -- ^ Which major protocol version to run the operation in
  -> VerboseMode
  -- ^ Whether to produce log output
  -> EvaluationContext
  -- ^ Includes the cost model to use for tallying up the execution costs
  -> ScriptForEvaluation
  -- ^ The script to evaluate
  -> [PLC.Data]
  -- ^ The arguments to the script
  -> (LogOutput, Either EvaluationError ExBudget)
evaluateScriptCounting :: MajorProtocolVersion
-> VerboseMode
-> EvaluationContext
-> ScriptForEvaluation
-> [Data]
-> (LogOutput, Either EvaluationError ExBudget)
evaluateScriptCounting = PlutusLedgerLanguage
-> MajorProtocolVersion
-> VerboseMode
-> EvaluationContext
-> ScriptForEvaluation
-> [Data]
-> (LogOutput, Either EvaluationError ExBudget)
Common.evaluateScriptCounting PlutusLedgerLanguage
thisLedgerLanguage

{-| Evaluates a script, with a cost model and a budget that restricts how many
resources it can use according to the cost model. Also returns the budget that
was actually used.

Can be used to calculate budgets for scripts, but even in this case you must give
a limit to guard against scripts that run for a long time or loop. -}
evaluateScriptRestricting
  :: MajorProtocolVersion
  -- ^ Which major protocol version to run the operation in
  -> VerboseMode
  -- ^ Whether to produce log output
  -> EvaluationContext
  -- ^ Includes the cost model to use for tallying up the execution costs
  -> ExBudget
  -- ^ The resource budget which must not be exceeded during evaluation
  -> ScriptForEvaluation
  -- ^ The script to evaluate
  -> [PLC.Data]
  -- ^ The arguments to the script
  -> (LogOutput, Either EvaluationError ExBudget)
evaluateScriptRestricting :: MajorProtocolVersion
-> VerboseMode
-> EvaluationContext
-> ExBudget
-> ScriptForEvaluation
-> [Data]
-> (LogOutput, Either EvaluationError ExBudget)
evaluateScriptRestricting = PlutusLedgerLanguage
-> MajorProtocolVersion
-> VerboseMode
-> EvaluationContext
-> ExBudget
-> ScriptForEvaluation
-> [Data]
-> (LogOutput, Either EvaluationError ExBudget)
Common.evaluateScriptRestricting PlutusLedgerLanguage
thisLedgerLanguage