From 030009a07c53d3b0c986e0d3ad33d7ed4a31796c Mon Sep 17 00:00:00 2001
From: painterpuppets <painterpuppets@gmail.com>
Date: Tue, 10 Oct 2023 13:12:47 +0800
Subject: [PATCH] optimize: halving over logic

---
 src/components/Banner/HalvingBanner.tsx | 25 ++++++----------
 src/constants/common.ts                 |  2 ++
 src/pages/Halving/index.tsx             | 39 +++++++++---------------
 src/utils/hook.ts                       | 40 +++++++++++++++++--------
 4 files changed, 53 insertions(+), 53 deletions(-)

diff --git a/src/components/Banner/HalvingBanner.tsx b/src/components/Banner/HalvingBanner.tsx
index 59a3df1ff..402d51581 100644
--- a/src/components/Banner/HalvingBanner.tsx
+++ b/src/components/Banner/HalvingBanner.tsx
@@ -6,7 +6,6 @@ import halvingSuccessAni from '../../assets/halving_success_ani.gif'
 import SimpleButton from '../SimpleButton'
 import { useCountdown, useHalving } from '../../utils/hook'
 import i18n from '../../utils/i18n'
-import { fetchCachedData } from '../../utils/cache'
 
 function numberToOrdinal(number: number) {
   switch (number) {
@@ -31,10 +30,8 @@ function numberToOrdinal(number: number) {
 }
 
 export const HalvingBanner = () => {
-  const { estimatedDate, nextHalvingCount } = useHalving()
+  const { estimatedDate, halvingCount, inCelebration } = useHalving()
   const [days, hours, minutes, seconds] = useCountdown(estimatedDate)
-  const lastedHavingKey = `lasted-having-${nextHalvingCount - 1}`
-  const unreadLastedHaving = nextHalvingCount > 1 && fetchCachedData(lastedHavingKey) === null
 
   const shortCountdown = () => {
     if (days > 0) {
@@ -46,29 +43,25 @@ export const HalvingBanner = () => {
     if (minutes > 0) {
       return `${minutes}${i18n.t('symbol.char_space')}${i18n.t('unit.minutes')}`
     }
-    if (seconds > 0) {
-      return `${seconds}${i18n.t('symbol.char_space')}${i18n.t('unit.seconds')}`
-    }
-    return `${i18n.t('halving.halving')}!`
+
+    return `${seconds}${i18n.t('symbol.char_space')}${i18n.t('unit.seconds')}`
   }
 
   return (
     <div
-      className={classnames(styles.halvingBannerWrapper, { [styles.halvingBannerSuccess]: unreadLastedHaving })}
+      className={classnames(styles.halvingBannerWrapper, { [styles.halvingBannerSuccess]: inCelebration })}
       style={{
-        backgroundImage: `url(${unreadLastedHaving ? halvingBannerSuccess : halvingBanner})`,
+        backgroundImage: `url(${inCelebration ? halvingBannerSuccess : halvingBanner})`,
       }}
     >
       <div className={styles.halvingBannerShadow}>
         <div className={classnames(styles.halvingBanner, 'container')}>
-          {unreadLastedHaving && (
-            <img className={styles.halvingBannerAnimation} src={halvingSuccessAni} alt="animation" />
-          )}
-          {unreadLastedHaving ? (
+          {inCelebration && <img className={styles.halvingBannerAnimation} src={halvingSuccessAni} alt="animation" />}
+          {inCelebration ? (
             <div className={classnames(styles.halvingBannerText, styles.success)}>
               {i18n
                 .t('halving.banner_congratulation', {
-                  times: i18n.t(`ordinal.${numberToOrdinal(nextHalvingCount - 1)}`),
+                  times: i18n.t(`ordinal.${numberToOrdinal(halvingCount)}`),
                 })
                 .toUpperCase()}
             </div>
@@ -79,7 +72,7 @@ export const HalvingBanner = () => {
           )}
           <a href="/halving">
             <SimpleButton className={styles.learnMoreButton}>
-              {unreadLastedHaving
+              {inCelebration
                 ? i18n.t('halving.learn_more')
                 : `${i18n.t('halving.halving_countdown')} ${shortCountdown()}`}
             </SimpleButton>
diff --git a/src/constants/common.ts b/src/constants/common.ts
index 5e35126a2..eb98f5f3f 100644
--- a/src/constants/common.ts
+++ b/src/constants/common.ts
@@ -13,6 +13,8 @@ export const EPOCH_HOURS = 4
 export const ONE_DAY_SECOND = 24 * 60 * 60
 export const ONE_HOUR_SECOND = 60 * 60
 export const ONE_MINUTE_SECOND = 60
+export const EPOCHS_PER_HALVING = 8760
+export const THEORETICAL_EPOCH_TIME = 1000 * 60 * 60 * 4 // 4 hours
 export const IS_MAINTAINING = process.env.REACT_APP_IS_MAINTAINING === 'true'
 
 export function getPrimaryColor() {
diff --git a/src/pages/Halving/index.tsx b/src/pages/Halving/index.tsx
index be7b19ce6..9710a9fb6 100644
--- a/src/pages/Halving/index.tsx
+++ b/src/pages/Halving/index.tsx
@@ -16,8 +16,7 @@ import { HalvingInfo } from './HalvingInfo'
 import { useStatistics } from '../../services/ExplorerService'
 import { HalvingCountdown } from './HalvingCountdown'
 import { useCountdown, useHalving, useIsMobile } from '../../utils/hook'
-import { fetchCachedData, storeCachedData } from '../../utils/cache'
-import { getPrimaryColor } from '../../constants/common'
+import { getPrimaryColor, EPOCHS_PER_HALVING, THEORETICAL_EPOCH_TIME } from '../../constants/common'
 import styles from './index.module.scss'
 
 function numberToOrdinal(number: number) {
@@ -45,20 +44,12 @@ function numberToOrdinal(number: number) {
 export const HalvingCountdownPage = () => {
   const isMobile = useIsMobile()
   const statistics = useStatistics()
-  const {
-    currentEpoch,
-    estimatedDate,
-    singleEpochAverageTime,
-    currentEpochUsedTime,
-    EPOCHS_PER_HALVING,
-    nextHalvingCount,
-  } = useHalving()
+  const { currentEpoch, estimatedDate, currentEpochUsedTime, halvingCount, inCelebration, skipCelebration } =
+    useHalving()
 
-  const lastedHavingKey = `lasted-having-${nextHalvingCount - 1}`
-  const unreadLastedHaving = nextHalvingCount > 1 && fetchCachedData(lastedHavingKey) === null
   const percent =
-    (((currentEpoch % EPOCHS_PER_HALVING) * singleEpochAverageTime - currentEpochUsedTime) /
-      (EPOCHS_PER_HALVING * singleEpochAverageTime)) *
+    (((currentEpoch % EPOCHS_PER_HALVING) * THEORETICAL_EPOCH_TIME - currentEpochUsedTime) /
+      (EPOCHS_PER_HALVING * THEORETICAL_EPOCH_TIME)) *
     100
   const [days, hours, minutes, seconds] = useCountdown(estimatedDate)
 
@@ -76,7 +67,7 @@ export const HalvingCountdownPage = () => {
   }
 
   const shareText = i18n.t('halving.share_text', {
-    times: i18n.t(`ordinal.${numberToOrdinal(nextHalvingCount)}`),
+    times: i18n.t(`ordinal.${numberToOrdinal(halvingCount)}`),
     date: estimatedDate.toUTCString(),
     countdown: shortCountdown(),
   })
@@ -90,7 +81,7 @@ export const HalvingCountdownPage = () => {
   }
 
   const renderHalvingPanel = () => {
-    if (unreadLastedHaving) {
+    if (inCelebration) {
       return (
         <div
           className={styles.halvingPanel}
@@ -101,12 +92,12 @@ export const HalvingCountdownPage = () => {
             <div className={styles.textCapitalize}>
               {i18n.t('halving.the')}
               {i18n.t('symbol.char_space')}
-              {i18n.t(`ordinal.${numberToOrdinal(nextHalvingCount - 1)}`)}
+              {i18n.t(`ordinal.${numberToOrdinal(halvingCount)}`)}
               {i18n.t('symbol.char_space')}
               {i18n.t('halving.halving')}
               {i18n.t('halving.actived')}{' '}
-              <a className={styles.textPrimary} href={`/block/${getTargetBlockByHavingCount(nextHalvingCount - 1)}`}>
-                {new BigNumber(getTargetBlockByHavingCount(nextHalvingCount - 1)).toFormat()}.
+              <a className={styles.textPrimary} href={`/block/${getTargetBlockByHavingCount(halvingCount)}`}>
+                {new BigNumber(getTargetBlockByHavingCount(halvingCount)).toFormat()}.
               </a>
             </div>
           </div>
@@ -114,9 +105,7 @@ export const HalvingCountdownPage = () => {
             <button
               className={classnames(styles.halvingSuccessBtn, styles.textCapitalize)}
               type="button"
-              onClick={() => {
-                storeCachedData(lastedHavingKey, true)
-              }}
+              onClick={() => skipCelebration()}
             >
               {i18n.t('halving.next')}
               {i18n.t('symbol.char_space')}
@@ -130,16 +119,16 @@ export const HalvingCountdownPage = () => {
     return (
       <div className={styles.halvingPanel}>
         <div className={classnames(styles.halvingPanelTitle, styles.textCapitalize)}>
-          {i18n.t(`ordinal.${numberToOrdinal(nextHalvingCount)}`)}
+          {i18n.t(`ordinal.${numberToOrdinal(halvingCount)}`)}
           {i18n.t('symbol.char_space')}
           {i18n.t('halving.halving')}
 
-          {nextHalvingCount > 1 && (
+          {halvingCount > 1 && (
             <Popover
               content={
                 <Table
                   pagination={false}
-                  dataSource={new Array(nextHalvingCount - 1).fill({}).map((_, index) => ({
+                  dataSource={new Array(halvingCount - 1).fill({}).map((_, index) => ({
                     key: index,
                     event: `${i18n.t(`ordinal.${numberToOrdinal(index + 1)}`)}
                   ${i18n.t('symbol.char_space')}
diff --git a/src/utils/hook.ts b/src/utils/hook.ts
index 9bbb1e72b..97ac8a540 100644
--- a/src/utils/hook.ts
+++ b/src/utils/hook.ts
@@ -14,7 +14,7 @@ import { interval, share } from 'rxjs'
 import { AppCachedKeys } from '../constants/cache'
 import { deprecatedAddrToNewAddr } from './util'
 import { startEndEllipsis } from './string'
-import { ListPageParams, PageParams } from '../constants/common'
+import { ListPageParams, PageParams, THEORETICAL_EPOCH_TIME, EPOCHS_PER_HALVING } from '../constants/common'
 import {
   fetchCachedData,
   fetchDateChartCache,
@@ -601,32 +601,48 @@ export const useCountdown = (targetDate: Date) => {
   return [days, hours, minutes, seconds]
 }
 
-export const useHalving = () => {
+export const useSingleHalving = (_halvingCount = 1) => {
+  const halvingCount = Math.max(Math.floor(_halvingCount) || 1, 1) // halvingCount should be a positive integer greater than 1.
   const statistics = useStatistics()
+  const celebrationSkipKey = `having-celebration-${halvingCount}`
+  const celebrationSkipped = fetchCachedData(celebrationSkipKey) !== null
+  function skipCelebration() {
+    storeCachedData(celebrationSkipKey, true)
+  }
 
-  const EPOCHS_PER_HALVING = 8760
   const currentEpoch = Number(statistics.epochInfo.epochNumber)
-  const nextHalvingCount = Math.ceil(currentEpoch / EPOCHS_PER_HALVING)
-  const targetEpoch = EPOCHS_PER_HALVING * nextHalvingCount
-  const singleEpochAverageTime = 1000 * 60 * 60 * 4
+  const targetEpoch = EPOCHS_PER_HALVING * halvingCount
   const currentEpochUsedTime =
-    (Number(statistics.epochInfo.index) / Number(statistics.epochInfo.epochLength)) * singleEpochAverageTime
-
-  const estimatedTime = (targetEpoch - currentEpoch) * singleEpochAverageTime - currentEpochUsedTime
+    (Number(statistics.epochInfo.index) / Number(statistics.epochInfo.epochLength)) * THEORETICAL_EPOCH_TIME
 
+  const estimatedTime = (targetEpoch - currentEpoch) * THEORETICAL_EPOCH_TIME - currentEpochUsedTime
   const estimatedDate = useMemo(() => new Date(new Date().getTime() + estimatedTime), [estimatedTime])
 
+  const haveDone = currentEpoch >= targetEpoch || new Date().getTime() > estimatedDate.getTime()
+  const celebrationOverEpoch = targetEpoch + 30 * 6 // Every 6 epochs is theoretically 1 day.
+  const inCelebration = haveDone && currentEpoch < celebrationOverEpoch && !celebrationSkipped
+
   return {
-    EPOCHS_PER_HALVING,
+    halvingCount,
     currentEpoch,
     targetEpoch,
-    nextHalvingCount,
-    singleEpochAverageTime,
+    inCelebration,
+    skipCelebration,
     currentEpochUsedTime,
     estimatedDate,
   }
 }
 
+export const useHalving = () => {
+  const statistics = useStatistics()
+  const currentEpoch = Number(statistics.epochInfo.epochNumber)
+  const lastedHalvingCount = Math.ceil((currentEpoch + 1) / EPOCHS_PER_HALVING)
+  const lastedHalving = useSingleHalving(lastedHalvingCount)
+  const previousHalving = useSingleHalving(lastedHalvingCount - 1)
+
+  return previousHalving.inCelebration ? previousHalving : lastedHalving
+}
+
 export default {
   useInterval,
   useTimeout,