Installing the Reclaim Protocol JavaScript SDK

Welcome to the first step in integrating Reclaim Protocol into your JavaScript project! This guide will walk you through the installation process and help you get started quickly.

Prerequisites

Before you begin, make sure you have:

• Node.js (version 14 or later) installed on your system
• npm (usually comes with Node.js) or yarn as your package manager

Installation Steps

1. Install the SDK

Open your terminal and navigate to your project directory. Then run one of the following commands:

Using npm:

npm install @reclaimprotocol/js-sdk

Using yarn:

yarn add @reclaimprotocol/js-sdk

This command will download and install the Reclaim Protocol SDK and its dependencies into your project.

2. Verify Installation

To ensure the SDK was installed correctly, you can check your package.json file. You should see @reclaimprotocol/js-sdk listed in the dependencies section.

Importing the SDK

After installation, you can import the SDK in your JavaScript or TypeScript files. Here's how:

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

For CommonJS environments, you can use:

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

Next Steps

Congratulations! You've successfully installed the Reclaim Protocol JavaScript SDK. Here's what you can do next:

1. Check out the Frontend Example (React) guide to create your first proof request.
2. Learn about Advanced Configuration options to customize the SDK for your needs.

If you encounter any issues during installation, please refer to our FAQ (opens in a new tab) or join our Telegram community (opens in a new tab) for support.

Happy coding with Reclaim Protocol!