Skip to content

Commit

Permalink
chore: doc interpreter (#607)
Browse files Browse the repository at this point in the history
# Description

This PR contains a spec/document for the WIT<->IPLD interpreter, which
converts WIT runtime values to IPLD data model values based on WIT
types. Consider this a living document on the state of the interpreter.

Includes: 

- added testing 
- function name handling of varying cases

---------

Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]>
  • Loading branch information
Zeeshan Lakhani and bgins authored Mar 8, 2024
1 parent 90c6246 commit b44d0d5
Show file tree
Hide file tree
Showing 6 changed files with 1,237 additions and 36 deletions.
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,12 @@ represents the `Homestar` runtime. We recommend diving into each package's own
- [homestar-wasm](./homestar-wasm)

This *wasm* library manages the [wasmtime][wasmtime] runtime, provides the
[Ipld][ipld] to/from [Wit][wit] interpreter/translation-layer, and implements
[IPLD][ipld] to/from [WIT][wit] interpreter/translation-layer, and implements
the input interface for working with Ipvm's standard Wasm tasks.

You can find the spec for translating between IPLD and WIT runtime values
based on WIT types [here](./homestar-wasm/README.md##interpreting-between-ipld-and-wit).

- [homestar-workflow](./homestar-workflow)

The *workflow* library implements workflow-centric [Ipvm features][ipvm-spec]
Expand Down
1 change: 1 addition & 0 deletions homestar-wasm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ wit-component = "0.200"

[dev-dependencies]
criterion = "0.5"
serde_json = { workspace = true }
tokio = { workspace = true }

[features]
Expand Down
Loading

0 comments on commit b44d0d5

Please sign in to comment.