Skip to content

Commit 5e46d91

Browse files
committed
Document the trust model and panics in the codebase.
Signed-off-by: Piotr Sikora <[email protected]>
1 parent 6d88ed5 commit 5e46d91

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

DEVELOPMENT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Development
22

3+
## Proxy-Wasm ABI compliance & trust model
4+
5+
It is expected that the host environment is completely trusted and compliant
6+
with the [Proxy-Wasm ABI specification] (currently v0.2.1).
7+
8+
This means that receiving unexpected callback, status, lifecycle flow and/or
9+
incorrectly serialized parameters is considered a permanent failure and will
10+
result in a `panic`.
11+
312
## Testing
413

514
GitHub Actions can be executed locally using the [`act`] tool.
@@ -28,5 +37,6 @@ bazelisk run //bazel/cargo:crates_vendor -- --repin all
2837
```
2938

3039

40+
[Proxy-Wasm ABI specification]: https://github.com/proxy-wasm/spec
3141
[`act`]: https://github.com/nektos/act
3242
[`bazelisk`]: https://github.com/bazelbuild/bazelisk

0 commit comments

Comments
 (0)