Installation

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 installation, ensure your development environment meets these requirements:

Node.js version 14.x or later (LTS version recommended)
npm version 6.x or later (included with Node.js) or yarn version 1.22.x or later
A project directory initialized with package.json

To verify your installations:

node --version
npm --version # or yarn --version

Installation Steps

1. Install the SDK

Navigate to your project directory in the terminal:

cd your-project-directory

Choose one of the following commands based on your package manager:

Using npm:

npm install @reclaimprotocol/js-sdk

Using yarn:

yarn add @reclaimprotocol/js-sdk

2. Using the SDK

Import the SDK into your application using either ES modules or CommonJS syntax:

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

For CommonJS environments:

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

Get an API Key

Setup your project using the Get API Key guide.

Integrate into your project

You can integrate into your frontend using the Quickstart guide or Fullstack guide