Skip to content

update cardano docs #90

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.

Sign up for GitHub

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

Merged
hadi-saleh14 merged 1 commit into from
Dec 11, 2025
Merged

update cardano docs #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions content/docs/onchain/cardano/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ Reclaim Protocol Proofs provide a secure way to verify user data in blockchain a

1. **Request Proofs**
- Implement proof requests using one of our official SDKs:
- [React SDK](/web/frontend) for web applications
- [JS SDK](/js-sdk/installation) for backend anf web implementations
Copy link

@coderabbitai coderabbitai bot Dec 11, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix typo: "anf" should be "and".

Line 13 contains a spelling error that should be corrected to improve documentation quality.

-     - [JS SDK](/js-sdk/installation) for backend anf web implementations
+     - [JS SDK](/js-sdk/installation) for backend and web implementations
📝 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
- [JS SDK](/js-sdk/installation) for backend anf web implementations
- [JS SDK](/js-sdk/installation) for backend and web implementations
🧰 Tools
🪛 LanguageTool

[grammar] ~13-~13: Ensure spelling is correct
Context: ... SDK](/js-sdk/installation) for backend anf web implementations - [React Nativ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
In content/docs/onchain/cardano/index.mdx around line 13, there's a spelling
mistake "anf" that should be corrected to "and"; update the text to read "[JS
SDK](/js-sdk/installation) for backend and web implementations" so the
documentation reads correctly.

- [React Native SDK](/react-native/installation) for mobile applications
- [Flutter SDK](/flutter/installation) for cross-platform applications
- [Node.js SDK](/web/backend/installation) for backend implementations

2. **Handle Proof Upload**
- Once the user uploads the proof, store the proof identifier or reference
Expand All @@ -23,13 +22,7 @@ Reclaim Protocol Proofs provide a secure way to verify user data in blockchain a
- Convert the proof into a blockchain-compatible format (serialization)
- Submit the serialized proof to your designated smart contract

4. **Verify On-chain**
4. **Verify on-chain**
- The smart contract performs verification of the submitted proof
- Implement appropriate logic to handle verification results

### Next Steps
- Review our [Smart Contract Integration Guide] for detailed verification implementation
- Explore [Example Implementations] for practical usage scenarios
- Check our [Security Best Practices] for proof handling

Note: Replace bracketed links with actual documentation links when available.
9 changes: 4 additions & 5 deletions content/docs/onchain/cardano/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ import { Step, Steps } from 'fumadocs-ui/components/steps';
## Prerequisites

Before starting, ensure you have:
- Working knowledge of ReactJS development ([Frontend Development Guide](/web/frontend))
- A Cardano-compatible wallet (e.g., Nami) configured for testnet
- A Cardano-compatible wallet (e.g., Lace) configured for testnet
- Basic understanding of blockchain concepts
- Access to the [example codebase](https://gitlab.reclaimprotocol.org/integrations/onchain/pluts-sdk)
- Access to the [example codebase](https://github.com/reclaimprotocol/pluts-sdk-onchain-integration)

## Overview

Expand All @@ -34,7 +33,7 @@ This integration creates a robust identity verification system combining zero-kn
Initialize the development environment:

```bash
git clone https://gitlab.reclaimprotocol.org/integrations/onchain/pluts-sdk
git clone https://github.com/reclaimprotocol/pluts-sdk-onchain-integration

cd pluts-sdk

Expand Down Expand Up @@ -78,7 +77,7 @@ npm install
### 5. Implementation Process

**Wallet Configuration**
- Connect your Cardano wallet (e.g., Nami)
- Connect your Cardano wallet (e.g., Lace)
- Ensure testnet configuration

**Proof Generation and Identity Creation**
Expand Down
2 changes: 2 additions & 0 deletions content/docs/zkfetch/cardano.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ deno run -A --unstable --node-modules-dir=manual sendTransaction.ts

Proof identifier and extracted parameters will be included in the transaction's [metadata](https://preprod.cexplorer.io/tx/c36ba27f9124ec345b3a54bde3212aef834f91e203d2c8bf32a2f1f474ac5b4f/metadata#data).

You can skip the guide below and head directly to the repository's comprehensive [README](https://github.com/reclaimprotocol/zkfetch-cardano-example?tab=readme-ov-file#zkfetch-cardano-example).

## Testing

Run all tests with:
Expand Down