@pezkuwi/networks 14.0.9 → 14.0.10

package/src/index.spec.ts

@@ -0,0 +1,120 @@
+// Copyright 2017-2025 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { BizinikwiNetwork } from './types.js';
+
+import { knownGenesis, knownIcon, knownLedger, knownTestnet } from './defaults/index.js';
+import { allNetworks, availableNetworks, selectableNetworks } from './index.js';
+
+describe('availableNetworks', (): void => {
+  it('has the correct starting order', (): void => {
+    expect(availableNetworks.slice(0, 3).map(({ prefix }) => prefix)).toEqual([0, 2, 42]);
+  });
+
+  it('has a sorted list (first external, last external)', (): void => {
+    expect(availableNetworks[3].displayName).toEqual('3DP network');
+    expect(availableNetworks[availableNetworks.length - 1].displayName).toEqual('ZERO');
+  });
+
+  it('has no ignored networks', (): void => {
+    expect(availableNetworks.some(({ isIgnored }) => isIgnored)).toEqual(false);
+  });
+
+  it('has no reserved networks', (): void => {
+    expect(availableNetworks.some(({ prefix }) => prefix === 47)).toEqual(false);
+  });
+
+  it('has allNetworks genesis information', (): void => {
+    expect(
+      Object.entries(knownGenesis).filter(([network, genesisHash]) =>
+        availableNetworks.some((a) =>
+          a.network === network &&
+          genesisHash.some((g, index) => a.genesisHash[index] !== g)
+        )
+      )
+    ).toEqual([]);
+  });
+
+  it('has allNetworks ledger details', (): void => {
+    expect(
+      Object.entries(knownLedger).filter(([network, slip44]) =>
+        availableNetworks.some((a) =>
+          a.network === network && (
+            a.slip44 !== slip44 ||
+            !a.hasLedgerSupport ||
+            !a.genesisHash.length
+          )
+        )
+      )
+    ).toEqual([]);
+  });
+
+  it('has no testnets exposed', (): void => {
+    expect(
+      Object.keys(knownTestnet).filter((network) =>
+        availableNetworks.some((a) =>
+          a.network === network
+        )
+      )
+    ).toEqual([]);
+  });
+
+  it('has allNetworks icons, except for overrides', (): void => {
+    expect(
+      availableNetworks.filter(({ icon, network }) =>
+        icon !== 'substrate' &&
+        knownIcon[network] !== icon
+      )
+    ).toEqual([]);
+  });
+
+  it('has all the correct fields', (): void => {
+    expect(availableNetworks[0]).toEqual({
+      decimals: [10],
+      displayName: 'Polkadot Relay Chain',
+      genesisHash: [
+        '0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3'
+      ],
+      hasLedgerSupport: true,
+      icon: 'polkadot',
+      isIgnored: false,
+      isTestnet: false,
+      network: 'polkadot',
+      prefix: 0,
+      slip44: 354,
+      standardAccount: '*25519',
+      symbols: ['DOT'],
+      website: 'https://polkadot.network'
+    });
+  });
+});
+
+describe('allNetworks', (): void => {
+  it('has no ss58 duplicates', (): void => {
+    const dupes: BizinikwiNetwork[] = [];
+    const uniques: BizinikwiNetwork[] = [];
+
+    allNetworks.forEach((a): void => {
+      if (uniques.some((u) => u.prefix === a.prefix)) {
+        dupes.push(a);
+      } else {
+        uniques.push(a);
+      }
+    });
+
+    expect(dupes).toEqual([]);
+  });
+});
+
+describe('selectableNetworks', (): void => {
+  it('has the correct starting order', (): void => {
+    expect(selectableNetworks.slice(0, 3).map(({ prefix }) => prefix)).toEqual([0, 2, 42]);
+  });
+
+  it('has a sorted list (first external, last external)', (): void => {
+    expect(selectableNetworks[3].displayName).toEqual('3DP network');
+    expect(selectableNetworks[selectableNetworks.length - 1].displayName).toEqual('Zeitgeist');
+  });
+});

package/src/index.ts

@@ -0,0 +1,9 @@
+// Copyright 2017-2025 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// TODO: This was removed, really cannot recall the reason...
+// ... put it back, but keep it removed
+// import './packageDetect.js';
+
+export * from './interfaces.js';
+export { packageInfo } from './packageInfo.js';

package/src/interfaces.ts

@@ -0,0 +1,109 @@
+// Copyright 2017-2025 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { KnownBizinikiwi, Network, BizinikwiNetwork } from './types.js';
+
+import { knownGenesis, knownIcon, knownLedger, knownTestnet } from './defaults/index.js';
+
+// These are known prefixes that are not sorted
+const UNSORTED = [0, 2, 42];
+const TESTNETS = ['testnet'];
+
+const customNetworks: KnownBizinikiwi[] = [
+  {
+    decimals: [10],
+    displayName: 'Pezkuwi Relay Chain',
+    network: 'pezkuwi',
+    prefix: 0,
+    standardAccount: '*25519',
+    symbols: ['PZW'],
+    website: 'https://pezkuwi.com'
+  },
+  {
+    decimals: [12],
+    displayName: 'Zagros Relay Chain',
+    network: 'zagros',
+    prefix: 2,
+    standardAccount: '*25519',
+    symbols: ['ZGS'],
+    website: 'https://zagros.pezkuwi.com'
+  },
+  {
+    decimals: [12],
+    displayName: 'Bizinikiwi',
+    network: 'bizinikiwi',
+    prefix: 42,
+    standardAccount: '*25519',
+    symbols: ['BZN'],
+    website: 'https://bizinikiwi.com'
+  },
+  {
+    decimals: [18],
+    displayName: 'PezkuwiChain',
+    network: 'pezkuwichain',
+    prefix: 1453,
+    standardAccount: '*25519',
+    symbols: ['PZC'],
+    website: 'https://chain.pezkuwi.com'
+  }
+];
+
+function toExpanded (o: KnownBizinikiwi): BizinikwiNetwork {
+  const network = o.network || '';
+  const nameParts = network.replace(/_/g, '-').split('-');
+  const n = o as BizinikwiNetwork;
+
+  // ledger additions
+  n.slip44 = knownLedger[network];
+  n.hasLedgerSupport = !!n.slip44;
+
+  // general items
+  n.genesisHash = knownGenesis[network] || [];
+  n.icon = knownIcon[network] || 'substrate';
+
+  // filtering
+  n.isTestnet = !!knownTestnet[network] || TESTNETS.includes(nameParts[nameParts.length - 1]);
+  n.isIgnored = n.isTestnet || (
+    !(
+      o.standardAccount &&
+      o.decimals?.length &&
+      o.symbols?.length
+    ) &&
+    o.prefix !== 42
+  );
+
+  return n;
+}
+
+function filterSelectable ({ genesisHash, prefix }: Network): boolean {
+  return !!genesisHash.length || prefix === 42;
+}
+
+function filterAvailable (n: BizinikwiNetwork): n is Network {
+  return !n.isIgnored && !!n.network;
+}
+
+function sortNetworks (a: Network, b: Network): number {
+  const isUnSortedA = UNSORTED.includes(a.prefix);
+  const isUnSortedB = UNSORTED.includes(b.prefix);
+
+  return isUnSortedA === isUnSortedB
+    ? isUnSortedA
+      ? 0
+      : a.displayName.localeCompare(b.displayName)
+    : isUnSortedA
+      ? -1
+      : 1;
+}
+
+// This is all the Bizinikiwi networks with our additional information
+export const allNetworks = customNetworks.map(toExpanded);
+
+// The list of available/claimed prefixes
+//   - no testnets
+//   - we only include those where we have a standardAccount
+//   - sort by name, however we keep 0, 2, 42 first in the list
+export const availableNetworks = allNetworks.filter(filterAvailable).sort(sortNetworks);
+
+// A filtered list of those chains we have details about (genesisHashes)
+export const selectableNetworks = availableNetworks.filter(filterSelectable);

package/src/mod.ts

@@ -0,0 +1,4 @@
+// Copyright 2017-2025 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './index.js';

package/src/packageDetect.ts

@@ -0,0 +1,11 @@
+// Copyright 2017-2026 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @pezkuwi/dev
+// (packageInfo imports will be kept as-is, user-editable)
+
+import { detectPackage } from '@pezkuwi/util';
+
+import { packageInfo } from './packageInfo.js';
+
+detectPackage(packageInfo, null, []);

package/src/packageInfo.ts

@@ -0,0 +1,6 @@
+// Copyright 2017-2026 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @pezkuwi/dev
+
+export const packageInfo = { name: '@pezkuwi/networks', path: 'auto', type: 'auto', version: '14.0.10' };

package/src/ss58registry.spec.ts

@@ -0,0 +1,34 @@
+// Copyright 2017-2025 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import known from '@substrate/ss58-registry';
+import fs from 'node:fs';
+
+import { stringify } from '@pezkuwi/util';
+
+describe('@substrate/ss58-registry', (): void => {
+  it('has known values', (): void => {
+    const testUrl = new URL('../test/ss58registry.json', import.meta.url);
+    const json = stringify(known, 2);
+
+    try {
+      expect(
+        JSON.parse(json)
+      ).toEqual(
+        JSON.parse(
+          fs.readFileSync(testUrl, 'utf-8')
+        )
+      );
+    } catch (error) {
+      if (process.env['GITHUB_REPOSITORY']) {
+        console.error(json);
+
+        throw error;
+      }
+
+      fs.writeFileSync(testUrl, json, { flag: 'w' });
+    }
+  });
+});

package/src/types.ts

@@ -0,0 +1,43 @@
+// Copyright 2017-2025 @pezkuwi/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { RegistryEntry } from '@substrate/ss58-registry';
+import type { HexString } from '@pezkuwi/util/types';
+
+export type Icon = 'beachball' | 'empty' | 'jdenticon' | 'polkadot' | 'substrate';
+
+export type KnownIcon = Record<string, Icon>;
+
+export type KnownLedger = Record<string, number>;
+
+export type KnownGenesis = Record<string, HexString[]>;
+
+export type KnownBizinikiwi = RegistryEntry;
+
+export type KnownTestnet = Record<string, true>;
+
+export interface BizinikwiNetwork extends KnownBizinikiwi {
+  /** The genesisHash for the chain */
+  genesisHash: HexString[];
+  /** Does the chain has support for Ledger devices */
+  hasLedgerSupport: boolean;
+  /** The IdentityIcon to use for the chain */
+  icon: Icon;
+  /** Flag set when we don't include this chain */
+  isIgnored: boolean;
+  /** Flag to indicate a testnet */
+  isTestnet: boolean;
+  /** The Ledger-specific/required slip44 for the chain */
+  slip44?: number | null;
+}
+
+export interface Network extends BizinikwiNetwork {
+  /** The network assigned to this chain */
+  network: string;
+}
+
+export interface Ss58Registry {
+  registry: KnownBizinikiwi[];
+  specification: string;
+  schema: Record<keyof KnownBizinikiwi, string>;
+}