From 4f11b1c4a8edc71d2a7a662c52c68c1c4800e94f Mon Sep 17 00:00:00 2001
From: SwiftHawk <SwiftHawk@SwiftHawk.com>
Date: Fri, 17 May 2024 13:59:03 +0500
Subject: [PATCH] chore: add comments

---
 src/components/AppBar/AppBar.tsx | 12 ++++++------
 src/components/username.tsx      |  4 ++++
 src/layouts/Main.tsx             | 11 +++++++----
 src/pages/login/index.tsx        |  5 ++---
 src/pages/sign/index.tsx         |  2 ++
 5 files changed, 21 insertions(+), 13 deletions(-)

diff --git a/src/components/AppBar/AppBar.tsx b/src/components/AppBar/AppBar.tsx
index af03c5c..ce5eacb 100644
--- a/src/components/AppBar/AppBar.tsx
+++ b/src/components/AppBar/AppBar.tsx
@@ -43,12 +43,14 @@ export const AppBar = () => {
   useEffect(() => {
     if (metadataState) {
       if (metadataState.content) {
-        const { picture, display_name, name } = JSON.parse(metadataState.content)
-  
+        const { picture, display_name, name } = JSON.parse(
+          metadataState.content
+        )
+
         if (picture) {
           setUserAvatar(picture)
         }
-  
+
         setUsername(shorten(display_name || name || '', 7))
       } else {
         setUserAvatar('')
@@ -84,9 +86,7 @@ export const AppBar = () => {
       })
     )
 
-    dispatch(
-      setMetadataEvent(metadataController.getEmptyMetadataEvent())
-    )
+    dispatch(setMetadataEvent(metadataController.getEmptyMetadataEvent()))
 
     // clear authToken saved in local storage
     clearAuthToken()
diff --git a/src/components/username.tsx b/src/components/username.tsx
index 387a4c6..ff93494 100644
--- a/src/components/username.tsx
+++ b/src/components/username.tsx
@@ -54,6 +54,10 @@ type UserProps = {
   image?: string
 }
 
+/**
+ *  This component will be used for the displaying username and profile picture.
+ *  If image is not available, robohash image will be displayed
+ */
 export const UserComponent = ({ pubkey, name, image }: UserProps) => {
   const theme = useTheme()
 
diff --git a/src/layouts/Main.tsx b/src/layouts/Main.tsx
index e258e36..e1d6f48 100644
--- a/src/layouts/Main.tsx
+++ b/src/layouts/Main.tsx
@@ -5,7 +5,12 @@ import { useDispatch } from 'react-redux'
 import { Outlet } from 'react-router-dom'
 import { AppBar } from '../components/AppBar/AppBar'
 import { restoreState, setAuthState, setMetadataEvent } from '../store/actions'
-import { clearAuthToken, clearState, loadState, saveNsecBunkerDelegatedKey } from '../utils'
+import {
+  clearAuthToken,
+  clearState,
+  loadState,
+  saveNsecBunkerDelegatedKey
+} from '../utils'
 import { LoadingSpinner } from '../components/LoadingSpinner'
 import { Dispatch } from '../store/store'
 import { MetadataController, NostrController } from '../controllers'
@@ -29,9 +34,7 @@ export const MainLayout = () => {
         })
       )
 
-      dispatch(
-        setMetadataEvent(metadataController.getEmptyMetadataEvent())
-      )
+      dispatch(setMetadataEvent(metadataController.getEmptyMetadataEvent()))
 
       // clear authToken saved in local storage
       clearAuthToken()
diff --git a/src/pages/login/index.tsx b/src/pages/login/index.tsx
index b14e714..7dd91d3 100644
--- a/src/pages/login/index.tsx
+++ b/src/pages/login/index.tsx
@@ -53,9 +53,8 @@ export const Login = () => {
         dispatch(updateLoginMethod(LoginMethods.extension))
 
         setLoadingSpinnerDesc('Authenticating and finding metadata')
-        const redirectPath = await authController.authenticateAndFindMetadata(
-          pubkey
-        )
+        const redirectPath =
+          await authController.authenticateAndFindMetadata(pubkey)
 
         navigate(redirectPath)
       })
diff --git a/src/pages/sign/index.tsx b/src/pages/sign/index.tsx
index a3c7e87..b5bacee 100644
--- a/src/pages/sign/index.tsx
+++ b/src/pages/sign/index.tsx
@@ -89,6 +89,8 @@ export const SignPage = () => {
         } else {
           for (const signer of meta.signers) {
             if (!signedBy.includes(signer)) {
+              // signers in meta.json are in npub1 format
+              // so, convert it to hex before setting to nextSigner
               setNextSinger(npubToHex(signer)!)
 
               const usersNpub = hexToNpub(usersPubkey!)