Add ZK documentation: nullifiers, compressed accounts, and Groth16 guides #10
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,3 +6,5 @@ mintlify-docs/ | |
|
|
||
| # Dependencies | ||
| node_modules/ | ||
|
|
||
| stash | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Contributor
There was a problem hiding this comment. do we still need this file? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Script to copy zk-merkle-proof code from program-examples to docs/snippets | ||
| # Wraps each file in appropriate markdown code blocks | ||
|
|
||
| PROGRAM_EXAMPLES="/home/tilo/Workspace/program-examples/zk/zk-merkle-proof" | ||
| SNIPPETS_DIR="/home/tilo/Workspace/docs/snippets/code-snippets/zk/merkle-proof" | ||
ananas-block marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| mkdir -p "$SNIPPETS_DIR" | ||
|
Comment on lines
+6
to
+9
There was a problem hiding this comment. Hard-coded absolute paths make this script effectively non-portable. Use repo-relative paths (based on the script’s directory) and/or accept Proposed fix-#!/bin/bash
+#!/usr/bin/env bash
+set -euo pipefail
-PROGRAM_EXAMPLES="/home/tilo/Workspace/program-examples/zk/zk-merkle-proof"
-SNIPPETS_DIR="/home/tilo/Workspace/docs/snippets/code-snippets/zk/merkle-proof"
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd -- "${SCRIPT_DIR}/.." && pwd)"
+
+# Allow overrides: ./copy-zk-merkle-proof.sh [program_examples_dir] [snippets_dir]
+PROGRAM_EXAMPLES="${1:-${PROGRAM_EXAMPLES:-${REPO_ROOT}/program-examples/zk/zk-merkle-proof}}"
+SNIPPETS_DIR="${2:-${SNIPPETS_DIR:-${REPO_ROOT}/snippets/code-snippets/zk/merkle-proof}}"
mkdir -p "$SNIPPETS_DIR"🤖 Prompt for AI Agents |
||
|
|
||
| wrap_code() { | ||
| local input_file="$1" | ||
| local output_file="$2" | ||
| local lang="$3" | ||
| echo "\`\`\`$lang" > "$output_file" | ||
| cat "$input_file" >> "$output_file" | ||
| echo '```' >> "$output_file" | ||
| echo "Created: $output_file" | ||
| } | ||
|
Comment on lines
+11
to
+19
There was a problem hiding this comment. Prefer Proposed fix wrap_code() {
local input_file="$1"
local output_file="$2"
local lang="$3"
- echo "\`\`\`$lang" > "$output_file"
- cat "$input_file" >> "$output_file"
- echo '```' >> "$output_file"
+ printf '```%s\n' "$lang" > "$output_file"
+ cat -- "$input_file" >> "$output_file"
+ printf '```\n' >> "$output_file"
echo "Created: $output_file"
}
# Circuit
if [ -f "$PROGRAM_EXAMPLES/circuits/merkle_proof.circom" ]; then
wrap_code "$PROGRAM_EXAMPLES/circuits/merkle_proof.circom" "$SNIPPETS_DIR/circuit.mdx" "circom expandable"
+else
+ echo "WARN: Missing $PROGRAM_EXAMPLES/circuits/merkle_proof.circom" >&2
fiAlso applies to: 22-34, 36-38 🤖 Prompt for AI Agents |
||
|
|
||
| # Circuit | ||
| if [ -f "$PROGRAM_EXAMPLES/circuits/merkle_proof.circom" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/circuits/merkle_proof.circom" "$SNIPPETS_DIR/circuit.mdx" "javascript expandable" | ||
| fi | ||
|
|
||
| # Program | ||
| if [ -f "$PROGRAM_EXAMPLES/src/lib.rs" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/src/lib.rs" "$SNIPPETS_DIR/program.mdx" "rust expandable" | ||
| fi | ||
|
|
||
| # Rust client | ||
| if [ -f "$PROGRAM_EXAMPLES/tests/test.rs" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/tests/test.rs" "$SNIPPETS_DIR/rust-client.mdx" "rust expandable" | ||
| fi | ||
|
|
||
| # TypeScript client | ||
| if [ -f "$PROGRAM_EXAMPLES/ts-tests/merkle-proof.test.ts" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/ts-tests/merkle-proof.test.ts" "$SNIPPETS_DIR/typescript-client.mdx" "typescript expandable" | ||
| fi | ||
|
|
||
| echo "" | ||
| echo "Done! Created snippets in: $SNIPPETS_DIR" | ||
| find "$SNIPPETS_DIR" -name "*.mdx" -type f | sort | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Script to copy zk-nullifier code from program-examples to docs/snippets | ||
|
|
||
| PROGRAM_EXAMPLES="/home/tilo/Workspace/program-examples/zk/zk-nullifier" | ||
| SNIPPETS_DIR="/home/tilo/Workspace/docs/snippets/code-snippets/zk/nullifier" | ||
|
Comment on lines
+5
to
+6
There was a problem hiding this comment. Replace hardcoded absolute paths with portable alternatives. The script uses hardcoded absolute paths specific to a local development environment ( Proposed fix-PROGRAM_EXAMPLES="/home/tilo/Workspace/program-examples/zk/zk-nullifier"
-SNIPPETS_DIR="/home/tilo/Workspace/docs/snippets/code-snippets/zk/nullifier"
+# Configure these paths or set via environment variables
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+PROGRAM_EXAMPLES="${PROGRAM_EXAMPLES:-../program-examples/zk/zk-nullifier}"
+SNIPPETS_DIR="${SNIPPETS_DIR:-$REPO_ROOT/snippets/code-snippets/zk/nullifier}"🤖 Prompt for AI Agents |
||
|
|
||
| mkdir -p "$SNIPPETS_DIR" | ||
|
Comment on lines
+5
to
+8
There was a problem hiding this comment. Hard-coded absolute paths make this script non-portable (same issue as merkle-proof script). Proposed fix (same pattern)-#!/bin/bash
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Allow overrides: ./copy-zk-nullifier.sh [program_examples_dir] [snippets_dir]
+# (derive defaults relative to repo root) |
||
|
|
||
| wrap_code() { | ||
| local input_file="$1" | ||
| local output_file="$2" | ||
| local lang="$3" | ||
| echo "\`\`\`$lang" > "$output_file" | ||
| cat "$input_file" >> "$output_file" | ||
| echo '```' >> "$output_file" | ||
| echo "Created: $output_file" | ||
| } | ||
|
Comment on lines
+10
to
+18
There was a problem hiding this comment. Use |
||
|
|
||
| # Circuit | ||
| if [ -f "$PROGRAM_EXAMPLES/circuits/nullifier.circom" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/circuits/nullifier.circom" "$SNIPPETS_DIR/circuit.mdx" "javascript expandable" | ||
| fi | ||
|
|
||
| # Program | ||
| if [ -f "$PROGRAM_EXAMPLES/programs/zk-nullifier/src/lib.rs" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/programs/zk-nullifier/src/lib.rs" "$SNIPPETS_DIR/program.mdx" "rust expandable" | ||
| fi | ||
|
|
||
| # Rust client (unified) | ||
| if [ -f "$PROGRAM_EXAMPLES/programs/zk-nullifier/tests/test.rs" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/programs/zk-nullifier/tests/test.rs" "$SNIPPETS_DIR/rust-client.mdx" "rust expandable" | ||
| fi | ||
|
|
||
| # TypeScript client | ||
| if [ -f "$PROGRAM_EXAMPLES/ts-tests/nullifier.test.ts" ]; then | ||
| wrap_code "$PROGRAM_EXAMPLES/ts-tests/nullifier.test.ts" "$SNIPPETS_DIR/typescript-client.mdx" "typescript expandable" | ||
| fi | ||
|
|
||
| echo "" | ||
| echo "Done! Created snippets in: $SNIPPETS_DIR" | ||
| find "$SNIPPETS_DIR" -name "*.mdx" -type f | sort | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's odd