You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/plutarch.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ For a full example see [Example](#example).
41
41
42
42
## LambdaBuffers modules
43
43
44
-
Writing .lbf schemas with API types intended for Plutarch backend will typically use the following LambdaBuffers modules:
44
+
Writing .lbf schemas with API types intended for Plutarch backend will typically use the following LambdaBuffers schema modules:
45
45
46
46
1.[Prelude](../libs/lbf-prelude/Prelude.lbf),
47
47
2.[Plutus.V1](../libs/lbf-plutus/Plutus/V1.lbf),
@@ -54,10 +54,10 @@ Take a look at [Example.lbf](./plutarch/api/Example.lbf) schema as an example.
54
54
The necessary LambdaBuffers runtime libraries a typical Plutarch project needs when working with LambdaBuffers:
55
55
56
56
1.[lbr-plutarch](../runtimes/haskell/lbr-plutarch) a Haskell runtime library necessary for working with `lbf-xyz` libraries.
57
-
2.[lbf-prelude-plutarch](../libs/lbf-prelude) that contains the [LambdaBuffers Prelude](../libs/lbf-prelude)package generated by LambdaBuffers.
58
-
3.[lbf-plutus-plutarch](../libs/lbf-plutus) that contains the [LambdaBuffers Plutus](../libs/lbf-plutus)package generated by LambdaBuffers.
57
+
2.[lbf-prelude-plutarch](../libs/lbf-prelude) that contains the [LambdaBuffers Prelude](../libs/lbf-prelude)schema library generated by LambdaBuffers.
58
+
3.[lbf-plutus-plutarch](../libs/lbf-plutus) that contains the [LambdaBuffers Plutus](../libs/lbf-plutus)schema library generated by LambdaBuffers.
59
59
60
-
Of course, additionally imports for Plutarch libraries is also necessary [plutarch](https://github.com/Plutonomicon/plutarch-plutus) and optionally [plutarch-extra](https://github.com/Plutonomicon/plutarch-plutus/plutarch-extra).
60
+
Of course, additional imports for Plutarch libraries are also necessary [plutarch](https://github.com/Plutonomicon/plutarch-plutus) and optionally [plutarch-extra](https://github.com/Plutonomicon/plutarch-plutus/plutarch-extra).
The set of imports a Haskell module using LambdaBuffers modules would typically need is the following:
89
+
The set of imports a Plutarch program using LambdaBuffers would typically need is the following:
90
90
91
91
```haskell
92
92
importLambdaBuffers.Plutus.V1.Plutarch ()
@@ -153,9 +153,9 @@ The Plutarch backend doesn't support the use of `Char`, `Text`, `Bytes` (there's
153
153
154
154
### Type definition mapping
155
155
156
-
Plutarch backend supports all types from the LambdaBuffers Plutus module, as to enable full featured Plutus script development.
156
+
Plutarch backend supports all types from the [LambdaBuffers Plutus](../libs/lbf-plutus) schema library, as to enable full featured Plutus script development.
157
157
158
-
Additionally, it also supports some types from the LambdaBuffers Prelude module, namely `Bool`, `Integer`, `Maybe`, `Either` and `List`.
158
+
Additionally, it also supports some types from the [LambdaBuffers Prelude](../libs/lbf-prelude) schema library, namely `Bool`, `Integer`, `Maybe`, `Either` and `List`.
159
159
160
160
```lbf
161
161
module Foo
@@ -310,7 +310,7 @@ infix 4 #==
310
310
311
311
> We don't generate an implementation from the LambdaBuffers 'equality spec', rather we delegate the equality check to the underlying 'PData' representations that all generated types have for performance.
312
312
313
-
### PShow
313
+
####PShow
314
314
315
315
All generated types have a PShow instance derived using the internal Plutarch deriving mechanism.
316
316
@@ -322,7 +322,7 @@ Let work through the [Plutarch example](./plutarch) available in the repo.
322
322
323
323
First, please check the [Getting started](getting-started.md) guide on how to prepare to work with the repo and setup Nix.
0 commit comments