add beacon nft verify endpoints

Author: alecananian

.env.example

@@ -1,3 +1,4 @@
 COINGECKO_API_KEY=
 GOLDSKY_PROJECT_ID=
 THIRDWEB_CLIENT_ID=
+TROVE_API_KEY=

.github/workflows/deploy.yaml

@@ -30,3 +30,4 @@ jobs:
           COINGECKO_API_KEY: ${{ secrets.COINGECKO_API_KEY }}
           GOLDSKY_PROJECT_ID: ${{ secrets.GOLDSKY_PROJECT_ID }}
           THIRDWEB_CLIENT_ID: ${{ secrets.THIRDWEB_CLIENT_ID }}
+          TROVE_API_KEY: ${{ secrets.TROVE_API_KEY }}

serverless.yml

@@ -12,6 +12,7 @@ provider:
     COINGECKO_API_KEY: ${env:COINGECKO_API_KEY}
     GOLDSKY_PROJECT_ID: ${env:GOLDSKY_PROJECT_ID}
     THIRDWEB_CLIENT_ID: ${env:THIRDWEB_CLIENT_ID}
+    TROVE_API_KEY: ${env:TROVE_API_KEY}
 
 package:
   individually: true
@@ -87,3 +88,16 @@ functions:
       - httpApi:
           path: /bridgeworld/harvesters/{id}/verify
           method: post
+  # /beacon
+  verifyFoundingCharacterHolders:
+    handler: src/handlers/beacon.verifyFoundingCharacterHolders
+    events:
+      - httpApi:
+          path: /beacon/founding-characters/verify
+          method: post
+  verifyPetHolders:
+    handler: src/handlers/beacon.verifyPetHolders
+    events:
+      - httpApi:
+          path: /beacon/pets/verify
+          method: post

src/constants.js

@@ -2,6 +2,10 @@ module.exports = {
   // Addresses
   BURN_ADDRESS: "0x0000000000000000000000000000000000000000",
   CONTRACT_ADVANCED_QUESTING: "0x737eaf14061fe68f04ff4ca8205acf538555fcc8",
+  CONTRACT_BEACON: "0x990eb28e378659b93a29d46ff41f08dc6316dd98",
+  CONTRACT_BEACON_PETS_STAKING_RULES:
+    "0x2c6c166832a4b5a501dd7a4b7acc8e13fb6968ec",
+  CONTRACT_BEACON_QUESTING: "0xd58d40a9a1aaeebd48a90bbb8197e0772d0e9b51",
   CONTRACT_CORRUPTION: "0x6b66d774a862539f84128f171db1940302c4671e",
   CONTRACT_CRAFTING: "0xb9c9ed651eb173ca7fbc3a094da9ce33ec145a29",
   CONTRACT_MAGIC: "0x539bde0d7dbd336b79148aa742883198bbf60342",

src/contracts/beaconPetsStakingRules.js

@@ -0,0 +1,12 @@
+const { Contract } = require("@ethersproject/contracts");
+const { CONTRACT_BEACON_PETS_STAKING_RULES } = require("../constants");
+const { arbitrumProvider } = require("../utils/provider");
+
+const beaconPetsStakingRules = new Contract(
+  CONTRACT_BEACON_PETS_STAKING_RULES,
+  ["function beaconPetsAmountStaked(address) view returns (uint256)"],
+  arbitrumProvider
+);
+
+exports.getBeaconPetsAmountStaked =
+  beaconPetsStakingRules.beaconPetsAmountStaked;

src/contracts/beaconQuesting.js

@@ -0,0 +1,11 @@
+const { Contract } = require("@ethersproject/contracts");
+const { CONTRACT_BEACON_QUESTING } = require("../constants");
+const { arbitrumProvider } = require("../utils/provider");
+
+const beaconQuesting = new Contract(
+  CONTRACT_BEACON_QUESTING,
+  ["function getUserQuests(address) view returns (uint128,uint128,uint128)"],
+  arbitrumProvider
+);
+
+exports.getUserQuests = beaconQuesting.getUserQuests;

src/handlers/beacon.js

@@ -0,0 +1,26 @@
+const { hasFoundingCharacter, hasPet } = require("../services/beacon");
+
+exports.verifyFoundingCharacterHolders = async (event) => {
+  const body = JSON.parse(event.body);
+  const wallets = (body.wallets || body.wallet || []).map((wallet) =>
+    wallet.toLowerCase()
+  );
+  console.log(
+    "Querying Beacon Founding Character holder status for wallets:",
+    wallets
+  );
+  return {
+    success: await hasFoundingCharacter(wallets),
+  };
+};
+
+exports.verifyPetHolders = async (event) => {
+  const body = JSON.parse(event.body);
+  const wallets = (body.wallets || body.wallet || []).map((wallet) =>
+    wallet.toLowerCase()
+  );
+  console.log("Querying Beacon Pet holder status for wallets:", wallets);
+  return {
+    success: await hasPet(wallets),
+  };
+};

src/services/beacon.js

@@ -0,0 +1,68 @@
+const { BigNumber } = require("@ethersproject/bignumber");
+
+const { CONTRACT_BEACON } = require("../constants");
+const {
+  getBeaconPetsAmountStaked,
+} = require("../contracts/beaconPetsStakingRules");
+const { getUserQuests } = require("../contracts/beaconQuesting");
+const { fetchUserInventory } = require("../utils/inventory");
+
+exports.hasFoundingCharacter = async (wallets) => {
+  if (wallets.length === 0) {
+    return false;
+  }
+
+  const results = await Promise.all([
+    ...wallets.map((wallet) => getUserQuests(wallet)),
+    ...wallets.map((wallet) =>
+      fetchUserInventory({
+        userAddress: wallet,
+        collectionAddresses: [CONTRACT_BEACON],
+      })
+    ),
+  ]);
+
+  const quests = results.slice(0, wallets.length);
+  const inventories = results.slice(wallets.length);
+
+  return (
+    quests.some((quest) => !BigNumber.from(0).eq(quest[2])) ||
+    inventories
+      .flat()
+      .some(({ attributes }) =>
+        attributes.some(
+          ({ type, value }) => type === "Token Type" && value === "CHARACTER"
+        )
+      )
+  );
+};
+
+exports.hasPet = async (wallets) => {
+  if (wallets.length === 0) {
+    return false;
+  }
+
+  const results = await Promise.all([
+    ...wallets.map((wallet) => getBeaconPetsAmountStaked(wallet)),
+    ...wallets.map((wallet) =>
+      fetchUserInventory({
+        userAddress: wallet,
+        collectionAddresses: [CONTRACT_BEACON],
+      })
+    ),
+  ]);
+
+  const stakedAmounts = results.slice(0, wallets.length);
+  const inventories = results.slice(wallets.length);
+
+  return (
+    stakedAmounts.some((amount) => !BigNumber.from(0).eq(amount)) ||
+    inventories
+      .flat()
+      .some(({ attributes }) =>
+        attributes.some(
+          ({ type, value }) => type === "Token Type" && value === "PET"
+        )
+      )
+  );
+};

src/utils/inventory.js

@@ -0,0 +1,59 @@
+exports.fetchUserInventory = async ({
+  userAddress,
+  collectionAddresses = [],
+  tokens = [],
+  projection = "collectionAddr,collectionUrlSlug,queryUserQuantityOwned,metadata,image",
+}) => {
+  const url = new URL("https://trove-api.treasure.lol/tokens-for-user");
+  url.searchParams.append("userAddress", userAddress);
+  url.searchParams.append("projection", projection);
+  if (tokens.length > 0) {
+    url.searchParams.append(
+      "ids",
+      tokens
+        .map(({ address, tokenId }) => `arb/${address}/${tokenId}`)
+        .join(",")
+    );
+  } else if (collectionAddresses.length > 0) {
+    url.searchParams.append(
+      "slugs",
+      collectionAddresses.map((address) => `arb/${address}`).join(",")
+    );
+  }
+
+  const response = await fetch(url, {
+    headers: {
+      "X-API-Key": process.env.TROVE_API_KEY,
+    },
+  });
+  const results = await response.json();
+  if (!Array.isArray(results)) {
+    throw new Error(
+      `Error fetching user inventory: ${results?.message ?? "Unknown error"}`
+    );
+  }
+
+  return results
+    .map(
+      ({
+        collectionAddr: address,
+        tokenId,
+        metadata: { name, attributes, imageAlt },
+        image: { uri: image, originalUri },
+        queryUserQuantityOwned: balance,
+      }) => ({
+        user: userAddress,
+        address,
+        tokenId: Number(tokenId),
+        name,
+        image,
+        imageAlt: imageAlt ?? originalUri,
+        attributes: attributes.map(({ trait_type: type, value }) => ({
+          type,
+          value,
+        })),
+        balance,
+      })
+    )
+    .sort((a, b) => a.tokenId - b.tokenId);
+};