From 727005d1cb0edd43ffea24fa0684a5e96d06cd46 Mon Sep 17 00:00:00 2001 From: hadi-saleh14 Date: Mon, 12 Jan 2026 18:26:07 +0800 Subject: [PATCH 1/2] misc doc updates --- content/docs/android/usage.mdx | 2 +- content/docs/ios-swift/usage.mdx | 2 +- content/docs/js-sdk/generating-proof.mdx | 2 +- content/docs/js-sdk/installation.mdx | 2 +- content/docs/react-native/install/expo.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/android/usage.mdx b/content/docs/android/usage.mdx index d78e337..0d70ade 100644 --- a/content/docs/android/usage.mdx +++ b/content/docs/android/usage.mdx @@ -22,7 +22,7 @@ val request = ReclaimVerification.Request( ) ``` -- You can get the `APP_ID` and `APP_SECRET` using [this guide](/api-key) +- You can get the `APP_ID` and `APP_SECRET` using [this guide](/api-key). - The `PROVIDER_ID` is the proof you want the user to generate. You can see all the [available providers here](https://dev.reclaimprotocol.org/explore). diff --git a/content/docs/ios-swift/usage.mdx b/content/docs/ios-swift/usage.mdx index 27343eb..4ebcf50 100644 --- a/content/docs/ios-swift/usage.mdx +++ b/content/docs/ios-swift/usage.mdx @@ -23,7 +23,7 @@ let request = ReclaimVerification.Request.params( ) ) ``` -- You can get the `APP_ID` and `APP_SECRET` using [this guide](/api-key) +- You can get the `APP_ID` and `APP_SECRET` using [this guide](/api-key). - The `PROVIDER_ID` is the proof you want the user to generate. You can see all the [available providers here](https://dev.reclaimprotocol.org/explore). diff --git a/content/docs/js-sdk/generating-proof.mdx b/content/docs/js-sdk/generating-proof.mdx index 50909c6..ddae81f 100644 --- a/content/docs/js-sdk/generating-proof.mdx +++ b/content/docs/js-sdk/generating-proof.mdx @@ -4,7 +4,7 @@ description: Initiate the proof request to the user on the frontend --- # What is initiating a proof request? -In the [previous section](/preparing-request), you just built the request containing the information on what proof you want the user to generate. +In the [previous section](/js-sdk/preparing-request), you just built the request containing the information on what proof you want the user to generate. Now it is turn to actually ask the user to generate the proof. Depending on the user's device, browser and operating system, the SDK will pick the most seamless verification mechanism available for that user. Available options : diff --git a/content/docs/js-sdk/installation.mdx b/content/docs/js-sdk/installation.mdx index f039ac3..2812f3a 100644 --- a/content/docs/js-sdk/installation.mdx +++ b/content/docs/js-sdk/installation.mdx @@ -30,7 +30,7 @@ pnpm add @reclaimprotocol/js-sdk There are 3 steps in integrating the JavaScript SDK 1. [Preparing](preparing-request) the proof request on the backend 2. Asking the user to [generate](generating-proof) the proof on the frontend -3. Uploading the proof to the backend and [verifying](verifying-proof) it +3. Uploading the proof to the backend and [verifying](verifying-proofs) it This guide will walk you through each of these three steps. diff --git a/content/docs/react-native/install/expo.mdx b/content/docs/react-native/install/expo.mdx index af78107..de08cf9 100644 --- a/content/docs/react-native/install/expo.mdx +++ b/content/docs/react-native/install/expo.mdx @@ -89,7 +89,7 @@ npx eas-cli build --profile development --local ## Ready -With the above steps completed, try running your project on any iOS device. You can now continue with our [React Native Get Started Guide](react-native/installation#using_reclaim). +With the above steps completed, try running your project on any iOS device. You can now continue with our [React Native Get Started Guide](/react-native/installation#basic-usage). Please be aware of a known incompatibility between ReclaimInAppSdk and the [expo-dev-client](https://www.npmjs.com/package/expo-dev-client) package on the iOS platform. We recommend temporarily removing [expo-dev-client](https://www.npmjs.com/package/expo-dev-client) from your project when you need to test or use ReclaimInAppSdk functionality on iOS. From 2f99736fbc015cae03cc61d0ceabc8cff4ba94a4 Mon Sep 17 00:00:00 2001 From: hadi-saleh14 Date: Mon, 12 Jan 2026 19:40:42 +0800 Subject: [PATCH 2/2] update starter template --- content/docs/onchain/alephzero/index.mdx | 7 +- content/docs/onchain/aptos/index.mdx | 37 ++++---- content/docs/onchain/cardano/index.mdx | 24 +++--- content/docs/onchain/cosmos/index.mdx | 25 ++++-- content/docs/onchain/diamante/index.mdx | 26 ++++-- content/docs/onchain/fuel/index.mdx | 26 ++++-- content/docs/onchain/gear/index.mdx | 26 ++++-- content/docs/onchain/index.mdx | 102 +++++++++++------------ content/docs/onchain/lukso/index.mdx | 26 ++++-- content/docs/onchain/mina/index.mdx | 26 ++++-- content/docs/onchain/near/index.mdx | 26 ++++-- content/docs/onchain/polkadot/index.mdx | 26 ++++-- content/docs/onchain/solana/index.mdx | 26 ++++-- content/docs/onchain/solidity/index.mdx | 29 +++++-- content/docs/onchain/starknet/index.mdx | 26 ++++-- content/docs/onchain/stellar/index.mdx | 26 ++++-- content/docs/onchain/sui/index.mdx | 27 ++++-- content/docs/onchain/xion/index.mdx | 26 ++++-- 18 files changed, 375 insertions(+), 162 deletions(-) diff --git a/content/docs/onchain/alephzero/index.mdx b/content/docs/onchain/alephzero/index.mdx index 306a59c..27a709e 100644 --- a/content/docs/onchain/alephzero/index.mdx +++ b/content/docs/onchain/alephzero/index.mdx @@ -10,10 +10,9 @@ The Alephzero SDK allows you to integrate and verify Reclaim Protocol Proofs in 1. **Request Proofs** - Implement proof requests in your application using one of our official SDKs: - - [Reclaim React SDK](/web/frontend) for web applications + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations - [Reclaim React Native SDK](/react-native/installation) for mobile applications - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications - - [Reclaim Node SDK](/web/backend/installation) for backend implementations 2. **Handle Proof Upload** - Once the user successfully uploads their proof, store the proof identifier @@ -28,6 +27,4 @@ The Alephzero SDK allows you to integrate and verify Reclaim Protocol Proofs in - Handle the verification result according to your application logic ### Next Steps -- Review our [API Reference](/api-reference) for detailed implementation guidelines -- Check out our [Examples](/examples) section for practical implementation scenarios -- Join our [Developer Community](/community) for support and updates +After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. diff --git a/content/docs/onchain/aptos/index.mdx b/content/docs/onchain/aptos/index.mdx index 1304509..9f1adbf 100644 --- a/content/docs/onchain/aptos/index.mdx +++ b/content/docs/onchain/aptos/index.mdx @@ -6,32 +6,25 @@ description: The Reclaim Protocol Proofs are compatible with blockchain applicat ### Overview The Reclaim Protocol allows you to verify user data proofs on the Aptos blockchain. This integration enables decentralized verification of user-provided proofs through smart contracts. -### Integration Flow +### Implementation Flow -The integration process consists of four main steps: +1. **Request Proofs** + - Implement proof requests in your application using one of our official SDKs: + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations + - [Reclaim React Native SDK](/react-native/installation) for mobile applications + - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications -1. **Proof Request** - - Implement proof requests using one of our front-end libraries: - - [Reclaim React SDK](/web/frontend) - - [Reclaim React Native SDK](/react-native/installation) - - [Reclaim Flutter SDK](/flutter/installation) - - Alternatively, use our backend solution: - - [Reclaim Node SDK](/web/backend/installation) +2. **Handle Proof Upload** + - Once the user successfully uploads their proof, store the proof identifier + - Maintain proper record-keeping for subsequent verification -2. **Proof Management** - - Once the user uploads their proof, store the proof identifier - - Maintain necessary metadata for on-chain verification - - Ensure secure handling of proof data +3. **Submit for Verification** + - Transform the proof into its serialized format + - Submit the serialized proof to your designated smart contract -3. **Smart Contract Submission** - - Serialize the proof data in the required format - - Submit the serialized proof to your Aptos smart contract - - Handle any submission errors appropriately - -4. **On-chain Verification** - - Execute proof verification within your smart contract - - Process the verification results according to your application logic - - Implement appropriate error handling and fallback mechanisms +4. **Verify On-Chain** + - Execute the verification process within your smart contract + - Handle the verification result according to your application logic ### Next Steps After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. \ No newline at end of file diff --git a/content/docs/onchain/cardano/index.mdx b/content/docs/onchain/cardano/index.mdx index c2a007a..7473acd 100644 --- a/content/docs/onchain/cardano/index.mdx +++ b/content/docs/onchain/cardano/index.mdx @@ -9,20 +9,22 @@ Reclaim Protocol Proofs provide a secure way to verify user data in blockchain a ### Implementation Flow 1. **Request Proofs** - - Implement proof requests using one of our official SDKs: - - [JS SDK](/js-sdk/installation) for backend anf web implementations - - [React Native SDK](/react-native/installation) for mobile applications - - [Flutter SDK](/flutter/installation) for cross-platform applications + - Implement proof requests in your application using one of our official SDKs: + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations + - [Reclaim React Native SDK](/react-native/installation) for mobile applications + - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications 2. **Handle Proof Upload** - - Once the user uploads the proof, store the proof identifier or reference - - This reference will be needed for subsequent verification steps + - Once the user successfully uploads their proof, store the proof identifier + - Maintain proper record-keeping for subsequent verification -3. **Submit Proof to Smart Contract** - - Convert the proof into a blockchain-compatible format (serialization) +3. **Submit for Verification** + - Transform the proof into its serialized format - Submit the serialized proof to your designated smart contract -4. **Verify on-chain** - - The smart contract performs verification of the submitted proof - - Implement appropriate logic to handle verification results +4. **Verify On-Chain** + - Execute the verification process within your smart contract + - Handle the verification result according to your application logic +### Next Steps +After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. \ No newline at end of file diff --git a/content/docs/onchain/cosmos/index.mdx b/content/docs/onchain/cosmos/index.mdx index 7afef99..1befbad 100644 --- a/content/docs/onchain/cosmos/index.mdx +++ b/content/docs/onchain/cosmos/index.mdx @@ -3,10 +3,25 @@ title: Cosmos description: The Reclaim Protocol Proofs are compatible with blockchain applications. --- -### Flow +### Implementation Flow -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) -2. Once the user has uploaded the proof, you can serialize it into a CosmWasm friendly format -3. Submit the serialized proof to your smart contract -4. Verify the proof on the smart contract +1. **Request Proofs** + - Implement proof requests in your application using one of our official SDKs: + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations + - [Reclaim React Native SDK](/react-native/installation) for mobile applications + - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications +2. **Handle Proof Upload** + - Once the user successfully uploads their proof, store the proof identifier + - Maintain proper record-keeping for subsequent verification + +3. **Submit for Verification** + - Transform the proof into its serialized format + - Submit the serialized proof to your designated smart contract + +4. **Verify On-Chain** + - Execute the verification process within your smart contract + - Handle the verification result according to your application logic + +### Next Steps +After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. \ No newline at end of file diff --git a/content/docs/onchain/diamante/index.mdx b/content/docs/onchain/diamante/index.mdx index bb18890..349072f 100644 --- a/content/docs/onchain/diamante/index.mdx +++ b/content/docs/onchain/diamante/index.mdx @@ -3,9 +3,25 @@ title: Diamante description: The Reclaim Protocol Proofs are compatible with blockchain applications. --- -## Flow +### Implementation Flow -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) -2. Once the user has uploaded the proof, you can keep a note of it for on-chain verification -3. Submit the serialized proof to your smart contract -4. Verify the proof on the smart contract +1. **Request Proofs** + - Implement proof requests in your application using one of our official SDKs: + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations + - [Reclaim React Native SDK](/react-native/installation) for mobile applications + - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications + +2. **Handle Proof Upload** + - Once the user successfully uploads their proof, store the proof identifier + - Maintain proper record-keeping for subsequent verification + +3. **Submit for Verification** + - Transform the proof into its serialized format + - Submit the serialized proof to your designated smart contract + +4. **Verify On-Chain** + - Execute the verification process within your smart contract + - Handle the verification result according to your application logic + +### Next Steps +After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. \ No newline at end of file diff --git a/content/docs/onchain/fuel/index.mdx b/content/docs/onchain/fuel/index.mdx index 7813e5e..52a0dbb 100644 --- a/content/docs/onchain/fuel/index.mdx +++ b/content/docs/onchain/fuel/index.mdx @@ -3,9 +3,25 @@ title: Fuel description: The Reclaim Protocol Proofs are compatible with blockchain applications. --- -### Flow -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) -2. Once the user has uploaded the proof, you can serialize it into a Fuel friendly format -3. Submit the serialized proof to your smart contract -4. Verify the proof on the smart contract +### Implementation Flow +1. **Request Proofs** + - Implement proof requests in your application using one of our official SDKs: + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations + - [Reclaim React Native SDK](/react-native/installation) for mobile applications + - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications + +2. **Handle Proof Upload** + - Once the user successfully uploads their proof, store the proof identifier + - Maintain proper record-keeping for subsequent verification + +3. **Submit for Verification** + - Transform the proof into its serialized format + - Submit the serialized proof to your designated smart contract + +4. **Verify On-Chain** + - Execute the verification process within your smart contract + - Handle the verification result according to your application logic + +### Next Steps +After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. \ No newline at end of file diff --git a/content/docs/onchain/gear/index.mdx b/content/docs/onchain/gear/index.mdx index 51e20de..1bf2ef1 100644 --- a/content/docs/onchain/gear/index.mdx +++ b/content/docs/onchain/gear/index.mdx @@ -3,9 +3,25 @@ title: Gear description: The Reclaim Protocol Proofs are compatible with blockchain applications. --- -### Flow -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) -2. Once the user has uploaded the proof, you can serialize it into a CosmWasm friendly format -3. Submit the serialized proof to your smart contract -4. Verify the proof on the smart contract +### Implementation Flow +1. **Request Proofs** + - Implement proof requests in your application using one of our official SDKs: + - [Reclaim JS SDK](/js-sdk/installation) for web and backend implementations + - [Reclaim React Native SDK](/react-native/installation) for mobile applications + - [Reclaim Flutter SDK](/flutter/installation) for cross-platform applications + +2. **Handle Proof Upload** + - Once the user successfully uploads their proof, store the proof identifier + - Maintain proper record-keeping for subsequent verification + +3. **Submit for Verification** + - Transform the proof into its serialized format + - Submit the serialized proof to your designated smart contract + +4. **Verify On-Chain** + - Execute the verification process within your smart contract + - Handle the verification result according to your application logic + +### Next Steps +After understanding the basic flow, refer to our specific SDK documentation for detailed implementation guidelines and best practices. \ No newline at end of file diff --git a/content/docs/onchain/index.mdx b/content/docs/onchain/index.mdx index fe23ca3..ae52a84 100644 --- a/content/docs/onchain/index.mdx +++ b/content/docs/onchain/index.mdx @@ -25,23 +25,23 @@ import Blocks from 'lucide-react/dist/esm/icons/blocks' ### Integrate Reclaim Protocol in your products - } +} /> } + title="Aptos" + description="Integrate on Aptos" + href="onchain/aptos" + icon={} /> } + title="Cardano" + description="Integrate on Cardano" + href="onchain/cardano" + icon={} /> } /> } + title="Diamante" + description="Integrate on Diamante" + href="onchain/diamante" + icon={} + /> + } /> } /> + } + /> + } + /> } /> - } - /> - } - /> } + title="Solana" + description="Integrate on Solana" + href="onchain/solana" + icon={} /> } + title="Solidity" + description="Integrate on EVM" + href="onchain/solidity" + icon={} /> } /> } - /> - } + title="Stellar" + description="Integrate on Stellar" + href="onchain/stellar" + icon={} /> } + title="Sui" + description="Integrate on Sui" + href="onchain/sui" + icon={} />