feat(neuron-ui): rename APY to APC

Author: Keith-CY

packages/neuron-ui/src/components/CustomRows/DAORecordRow.tsx

@@ -3,7 +3,7 @@ import { DefaultButton } from 'office-ui-fabric-react'
 import { useTranslation } from 'react-i18next'
 import { ckbCore, getBlockByNumber } from 'services/chain'
 import { showMessage } from 'services/remote'
-import calculateAPY from 'utils/calculateAPY'
+import calculateAPC from 'utils/calculateAPC'
 import { shannonToCKBFormatter, uniformTimeFormatter, localNumberFormatter } from 'utils/formatters'
 import calculateClaimEpochNumber from 'utils/calculateClaimEpochNumber'
 import { epochParser } from 'utils/parsers'
@@ -142,7 +142,7 @@ const DAORecord = ({
         </div>
       </div>
       <div className={styles.secondaryInfo}>
-        <span>{`APY: ~${calculateAPY(compensation.toString(), capacity, `${Date.now() - +timestamp}`)}%`}</span>
+        <span>{`APC: ~${calculateAPC(compensation.toString(), capacity, `${Date.now() - +timestamp}`)}%`}</span>
         <span>{uniformTimeFormatter(+timestamp)}</span>
         <span>{metaInfo}</span>
       </div>

packages/neuron-ui/src/components/NervosDAO/index.tsx

@@ -8,7 +8,7 @@ import appState from 'states/initStates/app'
 import { AppActions, StateWithDispatch } from 'states/stateProvider/reducer'
 import { updateNervosDaoData, clearNervosDaoData } from 'states/stateProvider/actionCreators'
 
-import calculateGlobalAPY from 'utils/calculateGlobalAPY'
+import calculateGlobalAPC from 'utils/calculateGlobalAPC'
 import calculateFee from 'utils/calculateFee'
 import { shannonToCKBFormatter, CKBToShannonFormatter } from 'utils/formatters'
 import { MIN_DEPOSIT_AMOUNT, MEDIUM_FEE_RATE, SHANNON_CKB_RATIO, CapacityUnit } from 'utils/const'
@@ -45,7 +45,7 @@ const NervosDAO = ({
   const [activeRecord, setActiveRecord] = useState<State.NervosDAORecord | null>(null)
   const [errorMessage, setErrorMessage] = useState('')
   const [withdrawList, setWithdrawList] = useState<(string | null)[]>([])
-  const [globalAPY, setGlobalAPY] = useState(0)
+  const [globalAPC, setGlobalAPC] = useState(0)
 
   const clearGeneratedTx = useCallback(() => {
     dispatch({
@@ -106,8 +106,8 @@ const NervosDAO = ({
 
   useEffect(() => {
     if (tipBlockTimestamp) {
-      calculateGlobalAPY(tipBlockTimestamp).then(apy => {
-        setGlobalAPY(apy)
+      calculateGlobalAPC(tipBlockTimestamp).then(apc => {
+        setGlobalAPC(apc)
       })
     }
   }, [tipBlockTimestamp])
@@ -298,10 +298,10 @@ const NervosDAO = ({
         <Text as="span" variant="small" block>{`Epoch number: ${epochInfo.number}`}</Text>
         <Text as="span" variant="small" block>{`Epoch index: ${epochInfo.index}`}</Text>
         <Text as="span" variant="small" block>{`Epoch length: ${epochInfo.length}`}</Text>
-        <Text as="span" variant="small" block>{`APY: ~${globalAPY}%`}</Text>
+        <Text as="span" variant="small" block>{`APC: ~${globalAPC}%`}</Text>
       </Stack>
     )
-  }, [epoch, globalAPY])
+  }, [epoch, globalAPC])
 
   const lockAndFreeProperties = [
     {

packages/neuron-ui/src/locales/en.json

@@ -314,7 +314,7 @@
       "locked": "Locked",
       "deposit": "Deposit",
       "deposit-receipts": "Deposit Receipts",
-      "apy": "APY",
+      "apc": "APC",
       "deposit-at": "Deposit at {{time}}",
       "claim": "Claim",
       "withdraw": "Withdraw",

packages/neuron-ui/src/locales/zh.json

@@ -314,7 +314,7 @@
       "locked": "已锁定",
       "deposit": "存入",
       "deposit-receipts": "存款凭证",
-      "apy": "预期年化利率",
+      "apc": "年化锁定补贴率",
       "deposit-at": "存入于{{time}}",
       "claim": "取款",
       "withdraw": "结算",

…lculation/calculateGlobalAPY/fixtures.ts …lculation/calculateGlobalAPC/fixtures.tspackages/neuron-ui/src/tests/calculation/calculateGlobalAPY/fixtures.ts renamed to packages/neuron-ui/src/tests/calculation/calculateGlobalAPC/fixtures.ts packages/neuron-ui/src/tests/calculation/calculateGlobalAPY/fixtures.ts renamed to packages/neuron-ui/src/tests/calculation/calculateGlobalAPC/fixtures.ts

@@ -2,11 +2,11 @@ export default {
   'return 0 if the genesis block is not loaded': {
     currentTime: Date.now(),
     genesisTime: undefined,
-    expectAPY: 0,
+    expectAPC: 0,
   },
   'one period and one handrand days': {
     currentTime: new Date('2023-04-10').getTime(),
     genesisTime: new Date('2019-01-01').getTime(),
-    expectAPY: 2.369552868619654,
+    expectAPC: 2.369552868619654,
   },
 }

packages/neuron-ui/src/tests/calculation/calculateGlobalAPC/index.test.ts

@@ -0,0 +1,16 @@
+import calculateGlobalAPC from 'utils/calculateGlobalAPC'
+import fixtures from './fixtures'
+
+describe('calculate the global apc', () => {
+  const fixtureTable = Object.entries(fixtures).map(([title, { currentTime, genesisTime, expectAPC }]) => [
+    title,
+    currentTime,
+    genesisTime,
+    expectAPC,
+  ])
+
+  test.each(fixtureTable)(`%s`, async (_title, currentTime, genesisTime, expectAPC) => {
+    const apc = await calculateGlobalAPC(currentTime, genesisTime)
+    expect(apc).toBe(expectAPC === 0 ? 0 : +expectAPC.toFixed(2))
+  })
+})