@pezkuwi/ui-keyring 3.16.6 → 3.16.8

package/src/observable/genericSubject.ts

@@ -1,66 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeypairType } from '@pezkuwi/util-crypto/types';
-import type { KeyringJson, KeyringStore } from '../types.js';
-import type { AddressSubject, SingleAddress, SubjectInfo } from './types.js';
-
-import { BehaviorSubject } from 'rxjs';
-
-import { objectCopy, objectSpread } from '@pezkuwi/util';
-
-import { createOptionItem } from '../options/item.js';
-import { env } from './env.js';
-
-function callNext (current: SubjectInfo, subject: BehaviorSubject<SubjectInfo>, withTest: boolean): void {
-  const isDevMode = env.isDevelopment();
-  const filtered: SubjectInfo = {};
-
-  Object.keys(current).forEach((key): void => {
-    const { json: { meta: { isTesting = false } = {} } = {} } = current[key];
-
-    if (!withTest || isDevMode || isTesting !== true) {
-      filtered[key] = current[key];
-    }
-  });
-
-  subject.next(filtered);
-}
-
-export function genericSubject (keyCreator: (address: string) => string, withTest = false): AddressSubject {
-  let current: SubjectInfo = {};
-  const subject = new BehaviorSubject({});
-  const next = (): void => callNext(current, subject, withTest);
-
-  env.subject.subscribe(next);
-
-  return {
-    add: (store: KeyringStore, address: string, json: KeyringJson, type?: KeypairType): SingleAddress => {
-      current = objectCopy(current);
-
-      current[address] = {
-        json: objectSpread({}, json, { address }),
-        option: createOptionItem(address, json.meta.name),
-        type
-      };
-
-      // we do not store dev or injected accounts (external/transient)
-      if (!json.meta.isInjected && (!json.meta.isTesting || env.isDevelopment())) {
-        store.set(keyCreator(address), json);
-      }
-
-      next();
-
-      return current[address];
-    },
-    remove: (store: KeyringStore, address: string): void => {
-      current = objectCopy(current);
-
-      delete current[address];
-
-      store.remove(keyCreator(address));
-      next();
-    },
-    subject
-  };
-}

package/src/observable/index.ts

@@ -1,28 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { SubjectInfo } from './types.js';
-
-import { combineLatest, map } from 'rxjs';
-
-import { accounts } from './accounts.js';
-import { addresses } from './addresses.js';
-import { contracts } from './contracts.js';
-
-interface Result {
-  accounts: SubjectInfo;
-  addresses: SubjectInfo;
-  contracts: SubjectInfo;
-}
-
-export const obervableAll = /*#__PURE__*/ combineLatest([
-  accounts.subject,
-  addresses.subject,
-  contracts.subject
-]).pipe(
-  map(([accounts, addresses, contracts]): Result => ({
-    accounts,
-    addresses,
-    contracts
-  }))
-);

package/src/observable/types.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BehaviorSubject } from 'rxjs';
-import type { KeypairType } from '@pezkuwi/util-crypto/types';
-import type { KeyringSectionOption } from '../options/types.js';
-import type { KeyringJson, KeyringStore } from '../types.js';
-
-export interface SingleAddress {
-  json: KeyringJson;
-  option: KeyringSectionOption;
-  type?: KeypairType | undefined;
-}
-
-export type SubjectInfo = Record<string, SingleAddress>;
-
-export interface AddressSubject {
-  add: (store: KeyringStore, address: string, json: KeyringJson, type?: KeypairType) => SingleAddress;
-  remove: (store: KeyringStore, address: string) => void;
-  subject: BehaviorSubject<SubjectInfo>;
-}

package/src/options/index.ts

@@ -1,150 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Subscription } from 'rxjs';
-import type { SingleAddress } from '../observable/types.js';
-import type { KeyringStruct } from '../types.js';
-import type { KeyringOptionInstance, KeyringOptions, KeyringSectionOption, KeyringSectionOptions } from './types.js';
-
-import { BehaviorSubject } from 'rxjs';
-
-import { obervableAll } from '../observable/index.js';
-
-let hasCalledInitOptions = false;
-
-const sortByName = (a: SingleAddress, b: SingleAddress): number => {
-  const valueA = a.option.name;
-  const valueB = b.option.name;
-
-  return valueA.localeCompare(valueB);
-};
-
-const sortByCreated = (a: SingleAddress, b: SingleAddress): number => {
-  const valueA = a.json.meta.whenCreated || 0;
-  const valueB = b.json.meta.whenCreated || 0;
-
-  if (valueA < valueB) {
-    return 1;
-  }
-
-  if (valueA > valueB) {
-    return -1;
-  }
-
-  return 0;
-};
-
-export class KeyringOption implements KeyringOptionInstance {
-  #allSub: Subscription | null = null;
-
-  public readonly optionsSubject = new BehaviorSubject<KeyringOptions>(this.emptyOptions());
-
-  public createOptionHeader (name: string): KeyringSectionOption {
-    return {
-      key: `header-${name.toLowerCase()}`,
-      name,
-      value: null
-    };
-  }
-
-  public init (keyring: KeyringStruct): void {
-    if (hasCalledInitOptions) {
-      throw new Error('Unable to initialise options more than once');
-    }
-
-    this.#allSub = obervableAll.subscribe((): void => {
-      const opts = this.emptyOptions();
-
-      this.addAccounts(keyring, opts);
-      this.addAddresses(keyring, opts);
-      this.addContracts(keyring, opts);
-
-      opts.address = this.linkItems({ Addresses: opts.address, Recent: opts.recent });
-      opts.account = this.linkItems({ Accounts: opts.account, Development: opts.testing });
-      opts.contract = this.linkItems({ Contracts: opts.contract });
-      opts.all = ([] as KeyringSectionOptions).concat(opts.account, opts.address);
-      opts.allPlus = ([] as KeyringSectionOptions).concat(opts.account, opts.address, opts.contract);
-
-      this.optionsSubject.next(opts);
-    });
-
-    hasCalledInitOptions = true;
-  }
-
-  public clear (): void {
-    if (this.#allSub) {
-      this.#allSub.unsubscribe();
-    }
-  }
-
-  private linkItems (items: Record<string, KeyringSectionOptions>): KeyringSectionOptions {
-    return Object.keys(items).reduce((result, header): KeyringSectionOptions => {
-      const options = items[header];
-
-      return result.concat(
-        options.length
-          ? [this.createOptionHeader(header)]
-          : [],
-        options
-      );
-    }, [] as KeyringSectionOptions);
-  }
-
-  private addAccounts (keyring: KeyringStruct, options: KeyringOptions): void {
-    const available = keyring.accounts.subject.getValue();
-
-    Object
-      .values(available)
-      .sort(sortByName)
-      .forEach(({ json: { meta: { isTesting = false } }, option }: SingleAddress): void => {
-        if (!isTesting) {
-          options.account.push(option);
-        } else {
-          options.testing.push(option);
-        }
-      });
-  }
-
-  private addAddresses (keyring: KeyringStruct, options: KeyringOptions): void {
-    const available = keyring.addresses.subject.getValue();
-
-    Object
-      .values(available)
-      .filter(({ json }: SingleAddress): boolean => !!json.meta.isRecent)
-      .sort(sortByCreated)
-      .forEach(({ option }: SingleAddress): void => {
-        options.recent.push(option);
-      });
-
-    Object
-      .values(available)
-      .filter(({ json }: SingleAddress): boolean => !json.meta.isRecent)
-      .sort(sortByName)
-      .forEach(({ option }: SingleAddress): void => {
-        options.address.push(option);
-      });
-  }
-
-  private addContracts (keyring: KeyringStruct, options: KeyringOptions): void {
-    const available = keyring.contracts.subject.getValue();
-
-    Object
-      .values(available)
-      .sort(sortByName)
-      .forEach(({ option }: SingleAddress): void => {
-        options.contract.push(option);
-      });
-  }
-
-  private emptyOptions (): KeyringOptions {
-    return {
-      account: [],
-      address: [],
-      all: [],
-      allPlus: [],
-      contract: [],
-      recent: [],
-      testing: []
-    };
-  }
-}

package/src/options/item.ts

@@ -1,22 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeyringSectionOption } from './types.js';
-
-import { isUndefined } from '@pezkuwi/util';
-
-export function createOptionItem (address: string, _name?: string): KeyringSectionOption {
-  const name = isUndefined(_name)
-    ? (
-      (address.length > 15)
-        ? `${address.slice(0, 6)}…${address.slice(-6)}`
-        : address
-    )
-    : _name;
-
-  return {
-    key: address,
-    name,
-    value: address
-  };
-}

package/src/options/types.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeyringItemType, KeyringStruct } from '../types.js';
-
-export interface KeyringSectionOption {
-  key: string | null;
-  name: string;
-  value: string | null;
-}
-
-export type KeyringSectionOptions = KeyringSectionOption[];
-
-export type KeyringOptions = {
-  [type in KeyringItemType | 'all' | 'allPlus' | 'recent' | 'testing']: KeyringSectionOptions
-};
-
-export type KeyringOption$Type = keyof KeyringOptions;
-
-export interface KeyringOptionInstance {
-  createOptionHeader: (name: string) => KeyringSectionOption;
-  init: (keyring: KeyringStruct) => void;
-}

package/src/packageDetect.ts

@@ -1,12 +0,0 @@
-// Copyright 2017-2026 @pezkuwi/ui-keyring 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 { packageInfo as settingsInfo } from '@pezkuwi/ui-settings/packageInfo';
-import { detectPackage } from '@pezkuwi/util';
-
-import { packageInfo } from './packageInfo.js';
-
-detectPackage(packageInfo, null, [settingsInfo]);

package/src/packageInfo.ts

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

package/src/stores/Browser.ts

@@ -1,28 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeyringJson, KeyringStore } from '../types.js';
-
-import store from 'store';
-
-export class BrowserStore implements KeyringStore {
-  public all (fn: (key: string, value: KeyringJson) => void): void {
-    store.each((value: KeyringJson, key: string): void => {
-      fn(key, value);
-    });
-  }
-
-  public get (key: string, fn: (value: KeyringJson) => void): void {
-    fn(store.get(key) as KeyringJson);
-  }
-
-  public remove (key: string, fn?: () => void): void {
-    store.remove(key);
-    fn && fn();
-  }
-
-  public set (key: string, value: KeyringJson, fn?: () => void): void {
-    store.set(key, value);
-    fn && fn();
-  }
-}

package/src/stores/File.ts

@@ -1,94 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeyringJson, KeyringStore } from '../types.js';
-
-import { mkdirpSync } from 'mkdirp';
-import fs from 'node:fs';
-import path from 'node:path';
-
-// NOTE untested and unused by any known apps, probably broken in various mysterious ways
-export class FileStore implements KeyringStore {
-  #path: string;
-
-  constructor (path: string) {
-    if (!fs.existsSync(path)) {
-      mkdirpSync(path);
-    }
-
-    this.#path = path;
-  }
-
-  private validateKey (key: string): boolean {
-    // Make sure the key has a .json extension
-    if (!key.endsWith('.json')) {
-      console.error('Non-JSON file requested: ', key);
-
-      return false;
-    }
-
-    // Remove '.json'
-    const keyWithoutExtension = key.slice(0, -5);
-    // Only allow alphanumeric characters, hyphens, and underscores in the base filename
-    const safeKeyRegex = /^[a-zA-Z0-9_-]+$/;
-
-    if (!safeKeyRegex.test(keyWithoutExtension)) {
-      console.error('Invalid key format detected: ', key);
-
-      return false;
-    }
-
-    return true;
-  }
-
-  public all (fn: (key: string, value: KeyringJson) => void): void {
-    fs
-      .readdirSync(this.#path)
-      .filter((key): boolean => !['.', '..', '.DS_Store'].includes(key))
-      .forEach((key): void => {
-        const value = this._readKey(key);
-
-        value?.address && fn(key, value);
-      });
-  }
-
-  public get (key: string, fn: (value: KeyringJson) => void): void {
-    const value = this._readKey(key);
-
-    if (!value?.address) {
-      throw new Error(`Invalid JSON found for ${key}`);
-    }
-
-    fn(value);
-  }
-
-  public remove (key: string, fn?: () => void): void {
-    fs.unlinkSync(this._getPath(key));
-    fn && fn();
-  }
-
-  public set (key: string, value: KeyringJson, fn?: () => void): void {
-    fs.writeFileSync(this._getPath(key), Buffer.from(JSON.stringify(value), 'utf-8'));
-    fn && fn();
-  }
-
-  private _getPath (key: string): string {
-    if (!this.validateKey(key)) {
-      throw new Error('Invalid key format');
-    }
-
-    return path.join(this.#path, key);
-  }
-
-  private _readKey (key: string): KeyringJson | undefined {
-    try {
-      return JSON.parse(
-        fs.readFileSync(this._getPath(key)).toString('utf-8')
-      ) as KeyringJson;
-    } catch (error) {
-      console.error(error);
-    }
-
-    return undefined;
-  }
-}

package/src/stores/index.ts

@@ -1,5 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { BrowserStore } from './Browser.js';
-export { FileStore } from './File.js';

package/src/types.ts

@@ -1,91 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/ui-keyring authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeyringInstance as BaseKeyringInstance, KeyringOptions as KeyringOptionsBase, KeyringPair, KeyringPair$Json, KeyringPair$Meta } from '@pezkuwi/keyring/types';
-import type { HexString } from '@pezkuwi/util/types';
-import type { EncryptedJson } from '@pezkuwi/util-crypto/json/types';
-import type { KeypairType } from '@pezkuwi/util-crypto/types';
-import type { AddressSubject, SingleAddress } from './observable/types.js';
-
-export type ContractMeta = NonNullable<KeyringPair$Meta['contract']>;
-
-export type KeyringJson$Meta = KeyringPair$Meta;
-
-export interface KeyringJson {
-  address: string;
-  meta: KeyringJson$Meta;
-}
-
-export interface KeyringPairs$Json extends EncryptedJson {
-  accounts: KeyringJson[];
-}
-
-export interface KeyringStore {
-  all: (cb: (key: string, value: KeyringJson) => void) => void;
-  get: (key: string, cb: (value: KeyringJson) => void) => void;
-  remove: (key: string, cb?: () => void) => void;
-  set: (key: string, value: KeyringJson, cb?: () => void) => void;
-}
-
-export interface KeyringOptions extends KeyringOptionsBase {
-  filter?: (json: KeyringJson) => boolean;
-  genesisHash?: HexString | { toHex: () => HexString };
-  genesisHashAdd?: HexString[];
-  isDevelopment?: boolean;
-  store?: KeyringStore;
-}
-
-export interface KeyringAddress {
-  readonly address: string;
-  readonly meta: KeyringJson$Meta;
-  readonly publicKey: Uint8Array;
-}
-
-export type KeyringAddressType = 'address' | 'contract';
-
-export type KeyringItemType = 'account' | KeyringAddressType;
-
-export interface CreateResult {
-  json: KeyringPair$Json;
-  pair: KeyringPair;
-}
-
-export interface KeyringStruct {
-  readonly accounts: AddressSubject;
-  readonly addresses: AddressSubject;
-  readonly contracts: AddressSubject;
-  readonly keyring: BaseKeyringInstance | undefined;
-  readonly genesisHash?: string | undefined;
-
-  addExternal: (publicKey: Uint8Array, meta?: KeyringPair$Meta) => CreateResult;
-  addPair: (pair: KeyringPair, password: string) => CreateResult;
-  addUri: (suri: string, password?: string, meta?: KeyringPair$Meta, type?: KeypairType) => CreateResult;
-  backupAccount: (pair: KeyringPair, password: string) => KeyringPair$Json;
-  backupAccounts: (addresses: string[], password: string) => Promise<KeyringPairs$Json>
-  createFromUri (suri: string, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
-  decodeAddress: (key: string | Uint8Array) => Uint8Array;
-  encodeAddress: (key: string | Uint8Array) => string;
-  encryptAccount: (pair: KeyringPair, password: string) => void;
-  forgetAccount: (address: string) => void;
-  forgetAddress: (address: string) => void;
-  forgetContract: (address: string) => void;
-  getAccount: (address: string | Uint8Array) => KeyringAddress | undefined;
-  getAccounts: () => KeyringAddress[];
-  getAddress: (address: string | Uint8Array, type: KeyringItemType | null) => KeyringAddress | undefined;
-  getAddresses: () => KeyringAddress[];
-  getContract: (address: string | Uint8Array) => KeyringAddress | undefined;
-  getContracts: (genesisHash?: string) => KeyringAddress[];
-  getPair: (address: string | Uint8Array) => KeyringPair;
-  getPairs: () => KeyringPair[];
-  isAvailable: (address: string | Uint8Array) => boolean;
-  isPassValid: (password: string) => boolean;
-  loadAll: (options: KeyringOptions) => void;
-  restoreAccount: (json: KeyringPair$Json, password: string) => KeyringPair;
-  restoreAccounts: (json: EncryptedJson, password: string) => void;
-  saveAccount: (pair: KeyringPair, password?: string) => KeyringPair$Json;
-  saveAccountMeta: (pair: KeyringPair, meta: KeyringPair$Meta) => void;
-  saveAddress: (address: string, meta: KeyringPair$Meta) => KeyringPair$Json;
-  saveContract: (address: string, meta: KeyringPair$Meta) => KeyringPair$Json;
-  saveRecent: (address: string) => SingleAddress;
-  setDevMode: (isDevelopment: boolean) => void;
-}

package/tsconfig.build.json

@@ -1,14 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": "..",
-    "outDir": "./build",
-    "rootDir": "./src"
-  },
-  "exclude": [
-    "**/*.spec.ts"
-  ],
-  "references": [
-    { "path": "../ui-settings/tsconfig.build.json" }
-  ]
-}