@pezkuwi/api-derive 16.5.20 → 16.5.22

package/src/imOnline/receivedHeartbeats.ts

@@ -1,65 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/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

@@ -1,103 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/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

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

package/src/membership/index.ts

@@ -1,76 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/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

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

package/src/packageDetect.ts

@@ -1,11 +0,0 @@
-// Copyright 2017-2026 @pezkuwi/api-derive 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

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

package/src/session/index.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/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

@@ -1,90 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/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

@@ -1,39 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/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);
-      })
-    )
-  );
-}

package/src/session/progress.ts

@@ -1,130 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { Option, u64 } from '@pezkuwi/types';
-import type { BlockNumber, SessionIndex } from '@pezkuwi/types/interfaces';
-import type { DeriveApi, DeriveSessionInfo, DeriveSessionProgress } from '../types.js';
-
-import { combineLatest, map, of, switchMap } from 'rxjs';
-
-import { objectSpread } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-
-type ResultSlotsNoSession = [u64, u64, u64];
-type ResultSlots = [u64, u64, u64, Option<SessionIndex>];
-type ResultSlotsFlat = [u64, u64, u64, SessionIndex];
-
-function withProgressField (field: 'eraLength' | 'eraProgress' | 'sessionProgress'): (instanceId: string, api: DeriveApi) => () => Observable<BlockNumber> {
-  return (instanceId: string, api: DeriveApi) =>
-    memo(instanceId, (): Observable<BlockNumber> =>
-      api.derive.session.progress().pipe(
-        map((info) => info[field])
-      )
-    );
-}
-
-function createDerive (api: DeriveApi, info: DeriveSessionInfo, [currentSlot, epochIndex, epochOrGenesisStartSlot, activeEraStartSessionIndex]: ResultSlotsFlat): DeriveSessionProgress {
-  const epochStartSlot = epochIndex.mul(info.sessionLength).iadd(epochOrGenesisStartSlot);
-  const sessionProgress = currentSlot.sub(epochStartSlot);
-  const eraProgress = info.currentIndex.sub(activeEraStartSessionIndex).imul(info.sessionLength).iadd(sessionProgress);
-
-  return objectSpread({
-    eraProgress: api.registry.createType('BlockNumber', eraProgress),
-    sessionProgress: api.registry.createType('BlockNumber', sessionProgress)
-  }, info);
-}
-
-function queryAura (api: DeriveApi): Observable<DeriveSessionProgress> {
-  return api.derive.session.info().pipe(
-    map((info): DeriveSessionProgress =>
-      objectSpread({
-        eraProgress: api.registry.createType('BlockNumber'),
-        sessionProgress: api.registry.createType('BlockNumber')
-      }, info)
-    )
-  );
-}
-
-function queryBabe (api: DeriveApi): Observable<[DeriveSessionInfo, ResultSlotsFlat]> {
-  return api.derive.session.info().pipe(
-    switchMap((info): Observable<[DeriveSessionInfo, ResultSlots | ResultSlotsNoSession]> =>
-      combineLatest([
-        of(info),
-        // we may have no staking, but have babe (permissioned)
-        api.query.staking?.erasStartSessionIndex
-          ? api.queryMulti<ResultSlots>([
-            api.query.babe.currentSlot,
-            api.query.babe.epochIndex,
-            api.query.babe.genesisSlot,
-            [api.query.staking.erasStartSessionIndex, info.activeEra]
-          ])
-          : api.queryMulti<ResultSlotsNoSession>([
-            api.query.babe.currentSlot,
-            api.query.babe.epochIndex,
-            api.query.babe.genesisSlot
-          ])
-      ])
-    ),
-    map(([info, [currentSlot, epochIndex, genesisSlot, optStartIndex]]): [DeriveSessionInfo, ResultSlotsFlat] => [
-      info, [currentSlot, epochIndex, genesisSlot, optStartIndex && optStartIndex.isSome ? optStartIndex.unwrap() : api.registry.createType('SessionIndex', 1)]
-    ])
-  );
-}
-
-/**
- * @name progress
- * @description Retrieves session information and progress.
- * @example
- * ```javascript
- * api.derive.session.progress((progress) => {
- *   console.log(`Session progress ${JSON.stringify(progress)}`);
- * });
- * ```
- */
-export function progress (instanceId: string, api: DeriveApi): () => Observable<DeriveSessionProgress> {
-  return memo(instanceId, (): Observable<DeriveSessionProgress> =>
-    api.query.babe
-      ? queryBabe(api).pipe(
-        map(([info, slots]: [DeriveSessionInfo, ResultSlotsFlat]): DeriveSessionProgress =>
-          createDerive(api, info, slots)
-        )
-      )
-      : queryAura(api)
-  );
-}
-
-/**
- * @name eraLenght
- * @description Retrieves the total length of the current era.
- * @example
- * ```javascript
- * api.derive.session.eraLength((length) => {
- *   console.log(`Current era length: ${length} sessions`);
- * });
- * ```
- */
-export const eraLength = /*#__PURE__*/ withProgressField('eraLength');
-/**
- * @name eraProgress
- * @description Retrieves the progress of the current era.
- * @example
- * ```javascript
- * api.derive.session.eraProgress((progress) => {
- *   console.log(`Current era progress: ${progress} sessions`);
- * });
- * ```
- */
-export const eraProgress = /*#__PURE__*/ withProgressField('eraProgress');
-/**
- * @name sessionProgress
- * @description Retrieves the progress of the current session.
- * @example
- * ```javascript
- *   api.derive.session.sessionProgress((progress) => {
- *   console.log(`Current session progress: ${progress} slots`);
- * });
- * ```
- */
-export const sessionProgress = /*#__PURE__*/ withProgressField('sessionProgress');

package/src/session/types.ts

@@ -1,25 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Option, u32, u64 } from '@pezkuwi/types';
-import type { BlockNumber, EraIndex, Moment, SessionIndex } from '@pezkuwi/types/interfaces';
-
-export interface DeriveSessionIndexes {
-  activeEra: EraIndex;
-  activeEraStart: Option<Moment>;
-  currentEra: EraIndex;
-  currentIndex: SessionIndex;
-  validatorCount: u32;
-}
-
-export interface DeriveSessionInfo extends DeriveSessionIndexes {
-  eraLength: BlockNumber;
-  isEpoch: boolean;
-  sessionLength: u64;
-  sessionsPerEra: SessionIndex;
-}
-
-export interface DeriveSessionProgress extends DeriveSessionInfo {
-  eraProgress: BlockNumber;
-  sessionProgress: BlockNumber;
-}

package/src/society/candidates.ts

@@ -1,71 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { AccountId32, BalanceOf } from '@pezkuwi/types/interfaces';
-import type { PezpalletSocietyBid, PezpalletSocietyBidKind, PezpalletSocietyCandidacy } from '@pezkuwi/types/lookup';
-import type { ITuple } from '@pezkuwi/types/types';
-import type { Option, Vec } from '@pezkuwi/types-codec';
-import type { DeriveApi, DeriveSocietyCandidate } from '../types.js';
-
-import { combineLatest, map, of, switchMap } from 'rxjs';
-
-import { memo } from '../util/index.js';
-
-type ResultSuspend = Option<ITuple<[BalanceOf, PezpalletSocietyBidKind]>>;
-type Result = [PezpalletSocietyBid[], ResultSuspend[]]
-
-function getPrev (api: DeriveApi): Observable<DeriveSocietyCandidate[]> {
-  return api.query.society.candidates<Vec<PezpalletSocietyBid>>().pipe(
-    switchMap((candidates): Observable<Result> =>
-      combineLatest([
-        of(candidates),
-        api.query.society['suspendedCandidates'].multi<Option<ITuple<[BalanceOf, PezpalletSocietyBidKind]>>>(
-          candidates.map(({ who }) => who)
-        )
-      ])
-    ),
-    map(([candidates, suspended]: Result): DeriveSocietyCandidate[] =>
-      candidates.map(({ kind, value, who }, index) => ({
-        accountId: who,
-        isSuspended: suspended[index].isSome,
-        kind,
-        value
-      }))
-    )
-  );
-}
-
-function getCurr (api: DeriveApi) {
-  return api.query.society.candidates.entries().pipe(
-    map((entries) =>
-      entries
-        .filter(([, opt]) => opt.isSome)
-        .map(([{ args: [accountId] }, opt]): [AccountId32, PezpalletSocietyCandidacy] => [accountId, opt.unwrap()])
-        // FIXME We are missing the new fields from the candidate record
-        .map(([accountId, { bid, kind }]) => ({
-          accountId,
-          isSuspended: false,
-          kind,
-          value: bid
-        }))
-    )
-  );
-}
-
-/**
- * @name candidate
- * @description Retrieves the list of candidates for the society module.
- * @example
- * ```javascript
- * const societyCandidates = await api.derive.society.candidates();
- * console.log(societyCandidates);
- * ```
- */
-export function candidates (instanceId: string, api: DeriveApi): () => Observable<DeriveSocietyCandidate[]> {
-  return memo(instanceId, (): Observable<DeriveSocietyCandidate[]> =>
-    api.query.society['suspendedCandidates'] && api.query.society.candidates.creator.meta.type.isPlain
-      ? getPrev(api)
-      : getCurr(api)
-  );
-}

package/src/society/index.ts

@@ -1,7 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export * from './candidates.js';
-export * from './info.js';
-export * from './member.js';
-export * from './members.js';