docs: update CRISP readme to reflect latest changes by 0xjei · Pull Request #829 · theinterfold/interfold

0xjei · 2025-10-10T12:13:17Z

this PR removes also the pnpm dev:down command in favour of the new clean command at root.

Summary by CodeRabbit

Documentation
- Overhauled CRISP docs and README: clearer description, reorganized project structure, consolidated prerequisites, step-by-step setup for web app/server, explicit environment variables with sample PROGRAM_SERVER_URL, updated example addresses, MetaMask install guidance, expanded Node/pnpm instructions, CLI usage, optional Bonsai/faster proving notes, and updated deployment/run examples.
Chores
- Added localhost deployment data for local testing.
- Removed an unused development script.
- Updated build metadata with no functional impact.

vercel · 2025-10-10T12:13:23Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
enclave-docs	Ready	Preview	Comment	Oct 10, 2025 4:56pm

1 Skipped Deployment

Project	Deployment	Preview	Comments	Updated (UTC)
crisp	Skipped			Oct 10, 2025 4:56pm

coderabbitai · 2025-10-10T12:14:20Z

Walkthrough

Rewrites and reorganizes CRISP example docs and README, updates environment/sample addresses and script names, removes one npm dev script, updates three Solidity artifact buildInfoId fields, and adds a new localhost deployment block to deployed_contracts.json.

Changes

Cohort / File(s)	Summary of Changes
CRISP docs & README `examples/CRISP/Readme.md`, `docs/pages/CRISP/setup.mdx`	Major rewrite and reorganization: new prerequisites/environment sections, updated sample env vars/addresses, renamed scripts/commands, reorganized install/deploy steps, added Bonsai configuration and examples.
CRISP package config `examples/CRISP/package.json`	Removed the `dev:down` npm script entry; no other edits to `package.json`.
Solidity artifact metadata `packages/enclave-contracts/artifacts/.../ICiphernodeRegistry.json`, `.../IEnclave.json`, `.../NaiveRegistryFilter.json`	Updated only the `buildInfoId` fields (solc build reference changed); ABI/bytecode and other content unchanged.
Deployed contracts data `packages/enclave-contracts/deployed_contracts.json`	Added a new top-level `localhost` deployment block containing Enclave, CiphernodeRegistry, NaiveRegistryFilter, Mock* contracts with addresses, constructor args, and block numbers; preserved existing entries.

Sequence Diagram(s)

(omitted — changes are documentation, metadata, and deployment data; no control-flow or runtime feature added)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Non-deterministic buildInfoId in artifacts despite unchanged contracts #792 — Matches updates to artifact buildInfoId values and the reported nondeterministic/changed buildInfoId across builds.

Possibly related PRs

docs: update hosted docs on CRISP #724 — Overlapping edits to CRISP documentation and example startup/setup commands.
docs: readme and contracts #722 — Related documentation rewrites for the CRISP example/README.
Enclave contracts deployment Sepolia #400 — Touches similar enclave contract artifacts and deployed contract data.

Suggested labels

documentation

Suggested reviewers

cedoor
ctrlc03

Poem

I twitch my whiskers at docs anew,
New envs and scripts hop into view.
Localhost gardens planted neat and fresh,
Artifacts refreshed — a tidy little thresh.
Hop on, CRISP — our burrow's trimmed and true. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly indicates that the CRISP README documentation is being updated to reflect changes, directly matching the primary task of the PR and avoiding vague terms or unnecessary details.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/CRISP

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e76f26c and fdc57bd.

📒 Files selected for processing (2)

docs/pages/CRISP/setup.mdx (2 hunks)
examples/CRISP/Readme.md (11 hunks)

🧰 Additional context used

🪛 Gitleaks (8.28.0)

docs/pages/CRISP/setup.mdx

[high] 167-167: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

[high] 304-304: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

[high] 321-321: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

examples/CRISP/Readme.md

[high] 167-167: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

GitHub Check: crisp_e2e
GitHub Check: integration_prebuild
GitHub Check: build_sdk
GitHub Check: build_e3_support_dev
GitHub Check: test_net
GitHub Check: rust_unit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d037828 and 117b5b4.

📒 Files selected for processing (6)

examples/CRISP/Readme.md (10 hunks)
examples/CRISP/package.json (0 hunks)
packages/enclave-contracts/artifacts/contracts/interfaces/ICiphernodeRegistry.sol/ICiphernodeRegistry.json (1 hunks)
packages/enclave-contracts/artifacts/contracts/interfaces/IEnclave.sol/IEnclave.json (1 hunks)
packages/enclave-contracts/artifacts/contracts/registry/NaiveRegistryFilter.sol/NaiveRegistryFilter.json (1 hunks)
packages/enclave-contracts/deployed_contracts.json (1 hunks)

💤 Files with no reviewable changes (1)

examples/CRISP/package.json

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

examples/CRISP/Readme.md

125-125: No space after hash on atx style heading

(MD018, no-missing-space-atx)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

GitHub Check: build_enclave_cli
GitHub Check: build_sdk
GitHub Check: test_contracts
GitHub Check: test_net
GitHub Check: integration_prebuild
GitHub Check: rust_unit
GitHub Check: build_e3_support_dev

cedoor

ACK 👍🏽

* update CRISP readme * run prettier for deployed contracts * update docs * better descriptions and fix wrong folder * revert deployed contracts

0xjei added 2 commits October 10, 2025 14:07

update CRISP readme

0f5641a

run prettier for deployed contracts

117b5b4

coderabbitai Bot reviewed Oct 10, 2025

View reviewed changes

Comment thread examples/CRISP/Readme.md

update docs

e76f26c

vercel Bot temporarily deployed to Preview – crisp October 10, 2025 12:21 Inactive

0xjei changed the title ~~Update CRISP readme to reflect latest changes~~ docs: update CRISP readme to reflect latest changes Oct 10, 2025

0xjei requested a review from cedoor October 10, 2025 12:22

0xjei self-assigned this Oct 10, 2025

vercel Bot deployed to Preview – enclave-docs October 10, 2025 12:22 View deployment

ctrlc03 reviewed Oct 10, 2025

View reviewed changes

Comment thread docs/pages/CRISP/setup.mdx Outdated

Comment thread docs/pages/CRISP/setup.mdx

better descriptions and fix wrong folder

fdc57bd

vercel Bot temporarily deployed to Preview – crisp October 10, 2025 15:03 Inactive

vercel Bot deployed to Preview – enclave-docs October 10, 2025 15:04 View deployment

cedoor previously approved these changes Oct 10, 2025

View reviewed changes

Comment thread packages/enclave-contracts/deployed_contracts.json

revert deployed contracts

cbc5d3b

0xjei dismissed cedoor’s stale review via cbc5d3b October 10, 2025 16:33

Merge branch 'main' into docs/CRISP

762c21f

vercel Bot temporarily deployed to Preview – crisp October 10, 2025 16:34 Inactive

0xjei enabled auto-merge (squash) October 10, 2025 16:34

vercel Bot temporarily deployed to Preview – enclave-docs October 10, 2025 16:34 Inactive

Merge branch 'main' into docs/CRISP

b6ddbd9

vercel Bot temporarily deployed to Preview – crisp October 10, 2025 16:55 Inactive

vercel Bot deployed to Preview – enclave-docs October 10, 2025 16:56 View deployment

cedoor approved these changes Oct 10, 2025

View reviewed changes

0xjei merged commit 2ed3b65 into main Oct 10, 2025
20 checks passed

cedoor deleted the docs/CRISP branch October 10, 2025 17:26

ctrlc03 pushed a commit that referenced this pull request Oct 11, 2025

docs: update CRISP readme to reflect latest changes (#829)

b457417

* update CRISP readme * run prettier for deployed contracts * update docs * better descriptions and fix wrong folder * revert deployed contracts

coderabbitai Bot mentioned this pull request Oct 29, 2025

fix: small changes to aid crisp e2e test to run locally #926

Merged

coderabbitai Bot mentioned this pull request Nov 13, 2025

feat: automatically config enclave.config.yaml #1014

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: update CRISP readme to reflect latest changes#829

docs: update CRISP readme to reflect latest changes#829
0xjei merged 7 commits into
mainfrom
docs/CRISP

0xjei commented Oct 10, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cedoor left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

0xjei commented Oct 10, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel Bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related issues

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cedoor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

0xjei commented Oct 10, 2025 •

edited by coderabbitai Bot

Loading

vercel Bot commented Oct 10, 2025 •

edited

Loading

coderabbitai Bot commented Oct 10, 2025 •

edited

Loading