Derives for society (#1727)

* Deries for society

* Candidates

* Add overview

* Candidate types

* WIP, stash before merge

* Linting

* Readability

* Typo

* Split option maps

packages/api-derive/src/index.ts

@@ -16,6 +16,7 @@ import * as democracy from './democracy';
 import * as elections from './elections';
 import * as imOnline from './imOnline';
 import * as session from './session';
+import * as society from './society';
 import * as staking from './staking';
 import * as technicalCommittee from './technicalCommittee';
 import * as treasury from './treasury';
@@ -59,7 +60,7 @@ function injectFunctions<AllSections> (api: ApiInterfaceRx, allSections: AllSect
     }, {} as DeriveAllSections<AllSections>);
 }
 
-export const derive = { accounts, balances, chain, contracts, council, democracy, elections, imOnline, session, staking, technicalCommittee, treasury };
+export const derive = { accounts, balances, chain, contracts, council, democracy, elections, imOnline, session, society, staking, technicalCommittee, treasury };
 export type ExactDerive = DeriveAllSections<typeof derive>;
 
 // FIXME The return type of this function should be {...ExactDerive, ...DeriveCustom}

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

@@ -0,0 +1,45 @@
+// Copyright 2017-2020 @polkadot/api-derive authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+import { ApiInterfaceRx } from '@polkadot/api/types';
+import { BalanceOf, Bid, BidKind } from '@polkadot/types/interfaces';
+import { ITuple } from '@polkadot/types/types';
+import { DeriveSocietyCandidate } from '../types';
+
+import { combineLatest, of, Observable } from 'rxjs';
+import { map, switchMap } from 'rxjs/operators';
+import { Option, Vec } from '@polkadot/types';
+
+import { memo } from '../util';
+
+type ResultSuspend = Option<ITuple<[BalanceOf, BidKind]>>;
+type Result = [Bid[], ResultSuspend[]]
+
+/**
+ * @description Get the candidate info for a society
+ */
+export function candidates (api: ApiInterfaceRx): () => Observable<DeriveSocietyCandidate[]> {
+  return memo((): Observable<DeriveSocietyCandidate[]> =>
+    api.query.society.candidates<Vec<Bid>>().pipe(
+      switchMap((candidates: Vec<Bid>): Observable<Result> =>
+        combineLatest([
+          of(candidates),
+          combineLatest(
+            candidates.map(({ who }: Bid): Observable<ResultSuspend> =>
+              api.query.society.suspendedCandidates<ResultSuspend>(who)
+            )
+          )
+        ])
+      ),
+      map(([candidates, suspended]: Result): DeriveSocietyCandidate[] =>
+        candidates.map(({ who, kind, value }, index) => ({
+          accountId: who,
+          isSuspended: suspended[index].isSome,
+          kind,
+          value
+        }))
+      )
+    )
+  );
+}

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

@@ -0,0 +1,8 @@
+// Copyright 2017-2020 @polkadot/api-derive authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+export * from './candidates';
+export * from './info';
+export * from './member';
+export * from './members';

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

@@ -0,0 +1,40 @@
+// Copyright 2017-2020 @polkadot/api-derive authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+import { ApiInterfaceRx } from '@polkadot/api/types';
+import { AccountId, BalanceOf, Bid } from '@polkadot/types/interfaces';
+import { DeriveSociety } from '../types';
+
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { Option, Vec, u32 } from '@polkadot/types';
+
+import { memo } from '../util';
+
+type Result = [Vec<Bid>, Option<AccountId>, Option<AccountId>, Option<AccountId>, u32, BalanceOf]
+
+/**
+ * @description Get the overall info for a society
+ */
+export function info (api: ApiInterfaceRx): () => Observable<DeriveSociety> {
+  return memo((): Observable<DeriveSociety> =>
+    api.queryMulti<Result>([
+      api.query.society.bids,
+      api.query.society.defender,
+      api.query.society.founder,
+      api.query.society.head,
+      api.query.society.maxMembers,
+      api.query.society.pot
+    ]).pipe(
+      map(([bids, defender, founder, head, maxMembers, pot]: Result): DeriveSociety => ({
+        bids,
+        defender: defender.unwrapOr(undefined),
+        head: head.unwrapOr(undefined),
+        founder: founder.unwrapOr(undefined),
+        maxMembers,
+        pot
+      }))
+    )
+  );
+}

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

@@ -0,0 +1,46 @@
+// Copyright 2017-2020 @polkadot/api-derive authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+import { ApiInterfaceRx } from '@polkadot/api/types';
+import { AccountId, Balance, BlockNumber, StrikeCount, VouchingStatus, Vote } from '@polkadot/types/interfaces';
+import { ITuple } from '@polkadot/types/types';
+import { DeriveSocietyMember } from '../types';
+
+import { Observable, combineLatest } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { bool, Option, Vec } from '@polkadot/types';
+
+import { memo } from '../util';
+
+type ResultMulti = [Vec<ITuple<[BlockNumber, Balance]>>, StrikeCount];
+type ResultSingle = [Option<Vote>, bool, Option<VouchingStatus>];
+type Result = [ResultMulti, ResultSingle];
+
+/**
+ * @description Get the member info for a society
+ */
+export function member (api: ApiInterfaceRx): (accountId: AccountId) => Observable<DeriveSocietyMember> {
+  return memo((accountId: AccountId): Observable<DeriveSocietyMember> =>
+    combineLatest([
+      api.queryMulti<ResultMulti>([
+        [api.query.society.payouts, accountId],
+        [api.query.society.strikes, accountId]
+      ]),
+      combineLatest([
+        api.query.society.defenderVotes<Option<Vote>>(accountId),
+        api.query.society.suspendedMembers<bool>(accountId),
+        api.query.society.vouching<Option<VouchingStatus>>(accountId)
+      ])
+    ]).pipe(
+      map(([[payouts, strikes], [defenderVote, suspended, vouching]]: Result): DeriveSocietyMember => ({
+        accountId,
+        payouts,
+        isSuspended: !suspended.isEmpty,
+        strikes,
+        vote: defenderVote.unwrapOr(undefined),
+        vouching: vouching.unwrapOr(undefined)
+      }))
+    )
+  );
+}

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

@@ -0,0 +1,27 @@
+// Copyright 2017-2020 @polkadot/api-derive authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+import { ApiInterfaceRx } from '@polkadot/api/types';
+import { AccountId } from '@polkadot/types/interfaces';
+import { DeriveSocietyMember } from '../types';
+
+import { combineLatest, Observable } from 'rxjs';
+import { switchMap } from 'rxjs/operators';
+
+import { memo } from '../util';
+
+/**
+ * @description Get the member info for a society
+ */
+export function members (api: ApiInterfaceRx): () => Observable<DeriveSocietyMember[]> {
+  return memo((): Observable<DeriveSocietyMember[]> =>
+    api.query.society.members<AccountId[]>().pipe(
+      switchMap((members): Observable<DeriveSocietyMember[]> =>
+        combineLatest(members.map((accountId): Observable<DeriveSocietyMember> =>
+          api.derive.society.member(accountId)
+        ))
+      )
+    )
+  );
+}

packages/api-derive/src/types.ts

@@ -2,7 +2,7 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
-import { AccountId, AccountIndex, Balance, BalanceLock, BlockNumber, EraIndex, EraPoints, Exposure, Hash, Index, Keys, Proposal, PropIndex, ProposalIndex, ReferendumInfo, RegistrationJudgement, RewardDestination, SessionIndex, SetIndex, StakingLedger, TreasuryProposal, ValidatorPrefs, Vote, Votes, VoteIndex } from '@polkadot/types/interfaces';
+import { AccountId, AccountIndex, Balance, BalanceLock, BalanceOf, Bid, BidKind, BlockNumber, EraIndex, EraPoints, Exposure, Hash, Index, Keys, Proposal, PropIndex, ProposalIndex, ReferendumInfo, RegistrationJudgement, RewardDestination, SessionIndex, SetIndex, StakingLedger, StrikeCount, TreasuryProposal, ValidatorPrefs, Vote, Votes, VoteIndex, VouchingStatus } from '@polkadot/types/interfaces';
 
 import BN from 'bn.js';
 import { u32, Vec } from '@polkadot/types';
@@ -149,6 +149,31 @@ export interface DerivedSessionInfo extends DeriveSessionIndexes {
   sessionProgress: BlockNumber;
 }
 
+export interface DeriveSociety {
+  bids: Bid[];
+  defender?: AccountId;
+  head?: AccountId;
+  founder?: AccountId;
+  maxMembers: u32;
+  pot: BalanceOf;
+}
+
+export interface DeriveSocietyCandidate {
+  accountId: AccountId;
+  kind: BidKind;
+  value: Balance;
+  isSuspended: boolean;
+}
+
+export interface DeriveSocietyMember {
+  accountId: AccountId;
+  isSuspended: boolean;
+  payouts: [BlockNumber, Balance][];
+  strikes: StrikeCount;
+  vote?: Vote;
+  vouching?: VouchingStatus;
+}
+
 export interface DerivedStakingElected {
   currentElected: AccountId[];
   info: DerivedStakingQuery[];