Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document LambdaBuffers packages (Prelude and Plutus) #112

Open
bladyjoker opened this issue Oct 10, 2023 · 0 comments
Open

Document LambdaBuffers packages (Prelude and Plutus) #112

bladyjoker opened this issue Oct 10, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@bladyjoker
Copy link
Contributor

bladyjoker commented Oct 10, 2023

When implementing runtimes for LB packages (Prelude, Plutus), we need to have a 'language neutral' specification of:

  1. Which opaques types are listed and what do they map to in different languages.
  2. How opaque types support a type class
    • Json encodings
    • PlutusData encodings
    • Equality
  3. How transparent types support a type class via derivation
    • Given a sum/record/prod type how does a Json/PlutusData encoding look like? How is equality performed?

Let's add necessary documentation for this.

I sense that documentation should be associated with an LB package. So it's basically a documentation for the LB package.

  • docs/lb-prelude.md
  • docs/lb-plutus.md
@bladyjoker bladyjoker added the documentation Improvements or additions to documentation label Oct 10, 2023
@bladyjoker bladyjoker changed the title Document type classes (Json, PlutusData, Eq) Document LambdaBuffers packages (Json, PlutusData, Eq) Oct 10, 2023
@bladyjoker bladyjoker changed the title Document LambdaBuffers packages (Json, PlutusData, Eq) Document LambdaBuffers packages (Prelude and Plutus) Oct 10, 2023
@szg251 szg251 moved this from Todo to Blocked in Lambda Buffers Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Blocked
Development

No branches or pull requests

1 participant