diff --git a/bench/plutus-scripts-bench/LICENSE b/bench/plutus-scripts-bench/LICENSE new file mode 100644 index 00000000000..05f60f1016f --- /dev/null +++ b/bench/plutus-scripts-bench/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Input Output (Hong Kong) Ltd. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/bench/plutus-scripts-bench/plutus-scripts-bench.cabal b/bench/plutus-scripts-bench/plutus-scripts-bench.cabal new file mode 100644 index 00000000000..3f53fb1fc83 --- /dev/null +++ b/bench/plutus-scripts-bench/plutus-scripts-bench.cabal @@ -0,0 +1,90 @@ +cabal-version: 3.0 +name: plutus-scripts-bench +version: 1.0.0.0 +description: + Plutus scripts used for benchmarking. + +author: IOHK +maintainer: operations@iohk.io +license: Apache-2.0 +build-type: Simple + +flag unexpected_thunks + description: Turn on unexpected thunks checks + default: False + +flag defer-plugin-errors + description: + Defer errors from the plugin, useful for things like Haddock that can't handle it. + + default: False + manual: True + +common common-definitions + build-depends: base ^>=4.14 + default-language: Haskell2010 + default-extensions: + NoImplicitPrelude + ImportQualifiedPost + OverloadedStrings + + -- See Plutus Tx readme for why we need the following flags: + -- -fobject-code -fno-ignore-interface-pragmas and -fno-omit-interface-pragmas + ghc-options: + -Wall -Wcompat -Wincomplete-record-updates + -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints + -Wunused-packages -fobject-code -fno-ignore-interface-pragmas + -fno-omit-interface-pragmas + + if flag(defer-plugin-errors) + ghc-options: -fplugin-opt PlutusTx.Plugin:defer-errors + +common maybe-Win32 + +library + import: common-definitions + hs-source-dirs: src + + if os(windows) + build-depends: Win32 + + if flag(unexpected_thunks) + cpp-options: -DUNEXPECTED_THUNKS + + exposed-modules: + Cardano.Benchmarking.PlutusScripts.Loop + + -------------------- + -- Local components + -------------------- + -- build-depends: plutus-script-utils >=1.0.0 + + -------------------------- + -- Other IOG dependencies + -------------------------- + build-depends: + , cardano-api >=1.35 + --, cardano-cli >=1.35 + --, cardano-ledger-alonzo + --, cardano-ledger-babbage + --, cardano-ledger-core + --, cardano-ledger-shelley + --, cardano-slotting + --, ouroboros-consensus + --, ouroboros-network + , plutus-ledger-api >=1.0.0 + , plutus-tx >=1.0.0 + , plutus-tx-plugin >=1.0.0 + + ------------------------ + -- Non-IOG dependencies + ------------------------ + build-depends: + --, aeson + --, bytestring + --, containers + --, serialise + --, strict-containers + --, text + --, transformers + --, transformers-except diff --git a/bench/plutus-scripts-bench/src/Cardano/Benchmarking/PlutusScripts.hs b/bench/plutus-scripts-bench/src/Cardano/Benchmarking/PlutusScripts.hs new file mode 100644 index 00000000000..00b27904aa4 --- /dev/null +++ b/bench/plutus-scripts-bench/src/Cardano/Benchmarking/PlutusScripts.hs @@ -0,0 +1,43 @@ +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeApplications #-} + +module Cardano.Benchmarking.PlutusScripts + ( findPlutusScript + , getAllScripts + , listPlutusScripts + ) where + +import Cardano.Api + +import qualified Cardano.Benchmarking.PlutusScripts.Loop as Loop + +getAllScripts :: + [(String, ScriptInAnyLang)] +getAllScripts = + [ (normalizeModuleName Loop.scriptName, asAnyLang Loop.scriptSerialized) + ] + +listPlutusScripts :: + [String] +listPlutusScripts + = fst <$> getAllScripts + +findPlutusScript :: + String + -> Maybe ScriptInAnyLang +findPlutusScript + = (`lookup` getAllScripts) + +asAnyLang :: forall lang. IsPlutusScriptLanguage lang => + PlutusScript lang + -> ScriptInAnyLang +asAnyLang script + = toScriptInAnyLang $ PlutusScript (plutusScriptVersion @lang) script + +-- "A.B.C" --> "C.hs" +normalizeModuleName :: + String + -> String +normalizeModuleName + = (++ ".hs") . reverse . takeWhile (/= '.') . reverse diff --git a/bench/plutus-scripts-bench/src/Cardano/Benchmarking/PlutusScripts/Loop.hs b/bench/plutus-scripts-bench/src/Cardano/Benchmarking/PlutusScripts/Loop.hs new file mode 100644 index 00000000000..c45f1fb5f51 --- /dev/null +++ b/bench/plutus-scripts-bench/src/Cardano/Benchmarking/PlutusScripts/Loop.hs @@ -0,0 +1,53 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} + +module Cardano.Benchmarking.PlutusScripts.Loop + ( scriptName + , scriptSerialized + ) where + +import Language.Haskell.TH +import Language.Haskell.TH.Syntax +import Prelude hiding (pred, ($), (&&), (<), (==)) + +import Cardano.Api.Shelley (PlutusScript (..), PlutusScriptV1) + +import Codec.Serialise +import Data.ByteString.Lazy qualified as LBS +import Data.ByteString.Short qualified as SBS + +import Plutus.V1.Ledger.Scripts qualified as Plutus +import PlutusTx +import PlutusTx.Builtins (unsafeDataAsI) +import PlutusTx.Prelude hiding (Semigroup (..), unless, (.)) + + +scriptName :: String +scriptName + = $(LitE . StringL . loc_module <$> qLocation) + + +{-# INLINABLE mkValidator #-} +mkValidator :: BuiltinData -> BuiltinData -> BuiltinData -> () +mkValidator _datum redeemer _txContext + = if n < 1000000 + then traceError "redeemer is < 1000000" + else loop n + where + n = unsafeDataAsI redeemer + loop i = if i == 1000000 then () else loop $ pred i + +validator :: Plutus.Validator +validator = Plutus.mkValidatorScript $$(PlutusTx.compile [|| mkValidator ||]) + +script :: Plutus.Script +script = Plutus.unValidatorScript validator + +loopScriptShortBs :: SBS.ShortByteString +loopScriptShortBs = SBS.toShort . LBS.toStrict $ serialise script + +scriptSerialized :: PlutusScript PlutusScriptV1 +scriptSerialized = PlutusScriptSerialised loopScriptShortBs diff --git a/bench/tx-generator/src/Cardano/Benchmarking/Plutus/BenchCustomCall.hs b/bench/tx-generator/src/Cardano/Benchmarking/Plutus/BenchCustomCall.hs index 6cd83e79283..43dc9e53019 100644 --- a/bench/tx-generator/src/Cardano/Benchmarking/Plutus/BenchCustomCall.hs +++ b/bench/tx-generator/src/Cardano/Benchmarking/Plutus/BenchCustomCall.hs @@ -9,15 +9,16 @@ module Cardano.Benchmarking.Plutus.BenchCustomCall ( BenchCustomArg , BenchCommand(..) , BenchCustomData(..) - , customCallScript - , customCallScriptShortBs + , customCallScriptV1 + , customCallScriptV2 ) where -import Cardano.Api (PlutusScript, PlutusScriptV2) +import Cardano.Api (PlutusScript, PlutusScriptV1, PlutusScriptV2) import Cardano.Api.Shelley (PlutusScript (..)) import Codec.Serialise (serialise) import qualified Data.ByteString.Lazy as LBS import qualified Data.ByteString.Short as SBS +import qualified Plutus.V1.Ledger.Api as PlutusV1 import qualified Plutus.V2.Ledger.Api as PlutusV2 import qualified PlutusTx import PlutusTx.Prelude as Plutus hiding (Semigroup (..), (.)) @@ -52,8 +53,8 @@ PlutusTx.unstableMakeIsData ''BenchCommand {-# INLINEABLE mkValidator #-} -mkValidator :: BuiltinData -> BuiltinData -> BuiltinData -> () -mkValidator datum_ redeemer_ _txContext = +mkValidator :: (BuiltinData -> BenchCustomArg) -> BuiltinData -> BuiltinData -> BuiltinData -> () +mkValidator unwrap datum_ redeemer_ _txContext = let result = case cmd of EvalSpine -> length redeemerArg == length datumArg @@ -62,8 +63,8 @@ mkValidator datum_ redeemer_ _txContext = in if result then () else error () where datum, redeemer :: BenchCustomArg - datum = PlutusV2.unsafeFromBuiltinData datum_ - redeemer = PlutusV2.unsafeFromBuiltinData redeemer_ + datum = unwrap datum_ + redeemer = unwrap redeemer_ datumArg = snd datum (cmd, redeemerArg) = redeemer @@ -73,14 +74,34 @@ mkValidator datum_ redeemer_ _txContext = validateValue (BenchConcat s ss) = s == mconcat ss validateValue _ = True -validator :: PlutusV2.Validator -validator = PlutusV2.mkValidatorScript $$(PlutusTx.compile [|| mkValidator ||]) +{-# INLINEABLE mkValidatorV1 #-} +mkValidatorV1 :: BuiltinData -> BuiltinData -> BuiltinData -> () +mkValidatorV1 = mkValidator PlutusV1.unsafeFromBuiltinData -script :: PlutusV2.Script -script = PlutusV2.unValidatorScript validator +{-# INLINEABLE mkValidatorV2 #-} +mkValidatorV2 :: BuiltinData -> BuiltinData -> BuiltinData -> () +mkValidatorV2 = mkValidator PlutusV2.unsafeFromBuiltinData -customCallScriptShortBs :: SBS.ShortByteString -customCallScriptShortBs = SBS.toShort . LBS.toStrict $ serialise script +validatorV1 :: PlutusV1.Validator +validatorV1 = PlutusV1.mkValidatorScript $$(PlutusTx.compile [|| mkValidatorV1 ||]) -customCallScript :: PlutusScript PlutusScriptV2 -customCallScript = PlutusScriptSerialised customCallScriptShortBs +validatorV2 :: PlutusV2.Validator +validatorV2 = PlutusV2.mkValidatorScript $$(PlutusTx.compile [|| mkValidatorV2 ||]) + +scriptV1 :: PlutusV1.Script +scriptV1 = PlutusV1.unValidatorScript validatorV1 + +scriptV1SBS :: SBS.ShortByteString +scriptV1SBS = SBS.toShort . LBS.toStrict $ serialise scriptV1 + +customCallScriptV1 :: PlutusScript PlutusScriptV1 +customCallScriptV1 = PlutusScriptSerialised scriptV1SBS + +scriptV2 :: PlutusV2.Script +scriptV2 = PlutusV2.unValidatorScript validatorV2 + +scriptV2SBS :: SBS.ShortByteString +scriptV2SBS = SBS.toShort . LBS.toStrict $ serialise scriptV2 + +customCallScriptV2 :: PlutusScript PlutusScriptV2 +customCallScriptV2 = PlutusScriptSerialised scriptV2SBS diff --git a/bench/tx-generator/src/Cardano/Benchmarking/Plutus/PlutusInclude.hs b/bench/tx-generator/src/Cardano/Benchmarking/Plutus/PlutusInclude.hs deleted file mode 100644 index 09ae6d30bee..00000000000 --- a/bench/tx-generator/src/Cardano/Benchmarking/Plutus/PlutusInclude.hs +++ /dev/null @@ -1,34 +0,0 @@ -{-# LANGUAGE RankNTypes #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TypeApplications #-} - -module Cardano.Benchmarking.Plutus.PlutusInclude - ( includePlutusScript - , listPlutusScripts - ) where - -import Cardano.Api - -import Cardano.Benchmarking.Plutus.BenchCustomCall - -library :: - [(String, ScriptInAnyLang)] -library = - [ ("BenchCustomCall.hs", asAnyLang customCallScript) - ] - -listPlutusScripts :: - [String] -listPlutusScripts - = map fst library - -includePlutusScript :: - String -> Maybe ScriptInAnyLang -includePlutusScript - = (`lookup` library) - -asAnyLang :: forall lang. IsPlutusScriptLanguage lang => - PlutusScript lang - -> ScriptInAnyLang -asAnyLang script - = toScriptInAnyLang $ PlutusScript (plutusScriptVersion @lang) script diff --git a/bench/tx-generator/src/Cardano/Benchmarking/Script/Core.hs b/bench/tx-generator/src/Cardano/Benchmarking/Script/Core.hs index b180efa6fcd..6d97d017f23 100644 --- a/bench/tx-generator/src/Cardano/Benchmarking/Script/Core.hs +++ b/bench/tx-generator/src/Cardano/Benchmarking/Script/Core.hs @@ -62,7 +62,6 @@ import Cardano.Benchmarking.LogTypes as Core (TraceBenchTxSubmit (..), import Cardano.Benchmarking.Types as Core (SubmissionErrorPolicy (..)) import Cardano.Benchmarking.Wallet as Wallet -import Cardano.Benchmarking.Plutus.PlutusInclude import Cardano.Benchmarking.Script.Aeson (prettyPrintOrdered, readProtocolParametersFile) import Cardano.Benchmarking.Script.Env hiding (Error (TxGenError)) import qualified Cardano.Benchmarking.Script.Env as Env (Error (TxGenError)) @@ -389,7 +388,7 @@ makePlutusContext ScriptSpec{..} = do then maybe (liftTxGenError $ TxGenError $ "Plutus script not included: " ++ scriptSpecFile) return - (includePlutusScript scriptSpecFile) + (pure Nothing) -- (includePlutusScript scriptSpecFile) else liftIOSafe $ Plutus.readPlutusScript scriptSpecFile executionUnitPrices <- case protocolParamPrices protocolParameters of diff --git a/bench/tx-generator/test/ApiTest.hs b/bench/tx-generator/test/ApiTest.hs index 374c53217aa..441b0bf2870 100644 --- a/bench/tx-generator/test/ApiTest.hs +++ b/bench/tx-generator/test/ApiTest.hs @@ -121,9 +121,11 @@ checkPlutusBuiltin :: checkPlutusBuiltin = do let - ~(Just script) = includePlutusScript "BenchCustomCall.hs" - putStrLn "* serialisation of built-in Plutus script:" - BSL.putStrLn $ textEnvelopeToJSON Nothing customCallScript + ~(Just script) = includePlutusScript "BenchCustomCallV2.hs" + putStrLn "* serialisation of built-in Plutus script V1:" + BSL.putStrLn $ textEnvelopeToJSON Nothing customCallScriptV1 + putStrLn "* serialisation of built-in Plutus script V2:" + BSL.putStrLn $ textEnvelopeToJSON Nothing customCallScriptV2 protocolParameters <- readProtocolParametersOrDie forM_ bArgs $ \bArg -> do diff --git a/bench/tx-generator/tx-generator.cabal b/bench/tx-generator/tx-generator.cabal index b28e2112238..6ebf93e14eb 100644 --- a/bench/tx-generator/tx-generator.cabal +++ b/bench/tx-generator/tx-generator.cabal @@ -57,7 +57,6 @@ library Cardano.Benchmarking.Wallet Cardano.Benchmarking.Plutus.BenchCustomCall - Cardano.Benchmarking.Plutus.PlutusInclude Cardano.TxGenerator.Fund Cardano.TxGenerator.FundQueue diff --git a/cabal.project b/cabal.project index 6a3c0016742..7e07ad5fb06 100644 --- a/cabal.project +++ b/cabal.project @@ -28,6 +28,7 @@ packages: cardano-tracer bench/cardano-topology bench/locli + bench/plutus-scripts-bench bench/tx-generator trace-dispatcher trace-resources