@xw3/maki-quest
v0.1.129
Published
Xircus Quest SDK
Downloads
1,468
Readme
Xircus Maki Quest
Modern Web3 Application Kit for TON & Telegram
Quest UI Components and React Hooks
Uses @tanstack/react-query useQuery for queries and useMutation for functions
Installation
npm install @xw3/maki-quest
yarn add @xw3/maki-quest
Components
| Name | Description | |--- |--- | |QuestQuests | Displays all active quests | |QuestInfo | Displays quest name and desc by questId | |QuestTasks | Displays tasks by questId | |QuestItem | Renders quest item | |QuestFriends | Displays all friends | |QuestFriend | Displays friend card | |QuestLeaders | Displays all leaders | |QuestLeader | Displays leader card | |QuestCurrent | Displays current quest from settings | |QuestFriendsCount | Displays friend count | |QuestFarm | Displays a farm task | |QuestorPoints | Displays questor points | |FarmProgress | Displays a farm progress | |Leaderboard | Displays quest leaders | |CreateQuest | Quest Creation Form |
Hooks
| Name | Description |
|--- |--- |
|useQuests | Returns the quests by app |
|useQuest | Returns the quest by questId |
|useCurrentQuestor | Returns the questor by userId |
|useQuestor | Returns the questor by userId |
|useQuestorPoints | |
|useQuestorTickets | |
|useFarm | Generates a farm timer |
|usePacks | Returns all packs |
|useFriends | Returns the friends by questId |
|useFriendsCount | Returns the total friends by questId |
|useQuestorActions | Contains join, addPoints, addPointsDaily, addRefPoints |
|useQuestorFarm | Contains farm and verify mutation |
|useQuestorJoin | Instantly joins a quest by questId |
|useQuestorItems | Contains the questor items done or active by questId |
|useQuestSetting | Contains the app quest setting for farm, daily, rewards, etc |
|useReferralInvite | Instantly process the referral invite code |
|useReferror | Returns the referror by referral code |
|useQuestAdmin | Contains admin mutations |