@pezkuwi/api-derive 16.5.5

package/src/imOnline/receivedHeartbeats.ts

@@ -0,0 +1,65 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Observable } from 'rxjs';
+import type { Option, u32 } from '@pezkuwi/types';
+import type { AccountId } from '@pezkuwi/types/interfaces';
+import type { Codec } from '@pezkuwi/types/types';
+import type { DeriveApi, DeriveHeartbeats } from '../types.js';
+
+import { combineLatest, map, of, switchMap } from 'rxjs';
+
+import { BN_ZERO } from '@pezkuwi/util';
+
+import { memo } from '../util/index.js';
+
+type Result = [DeriveHeartbeats, AccountId[], Option<Codec>[], u32[]];
+
+function mapResult ([result, validators, heartbeats, numBlocks]: Result): DeriveHeartbeats {
+  validators.forEach((validator, index): void => {
+    const validatorId = validator.toString();
+    const blockCount = numBlocks[index];
+    const hasMessage = !heartbeats[index].isEmpty;
+    const prev = result[validatorId];
+
+    if (!prev || prev.hasMessage !== hasMessage || !prev.blockCount.eq(blockCount)) {
+      result[validatorId] = {
+        blockCount,
+        hasMessage,
+        isOnline: hasMessage || blockCount.gt(BN_ZERO)
+      };
+    }
+  });
+
+  return result;
+}
+
+/**
+ * @name receivedHeartbeats
+ * @description Return a boolean array indicating whether the passed accounts had received heartbeats in the current session.
+ * @example
+ * ```javascript
+ * let unsub = await api.derive.imOnline.receivedHeartbeats((heartbeat) => {
+ *   console.log(heartbeat);
+ * });
+ * ```
+ */
+export function receivedHeartbeats (instanceId: string, api: DeriveApi): () => Observable<DeriveHeartbeats> {
+  return memo(instanceId, (): Observable<DeriveHeartbeats> =>
+    api.query.imOnline?.receivedHeartbeats
+      ? api.derive.staking.overview().pipe(
+        switchMap(({ currentIndex, validators }): Observable<Result> =>
+          combineLatest([
+            of({}),
+            of(validators),
+            api.query.imOnline.receivedHeartbeats.multi(
+              validators.map((_address, index) => [currentIndex, index])),
+            api.query.imOnline.authoredBlocks.multi(
+              validators.map((address) => [currentIndex, address]))
+          ])
+        ),
+        map(mapResult)
+      )
+      : of({})
+  );
+}

package/src/index.spec.ts

@@ -0,0 +1,103 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/restrict-template-expressions */
+
+import type { ExactDerive } from './index.js';
+
+import { from, Observable } from 'rxjs';
+
+import { ApiRx } from '@pezkuwi/api';
+import { MockProvider } from '@pezkuwi/rpc-provider/mock';
+import { TypeRegistry } from '@pezkuwi/types/create';
+
+const testFunction = (api: ApiRx): any => {
+  return <S extends keyof ExactDerive, M extends keyof (typeof api.derive[S])>(section: S, method: M, inputs: any[]): void => {
+    describe(`derive.${section}.${method as string}`, (): void => {
+      it('should be a function', (): void => {
+        expect(typeof api.derive[section][method]).toBe('function');
+      });
+
+      it('should return an Observable', (): void => {
+        expect((api.derive[section][method] as any)(...inputs)).toBeInstanceOf(Observable);
+      });
+    });
+  };
+};
+
+function waitReady (api: ApiRx): Promise<ApiRx> {
+  return new Promise<ApiRx>((resolve) =>
+    api.isReady.subscribe((api) => resolve(api))
+  );
+}
+
+describe('derive', (): void => {
+  const registry = new TypeRegistry();
+
+  describe('builtin', (): void => {
+    const api = new ApiRx({ provider: new MockProvider(registry), registry });
+
+    beforeAll(async () => {
+      await waitReady(api);
+    });
+    afterAll(() => api.disconnect());
+
+    testFunction(api)('accounts', 'idAndIndex', []);
+    testFunction(api)('accounts', 'idToIndex', []);
+    testFunction(api)('accounts', 'indexes', []);
+    testFunction(api)('accounts', 'indexToId', []);
+
+    testFunction(api)('balances', 'all', []);
+    testFunction(api)('balances', 'votingBalance', []);
+    testFunction(api)('balances', 'votingBalances', []);
+
+    testFunction(api)('chain', 'bestNumber', []);
+    testFunction(api)('chain', 'bestNumberFinalized', []);
+
+    testFunction(api)('democracy', 'proposals', []);
+    testFunction(api)('democracy', 'referendums', []);
+
+    testFunction(api)('elections', 'info', []);
+
+    testFunction(api)('session', 'eraLength', []);
+    testFunction(api)('session', 'eraProgress', []);
+    testFunction(api)('session', 'sessionProgress', []);
+
+    testFunction(api)('staking', 'account', []);
+    testFunction(api)('staking', 'stashes', []);
+  });
+
+  describe('custom', (): void => {
+    const api = new ApiRx({
+      derives: {
+        balances: {
+          fees: (): any => (): Observable<any> => from(['a', 'b'])
+        },
+        custom: {
+          test: (): any => (): Observable<any> => from([1, 2, 3])
+        }
+      },
+      provider: new MockProvider(registry),
+      registry,
+      throwOnConnect: true
+    });
+
+    beforeAll(async () => {
+      await waitReady(api);
+    });
+    afterAll(() => api.disconnect());
+
+    // override
+    testFunction(api)('balances', 'fees', ['a', 'b']);
+
+    // new
+    testFunction(api)('custom', 'test', [1, 2, 3]);
+
+    // existing
+    testFunction(api)('chain', 'bestNumber', []);
+  });
+});

package/src/index.ts

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

package/src/membership/index.ts

@@ -0,0 +1,76 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { hasProposals as collectiveHasProposals, members as collectiveMembers, prime as collectivePrime, proposal as collectiveProposal, proposalCount as collectiveProposalCount, proposalHashes as collectiveProposalHashes, proposals as collectiveProposals } from '../collective/index.js';
+
+/**
+ * @name members
+ * @description Retrieves the list of members in the "membership" collective.
+ * @example
+ * ```javascript
+ * const members = await api.derive.membership.members();
+ * console.log(`Members: ${JSON.stringify(members)});
+ * ```
+ */
+export const members = /*#__PURE__*/ collectiveMembers('membership');
+
+/**
+ * @name hasProposals
+ * @description Checks if there are any active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const exists = await api.derive.membership.hasProposals();
+ * console.log(exists);
+ * ```
+ */
+export const hasProposals = /*#__PURE__*/ collectiveHasProposals('membership');
+/**
+ * @name proposal
+ * @description Retrieves details of a specific proposal in the "membership" collective by its hash.
+ * @example
+ * ```javascript
+ * const proposalDetails = await api.derive.membership.proposal(PROPOSAL_HASH);
+ * console.log(proposalDetails);
+ * ```
+ */
+export const proposal = /*#__PURE__*/ collectiveProposal('membership');
+/**
+ * @name proposalCount
+ * @description Retrieves the total number of proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const count = await api.derive.membership.proposalCount();
+ * console.log(`Amount of proposals: ${count}`);
+ * ```
+ */
+export const proposalCount = /*#__PURE__*/ collectiveProposalCount('membership');
+/**
+ * @name proposalHashes
+ * @description Retrieves an array of hashes for all active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const hashes = await api.derive.membership.proposalHashes();
+ * console.log(`Proposals ${JSON.stringify(hashes)}`);
+ * ```
+ */
+export const proposalHashes = /*#__PURE__*/ collectiveProposalHashes('membership');
+/**
+ * @name proposals
+ * @description Retrieves a list of all active proposals in the "membership" collective.
+ * @example
+ * ```javascript
+ * const proposals = await api.derive.membership.proposals();
+ * console.log(proposals);
+ * ```
+ */
+export const proposals = /*#__PURE__*/ collectiveProposals('membership');
+/**
+ * @name prime
+ * @description Retrieves the prime member of the "membership" collective, if one exists.
+ * @example
+ * ```javascript
+ * const primeMember = await api.derive.membership.prime();
+ * console.log(primeMember);
+ * ```
+ */
+export const prime = /*#__PURE__*/ collectivePrime('membership');

package/src/mod.ts

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

package/src/packageDetect.ts

@@ -0,0 +1,11 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @polkadot/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-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @polkadot/dev
+
+export const packageInfo = { name: '@pezkuwi/api-derive', path: 'auto', type: 'auto', version: '16.5.5' };

package/src/parachains/index.ts

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

package/src/parachains/info.ts

@@ -0,0 +1,111 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Observable } from 'rxjs';
+import type { CollatorId, ParaId } from '@pezkuwi/types/interfaces';
+import type { DeriveApi, DeriveParachainActive, DeriveParachainFull, DeriveParachainInfo } from '../types.js';
+import type { Active, DidUpdate, Heads, ParaInfoResult, PendingSwap, RelayDispatchQueue, RetryQueue, SelectedThreads } from './types.js';
+
+import { map, of } from 'rxjs';
+
+import { objectSpread } from '@pezkuwi/util';
+
+import { memo } from '../util/index.js';
+import { didUpdateToBool } from './util.js';
+
+type Result = [
+  Active,
+  RetryQueue,
+  SelectedThreads,
+  DidUpdate,
+  ParaInfoResult,
+  PendingSwap,
+  Heads,
+  RelayDispatchQueue
+];
+
+function parseActive (id: ParaId, active: Active): DeriveParachainActive | null {
+  const found = active.find(([paraId]) => paraId === id);
+
+  if (found && found[1].isSome) {
+    const [collatorId, retriable] = found[1].unwrap();
+
+    return objectSpread<DeriveParachainActive>(
+      { collatorId },
+      retriable.isWithRetries
+        ? {
+          isRetriable: true,
+          retries: retriable.asWithRetries.toNumber()
+        }
+        : {
+          isRetriable: false,
+          retries: 0
+        }
+    );
+  }
+
+  return null;
+}
+
+function parseCollators (id: ParaId, collatorQueue: SelectedThreads | RetryQueue): (CollatorId | null)[] {
+  return collatorQueue.map((queue): CollatorId | null => {
+    const found = queue.find(([paraId]) => paraId === id);
+
+    return found ? found[1] : null;
+  });
+}
+
+function parse (id: ParaId, [active, retryQueue, selectedThreads, didUpdate, info, pendingSwap, heads, relayDispatchQueue]: Result): DeriveParachainFull | null {
+  if (info.isNone) {
+    return null;
+  }
+
+  return {
+    active: parseActive(id, active),
+    didUpdate: didUpdateToBool(didUpdate, id),
+    heads,
+    id,
+    info: objectSpread<DeriveParachainInfo>({ id }, info.unwrap()),
+    pendingSwapId: pendingSwap.unwrapOr(null),
+    relayDispatchQueue,
+    retryCollators: parseCollators(id, retryQueue),
+    selectedCollators: parseCollators(id, selectedThreads)
+  };
+}
+
+/**
+ * @name info
+ * @param {ParaId | number} id A unique numeric (non-negative integer) identifier for a parachain.
+ * @description Retrieves detailed information about a specific parachain.
+ * @example
+ * ```javascript
+ * await api.derive.parachains.info(1000, (info) => {
+ *   if (info) {
+ *     console.log(`Parachain ${info.id.toString()} is active: ${info.active}`);
+ *   } else {
+ *     console.log("Parachain information not available.");
+ *   }
+ * });
+ * ```
+*/
+export function info (instanceId: string, api: DeriveApi): (id: ParaId | number) => Observable<DeriveParachainFull | null> {
+  return memo(instanceId, (id: ParaId | number): Observable<DeriveParachainFull | null> =>
+    api.query['registrar'] && api.query['parachains']
+      ? api.queryMulti<Result>([
+        api.query['registrar']['active'],
+        api.query['registrar']['retryQueue'],
+        api.query['registrar']['selectedThreads'],
+        api.query['parachains']['didUpdate'],
+        [api.query['registrar']['paras'], id],
+        [api.query['registrar']['pendingSwap'], id],
+        [api.query['parachains']['heads'], id],
+        [api.query['parachains']['relayDispatchQueue'], id]
+      ])
+        .pipe(
+          map((result: Result): DeriveParachainFull | null =>
+            parse(api.registry.createType('ParaId', id), result)
+          )
+        )
+      : of(null)
+  );
+}

package/src/parachains/overview.ts

@@ -0,0 +1,63 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Observable } from 'rxjs';
+import type { ParaId } from '@pezkuwi/types/interfaces';
+import type { DeriveApi, DeriveParachain, DeriveParachainInfo } from '../types.js';
+import type { DidUpdate, ParaInfoResult, PendingSwap, RelayDispatchQueueSize } from './types.js';
+
+import { combineLatest, map, of, switchMap } from 'rxjs';
+
+import { objectSpread } from '@pezkuwi/util';
+
+import { memo } from '../util/index.js';
+import { didUpdateToBool } from './util.js';
+
+type Result = [
+  ParaId[],
+  DidUpdate,
+  RelayDispatchQueueSize[],
+  ParaInfoResult[],
+  PendingSwap[]
+];
+
+function parse ([ids, didUpdate, relayDispatchQueueSizes, infos, pendingSwaps]: Result): DeriveParachain[] {
+  return ids.map((id, index): DeriveParachain => ({
+    didUpdate: didUpdateToBool(didUpdate, id),
+    id,
+    info: objectSpread<DeriveParachainInfo>({ id }, infos[index].unwrapOr(null)),
+    pendingSwapId: pendingSwaps[index].unwrapOr(null),
+    relayDispatchQueueSize: relayDispatchQueueSizes[index][0].toNumber()
+  }));
+}
+
+/**
+ * @name overview
+ * @description Retrieves an overview of all registered parachains.
+ * @example
+ * ```javascript
+ * await api.derive.parachains.overview((overview) => {
+ *   parachains.forEach(parachain => {
+ *     console.log(`Parachain ${parachain.id.toString()} is registered.`);
+ *   });
+ * });
+ * ```
+ */
+export function overview (instanceId: string, api: DeriveApi): () => Observable<DeriveParachain[]> {
+  return memo(instanceId, (): Observable<DeriveParachain[]> =>
+    api.query['registrar']?.['parachains'] && api.query['parachains']
+      ? api.query['registrar']['parachains']<ParaId[]>().pipe(
+        switchMap((paraIds) =>
+          combineLatest([
+            of(paraIds),
+            api.query['parachains']['didUpdate']<DidUpdate>(),
+            api.query['parachains']['relayDispatchQueueSize'].multi<RelayDispatchQueueSize>(paraIds),
+            api.query['registrar']['paras'].multi<ParaInfoResult>(paraIds),
+            api.query['registrar']['pendingSwap'].multi<PendingSwap>(paraIds)
+          ])
+        ),
+        map(parse)
+      )
+      : of([] as DeriveParachain[])
+  );
+}

package/src/parachains/types.ts

@@ -0,0 +1,46 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Bytes, Option, u32, Vec } from '@pezkuwi/types';
+import type { CollatorId, ParaId, ParaInfo, Retriable, UpwardMessage } from '@pezkuwi/types/interfaces';
+import type { ITuple } from '@pezkuwi/types/types';
+
+export type ParaInfoResult = Option<ParaInfo>;
+export type PendingSwap = Option<ParaId>;
+export type Active = Vec<ITuple<[ParaId, Option<ITuple<[CollatorId, Retriable]>>]>>;
+export type RetryQueue = Vec<Vec<ITuple<[ParaId, CollatorId]>>>
+export type SelectedThreads = Vec<Vec<ITuple<[ParaId, CollatorId]>>>
+export type Code = Bytes;
+export type Heads = Bytes;
+export type RelayDispatchQueue = Vec<UpwardMessage>
+export type RelayDispatchQueueSize = ITuple<[u32, u32]>;
+export type DidUpdate = Option<Vec<ParaId>>;
+
+export interface DeriveParachainActive {
+  collatorId: CollatorId;
+  isRetriable: boolean;
+  retries: number;
+}
+
+export interface DeriveParachainInfo extends ParaInfo {
+  id: ParaId;
+  icon?: string;
+  name?: string;
+  owner?: string;
+}
+
+export interface DeriveParachain {
+  didUpdate: boolean;
+  pendingSwapId: ParaId | null;
+  id: ParaId;
+  info: DeriveParachainInfo | null;
+  relayDispatchQueueSize?: number;
+}
+
+export interface DeriveParachainFull extends DeriveParachain {
+  active: DeriveParachainActive | null;
+  heads: Bytes | null;
+  relayDispatchQueue: UpwardMessage[];
+  retryCollators: (CollatorId | null)[];
+  selectedCollators: (CollatorId | null)[];
+}

package/src/parachains/util.ts

@@ -0,0 +1,11 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ParaId } from '@pezkuwi/types/interfaces';
+import type { DidUpdate } from './types.js';
+
+export function didUpdateToBool (didUpdate: DidUpdate, id: ParaId): boolean {
+  return didUpdate.isSome
+    ? didUpdate.unwrap().some((paraId) => paraId.eq(id))
+    : false;
+}

package/src/session/index.ts

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

package/src/session/indexes.ts

@@ -0,0 +1,90 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Observable } from 'rxjs';
+import type { Option, u32 } from '@pezkuwi/types';
+import type { ActiveEraInfo, EraIndex, Moment, SessionIndex } from '@pezkuwi/types/interfaces';
+import type { DeriveApi, DeriveSessionIndexes } from '../types.js';
+
+import { map, of } from 'rxjs';
+
+import { memo } from '../util/index.js';
+
+// parse into Indexes
+function parse ([currentIndex, activeEra, activeEraStart, currentEra, validatorCount]: [SessionIndex, EraIndex, Option<Moment>, EraIndex, u32]): DeriveSessionIndexes {
+  return {
+    activeEra,
+    activeEraStart,
+    currentEra,
+    currentIndex,
+    validatorCount
+  };
+}
+
+// query based on latest
+function queryStaking (api: DeriveApi): Observable<DeriveSessionIndexes> {
+  return api.queryMulti<[SessionIndex, Option<ActiveEraInfo>, Option<EraIndex>, u32]>([
+    api.query.session.currentIndex,
+    api.query.staking.activeEra,
+    api.query.staking.currentEra,
+    api.query.staking.validatorCount
+  ]).pipe(
+    map(([currentIndex, activeOpt, currentEra, validatorCount]): DeriveSessionIndexes => {
+      const { index, start } = activeOpt.unwrapOrDefault();
+
+      return parse([
+        currentIndex,
+        index,
+        start,
+        currentEra.unwrapOrDefault(),
+        validatorCount
+      ]);
+    })
+  );
+}
+
+// query based on latest
+function querySession (api: DeriveApi): Observable<DeriveSessionIndexes> {
+  return api.query.session.currentIndex().pipe(
+    map((currentIndex): DeriveSessionIndexes => parse([
+      currentIndex,
+      api.registry.createType('EraIndex'),
+      api.registry.createType('Option<Moment>'),
+      api.registry.createType('EraIndex'),
+      api.registry.createType('u32')
+    ]))
+  );
+}
+
+// empty set when none is available
+function empty (api: DeriveApi): Observable<DeriveSessionIndexes> {
+  return of(parse([
+    api.registry.createType('SessionIndex', 1),
+    api.registry.createType('EraIndex'),
+    api.registry.createType('Option<Moment>'),
+    api.registry.createType('EraIndex'),
+    api.registry.createType('u32')
+  ]));
+}
+
+/**
+ * @name indexes
+ * @description Retrieves session-related index data, adapting to whether
+ * the chain has staking enabled.
+ * @example
+ * ```javascript
+ * api.derive.session.indexes((indexes) => {
+ *   console.log(`Current session index: ${indexes.currentIndex}`);
+ *   console.log(`Validator count: ${indexes.validatorCount}`);
+ * });
+ * ```
+ */
+export function indexes (instanceId: string, api: DeriveApi): () => Observable<DeriveSessionIndexes> {
+  return memo(instanceId, (): Observable<DeriveSessionIndexes> =>
+    api.query.session
+      ? api.query.staking
+        ? queryStaking(api)
+        : querySession(api)
+      : empty(api)
+  );
+}

package/src/session/info.ts

@@ -0,0 +1,39 @@
+// Copyright 2017-2025 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Observable } from 'rxjs';
+import type { DeriveApi, DeriveSessionInfo } from '../types.js';
+
+import { map } from 'rxjs';
+
+import { objectSpread } from '@pezkuwi/util';
+
+import { memo } from '../util/index.js';
+
+/**
+ * @name info
+ * @description Retrieves all the session and era query and calculates specific values on it as the length of the session and eras.
+ * @example
+ * ```javascript
+ * api.derive.session.info((info) => {
+ *   console.log(`Session info ${JSON.stringify(info)}`);
+ * });
+ * ```
+ */
+export function info (instanceId: string, api: DeriveApi): () => Observable<DeriveSessionInfo> {
+  return memo(instanceId, (): Observable<DeriveSessionInfo> =>
+    api.derive.session.indexes().pipe(
+      map((indexes) => {
+        const sessionLength = api.consts?.babe?.epochDuration || api.registry.createType('u64', 1);
+        const sessionsPerEra = api.consts?.staking?.sessionsPerEra || api.registry.createType('SessionIndex', 1);
+
+        return objectSpread({
+          eraLength: api.registry.createType('BlockNumber', sessionsPerEra.mul(sessionLength)),
+          isEpoch: !!api.query.babe,
+          sessionLength,
+          sessionsPerEra
+        }, indexes);
+      })
+    )
+  );
+}