Valentin Fernandez
ed62d164ea
* document derives from accounts to democracy * Derive Documentation progress * Derive Documentation progress * tx and staking docs * Staking docs progress * more staking docs * Staking module complete * imonline, elections and progress in democracy * Document missing derives * lint
82 lines
3.0 KiB
TypeScript
82 lines
3.0 KiB
TypeScript
// Copyright 2017-2025 @polkadot/api-derive authors & contributors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
import type { Observable } from 'rxjs';
|
|
import type { Option, Vec } from '@polkadot/types';
|
|
import type { AccountId, Balance, Hash, PropIndex } from '@polkadot/types/interfaces';
|
|
import type { FrameSupportPreimagesBounded } from '@polkadot/types/lookup';
|
|
import type { ITuple } from '@polkadot/types/types';
|
|
import type { DeriveApi, DeriveProposal, DeriveProposalImage } from '../types.js';
|
|
|
|
import { combineLatest, map, of, switchMap } from 'rxjs';
|
|
|
|
import { isFunction, objectSpread } from '@polkadot/util';
|
|
|
|
import { memo } from '../util/index.js';
|
|
import { getImageHashBounded } from './util.js';
|
|
|
|
type DepositorsNew = Option<ITuple<[Vec<AccountId>, Balance]>>;
|
|
type DepositorsOld = Option<ITuple<[Balance, Vec<AccountId>]>>;
|
|
type Depositors = DepositorsNew | DepositorsOld;
|
|
type Proposals = ITuple<[PropIndex, Hash | FrameSupportPreimagesBounded, AccountId]>[];
|
|
type Result = [Proposals, (DeriveProposalImage | undefined)[], Depositors[]];
|
|
|
|
function isNewDepositors (depositors: ITuple<[Vec<AccountId>, Balance]> | ITuple<[Balance, Vec<AccountId>]>): depositors is ITuple<[Vec<AccountId>, Balance]> {
|
|
// Detect balance...
|
|
return isFunction((depositors[1] as Balance).mul);
|
|
}
|
|
|
|
function parse ([proposals, images, optDepositors]: Result): DeriveProposal[] {
|
|
return proposals
|
|
.filter(([, , proposer], index): boolean =>
|
|
!!(optDepositors[index]?.isSome) && !proposer.isEmpty
|
|
)
|
|
.map(([index, hash, proposer], proposalIndex): DeriveProposal => {
|
|
const depositors = optDepositors[proposalIndex].unwrap();
|
|
|
|
return objectSpread(
|
|
{
|
|
image: images[proposalIndex],
|
|
imageHash: getImageHashBounded(hash),
|
|
index,
|
|
proposer
|
|
},
|
|
isNewDepositors(depositors)
|
|
? { balance: depositors[1], seconds: depositors[0] }
|
|
: { balance: depositors[0], seconds: depositors[1] }
|
|
);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @name proposals
|
|
* @description Retrieves the list of active public proposals in the democracy module, along with their associated preimage data and deposit information.
|
|
* @example
|
|
* ```javascript
|
|
* const proposals = await api.derive.democracy.proposals();
|
|
* console.log("proposals:", proposals);
|
|
* ```
|
|
*/
|
|
export function proposals (instanceId: string, api: DeriveApi): () => Observable<DeriveProposal[]> {
|
|
return memo(instanceId, (): Observable<DeriveProposal[]> =>
|
|
isFunction(api.query.democracy?.publicProps)
|
|
? api.query.democracy.publicProps().pipe(
|
|
switchMap((proposals) =>
|
|
proposals.length
|
|
? combineLatest([
|
|
of(proposals),
|
|
api.derive.democracy.preimages(
|
|
proposals.map(([, hash]) => hash)
|
|
),
|
|
api.query.democracy.depositOf.multi(
|
|
proposals.map(([index]) => index)
|
|
)
|
|
])
|
|
: of<Result>([[], [], []])
|
|
),
|
|
map(parse)
|
|
)
|
|
: of([])
|
|
);
|
|
}
|