hyperlight-dev / hyperlight-dev/hyperlight

Redesign public hyperlight API

Open
#1,560 2 comments 0 reactions 1 assignee Claimed by @jprendes View on GitHub
lifecycle/confirmed
Dominant language
Rust
Stars
4.7k
Forks
208
Avg merge
1d 7h
Merged PRs (30d)
47

Description

This issue is meant to cover redesigning the public hyperlight API for a 1.0 release. It's separate from https://github.com/hyperlight-dev/hyperlight/issues/765, because this one is referring to redesigning the existing API, while #765 is concerned about removing public items that should not be public.

Some things I can think of right now:
- Remove Uninitiated sandbox and `evolve`
- Combine and/or `SandboxConfiguration` and `SandboxRuntimeConfig`
- Add builder-pattern where makes sense
- Rename `MultiUseSandbox` (name is outdated)
- Possibly add some light-weight type-safety to MultiUseSandbox to prevent host functions from being added (see https://github.com/hyperlight-dev/hyperlight/pull/1392)
- Narrow method-specific errors and error variants, rather than a catch-all HyperlightError

Please add more!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.