Merge pull request #1132 from brave/dsuh-943-bat-gating

Dsuh 943 bat gating

package.json

@@ -62,4 +62,4 @@
     "react-i18next": "13.0.1",
     "react-router-dom": "6.14.1"
   }
-}
+}

src/components/web3/NonExpandablePanel.tsx

@@ -0,0 +1,55 @@
+import { css } from "@emotion/react";
+import React, { ReactNode, useState } from "react";
+import { baseText } from "./styles";
+import PlusImage from "../../images/plus.svg";
+import MinusImage from "../../images/minus.svg";
+import SpinnerImage from "../../images/spinner.svg";
+
+interface Props {
+  header: string;
+  subhead: string;
+  loading?: boolean;
+  children?: ReactNode;
+}
+
+export const NonExapandablePanel: React.FC<Props> = ({
+  header,
+  subhead,
+  loading = false,
+  children,
+}) => {
+  return (
+    <div
+      css={{
+        background: "rgba(255, 255, 255, 0.24)",
+        backdropFilter: "blur(8px)",
+        marginTop: "11px",
+        padding: "24px 19px",
+        textAlign: "left",
+      }}
+    >
+      <div
+        css={{
+          display: "flex",
+          alignItems: "center",
+        }}
+      >
+        <div css={{ flex: 1 }}>
+          <div
+            css={css(baseText, {
+              fontWeight: 500,
+              fontSize: "22px",
+              lineHeight: "32px",
+            })}
+          >
+            {header}
+          </div>
+          <div>{subhead}</div>
+        </div>
+        {loading && (
+          <img width={25} height={26} src={SpinnerImage} alt="spinner" />
+        )}
+      </div>
+    </div>
+  );
+};

src/components/web3/OptionalSettings.tsx

@@ -2,11 +2,13 @@ import React from "react";
 import { useTranslation } from "react-i18next";
 import { POAP, NFTcollection, NFT } from "./core";
 import { ExapandablePanel } from "./ExpandablePanel";
+import { NonExapandablePanel } from "./NonExpandablePanel";
 import { SelectableImageList } from "./SelectableImageList";
 import { SelectablePoapList } from "./SelectablePoapList";
 import { SelectableNFTCollectionList } from "./SelectableNFTCollectionList";
 import { PermissionTypeSelector } from "./PermissionTypeSelector";
 import noNftImage from "../../images/no-nft-image.png";
+import { Web3PermissionType } from "./api";
 
 interface Props {
   startCall: boolean;
@@ -17,7 +19,7 @@ interface Props {
   nft: string | null;
   setNft: (nft: string) => void;
   permissionType: string;
-  setPermissionType: (permissionType: string) => void;
+  setPermissionType: (permissionType: Web3PermissionType) => void;
   participantPoaps?: POAP[];
   setParticipantPoaps?: (participantPoaps: POAP[]) => void;
   moderatorPoaps?: POAP[];
@@ -164,6 +166,14 @@ export const OptionalSettings: React.FC<Props> = ({
             </ExapandablePanel>
           </React.Fragment>
         )}
+      {startCall && permissionType === "balance" && (
+        <React.Fragment>
+          <NonExapandablePanel
+            header={t("bat_gating_panel_header")}
+            subhead={t("bat_gating_panel_subheader")}
+          />
+        </React.Fragment>
+      )}
     </div>
   );
 };

src/components/web3/PermissionTypeSelector.tsx

@@ -1,11 +1,12 @@
 import React from "react";
 import { css } from "@emotion/react";
 import { useTranslation } from "react-i18next";
+import { Web3PermissionType } from "./api";
 
 type Props = {
   web3Account: "ETH" | "SOL" | null;
   permissionType: string;
-  setPermissionType: (permissionType: string) => void;
+  setPermissionType: (permissionType: Web3PermissionType) => void;
 };
 
 const styles = {
@@ -63,6 +64,12 @@ export const PermissionTypeSelector: React.FC<Props> = ({
       >
         {t("nft_collection_permission_type")}
       </button>
+      <button
+        onClick={() => setPermissionType("balance")}
+        css={[styles.base, permissionType === "balance" && styles.selected]}
+      >
+        {"BAT Gating"}
+      </button>
     </div>
   );
 };

src/components/web3/SolLogin.tsx

@@ -16,16 +16,18 @@ export const SolLogin: React.FC<Props> = ({
   const { t } = useTranslation();
 
   useEffect(() => {
-    try{
+    try {
       window.braveSolana?.on("!!! accountChanged", () => setNotice(undefined));
-    }catch {
-      console.warn("!!! Brave Wallet does not exists")
+    } catch {
+      console.warn("!!! Brave Wallet does not exists");
     }
 
-    try{
-      window.phantom?.solana.on("!!! accountChanged", () => setNotice(undefined));
-    }catch {
-      console.warn("!!! Phantom Wallet does not exists")
+    try {
+      window.phantom?.solana.on("!!! accountChanged", () =>
+        setNotice(undefined)
+      );
+    } catch {
+      console.warn("!!! Phantom Wallet does not exists");
     }
   }, []);
 

src/components/web3/api.ts

@@ -10,6 +10,8 @@ declare let window: any;
 // making a cross domain call - see https://github.com/brave/devops/issues/5445.
 const SIMPLEHASH_PROXY_ROOT_URL = "/api/v1/simplehash";
 
+export type Web3PermissionType = "POAP" | "NFT-collection" | "balance";
+
 export interface Web3Authentication {
   method: string;
   proof: {
@@ -23,6 +25,18 @@ export interface Web3Authorization {
   method: string;
   POAPs: Web3AuthList;
   Collections: Web3AuthList;
+  Balances: Web3BalancesList;
+}
+
+export interface Web3BalancesList {
+  participants: Web3BalancesRequireList;
+  moderators: Web3BalancesRequireList;
+}
+
+export interface Web3BalancesRequireList {
+  network: "ETH"; // "ETH" | "SOL" in the future probably
+  token?: string;
+  minimum: string; // in wei, e.g. 10e-18
 }
 
 export interface Web3SolAuthorization {

src/hooks/use-web3-call-state.ts

@@ -4,6 +4,7 @@ import {
   Web3RequestBody,
   Web3Authentication,
   web3Prove,
+  Web3PermissionType,
   web3SolProve,
 } from "../components/web3/api";
 import { POAP, NFTcollection } from "../components/web3/core";
@@ -12,14 +13,14 @@ import { fetchJWT } from "../rooms";
 
 interface Web3CallState {
   web3Address?: string;
-  permissionType: string;
+  permissionType: Web3PermissionType;
   nft: string | null;
   participantPoaps: POAP[];
   moderatorPoaps: POAP[];
   participantNFTCollections: NFTcollection[];
   moderatorNFTCollections: NFTcollection[];
   setWeb3Address: (web3Address: string, event: string) => void;
-  setPermissionType: (permissionType: string) => void;
+  setPermissionType: (permissionType: Web3PermissionType) => void;
   setNft: (nft: string) => void;
   setParticipantPoaps: (participanPoaps: POAP[]) => void;
   setModeratorPoaps: (moderatorPoaps: POAP[]) => void;
@@ -42,7 +43,7 @@ export function useWeb3CallState(
 ): Web3CallState {
   const [web3Address, _setWeb3Address] = useState<string>();
   const [permissionType, setPermissionType] =
-    useState<string>("NFT-collection");
+    useState<Web3PermissionType>("NFT-collection");
   const [nft, setNft] = useState<string | null>(null);
   const [participantPoaps, setParticipantPoaps] = useState<POAP[]>([]);
   const [moderatorPoaps, setModeratorPoaps] = useState<POAP[]>([]);
@@ -81,7 +82,6 @@ export function useWeb3CallState(
     });
   }
 
-
   try {
     window.braveSolana?.on("accountChanged", (account: any) => {
       setWeb3Account("SOL");
@@ -151,12 +151,10 @@ export function useWeb3CallState(
     } catch (e: any) {
       console.error(e);
 
-      if (
-        e.message.includes(
-          "You must have an appropriate token to join this call"
-        )
-      ) {
+      if (e.message.includes("no-token")) {
         setFeedbackMessage("invalid_token_error");
+      } else if (e.message.includes("no-currency")) {
+        setFeedbackMessage("not_enough_currency_error");
       } else {
         setFeedbackMessage("not_participant_error");
       }
@@ -202,6 +200,18 @@ export function useWeb3CallState(
               deny: [],
             },
           },
+          Balances: {
+            participants: {
+              network: "ETH" as const,
+              token: "BAT",
+              minimum: "1",
+            },
+            moderators: {
+              network: "ETH" as const,
+              token: "BAT",
+              minimum: "1",
+            },
+          },
         },
         avatarURL: nft,
       };

src/i18n/locales/en/translation.json

@@ -1,6 +1,8 @@
 {
   "avatar_fetch_error": "Failed to fetch avatar NFTs",
   "avatar_nft_subhead": "Currently supports Ethereum ERC-721 NFTs and Solana Metaplex NFTs",
+  "bat_gating_panel_header": "Non-Zero BAT gating will be applied.",
+  "bat_gating_panel_subheader": "Users will need to have a non-zero balance of BAT in their wallet to join this call.",
   "call_permission_type": "Call permission type:",
   "check_subscription": "Checking subscription status...",
   "create_link": "Create link",
@@ -27,6 +29,7 @@
   "my_account_link": "My Account",
   "nft_collection_permission_type": "NFT Collection",
   "not_participant_error": "Not listed as participant",
+  "not_enough_currency_error": "Access failure: Non-zero amount of BAT in your wallet is required to join this call.",
   "notice_text": "Encrypted video calls. Right in your browser.",
   "participant_nft_collection_panel_header": "Require an NFT Collection",
   "participant_nft_collection_panel_subhead": "Select an NFT Collection that participants must verify to join",

src/rooms.ts

@@ -97,12 +97,14 @@ const roomsRequest = async ({
           failureMessages: failureMessages,
         });
       }
-
+      const respText = await response.text();
       const message =
-        failureMessages[status] ||
-        `Request failed: ${status} ${response.statusText}`;
+        status == 401
+          ? respText
+          : failureMessages[status] ||
+            `Request failed: ${status} ${response.statusText}`;
 
-      console.warn(`!!! body: ${await response.text()}`);
+      console.warn(`!!! body: ${respText}`);
       throw new Error(message);
     }