Rework the "Using Plutus Tx" section of the user guide #6516
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
zliu41
requested review from
bezirg,
Unisay,
kwxm,
ramsay-t,
effectfully,
zeme-wana,
ana-pantilie and
a team
zliu41
had a problem deploying
to
github-pages
GitHub Actions
Failure
zliu41
force-pushed
the
zliu41/using-plinth
branch
from
e267e84
to
f93e076
Compare
|
/benchmark validation |
|
(sorry for hijacking) |
|
Click here to check the status of your benchmark. |
|
Comparing benchmark results of 'validation' on '24e3cfc0f' (base) and 'f93e076ef' (PR) Results table
|
bezirg
reviewed
Sep 25, 2024
| In general, we do not want GHC to perform optimizations, since GHC optimizes a program based on the assumption that it has non-strict semantics and is evaluated lazily (call by need), which is not true for Plutus Tx programs. | ||
| Therefore, `INLINEABLE` is preferred over `-fexpose-all-unfoldings`, even though the latter is simpler. | ||
| myPlutusTxCodeCompiled :: CompiledCode (Integer -> Integer) | ||
| myPlutusTxCodeCompiled = plc (Proxy @"location info") myPlutusTxCode |
There was a problem hiding this comment.
maybe mention that "location info" is for debugging purposes and not very important
bezirg
reviewed
Sep 25, 2024
|
|
||
| > ghc-options: | ||
| > | ||
| > : -fno-ignore-interface-pragmas |
There was a problem hiding this comment.
i think typo here with a leading :
bezirg
reviewed
Sep 25, 2024
|
|
||
| In [`PlutusTx.Builtins.Internal`](https://plutus.cardano.intersectmbo.org/haddock/latest/plutus-tx/PlutusTx-Builtins-Internal.html), functions marked `OPAQUE` are directly converted to the corresponding builtin function. | ||
| For instance, `PlutusTx.Builtins.Internal.addInteger` is converted to UPLC term `(builtin addInteger)`. | ||
| Using the `OPAQUE` pramga prevents GHC from inlining these functions, allowing the Plutus Tx compiler to determine where exactly they are invoked, and compile them appropriately. |
bezirg
reviewed
Sep 25, 2024
|
|
||
| ## `IsString` Instances | ||
|
|
||
| [`IsString`](https://hackage.haskell.org/package/base/docs/Data-String.html#t:IsString) is a type class from `base`, and can be used along with the `OverloadedString` language extension to convert string literals to types other than `String`. |
bezirg
approved these changes
Sep 25, 2024
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.
The section now looks like this:
asData": unmodified