@mojito-inc/loyalty-sdk/README.md

Core SDK for Mojito's Loyalty Platform

# Mojito Loyalty Core SDK

Welcome to the **Mojito Loyalty Platform SDK** — your all-in-one developer toolkit to integrate powerful loyalty mechanics directly into your Web App and Node.js API.

This SDK is your gateway to building engaging user experiences with missions, rewards, and real-time point systems — all while seamlessly interacting with Mojito’s platform APIs.

- 🔗 https://getmojito.com/loyalty
- 📚 Docs: https://loyaltydocs.getmojito.com/
- 📧 Support: dev-support@mojito.xyz


---


## ✨ Features

- 🔐 **User authentication**
- 🏆 **Retrieve leaderboard data**
- 🎯 **Access missions and rewards**
- 🧾 **Claim missions to earn points**
- 🎁 **Redeem and distribute rewards**

---


## 🔑 Getting Access

To use the SDK, generate your **API Key** by logging into the [Mojito Admin Portal](https://getmojito.com/loyalty).  
Go to the API section and generate your api key — you'll need it for all SDK calls.

---


## 📦 Installation

Install via **npm**:
```sh
npm install @mojito-inc/loyalty
```

Or via **yarn**:
```sh
yarn add @mojito-inc/loyalty
```

---


## 🚀 Usage

### 🔐 Authentication

**Set API Key**
```js
const sdk = new LoyaltyClient('prod');
sdk.auth.setApiKey('your-api-key-here');
```

**Fetch the sign Message for Web3 Wallet**
```js
const sdk = new LoyaltyClient('prod');
sdk.auth.fetchSignMessage('wallet-address', sdk.auth);
```

**Generate JWT from Web3 Wallet**
```js
const sdk = new LoyaltyClient('prod');
sdk.auth.generateJWT('wallet-address', 'signature', 'chain', 'message', sdk.auth);
```

**Use Existing JWT Token**
```js
const sdk = new LoyaltyClient('prod');
sdk.auth.setJWT('your-jwt-token');
```

---


### 🧾 Claims Management

**Initiate a Claim**
```js
let response = await sdk.claim.initiateClaim('mission-id', 'user-unique-address', sdk.auth);
```

**Fetch Claim Status**
```js
let response = await sdk.admin.getClaimStatus('tenant-slug', 'mission-id', 'user-unique-address', 'claim-id', sdk.auth);
```

---


### 🎁 Reward Redemption

**Initiate a Redeem**
```js
let response = await sdk.redeemption.initiateReward('reward-id', 'user-unique-address', 'wallet-address', sdk.auth);
```

---


### 📌 Missions and Rewards

**Fetch Mission by ID**
```js
let response = await sdk.admin.getMissions('mission-id', sdk.auth);
```

**Fetch Reward by ID**
```js
let response = await sdk.admin.getRewards('reward-id', sdk.auth);
```

---


## 📞 Contact & Support

- 📚 Docs: [https://loyaltydocs.getmojito.com/](https://loyaltydocs.getmojito.com/)
- 📧 Email: dev-support@mojito.xyz