Merge pull request #2298 from oasisprotocol/lw/runtime-methods-type

Move knownRuntimeTxMethods to api.ts

Author: lukaw3d

.changelog/2298.trivial.md

@@ -0,0 +1 @@
+Move knownRuntimeTxMethods to api.ts

src/app/components/RuntimeTransactionMethod/index.tsx

@@ -14,7 +14,13 @@ import DeveloperBoard from '@mui/icons-material/DeveloperBoard'
 import DeveloperBoardOffIcon from '@mui/icons-material/DeveloperBoardOff'
 import LockIcon from '@mui/icons-material/Lock'
 import { MethodIcon } from '../ConsensusTransactionMethod'
-import { GetRuntimeTransactionsParams, Layer, RuntimeTransaction } from '../../../oasis-nexus/api'
+import {
+  GetRuntimeTransactionsParams,
+  KnownRuntimeTxMethod,
+  knownRuntimeTxMethods,
+  Layer,
+  RuntimeTransaction,
+} from '../../../oasis-nexus/api'
 import { paraTimesConfig } from '../../../config'
 import { exhaustedTypeWarning } from '../../../types/errors'
 import { RuntimeTxMethodFilteringType } from '../../hooks/useCommonParams'
@@ -72,31 +78,6 @@ const getRuntimeTransactionLabel = (t: TFunction, method: KnownRuntimeTxMethod)
   }
 }
 
-const knownRuntimeTxMethods = [
-  'accounts.Transfer',
-  'evm.Call',
-  'evm.Create',
-  'consensus.Deposit',
-  'consensus.Withdraw',
-  'consensus.Delegate',
-  'consensus.Undelegate',
-  'rofl.Create',
-  'rofl.Register',
-  'rofl.Remove',
-  'rofl.Update',
-  'roflmarket.ProviderCreate',
-  'roflmarket.ProviderUpdate',
-  'roflmarket.ProviderUpdateOffers',
-  'roflmarket.ProviderRemove',
-  'roflmarket.InstanceCreate',
-  'roflmarket.InstanceTopUp',
-  'roflmarket.InstanceCancel',
-  'roflmarket.InstanceExecuteCmds',
-  'roflmarket.InstanceChangeAdmin',
-  '',
-] as const
-export type KnownRuntimeTxMethod = (typeof knownRuntimeTxMethods)[number]
-
 export type RuntimeTxMethodFilterOption = {
   value: RuntimeTxMethodFilteringType
   label: string
@@ -115,7 +96,7 @@ export const getRuntimeTxMethodOptions = (t: TFunction, layer: Layer) => {
 }
 
 export const getRuntimeRoflUpdatesMethodOptions = (t: TFunction) => {
-  const options = ['rofl.Create', 'rofl.Remove', 'rofl.Update'] as const
+  const options = ['rofl.Create', 'rofl.Remove', 'rofl.Update'] satisfies KnownRuntimeTxMethod[]
 
   return options.map(
     (method): RuntimeTxMethodFilterOption => ({
@@ -131,27 +112,7 @@ export const getRuntimeRoflUpdatesMethodOptions = (t: TFunction) => {
  * May be undefined if the transaction was malformed.
  *
  * In theory, this could be any string as the runtimes evolve.
- * In practice, the nexus currently expects only the following methods:
- *   - "accounts.Transfer"
- *   - "consensus.Deposit"
- *   - "consensus.Withdraw"
- *   - "consensus.Delegate"
- *   - "consensus.Undelegate"
- *   - "evm.Create"
- *   - "evm.Call"
- *   - "rofl.Create"
- *   - "rofl.Update"
- *   - "rofl.Remove"
- *   - "rofl.Register"
- *   - "roflmarket.ProviderCreate"
- *   - "roflmarket.ProviderUpdate"
- *   - "roflmarket.ProviderUpdateOffers"
- *   - "roflmarket.ProviderRemove"
- *   - "roflmarket.InstanceCreate"
- *   - "roflmarket.InstanceTopUp"
- *   - "roflmarket.InstanceCancel"
- *   - "roflmarket.InstanceExecuteCmds"
- *   - "roflmarket.InstanceChangeAdmin"
+ * In practice, the nexus currently expects only KnownRuntimeTxMethod.
  */
 const getRuntimeTransactionIcon = (method: KnownRuntimeTxMethod, label: string, truncate?: boolean) => {
   const props = {

src/app/hooks/useCommonParams.ts

@@ -5,8 +5,8 @@ import {
   GetConsensusEventsParams,
   RuntimeEventType,
   ConsensusEventType,
+  KnownRuntimeTxMethod,
 } from '../../oasis-nexus/api'
-import { KnownRuntimeTxMethod } from '../components/RuntimeTransactionMethod'
 
 export const TX_METHOD_QUERY_ARG_NAME = 'tx_method'
 

src/app/utils/transaction.ts

@@ -1,5 +1,5 @@
 import { consensusDecimals } from '../../config'
-import { ConsensusTxMethod, Transaction } from '../../oasis-nexus/api'
+import { ConsensusTxMethod, KnownRuntimeTxMethod, Transaction } from '../../oasis-nexus/api'
 import { fromBaseUnits } from './number-utils'
 
 export const getConsensusTransactionToAddress = (transaction: Transaction) => {
@@ -33,7 +33,7 @@ export const getConsensusTransactionAmount = (transaction: Transaction) => {
   }
 }
 export const isRoflTransaction = (method: string | undefined): boolean => {
-  const roflMethods = [
+  const roflMethods: string[] = [
     'rofl.Create',
     'rofl.Update',
     'rofl.Remove',
@@ -47,6 +47,6 @@ export const isRoflTransaction = (method: string | undefined): boolean => {
     'roflmarket.InstanceCancel',
     'roflmarket.InstanceExecuteCmds',
     'roflmarket.InstanceChangeAdmin',
-  ]
+  ] satisfies KnownRuntimeTxMethod[]
   return method ? roflMethods.includes(method) : false
 }

src/oasis-nexus/api.ts

@@ -160,6 +160,32 @@ declare module './generated/api' {
   }
 }
 
+/** From docs for {@link generated.RuntimeTransaction.method} */
+export const knownRuntimeTxMethods = [
+  'accounts.Transfer',
+  'evm.Call',
+  'evm.Create',
+  'consensus.Deposit',
+  'consensus.Withdraw',
+  'consensus.Delegate',
+  'consensus.Undelegate',
+  'rofl.Create',
+  'rofl.Register',
+  'rofl.Remove',
+  'rofl.Update',
+  'roflmarket.ProviderCreate',
+  'roflmarket.ProviderUpdate',
+  'roflmarket.ProviderUpdateOffers',
+  'roflmarket.ProviderRemove',
+  'roflmarket.InstanceCreate',
+  'roflmarket.InstanceTopUp',
+  'roflmarket.InstanceCancel',
+  'roflmarket.InstanceExecuteCmds',
+  'roflmarket.InstanceChangeAdmin',
+  '',
+] as const
+export type KnownRuntimeTxMethod = (typeof knownRuntimeTxMethods)[number]
+
 export const isAccountEmpty = (account: RuntimeAccount | Account) => {
   if (account.layer === 'consensus') {
     const {