Merge pull request #2082 from oasisprotocol/lw/discourage-cipher

Discourage mistaken ParaTime deposits into Cipher

.changelog/2082.bugfix.md

@@ -0,0 +1 @@
+Discourage mistaken ParaTime deposits into Cipher

src/app/pages/ParaTimesPage/ParaTimeSelection/__tests__/__snapshots__/index.test.tsx.snap

@@ -492,7 +492,7 @@ exports[`<ParaTimeSelection /> should render component 1`] = `
                         class="c12"
                       >
                         <span>
-                          paraTimes.common.cipher
+                          paraTimes.common.cipher paraTimes.common.discouragedType
                         </span>
                       </div>
                       <input

src/app/pages/ParaTimesPage/ParaTimeSelection/index.tsx

@@ -8,6 +8,7 @@ import { useTranslation } from 'react-i18next'
 import { ParaTimeContent } from '../ParaTimeContent'
 import { ParaTimeFormFooter } from '../ParaTimeFormFooter'
 import { useParaTimes } from '../useParaTimes'
+import { getParaTimeName } from '../getParaTimeName'
 import { useParaTimesNavigation } from '../useParaTimesNavigation'
 import { ThemeContext } from 'styled-components'
 import { ThemeType } from 'grommet/es6/themes'
@@ -41,7 +42,7 @@ export const ParaTimeSelection = () => {
   } = useParaTimes()
   const { navigateToRecipient } = useParaTimesNavigation()
   const options = availableParaTimesForSelectedNetwork.map(item => ({
-    label: <ParaTimeOption label={t(`paraTimes.common.${item.value}`)} isEvm={item.isEvm} />,
+    label: <ParaTimeOption label={getParaTimeName(t, item.value)} isEvm={item.isEvm} />,
     value: item.value,
   }))
 

src/app/pages/ParaTimesPage/getParaTimeName.ts

@@ -0,0 +1,24 @@
+import { TFunction } from 'i18next'
+import { ExhaustedTypeError } from 'types/errors'
+import { ParaTime } from '../../../config'
+
+export const getParaTimeName = (t: TFunction, paraTime: ParaTime) => {
+  switch (paraTime) {
+    case ParaTime.Cipher:
+      return `${t('paraTimes.common.cipher', 'Cipher')} ${t(
+        'paraTimes.common.discouragedType',
+        // Discourage mistaken ParaTime deposits into Cipher accounts controlled
+        // by Binance. That requires contacting support to recover it.
+        '(experimental)',
+      )}`
+    case ParaTime.Emerald:
+      return t('paraTimes.common.emerald', 'Emerald')
+    case ParaTime.Sapphire:
+      return t('paraTimes.common.sapphire', 'Sapphire')
+    default:
+      throw new ExhaustedTypeError(
+        t('paraTimes.validation.unsupportedParaTime', 'Unsupported ParaTime'),
+        paraTime,
+      )
+  }
+}

src/app/pages/ParaTimesPage/useParaTimes.test.ts

@@ -284,7 +284,7 @@ describe('useParaTimes', () => {
 
       const { result } = renderHook(() => useParaTimes())
 
-      expect(result.current.paraTimeName).toEqual('paraTimes.common.cipher')
+      expect(result.current.paraTimeName).toEqual('paraTimes.common.cipher paraTimes.common.discouragedType')
     })
   })
 

src/app/pages/ParaTimesPage/useParaTimes.ts

@@ -1,18 +1,18 @@
 import { useCallback } from 'react'
 import { useDispatch, useSelector } from 'react-redux'
 import { useTranslation } from 'react-i18next'
-import { TFunction } from 'i18next'
 import { paraTimesActions } from 'app/state/paratimes'
 import { TransactionForm, TransactionTypes } from 'app/state/paratimes/types'
 import { selectSelectedNetwork, selectTicker } from 'app/state/network/selectors'
 import { selectAccountAvailableBalance, selectAccountIsLoading } from 'app/state/account/selectors'
 import { selectAddress } from 'app/state/wallet/selectors'
 import { selectParaTimes } from 'app/state/paratimes/selectors'
 import { StringifiedBigInt } from 'types/StringifiedBigInt'
-import { ErrorPayload, ExhaustedTypeError } from 'types/errors'
+import { ErrorPayload } from 'types/errors'
 import { paraTimesConfig, RuntimeTypes, ParaTime, type ParaTimeConfig } from '../../../config'
 import { selectEvmAccounts } from 'app/state/evmAccounts/selectors'
 import { EvmAccount } from 'app/state/evmAccounts/types'
+import { getParaTimeName } from './getParaTimeName'
 
 type AvailableParaTimesForNetwork = {
   isEvm: boolean
@@ -45,22 +45,6 @@ export type ParaTimesHook = {
   usesOasisAddress: boolean
 }
 
-const getParaTimeName = (t: TFunction, paraTime: ParaTime) => {
-  switch (paraTime) {
-    case ParaTime.Cipher:
-      return t('paraTimes.common.cipher', 'Cipher')
-    case ParaTime.Emerald:
-      return t('paraTimes.common.emerald', 'Emerald')
-    case ParaTime.Sapphire:
-      return t('paraTimes.common.sapphire', 'Sapphire')
-    default:
-      throw new ExhaustedTypeError(
-        t('paraTimes.validation.unsupportedParaTime', 'Unsupported ParaTime'),
-        paraTime,
-      )
-  }
-}
-
 export const useParaTimes = (): ParaTimesHook => {
   const { t } = useTranslation()
   const dispatch = useDispatch()

src/locales/en/translation.json

@@ -358,6 +358,7 @@
     "common": {
       "cipher": "Cipher",
       "depositHeader": "Deposit to ParaTime",
+      "discouragedType": "(experimental)",
       "emerald": "Emerald",
       "evmcType": "(EVMc)",
       "header": "ParaTime Transfers",