[Feat] Add reward claiming for other reward types (#927)

* add reward claiming for other reward types

* prettier

* update urls and types

* fix typo

* add quest playstreak GET, refactor claims to separate modules

* fix screen quest playstreak

* add resync tasks mutation

* use mutate for other claims

* fix claimPoints

* fix quest fetch

* clear playstreak cache after claim

* update log

* update quest details, add chain name and num to claim to rewards

* fix lint

* use prod dev portal url

* rm console logs

* update fetch with cookie

* update hp ui

* add LD quest claim cta flag

* show current streak = required streak when current > required, refactor to shared fxn

* add gamesToShowQuestsFor LD flag for quest overlay and main window page

* fix wagmi urls, add polygon

* [Feat] Add ERC721 and ERC1155 reward claiming (#936)

* add erc1155 claiming

* get sig for 1155 token id

* add erc721 minting

* fix 721 call args

* handle null decimals and chain_id, fix show sync button

* fix fetch with cookie

* pretty

* fix decimals check

* improve fetch error logs

* rm empty comment

* bump version

Author: BrettCleary

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperplay",
-  "version": "0.15.2",
+  "version": "0.15.3",
   "private": true,
   "main": "build/main/main.js",
   "homepage": "./",
@@ -167,9 +167,10 @@
     "@fortawesome/free-regular-svg-icons": "^6.1.1",
     "@fortawesome/free-solid-svg-icons": "^6.1.1",
     "@fortawesome/react-fontawesome": "^0.1.18",
+    "@hyperplay/chains": "^0.2.10",
     "@hyperplay/check-disk-space": "^3.5.2",
-    "@hyperplay/ui": "^1.5.9",
-    "@hyperplay/utils": "^0.0.14",
+    "@hyperplay/ui": "^1.5.28",
+    "@hyperplay/utils": "^0.0.16",
     "@mantine/carousel": "^7.5.1",
     "@mantine/core": "^7.5.1",
     "@mantine/dropzone": "^7.5.1",

src/backend/api/questsAchievements.ts

@@ -24,14 +24,26 @@ export const getQuests = async (projectId?: string) =>
 export const getQuest = async (questId: number) =>
   ipcRenderer.invoke('getQuest', questId)
 
+export const getUserPlayStreak = async (questId: number) =>
+  ipcRenderer.invoke('getUserPlayStreak', questId)
+
 export const getSteamGameMetadata = async (gameId: number) =>
   ipcRenderer.invoke('getSteamGameMetadata', gameId)
 
 export const getQuestRewardSignature = async (
   address: `0x${string}`,
-  questId: number,
-  rewardId: number
-) => ipcRenderer.invoke('getQuestRewardSignature', address, questId, rewardId)
+  rewardId: number,
+  tokenId?: number
+) => ipcRenderer.invoke('getQuestRewardSignature', address, rewardId, tokenId)
 
 export const getDepositContracts = async (questId: number) =>
   ipcRenderer.invoke('getDepositContracts', questId)
+
+export const claimQuestPointsReward = async (rewardId: string) =>
+  ipcRenderer.invoke('claimQuestPointsReward', rewardId)
+
+export const completeExternalTask = async (rewardId: string) =>
+  ipcRenderer.invoke('completeExternalTask', rewardId)
+
+export const resyncExternalTask = async (rewardId: string) =>
+  ipcRenderer.invoke('resyncExternalTask', rewardId)

src/backend/ipcHandlers/achievements.ts

@@ -244,10 +244,10 @@ ipcMain.handle('getSyncProgress', async (e, requestId) => {
 
 async function getQuestRewardSignature(
   address: `0x${string}`,
-  questId: number,
-  rewardId: number
+  rewardId: number,
+  tokenId?: number
 ): Promise<RewardClaimSignature> {
-  const url = `${DEV_PORTAL_URL}api/v1/quests/${questId}/rewards/${rewardId}/signature`
+  const url = `${DEV_PORTAL_URL}api/v1/quests/rewards/${rewardId}/signature`
 
   const cookieString = await getPartitionCookies({
     partition: 'persist:auth',
@@ -261,9 +261,15 @@ async function getQuestRewardSignature(
     },
     body: JSON.stringify({
       withdraw: true,
-      address
+      address,
+      tokenId
     })
   })
+  if (!result.ok) {
+    const errMsg = await result.text()
+    logError(errMsg, LogPrefix.HyperPlay)
+    throw errMsg
+  }
   const resultJson = await result.json()
   return resultJson
 }

src/backend/ipcHandlers/quests.ts

@@ -1,4 +1,6 @@
+import { fetchWithCookie } from 'backend/utils/fetch_with_cookie'
 import { DEV_PORTAL_URL } from 'common/constants'
+import { GenericApiResponse, PointsClaimReturn } from 'common/types'
 import { ipcMain } from 'electron'
 
 ipcMain.handle('getQuests', async (e, projectId) => {
@@ -17,8 +19,31 @@ ipcMain.handle('getQuest', async (e, questId) => {
   return questResultJson
 })
 
+ipcMain.handle('getUserPlayStreak', async (e, questId) => {
+  const questResultJson = await fetchWithCookie({
+    url: `${DEV_PORTAL_URL}api/v1/quests/${questId}/playstreak`,
+    method: 'GET'
+  })
+  return questResultJson
+})
+
 ipcMain.handle('getSteamGameMetadata', async (e, gameId) => {
   const result = await fetch(`${DEV_PORTAL_URL}api/v1/steam/games/${gameId}`)
   const resultJson = await result.json()
   return resultJson
 })
+
+ipcMain.handle('claimQuestPointsReward', async (e, rewardId) => {
+  const url = `${DEV_PORTAL_URL}api/v1/quests/rewards/${rewardId}/points-claim`
+  return (await fetchWithCookie({ url, method: 'POST' })) as PointsClaimReturn
+})
+
+ipcMain.handle('completeExternalTask', async (e, rewardId) => {
+  const url = `${DEV_PORTAL_URL}api/v1/quests/rewards/${rewardId}/external-tasks/completed`
+  return (await fetchWithCookie({ url, method: 'POST' })) as GenericApiResponse
+})
+
+ipcMain.handle('resyncExternalTask', async (e, rewardId) => {
+  const url = `${DEV_PORTAL_URL}api/v1/quests/rewards/${rewardId}/external-tasks/re-sync`
+  return (await fetchWithCookie({ url, method: 'POST' })) as GenericApiResponse
+})

src/backend/main.ts

@@ -2004,9 +2004,11 @@ function watchLibraryChanges() {
   sideloadLibraryStore.onDidChange('games', (newValue) =>
     sendFrontendMessage('onLibraryChanged', 'sideload', newValue)
   )
-  hpLibraryStore.onDidChange('games', (newValue) =>
-    sendFrontendMessage('onLibraryChanged', 'hyperplay', newValue)
-  )
+  hpLibraryStore.onDidChange('games', (newValue) => {
+    for (const win of BrowserWindow.getAllWindows()) {
+      win.webContents.send('onLibraryChanged', 'hyperplay', newValue)
+    }
+  })
 }
 
 ipcMain.on('openGameInEpicStore', async (_e, url) => {

src/backend/utils/fetch_with_cookie.ts

@@ -0,0 +1,29 @@
+import { DEV_PORTAL_URL } from 'common/constants'
+import getPartitionCookies from './get_partition_cookies'
+
+export async function fetchWithCookie({
+  url,
+  method,
+  partition
+}: {
+  url: string
+  method: string
+  partition?: string
+}) {
+  const cookieString = await getPartitionCookies({
+    partition: partition ?? 'persist:auth',
+    url: DEV_PORTAL_URL
+  })
+
+  const response = await fetch(url, {
+    method: method,
+    headers: {
+      Cookie: cookieString
+    }
+  })
+  if (!response.ok) {
+    throw await response.text()
+  }
+  const resultJson = await response.json()
+  return resultJson
+}

src/common/typedefs/ipcBridge.d.ts

@@ -4,7 +4,9 @@ import {
   Achievement,
   SummaryAchievement,
   LDEnv,
-  HyperPlayRelease
+  HyperPlayRelease,
+  PointsClaimReturn,
+  GenericApiResponse
 } from './../types'
 import { EventEmitter } from 'node:events'
 import { IpcMainEvent, OpenDialogOptions } from 'electron'
@@ -272,14 +274,18 @@ interface HyperPlayAsyncIPCFunctions {
   updateAutoLaunch: () => Promise<void>
   getQuests: (projectId?: string) => Promise<Quest[]>
   getQuest: (questId: number) => Promise<Quest>
+  getUserPlayStreak: (questId: number) => Promise<UserPlayStreak>
   getSteamGameMetadata: (gameId: number) => Promise<unknown>
   getHyperPlayListings: () => Promise<Record<string, HyperPlayRelease>>
   getQuestRewardSignature: (
     address: `0x${string}`,
-    questId: number,
-    rewardId: number
+    rewardId: number,
+    tokenId?: number
   ) => Promise<RewardClaimSignature>
   getDepositContracts: (questId: number) => Promise<DepositContract[]>
+  claimQuestPointsReward: (rewardId: string) => Promise<PointsClaimReturn>
+  completeExternalTask: (rewardId: string) => Promise<GenericApiResponse>
+  resyncExternalTask: (rewardId: string) => Promise<GenericApiResponse>
 }
 
 interface AsyncIPCFunctions extends HyperPlayAsyncIPCFunctions {

src/common/types.ts

@@ -903,15 +903,15 @@ export type OverlayType = 'native' | 'browser' | 'mainWindow'
 
 export interface Reward {
   id: number
-  amount_per_user: number
-  chain_id: number
+  amount_per_user: number | null
+  chain_id: number | null
   marketplace_url: string | null
-  reward_type: 'ERC20' | 'ERC721' | 'ERC1155'
+  reward_type: 'ERC20' | 'ERC721' | 'ERC1155' | 'POINTS' | 'EXTERNAL-TASKS'
   name: string
   contract_address: `0x${string}`
-  decimals: number
+  decimals: number | null
   /* eslint-disable-next-line */
-  token_ids: any[]
+  token_ids: { amount_per_user: string; token_id: number }[]
   image_url: string
 }
 
@@ -930,8 +930,6 @@ export interface Quest {
     steam_games: { id: string }[]
     play_streak: {
       required_playstreak_in_days: number
-      current_playstreak_in_days?: number
-      last_play_session_completed_datetime_utc?: string
     }
   }
 }
@@ -946,3 +944,23 @@ export interface DepositContract {
   contract_address: `0x${string}`
   chain_id: number
 }
+
+export interface GenericApiResponse {
+  status?: string
+  message: string
+}
+
+export interface PointsClaimReturn {
+  // sent on error
+  status?: string
+  message?: string
+  // sent on success
+  success?: string
+}
+
+export interface UserPlayStreak {
+  current_playstreak_in_days: number
+  completed_counter: number
+  accumulated_playtime_today_in_seconds: number
+  last_play_session_completed_datetime: string
+}

src/frontend/OverlayManager/Overlay/index.tsx

@@ -12,6 +12,7 @@ import { BrowserGameProps } from '../types'
 import { Button } from '@hyperplay/ui'
 import { QuestsViewer } from 'frontend/components/UI/QuestsViewer'
 import { useFlags } from 'launchdarkly-react-client-sdk'
+import libraryState from 'frontend/state/libraryState'
 
 export const Overlay = observer(function ({
   appName,
@@ -110,7 +111,12 @@ export const Overlay = observer(function ({
     }
 
     let questsViewer = null
-    if (flags.questsOverlayClaimModals) {
+    const gamesToShowQuestsFor =
+      (flags.gamesToShowQuestsFor as string | undefined)?.split(',') ?? []
+    if (
+      flags.questsOverlayClaimModals ||
+      libraryState.hasGame(gamesToShowQuestsFor)
+    ) {
       questsViewer = <QuestsViewer projectId={appName} />
     }