Installation

Prerequisites

Before starting, ensure you have the following requirements installed:

• Node.js (version 14.0.0 or later)
• npm (Node Package Manager, included with Node.js) or yarn
• A working React Native project
  • If you haven't created one, follow the official React Native CLI Quickstart

Note: Make sure your React Native project is properly configured and can run successfully before installing the SDK.

Installation

1. Install the SDK

Navigate to your React Native project's root directory and execute one of the following commands:

Using npm:

npm install @reclaimprotocol/reactnative-sdk

Using yarn:

yarn add @reclaimprotocol/reactnative-sdk

2. Installation Verification

Verify the installation by:

1. Checking your package.json file for:

   "dependencies": {
     "@reclaimprotocol/reactnative-sdk": "^x.x.x"
   }

2. Ensuring no error messages appeared during installation

Implementation

Importing the SDK

Import the SDK in your JavaScript/TypeScript files using either of these methods:

ES6+ syntax (recommended):

import { ReclaimProofRequest } from '@reclaimprotocol/reactnative-sdk';

CommonJS syntax:

const { ReclaimProofRequest } = require('@reclaimprotocol/reactnative-sdk');

Next Steps

Now that you've installed the SDK successfully, you can:

1. Follow the Basic Example guide to create your first proof request
2. Explore Advance Options options for customization
3. Review best practices and implementation patterns

Need Help?

If you encounter any issues:

• Check our comprehensive FAQ
• Join our Telegram community for real-time support
• Review the troubleshooting section in our documentation

Tip: Keep your SDK version up to date by regularly checking for updates using npm outdated or yarn outdated.