From a90a8964357f53ffe3637c86d189c8b5092651af Mon Sep 17 00:00:00 2001
From: ikprk <168457495+ikprk@users.noreply.github.com>
Date: Fri, 19 Jul 2024 11:01:52 +0200
Subject: [PATCH] :rescue_worker_helmet: Revenue share amm restriction (#6416)

* Add new hook to unify the token lock logic

* Implement new hook throughout the app

* Correct logic to follow runtime
---
 .../BuyFromMarketButton/BuyFromMarketButton.tsx |  6 +++---
 .../BuyMarketTokenModal/BuyMarketTokenModal.tsx | 17 ++++++++---------
 .../_crt/CrtStatusWidget/CrtStatusWidget.tsx    | 10 ++++------
 .../SellOnMarketButton/SellOnMarketButton.tsx   |  6 +++---
 .../_crt/SellTokenModal/SellTokenModal.tsx      | 16 +++++++---------
 .../atlas/src/hooks/useIsTokenInLockedMode.ts   | 16 ++++++++++++++++
 6 files changed, 41 insertions(+), 30 deletions(-)
 create mode 100644 packages/atlas/src/hooks/useIsTokenInLockedMode.ts

diff --git a/packages/atlas/src/components/_crt/BuyFromMarketButton/BuyFromMarketButton.tsx b/packages/atlas/src/components/_crt/BuyFromMarketButton/BuyFromMarketButton.tsx
index 61587e88bc..850881856e 100644
--- a/packages/atlas/src/components/_crt/BuyFromMarketButton/BuyFromMarketButton.tsx
+++ b/packages/atlas/src/components/_crt/BuyFromMarketButton/BuyFromMarketButton.tsx
@@ -6,17 +6,17 @@ import { BuyMarketTokenModal } from '@/components/_crt/BuyMarketTokenModal'
 
 type BuyFromMarketButtonProps = {
   tokenId: string
-  hasActiveRevenueShare?: boolean
+  isTokenLocked?: boolean
 }
 
-export const BuyFromMarketButton = ({ tokenId, hasActiveRevenueShare }: BuyFromMarketButtonProps) => {
+export const BuyFromMarketButton = ({ tokenId, isTokenLocked }: BuyFromMarketButtonProps) => {
   const [showModal, setShowModal] = useState(false)
   return (
     <>
       <BuyMarketTokenModal tokenId={tokenId} show={showModal} onClose={() => setShowModal(false)} />
       <ProtectedActionWrapper title="You want to buy tokens?" description="Sign in to buy">
         <Button
-          variant={hasActiveRevenueShare ? 'warning' : 'primary'}
+          variant={isTokenLocked ? 'warning' : 'primary'}
           size="large"
           fullWidth
           onClick={() => setShowModal(true)}
diff --git a/packages/atlas/src/components/_crt/BuyMarketTokenModal/BuyMarketTokenModal.tsx b/packages/atlas/src/components/_crt/BuyMarketTokenModal/BuyMarketTokenModal.tsx
index bfafcad780..010af86a0b 100644
--- a/packages/atlas/src/components/_crt/BuyMarketTokenModal/BuyMarketTokenModal.tsx
+++ b/packages/atlas/src/components/_crt/BuyMarketTokenModal/BuyMarketTokenModal.tsx
@@ -18,11 +18,11 @@ import { DialogProps } from '@/components/_overlays/Dialog'
 import { DialogModal } from '@/components/_overlays/DialogModal'
 import { absoluteRoutes } from '@/config/routes'
 import { useDismissibleAction } from '@/hooks/useDismissibleAction'
+import { useIsTokenInLockedMode } from '@/hooks/useIsTokenInLockedMode'
 import { useMediaMatch } from '@/hooks/useMediaMatch'
 import { useSegmentAnalytics } from '@/hooks/useSegmentAnalytics'
 import { hapiBnToTokenNumber, tokenNumberToHapiBn } from '@/joystream-lib/utils'
 import { useFee, useJoystream, useSubscribeAccountBalance } from '@/providers/joystream'
-import { useJoystreamStore } from '@/providers/joystream/joystream.store'
 import { useNetworkUtils } from '@/providers/networkUtils/networkUtils.hooks'
 import { useSnackbar } from '@/providers/snackbars'
 import { useTransaction } from '@/providers/transactions/transactions.hooks'
@@ -57,7 +57,6 @@ export const BuyMarketTokenModal = ({ tokenId, onClose: _onClose, show }: BuySal
   const amountRef = useRef<number | null>(null)
   const { control, watch, handleSubmit, reset, formState } = useForm<{ tokenAmount: number }>()
   const tokenAmount = watch('tokenAmount') || 0
-  const currentBlockRef = useRef(useJoystreamStore((store) => store.currentBlock))
   const { fullFee } = useFee('purchaseTokenOnMarketTx', ['1', '1', String(tokenAmount ?? 0), '1000000'])
   const { data, loading } = useGetFullCreatorTokenQuery({
     variables: {
@@ -67,8 +66,8 @@ export const BuyMarketTokenModal = ({ tokenId, onClose: _onClose, show }: BuySal
       SentryLogger.error('Error while fetching creator token', 'BuyMarketTokenModal', error)
     },
   })
-  const activeRevenueShare = data?.creatorTokenById?.revenueShares.find((rS) => !rS.finalized)
-  const hasActiveRevenueShare = (activeRevenueShare?.endsAt ?? 0) > currentBlockRef.current
+  const isTokenLocked = useIsTokenInLockedMode(data?.creatorTokenById ?? undefined)
+
   const { data: memberTokenAccount } = useGetCreatorTokenHoldersQuery({
     variables: {
       where: {
@@ -355,10 +354,10 @@ export const BuyMarketTokenModal = ({ tokenId, onClose: _onClose, show }: BuySal
     if (activeStep === BUY_MARKET_TOKEN_STEPS.form) {
       setPrimaryButtonProps({
         text: 'Continue',
-        disabled: hasActiveRevenueShare,
-        variant: hasActiveRevenueShare ? 'warning' : undefined,
+        disabled: isTokenLocked,
+        variant: isTokenLocked ? 'warning' : undefined,
         onClick: () => {
-          if (hasActiveRevenueShare) {
+          if (isTokenLocked) {
             displaySnackbar({
               iconType: 'error',
               title: 'You cannot trade tokens during revenue share.',
@@ -385,7 +384,7 @@ export const BuyMarketTokenModal = ({ tokenId, onClose: _onClose, show }: BuySal
     displaySnackbar,
     handleSubmit,
     hasAcceptedConditions,
-    hasActiveRevenueShare,
+    isTokenLocked,
     onTransactionSubmit,
   ])
 
@@ -410,7 +409,7 @@ export const BuyMarketTokenModal = ({ tokenId, onClose: _onClose, show }: BuySal
       confetti={activeStep === BUY_MARKET_TOKEN_STEPS.success && smMatch}
       noContentPadding={activeStep === BUY_MARKET_TOKEN_STEPS.conditions}
       additionalActionsNode={
-        hasActiveRevenueShare ? (
+        isTokenLocked ? (
           <Tooltip text="During revenue share you are unable to trade on market. Please wait until it ends to make new transactions.">
             <SvgAlertsWarning24 />
           </Tooltip>
diff --git a/packages/atlas/src/components/_crt/CrtStatusWidget/CrtStatusWidget.tsx b/packages/atlas/src/components/_crt/CrtStatusWidget/CrtStatusWidget.tsx
index fd3743545a..5a98beb1c4 100644
--- a/packages/atlas/src/components/_crt/CrtStatusWidget/CrtStatusWidget.tsx
+++ b/packages/atlas/src/components/_crt/CrtStatusWidget/CrtStatusWidget.tsx
@@ -12,9 +12,9 @@ import { ExpandButton } from '@/components/_buttons/ExpandButton'
 import { BuyFromMarketButton } from '@/components/_crt/BuyFromMarketButton/BuyFromMarketButton'
 import { SellOnMarketButton } from '@/components/_crt/SellOnMarketButton/SellOnMarketButton'
 import { DetailsContent } from '@/components/_nft/NftTile'
+import { useIsTokenInLockedMode } from '@/hooks/useIsTokenInLockedMode'
 import { useMediaMatch } from '@/hooks/useMediaMatch'
 import { hapiBnToTokenNumber } from '@/joystream-lib/utils'
-import { useJoystreamStore } from '@/providers/joystream/joystream.store'
 import { calcBuyMarketPricePerToken } from '@/utils/crts'
 import { SentryLogger } from '@/utils/logs'
 import { formatDate } from '@/utils/time'
@@ -110,9 +110,7 @@ const InactiveDetails = () => {
 }
 
 const MarketDetails = ({ token }: { token: FullCreatorTokenFragment }) => {
-  const currentBlockRef = useRef(useJoystreamStore((store) => store.currentBlock))
-  const activeRevenueShare = token.revenueShares.find((rS) => !rS.finalized)
-  const hasActiveRevenueShare = (activeRevenueShare?.endsAt ?? 0) > currentBlockRef.current
+  const isTokenLocked = useIsTokenInLockedMode(token)
   const calculateSlippageAmount = useCallback(
     (amount: number) => {
       const currentAmm = token?.ammCurves.find((amm) => !amm.finalized)
@@ -136,8 +134,8 @@ const MarketDetails = ({ token }: { token: FullCreatorTokenFragment }) => {
         tooltipText="Price of each incremental unit purchased or sold depends on overall quantity of tokens transacted, the actual average price per unit for the entire purchase or sale will differ from the price displayed for the first unit transacted."
       />
       <FlexBox equalChildren width="100%" gap={2}>
-        <SellOnMarketButton hasActiveRevenueShare={hasActiveRevenueShare} tokenId={token.id} />
-        <BuyFromMarketButton hasActiveRevenueShare={hasActiveRevenueShare} tokenId={token.id} />
+        <SellOnMarketButton isTokenLocked={isTokenLocked} tokenId={token.id} />
+        <BuyFromMarketButton isTokenLocked={isTokenLocked} tokenId={token.id} />
       </FlexBox>
 
       <SupplyLine>
diff --git a/packages/atlas/src/components/_crt/SellOnMarketButton/SellOnMarketButton.tsx b/packages/atlas/src/components/_crt/SellOnMarketButton/SellOnMarketButton.tsx
index 3e9ee174d6..40f9acee03 100644
--- a/packages/atlas/src/components/_crt/SellOnMarketButton/SellOnMarketButton.tsx
+++ b/packages/atlas/src/components/_crt/SellOnMarketButton/SellOnMarketButton.tsx
@@ -6,17 +6,17 @@ import { SellTokenModal } from '@/components/_crt/SellTokenModal'
 
 type SellOnMarketButtonProps = {
   tokenId: string
-  hasActiveRevenueShare?: boolean
+  isTokenLocked?: boolean
 }
 
-export const SellOnMarketButton = ({ tokenId, hasActiveRevenueShare }: SellOnMarketButtonProps) => {
+export const SellOnMarketButton = ({ tokenId, isTokenLocked }: SellOnMarketButtonProps) => {
   const [showModal, setShowModal] = useState(false)
   return (
     <>
       <SellTokenModal tokenId={tokenId} show={showModal} onClose={() => setShowModal(false)} />
       <ProtectedActionWrapper title="You want to sell tokens?" description="Sign in to sell">
         <Button
-          variant={hasActiveRevenueShare ? 'warning-secondary' : 'secondary'}
+          variant={isTokenLocked ? 'warning-secondary' : 'secondary'}
           fullWidth
           size="large"
           onClick={() => setShowModal(true)}
diff --git a/packages/atlas/src/components/_crt/SellTokenModal/SellTokenModal.tsx b/packages/atlas/src/components/_crt/SellTokenModal/SellTokenModal.tsx
index 2a2c4e850e..36e83a62c9 100644
--- a/packages/atlas/src/components/_crt/SellTokenModal/SellTokenModal.tsx
+++ b/packages/atlas/src/components/_crt/SellTokenModal/SellTokenModal.tsx
@@ -1,5 +1,5 @@
 import BN from 'bn.js'
-import { useCallback, useMemo, useRef, useState } from 'react'
+import { useCallback, useMemo, useState } from 'react'
 import { useForm } from 'react-hook-form'
 
 import { useGetFullCreatorTokenQuery } from '@/api/queries/__generated__/creatorTokens.generated'
@@ -12,10 +12,10 @@ import { AmmModalSummaryTemplate } from '@/components/_crt/AmmModalTemplates/Amm
 import { DialogModal } from '@/components/_overlays/DialogModal'
 import { atlasConfig } from '@/config'
 import { useGetTokenBalance } from '@/hooks/useGetTokenBalance'
+import { useIsTokenInLockedMode } from '@/hooks/useIsTokenInLockedMode'
 import { useSegmentAnalytics } from '@/hooks/useSegmentAnalytics'
 import { hapiBnToTokenNumber, tokenNumberToHapiBn } from '@/joystream-lib/utils'
 import { useFee, useJoystream } from '@/providers/joystream'
-import { useJoystreamStore } from '@/providers/joystream/joystream.store'
 import { useNetworkUtils } from '@/providers/networkUtils/networkUtils.hooks'
 import { useSnackbar } from '@/providers/snackbars'
 import { useTransaction } from '@/providers/transactions/transactions.hooks'
@@ -41,7 +41,6 @@ export const SellTokenModal = ({ tokenId, onClose: _onClose, show }: SellTokenMo
   const { trackAMMTokensSold } = useSegmentAnalytics()
   const { displaySnackbar } = useSnackbar()
   const { fullFee } = useFee('sellTokenOnMarketTx', ['1', '1', '2', '10000000'])
-  const currentBlockRef = useRef(useJoystreamStore((store) => store.currentBlock))
   const { data, loading } = useGetFullCreatorTokenQuery({
     variables: {
       id: tokenId,
@@ -50,8 +49,7 @@ export const SellTokenModal = ({ tokenId, onClose: _onClose, show }: SellTokenMo
       SentryLogger.error('Failed to fetch token data', 'SellTokenModal', { error })
     },
   })
-  const activeRevenueShare = data?.creatorTokenById?.revenueShares.find((rS) => !rS.finalized)
-  const hasActiveRevenueShare = (activeRevenueShare?.endsAt ?? 0) > currentBlockRef.current
+  const isTokenLocked = useIsTokenInLockedMode(data?.creatorTokenById ?? undefined)
 
   const currentAmm = data?.creatorTokenById?.currentAmmSale
   const ammBalance = currentAmm ? +currentAmm.mintedByAmm - +currentAmm.burnedByAmm : 0
@@ -198,7 +196,7 @@ export const SellTokenModal = ({ tokenId, onClose: _onClose, show }: SellTokenMo
   )
 
   const onFormSubmit = () => {
-    if (hasActiveRevenueShare) {
+    if (isTokenLocked) {
       displaySnackbar({
         iconType: 'error',
         title: 'You cannot trade tokens during revenue share.',
@@ -269,7 +267,7 @@ export const SellTokenModal = ({ tokenId, onClose: _onClose, show }: SellTokenMo
       show={show}
       onExitClick={onClose}
       additionalActionsNode={
-        hasActiveRevenueShare ? (
+        isTokenLocked ? (
           <Tooltip text="During revenue share you are unable to trade on market. Please wait until it ends to make new transactions.">
             <SvgAlertsWarning24 />
           </Tooltip>
@@ -282,8 +280,8 @@ export const SellTokenModal = ({ tokenId, onClose: _onClose, show }: SellTokenMo
       primaryButton={{
         text: isFormStep ? 'Continue' : `Sell $${title}`,
         onClick: isFormStep ? onFormSubmit : onTransactionSubmit,
-        disabled: hasActiveRevenueShare,
-        variant: hasActiveRevenueShare ? 'warning' : undefined,
+        disabled: isTokenLocked,
+        variant: isTokenLocked ? 'warning' : undefined,
       }}
     >
       {step === 'form' ? (
diff --git a/packages/atlas/src/hooks/useIsTokenInLockedMode.ts b/packages/atlas/src/hooks/useIsTokenInLockedMode.ts
new file mode 100644
index 0000000000..a5f6a22f5f
--- /dev/null
+++ b/packages/atlas/src/hooks/useIsTokenInLockedMode.ts
@@ -0,0 +1,16 @@
+// import { useRef } from 'react'
+import { FullCreatorTokenFragment } from '@/api/queries/__generated__/fragments.generated'
+
+// import { useJoystreamStore } from '@/providers/joystream/joystream.store'
+
+export const useIsTokenInLockedMode = (token?: FullCreatorTokenFragment) => {
+  // const currentBlockRef = useRef(useJoystreamStore((store) => store.currentBlock))
+  // 1. Check if there is any unfinalized revenue share
+  const activeRevenueShare = token?.revenueShares.find((rS) => !rS.finalized)
+
+  // 2. If ending block is not yet came for a user, consider that the token is locked
+  // BUG: looks like runtime doesnt allow to make tx if the revenue share not finalized
+  // const hasActiveRevenueShare = (activeRevenueShare?.endsAt ?? 0) > currentBlockRef.current
+
+  return !!activeRevenueShare
+}