Use lookup types in derives (#4012)

* Use lookup types in derives

* additional

* society

Author: jacogr

packages/api-derive/src/accounts/identity.ts

@@ -4,7 +4,8 @@
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
 import type { Data, Option } from '@polkadot/types';
-import type { AccountId, IdentityInfoAdditional, Registration } from '@polkadot/types/interfaces';
+import type { AccountId } from '@polkadot/types/interfaces';
+import type { PalletIdentityIdentityInfo, PalletIdentityRegistration } from '@polkadot/types/lookup';
 import type { ITuple } from '@polkadot/types/types';
 import type { DeriveAccountRegistration, DeriveHasIdentity } from '../types';
 
@@ -14,6 +15,8 @@ import { isHex, u8aToString } from '@polkadot/util';
 
 import { memo } from '../util';
 
+type IdentityInfoAdditional = PalletIdentityIdentityInfo['additional'][0];
+
 const UNDEF_HEX = { toHex: () => undefined };
 
 function dataAsString (data: Data): string | undefined {
@@ -37,7 +40,7 @@ function extractOther (additional: IdentityInfoAdditional[]): Record<string, str
   }, {});
 }
 
-function extractIdentity (identityOfOpt?: Option<Registration>, superOf?: [AccountId, Data]): DeriveAccountRegistration {
+function extractIdentity (identityOfOpt?: Option<PalletIdentityRegistration>, superOf?: [AccountId, Data]): DeriveAccountRegistration {
   if (!identityOfOpt?.isSome) {
     return { judgements: [] };
   }
@@ -61,7 +64,7 @@ function extractIdentity (identityOfOpt?: Option<Registration>, superOf?: [Accou
   };
 }
 
-function getParent (api: ApiInterfaceRx, identityOfOpt: Option<Registration> | undefined, superOfOpt: Option<ITuple<[AccountId, Data]>> | undefined): Observable<[Option<Registration> | undefined, [AccountId, Data] | undefined]> {
+function getParent (api: ApiInterfaceRx, identityOfOpt: Option<PalletIdentityRegistration> | undefined, superOfOpt: Option<ITuple<[AccountId, Data]>> | undefined): Observable<[Option<PalletIdentityRegistration> | undefined, [AccountId, Data] | undefined]> {
   if (identityOfOpt?.isSome) {
     // this identity has something set
     return of([identityOfOpt, undefined]);
@@ -70,7 +73,7 @@ function getParent (api: ApiInterfaceRx, identityOfOpt: Option<Registration> | u
 
     // we have a super
     return combineLatest([
-      api.query.identity.identityOf<Option<Registration>>(superOf[0]),
+      api.query.identity.identityOf(superOf[0]),
       of(superOf)
     ]);
   }
@@ -79,9 +82,9 @@ function getParent (api: ApiInterfaceRx, identityOfOpt: Option<Registration> | u
   return of([undefined, undefined]);
 }
 
-function getBase (api: ApiInterfaceRx, accountId?: AccountId | Uint8Array | string): Observable<[Option<Registration> | undefined, Option<ITuple<[AccountId, Data]>> | undefined]> {
+function getBase (api: ApiInterfaceRx, accountId?: AccountId | Uint8Array | string): Observable<[Option<PalletIdentityRegistration> | undefined, Option<ITuple<[AccountId, Data]>> | undefined]> {
   return accountId && api.query.identity?.identityOf
-    ? api.queryMulti<[Option<Registration>, Option<ITuple<[AccountId, Data]>>]>([
+    ? api.queryMulti<[Option<PalletIdentityRegistration>, Option<ITuple<[AccountId, Data]>>]>([
       [api.query.identity.identityOf, accountId],
       [api.query.identity.superOf, accountId]
     ])

packages/api-derive/src/balances/all.ts

@@ -4,7 +4,8 @@
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx, QueryableStorageMultiArg } from '@polkadot/api/types';
 import type { Option, Vec } from '@polkadot/types';
-import type { AccountId, AccountIndex, Address, Balance, BalanceLock, BalanceLockTo212, BlockNumber, VestingInfo, VestingSchedule } from '@polkadot/types/interfaces';
+import type { AccountId, AccountIndex, Address, Balance, BalanceLockTo212, BlockNumber, VestingSchedule } from '@polkadot/types/interfaces';
+import type { PalletBalancesBalanceLock, PalletVestingVestingInfo } from '@polkadot/types/lookup';
 import type { DeriveBalancesAccount, DeriveBalancesAccountData, DeriveBalancesAll, DeriveBalancesAllAccountData } from '../types';
 
 import { combineLatest, map, of, switchMap } from 'rxjs';
@@ -13,15 +14,15 @@ import { BN, bnMax, isFunction } from '@polkadot/util';
 
 import { memo } from '../util';
 
-type BalanceLocksEntry = Vec<BalanceLock | BalanceLockTo212>;
+type BalanceLocksEntry = Vec<PalletBalancesBalanceLock | BalanceLockTo212>;
 type BalanceLocks = BalanceLocksEntry[];
-type ResultBalance = [VestingInfo | null, ((BalanceLock | BalanceLockTo212)[])[]];
+type ResultBalance = [PalletVestingVestingInfo | null, ((PalletBalancesBalanceLock | BalanceLockTo212)[])[]];
 type Result = [DeriveBalancesAccount, BlockNumber, ResultBalance];
 
 interface AllLocked {
   allLocked: boolean,
   lockedBalance: Balance,
-  lockedBreakdown: (BalanceLock | BalanceLockTo212)[],
+  lockedBreakdown: (PalletBalancesBalanceLock | BalanceLockTo212)[],
   vestingLocked: Balance
 }
 
@@ -33,9 +34,9 @@ type DeriveCustomLocks = ApiInterfaceRx['derive'] & {
 
 const VESTING_ID = '0x76657374696e6720';
 
-function calcLocked (api: ApiInterfaceRx, bestNumber: BlockNumber, locks: (BalanceLock | BalanceLockTo212)[]): AllLocked {
+function calcLocked (api: ApiInterfaceRx, bestNumber: BlockNumber, locks: (PalletBalancesBalanceLock | BalanceLockTo212)[]): AllLocked {
   let lockedBalance = api.registry.createType('Balance');
-  let lockedBreakdown: (BalanceLock | BalanceLockTo212)[] = [];
+  let lockedBreakdown: (PalletBalancesBalanceLock | BalanceLockTo212)[] = [];
   let vestingLocked = api.registry.createType('Balance');
   let allLocked = false;
 
@@ -56,7 +57,7 @@ function calcLocked (api: ApiInterfaceRx, bestNumber: BlockNumber, locks: (Balan
   return { allLocked, lockedBalance, lockedBreakdown, vestingLocked };
 }
 
-function calcShared (api: ApiInterfaceRx, bestNumber: BlockNumber, data: DeriveBalancesAccountData, locks: (BalanceLock | BalanceLockTo212)[]): DeriveBalancesAllAccountData {
+function calcShared (api: ApiInterfaceRx, bestNumber: BlockNumber, data: DeriveBalancesAccountData, locks: (PalletBalancesBalanceLock | BalanceLockTo212)[]): DeriveBalancesAllAccountData {
   const { allLocked, lockedBalance, lockedBreakdown, vestingLocked } = calcLocked(api, bestNumber, locks);
 
   return {
@@ -73,7 +74,7 @@ function calcBalances (api: ApiInterfaceRx, [data, bestNumber, [vesting, allLock
   // Calculate the vesting balances,
   //  - offset = balance locked at startingBlock
   //  - perBlock is the unlock amount
-  const emptyVest = api.registry.createType('VestingInfo');
+  const emptyVest = api.registry.createType<PalletVestingVestingInfo>('VestingInfo');
   const { locked: vestingTotal, perBlock, startingBlock } = vesting || emptyVest;
   const isStarted = bestNumber.gt(startingBlock);
   const vestedNow = isStarted ? perBlock.mul(bestNumber.sub(startingBlock)) : new BN(0);
@@ -96,7 +97,7 @@ function calcBalances (api: ApiInterfaceRx, [data, bestNumber, [vesting, allLock
 
 // old
 function queryOld (api: ApiInterfaceRx, accountId: AccountId): Observable<ResultBalance> {
-  return api.queryMulti<[Vec<BalanceLock>, Option<VestingSchedule>]>([
+  return api.queryMulti<[Vec<PalletBalancesBalanceLock>, Option<VestingSchedule>]>([
     [api.query.balances.locks, accountId],
     [api.query.balances.vesting, accountId]
   ]).pipe(
@@ -106,7 +107,7 @@ function queryOld (api: ApiInterfaceRx, accountId: AccountId): Observable<Result
       if (optVesting.isSome) {
         const { offset: locked, perBlock, startingBlock } = optVesting.unwrap();
 
-        vestingNew = api.registry.createType('VestingInfo', { locked, perBlock, startingBlock });
+        vestingNew = api.registry.createType<PalletVestingVestingInfo>('VestingInfo', { locked, perBlock, startingBlock });
       }
 
       return [vestingNew, [locks]];
@@ -126,20 +127,20 @@ function queryCurrent (api: ApiInterfaceRx, accountId: AccountId, balanceInstanc
 
   return (
     api.query.vesting?.vesting
-      ? api.queryMulti<[Option<VestingInfo>, ...BalanceLocks]>([[api.query.vesting.vesting, accountId], ...queries])
+      ? api.queryMulti<[Option<PalletVestingVestingInfo>, ...BalanceLocks]>([[api.query.vesting.vesting, accountId], ...queries])
       // TODO We need to check module instances here as well, not only the balances module
       : queries.length
-        ? api.queryMulti<[...(Vec<BalanceLock>)[]]>(queries).pipe(
-          map((r): [Option<VestingInfo>, ...BalanceLocks] => [api.registry.createType('Option<VestingInfo>'), ...r])
+        ? api.queryMulti<[...(Vec<PalletBalancesBalanceLock>)[]]>(queries).pipe(
+          map((r): [Option<PalletVestingVestingInfo>, ...BalanceLocks] => [api.registry.createType('Option<VestingInfo>'), ...r])
         )
-        : of([api.registry.createType('Option<VestingInfo>')] as [Option<VestingInfo>])
+        : of([api.registry.createType('Option<VestingInfo>')] as [Option<PalletVestingVestingInfo>])
   ).pipe(
     map(([opt, ...locks]): ResultBalance => {
       let offset = -1;
 
       return [
         opt.unwrapOr(null),
-        lockEmpty.map((e) => e ? api.registry.createType('Vec<BalanceLock>') : locks[++offset])
+        lockEmpty.map((e) => e ? api.registry.createType<Vec<PalletBalancesBalanceLock>>('Vec<BalanceLock>') : locks[++offset])
       ];
     })
   );

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

@@ -0,0 +1,38 @@
+// Copyright 2017-2021 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { AccountId, Balance, BalanceLockTo212, BlockNumber, Index } from '@polkadot/types/interfaces';
+import type { PalletBalancesBalanceLock } from '@polkadot/types/lookup';
+
+export interface DeriveBalancesAccountData {
+  freeBalance: Balance;
+  frozenFee: Balance;
+  frozenMisc: Balance;
+  reservedBalance: Balance;
+  votingBalance: Balance;
+}
+
+export interface DeriveBalancesAccount extends DeriveBalancesAccountData {
+  accountId: AccountId;
+  accountNonce: Index;
+  additional: DeriveBalancesAccountData[];
+}
+
+export interface DeriveBalancesAllAccountData extends DeriveBalancesAccountData {
+  availableBalance: Balance;
+  lockedBalance: Balance;
+  lockedBreakdown: (PalletBalancesBalanceLock | BalanceLockTo212)[];
+  vestingLocked: Balance;
+}
+
+export interface DeriveBalancesAll extends DeriveBalancesAccount, DeriveBalancesAllAccountData {
+  additional: DeriveBalancesAllAccountData[];
+  isVesting: boolean;
+  vestedBalance: Balance;
+  vestedClaimable: Balance;
+  vestingEndBlock: BlockNumber;
+  vestingPerBlock: Balance;
+  vestingTotal: Balance;
+}
+
+export type DeriveBalancesMap = Record<string, DeriveBalancesAll>;

packages/api-derive/src/council/votes.ts

@@ -4,7 +4,8 @@
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx, QueryableModuleStorage } from '@polkadot/api/types';
 import type { Vec } from '@polkadot/types';
-import type { AccountId, Balance, Voter } from '@polkadot/types/interfaces';
+import type { AccountId, Balance } from '@polkadot/types/interfaces';
+import type { PalletElectionsPhragmenVoter } from '@polkadot/types/lookup';
 import type { ITuple } from '@polkadot/types/types';
 import type { DeriveCouncilVote, DeriveCouncilVotes } from '../types';
 
@@ -13,9 +14,9 @@ import { combineLatest, map, of } from 'rxjs';
 import { memo } from '../util';
 
 // Voter is current tuple is 2.x-era
-type VoteEntry = Voter | ITuple<[Balance, Vec<AccountId>]>;
+type VoteEntry = PalletElectionsPhragmenVoter | ITuple<[Balance, Vec<AccountId>]>;
 
-function isVoter (value: VoteEntry): value is Voter {
+function isVoter (value: VoteEntry): value is PalletElectionsPhragmenVoter {
   return !Array.isArray(value);
 }
 

packages/api-derive/src/democracy/locks.ts

@@ -3,8 +3,8 @@
 
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { AccountId, ReferendumInfoFinished, ReferendumInfoTo239, Vote, VotingDelegating, VotingDirect, VotingDirectVote } from '@polkadot/types/interfaces';
-import type { PalletDemocracyReferendumInfo } from '@polkadot/types/lookup';
+import type { AccountId, ReferendumInfoTo239, Vote } from '@polkadot/types/interfaces';
+import type { PalletDemocracyReferendumInfo, PalletDemocracyVoteVoting } from '@polkadot/types/lookup';
 import type { BN } from '@polkadot/util';
 import type { DeriveDemocracyLock } from '../types';
 
@@ -14,6 +14,11 @@ import { BN_ZERO, isUndefined } from '@polkadot/util';
 
 import { memo } from '../util';
 
+type ReferendumInfoFinished = PalletDemocracyReferendumInfo['asFinished'];
+type VotingDelegating = PalletDemocracyVoteVoting['asDelegating'];
+type VotingDirect = PalletDemocracyVoteVoting['asDirect'];
+type VotingDirectVote = VotingDirect['votes'][0];
+
 const LOCKUPS = [0, 1, 2, 4, 8, 16, 32];
 
 function parseEnd (api: ApiInterfaceRx, vote: Vote, { approved, end }: ReferendumInfoFinished): [BN, BN] {

packages/api-derive/src/democracy/nextExternal.ts

@@ -4,15 +4,16 @@
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
 import type { Option } from '@polkadot/types';
-import type { Hash, VoteThreshold } from '@polkadot/types/interfaces';
+import type { H256 } from '@polkadot/types/interfaces';
+import type { PalletDemocracyVoteThreshold } from '@polkadot/types/lookup';
 import type { ITuple } from '@polkadot/types/types';
 import type { DeriveProposalExternal } from '../types';
 
 import { map, of, switchMap } from 'rxjs';
 
 import { memo } from '../util';
 
-function withImage (api: ApiInterfaceRx, nextOpt: Option<ITuple<[Hash, VoteThreshold]>>): Observable<DeriveProposalExternal | null> {
+function withImage (api: ApiInterfaceRx, nextOpt: Option<ITuple<[H256, PalletDemocracyVoteThreshold]>>): Observable<DeriveProposalExternal | null> {
   if (nextOpt.isNone) {
     return of(null);
   }
@@ -31,7 +32,7 @@ function withImage (api: ApiInterfaceRx, nextOpt: Option<ITuple<[Hash, VoteThres
 export function nextExternal (instanceId: string, api: ApiInterfaceRx): () => Observable<DeriveProposalExternal | null> {
   return memo(instanceId, (): Observable<DeriveProposalExternal | null> =>
     api.query.democracy?.nextExternal
-      ? api.query.democracy.nextExternal<Option<ITuple<[Hash, VoteThreshold]>>>().pipe(
+      ? api.query.democracy.nextExternal().pipe(
         switchMap((nextOpt) => withImage(api, nextOpt))
       )
       : of(null)

packages/api-derive/src/democracy/preimage.ts

@@ -3,21 +3,17 @@
 
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { Bytes, Option } from '@polkadot/types';
-import type { AccountId, Balance, BlockNumber, Hash } from '@polkadot/types/interfaces';
-import type { ITuple } from '@polkadot/types/types';
+import type { Hash } from '@polkadot/types/interfaces';
 import type { DeriveProposalImage } from '../types';
 
 import { map } from 'rxjs';
 
 import { memo } from '../util';
 import { parseImage } from './util';
 
-type PreImage = Option<ITuple<[Bytes, AccountId, Balance, BlockNumber]>>;
-
 export function preimage (instanceId: string, api: ApiInterfaceRx): (hash: Hash) => Observable<DeriveProposalImage | undefined> {
   return memo(instanceId, (hash: Hash): Observable<DeriveProposalImage | undefined> =>
-    api.query.democracy.preimages<PreImage>(hash).pipe(
+    api.query.democracy.preimages(hash).pipe(
       map((imageOpt) => parseImage(api, imageOpt))
     )
   );

packages/api-derive/src/democracy/referendumsInfo.ts

@@ -4,8 +4,8 @@
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
 import type { Option, Vec } from '@polkadot/types';
-import type { AccountId, ReferendumInfoTo239, Vote, Voting, VotingDelegating, VotingDirectVote } from '@polkadot/types/interfaces';
-import type { PalletDemocracyReferendumInfo } from '@polkadot/types/lookup';
+import type { AccountId, ReferendumInfoTo239, Vote } from '@polkadot/types/interfaces';
+import type { PalletDemocracyReferendumInfo, PalletDemocracyVoteVoting } from '@polkadot/types/lookup';
 import type { BN } from '@polkadot/util';
 import type { DeriveBalancesAccount, DeriveReferendum, DeriveReferendumVote, DeriveReferendumVotes } from '../types';
 
@@ -16,6 +16,10 @@ import { isFunction } from '@polkadot/util';
 import { memo } from '../util';
 import { calcVotes, getStatus, parseImage } from './util';
 
+type VotingDelegating = PalletDemocracyVoteVoting['asDelegating'];
+type VotingDirect = PalletDemocracyVoteVoting['asDirect'];
+type VotingDirectVote = VotingDirect['votes'][0];
+
 function votesPrev (api: ApiInterfaceRx, referendumId: BN): Observable<DeriveReferendumVote[]> {
   return api.query.democracy.votersFor<Vec<AccountId>>(referendumId).pipe(
     switchMap((votersFor): Observable<[Vec<AccountId>, Vote[], DeriveBalancesAccount[]]> =>
@@ -42,7 +46,7 @@ function votesPrev (api: ApiInterfaceRx, referendumId: BN): Observable<DeriveRef
   );
 }
 
-function extractVotes (mapped: [AccountId, Voting][], referendumId: BN): DeriveReferendumVote[] {
+function extractVotes (mapped: [AccountId, PalletDemocracyVoteVoting][], referendumId: BN): DeriveReferendumVote[] {
   return mapped
     .filter(([, voting]) => voting.isDirect)
     .map(([accountId, voting]): [AccountId, VotingDirectVote[]] => [
@@ -67,9 +71,9 @@ function extractVotes (mapped: [AccountId, Voting][], referendumId: BN): DeriveR
 }
 
 function votesCurr (api: ApiInterfaceRx, referendumId: BN): Observable<DeriveReferendumVote[]> {
-  return api.query.democracy.votingOf.entries<Voting, [AccountId]>().pipe(
+  return api.query.democracy.votingOf.entries().pipe(
     map((allVoting): DeriveReferendumVote[] => {
-      const mapped = allVoting.map(([{ args: [accountId] }, voting]): [AccountId, Voting] => [accountId, voting]);
+      const mapped = allVoting.map(([{ args: [accountId] }, voting]): [AccountId, PalletDemocracyVoteVoting] => [accountId, voting]);
       const votes = extractVotes(mapped, referendumId);
       const delegations = mapped
         .filter(([, voting]) => voting.isDelegating)

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

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { Vec } from '@polkadot/types';
-import type { AccountId, Balance, BlockNumber, Hash, PropIndex, Proposal, ReferendumIndex, ReferendumInfoTo239, Vote, VoteThreshold } from '@polkadot/types/interfaces';
-import type { PalletDemocracyReferendumStatus } from '@polkadot/types/lookup';
+import type { AccountId, Balance, BlockNumber, Hash, PropIndex, Proposal, ReferendumIndex, ReferendumInfoTo239, Vote } from '@polkadot/types/interfaces';
+import type { PalletDemocracyReferendumStatus, PalletDemocracyVoteThreshold } from '@polkadot/types/lookup';
 import type { BN } from '@polkadot/util';
 
 export interface DeriveDemocracyLock {
@@ -42,7 +42,7 @@ export interface DeriveProposal {
 export interface DeriveProposalExternal {
   image?: DeriveProposalImage;
   imageHash: Hash;
-  threshold: VoteThreshold;
+  threshold: PalletDemocracyVoteThreshold;
 }
 
 export interface DeriveReferendum {

packages/api-derive/src/society/candidates.ts

@@ -3,29 +3,31 @@
 
 import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { Option, Vec } from '@polkadot/types';
-import type { AccountId, BalanceOf, Bid, BidKind } from '@polkadot/types/interfaces';
+import type { Option } from '@polkadot/types';
+import type { BalanceOf } from '@polkadot/types/interfaces';
+import type { PalletSocietyBid, PalletSocietyBidKind } from '@polkadot/types/lookup';
 import type { ITuple } from '@polkadot/types/types';
 import type { DeriveSocietyCandidate } from '../types';
 
 import { combineLatest, map, of, switchMap } from 'rxjs';
 
 import { memo } from '../util';
 
-type ResultSuspend = Option<ITuple<[BalanceOf, BidKind]>>;
-type Result = [Bid[], ResultSuspend[]]
+type ResultSuspend = Option<ITuple<[BalanceOf, PalletSocietyBidKind]>>;
+type Result = [PalletSocietyBid[], ResultSuspend[]]
 
 /**
  * @description Get the candidate info for a society
  */
 export function candidates (instanceId: string, api: ApiInterfaceRx): () => Observable<DeriveSocietyCandidate[]> {
   return memo(instanceId, (): Observable<DeriveSocietyCandidate[]> =>
-    api.query.society.candidates<Vec<Bid>>().pipe(
-      switchMap((candidates: Vec<Bid>): Observable<Result> =>
+    api.query.society.candidates().pipe(
+      switchMap((candidates): Observable<Result> =>
         combineLatest([
           of(candidates),
           api.query.society.suspendedCandidates.multi(
-            candidates.map(({ who }): AccountId => who))
+            candidates.map(({ who }) => who)
+          )
         ])
       ),
       map(([candidates, suspended]: Result): DeriveSocietyCandidate[] =>