@pezkuwi/api-derive 16.5.5 → 16.5.6

package/src/accounts/info.ts

@@ -1,58 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { Bytes, Option, u32 } from '@pezkuwi/types';
-import type { AccountId, AccountIndex, Address, Balance } from '@pezkuwi/types/interfaces';
-import type { ITuple } from '@pezkuwi/types/types';
-import type { DeriveAccountInfo, DeriveAccountRegistration, DeriveApi } from '../types.js';
-
-import { combineLatest, map, of, switchMap } from 'rxjs';
-
-import { u8aToString } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-
-function retrieveNick (api: DeriveApi, accountId?: AccountId): Observable<string | undefined> {
-  return ((
-    accountId && api.query['nicks']?.['nameOf']
-      ? api.query['nicks']['nameOf'](accountId)
-      : of(undefined)
-  ) as Observable<Option<ITuple<[Bytes, Balance]>> | undefined>).pipe(
-    map((nameOf): string | undefined =>
-      nameOf?.isSome
-        ? u8aToString(nameOf.unwrap()[0]).substring(0, (api.consts['nicks']['maxLength'] as u32).toNumber())
-        : undefined
-    )
-  );
-}
-
-/**
- * @name info
- * @description Returns aux. info with regards to an account, current that includes the accountId, accountIndex, identity and nickname
- * @param {(AccountIndex | AccountId | Address | Uint8Array | string | null)} address An accounts in different formats.
- * @example
- * ```javascript
- * const ALICE = "13AU";
- * const info = await api.derive.accounts.info(ALICE);
- * console.log(
- *   "Account Info: ",
- *   Object.keys(info).map((key) => `${key}: ${info[key]}`)
- * );
- * ```
- */
-export function info (instanceId: string, api: DeriveApi): (address?: AccountIndex | AccountId | Address | Uint8Array | string | null) => Observable<DeriveAccountInfo> {
-  return memo(instanceId, (address?: AccountIndex | AccountId | Address | Uint8Array | string | null): Observable<DeriveAccountInfo> =>
-    api.derive.accounts.idAndIndex(address).pipe(
-      switchMap(([accountId, accountIndex]): Observable<[Partial<DeriveAccountInfo>, DeriveAccountRegistration, string | undefined]> =>
-        combineLatest([
-          of({ accountId, accountIndex }),
-          api.derive.accounts.identity(accountId),
-          retrieveNick(api, accountId)
-        ])
-      ),
-      map(([{ accountId, accountIndex }, identity, nickname]): DeriveAccountInfo => ({
-        accountId, accountIndex, identity, nickname
-      }))
-    ));
-}

package/src/accounts/types.ts

@@ -1,48 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { AccountId, AccountIndex, RegistrationJudgement } from '@pezkuwi/types/interfaces';
-import type { Vec } from '@pezkuwi/types-codec';
-
-export type AccountIdAndIndex = [AccountId | undefined, AccountIndex | undefined];
-
-export type AccountIndexes = Record<string, AccountIndex>;
-
-export interface DeriveAccountRegistration {
-  discord?: string | undefined;
-  display?: string | undefined;
-  displayParent?: string | undefined;
-  email?: string | undefined;
-  github?: string | undefined;
-  image?: string | undefined;
-  legal?: string | undefined;
-  matrix?: string | undefined;
-  other?: Record<string, string> | undefined;
-  parent?: AccountId | undefined;
-  pgp?: string | undefined;
-  riot?: string | undefined;
-  subs?: Vec<AccountId> | undefined;
-  twitter?: string | undefined;
-  web?: string | undefined;
-  judgements: RegistrationJudgement[];
-}
-
-export interface DeriveAccountFlags {
-  isCouncil: boolean;
-  isSociety: boolean;
-  isSudo: boolean;
-  isTechCommittee: boolean;
-}
-
-export interface DeriveAccountInfo {
-  accountId?: AccountId | undefined;
-  accountIndex?: AccountIndex | undefined;
-  identity: DeriveAccountRegistration;
-  nickname?: string | undefined;
-}
-
-export interface DeriveHasIdentity {
-  display?: string | undefined;
-  hasIdentity: boolean;
-  parentId?: string | undefined;
-}

package/src/augment.ts

@@ -1,4 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import '@pezkuwi/api-augment';

package/src/bagsList/get.ts

@@ -1,79 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { Option, u64 } from '@pezkuwi/types';
-import type { PalletBagsListListBag } from '@pezkuwi/types/lookup';
-import type { BN } from '@pezkuwi/util';
-import type { DeriveApi } from '../types.js';
-import type { Bag } from './types.js';
-
-import { map, of, switchMap } from 'rxjs';
-
-import { BN_ZERO, bnToBn, objectSpread } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-import { getQueryInterface } from './util.js';
-
-function orderBags (ids: BN[], bags: Option<PalletBagsListListBag>[]): Bag[] {
-  const sorted = ids
-    .map((id, index) => ({
-      bag: bags[index].unwrapOr(null),
-      id,
-      key: id.toString()
-    }))
-    .sort((a, b) => b.id.cmp(a.id));
-  const max = sorted.length - 1;
-
-  return sorted.map((entry, index): Bag =>
-    objectSpread(entry, {
-      bagLower: index === max
-        ? BN_ZERO
-        : sorted[index + 1].id,
-      bagUpper: entry.id,
-      index
-    })
-  );
-}
-
-export function _getIds (instanceId: string, api: DeriveApi): (ids: (BN | number)[]) => Observable<Bag[]> {
-  const query = getQueryInterface(api);
-
-  return memo(instanceId, (_ids: (BN | number)[]): Observable<Bag[]> => {
-    const ids = _ids.map((id) => bnToBn(id));
-
-    return ids.length
-      ? query.listBags.multi<Option<PalletBagsListListBag>>(ids).pipe(
-        map((bags) => orderBags(ids, bags))
-      )
-      : of([]);
-  });
-}
-
-export function all (instanceId: string, api: DeriveApi): () => Observable<Bag[]> {
-  const query = getQueryInterface(api);
-
-  return memo(instanceId, (): Observable<Bag[]> =>
-    query.listBags.keys<[u64]>().pipe(
-      switchMap((keys) =>
-        api.derive.bagsList._getIds(keys.map(({ args: [id] }) => id))
-      ),
-      map((list) =>
-        list.filter(({ bag }) => bag)
-      )
-    )
-  );
-}
-
-/**
- * @name get
- * @param {(BN | number)} id The id of the bag to retrieve.
- * @description Retrieves a specific bag from the BagsList pallet by its id.
- */
-export function get (instanceId: string, api: DeriveApi): (id: BN | number) => Observable<Bag> {
-  return memo(instanceId, (id: BN | number): Observable<Bag> =>
-    api.derive.bagsList._getIds([bnToBn(id)]).pipe(
-      map((bags) => bags[0])
-    )
-  );
-}

package/src/bagsList/getExpanded.ts

@@ -1,41 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { BN } from '@pezkuwi/util';
-import type { DeriveApi } from '../types.js';
-import type { Bag, BagExpanded } from './types.js';
-
-import { map, switchMap } from 'rxjs';
-
-import { objectSpread } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-
-/**
- * @name expand
- * @description Expands a given bag by retrieving all its nodes (accounts contained within the bag).
- * @param {Bag} bag The bag to be expanded.
- */
-export function expand (instanceId: string, api: DeriveApi): (bag: Bag) => Observable<BagExpanded> {
-  return memo(instanceId, (bag: Bag): Observable<BagExpanded> =>
-    api.derive.bagsList.listNodes(bag.bag).pipe(
-      map((nodes) => objectSpread({ nodes }, bag))
-    )
-  );
-}
-
-/**
- * @name getExpanded
- * @description Retrieves and expands a specific bag from the BagsList pallet.
- * @param {BN | number} id The id of the bag to expand.
- */
-export function getExpanded (instanceId: string, api: DeriveApi): (id: BN | number) => Observable<BagExpanded> {
-  return memo(instanceId, (id: BN | number): Observable<BagExpanded> =>
-    api.derive.bagsList.get(id).pipe(
-      switchMap((bag) =>
-        api.derive.bagsList.expand(bag)
-      )
-    )
-  );
-}

package/src/bagsList/index.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export * from './get.js';
-export * from './getExpanded.js';
-export * from './listNodes.js';

package/src/bagsList/listNodes.ts

@@ -1,50 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { Option } from '@pezkuwi/types';
-import type { AccountId32 } from '@pezkuwi/types/interfaces';
-import type { PalletBagsListListBag, PalletBagsListListNode } from '@pezkuwi/types/lookup';
-import type { DeriveApi } from '../types.js';
-
-import { BehaviorSubject, map, of, switchMap, tap, toArray } from 'rxjs';
-
-import { nextTick } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-import { getQueryInterface } from './util.js';
-
-function traverseLinks (api: DeriveApi, head: AccountId32 | string): Observable<PalletBagsListListNode[]> {
-  const subject = new BehaviorSubject<AccountId32 | string>(head);
-  const query = getQueryInterface(api);
-
-  return subject.pipe(
-    switchMap((account) =>
-      query.listNodes<Option<PalletBagsListListNode>>(account)
-    ),
-    tap((node: Option<PalletBagsListListNode>): void => {
-      nextTick((): void => {
-        node.isSome && node.value.next.isSome
-          ? subject.next(node.unwrap().next.unwrap())
-          : subject.complete();
-      });
-    }),
-    toArray(), // toArray since we want to startSubject to be completed
-    map((all: Option<PalletBagsListListNode>[]) =>
-      all.map((o) => o.unwrap())
-    )
-  );
-}
-
-/**
- * @name listNodes
- * @param {(PalletBagsListListBag | null)} bag A reference to a specific bag in the BagsList pallet.
- * @description Retrieves the list of nodes (accounts) contained in a specific bag within the BagsList pallet.
- */
-export function listNodes (instanceId: string, api: DeriveApi): (bag: PalletBagsListListBag | null) => Observable<PalletBagsListListNode[]> {
-  return memo(instanceId, (bag: PalletBagsListListBag | null): Observable<PalletBagsListListNode[]> =>
-    bag && bag.head.isSome
-      ? traverseLinks(api, bag.head.unwrap())
-      : of([])
-  );
-}

package/src/bagsList/types.ts

@@ -1,18 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { PalletBagsListListBag, PalletBagsListListNode } from '@pezkuwi/types/lookup';
-import type { BN } from '@pezkuwi/util';
-
-export interface Bag {
-  bag: PalletBagsListListBag | null;
-  bagUpper: BN;
-  bagLower: BN;
-  id: BN;
-  index: number;
-  key: string;
-}
-
-export interface BagExpanded extends Bag {
-  nodes: PalletBagsListListNode[];
-}

package/src/bagsList/util.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { DeriveApi } from '../types.js';
-
-export function getQueryInterface (api: DeriveApi): DeriveApi['query']['voterList'] {
-  return (
-    // latest substrate & polkadot
-    api.query.voterList ||
-    // previous substrate
-    api.query['voterBagsList'] ||
-    api.query['bagsList']
-  );
-}

package/src/balances/account.ts

@@ -1,210 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { QueryableStorageEntry } from '@pezkuwi/api-base/types';
-import type { AccountData, AccountId, AccountIndex, AccountInfo, Address, Balance, Index } from '@pezkuwi/types/interfaces';
-import type { FrameSystemAccountInfo, PalletBalancesAccountData } from '@pezkuwi/types/lookup';
-import type { ITuple } from '@pezkuwi/types/types';
-import type { DeriveApi, DeriveBalancesAccount, DeriveBalancesAccountData } from '../types.js';
-
-import { combineLatest, map, of, switchMap } from 'rxjs';
-
-import { isFunction, objectSpread } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-
-type BalanceResult = [Balance, Balance, Balance, Balance];
-
-type Result = [Index, BalanceResult[], AccountType];
-
-interface AccountType { isFrameAccountData: boolean }
-
-type DeriveCustomAccount = DeriveApi['derive'] & Record<string, {
-  customAccount?: DeriveApi['query']['balances']['account']
-}>
-
-function zeroBalance (api: DeriveApi) {
-  return api.registry.createType('Balance');
-}
-
-function getBalance (api: DeriveApi, [freeBalance, reservedBalance, frozenFeeOrFrozen, frozenMiscOrFlags]: BalanceResult, accType: AccountType): DeriveBalancesAccountData {
-  const votingBalance = api.registry.createType('Balance', freeBalance.toBn());
-
-  if (accType.isFrameAccountData) {
-    return {
-      frameSystemAccountInfo: {
-        flags: frozenMiscOrFlags,
-        frozen: frozenFeeOrFrozen
-      },
-      freeBalance,
-      frozenFee: api.registry.createType('Balance', 0),
-      frozenMisc: api.registry.createType('Balance', 0),
-      reservedBalance,
-      votingBalance
-    };
-  }
-
-  return {
-    freeBalance,
-    frozenFee: frozenFeeOrFrozen,
-    frozenMisc: frozenMiscOrFlags,
-    reservedBalance,
-    votingBalance
-  };
-}
-
-function calcBalances (api: DeriveApi, [accountId, [accountNonce, [primary, ...additional], accType]]: [AccountId, Result]): DeriveBalancesAccount {
-  return objectSpread({
-    accountId,
-    accountNonce,
-    additional: additional.map((b) => getBalance(api, b, accType))
-  }, getBalance(api, primary, accType));
-}
-
-// old
-function queryBalancesFree (api: DeriveApi, accountId: AccountId): Observable<Result> {
-  return combineLatest([
-    api.query.balances['freeBalance']<Balance>(accountId),
-    api.query.balances['reservedBalance']<Balance>(accountId),
-    api.query.system['accountNonce']<Index>(accountId)
-  ]).pipe(
-    map(([freeBalance, reservedBalance, accountNonce]): Result => [
-      accountNonce,
-      [[freeBalance, reservedBalance, zeroBalance(api), zeroBalance(api)]],
-      { isFrameAccountData: false }
-    ])
-  );
-}
-
-function queryNonceOnly (api: DeriveApi, accountId: AccountId): Observable<Result> {
-  const fill = (nonce: Index): Result => [
-    nonce,
-    [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
-    { isFrameAccountData: false }
-  ];
-
-  return isFunction(api.query.system.account)
-    ? api.query.system.account(accountId).pipe(
-      map(({ nonce }) => fill(nonce))
-    )
-    : isFunction(api.query.system['accountNonce'])
-      ? api.query.system['accountNonce']<Index>(accountId).pipe(
-        map((nonce) => fill(nonce))
-      )
-      : of(fill(api.registry.createType('Index')));
-}
-
-function queryBalancesAccount (api: DeriveApi, accountId: AccountId, modules: string[] = ['balances']): Observable<Result> {
-  const balances = modules
-    .map((m): QueryableStorageEntry<'rxjs'> => (api.derive as DeriveCustomAccount)[m]?.customAccount || api.query[m as 'balances']?.account)
-    .filter((q) => isFunction(q));
-
-  const extract = (nonce: Index, data: AccountData[]): Result => [
-    nonce,
-    data.map(({ feeFrozen, free, miscFrozen, reserved }): BalanceResult => [free, reserved, feeFrozen, miscFrozen]),
-    { isFrameAccountData: false }
-  ];
-
-  // NOTE this is for the first case where we do have instances specified
-  return balances.length
-    ? isFunction(api.query.system.account)
-      ? combineLatest([
-        api.query.system.account(accountId),
-        ...balances.map((c) => c(accountId))
-      ]).pipe(
-        map(([{ nonce }, ...balances]) => extract(nonce, balances as unknown as AccountData[]))
-      )
-      : combineLatest([
-        api.query.system['accountNonce']<Index>(accountId),
-        ...balances.map((c) => c(accountId))
-      ]).pipe(
-        map(([nonce, ...balances]) => extract(nonce, balances as unknown as AccountData[]))
-      )
-    : queryNonceOnly(api, accountId);
-}
-
-function querySystemAccount (api: DeriveApi, accountId: AccountId): Observable<Result> {
-  // AccountInfo is current, support old, eg. Edgeware
-  return api.query.system.account<AccountInfo | FrameSystemAccountInfo | ITuple<[Index, AccountData]>>(accountId).pipe(
-    map((infoOrTuple): Result => {
-      const data = (infoOrTuple as AccountInfo).nonce
-        ? (infoOrTuple as AccountInfo).data
-        : (infoOrTuple as [Index, AccountData])[1];
-
-      const nonce = (infoOrTuple as AccountInfo).nonce || (infoOrTuple as [Index, AccountData])[0];
-
-      if (!data || data.isEmpty) {
-        return [
-          nonce,
-          [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
-          { isFrameAccountData: false }
-        ];
-      }
-
-      const isFrameType = !!(infoOrTuple as FrameSystemAccountInfo).data.frozen;
-
-      if (isFrameType) {
-        const { flags, free, frozen, reserved } = (data as unknown as PalletBalancesAccountData);
-
-        return [
-          nonce,
-          [[free, reserved, frozen, flags]],
-          { isFrameAccountData: true }
-        ];
-      } else {
-        const { feeFrozen, free, miscFrozen, reserved } = data;
-
-        return [
-          nonce,
-          [[free, reserved, feeFrozen, miscFrozen]],
-          { isFrameAccountData: false }
-        ];
-      }
-    })
-  );
-}
-
-/**
- * @name account
- * @description Retrieves the essential balance details for an account, such as free balance and account nonce.
- * @param {( AccountIndex | AccountId | Address | string )} address An accountsId in different formats.
- * @example
- * ```javascript
- * const ALICE = 'F7Hs';
- *
- * api.derive.balances.all(ALICE, ({ accountId, lockedBalance }) => {
- *   console.log(`The account ${accountId} has a locked balance ${lockedBalance} units.`);
- * });
- * ```
- */
-export function account (instanceId: string, api: DeriveApi): (address: AccountIndex | AccountId | Address | string) => Observable<DeriveBalancesAccount> {
-  const balanceInstances = api.registry.getModuleInstances(api.runtimeVersion.specName, 'balances');
-  const nonDefaultBalances = balanceInstances && balanceInstances[0] !== 'balances';
-
-  return memo(instanceId, (address: AccountIndex | AccountId | Address | string): Observable<DeriveBalancesAccount> =>
-    api.derive.accounts.accountId(address).pipe(
-      switchMap((accountId): Observable<[AccountId, Result]> =>
-        (accountId
-          ? combineLatest([
-            of(accountId),
-            nonDefaultBalances
-              ? queryBalancesAccount(api, accountId, balanceInstances)
-              : isFunction(api.query.system?.account)
-                ? querySystemAccount(api, accountId)
-                : isFunction(api.query.balances?.account)
-                  ? queryBalancesAccount(api, accountId)
-                  : isFunction(api.query.balances?.['freeBalance'])
-                    ? queryBalancesFree(api, accountId)
-                    : queryNonceOnly(api, accountId)
-          ])
-          : of([api.registry.createType('AccountId'), [
-            api.registry.createType('Index'),
-            [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
-            { isFrameAccountData: false }
-          ]])
-        )
-      ),
-      map((result): DeriveBalancesAccount => calcBalances(api, result))
-    ));
-}