Cloud Functions

Running the functions locally

cd functions

./node_modules/.bin/eslint src --fix

npm run-script build

firebase serve

checkIfUsernameAvailable

Allows authenticated user to check if username is available.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/checkIfUsernameAvailable

CURL

curl --location --request GET 'https://capx-gateway-5gijqs76.uc.gateway.dev/checkIfUsernameAvailable?username=@shreyas' \
--header 'Authorization: Bearer JWT_TOKEN'

checkInviteCode

Allows authenticated user to check if invite_code is valid.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/checkInviteCode

CURL

curl --location --request GET 'https://capx-gateway-5gijqs76.uc.gateway.dev/checkInviteCode?invite_code=XCAPX' \
--header 'Authorization: Bearer JWT_TOKEN'

updateUserProfile

Allows authenticated user to update their profile full name (or) image.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/updateUserProfile

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/updateUserProfile' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "name": "<name>",
    <!-- Optional -->
    "image_url": "<image_url>"
  }
}'

linkYourTwitter

Allows authenticated user to link their Twitter Account.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/linkYourTwitter

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/linkYourTwitter' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TWITTER_TOKEN' \
--data-raw '{
  "data" : {}
}'

linkYourGoogle

Allows authenticated user to link their Google Account.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/linkYourGoogle

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/linkYourGoogle' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer GOOGLE_TOKEN' \
--data-raw '{
  "data" : {}
}'

fetchLeaderboard

Allows authenticated user to fetch the leaderboard upto max_positions defined by the user, upper limit is 20. Default max_positions is 10.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/fetchLeaderboard

CURL

curl --location --request GET 'https://capx-gateway-5gijqs76.uc.gateway.dev/fetchLeaderboard' \
--header 'Authorization: Bearer JWT_TOKEN'

<!-- OR -->

curl --location --request GET 'https://capx-gateway-5gijqs76.uc.gateway.dev/fetchLeaderboard?max_positions=<number>' \
--header 'Authorization: Bearer JWT_TOKEN'

fetchWallet

Allows authenticated user to fetch the wallet details.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/fetchWallet

CURL

curl --location --request GET 'https://capx-gateway-5gijqs76.uc.gateway.dev/fetchWallet' \
--header 'Authorization: Bearer JWT_TOKEN'

createUser

Allows authenticated user to create their profile.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/createUser

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/createUser' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "name": "<name>",
	  "username" : "<username>",
    "invite_code" : "<invite_code>
  }
}'

createOrg

Creates an Organisation by authorized user.

URL : https://us-central1-capx-app.cloudfunctions.net/v1/createOrg

CURL

curl --location --request POST 'https://us-central1-capx-app.cloudfunctions.net/v1/createOrg' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "name" : "Capx",
    "description" : "Democratising Financial Markets",
    "tags" : ["DEFI","WVTs","DEX"],
    "website" : "https://capx.fi"
  }
}'

createQuest

Creates a Quest for an underlying organisation by an authorized user.

URL : https://us-central1-capx-app.cloudfunctions.net/v1/createQuest

CURL

curl --location --request POST 'https://us-central1-capx-app.cloudfunctions.net/v1/createQuest' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "type" : "Daily/ Special / Daily_Reward"
    "title" : "Connect Twitter",
    "description": "Link your Twitter acount with Capx App.",
    "cta_title" : "Connect your Twitter Account",
    "rewards_type": "Level",
    "reward": "1",
    "expiry": "2022-12-25",
    "quest_type" : "Special / Daily / DailyReward",
    "quest_day" : "DAY<number>",
    <!-- "start_date" : "date" (incase of Action Type `Notify` (or) incase the Quest type is `Special` type.) -->
    "launch_day_period" : <number>
    "actions" : [
      {
        "title" : "Watch Video",
        "type" : "Video",
        "cta_title" : "Watch Video & Earn Rewards",
        "media_link" : "https://link",
        "action_reward_amount" : <number>
      }
    ],
    "tags" : ["Twitter","Social Media"]
  }
}'

Types of Action Object

Quest Type - Daily | ActionType - Quiz

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Quiz",
  "question" : "<string>",
  "answer" : "<string>",
  "options" : ["<string>",...],
  "action_reward_amount" : <number>
}

Quest Type - Daily | ActionType - Social_Twitter

checkIfUserFollows - Check if a user follows a particular twitter account.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "checkIfUserFollows",
  "twitter_id_to_follow" : "<string>",
  "action_reward_amount" : <number>
}

checkIfUserLikedTweet - Check if a user has liked a particular tweet.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "checkIfUserLikedTweet",
  "tweet_url" : "<string>",
  "action_reward_amount" : <number>
}

checkIfUserQuoted - Check if a user has tweet quoted on a particular tweet.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "checkIfUserQuoted",
  "tweet_url" : "<string>",
  "action_reward_amount" : <number>
}

checkIfUserCommented - Check if a user has commented on a particular tweet.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "checkIfUserCommented",
  "tweet_url" : "<string>",
  "action_reward_amount" : <number>
}

checkIfUserRetweeted - Check if a user has retweeted on a particular tweet.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "checkIfUserRetweeted",
  "tweet_url" : "<string>",
  "action_reward_amount" : <number>
}

checkUserTweet - Check if a user tweet contains the required strings.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "checkUserTweet",
  "tweet_strings": ["<string>"],
  "action_reward_amount" : <number>
}

info - Provides the information corresponding to twitter task.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Twitter",
  "verification_engine" : "info",
  "info_details": [{"<string>": "<string>" (or) ["strings"]}],
  "action_reward_amount" : <number>
}

Quest Type - Daily | ActionType - Social_Discord

checkUserJoined - Checks if a user has joined a server.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Discord",
  "verification_engine" : "checkUserJoined",
  "guild_id" : "<server_id>",
  "action_reward_amount" : <number>
}

checkUserReacted - Checks if a user has reacted with a particular emoji on a particular message in a particular channel on a server.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Discord",
  "verification_engine" : "checkUserReacted",
  "guild_id" : "<server_id>",
  "channel_id" : "<channel_id>",
  "message_id" : "<message_id>",
  "emoji" : "<emoji>" ,
  "action_reward_amount" : <number>
}

checkUserHasRole - Checks if a user has a particular role in a server.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Discord",
  "verification_engine" : "checkUserHasRole",
  "guild_id" : "<server_id>",
  "role" : "<role>",
  "action_reward_amount" : <number>
}

checkUserMessage - Checks if a user has a certain message in a particular channel in a particular server.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Discord",
  "verification_engine" : "checkUserMessage",
  "guild_id" : "<server_id>",
  "channel_id" : "<channel_id>",
  "message" : "<string>",
  "action_reward_amount" : <number>
}

checkUserInVoice - Checks if a user has a joined a particular voice channel in a particular server.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Discord",
  "verification_engine" : "checkUserInVoice",
  "guild_id" : "<server_id>",
  "channel_id" : "<channel_id>",
  "action_reward_amount" : <number>
}

checkUserSubscribedToEvent - Checks if a user has a joined a particular voice channel in a particular server.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Social_Discord",
  "verification_engine" : "checkUserSubscribedToEvent",
  "guild_id" : "<server_id>",
  "event_id" : "<channel_id>",
  "action_reward_amount" : <number>
}

Quest Type - Daily | ActionType - Video

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Video",
  "media_link" : "<video_url>",
  "action_reward_amount" : <number>
}

Quest Type - Daily | ActionType - Notify

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Notify",
  "notification_type" : "Affiliate / Meme",
  "action_reward_amount" : <number>
}

Quest Type - Special | ActionType - Generate_Invite_Code

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Generate_Invite_Code",
  "verification_engine" : "generateInviteCode",
  "action_reward_amount" : <number>
}

Quest Type - Daily | ActionType - Verify_Invite_Code

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Verify_Invite_Code",
  "verification_engine" : "verifyInviteCode",
  "action_reward_amount" : <number>
}

Quest Type - Daily | ActionType - CheckProfile

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "CheckProfile",
  "verification_engine" : "checkUserProfile",
  "to_check" : [
    "Profile Name",
    "Profile Picture",
    "Connect your Twitter",
    "Connect your Google Account"
  ],
  "action_reward_amount" : <number>
}

Quest Type - Special | ActionType - BuildProfile

updateFullName - Updates the full name of an authenticated user.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "BuildProfile",
  "verification_engine" : "updateFullName",
  "action_reward_amount" : <number>
}

updateProfileImage - Updates the profile image of an authenticated user.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "BuildProfile",
  "verification_engine" : "updateProfileImage",
  "action_reward_amount" : <number>
}

linkTwitter - Links the Twitter account of an authenticated user.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "BuildProfile",
  "verification_engine" : "linkTwitter",
  "action_reward_amount" : <number>
}

linkDiscord - Links the Discord account of an authenticated user.

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "BuildProfile",
  "verification_engine" : "linkDiscord",
  "action_reward_amount" : <number>
}

Quest Type - DailyReward | ActionType - Daily_Reward

{
  "title" : "<string>",
  "cta_title" : "<string>",
  "type": "Daily_Reward",
  "action_reward_amount" : <number>
}

registerForQuest

Register for a Quest for an underlying organisation by an authorized user.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/registerForQuest

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/registerForQuest' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "questId": "<quest_id>",
  }
}'

completeAction

Allows an authorized user to complete an action for a registered quest.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/completeAction

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/completeAction' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "action_order_id": "<action_order_id>",
    <!-- Optional -->
    "email": "<email>", <!-- Incase of `Notify` Action Type -->
    "answer": "<answer>" <!-- Incase of `Quiz` Action Type -->
    "tweet_url": "<tweet_url>" <!-- Incase of `Social_Twitter` Action Type -->
    "name" : "<string>" <!-- Incase of `BuildProfile` Action Type & `updateFullName` engine type.-->
    "image_url" : "<string>" <!-- Incase of `BuildProfile` Action Type & `updateProfileImage` engine type.-->
  }
}'

claimReward

Allows an authorized user to claim reward a registered quest.

URL : https://capx-gateway-5gijqs76.uc.gateway.dev/claimReward

CURL

curl --location --request POST 'https://capx-gateway-5gijqs76.uc.gateway.dev/claimReward' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JWT_TOKEN' \
--data-raw '{
  "data" : {
    "action_order_id": "<action_order_id>",
    <!-- OR -->
    "quest_order_id" : "<quest_order_id>
  }
}'

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
api-gateway		api-gateway
functions		functions
README.md		README.md
firebase.json		firebase.json
firestore-debug.log		firestore-debug.log
firestore.indexes.json		firestore.indexes.json
firestore.rules		firestore.rules
package-lock.json		package-lock.json
package.json		package.json
ui-debug.log		ui-debug.log

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Cloud Functions

Running the functions locally

checkIfUsernameAvailable

checkInviteCode

updateUserProfile

linkYourTwitter

linkYourGoogle

fetchLeaderboard

fetchWallet

createUser

createOrg

createQuest

Types of Action Object

Quest Type - Daily | ActionType - Quiz

Quest Type - Daily | ActionType - Social_Twitter

Quest Type - Daily | ActionType - Social_Discord

Quest Type - Daily | ActionType - Video

Quest Type - Daily | ActionType - Notify

Quest Type - Special | ActionType - Generate_Invite_Code

Quest Type - Daily | ActionType - Verify_Invite_Code

Quest Type - Daily | ActionType - CheckProfile

Quest Type - Special | ActionType - BuildProfile

Quest Type - DailyReward | ActionType - Daily_Reward

registerForQuest

completeAction

claimReward

About

Releases

Packages

Languages

Capx-Fi/Capx-App-Backend-Beta

Folders and files

Latest commit

History

Repository files navigation

Cloud Functions

Running the functions locally

checkIfUsernameAvailable

checkInviteCode

updateUserProfile

linkYourTwitter

linkYourGoogle

fetchLeaderboard

fetchWallet

createUser

createOrg

createQuest

Types of Action Object

Quest Type - Daily | ActionType - Quiz

Quest Type - Daily | ActionType - Social_Twitter

Quest Type - Daily | ActionType - Social_Discord

Quest Type - Daily | ActionType - Video

Quest Type - Daily | ActionType - Notify

Quest Type - Special | ActionType - Generate_Invite_Code

Quest Type - Daily | ActionType - Verify_Invite_Code

Quest Type - Daily | ActionType - CheckProfile

Quest Type - Special | ActionType - BuildProfile

Quest Type - DailyReward | ActionType - Daily_Reward

registerForQuest

completeAction

claimReward

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages