mirror of
https://github.com/tlsnotary/tlsn.git
synced 2026-05-14 03:00:10 -04:00
* chore(examples): extract basic_zk into standalone crate outside workspace Move `crates/examples/basic_zk/` to `crates/examples-zk/` as its own package excluded from the root workspace. Cargo would otherwise clone the ~1 GB `noir-lang/noir` monorepo (pulled transitively by `noir-rs`) during every workspace resolution, even when the ZK example is not built. Tested: `cargo metadata` at the workspace root now references zero noir-related packages, while `cargo run --release` from `crates/examples-zk/` builds and runs the demo as before. * ci: build basic_zk example in build-and-test job After the previous commit moved the ZK example out of the workspace, `cargo build --all-targets` no longer touches it. Add an explicit release build step inside `crates/examples-zk` so the example continues to be verified on every CI run. * chore(examples): trim README blurb and fix clippy needless-borrow lints
Examples
This folder contains examples demonstrating how to use the TLSNotary protocol.
- Basic: Basic Prover and Verifier session.
- Attestation: Issuing an attestation where a Verifier acts as a Notary.
- Basic_zk: Basic Prover and Verifier session demonstrating zero-knowledge age verification using Noir.
Refer to https://tlsnotary.org/docs/quick_start for a quick start guide to using TLSNotary with these examples.