[Builtins] Polish handling of integral types #6036
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…to effectfully/builtins/polish-handling-of-integral-types
effectfully
commented
May 29, 2024
| @@ -174,7 +174,7 @@ instance | |||
| type IsBuiltin _ (MetaForall name a) = 'False | |||
| type ToHoles _ (MetaForall name a) = '[TypeHole a] | |||
| type ToBinds uni acc (MetaForall name a) = ToBinds uni (Insert ('GADT.Some name) acc) a | |||
| toTypeAst _ = toTypeAst $ Proxy @a | |||
| typeAst = toTypeAst $ Proxy @a | |||
There was a problem hiding this comment.
It now doesn't take a proxy argument, so that newtype- and via-deriving are available. The old toTypeAst is now provided as a standalone function for backward compatibility.
Comment on lines
190
to
+193
| instance tyname ~ TyName => KnownTypeAst tyname DefaultUni Void where | ||
| toTypeAst _ = runQuote $ do | ||
| type IsBuiltin _ _ = 'False | ||
| type ToHoles _ _ = '[] | ||
| type ToBinds _ acc _ = acc |
There was a problem hiding this comment.
The type instances were missing and the incorrect ones were derived automatically, so it only worked by accident. Good thing that it's all just test code.
| a <- freshTyName "a" | ||
| pure $ TyForall () a (Type ()) $ TyVar () a | ||
| instance UniOf term ~ DefaultUni => MakeKnownIn DefaultUni term Void where | ||
| makeKnown = absurd | ||
| instance UniOf term ~ DefaultUni => ReadKnownIn DefaultUni term Void where | ||
| readKnown _ = throwing _UnliftingError "Can't unlift to 'Void'" | ||
| readKnown _ = throwing _StructuralUnliftingError "Can't unlift to 'Void'" |
There was a problem hiding this comment.
We used to only support throwing structural unlifting errors with attached text and operational errors with no attached text (just raw failure), now we also support throwing operational unlifting errors with attached text (and use that feature, see below). Hence we now need to explicitly distinguish between the two kinds of errors.
Comment on lines
+360
to
+363
| -- | For deriving 'KnownTypeAst', 'MakeKnown' and 'ReadKnown' instances via 'Integer'. | ||
| newtype AsInteger a = AsInteger | ||
| { unAsInteger :: a | ||
| } |
There was a problem hiding this comment.
The new thing allowing us to uniformly handle all of Int8/Int16/Int32/Int64 and the same for Word* types.
Comment on lines
+386
to
+392
| if fromIntegral (minBound :: a) <= i && i <= fromIntegral (maxBound :: a) | ||
| then pure . AsInteger $ fromIntegral i | ||
| else throwing _OperationalUnliftingError . MkUnliftingError $ fold | ||
| [ Text.pack $ show i | ||
| , " is not within the bounds of " | ||
| , Text.pack . show . typeRep $ Proxy @a | ||
| ] |
There was a problem hiding this comment.
This is where we now throw operational unlifting errors with text attached. It used to be an operational unlifting error as well, just without any text.
Unfortunately, the user will still not get the message as of right now because of
{- Note [Ignoring context in OperationalEvaluationError]
The 'OperationalEvaluationError' error has a term argument, but 'extractEvaluationResult' just
discards this and returns 'EvaluationFailure'. This means that, for example, if we use the @plc@
command to execute a program containing a division by zero, @plc@ exits silently without reporting
that anything has gone wrong (but returning a non-zero exit code to the shell via 'exitFailure').
This is because 'OperationalEvaluationError' is used in cases when a PLC program itself goes wrong
(see the Haddocks of 'EvaluationError'). This is used to signal unsuccessful validation and so is
not regarded as a real error; in contrast structural errors are genuine errors and we report their
context if available.
-}
which I believe is simply wrong, we shouldn't erase error messages so early.
| deriving via AsInteger Word64 instance HasConstantIn DefaultUni term => | ||
| MakeKnownIn DefaultUni term Word64 | ||
| deriving via AsInteger Word64 instance HasConstantIn DefaultUni term => | ||
| ReadKnownIn DefaultUni term Word64 |
There was a problem hiding this comment.
We could have an instance for Natural as well, but that can't be handled with AsInteger, because Natural doesn't have a maxBound, so I decided not to bother implementing it manually, maybe we'll never need it.
There was a problem hiding this comment.
Maybe it is better to have here only those types that we currently rely upon for our current builtins?
There was a problem hiding this comment.
I want to have a consistent set. Why should we support Word8 but not Int8? Int64 but not Word64? Let's just add all of them and save the user from scratching their head upon getting an error message saying that Int8 isn't support when they copied some code from a builtin using Word8.
| -} | ||
| data EvaluationError operational structural | ||
| = OperationalEvaluationError !operational | ||
| | StructuralEvaluationError !structural |
There was a problem hiding this comment.
This is all the same stuff as in the recent PR about operational vs structural errors, I just it moved it to its own module.
| , Pretty operational, PrettyBy config structural | ||
| ) => PrettyBy config (EvaluationError operational structural) where | ||
| prettyBy _ (OperationalEvaluationError operational) = pretty operational | ||
| prettyBy config (StructuralEvaluationError structural) = prettyBy config structural |
There was a problem hiding this comment.
It's kinda weird that operational errors aren't pretty-printed configurably, but this all is old code and I'm not gonna bother fixing it here.
| throwBuiltinErrorWithCause | ||
| :: (MonadError (ErrorWithCause err cause) m, AsUnliftingError err, AsEvaluationFailure err) | ||
| => cause -> BuiltinError -> m void | ||
| throwBuiltinErrorWithCause cause = \case |
There was a problem hiding this comment.
Moved it to PlutusCore.Evaluation.ErrorWithCause.
| @@ -115,6 +115,9 @@ type CkM uni fun s = | |||
| instance AsEvaluationFailure CkUserError where | |||
| _EvaluationFailure = _EvaluationFailureVia CkEvaluationFailure | |||
|
|
|||
| instance AsUnliftingError CkUserError where | |||
| _UnliftingError = _UnliftingErrorVia CkEvaluationFailure | |||
There was a problem hiding this comment.
Everything used to work without this instance, because we had a general AsUnliftingError instance for any EvaluationError, but that forced us to make all unlifting errors structural, which was wrong.
I'll either create a separate PR for it or open an issue (likely the latter). |
bezirg
reviewed
May 30, 2024
| deriving via AsInteger Word instance HasConstantIn DefaultUni term => | ||
| MakeKnownIn DefaultUni term Word | ||
| instance HasConstantIn DefaultUni term => ReadKnownIn DefaultUni term Word where | ||
| readKnown term = fromIntegral @Word64 @Word <$> readKnown term |
There was a problem hiding this comment.
This I think should be inside the #if WORD_SIZE_IN_BITS == 64 cpp macro since you are assuming Word is 64bits?
There was a problem hiding this comment.
It is, it's just that the diff in unwieldy.
bezirg
approved these changes
May 30, 2024
|
/benchmark validation |
|
Click here to check the status of your benchmark. |
|
Comparing benchmark results of 'validation' on '85cf1edc5' (base) and 'b61cce8a4' (PR) Results table
|
Unisay
approved these changes
May 31, 2024
effectfully
deleted the
effectfully/builtins/polish-handling-of-integral-types
branch
ramsay-t
added a commit
that referenced
this pull request
Aug 6, 2024
* Trace removal re-implemented as a IR rewrite rule (#5907) * refactor: Internal module for RewriteRules, Monoid Instance * Trace removal re-implemented as a IR rewrite rule * Test case for an impure trace message, added note. * CIP-0057 Howto: exporting a Plutus contract blueprint (#5817) * Howto: exporting a Plutus contract blueprint * howto/exporting-a-blueprint uses literal includes * Changelog record * Paragraph about `deriveArgumentBlueprint` / `deriveParameterBlueprint` * Include plutus.json literally * [Release] 1.26.0.0 (#5914) Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> * A quick isabelle experiment. (#5913) * PLT-8171: Combine PIR, PLC, and UPLC into a single executable (#5699) Acked-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> * chore(deps): bump slackapi/slack-github-action from 1.25.0 to 1.26.0 (#5915) Bumps [slackapi/slack-github-action](https://github.com/slackapi/slack-github-action) from 1.25.0 to 1.26.0. - [Release notes](https://github.com/slackapi/slack-github-action/releases) - [Commits](slackapi/slack-github-action@v1.25.0...v1.26.0) --- updated-dependencies: - dependency-name: slackapi/slack-github-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Kwxm/plc spec/bitwise conversions (#5911) * Intial text for bitwise conversions * Intial text for bitwise conversions * Updates * Tidying up * Tidying up * Deal with edge cases more concisely * More tidying up * Rearrange some cases * Almost done * More clarification * Update specification date * Some clarification after PR comments * Use Int64 in CostModelParams (#5920) * Change CMTooFewParamsError to a warning (#5912) * [Costing] Provide support for multiple 'CostModel's (#5851) * CaseOfCase kind mismatch error fix (#5923) * Fix issue #5922 * test_extractTyArgs * CaseOfCase: cover types with two type args * Fix some Notes so they pass the check (#5930) * Restore old cost model param names (#5932) * Tidy up SimpleJSON.hs (#5936) * chore: formatting (#5937) * 1.27.0.0 (#5938) * Do not build the plutus executable if GHC <9.6 (#5940) * Update CONTRIBUTING.adoc (#5950) * Add 'Note [Table of all possible ledger's states w.r.t. cost model parameters update]' (#5935) * Remove annoying error message (#5956) * Add plutus-tx-template Release Instructions and GH Workflow (#5952) * [StdLib] Strictify 'fix' (#5939) This makes `fix` stricter so that the body of the function that it takes always gets forced regardless of whether the necessary argument is provided or not. Resolves #5961. --------- Co-authored-by: Yura Lazaryev <Yuriy.Lazaryev@iohk.io> * [PIR] Don't generate 'fixBy' if you don't need to (#5954) Removes unnecessary generation of `fixBy` when we only need `fix`. * Chore: formatting, imports, pragmas. (#5965) * CaseOfCase UPLC transformation tests. (#5960) * Avoid evaluating `nilCase` strictly in `matchList`, and rename the original `matchList` to `matchList'` (#5901) * Improvements to plutus-metatheory site (#5959) * Improvements to plutus-metatheory site * Added markdown titles to markdown files so they get built properly. Not all of the titles are very interesting. --------- Co-authored-by: Ramsay Taylor <ramsay.taylor@iohk.io> * chore(deps): bump nixbuild/nix-quick-install-action from 27 to 28 (#5951) Bumps [nixbuild/nix-quick-install-action](https://github.com/nixbuild/nix-quick-install-action) from 27 to 28. - [Release notes](https://github.com/nixbuild/nix-quick-install-action/releases) - [Changelog](https://github.com/nixbuild/nix-quick-install-action/blob/master/RELEASE) - [Commits](nixbuild/nix-quick-install-action@v27...v28) --- updated-dependencies: - dependency-name: nixbuild/nix-quick-install-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * [Build] Remove the doctests runner of 'prettyprinter-configurable' (#5974) * Kwxm/mainnet script budgets (#5973) * Mainnet script budget analysis * Comment * Add a comment * Release 1.28.0.0 (#5975) * [PlutusTx] [Builtins] Split 'FromBuiltin' and 'ToBuiltin' (#5971) This addresses the [inconsistencies](#5547 (comment)) that we got from using the now retired `FromBuiltin`/`ToBuiltin` classes for two mutually exclusive purposes. Now we have two versions of those classes: one is used for converting builtins to Plutus Tx types and back, while the other one is for making builtins transparent/opaque within Plutus Tx. These two purposes are very similar, but also subtly different and that is explained in the docs. * Update README.md (#5997) * chore(deps): bump cachix/install-nix-action from 26 to 27 (#5999) Bumps [cachix/install-nix-action](https://github.com/cachix/install-nix-action) from 26 to 27. - [Release notes](https://github.com/cachix/install-nix-action/releases) - [Commits](cachix/install-nix-action@v26...V27) --- updated-dependencies: - dependency-name: cachix/install-nix-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Script to prepare binary executables for uploading to the github release page. (#6015) * Kwxm/mainnet script budgets 2 (#6057) * Get the script analysis executable to print out actual execution costs * Tidying up * Empty comment * Dot * Output evaluation status too * Oops * Add integerToByteString and byteStringToInteger to PlutusV2 at PV10 (#6056) * [Refactoring] Remove 'UnknownBuiltin' and 'UnknownBuiltinType' (#6064) * Conditionally add 'triage' label to new issues (#6061) * Add triage label only when the issue does not have any of the 'Internal' labels * Fix bug in add-triage-label.yml (#6067) * chore(deps): bump benchmark-action/github-action-benchmark (#6058) Bumps [benchmark-action/github-action-benchmark](https://github.com/benchmark-action/github-action-benchmark) from 1.19.3 to 1.20.3. - [Release notes](https://github.com/benchmark-action/github-action-benchmark/releases) - [Changelog](https://github.com/benchmark-action/github-action-benchmark/blob/master/CHANGELOG.md) - [Commits](benchmark-action/github-action-benchmark@v1.19.3...v1.20.3) --- updated-dependencies: - dependency-name: benchmark-action/github-action-benchmark dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add integerToByteString and byteStringToInteger to V2.ParamName (#6065) * Add PlutusTx Map backed by Data (#5927) Co-authored-by: Ziyang Liu <unsafeFixIO@gmail.com> Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> * Let nightly.yml accept hedgehog-tests input (#6062) * Let nightly.yml accept hedgehog-tests input * Default tests from 10k to 50k * Remove obsolete defer-plugin-errors flag (#6080) * Add a Plutus Tx test utility package (#6086) Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> * [Errors] polish evaluation errors (#6043) We have this distinction of "user" vs "internal" errors that made some sense when TPLC was what was evaluated, but now that it's UPLC, all of those are "user" errors. So I was going to remove the distinction entirely just to realize that it in fact still makes sense, it's just now "operational" vs "structural". This PR clarifies this. I've also tweaked errors a bit while I was here, plus removed a bunch of unsafe functions from the CEK machine API (they were convenient when they were exposed from a single module, but now that we have several of them, it's no longer worth the trouble, plus we really should use some different approach to calling the CEK machine in the benchmarks, but that's not within the scope of this PR). * [Test] Add do-notation support for 'TestNested' (#5948) This refactors the `TestNested` machinery, so that 1. it supports listing tests in a `do`-block, which is something that I need in a different PR to update a huge `do`-block so that some of the tests there become golden 2. the API is more granular and pushes the user in the right direction I've also improved some of the tests while I was there and unified the formatting. Most of the tests we have use 4 spaces instead of 2, so I preserved that, we're probably going to run `fourmolu` over all the files eventually anyway and that'll make the indentation 2-space-based. * Run nightly tests on plutus-benchmark (#6091) * [Exe] Generalize 'withL' to 'withLangGeneral' (#5918) * Kwxm/provisional conway cost model (#6087) * Rename semantics variants * Change some names * Get uplc to use correct cost model for semvar * Dumping cost models * Dumping cost models * Tidy up exports and tests * Move a function * More updates * Fix some typos * Update models.R * Add updated cost models * Add updated cost models * Update test results * Remove obsolete entries from V3.ParamName * Fix cost model interface test * Fix (sort of) plutus-ledger-api tests * Various small fixes * Forgot to update parameters * Add changelog entries * Fix the changelog entries * Address PR review comments * Add costs for new builtins to V1 and V2 cost model files * Fix some dependencies in plutus-benchmark * Fix partial reversion of #6086 caused by merge * Remove old cost model files * Update/rename benchmark CSV files * Update issue templates (#6037) * Remove reference to benching.csv in plutus-core.cabal (#6149) * PlutusV3: Datum/Redeemer in ScriptContext, Datum Optional, Unified Script Type (#5934) * Kwxm/costing/reduce CEK CPU step costs B (#6153) * Make CEK step costs for models B anc C identical * Add changelog entry * Add changelog entry * [Test] Dump UPLC for 'strictLetRec' (#5963) * Use the most recent evaluation context for most of the benchmarks (#6152) * [Builtins] Polish handling of integral types (#6036) This - adds support for throwing operational unlifting errors in the builtins machinery, which allows us to attach a message to an unlifting failure. Unfortunately this is still not enough to propagate proper error messages to the user, because they get erased by the evaluation machinery down the line, this is our 2018's legacy of the stupid idea to have raw evaluation failures that don't carry any content - makes handling of integral types in `PlutusCore.Default.Universe` uniform (it was a mess before with a weird partial set of instances and morally the same instances being implemented differently) * Tests for the `preserve-logging` flag. (#6162) * Require PlutusV3 scripts to evaluate to BuiltinUnit (#6159) * Quadratic costing for integer division functions (#6161) * Quadratic costing for integer division functions * Correct some typos * Agda typo * Fix V2's costModelParamsForTesting (#6166) * Release 1.29.0.0 (#6170) * Update update-version.sh to match package names less greedily (#6174) * Update update-version.sh to match package names less greedily * Allow whitespace after comma * Allow whitespace after comma * Clarify comment * More error checking (#6179) * Reorganized Plutus user guide on the Docusaurus platform initial deployment (#6177) * Initial Docusaurus Setup * uploaded docs files and images * added code files and images * cleaned up mermaid diagrams for platform page * committed yarn.lock file * Add markdown link styling * Update Plutus styling and add GA plugin * updating yarn.lock file * CSV Rendering component * adding cost model parameters page that imports CSV files * Fix gradient overflow on tables for dark mode * changing title to Plutus user guide * Update favicon and social card assets * Remove landing page and set /docs to base path * Update literal include roots * Rename Haddock workflow and update to include Docusaurus build * Update docusaurus/README.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr-index.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr-index.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr-index.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr2.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/essential-concepts/language-versions.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/essential-concepts/language-versions.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/essential-concepts/language-versions.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/essential-concepts/language-versions.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Update docusaurus/docs/adr/adr1.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * committing after running pre-commit run --all-files command to fix build errors --------- Co-authored-by: ianhanssoniohk <ian.hansson@iohk.io> Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * Initial version of new combined-haddock.yml workflow (#6182) * [Builtins] Make 'BuiltinSuccess' the first constructor (#5885) This makes `BuiltinSuccess` the first constructor of `BuiltinResult`, see the comment there of why we want that. See [this](#5885 (comment)) comment for the very ambiguous benchmarking results. * [PlutusLedgerApi] [Refactoring] Polish imports and exports (#6178) This - resolves #6098 - moves a bunch of stuff shared among `V1`/`V2`/`V3` into `Common` (see the PR review) - makes all imports in the `Common`/`V1`/`V2`/`V3` modules qualified so that it's clear where definitions come from and whether they are inherited from `Common` or an earlier ledger language - fixes some formatting, adds a definition for consistency etc * Adding link to Haddock documentation to index.md (#6187) * removing outdated and incorrect content from the Plutus platform page (#6188) * Add `Data.Value` to `PlutusLedgerAPI` (#6143) Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> * added the term Haddock where the public Plutus code libraries are mentioned since it is a term likely to be used in searches (#6190) * Refactored Serialise/Flat-Via. Fixes #6083 (#6144) Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> * Add Redeemer to V3 ScriptContext Pretty instance (#6191) * Logical operations (#5970) * Initial port of logical ops * Add PlutusTx correspondents to the new builtins * Tests for logical operations * Rest of tests * Formatting of denotations * Rename byteStringReplicate to replicateByteString * Correct references to CIP-121 * Changelogs, document tests * Note commutativity for new operations * Properly rename replicate builtin, add to plutus-tx-plugin * Make new logical builtins available in V3 * Fix links to CIP-122, use toOpaque and fromOpaque instead * Correct all references to CIP-122 * Rename bitwise builtins, use proper costing * Bitwise primops will not be in Conway * Rename tests to suit new primop names * Combined Haddock Generation (#6146) * Run nightly tests on plutus-shared instead of plutus-benchmark (#6195) * Run combined-haddock.yml workflow on plutus-shared instead of plutus-runner (#6196) * Fix combined_haddock.sh script (#6199) * [Test] [Builtins] Add golden tests with unlifting errors (#6189) This refactors a file with tests so that unit tests that are supposed to result in evaluation failure also become golden tests with the error message printed to a golden file. Need it to demonstrate that #6181 does indeed allow us to preserve operational unlifting errors. * Changed the term "Documentation" to "User guide" in the upper left area of the docs site (#6200) * Styling updates to docusaurus site * Changed the term Documentation to User guide in the upper left corner of the docs site next to the PLUTUS wordmark logo. * Add .yarn to .gitignore --------- Co-authored-by: ianhanssoniohk <ian.hansson@iohk.io> * Update Alert Message in longitudinal-benchmark.yml (#6201) * [Test] Add missing bitwise builtins golden files (#6204) * [Errors] Preserve operational unlifting errors (#6181) * Docs raise visibility code libraries (#6203) * added more visibility to Haddock Plutus code libraries on index.md page * adding new Haddock documentation page under the Reference nav menu * updated Reference top-level page description * minor style edit update docusaurus/docs/index.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * style edits update docusaurus/docs/reference/haddock-documentation.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> --------- Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * [Test] [Builtin] Polish 'MakeRead' tests (#6202) * Remove AssocMap comparison instances (#6173) Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> * Update README.adoc (#6206) Updated the link in README to point to the Plutus docs site on the docusaurus platform instead of Read the docs. * Remove PyF as it depends on GHC and causes depenecy conflicts downstream. (#6208) * Bitwise operations (#6090) * Initial bitwise primitives * Wire up new builtins * Tests * Changelogs * Fix failing goldens * Fix cost model for tests * Bitwise primitives are not in Conway * Finish shift tests * Fix goldens * Rest of tests * Rename operations * Note about split composition for shift property * Explain bitwise tests in comments, remove AND and OR tests for finding and counting bits * Goldens for bitwise primops * Chop down property test running times a bit * Add test for finding first in zero byte string, rename some tests for clarity * Clarify implementation choices in the comments * Tidy up helpers for property tests * Consolidate all bitwise ops, retarget links to CIPs * Reduce coverage limits for signature verification tests (#6209) * moved the Getting Started page to immediately follow the Introduction page (#6211) * Haskell Eq for AssocMap (#6213) Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> * Shorten some filenames in the conformance tests (#6214) Shorten some file names * MK-5422 move getting started page fixing link (#6215) * moved the Getting Started page to immediately follow the Introduction page * fixed broken link * [Evaluation] Move stuff under `enterComputeCek` (#6156) This polishes the structure of the CEK machine code a little: moves definitions having CEK-specific constraints around (as per `Note [Compilation peculiarities]`), removes outdated comments and moves pragmas around. * Release 1.30.0.0 (#6216) * plutus-ir: fix redundant imports (#6218) * Fix incorrect Note reference (#6217) * Add documentation to `Data.Value` (#6220) * [Builtins] Replace 'EvaluationResult' with 'BuiltinResult' (#5926) This replaces several `Emitter (EvaluationResult a)` occurrences with `BuiltinResult`, something that I missed the last [time](#5728). In addition to that, it also replaces `EvaluationResult` with `BuiltinResult` in general. It doesn't matter performance-wise (modulo a regression that we didn't notice some time ago), but `BuiltinResult`, unlike `EvaluationResult`, allows one to attach an error message to a failure, which we do in this PR as well, meaning we now get better error messages. And we also now respect the operational vs structural evaluation errors distinction. The PR also replaces `Emitter` with `BuiltinResult`. And makes the GHC Core of builtins smaller by making error-throwing functions (not) inline (see `Note [INLINE and OPAQUE on error-related definitions]` for details). * New `./scripts/combined-haddock.sh` (#6205) * Add workflow for publishing Agda Metatheory site (#6223) * Add workflow for publishing AGDA metatheory site * wip * wip * Fixes to `metatheory-site.yml` workflow (#6228) * Final changes to `metatheory-site.yml` workflow (#6229) * Update RELEASE.adoc with instructions to delete unused branches and tags (#6230) * Complete Migration from RDT to Docusaurus (#6227) - Delete the contents of doc/read-the-docs-site, only keeping the README with a migration notice. - Move docusaurus folder into doc folder. - Update the GH workflows for publishing the haddock site and docusaurus site. - Delete GH web hook and update redirects on RTD site. - Remove mentions of read-the-docs and combined-haddock from nix code - Update release process, mentioning how to publish Docusaurus and the Haddock site - Update links in Docusaurus mentioning the new haddock site * Fix broken links in docusaurus docs (#6232) * Add flake.nix for doc/docusaurus (#6233) * New shell for Docusaurus * Fix broken links * making a spelling correction on the doc/docusaurus README file (#6235) * [Builtins] Remove 'Emitter' and 'MonadEmitter' (#6224) * Refactor GitHub Workflows (#6124) * Fix & simplify SOP encoding example comment (#6231) Here's a small fix for the comment: - use one variable for the type everywhere - fix ordering of `constr` arguments Additionally, - align the corresponding parts in the text * Update github-action-benchmark version (#6238) * Make it build with ghc 9.10 (#6079) * Make it build with ghc 9.10 * Nix updates * Disable failing test (cseExpensive test in untyped-plutus-core-test suite) * plutus-tx-plugin-tests: Accept some CSE golden changes * Update version of github-action-benchmark to v1.20.3 (#6240) * Update version of github-action-benchmark to v1.20.3 * Fix bug in triage-label.yml * Add workflows to check broken links and deploy papers to GH Pages (#6236) * Add workflows to check broken links and deploy papers to GH Pages * Publish papers and specs on push to master only (#6246) * Cabal project to compile docusaurus examples. (#6239) * Added cardano-constitution package (#6234) * Added cardano-constitution package * Remove cardano-constitution checks from CI * Restrist x-compiling --------- Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> Co-authored-by: zeme <lorenzo.calegari@iohk.io> * [Test] Turn off CSE for problematic tests (#6249) * [Test] Turn off CSE for the 'patternMatching' test (#6251) * [Optimization] Remove case-of-case (#6248) * Spec that verifies various script sizes (#6247) * Add cardano-constitution-tests and slack-message-broker workflows (#6253) * Updates to slack-message-broker.yml (#6258) * Update slackapi/slack-github-action version -> v1.26.0 (#6259) * Improve messages in slack-message-broker.yml (#6260) * Fix error message in slack-message-broker.yml (#6261) * Fix another error in slack-message-broker.yml (#6262) * Fix "un-rolling" a list type. (#6165) * Fix "un-rolling" a list type. * Un-roll other general types: [], Maybe, (,), BuiltinUnit, BuiltinPair * constitution: Add executable that creates json envelope (#6267) Co-authored-by: Jamie Bertram <jamie.bertram@tweag.io> * Fix bug in ./script/combined-haddock.sh (#6263) * Update baseUrl in docusaurus.config.ts (#6275) * Improvements to haddock-site.yml (support auto-publish on push to master) (#6276) * Better messages in slack-message-broker.yml (#6280) * Remove --ignore-url's from linkchecker step in combined-haddock.sh (#6281) * Add cabal update step in combined-haddock.sh (#6283) * Fix CsvTable.tsx and LiteralInclde.tsx in docusaurus (#6282) * Fix haddock documentation for cardano-constitution (#6284) * Stronger docusaurus builds and general QOL improvements (#6287) * Move package-lock.json from top-level to scripts/blueprints (#6289) * Fix editUrl in docusaurus.config.ts (#6291) * chore(deps): bump JamesIves/github-pages-deploy-action (#6292) Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.6.1 to 4.6.3. - [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases) - [Commits](JamesIves/github-pages-deploy-action@v4.6.1...v4.6.3) --- updated-dependencies: - dependency-name: JamesIves/github-pages-deploy-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix typos (#6288) * fix typo * fix typos * fix typo * fix typo * Detect broken links for haddock,metatheory,docusaurus + local repo files (#6294) * Fix broken linkchecker workflows (#6295) * Add .github/linkchecker/action.yml * Add support for ghc910 to hydraJobs (#6293) * Disable linkchecker on live sites (#6298) * [Bug] Fix 'isNormalType' and add 'prop_normalizedTypeIsNormal' (#6272) * Analyse script events supports PlutusLedgerLanguage V3 (#6300) * fix: parameter 33 should be a Rational (#6302) * Address guardrail script audit comments (#6305) * All names are printed with their unique values by default. (#5972) * chore: explicit imports * Test demonstrates that without printed unique value a name won't roundtrip printing/parsing * Pretty-printing with indexes by default, simple representation by opt-in. * Updated golden files * fix: types in defaultConstitution (#6307) More descriptive type names in the defaultConstitution Co-authored-by: Nikolaos Bezirgiannis <329939+bezirg@users.noreply.github.com> * Fix overflow bug in shiftByteString, rotateByteString, add tests to ensure it stays fixed (#6309) * Fix overflow bug in shiftByteString, add tests to ensure it stays fixed * Fix similar issue in rotations * Add shift wrapper for bounds checks * Fix rotations similarly, note in docs * Fix typo, note about fromIntegral * Release 1.31.0.0 (#6312) * Re-export bitwise builtins from PlutusTx.Prelude (#6313) * [Costing] Increase the cost of constructors of '[]' (#6285) * Change writeBits to take changelists as two separate lists (#6317) * fix: types in defaultConstitution (#6307) More descriptive type names in the defaultConstitution Co-authored-by: Nikolaos Bezirgiannis <329939+bezirg@users.noreply.github.com> * Fix overflow bug in shiftByteString, rotateByteString, add tests to ensure it stays fixed (#6309) * Fix overflow bug in shiftByteString, add tests to ensure it stays fixed * Fix similar issue in rotations * Add shift wrapper for bounds checks * Fix rotations similarly, note in docs * Fix typo, note about fromIntegral * Release 1.31.0.0 (#6312) * Modify writeBits to use two lists as arguments * Fix writeBits in PlutusTx to match new API * Fix goldens --------- Co-authored-by: Romain Soulat <117812549+RSoulatIOHK@users.noreply.github.com> Co-authored-by: Nikolaos Bezirgiannis <329939+bezirg@users.noreply.github.com> Co-authored-by: Yura Lazarev <1009751+Unisay@users.noreply.github.com> * [Costing] Remove the 'ExMemoryUsage' instance for 'SomeTypeIn' (#6318) * feat: New version of VT-CC-01 (#6320) Signed Changed the defaultConstitution.json (+ random fixes in some $comment) Changed the tests values Changed the traceability documents and updated the versioning New golden test values "All 654 tests passed (99.02s)" * [Test] Make tests take reasonable time (#6286) This dramatically reduces the number of tests run locally making evaluation times of plutus-test drop by more than 10x. The reduced number of tests run locally is balanced by running the old amount of tests in the nightly test suite. * fix: haddock error (#6323) * Reverse hunk test_multiSplitSound (#6324) Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> * Kwxm/costing/bitwise 4 (#6301) * Costing for new bitwise builtins * Fix alignment problem * Add changelog entry * Update some CIP URLs * Update some CIP URLs * Remove outdated comment * Address some review comments * Address some review comments * Fix for changes in main branch * Update costing for revised version of writeBits * Fix benchmark tests for integer division builtins * Fix comments * Update benchmark results for writeBits split updates * Try removing zip in writeBits * Remove wrapper * Rearrange code again * Tidying up * Fix plutus-tx * Make some helpers INLINEABLE * Rearrange code again * Simplify known type instances for 'ListCostedByLength' --------- Co-authored-by: effectfully <effectfully@gmail.com> * 8-queens using bitwise primops benchmark (#6311) * Milestone 3 benchmark, test * Fix cabal file * Update writeBits use in NQueens * [Plinth] [Builtins] Fix 'writeBits' (#6329) * [Plinth] Ban using 'toBuiltin' and 'fromBuiltin' (#6342) It used to be possible to use `toBuiltin`/`fromBuiltin` within a smart contract, but this is no longer the case, but this isn't obvious to the users as they already have code with `toBuiltin`/`fromBuiltin` that now just misbehaves instead of throwing a type error or breaking compilation some other way. This fixes the problem by throwing on any usage of `toBuiltin`/`fromBuiltin` with a suggestion to use `toOpaque`/`fromOpaque` instead. * Kwxm/bitwise/enable nqueens benchmark (#6343) This enables the bitwise `nqueens` benchmark following the fix for `writeBits` in Plinth in #6309. ``` $ cabal bench bitwise-bench Build profile: -w ghc-9.6.6 -O1 In order, the following will be built (use -v for more details): - plutus-benchmark-0.1.0.0 (bench:bitwise-bench) (first run) Preprocessing benchmark 'bitwise-bench' for plutus-benchmark-0.1.0.0... Building benchmark 'bitwise-bench' for plutus-benchmark-0.1.0.0... Running 1 benchmarks... Benchmark bitwise-bench: RUNNING... benchmarking 8-queens time 683.4 ms (681.5 ms .. 685.0 ms) 1.000 R² (1.000 R² .. 1.000 R²) mean 678.6 ms (674.1 ms .. 680.4 ms) std dev 3.211 ms (92.63 μs .. 3.978 ms) variance introduced by outliers: 19% (moderately inflated) Benchmark bitwise-bench: FINISH ``` * [plc] Support for `Natural` numbers in the default universe, backed by `Integer`. (#6346) Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> * nothunks ^>= 0.2 (#6349) * Make NumBytesCostedAsNumWords use Integer instead of Int (#6350) The `NumBytesCostedAsNumWords` wrapper contained an `Int`, but this changes it to `Integer` for consistency with the other wrappers. This change also affects the type of `Bitwise.replicateByte`. * [Benchmark] Reduce the number of benchmarks (#6328) * [Test] Improve distribution of generated integers (#6315) This improves distribution of generated integers, so that we more often hit important edge cases such as `2 ^ 16`, `2 ^ 32 - 1`, `2 ^ 32`, `2 ^ 64` etc. * [Plinth] [Builtins] Add a general 'mkNil' (#6347) This replaces the `mkNilInteger`, `mkNilData` etc boilerplate with a single `mkNil` function at the expense of moving the boilerplate to the compiler code. * [Refactoring] Use 'KnownBuiltinTypeIn' instead of 'HasConstant' consistently (#6353) * Restore auto generation of compiler option table (#6373) * Add the bitwise builtins to the metatheory (#6368) * Initial metatheory for rest of bitwise builtins * Separate lists of expected failures for evaluation tests and budget tests * Remove temporary test data * Fix memory usage for lists in Agda * Forgot about haskell-steppable-conformance * Remove suprious s * Restore CI checks for doc site code (#6376) * andByteString conformance cases (#6356) * andByteString conformance cases * Move each case to its own directory * Update goldens for merge * Conformance cases for complementByteString (#6359) * Conformance for orByteString (#6357) * Conformance cases for readBit (#6360) * Conformance for shiftByteString (#6363) * Conformance for findFirstSetBit (#6366) * Conformance for xorByteString (#6358) * Conformance for countSetBits (#6365) --------- Signed-off-by: Ana Pantilie <ana.pantilie95@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Yura Lazarev <Unisay@users.noreply.github.com> Co-authored-by: Ana Pantilie <45069775+ana-pantilie@users.noreply.github.com> Co-authored-by: Nikolaos Bezirgiannis <329939+bezirg@users.noreply.github.com> Co-authored-by: Nikolaos Bezirgiannis <bezirg@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Kenneth MacKenzie <kwxm@inf.ed.ac.uk> Co-authored-by: Ziyang Liu <unsafeFixIO@gmail.com> Co-authored-by: effectfully <effectfully@gmail.com> Co-authored-by: Yura Lazarev <1009751+Unisay@users.noreply.github.com> Co-authored-by: zeme-wana <15709674+zeme-wana@users.noreply.github.com> Co-authored-by: Yura Lazaryev <Yuriy.Lazaryev@iohk.io> Co-authored-by: Joseph Fajen <104791413+joseph-fajen@users.noreply.github.com> Co-authored-by: ianhanssoniohk <ian.hansson@iohk.io> Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> Co-authored-by: Koz Ross <koz.ross@retro-freedom.nz> Co-authored-by: Samuel Leathers <samuel.leathers@iohk.io> Co-authored-by: Vladimir Kalnitsky <klntsky@gmail.com> Co-authored-by: Erik de Castro Lopo <erikd@mega-nerd.com> Co-authored-by: zeme <lorenzo.calegari@iohk.io> Co-authored-by: Jamie Bertram <jamie.bertram@tweag.io> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com> Co-authored-by: Romain Soulat <117812549+RSoulatIOHK@users.noreply.github.com>
effectfully
added a commit
that referenced
this pull request
Aug 6, 2024
This - adds support for throwing operational unlifting errors in the builtins machinery, which allows us to attach a message to an unlifting failure. Unfortunately this is still not enough to propagate proper error messages to the user, because they get erased by the evaluation machinery down the line, this is our 2018's legacy of the stupid idea to have raw evaluation failures that don't carry any content - makes handling of integral types in `PlutusCore.Default.Universe` uniform (it was a mess before with a weird partial set of instances and morally the same instances being implemented differently)
v0d1ch
pushed a commit
to v0d1ch/plutus
that referenced
this pull request
Dec 6, 2024
This - adds support for throwing operational unlifting errors in the builtins machinery, which allows us to attach a message to an unlifting failure. Unfortunately this is still not enough to propagate proper error messages to the user, because they get erased by the evaluation machinery down the line, this is our 2018's legacy of the stupid idea to have raw evaluation failures that don't carry any content - makes handling of integral types in `PlutusCore.Default.Universe` uniform (it was a mess before with a weird partial set of instances and morally the same instances being implemented differently)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This
PlutusCore.Default.Universeuniform (it was a mess before with a weird partial set of instances and morally the same instances being implemented differently)