Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions CRIP/CRIP-ZomatoTotalOrders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
| proposal | title | description | author | discussions-to | status | type | category | created | requires |
|----------|-------------------------|-----------------------------------------------------|---------------------------|----------------|--------|-------------|----------|------------|----------|
| CRIP-3 | Zomato Total Orders | Integration with Zomato API to verify the total number of orders | Ritik Bhatt <[email protected]> | | Draft | Integration | CRIP | 2024-07-07 | |

## Title

Zomato Total Orders Integration

## Introduction

This proposal outlines the integration of Zomato as a data provider for the Catoff-Reclaim integration project. The integration aims to retrieve and process the total number of orders data from Zomato, allowing users to validate their order history on the Catoff platform. This will enable users to use their Zomato order data for various challenges and verifications on Catoff.

## External APIs Needed

- Zomato API: Zomato doesn't have a public API, so the integration will use data extraction methods from the Zomato app/web.

## Use Cases

1. **User Verification**: Verify the total number of orders of users on Zomato.
2. **Challenge Participation**: Allow users to participate in challenges that require proof of their total Zomato order count.
3. **Purchase History**: Validate users' purchase history based on their Zomato order data.

## Data Provider

- **Name**: Zomato Total Orders
- **Hash Value**: 0xead50bf0e5ac604b58060993a9f8f27f6dc1d497be2212111c5582b30de61f7f

## Code Snippet

Below is a code snippet that demonstrates the key parts of the Zomato integration. The full implementation should follow the service file template.

**`services/ZomatoTotalOrdersService.js`**

```javascript
const { ReclaimServiceResponse } = require('../utils/reclaimServiceResponse');

exports.processZomatoData = async (proof, providerName) => {
console.log("Proof is: ", proof[0]);

const extractedParameters = JSON.parse(proof[0].claimData.context).extractedParameters;
const numberOfOrders = extractedParameters.ordersCount;
const lastUpdateTimeStamp = proof[0].claimData.timestampS;

console.log('Total Number of orders are: ', numberOfOrders);

return new ReclaimServiceResponse(
providerName,
lastUpdateTimeStamp,
'username',
numberOfOrders,
proof[0]
);
};
2 changes: 2 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ const express = require('express')
const bodyParser = require('body-parser')
const reclaimController = require('./src/controllers/reclaimController')

require('dotenv').config();

const app = express()
app.use(bodyParser.json())

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"@reclaimprotocol/js-sdk": "^1.3.6",
"axios": "^1.7.2",
"body-parser": "^1.20.2",
"chess-web-api": "^1.2.0",
"dotenv": "^16.4.5",
"express": "^4.19.2"
},
Expand Down
19 changes: 19 additions & 0 deletions src/services/ZomatoTotalOrdersService.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const { ReclaimServiceResponse } = require('../utils/reclaimServiceResponse');

exports.processZomatoData = async (proof, providerName) => {
console.log("Proof is: ", proof[0]);

const extractedParameters = JSON.parse(proof[0].claimData.context).extractedParameters;
const numberOfOrders = extractedParameters.ordersCount;
const lastUpdateTimeStamp = proof[0].claimData.timestampS;

console.log('Total Number of orders are: ', numberOfOrders);

return new ReclaimServiceResponse(
providerName,
lastUpdateTimeStamp,
'username',
numberOfOrders,
proof[0]
);
};
16 changes: 11 additions & 5 deletions src/services/reclaimService.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const { Reclaim } = require('@reclaimprotocol/js-sdk')
const { RECLAIM_PROVIDER_ID, RECLAIM_APP_ID } = require('../utils/constants')
const { processTwitterData } = require('./twitterService')
const { processGitHubData } = require('./githubService')
const { processZomatoData } = require('./ZomatoTotalOrdersService')

exports.signWithProviderID = async (userId, providerId) => {
const providerName = RECLAIM_PROVIDER_ID[providerId]
Expand All @@ -13,11 +14,11 @@ exports.signWithProviderID = async (userId, providerId) => {
`Sending signature request to Reclaim for userId: ${userId} with providerName: ${providerName}`
)

try {
const reclaimClient = new Reclaim.ProofRequest(reclaimAppID)
await reclaimClient.buildProofRequest(providerId)
try {
const reclaimClient = new Reclaim.ProofRequest('0xD2bD98049dE5B8b4AD1BD2643a85992e13E4bf34')
await reclaimClient.buildProofRequest('6cadc27b-72cd-4c12-87de-9198fd24456e')
reclaimClient.setSignature(
await reclaimClient.generateSignature(reclaimAppSecret)
await reclaimClient.generateSignature('0xca30be77c4c2d796fab31489ba7b4388e87377df92621b4505986efd45e7a656')
)
const { requestUrl: signedUrl } =
await reclaimClient.createVerificationRequest()
Expand All @@ -34,6 +35,7 @@ exports.signWithProviderID = async (userId, providerId) => {
}

const handleReclaimSession = async (userId, reclaimClient, providerName) => {
console.log('Starting session')
await reclaimClient.startSession({
onSuccessCallback: async proof => {
console.log(
Expand All @@ -49,6 +51,9 @@ const handleReclaimSession = async (userId, reclaimClient, providerName) => {
case 'GITHUB_ACCOUNT_VERIFICATION':
processedData = await processGitHubData(proof, providerName)
break
case 'ZOMATO_ACCOUNT_VERIFICATION':
processedData = await processZomatoData(proof, providerName);
break
default:
throw new Error(`No handler for provider: ${providerName}`)
}
Expand All @@ -65,4 +70,5 @@ const handleReclaimSession = async (userId, reclaimClient, providerName) => {
console.error(`Verification failed for userId: ${userId}`, error)
},
})
}
console.log('Ended session')
}
8 changes: 8 additions & 0 deletions src/utils/constants.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
exports.RECLAIM_PROVIDER_ID = {
twitter: 'TWITTER_ANALYTICS_VIEWS',
github: 'GITHUB_ACCOUNT_VERIFICATION',
zomato: 'ZOMATO_ACCOUNT_VERIFICATION'
}

exports.RECLAIM_APP_ID = {
TWITTER_ANALYTICS_VIEWS: 'your-twitter-app-id',
GITHUB_ACCOUNT_VERIFICATION: 'your-github-app-id',
ZOMATO_ACCOUNT_VERIFICATION: 'your-zomato-app-id'
}

exports.PROVIDER_ID = {
twitter: 'twitter-provider-id',
github: 'github-provider-id',
zomato: 'zomato-provider-id'
}