@pezkuwi/api-derive 16.5.5 → 16.5.6

package/src/collective/proposals.ts

@@ -1,73 +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 { Hash, Proposal, Votes } from '@pezkuwi/types/interfaces';
-import type { DeriveApi, DeriveCollectiveProposal } from '../types.js';
-import type { Collective, HasProposalsFnRet, ProposalCountFn, ProposalFnRet, ProposalHashesFn, ProposalsFnRet } from './types.js';
-
-import { catchError, combineLatest, map, of, switchMap } from 'rxjs';
-
-import { isFunction } from '@pezkuwi/util';
-
-import { firstObservable } from '../util/index.js';
-import { callMethod, withSection } from './helpers.js';
-
-type Result = [(Hash | Uint8Array | string)[], (Option<Proposal> | null)[], Option<Votes>[]];
-
-function parse (api: DeriveApi, [hashes, proposals, votes]: Result): DeriveCollectiveProposal[] {
-  return proposals.map((o, index): DeriveCollectiveProposal => ({
-    hash: api.registry.createType('Hash', hashes[index]),
-    proposal: o && o.isSome
-      ? o.unwrap()
-      : null,
-    votes: votes[index].unwrapOr(null)
-  }));
-}
-
-function _proposalsFrom (api: DeriveApi, query: DeriveApi['query']['council'], hashes: (Hash | Uint8Array | string)[]): Observable<DeriveCollectiveProposal[]> {
-  return (isFunction(query?.proposals) && hashes.length
-    ? combineLatest([
-      of(hashes),
-      // this should simply be api.query[section].proposalOf.multi<Option<Proposal>>(hashes),
-      // however we have had cases on Edgeware where the indices have moved around after an
-      // upgrade, which results in invalid on-chain data
-      query.proposalOf.multi<Option<Proposal>>(hashes).pipe(
-        catchError(() => of(hashes.map(() => null)))
-      ),
-      query.voting.multi<Option<Votes>>(hashes)
-    ])
-    : of<Result>([[], [], []])
-  ).pipe(
-    map((r) => parse(api, r))
-  );
-}
-
-export function hasProposals (section: Collective): HasProposalsFnRet {
-  return withSection(section, (query) =>
-    (): Observable<boolean> =>
-      of(isFunction(query?.proposals))
-  );
-}
-
-export function proposals (section: Collective): ProposalsFnRet {
-  return withSection(section, (query, api) =>
-    (): Observable<DeriveCollectiveProposal[]> =>
-      api.derive[section as 'council'].proposalHashes().pipe(
-        switchMap((all) => _proposalsFrom(api, query, all))
-      )
-  );
-}
-
-export function proposal (section: Collective): ProposalFnRet {
-  return withSection(section, (query, api) =>
-    (hash: Hash | Uint8Array | string): Observable<DeriveCollectiveProposal | null> =>
-      isFunction(query?.proposals)
-        ? firstObservable(_proposalsFrom(api, query, [hash]))
-        : of(null)
-  );
-}
-
-export const proposalCount: ProposalCountFn = /*#__PURE__*/ callMethod('proposalCount', null);
-export const proposalHashes: ProposalHashesFn = /*#__PURE__*/ callMethod('proposals', []);

package/src/contracts/fees.ts

@@ -1,61 +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, DeriveContractFees } from '../types.js';
-
-import { map, of } from 'rxjs';
-
-import { memo } from '../util/index.js';
-
-type ResultV2 = [BN, BN, BN, BN, BN, BN, BN, BN, BN, BN];
-
-// query via constants (current applicable path)
-function queryConstants (api: DeriveApi): Observable<ResultV2> {
-  return of([
-    // deprecated
-    api.consts.contracts['callBaseFee'] || api.registry.createType('Balance'),
-    api.consts.contracts['contractFee'] || api.registry.createType('Balance'),
-    api.consts.contracts['creationFee'] || api.registry.createType('Balance'),
-    api.consts.contracts['transactionBaseFee'] || api.registry.createType('Balance'),
-    api.consts.contracts['transactionByteFee'] || api.registry.createType('Balance'),
-    api.consts.contracts['transferFee'] || api.registry.createType('Balance'),
-
-    // current
-    api.consts.contracts['rentByteFee'] || api.registry.createType('Balance'),
-    api.consts.contracts['rentDepositOffset'] || api.registry.createType('Balance'),
-    api.consts.contracts['surchargeReward'] || api.registry.createType('Balance'),
-    api.consts.contracts['tombstoneDeposit'] || api.registry.createType('Balance')
-  ]) as unknown as Observable<ResultV2>;
-}
-
-/**
- * @name fees
- * @returns An object containing the combined results of the queries for
- * all relevant contract fees as declared in the substrate chain spec.
- * @example
- * ```javascript
- * api.derive.contracts.fees(([creationFee, transferFee]) => {
- *   console.log(`The fee for creating a new contract on this chain is ${creationFee} units. The fee required to call this contract is ${transferFee} units.`);
- * });
- * ```
- */
-export function fees (instanceId: string, api: DeriveApi): () => Observable<DeriveContractFees> {
-  return memo(instanceId, (): Observable<DeriveContractFees> => {
-    return queryConstants(api).pipe(
-      map(([callBaseFee, contractFee, creationFee, transactionBaseFee, transactionByteFee, transferFee, rentByteFee, rentDepositOffset, surchargeReward, tombstoneDeposit]): DeriveContractFees => ({
-        callBaseFee,
-        contractFee,
-        creationFee,
-        rentByteFee,
-        rentDepositOffset,
-        surchargeReward,
-        tombstoneDeposit,
-        transactionBaseFee,
-        transactionByteFee,
-        transferFee
-      }))
-    );
-  });
-}

package/src/contracts/index.ts

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

package/src/council/votes.ts

@@ -1,97 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { QueryableModuleStorage } from '@pezkuwi/api-base/types';
-import type { Vec } from '@pezkuwi/types';
-import type { AccountId, Balance } from '@pezkuwi/types/interfaces';
-import type { PalletElectionsPhragmenVoter } from '@pezkuwi/types/lookup';
-import type { ITuple } from '@pezkuwi/types/types';
-import type { DeriveApi, DeriveCouncilVote, DeriveCouncilVotes } from '../types.js';
-
-import { combineLatest, map, of } from 'rxjs';
-
-import { memo } from '../util/index.js';
-
-// Voter is current tuple is 2.x-era
-type VoteEntry = PalletElectionsPhragmenVoter | ITuple<[Balance, Vec<AccountId>]>;
-
-function isVoter (value: VoteEntry): value is PalletElectionsPhragmenVoter {
-  return !Array.isArray(value);
-}
-
-function retrieveStakeOf (elections: QueryableModuleStorage<'rxjs'>): Observable<[AccountId, Balance][]> {
-  return elections['stakeOf'].entries<Balance, [AccountId]>().pipe(
-    map((entries) =>
-      entries.map(([{ args: [accountId] }, stake]) => [accountId, stake])
-    )
-  );
-}
-
-function retrieveVoteOf (elections: DeriveApi['query']['elections']): Observable<[AccountId, AccountId[]][]> {
-  return elections['votesOf'].entries<Vec<AccountId>, [AccountId]>().pipe(
-    map((entries) =>
-      entries.map(([{ args: [accountId] }, votes]) => [accountId, votes])
-    )
-  );
-}
-
-function retrievePrev (api: DeriveApi, elections: DeriveApi['query']['elections']): Observable<DeriveCouncilVotes> {
-  return combineLatest([
-    retrieveStakeOf(elections),
-    retrieveVoteOf(elections)
-  ]).pipe(
-    map(([stakes, votes]): DeriveCouncilVotes => {
-      const result: DeriveCouncilVotes = [];
-
-      votes.forEach(([voter, votes]): void => {
-        result.push([voter, { stake: api.registry.createType('Balance'), votes }]);
-      });
-
-      stakes.forEach(([staker, stake]): void => {
-        const entry = result.find(([voter]) => voter.eq(staker));
-
-        if (entry) {
-          entry[1].stake = stake;
-        } else {
-          result.push([staker, { stake, votes: [] }]);
-        }
-      });
-
-      return result;
-    })
-  );
-}
-
-function retrieveCurrent (elections: DeriveApi['query']['elections']): Observable<DeriveCouncilVotes> {
-  return elections.voting.entries<VoteEntry, [AccountId]>().pipe(
-    map((entries): DeriveCouncilVotes =>
-      entries.map(([{ args: [accountId] }, value]): [AccountId, DeriveCouncilVote] => [
-        accountId,
-        isVoter(value)
-          ? { stake: value.stake, votes: value.votes }
-          : { stake: value[0], votes: value[1] }
-      ])
-    )
-  );
-}
-
-/**
- * @name votes
- * @description Retrieves the council election votes for all participants.
- * @example
- * ```javascript
- * const votes = await api.derive.council.votes();
- * ```
- */
-export function votes (instanceId: string, api: DeriveApi): () => Observable<DeriveCouncilVotes> {
-  const elections = api.query.elections || api.query['phragmenElection'] || api.query['electionsPhragmen'];
-
-  return memo(instanceId, (): Observable<DeriveCouncilVotes> =>
-    elections
-      ? elections['stakeOf']
-        ? retrievePrev(api, elections)
-        : retrieveCurrent(elections)
-      : of([])
-  );
-}

package/src/council/votesOf.ts

@@ -1,35 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { AccountId } from '@pezkuwi/types/interfaces';
-import type { DeriveApi, DeriveCouncilVote } from '../types.js';
-
-import { map } from 'rxjs';
-
-import { memo } from '../util/index.js';
-
-/**
- * @name votesOf
- * @description Retrieves the council votes associated with a given account.
- * @returns The stake and the list of candidates the account has voted for.
- * @param {string | Uint8Array | AccountId} accountId The accountId to retrieve votes for.
- * @example
- * ```javascript
- * const accountId = "5Gw3s7qQ9Z..."; // Replace with a valid account ID
- * const votes = await api.derive.council.votesOf(accountId);
- * console.log("Account votes:", votes);
- * ```
- */
-export function votesOf (instanceId: string, api: DeriveApi): (accountId: string | Uint8Array | AccountId) => Observable<DeriveCouncilVote> {
-  return memo(instanceId, (accountId: string | Uint8Array | AccountId): Observable<DeriveCouncilVote> =>
-    api.derive.council.votes().pipe(
-      map((votes): DeriveCouncilVote =>
-        (
-          votes.find(([from]) => from.eq(accountId)) ||
-          [null, { stake: api.registry.createType('Balance'), votes: [] as AccountId[] }]
-        )[1]
-      )
-    )
-  );
-}

package/src/crowdloan/childKey.ts

@@ -1,57 +0,0 @@
-// 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 { PolkadotRuntimeCommonCrowdloanFundInfo } from '@pezkuwi/types/lookup';
-import type { BN } from '@pezkuwi/util';
-import type { DeriveApi } from '../types.js';
-
-import { map } from 'rxjs';
-
-import { u8aConcat, u8aToHex } from '@pezkuwi/util';
-import { blake2AsU8a } from '@pezkuwi/util-crypto';
-
-import { memo } from '../util/index.js';
-
-interface AllInfo extends PolkadotRuntimeCommonCrowdloanFundInfo {
-  // previously it was named trieIndex
-  trieIndex?: u32;
-}
-
-function createChildKey (info: AllInfo): string {
-  return u8aToHex(
-    u8aConcat(
-      ':child_storage:default:',
-      blake2AsU8a(
-        u8aConcat(
-          'crowdloan',
-          (info.fundIndex || info.trieIndex).toU8a()
-        )
-      )
-    )
-  );
-}
-
-/**
- * @name childKey
- * @description Retrieves the child storage key for a given parachain’s crowdloan contributions.
- * This key is used to access contribution data stored in a separate child trie of the blockchain’s state.
- * @param {string | number | BN} paraId The parachain ID for which contributions are being queried.
- * @example
- * ```javascript
- * const childKey = await api.derive.crowdloan.childKey(3369);
- * console.log("Child Key:", childKey);
- * ```
- */
-export function childKey (instanceId: string, api: DeriveApi): (paraId: string | number | BN) => Observable<string | null> {
-  return memo(instanceId, (paraId: string | number | BN): Observable<string | null> =>
-    api.query['crowdloan']['funds']<Option<PolkadotRuntimeCommonCrowdloanFundInfo>>(paraId).pipe(
-      map((optInfo) =>
-        optInfo.isSome
-          ? createChildKey(optInfo.unwrap())
-          : null
-      )
-    )
-  );
-}

package/src/crowdloan/contributions.ts

@@ -1,142 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Observable } from 'rxjs';
-import type { StorageKey } from '@pezkuwi/types';
-import type { BN } from '@pezkuwi/util';
-import type { DeriveApi, DeriveContributions } from '../types.js';
-
-import { BehaviorSubject, combineLatest, EMPTY, map, of, startWith, switchMap, tap, toArray } from 'rxjs';
-
-import { arrayFlatten, isFunction, nextTick } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-import { extractContributed } from './util.js';
-
-interface Changes {
-  added: string[];
-  blockHash: string;
-  removed: string[];
-}
-
-const PAGE_SIZE_K = 1000; // limit aligned with the 1k on the node (trie lookups are heavy)
-
-function _getUpdates (api: DeriveApi, paraId: string | number | BN): Observable<Changes> {
-  let added: string[] = [];
-  let removed: string[] = [];
-
-  return api.query.system.events().pipe(
-    switchMap((events): Observable<Changes> => {
-      const changes = extractContributed(paraId, events);
-
-      if (changes.added.length || changes.removed.length) {
-        added = added.concat(...changes.added);
-        removed = removed.concat(...changes.removed);
-
-        return of({ added, addedDelta: changes.added, blockHash: events.createdAtHash?.toHex() || '-', removed, removedDelta: changes.removed });
-      }
-
-      return EMPTY;
-    }),
-    startWith({ added, addedDelta: [], blockHash: '-', removed, removedDelta: [] })
-  );
-}
-
-function _eventTriggerAll (api: DeriveApi, paraId: string | number | BN): Observable<string> {
-  return api.query.system.events().pipe(
-    switchMap((events): Observable<string> => {
-      const items = events.filter(({ event: { data: [eventParaId], method, section } }) =>
-        section === 'crowdloan' &&
-        ['AllRefunded', 'Dissolved', 'PartiallyRefunded'].includes(method) &&
-        eventParaId.eq(paraId)
-      );
-
-      return items.length
-        ? of(events.createdAtHash?.toHex() || '-')
-        : EMPTY;
-    }),
-    startWith('-')
-  );
-}
-
-function _getKeysPaged (api: DeriveApi, childKey: string): Observable<StorageKey[]> {
-  const subject = new BehaviorSubject<string | undefined>(undefined);
-
-  return subject.pipe(
-    switchMap((startKey) =>
-      api.rpc.childstate.getKeysPaged(childKey, '0x', PAGE_SIZE_K, startKey)
-    ),
-    tap((keys): void => {
-      nextTick((): void => {
-        keys.length === PAGE_SIZE_K
-          ? subject.next(keys[PAGE_SIZE_K - 1].toHex())
-          : subject.complete();
-      });
-    }),
-    toArray(), // toArray since we want to startSubject to be completed
-    map((keyArr: StorageKey[][]) => arrayFlatten(keyArr))
-  );
-}
-
-function _getAll (api: DeriveApi, paraId: string | number | BN, childKey: string): Observable<string[]> {
-  return _eventTriggerAll(api, paraId).pipe(
-    switchMap(() =>
-      isFunction(api.rpc.childstate.getKeysPaged)
-        ? _getKeysPaged(api, childKey)
-        : api.rpc.childstate.getKeys(childKey, '0x')
-    ),
-    map((keys) =>
-      keys.map((k) => k.toHex())
-    )
-  );
-}
-
-function _contributions (api: DeriveApi, paraId: string | number | BN, childKey: string): Observable<DeriveContributions> {
-  return combineLatest([
-    _getAll(api, paraId, childKey),
-    _getUpdates(api, paraId)
-  ]).pipe(
-    map(([keys, { added, blockHash, removed }]): DeriveContributions => {
-      const contributorsMap: Record<string, boolean> = {};
-
-      keys.forEach((k): void => {
-        contributorsMap[k] = true;
-      });
-
-      added.forEach((k): void => {
-        contributorsMap[k] = true;
-      });
-
-      removed.forEach((k): void => {
-        delete contributorsMap[k];
-      });
-
-      return {
-        blockHash,
-        contributorsHex: Object.keys(contributorsMap)
-      };
-    })
-  );
-}
-
-/**
- * @name contributions
- * @description Retrieves all contributions for a given parachain crowdloan.
- * @param {string | number | BN} paraId The parachain ID for which contributions are being queried.
- * @example
- * ```javascript
- * const contributions = await api.derive.crowdloan.contributions(3369);
- * console.log("Contributions:", contributions);
- * ```
- */
-export function contributions (instanceId: string, api: DeriveApi): (paraId: string | number | BN) => Observable<DeriveContributions> {
-  return memo(instanceId, (paraId: string | number | BN): Observable<DeriveContributions> =>
-    api.derive.crowdloan.childKey(paraId).pipe(
-      switchMap((childKey) =>
-        childKey
-          ? _contributions(api, paraId, childKey)
-          : of({ blockHash: '-', contributorsHex: [] })
-      )
-    )
-  );
-}

package/src/crowdloan/index.ts

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

package/src/crowdloan/ownContributions.ts

@@ -1,81 +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, DeriveOwnContributions } from '../types.js';
-
-import { combineLatest, EMPTY, map, of, startWith, switchMap } from 'rxjs';
-
-import { objectSpread } from '@pezkuwi/util';
-
-import { memo } from '../util/index.js';
-import { extractContributed } from './util.js';
-
-function _getValues (api: DeriveApi, childKey: string, keys: string[]): Observable<DeriveOwnContributions> {
-  // We actually would love to use multi-keys https://github.com/paritytech/substrate/issues/9203
-  return combineLatest(keys.map((k) => api.rpc.childstate.getStorage(childKey, k))).pipe(
-    map((values) =>
-      values
-        .map((v) => api.registry.createType('Option<StorageData>', v))
-        .map((o) =>
-          o.isSome
-            ? api.registry.createType('Balance', o.unwrap())
-            : api.registry.createType('Balance')
-        )
-        .reduce((all: DeriveOwnContributions, b, index): DeriveOwnContributions =>
-          objectSpread(all, { [keys[index]]: b }), {})
-    )
-  );
-}
-
-function _watchOwnChanges (api: DeriveApi, paraId: string | number | BN, childkey: string, keys: string[]): Observable<DeriveOwnContributions> {
-  return api.query.system.events().pipe(
-    switchMap((events): Observable<DeriveOwnContributions> => {
-      const changes = extractContributed(paraId, events);
-      const filtered = keys.filter((k) =>
-        changes.added.includes(k) ||
-        changes.removed.includes(k)
-      );
-
-      return filtered.length
-        ? _getValues(api, childkey, filtered)
-        : EMPTY;
-    }),
-    startWith({})
-  );
-}
-
-function _contributions (api: DeriveApi, paraId: string | number | BN, childKey: string, keys: string[]): Observable<DeriveOwnContributions> {
-  return combineLatest([
-    _getValues(api, childKey, keys),
-    _watchOwnChanges(api, paraId, childKey, keys)
-  ]).pipe(
-    map(([all, latest]) =>
-      objectSpread({}, all, latest)
-    )
-  );
-}
-
-/**
- * @name ownContributions
- * @description Retrieves the contribution amounts made by specific accounts (`keys`) to a given parachain crowdloan (`paraId`).
- * @param {string | number | BN} paraId The parachain ID for which contributions are being queried.
- * @param {string[]} keys An array of account addresses whose contributions are to be fetched.
- * @example
- * ```javascript
- * const contributions = await api.derive.crowdloan.ownContributions(2000, ['5Ff...PqV', '5Gg...XyZ']);
- * console.log("Own Contributions:", contributions);
- * ```
- */
-export function ownContributions (instanceId: string, api: DeriveApi): (paraId: string | number | BN, keys: string[]) => Observable<DeriveOwnContributions> {
-  return memo(instanceId, (paraId: string | number | BN, keys: string[]): Observable<DeriveOwnContributions> =>
-    api.derive.crowdloan.childKey(paraId).pipe(
-      switchMap((childKey) =>
-        childKey && keys.length
-          ? _contributions(api, paraId, childKey, keys)
-          : of({})
-      )
-    )
-  );
-}

package/src/crowdloan/util.ts

@@ -1,33 +0,0 @@
-// Copyright 2017-2025 @polkadot/api-derive authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { FrameSystemEventRecord } from '@pezkuwi/types/lookup';
-import type { Vec } from '@pezkuwi/types-codec';
-import type { BN } from '@pezkuwi/util';
-
-interface Changes {
-  added: string[];
-  blockHash: string;
-  removed: string[];
-}
-
-export function extractContributed (paraId: string | number | BN, events: Vec<FrameSystemEventRecord>): Changes {
-  const added: string[] = [];
-  const removed: string[] = [];
-
-  return events
-    .filter(({ event: { data: [, eventParaId], method, section } }) =>
-      section === 'crowdloan' &&
-      ['Contributed', 'Withdrew'].includes(method) &&
-      eventParaId.eq(paraId)
-    )
-    .reduce((result: Changes, { event: { data: [accountId], method } }): Changes => {
-      if (method === 'Contributed') {
-        result.added.push(accountId.toHex());
-      } else {
-        result.removed.push(accountId.toHex());
-      }
-
-      return result;
-    }, { added, blockHash: events.createdAtHash?.toHex() || '-', removed });
-}