Skip to content

Plutus cost model: validate sizes in genesis files#724

Draft
smelc wants to merge 4 commits intomasterfrom
smelc/validate-cost-models-upon-deserialization
Draft

Plutus cost model: validate sizes in genesis files#724
smelc wants to merge 4 commits intomasterfrom
smelc/validate-cost-models-upon-deserialization

Conversation

@smelc
Copy link
Contributor

@smelc smelc commented Jan 14, 2025 •
edited by palas
Loading

Changelog

- description: |
    Plutus cost model: validate sizes in genesis files
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...
# uncomment at least one main project this PR is associated with
  projects:
  # - cardano-api
  # - cardano-api-gen
  # - cardano-rpc
  # - cardano-wasm

Context

API part of IntersectMBO/cardano-cli#928

How to trust this PR

TBD

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@smelc smelc force-pushed the smelc/validate-cost-models-upon-deserialization branch 2 times, most recently from e7abb54 to 82c6d28 Compare January 14, 2025 21:03
@smelc smelc force-pushed the smelc/validate-cost-models-upon-deserialization branch from 82c6d28 to 6632c4c Compare January 14, 2025 21:04
github-advanced-security[bot]
github-advanced-security bot found potential problems Jan 15, 2025
View reviewed changes
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
, protocolUpdateUTxOCostPerByte = Nothing
}
where
mCostModels :: Maybe (Plutus.CostModels)

Check warning

Code scanning / HLint

Redundant bracket Warning

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1478:24-42: Warning: Redundant bracket
  
Found:
  (Plutus.CostModels)
  
Perhaps:
  Plutus.CostModels
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
costModels :: Either
CostModelNotEnoughParametersError
(Maybe (Map AnyPlutusScriptVersion CostModel))
costModels = sequence $ fromAlonzoCostModels <$> mCostModels

Check warning

Code scanning / HLint

Use mapM Warning

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1484:16-62: Warning: Use mapM
  
Found:
  sequence $ fromAlonzoCostModels <$> mCostModels
  
Perhaps:
  mapM fromAlonzoCostModels mCostModels
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
(\(Ledger.ProtVer a b) -> (Ledger.getVersion a, b))
<$> strictMaybeToMaybe (ppu ^. ppuProtocolVersionL)
}
(fromAlonzoCommonPParamsUpdate ppu) <&> \ppu' ->

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1491:3-37: Suggestion: Redundant bracket
  
Found:
  (fromAlonzoCommonPParamsUpdate ppu)
    <&>
      \\ ppu'
        -> ppu'
             {protocolUpdateProtocolVersion = (\\ (Ledger.ProtVer a b)
                                                 -> (Ledger.getVersion a, b))
                                                <$> strictMaybeToMaybe (ppu ^. ppuProtocolVersionL)}
  
Perhaps:
  fromAlonzoCommonPParamsUpdate ppu
    <&>
      \\ ppu'
        -> ppu'
             {protocolUpdateProtocolVersion = (\\ (Ledger.ProtVer a b)
                                                 -> (Ledger.getVersion a, b))
                                                <$> strictMaybeToMaybe (ppu ^. ppuProtocolVersionL)}
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
(fromAlonzoCommonPParamsUpdate ppu)
{ protocolUpdateUTxOCostPerByte = unCoinPerByte <$> strictMaybeToMaybe (ppu ^. ppuCoinsPerUTxOByteL)
}
(fromAlonzoCommonPParamsUpdate ppu) <&> \ppu' ->

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1503:3-37: Suggestion: Redundant bracket
  
Found:
  (fromAlonzoCommonPParamsUpdate ppu)
    <&>
      \\ ppu'
        -> ppu'
             {protocolUpdateUTxOCostPerByte = unCoinPerByte
                                                <$> strictMaybeToMaybe (ppu ^. ppuCoinsPerUTxOByteL)}
  
Perhaps:
  fromAlonzoCommonPParamsUpdate ppu
    <&>
      \\ ppu'
        -> ppu'
             {protocolUpdateUTxOCostPerByte = unCoinPerByte
                                                <$> strictMaybeToMaybe (ppu ^. ppuCoinsPerUTxOByteL)}
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
(\(Ledger.ProtVer a b) -> (Ledger.getVersion a, b))
<$> strictMaybeToMaybe (ppu ^. ppuProtocolVersionL)
}
(fromBabbageCommonPParamsUpdate ppu) <&> \ppu' ->

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1513:3-38: Suggestion: Redundant bracket
  
Found:
  (fromBabbageCommonPParamsUpdate ppu)
    <&>
      \\ ppu'
        -> ppu'
             {protocolUpdateProtocolVersion = (\\ (Ledger.ProtVer a b)
                                                 -> (Ledger.getVersion a, b))
                                                <$> strictMaybeToMaybe (ppu ^. ppuProtocolVersionL)}
  
Perhaps:
  fromBabbageCommonPParamsUpdate ppu
    <&>
      \\ ppu'
        -> ppu'
             {protocolUpdateProtocolVersion = (\\ (Ledger.ProtVer a b)
                                                 -> (Ledger.getVersion a, b))
                                                <$> strictMaybeToMaybe (ppu ^. ppuProtocolVersionL)}
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
(fromAlonzoPParams pp)
{ protocolParamUTxOCostPerByte = Just . unCoinPerWord $ pp ^. ppCoinsPerUTxOWordL
}
(fromAlonzoPParams pp) <&> \pp' ->

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1801:3-24: Suggestion: Redundant bracket
  
Found:
  (fromAlonzoPParams pp)
    <&>
      \\ pp'
        -> pp'
             {protocolParamUTxOCostPerByte = Just . unCoinPerWord
                                               $ pp ^. ppCoinsPerUTxOWordL}
  
Perhaps:
  fromAlonzoPParams pp
    <&>
      \\ pp'
        -> pp'
             {protocolParamUTxOCostPerByte = Just . unCoinPerWord
                                               $ pp ^. ppCoinsPerUTxOWordL}
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
{ protocolParamUTxOCostPerByte = Just . unCoinPerByte $ pp ^. ppCoinsPerUTxOByteL
, protocolParamDecentralization = Nothing
}
(fromAlonzoPParams pp) <&> \pp' ->

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/internal/Cardano/Api/ProtocolParameters.hs:1815:3-24: Suggestion: Redundant bracket
  
Found:
  (fromAlonzoPParams pp)
    <&>
      \\ pp'
        -> pp'
             {protocolParamUTxOCostPerByte = Just . unCoinPerByte
                                               $ pp ^. ppCoinsPerUTxOByteL,
              protocolParamDecentralization = Nothing}
  
Perhaps:
  fromAlonzoPParams pp
    <&>
      \\ pp'
        -> pp'
             {protocolParamUTxOCostPerByte = Just . unCoinPerByte
                                               $ pp ^. ppCoinsPerUTxOByteL,
              protocolParamDecentralization = Nothing}
@smelc smelc force-pushed the smelc/validate-cost-models-upon-deserialization branch from 3d6de33 to dc0d52b Compare January 15, 2025 16:06
@smelc smelc force-pushed the smelc/validate-cost-models-upon-deserialization branch from dc0d52b to bb8f66f Compare January 15, 2025 17:05
github-advanced-security[bot]
github-advanced-security bot found potential problems Jan 15, 2025
View reviewed changes
cardano-api/internal/Cardano/Api/Tx/Body.hs
case body ^. L.updateTxBodyL of
SNothing -> TxUpdateProposalNone
SJust p -> TxUpdateProposal w (fromLedgerUpdate sbe p)
SNothing -> pure TxUpdateProposalNone

Check notice

Code scanning / HLint

Redundant bracket Note

cardano-api/internal/Cardano/Api/Tx/Body.hs:2548:45-68: Suggestion: Redundant bracket
  
Found:
  TxUpdateProposal w <$> (fromLedgerUpdate sbe p)
  
Perhaps:
  TxUpdateProposal w <$> fromLedgerUpdate sbe p
@smelc smelc force-pushed the smelc/validate-cost-models-upon-deserialization branch from bb8f66f to 2a1154b Compare January 16, 2025 13:33
Jimbo4350
Jimbo4350 reviewed Jan 16, 2025
View reviewed changes
cardano-api/internal/Cardano/Api/ProtocolParameters.hs
fromAlonzoCostModel :: Alonzo.CostModel -> CostModel
fromAlonzoCostModel m = CostModel $ Alonzo.getCostModelParams m

validateCostModelSize
Copy link
Contributor

@Jimbo4350 Jimbo4350 Jan 16, 2025

Choose a reason for hiding this comment

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

Why not use validateCostModel?

@smelc smelc mentioned this pull request Jan 16, 2025
Merged
2 tasks
@github-actions
Copy link

github-actions bot commented May 13, 2025

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label May 13, 2025
@carbolymer carbolymer removed the Stale label May 13, 2025
@github-actions
Copy link

github-actions bot commented Jun 28, 2025

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label Jun 28, 2025
@carbolymer carbolymer removed the Stale label Jul 1, 2025
@github-actions
Copy link

github-actions bot commented Sep 8, 2025

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label Sep 8, 2025
@carbolymer carbolymer removed the Stale label Sep 8, 2025
@github-actions
Copy link

github-actions bot commented Nov 8, 2025

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label Nov 8, 2025
@carbolymer carbolymer removed the Stale label Nov 17, 2025
@github-actions
Copy link

github-actions bot commented Jan 2, 2026

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label Jan 2, 2026
@carbolymer carbolymer removed the Stale label Jan 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jimbo4350 Jimbo4350 Jimbo4350 left review comments

@dcoutts dcoutts Awaiting requested review from dcoutts dcoutts will be requested when the pull request is marked ready for review dcoutts is a code owner

@erikd erikd Awaiting requested review from erikd erikd will be requested when the pull request is marked ready for review erikd is a code owner

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy will be requested when the pull request is marked ready for review newhoggy is a code owner

@carbolymer carbolymer Awaiting requested review from carbolymer carbolymer will be requested when the pull request is marked ready for review carbolymer is a code owner

@palas palas Awaiting requested review from palas palas will be requested when the pull request is marked ready for review palas is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond will be requested when the pull request is marked ready for review kevinhammond is a code owner

@CarlosLopezDeLara CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara will be requested when the pull request is marked ready for review CarlosLopezDeLara is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler will be requested when the pull request is marked ready for review disassembler is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@smelc @Jimbo4350 @carbolymer