Skip to content
nokto/docsGitHub (opens in a new tab)

Building from source

The only way to run Nokto today — the @nokto-protocol/* packages are not published to npm, and each carries "private": true to stop an accidental npm publish. Every install instruction on this site means clone and build, never install.

pnpm install
./contracts/build.sh          # add --zk for proving keys; it is slow
pnpm -r test

./contracts/build.sh skips ZK proving-key generation by default; pass --zk to generate them.

This requires the Compact toolchain. The current release record records which toolchain versions this codebase was measured against, and what was found — recalled knowledge about Compact and the Midnight SDKs drifts between versions, so that record, not memory, is the source of truth for what actually compiles and runs here.

What passes today

Phase 1a is built and tested at the simulator level: the protocol composes, and the privacy properties hold at the state level — 229 tests, including the forgery each invariant exists to prevent.

It has not been run against a devnet. Deployment is blocked upstream: the released client stack requires compact-runtime 0.16.0, this contract is compiled against 0.19.0, and the older compiler that emits 0.16.0 has no in-circuit Schnorr — which is the trust anchor of the design.

So: the protocol logic is exercised and the privacy properties are asserted, but proof generation and transaction submission are not yet demonstrated. Both matter, and only one of them is done today.

Packages this builds

PackageFor
@nokto-protocol/schemaTypes, constants, and conformance vectors. Zero runtime dependencies.
@nokto-protocol/sdkprepare → prove → submit, and @nokto-protocol/sdk/verify on its own.
@nokto-protocol/plugin-kitBuild a verifier or an issuer adapter — see Guides.

Contributions are welcome — the repository's CONTRIBUTING.md has the setup and what a good pull request looks like. Changes to the consensus surface — the signed message layout, the predicate registry, tier and binding-scheme semantics, the invariants, the ledger layout, the conformance vectors — start with an issue before any code is written, described in CONTRIBUTING.md.