Skip to content

Conversation

@hadi-saleh14
Copy link
Contributor

@hadi-saleh14 hadi-saleh14 commented Sep 24, 2025

Summary by CodeRabbit

  • Documentation
    • Updated SDK links across on-chain docs to new web/installation paths for React, React Native, Flutter, and Node.
    • Refreshed Quickstart prerequisites to point to updated frontend/backend guides.
    • Expanded workflows: added “Submit for Verification” and “Verify On-Chain” (Aleph Zero).
    • Added guidance on maintaining metadata and secure proof handling (Aptos; Cardano note on proof references).
    • Extended flows with new steps, e.g., using signer address (Solana) and extracting/using context address (Solidity).
    • Minor wording and numbering adjustments.

@vercel
Copy link

vercel bot commented Sep 24, 2025

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

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Sep 24, 2025 10:32am

@coderabbitai
Copy link

coderabbitai bot commented Sep 24, 2025

Walkthrough

Documentation across multiple on-chain guides updates SDK link paths to new /web/* and installation URLs. Several pages add brief guidance on proof handling, metadata retention, submission, and on-chain verification. Some flows are extended (e.g., Solana adds a final step; Solidity adds address extraction/usage). Quickstarts mostly adjust prerequisite links.

Changes

Cohort / File(s) Summary of changes
SDK link path updates (Index pages, multiple chains)
content/docs/onchain/*/index.mdx (e.g., alephzero/index.mdx, aptos/index.mdx, cardano/index.mdx, cosmos/index.mdx, diamante/index.mdx, fuel/index.mdx, gear/index.mdx, lukso/index.mdx, mina/index.mdx, near/index.mdx, polkadot/index.mdx, starknet/index.mdx, stellar/index.mdx, sui/index.mdx, xion/index.mdx)
Replace legacy SDK links: /js/frontend-example/web/frontend, /react-native/react-native/installation, /flutter/flutter/installation, /js/backend-example/web/backend/installation.
Prerequisite link updates
content/docs/onchain/*/quickstart.mdx, content/docs/onchain/cosmos/{archway.mdx, neutron.mdx, neutron-terra.mdx, nibiru.mdx, secret.mdx}
Update ReactJS prerequisite link: /js/frontend-example/web/frontend. No other flow/content changes.
Proof handling and verification guidance added
content/docs/onchain/alephzero/index.mdx, content/docs/onchain/aptos/index.mdx, content/docs/onchain/cardano/index.mdx
Add notes to retain metadata/proof references; introduce submit-for-verification and on-chain verification steps.
Solana flow update
content/docs/onchain/solana/index.mdx
Update SDK links; add final step to use signer address in business logic; minor rewording.
Solidity flow expansion
content/docs/onchain/solidity/index.mdx
Update SDK links; add steps to extract context address and use it as user address in subsequent logic.
Targeted link tweak
content/docs/onchain/solana/front-end.mdx
Update “Publish proof” link: ../js/frontend-example../web/frontend.
Minor formatting adjustment
content/docs/onchain/stellar/index.mdx
Normalize step numbering (“-1.” to “1.”); update SDK links as above.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant App as dApp / Frontend
  participant Srv as Backend
  participant SC as Smart Contract
  participant Chain as Blockchain

  User->>App: Initiate proof request
  App->>User: Collect proof (SDK)
  App->>Srv: Upload proof + metadata
  note over App,Srv: Store reference for later verification
  Srv->>SC: Submit serialized proof
  SC->>SC: Verify proof on-chain
  alt verification success
    SC-->>Srv: Verification result (success)
    Srv-->>App: Acknowledge and proceed
  else verification failure
    SC-->>Srv: Verification result (failure)
    Srv-->>App: Handle error path
  end
Loading
sequenceDiagram
  autonumber
  participant App as dApp
  participant SC as Solidity Contract

  App->>SC: Submit proof payload
  SC->>SC: Validate proof
  SC->>SC: Extract context address
  note right of SC: New step: address extraction
  alt valid
    SC-->>App: Return signer/context address
    App->>App: Use address in business logic
  else invalid
    SC-->>App: Revert/emit failure
  end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

documentation, enhancement

Suggested reviewers

  • TheLedgerOfJoudi
  • ChinmayMhatre

Poem

Through links I hop, from js to web I veer,
New paths marked clear—installation’s near!
Proofs tucked tight, metadata in tow,
On-chain I thump: verify, then go.
A signer’s address, a carrot of trust—
Hippity-hey, our docs don’t rust! 🥕🐇

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 is short and explicitly references fixes to “on-chain” content, which aligns with the PR’s widespread updates to on-chain documentation links and flow steps; it therefore reflects the main theme of the changes. It is informal due to the word “hot” and does not enumerate specifics, but PR titles are not required to cover every detail. Because it clearly signals on-chain fixes and is concise, it is acceptable for this changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch onchain-docs-update

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

## Pre-requisite

This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/js/frontend), [React Native](/react-native), or [Node](/js/backend).
This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/web/frontend/), [React Native](/react-native/installation), or [Node](/web/backend/installation).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Inconsistent Link Formatting Causes Routing Issues

The React frontend link in quickstart.mdx includes a trailing slash (/web/frontend/), which is inconsistent with other instances of this link throughout the codebase that omit it. This could cause broken links or routing issues.

Fix in Cursor Fix in Web

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (17)
content/docs/onchain/starknet/quickstart.mdx (1)

231-248: Fix broken React state initializations (JSX/TS syntax errors)

The example mixes TypeScript generics into a JSX code fence and contains invalid useState expressions — it will not compile.

File: content/docs/onchain/starknet/quickstart.mdx (lines 231–248)

- export default function VerifyProof(props: any) {
+ // If this file is .jsx, remove TypeScript types; if it's .tsx, keep them and set code fence to tsx.
+ export default function VerifyProof(props: any) {

- const [error, setError] = (useState < string) | (null > null);
+ const [error, setError] = useState<string | null>(null);

- const [transactionHash, setTransactionHash] =
-   (useState < string) | (null > null);
+ const [transactionHash, setTransactionHash] = useState<string | null>(null);
  • If this file is intended to be TSX: change the MDX code fence to "tsx" and keep type annotations.
  • If it should be plain JSX: remove all TypeScript syntax (e.g., props: any → props; useState generics).
content/docs/onchain/cosmos/archway.mdx (3)

428-431: Fix gas denom for Archway testnet (aconst vs aarch).

You configure the chain as constantine-3 (testnet) above, whose minimal denom is aconst, but use aarch here. This will cause tx failures.

Apply this diff:

-    const defaultGasPrice = GasPrice.fromString("140000000000aarch");
+    // Use 'aconst' on Constantine testnet; switch to 'aarch' on mainnet.
+    const defaultGasPrice = GasPrice.fromString("140000000000aconst");

131-135: Do not embed APP_SECRET in frontend.

Leaking an app secret to the browser is a security risk. Fetch a server-generated signature instead.

-    reclaimClient.setSignature(
-      await reclaimClient.generateSignature(
-        APP_SECRET //TODO : replace with your APP_SECRET
-      )
-    );
+    // Fetch a server-generated signature. Do NOT expose APP_SECRET in the client.
+    const sigResp = await fetch("/api/reclaim/signature", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ applicationId: "YOUR_APPLICATION_ID_HERE" }),
+    });
+    const { signature } = await sigResp.json();
+    reclaimClient.setSignature(signature);

247-248: Fix typos in user-facing messages.

“intall keplr!” → “Install Keplr!”

-        console.log("intall keplr!");
+        console.log("Install Keplr!");
...
-            alert("Intall keplr!");
+            alert("Install Keplr!");

Also applies to: 271-275

content/docs/onchain/cosmos/neutron-terra.mdx (6)

33-35: Fix typos: requests.

Minor wording improvements.

-contract for sending verification requsts.
+contract for sending verification requests.

134-134: Fix typo: address.

-You should send funds to the account adddress in the json file, as that is the actual address that executes the messages.
+You should send funds to the account address in the JSON file, as that is the actual address that executes the messages.

351-352: Fix typo: adjustments.

-Refer them and make your own adjustion.
+Refer to them and make your own adjustments.

140-141: CLI command appears malformed (trailing --chain).

The command likely shouldn’t end with a standalone “--chain”.

-hermes config auto --output $HOME/.hermes/config.toml --chain neutron:keyneutron terra2:keyphoenix --chain 
+hermes config auto --output $HOME/.hermes/config.toml --chain neutron:keyneutron terra2:keyphoenix

431-434: Do not embed APP_SECRET in frontend.

Move signing to a backend endpoint and set the signature from the response.

-    reclaimClient.setSignature(
-      await reclaimClient.generateSignature(
-        APP_SECRET //TODO : replace with your APP_SECRET
-      )
-    );
+    const sigResp = await fetch("/api/reclaim/signature", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ applicationId: "YOUR_APPLICATION_ID_HERE" }),
+    });
+    const { signature } = await sigResp.json();
+    reclaimClient.setSignature(signature);

654-656: Avoid committing API keys/secret-looking tokens in docs.

The Terra LCD URL includes a token-like UUID. Replace with a placeholder and instruct users to supply their own endpoint via env var.

-const terra2URL = "https://luna.nownodes.io/8e88b7de-791c-4ec1-9892-535929724e87";
+// Use your own Terra LCD endpoint; do not hardcode tokens in source.
+const terra2URL = process.env.TERRA_LCD_URL; // e.g., "https://lcd.terra.dev"
content/docs/onchain/cosmos/neutron.mdx (3)

2-2: Fix title typo: Neturon → Neutron.

User-facing header.

-title: Cosmos - Neturon
+title: Cosmos - Neutron

237-237: Fix typo in log message.

-        console.log("intall keplr!");
+        console.log("Install Keplr!");

571-573: Do not embed APP_SECRET in frontend.

Fetch the signature from a backend endpoint.

-      await reclaimClient.generateSignature(
-        APP_SECRET //TODO : replace with your APP_SECRET
-      )
+      // Obtain signature from your backend; never expose APP_SECRET in client code
+      (await (await fetch("/api/reclaim/signature", { method: "POST" })).json()).signature
content/docs/onchain/alephzero/quickstart.mdx (1)

31-35: Fix repo path in quickstart build snippet

File: content/docs/onchain/alephzero/quickstart.mdx (lines 31-35) — the snippet clones ink-sdk.git but runs cd reclaim-aleph-client; change to the correct directory (or document cloning into the expected folder).

 git clone https://gitlab.reclaimprotocol.org/integrations/onchain/ink-sdk.git
-cd reclaim-aleph-client
+cd ink-sdk
 cargo contract build --release

Also add ink!/WASM toolchain prerequisites (before build):

rustup update
rustup target add wasm32-unknown-unknown
cargo install cargo-contract --force --locked
content/docs/onchain/solana/quickstart.mdx (1)

24-24: Fix broken Solana Tool Suite install link

The "here" link is empty — replace it with the official Solana CLI install page: https://solana.com/docs/toolkit/projects/overview

File: content/docs/onchain/solana/quickstart.mdx (line 24)

content/docs/onchain/cosmos/secret.mdx (2)

100-104: Do not expose APP_SECRET in the frontend. Generate the signature on your backend.

Placing APP_SECRET in React code leaks it. Recommend fetching a server‑generated signature (see /web/backend/installation) and setting it on the client.

Apply this diff to both snippets:

-    reclaimClient.setSignature(
-      await reclaimClient.generateSignature(
-        APP_SECRET //TODO : replace with your APP_SECRET
-      )
-    );
+    // Fetch a short‑lived signature from your backend (never ship APP_SECRET to the client)
+    const signature = await fetch("/api/reclaim/signature", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ payload: await reclaimClient.toSignaturePayload() })
+    }).then(r => r.text());
+    reclaimClient.setSignature(signature);

Also applies to: 451-453


354-361: “Proof verified” renders even on failure.

setVerified(true) runs in finally; move it to the success path.

-        onClick={async () => {
-          try {
-            await verify_proof(proof);
-          } catch (e) {
-            console.error(e);
-          } finally {
-            setVerified(true);
-          }
-        }}
+        onClick={async () => {
+          try {
+            await verify_proof(proof);
+            setVerified(true);
+          } catch (e) {
+            console.error(e);
+            setVerified(false);
+          }
+        }}
🧹 Nitpick comments (24)
content/docs/onchain/lukso/quickstart.mdx (1)

10-10: Polish wording and capitalization in prerequisite sentence

“ReactJs” → “React” (or “React SDK guide”), and “at” → “in” reads better.

-At this stage, we assume that you are familiar with the steps at [ReactJs](/web/frontend).
+At this stage, we assume you are familiar with the steps in the [React guide](/web/frontend).

Also confirm /web/frontend resolves in the deployed docs.

content/docs/onchain/xion/index.mdx (1)

7-7: Update React SDK link to installation page and use "frontend" (no hyphen)

File: content/docs/onchain/xion/index.mdx (line 7) — installation pages verified; apply the change below.

-1. Your app requests proofs from the user using one of the front-end libraries like [Reclaim React SDK](/web/frontend), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation) or a backend library like [Reclaim Node SDK](/web/backend/installation)
+1. Your app requests proofs from the user using one of the frontend libraries like [Reclaim React SDK](/web/frontend/installation), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation) or a backend library like [Reclaim Node SDK](/web/backend/installation)
content/docs/onchain/fuel/index.mdx (1)

7-7: Rename link text to "Reclaim Web SDK", use "frontend" (no hyphen), and add Oxford comma — targets verified

Verified slugs: content/docs/web/frontend/index.mdx, content/docs/react-native/installation.mdx, content/docs/flutter/installation.mdx, content/docs/web/backend/installation.mdx. Update content/docs/onchain/fuel/index.mdx (line 7) as follows:

-1. Your app requests proofs from the user using one of the front-end libraries like [Reclaim React SDK](/web/frontend), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation) or a backend library like [Reclaim Node SDK](/web/backend/installation)
+1. Your app requests proofs from the user using one of the frontend libraries like [Reclaim Web SDK](/web/frontend), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation), or a backend library like [Reclaim Node SDK](/web/backend/installation)
content/docs/onchain/gear/index.mdx (2)

7-7: Consistency nit: hyphenation and Oxford comma.

Prefer “back-end” to match “front-end,” and add a comma before “or” for the final list item.

Apply this diff:

-1. Your app requests proofs from the user using one of the front-end libraries like [Reclaim React SDK](/web/frontend), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation) or a backend library like [Reclaim Node SDK](/web/backend/installation)
+1. Your app requests proofs from the user using one of the front-end libraries like [Reclaim React SDK](/web/frontend), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation), or a back-end library like [Reclaim Node SDK](/web/backend/installation)

8-8: Copy edit: hyphenate “CosmWasm‑friendly”.

Minor readability tweak.

Apply this diff:

-2. Once the user has uploaded the proof, you can serialize it into a CosmWasm friendly format
+2. Once the user has uploaded the proof, you can serialize it into a CosmWasm‑friendly format
content/docs/onchain/near/quickstart.mdx (1)

10-10: Link target OK — tighten label to "React (Web) guide"

Target exists at content/docs/web/frontend/ — update phrasing for consistency.

-At this stage, we assume that you are familiar with the steps at [ReactJs](/web/frontend).
+At this stage, we assume you are familiar with the steps in the [React (Web) guide](/web/frontend).

Location: content/docs/onchain/near/quickstart.mdx:10

content/docs/onchain/diamante/quickstart.mdx (3)

112-115: Consolidate imports from the same package

Minor cleanup: import both symbols from @reclaimprotocol/js-sdk in one line.

Apply this diff:

-import { ReclaimProofRequest } from "@reclaimprotocol/js-sdk";
+import { ReclaimProofRequest, verifyProof } from "@reclaimprotocol/js-sdk";
-import QRCode from "react-qr-code";
-import { verifyProof } from "@reclaimprotocol/js-sdk";
+import QRCode from "react-qr-code";

127-128: Remove unused statusUrl or show how to use it

statusUrl is set but never used, which can confuse readers. Either drop it or add a short snippet showing how to poll/display status.

Apply this diff to remove it:

-  const [statusUrl, setStatusUrl] = useState("");
...
-    const status = reclaimProofRequest.getStatusUrl();
-    setStatusUrl(status);

Also applies to: 156-157


133-137: Avoid committing real-looking credentials; use explicit placeholders

These hex-like values look real. If they are live, rotate immediately. Even if examples, replace with unmistakable placeholders to prevent accidental use and misconstrual as valid secrets.

Apply this diff in the snippet:

-      const APP_ID = "0x6E0338a6D8594101Ea9e13840449242015d71B19"; //TODO: This is an example App Id Replace it with your App Id.
-      const APP_SECRET =
-        "0x1e0d6a6548b72286d747b4ac9f2ad6b07eba8ad6a99cb1191890ea3f77fae48f"; //TODO: This is an example App Secret Replace it with your App Secret.
-      const PROVIDER_ID = "6d3f6753-7ee6-49ee-a545-62f1b1822ae5"; //TODO: This is GitHub Provider Id Replace it with the provider id you want to use.
+      const APP_ID = "REPLACE_WITH_YOUR_APP_ID";
+      const APP_SECRET = "REPLACE_WITH_YOUR_APP_SECRET";
+      const PROVIDER_ID = "REPLACE_WITH_PROVIDER_ID"; // e.g., GitHub provider ID

If these were real credentials, please confirm rotation has been performed.

content/docs/onchain/cosmos/nibiru.mdx (1)

8-10: Polish phrasing and casing; prefer “Prerequisites” and clearer link text.

Minor UX copy nits: use “Prerequisites” and “React” casing, and make the link text clearer.

Apply this diff:

-## Pre-requisite
-At this stage, we assume that you are familiar with the steps at [ReactJs](/web/frontend).
+## Prerequisites
+At this stage, we assume you're familiar with the steps in the [Web (React) quickstart](/web/frontend).
content/docs/onchain/polkadot/quickstart.mdx (1)

18-18: Typo: “intergrate” → “integrate”

User-facing typo in a heading paragraph.

-Please note that `pallet_integration_with_reclaim` pallet is an example pallet that represents your pallet which you want to intergrate `Reclaim` with.
+Please note that `pallet_integration_with_reclaim` is an example pallet that represents your pallet which you want to integrate `Reclaim` with.
content/docs/onchain/solana/front-end.mdx (1)

47-47: Fix link style and minor grammar in the sentence

Use absolute path for consistency and correct typos.

-As in [Reclaim React SDK](../web/frontend), our starter app shows a QR-code for you to scan and create proof. Upon successfull proof generation, A button with the text `Verify Proof` appears. Clicking this button prompts you to publish the obtained proof. 
+As in [Reclaim React SDK](/web/frontend), our starter app shows a QR code for you to scan and create a proof. Upon successful proof generation, a button labeled "Verify Proof" appears. Clicking this button prompts you to publish the obtained proof.

Please also confirm all other pages use absolute paths to docs sections for consistency.

content/docs/onchain/solana/index.mdx (1)

13-13: Clarify “Use the signer address” step with a reference

Add a short note or link on how to extract the signer address (from the proof payload or program account) to make this actionable.

Proposed addition after step 5:

  • “See ‘Signer address extraction’ in the Solana frontend guide for how to read the signer address from the verified proof.”

Do we have a dedicated section to link here? If not, I can draft a brief subsection with a code snippet.

content/docs/onchain/solidity/quickstart.mdx (1)

10-10: Clarify “frontend” vs “Node” and use SDK names

“Node” isn’t a frontend; suggest wording that distinguishes frontend vs backend and uses the SDK name for React.

-This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/web/frontend), [React Native](/react-native/installation), or [Node](/web/backend/installation).
+This tutorial assumes you have either a frontend (e.g., [Reclaim React SDK](/web/frontend) or [React Native](/react-native/installation)) or a backend ([Node](/web/backend/installation)) that requests proofs and processes responses.
content/docs/onchain/cardano/index.mdx (1)

19-21: Tighten guidance on storing proofs

Recommend clearer wording that emphasizes secure storage and that the reference is required later.

-   - Once the user uploads the proof, store the proof identifier or reference
-   - This reference will be needed for subsequent verification steps
+   - Once the user uploads the proof, securely store the proof (or its identifier/reference)
+   - You’ll need this for subsequent verification steps
content/docs/onchain/solidity/index.mdx (1)

11-12: Add cross‑link to context extraction utility

Since you reference extracting the context address, link to the Quickstart section that documents extractFieldFromContext for a smoother flow.

-5. Extract context address from the proof 
+5. Extract context address from the proof (see [Context Field](./quickstart#context-field))
 6. Use the above as the user's address in further business logic
content/docs/onchain/cosmos/index.mdx (1)

9-9: Optional: link to serialization helper for clarity.

Consider pointing to Reclaim.transformForOnchain (or equivalent) to guide users on the “serialize” step.

-2. Once the user has uploaded the proof, you can serialize it into a CosmWasm friendly format
+2. Once the user has uploaded the proof, serialize it into a CosmWasm‑friendly format (e.g., using Reclaim’s on‑chain transform helper)
content/docs/onchain/alephzero/quickstart.mdx (3)

44-48: Clarify network selection in Contract UI.

Add a note to select the Aleph Zero testnet in the UI before deploying to avoid mis-deploying to another chain.


80-85: Secret handling: don’t commit credentials.

Advise storing Reclaim credentials in environment variables or a secure vault and exclude them from VCS.


14-14: /web/frontend exists — optional: standardize the link text to "React guide".

content/docs/web/frontend contains index.mdx, quickstart.mdx and fullstack.mdx. Update content/docs/onchain/alephzero/quickstart.mdx:14 from "ReactJs guide" to "React guide" (or "React.js guide") for consistency.

content/docs/onchain/solana/quickstart.mdx (1)

172-179: Disambiguate “mainnet-beta” vs Anchor “mainnet” naming

You list “mainnet-beta” as a supported network, but Anchor.toml uses cluster = "mainnet" and [programs.mainnet]. This is correct for Anchor, but may confuse readers.

Add a short note clarifying that:

  • Solana network is commonly called “mainnet-beta”.
  • Anchor uses “mainnet” in Anchor.toml and the --provider.cluster flag.

Also applies to: 212-218, 220-227

content/docs/onchain/cosmos/secret.mdx (3)

344-347: Add dependency to useEffect.

Ensure transformed proof updates when props.proof changes.

-  useEffect(() => {
+  useEffect(() => {
     const newProof = Reclaim.transformForOnchain(props.proof);
     setProof(newProof);
-  }, []);
+  }, [props.proof]);

220-221: Typo in log message.

Minor polish.

-        console.log("intall keplr!");
+        console.log("install Keplr!");

410-414: Avoid hardcoded end index when truncating address.

Use slice(-4) for the last 4 chars; current 41–45 assumes fixed length.

-        {secretAddress
-          ? secretAddress.slice(0, 10) + "...." + secretAddress.slice(41, 45)
+        {secretAddress
+          ? `${secretAddress.slice(0, 10)}....${secretAddress.slice(-4)}`
           : "Please connect wallet"}
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 16308f3 and d710d6a.

📒 Files selected for processing (34)
  • content/docs/onchain/alephzero/index.mdx (1 hunks)
  • content/docs/onchain/alephzero/quickstart.mdx (1 hunks)
  • content/docs/onchain/aptos/index.mdx (1 hunks)
  • content/docs/onchain/aptos/quickstart.mdx (1 hunks)
  • content/docs/onchain/cardano/index.mdx (1 hunks)
  • content/docs/onchain/cardano/quickstart.mdx (1 hunks)
  • content/docs/onchain/cosmos/archway.mdx (1 hunks)
  • content/docs/onchain/cosmos/index.mdx (1 hunks)
  • content/docs/onchain/cosmos/neutron-terra.mdx (1 hunks)
  • content/docs/onchain/cosmos/neutron.mdx (1 hunks)
  • content/docs/onchain/cosmos/nibiru.mdx (1 hunks)
  • content/docs/onchain/cosmos/secret.mdx (1 hunks)
  • content/docs/onchain/diamante/index.mdx (1 hunks)
  • content/docs/onchain/diamante/quickstart.mdx (1 hunks)
  • content/docs/onchain/fuel/index.mdx (1 hunks)
  • content/docs/onchain/gear/index.mdx (1 hunks)
  • content/docs/onchain/lukso/index.mdx (1 hunks)
  • content/docs/onchain/lukso/quickstart.mdx (1 hunks)
  • content/docs/onchain/mina/index.mdx (1 hunks)
  • content/docs/onchain/mina/quickstart.mdx (1 hunks)
  • content/docs/onchain/near/index.mdx (1 hunks)
  • content/docs/onchain/near/quickstart.mdx (1 hunks)
  • content/docs/onchain/polkadot/index.mdx (1 hunks)
  • content/docs/onchain/polkadot/quickstart.mdx (1 hunks)
  • content/docs/onchain/solana/front-end.mdx (1 hunks)
  • content/docs/onchain/solana/index.mdx (1 hunks)
  • content/docs/onchain/solana/quickstart.mdx (1 hunks)
  • content/docs/onchain/solidity/index.mdx (1 hunks)
  • content/docs/onchain/solidity/quickstart.mdx (1 hunks)
  • content/docs/onchain/starknet/index.mdx (1 hunks)
  • content/docs/onchain/starknet/quickstart.mdx (1 hunks)
  • content/docs/onchain/stellar/index.mdx (1 hunks)
  • content/docs/onchain/sui/index.mdx (1 hunks)
  • content/docs/onchain/xion/index.mdx (1 hunks)
⏰ 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). (1)
  • GitHub Check: Cursor Bugbot
🔇 Additional comments (28)
content/docs/onchain/lukso/index.mdx (1)

8-8: Updated SDK links verified — all targets exist

All four linked pages were found: content/docs/web/frontend/index.mdx, content/docs/react-native/installation.mdx, content/docs/flutter/installation.mdx, content/docs/web/backend/installation.mdx.

content/docs/onchain/gear/index.mdx (1)

7-7: Confirm doc slugs exist and update React link to include /installation if needed

Local search under content/docs returned no matches for these slugs — add the pages or update links/redirects so these URLs resolve:

  • /web/frontend
  • /react-native/installation
  • /flutter/installation
  • /web/backend/installation
content/docs/onchain/near/index.mdx (1)

8-8: LGTM — links verified; harmonize terminology/labels.

-1. Your app requests proofs from the user using one of the front-end libraries like [Reclaim React SDK](/web/frontend), [Reclaim React Native SDK](/react-native/installation), [Reclaim Flutter SDK](/flutter/installation) or a backend library like [Reclaim Node SDK](/web/backend/installation)
+1. Your app requests proofs using one of the frontend SDKs — [React (Web)](/web/frontend), [React Native](/react-native/installation), [Flutter](/flutter/installation) — or the backend SDK — [Node (Web)](/web/backend/installation).
content/docs/onchain/diamante/quickstart.mdx (1)

11-11: Fix link label casing — use "ReactJS" (route /web/frontend exists)

Use "ReactJS" for consistency; the target route exists at content/docs/web/frontend.

-At this stage, we assume that you are familiar with the steps at [ReactJs](/web/frontend).
+At this stage, we assume that you are familiar with the steps at [ReactJS](/web/frontend).
content/docs/onchain/cosmos/nibiru.mdx (1)

9-9: Verified — /web/frontend exists and should resolve.

content/docs/web/frontend/index.mdx and content/docs/web/frontend/fullstack.mdx are present and repo baseUrl is '/', so absolute /web/frontend links should work.

content/docs/onchain/starknet/quickstart.mdx (1)

10-10: LGTM on the prereq link update

Matches the new docs IA.

content/docs/onchain/polkadot/quickstart.mdx (1)

12-12: LGTM on the prereq link update

Consistent with other pages.

content/docs/onchain/aptos/quickstart.mdx (1)

14-14: LGTM on the prereq link update

Matches site-wide path changes.

content/docs/onchain/cardano/quickstart.mdx (1)

11-11: LGTM on the prereq link update

Reads well and matches new structure.

content/docs/onchain/solana/index.mdx (1)

8-8: LGTM on the link target updates

Consistent with the rest of the PR.

content/docs/onchain/diamante/index.mdx (1)

8-8: Approve — link targets updated; no legacy /js/ paths found*

Searched content/docs: no matches for /js/frontend-example or /js/backend-example; docs use /web/frontend, /react-native/installation, /flutter/installation and /web/backend/installation.

content/docs/onchain/mina/quickstart.mdx (1)

10-10: Link update verified — route exists and old path removed

content/docs/web/frontend (index.mdx, fullstack.mdx, installation.mdx, quickstart.mdx) exists; /web/frontend is referenced across docs and there are NO matches for /js/frontend-example.

content/docs/onchain/mina/index.mdx (1)

8-8: Links update LGTM; please verify targets resolve

The new SDK doc paths look consistent with the repo-wide change. Please double‑check that all four targets exist and build correctly in the deployed docs.

content/docs/onchain/cardano/index.mdx (1)

13-16: Links update LGTM; ensure targets exist

The path updates align with the new structure. Please verify these pages exist so the links don’t 404.

content/docs/onchain/solidity/index.mdx (1)

7-7: Links update LGTM; please verify targets resolve

New SDK doc paths look consistent. Please confirm all four pages exist and render.

content/docs/onchain/stellar/index.mdx (1)

7-7: Links update LGTM; please verify targets resolve

The updated SDK links match the new structure. Confirm the targets exist and deploy.

content/docs/onchain/polkadot/index.mdx (1)

8-8: Links update LGTM; please verify targets resolve

Consistent with repo-wide changes. Please ensure all four linked pages are present.

content/docs/onchain/starknet/index.mdx (1)

8-8: Links update LGTM; please verify targets resolve

Looks good and consistent. Please double‑check that the new URLs exist in the docs site.

content/docs/onchain/sui/index.mdx (1)

7-7: Links update LGTM; please verify targets resolve

Update aligns with the standardized paths. Confirm targets render to avoid broken links.

content/docs/onchain/aptos/index.mdx (1)

15-19: SDK link updates look good; please confirm the routes exist in the built site.

The paths align with the new structure (/web/* and installation pages). Verify no redirects are needed.

content/docs/onchain/alephzero/index.mdx (1)

13-16: Good alignment with new SDK paths.

Links match the updated web/installation structure.

content/docs/onchain/cosmos/archway.mdx (1)

10-10: Prereq link update looks correct.

Points to /web/frontend consistently with other guides.

content/docs/onchain/cosmos/neutron-terra.mdx (1)

10-10: Prereq link update looks correct.

Consistent with other on-chain pages.

content/docs/onchain/cosmos/neutron.mdx (1)

10-10: Prereq link update looks correct.

Matches the new /web/frontend path.

content/docs/onchain/cosmos/index.mdx (1)

8-8: Flow step link updates look good.

Consistent with the standardized /web/* and installation paths.

content/docs/onchain/alephzero/quickstart.mdx (2)

53-61: Validate epoch/witness parameters.

Please confirm the witness host and address are current for Aleph Zero testnet. Stale values will cause verification failures.


103-106: Double-check start command.

Starter templates vary: many use npm run dev (Vite) rather than npm start. Confirm the correct script in package.json.

content/docs/onchain/cosmos/secret.mdx (1)

10-10: LGTM — prerequisite link updated; no stale /js/frontend references found

Searched repository .md/.mdx files: only /web/frontend references remain (expected); no matches for /js/frontend or /js/frontend-example.

## Pre-requisite

This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/js/frontend), [React Native](/react-native), or [Node](/js/backend).
This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/web/frontend/), [React Native](/react-native/installation), or [Node](/web/backend/installation).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Clarify frontend vs backend and tighten wording

Node is not a frontend. Rephrase to avoid confusion and align links.

Apply this diff:

-This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/web/frontend/), [React Native](/react-native/installation), or [Node](/web/backend/installation).
+This tutorial assumes you have:
+- a frontend to request proofs from users (e.g., [Web (React)](/web/frontend), [React Native](/react-native/installation)), and
+- a backend to process responses or submit on-chain (e.g., [Node](/web/backend/installation)).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
This tutorial assumes that you have a frontend that requests proofs from the user and processes the response, like [React](/web/frontend/), [React Native](/react-native/installation), or [Node](/web/backend/installation).
This tutorial assumes you have:
- a frontend to request proofs from users (e.g., [Web (React)](/web/frontend), [React Native](/react-native/installation)), and
- a backend to process responses or submit on-chain (e.g., [Node](/web/backend/installation)).
🤖 Prompt for AI Agents
In content/docs/onchain/solana/quickstart.mdx around line 10, the sentence
incorrectly lists Node as a frontend and is ambiguous; update wording to clearly
distinguish frontends (e.g., React, React Native) from backend environments
(Node). Replace the line with a concise phrase like "This tutorial assumes you
have a client application (e.g., React or React Native) or a backend service
(e.g., Node) that requests proofs from the user and processes responses," and
ensure the existing links point to the appropriate frontend and backend pages.

@TheLedgerOfJoudi TheLedgerOfJoudi merged commit c3d0462 into main Sep 24, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants