Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plutus cost model: validate sizes in genesis files #724

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Plutus cost model: validate sizes in genesis files #724

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6632c4c
Plutus cost model size: add tests of validation
smelc Jan 14, 2025
1b71664
ProtocolParameters.hs: add function to validate cost model size
smelc Jan 15, 2025
cd62068
ProtocolParameters.hs: propagate new error behavior
smelc Jan 15, 2025
2a1154b
Adapt callers outside ProtocolParameters
smelc Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions cardano-api/internal/Cardano/Api/ProtocolParameters.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ import qualified Cardano.Ledger.Plutus.Language as Plutus
import qualified Cardano.Ledger.Shelley.API as Ledger
import Cardano.Slotting.Slot (EpochNo (..))
import PlutusLedgerApi.Common (CostModelApplyError)
import qualified PlutusLedgerApi.V1.ParamName as PlutusV1
import qualified PlutusLedgerApi.V2.ParamName as PlutusV2
import qualified PlutusLedgerApi.V3.ParamName as PlutusV3

import Control.Monad
import Data.Aeson (FromJSON (..), ToJSON (..), object, withObject, (.!=), (.:), (.:?),
Expand Down Expand Up @@ -1051,6 +1054,40 @@ toAlonzoCostModel (CostModel m) l = first (PpceInvalidCostModel (CostModel m)) $
fromAlonzoCostModel :: Alonzo.CostModel -> CostModel
fromAlonzoCostModel m = CostModel $ Alonzo.getCostModelParams m

validateCostModelSize
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not use validateCostModel?

:: Maybe (ShelleyBasedEra era)
-> Plutus.Language
-> [Int64]
-> Either CostModelNotEnoughParametersError CostModel
validateCostModelSize mSbe lang model
| actual < expected = Left $ CostModelNotEnoughParametersError lang expected actual
| actual == expected = Right $ CostModel model
| otherwise =
-- Since the number of parameters can increase in future versions of the Plutus language,
-- we are fine having too many parameters. This allows for easier testing.
Right $ CostModel model
where
actual = length model
expected = languageToMinimumParameterCount lang
allValues :: forall a. (Bounded a, Enum a) => [a]
allValues = [minBound :: a .. maxBound]
languageToMinimumParameterCount :: Plutus.Language -> Int
languageToMinimumParameterCount = \case
Plutus.PlutusV1 -> length $ allValues @PlutusV1.ParamName -- 166
Plutus.PlutusV2 ->
let nParamNames = length $ allValues @PlutusV2.ParamName -- 185
in case mSbe of
Nothing ->
-- We don't know the era, so we can't know the exact number of parameters that is expected,
-- so we need to be lenient
nParamNames - 10
Just sbe ->
caseShelleyToBabbageOrConwayEraOnwards
(const $ nParamNames - 10) -- Ten parameters were added to V2 in Conway, need to remove them here
(const nParamNames)
sbe
Plutus.PlutusV3 -> length $ allValues @PlutusV3.ParamName -- 297

-- ----------------------------------------------------------------------------
-- Proposals embedded in transactions to update protocol parameters
--
Expand Down Expand Up @@ -1853,6 +1890,11 @@ data ProtocolParametersConversionError
| PpceMissingParameter !ProtocolParameterName
deriving (Eq, Show, Data)

-- | @CostModelNotEnoughParametersError lang minimum actual@ is returned when the observed number of
-- protocol parameters for @lang@ is @actual@ and that number is below the @minimum@ expected number of parameters.
data CostModelNotEnoughParametersError
= CostModelNotEnoughParametersError Plutus.Language Int Int

type ProtocolParameterName = String

type ProtocolParameterVersion = Natural
Expand All @@ -1867,3 +1909,12 @@ instance Error ProtocolParametersConversionError where
"Invalid cost model: " <> pretty @Text (display err) <> " Cost model: " <> pshow cm
PpceMissingParameter name ->
"Missing parameter: " <> pretty name

instance Error CostModelNotEnoughParametersError where
prettyError (CostModelNotEnoughParametersError lang minimum' actual) =
"Not enough parameters for language "
<> pretty (Plutus.languageToText lang)
<> ". Expected at least "
<> pretty minimum'
<> " parameters but got "
<> pretty actual
Loading