Rebrand: polkadot → pezkuwi, substrate → bizinikiwi, kusama → dicle

packages/api-derive/src/elections/index.ts

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

packages/api-derive/src/elections/info.ts

@@ -0,0 +1,126 @@
+// Copyright 2017-2025 @pezkuwi/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Observable } from 'rxjs';
+import type { u32, Vec } from '@pezkuwi/types';
+import type { AccountId32, Balance, BlockNumber } from '@pezkuwi/types/interfaces';
+import type { PezpalletElectionsPhragmenSeatHolder } from '@pezkuwi/types/lookup';
+import type { ITuple } from '@pezkuwi/types/types';
+import type { DeriveApi } from '../types.js';
+import type { DeriveElectionsInfo } from './types.js';
+
+import { combineLatest, map, of } from 'rxjs';
+
+import { objectSpread } from '@pezkuwi/util';
+
+import { memo } from '../util/index.js';
+
+// SeatHolder is current tuple is 2.x-era Bizinikiwi
+type Member = PezpalletElectionsPhragmenSeatHolder | ITuple<[AccountId32, Balance]>;
+
+type Candidate = AccountId32 | ITuple<[AccountId32, Balance]>;
+
+function isSeatHolder (value: Member): value is PezpalletElectionsPhragmenSeatHolder {
+  return !Array.isArray(value);
+}
+
+function isCandidateTuple (value: Candidate): value is ITuple<[AccountId32, Balance]> {
+  return Array.isArray(value);
+}
+
+function getAccountTuple (value: Member): [AccountId32, Balance] {
+  return isSeatHolder(value)
+    ? [value.who, value.stake]
+    : value;
+}
+
+function getCandidate (value: Candidate): AccountId32 {
+  return isCandidateTuple(value)
+    ? value[0]
+    : value;
+}
+
+function sortAccounts ([, balanceA]: [AccountId32, Balance], [, balanceB]: [AccountId32, Balance]): number {
+  return balanceB.cmp(balanceA);
+}
+
+function getConstants (api: DeriveApi, elections: string | null): Partial<DeriveElectionsInfo> {
+  return elections
+    ? {
+      candidacyBond: api.consts[elections as 'elections'].candidacyBond as Balance,
+      desiredRunnersUp: api.consts[elections as 'elections'].desiredRunnersUp as u32,
+      desiredSeats: api.consts[elections as 'elections'].desiredMembers as u32,
+      termDuration: api.consts[elections as 'elections'].termDuration as BlockNumber,
+      votingBond: api.consts[elections as 'elections']['votingBond'] as Balance,
+      votingBondBase: api.consts[elections as 'elections'].votingBondBase as Balance,
+      votingBondFactor: api.consts[elections as 'elections'].votingBondFactor as Balance
+    }
+    : {};
+}
+
+function getModules (api: DeriveApi): [string, string | null] {
+  const [council] = api.registry.getModuleInstances(api.runtimeVersion.specName, 'council') || ['council'];
+  const elections = api.query['phragmenElection']
+    ? 'phragmenElection'
+    : api.query['electionsPhragmen']
+      ? 'electionsPhragmen'
+      : api.query.elections
+        ? 'elections'
+        : null;
+  // In some cases council here can refer to `generalCouncil` depending on what the chain specific override is.
+  // Therefore, we check to see if it exists in the query field. If it does not we default to `council`.
+  const resolvedCouncil = api.query[council] ? council : 'council';
+
+  return [resolvedCouncil, elections];
+}
+
+function queryAll (api: DeriveApi, council: string, elections: string): Observable<[AccountId32[], Candidate[], Member[], Member[]]> {
+  return api.queryMulti<[Vec<AccountId32>, Vec<Candidate>, Vec<Member>, Vec<Member>]>([
+    api.query[council as 'council'].members,
+    api.query[elections as 'elections'].candidates,
+    api.query[elections as 'elections'].members,
+    api.query[elections as 'elections'].runnersUp
+  ]);
+}
+
+function queryCouncil (api: DeriveApi, council: string): Observable<[AccountId32[], Candidate[], Member[], Member[]]> {
+  return combineLatest([
+    api.query[council as 'council'].members(),
+    of<Candidate[]>([]),
+    of<Member[]>([]),
+    of<Member[]>([])
+  ]);
+}
+
+/**
+ * @name info
+ * @description An object containing the combined results of the storage queries for all relevant election module properties.
+ * @example
+ * ```javascript
+ * api.derive.elections.info(({ members, candidates }) => {
+ *   console.log(`There are currently ${members.length} council members and ${candidates.length} prospective council candidates.`);
+ * });
+ * ```
+ */
+export function info (instanceId: string, api: DeriveApi): () => Observable<DeriveElectionsInfo> {
+  return memo(instanceId, (): Observable<DeriveElectionsInfo> => {
+    const [council, elections] = getModules(api);
+
+    return (
+      elections
+        ? queryAll(api, council, elections)
+        : queryCouncil(api, council)
+    ).pipe(
+      map(([councilMembers, candidates, members, runnersUp]): DeriveElectionsInfo =>
+        objectSpread({}, getConstants(api, elections), {
+          candidateCount: api.registry.createType('u32', candidates.length),
+          candidates: candidates.map(getCandidate),
+          members: members.length
+            ? members.map(getAccountTuple).sort(sortAccounts)
+            : councilMembers.map((a): [AccountId32, Balance] => [a, api.registry.createType('Balance')]),
+          runnersUp: runnersUp.map(getAccountTuple).sort(sortAccounts)
+        })
+      )
+    );
+  });
+}

packages/api-derive/src/elections/types.ts

@@ -0,0 +1,22 @@
+// Copyright 2017-2025 @pezkuwi/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { u32 } from '@pezkuwi/types';
+import type { AccountId, Balance, BlockNumber, SetIndex, VoteIndex } from '@pezkuwi/types/interfaces';
+
+export interface DeriveElectionsInfo {
+  candidates: AccountId[];
+  candidateCount: u32;
+  candidacyBond?: Balance;
+  desiredRunnersUp?: u32;
+  desiredSeats?: u32;
+  members: [AccountId, Balance][];
+  nextVoterSet?: SetIndex;
+  runnersUp: [AccountId, Balance][];
+  termDuration?: BlockNumber;
+  voteCount?: VoteIndex;
+  voterCount?: SetIndex;
+  votingBond?: Balance;
+  votingBondBase?: Balance;
+  votingBondFactor?: Balance;
+}