refactor(networks): simplify network symbol typing

Author: peter-sanderson

networks/README.md

@@ -13,6 +13,10 @@ Every package name must start with `network-`, followed by the network name (for
 | Suite Common | `@trezor/network-<network>-suite-common` |
 | Suite Native | `@trezor/network-<network>-suite-native` |
 
+`@trezor/network-module` contains layer-independent primitives shared by all technical layers.
+Its `NetworkSymbol` is intentionally open-ended; exhaustive symbol unions and mappings belong to
+individual network families.
+
 Suite and Suite Native packages may depend on Suite Common. Suite Common must remain platform-independent and must not depend on Suite or Suite Native.
 
 All the 3rd party dependencies related to a network should be defined inside that network's directory. Moreover, currently they're defined only inside general, no-suffix packages, e.g. `network-cardano` (previously coins packages) and dynamically exported.

networks/bitcoin/network-bitcoin-suite-common/package.json

@@ -14,6 +14,7 @@
     "dependencies": {
         "@noble/hashes": "^2.0.1",
         "@scure/base": "^2.0.0",
+        "@trezor/network-module": "workspace:*",
         "@trezor/network-module-suite-common-types": "workspace:*",
         "@trezor/utils": "workspace:*"
     }

networks/bitcoin/network-bitcoin-suite-common/src/BitcoinNetworkSuiteCommonNetworkModule.ts

@@ -1,17 +1,39 @@
-import type { SuiteCommonNetworkModule } from '@trezor/network-module-suite-common-types';
+import { type NetworkSymbol, asNetworkSymbol } from '@trezor/network-module';
+import type {
+    AddressValidator,
+    SuiteCommonNetworkModule,
+} from '@trezor/network-module-suite-common-types';
+import { isArrayMember } from '@trezor/utils';
 
 import { bitcoinValidator } from './addressValidator/bitcoinAddressValidator';
 import {
     type BitcoinNetworkSymbol,
     getSupportedNetworks,
-    isSupportedNetwork,
+    supportedNetworks,
 } from './supportedNetworks';
 
-export type BitcoinNetworkSuiteCommonNetworkModule = SuiteCommonNetworkModule<BitcoinNetworkSymbol>;
+const isSupportedNetwork = (
+    symbol: NetworkSymbol,
+): symbol is NetworkSymbol & BitcoinNetworkSymbol =>
+    isArrayMember(symbol as string, supportedNetworks);
+
+const toBitcoinNetworkSymbol = (symbol: NetworkSymbol): BitcoinNetworkSymbol => {
+    if (!isSupportedNetwork(symbol)) {
+        throw new Error(`Unsupported Bitcoin network symbol: ${symbol}`);
+    }
+
+    return symbol;
+};
 
-export const createBitcoinSuiteCommonNetworkModule =
-    (): BitcoinNetworkSuiteCommonNetworkModule => ({
-        addressValidator: bitcoinValidator,
-        getSupportedNetworks,
-        isSupportedNetwork,
-    });
+const addressValidator: AddressValidator<NetworkSymbol> = {
+    isAddressValid: (address, symbol) =>
+        bitcoinValidator.isAddressValid(address, toBitcoinNetworkSymbol(symbol)),
+    getAddressType: (address, symbol) =>
+        bitcoinValidator.getAddressType(address, toBitcoinNetworkSymbol(symbol)),
+};
+
+export const createBitcoinSuiteCommonNetworkModule = (): SuiteCommonNetworkModule => ({
+    addressValidator,
+    getSupportedNetworks: () => getSupportedNetworks().map(asNetworkSymbol),
+    isSupportedNetwork,
+});

networks/bitcoin/network-bitcoin-suite-common/src/addressValidator/bitcoinAddressValidator.ts

@@ -63,16 +63,6 @@ const BITCOIN_CURRENCIES: Record<BitcoinCurrencySymbol, BitcoinCurrency> = {
     },
 };
 
-const getCurrency = (symbol: BitcoinCurrencySymbol): BitcoinCurrency => {
-    const currency = BITCOIN_CURRENCIES[symbol];
-
-    if (!currency) {
-        throw new Error(`Unsupported bitcoin network symbol: ${symbol}`);
-    }
-
-    return currency;
-};
-
 const getNetworkEnvironment = (symbol: BitcoinNetworkSymbol): NetworkEnvironment => {
     switch (symbol) {
         case 'test':
@@ -328,7 +318,7 @@ export const getAddressType = (address: string, symbol: BitcoinNetworkSymbol) =>
         return bchValidator.getAddressType(address, symbol);
     }
 
-    const currency = getCurrency(symbol);
+    const currency = BITCOIN_CURRENCIES[symbol];
     const networkEnvironments = getNetworkEnvironments(symbol, currency);
 
     for (const networkEnvironment of networkEnvironments) {

networks/bitcoin/network-bitcoin-suite-common/src/index.ts

@@ -1,2 +1,2 @@
 export { createBitcoinSuiteCommonNetworkModule } from './BitcoinNetworkSuiteCommonNetworkModule';
-export type { BitcoinNetworkSuiteCommonNetworkModule } from './BitcoinNetworkSuiteCommonNetworkModule';
+export type { BitcoinNetworkSymbol } from './supportedNetworks';

networks/bitcoin/network-bitcoin-suite-common/src/supportedNetworks.ts

@@ -1,10 +1,5 @@
-import { isArrayMember } from '@trezor/utils';
-
 export const supportedNetworks = ['btc', 'test', 'regtest', 'ltc', 'doge', 'zec', 'bch'] as const;
 
 export type BitcoinNetworkSymbol = (typeof supportedNetworks)[number];
 
 export const getSupportedNetworks = (): readonly BitcoinNetworkSymbol[] => supportedNetworks;
-
-export const isSupportedNetwork = (symbol: string): symbol is BitcoinNetworkSymbol =>
-    isArrayMember(symbol, supportedNetworks);

networks/bitcoin/network-bitcoin-suite-common/tsconfig.json

@@ -2,6 +2,9 @@
     "extends": "../../../tsconfig.base.json",
     "compilerOptions": { "outDir": "libDev" },
     "references": [
+        {
+            "path": "../../network-module/network-module"
+        },
         {
             "path": "../../network-module/network-module-suite-common-types"
         },

networks/bitcoin/network-bitcoin-suite-common/tsconfig.lib.json

@@ -3,6 +3,9 @@
     "compilerOptions": { "outDir": "./lib" },
     "include": ["./src"],
     "references": [
+        {
+            "path": "../../network-module/network-module/tsconfig.lib.json"
+        },
         {
             "path": "../../network-module/network-module-suite-common-types"
         },

networks/cardano/network-cardano-suite-common/package.json

@@ -13,6 +13,7 @@
     },
     "dependencies": {
         "@scure/base": "^2.0.0",
+        "@trezor/network-module": "workspace:*",
         "@trezor/network-module-suite-common-types": "workspace:*",
         "@trezor/utils": "workspace:*",
         "cbor": "^10.0.12",

networks/cardano/network-cardano-suite-common/src/CardanoNetworkSuiteCommonNetworkModule.ts

@@ -1,17 +1,39 @@
-import type { SuiteCommonNetworkModule } from '@trezor/network-module-suite-common-types';
+import { type NetworkSymbol, asNetworkSymbol } from '@trezor/network-module';
+import type {
+    AddressValidator,
+    SuiteCommonNetworkModule,
+} from '@trezor/network-module-suite-common-types';
+import { isArrayMember } from '@trezor/utils';
 
 import { adaValidator } from './addressValidator/cardanoAddressValidator';
 import {
     type CardanoNetworkSymbol,
     getSupportedNetworks,
-    isSupportedNetwork,
+    supportedNetworks,
 } from './supportedNetworks';
 
-export type CardanoNetworkSuiteCommonNetworkModule = SuiteCommonNetworkModule<CardanoNetworkSymbol>;
+const isSupportedNetwork = (
+    symbol: NetworkSymbol,
+): symbol is NetworkSymbol & CardanoNetworkSymbol =>
+    isArrayMember(symbol as string, supportedNetworks);
+
+const toCardanoNetworkSymbol = (symbol: NetworkSymbol): CardanoNetworkSymbol => {
+    if (!isSupportedNetwork(symbol)) {
+        throw new Error(`Unsupported Cardano network symbol: ${symbol}`);
+    }
+
+    return symbol;
+};
 
-export const createCardanoSuiteCommonNetworkModule =
-    (): CardanoNetworkSuiteCommonNetworkModule => ({
-        addressValidator: adaValidator,
-        getSupportedNetworks,
-        isSupportedNetwork,
-    });
+const addressValidator: AddressValidator<NetworkSymbol> = {
+    isAddressValid: (address, symbol) =>
+        adaValidator.isAddressValid(address, toCardanoNetworkSymbol(symbol)),
+    getAddressType: (address, symbol) =>
+        adaValidator.getAddressType(address, toCardanoNetworkSymbol(symbol)),
+};
+
+export const createCardanoSuiteCommonNetworkModule = (): SuiteCommonNetworkModule => ({
+    addressValidator,
+    getSupportedNetworks: () => getSupportedNetworks().map(asNetworkSymbol),
+    isSupportedNetwork,
+});