-
Notifications
You must be signed in to change notification settings - Fork 13
zkFetch docs update #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,42 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| title: Installation | ||||||||||||||||||
| description: Flutter SDK for Reclaim Protocol | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. description is incorrect |
||||||||||||||||||
| --- | ||||||||||||||||||
|
Comment on lines
+1
to
+4
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix incorrect SDK description in front matter. Line 3 states Apply this diff to correct the description: - description: Flutter SDK for Reclaim Protocol
+ description: JavaScript SDK for Reclaim Protocol📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||
|
|
||||||||||||||||||
| ## Prerequisites | ||||||||||||||||||
| - NodeJS 18 or later | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Get an API Key | ||||||||||||||||||
| Setup your project using the [Get API Key guide](/api-key). | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Enable zkFetch | ||||||||||||||||||
| Make sure zkFetch is turned on for your application from the [Dev Tool](https://dev.reclaimprotocol.org). You can do so by navigating to the application, and looking for zkFetch in the Integration tab. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Installation | ||||||||||||||||||
|
|
||||||||||||||||||
| ```bash copy | ||||||||||||||||||
| npm i @reclaimprotocol/zk-fetch | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| Please download zk files using this command: | ||||||||||||||||||
| ```bash copy | ||||||||||||||||||
| node node_modules/@reclaimprotocol/zk-symmetric-crypto/lib/scripts/download-files | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Additional NextJS Configuration | ||||||||||||||||||
|
|
||||||||||||||||||
| zkFetch uses native modules that need to be externalized in Next.js. Add this to your `next.config.ts`: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```typescript | ||||||||||||||||||
| import type { NextConfig } from "next"; | ||||||||||||||||||
|
|
||||||||||||||||||
| const nextConfig: NextConfig = { | ||||||||||||||||||
| serverExternalPackages: ['koffi', '@reclaimprotocol/zk-fetch'], | ||||||||||||||||||
| }; | ||||||||||||||||||
|
|
||||||||||||||||||
| export default nextConfig; | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| { | ||
| "title": "ZK Fetch", | ||
| "pages": ["quickstart", "cardano", "stellar"] | ||
| "pages": ["installation", "usage", "cardano", "stellar"] | ||
| } |
This file was deleted.
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.
Correct hyphenation: "zero knowledge proofs" → "zero-knowledge proofs".
Line 13 uses "zero knowledge proofs" (two words), but the standard English term in cryptography and blockchain contexts is "zero-knowledge proofs" (hyphenated).
Apply this diff:
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[grammar] ~13-~13: Use a hyphen to join words.
Context: ...username/passwords, PII etc. Using zero knowledge proofs, you can redact parts o...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents