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

Create new structured format for Playground bundle #73

Open
hrajchert opened this issue Jun 14, 2022 · 2 comments
Open

Create new structured format for Playground bundle #73

hrajchert opened this issue Jun 14, 2022 · 2 comments
Assignees

Comments

@hrajchert
Copy link
Collaborator

hrajchert commented Jun 14, 2022

We should improve the structure of the Exented bundle to include the following:

  • A version of the bundle to allow backward compatibility
  • The JSON representation of the Extended contract
  • The Metadata
  • Maybe the Source code if it's pure Marlowe (we can avoid it and pretty print it from the JSON)
  • The Source code and an optional Source Map (targeting the pretty print or the JSON?) if it is generated from Haskell/JavaScript

We should also remove the empty playground.marlowe.json file which is currently used only to distinguish Marlowe gists from other gists and provide a tar file instead.

@hrajchert hrajchert changed the title Create new structured format for Marlowe Extended bundle Create new structured format for Playground bundle Jun 20, 2022
@hrajchert
Copy link
Collaborator Author

hrajchert commented Jun 20, 2022

After talks with @paluh for this issue, the initial implementation will:

  • Not contain source map between Sources to Target
  • Will merge the playground.marlowe.json with the metadata
  • Will add Bundle version, Core/Extended version and Haskell version/TypeScript version when applicable

We still need to define if we include the JSON representation of the Extended Marlowe or if we leave that for the Executable bundle that will be used together with marlowe-cli and should be a different issue. My thinking is that if we agree on separate a playground bundle from executable bundle, then there is no need for us to have the JSON representation here, and only the textual representation if the source is plain Blockly/Marlowe.

@paluh
Copy link
Collaborator

paluh commented Jun 21, 2022

Thanks for writing that down @hrajchert. I think that I'm going to stick to the source only bundle for this case.

@nhenin nhenin transferred this issue from input-output-hk/marlowe-cardano Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants