From fb227285d07e4edd5132f02ce53afbc88eadbcc9 Mon Sep 17 00:00:00 2001 From: 0xisk <0xisk@proton.me> Date: Fri, 28 Aug 2026 11:09:06 +0200 Subject: [PATCH] docs: warn that these tools are unaudited internal tooling The packages are published to npm, so readers arriving from a registry listing have no signal about their maturity. State the intended audience and the lack of an audit up front, next to the install instructions. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0f9060e..7f7c769 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,15 @@ This project extends the Midnight Network with additional developer tooling. # OpenZeppelin Compact Tools +> [!WARNING] +> **Internal tooling. Not audited.** +> +> These packages are built and maintained for the OpenZeppelin team's own +> Midnight development. They have not been audited, may contain bugs, and +> their APIs can change between releases without notice. Use them at your own +> risk. See [SECURITY.md](./SECURITY.md) for the full disclaimer and for how +> to report a vulnerability. + Tools for compiling, building, and testing Compact smart contracts. This is a monorepo containing: - [`packages/builder`](./packages/builder) — programmatic library that drives the Compact compiler + builder