@pezkuwi/api-derive 16.5.8 → 16.5.10

package/build-deno/accounts/types.ts

@@ -1,46 +0,0 @@
-
-import type { AccountId, AccountIndex, RegistrationJudgement } from 'https://deno.land/x/pezkuwi/types/interfaces/index.ts';
-import type { Vec } from 'https://deno.land/x/pezkuwi/types-codec/mod.ts';
-
-export type AccountIdAndIndex = [AccountId | undefined, AccountIndex | undefined];
-
-export type AccountIndexes = Record<string, AccountIndex>;
-
-export interface DeriveAccountRegistration {
-  discord?: string | undefined;
-  display?: string | undefined;
-  displayParent?: string | undefined;
-  email?: string | undefined;
-  github?: string | undefined;
-  image?: string | undefined;
-  legal?: string | undefined;
-  matrix?: string | undefined;
-  other?: Record<string, string> | undefined;
-  parent?: AccountId | undefined;
-  pgp?: string | undefined;
-  riot?: string | undefined;
-  subs?: Vec<AccountId> | undefined;
-  twitter?: string | undefined;
-  web?: string | undefined;
-  judgements: RegistrationJudgement[];
-}
-
-export interface DeriveAccountFlags {
-  isCouncil: boolean;
-  isSociety: boolean;
-  isSudo: boolean;
-  isTechCommittee: boolean;
-}
-
-export interface DeriveAccountInfo {
-  accountId?: AccountId | undefined;
-  accountIndex?: AccountIndex | undefined;
-  identity: DeriveAccountRegistration;
-  nickname?: string | undefined;
-}
-
-export interface DeriveHasIdentity {
-  display?: string | undefined;
-  hasIdentity: boolean;
-  parentId?: string | undefined;
-}

package/build-deno/alliance/index.ts

@@ -1,74 +0,0 @@
-
-import { hasProposals as collectiveHasProposals, members as collectiveMembers, prime as collectivePrime, proposal as collectiveProposal, proposalCount as collectiveProposalCount, proposalHashes as collectiveProposalHashes, proposals as collectiveProposals } from '../collective/index.ts';
-
-/**
- * @name members
- * @description Retrieves the list of members in the "allianceMotion" collective.
- * @example
- * ```javascript
- * const members = await api.derive.alliance.members();
- * console.log(`Members: ${JSON.stringify(members)});
- * ```
- */
-export const members = /*#__PURE__*/ collectiveMembers('allianceMotion');
-
-/**
- * @name hasProposals
- * @description Checks if there are any active proposals in the "allianceMotion" collective.
- * @example
- * ```javascript
- * const exists = await api.derive.alliance.hasProposals();
- * console.log(exists);
- * ```
- */
-export const hasProposals = /*#__PURE__*/ collectiveHasProposals('allianceMotion');
-/**
- * @name proposal
- * @description Retrieves details of a specific proposal in the "allianceMotion" collective by its hash.
- * @example
- * ```javascript
- * const proposalDetails = await api.derive.alliance.proposal(PROPOSAL_HASH);
- * console.log(proposalDetails);
- * ```
- */
-export const proposal = /*#__PURE__*/ collectiveProposal('allianceMotion');
-/**
- * @name proposalCount
- * @description Retrieves the total number of proposals in the "allianceMotion" collective.
- * @example
- * ```javascript
- * const count = await api.derive.alliance.proposalCount();
- * console.log(`Amount of proposals: ${count}`);
- * ```
- */
-export const proposalCount = /*#__PURE__*/ collectiveProposalCount('allianceMotion');
-/**
- * @name proposalHashes
- * @description Retrieves an array of hashes for all active proposals in the "allianceMotion" collective.
- * @example
- * ```javascript
- * const hashes = await api.derive.alliance.proposalHashes();
- * console.log(`Proposals ${JSON.stringify(hashes)}`);
- * ```
- */
-export const proposalHashes = /*#__PURE__*/ collectiveProposalHashes('allianceMotion');
-/**
- * @name proposals
- * @description Retrieves a list of all active proposals in the "allianceMotion" collective.
- * @example
- * ```javascript
- * const proposals = await api.derive.alliance.proposals();
- * console.log(proposals);
- * ```
- */
-export const proposals = /*#__PURE__*/ collectiveProposals('allianceMotion');
-/**
- * @name prime
- * @description Retrieves the prime member of the "allianceMotion" collective, if one exists.
- * @example
- * ```javascript
- * const primeMember = await api.derive.alliance.prime();
- * console.log(primeMember);
- * ```
- */
-export const prime = /*#__PURE__*/ collectivePrime('allianceMotion');

package/build-deno/augment.ts

@@ -1,2 +0,0 @@
-
-import 'https://deno.land/x/pezkuwi/api-augment/mod.ts';

package/build-deno/bagsList/get.ts

@@ -1,77 +0,0 @@
-
-import type { Observable } from 'https://esm.sh/rxjs@7.8.1';
-import type { Option, u64 } from 'https://deno.land/x/pezkuwi/types/mod.ts';
-import type { PezpalletBagsListListBag } from 'https://deno.land/x/pezkuwi/types/lookup.ts';
-import type { BN } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-import type { DeriveApi } from '../types.ts';
-import type { Bag } from './types.ts';
-
-import { map, of, switchMap } from 'https://esm.sh/rxjs@7.8.1';
-
-import { BN_ZERO, bnToBn, objectSpread } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { memo } from '../util/index.ts';
-import { getQueryInterface } from './util.ts';
-
-function orderBags (ids: BN[], bags: Option<PezpalletBagsListListBag>[]): Bag[] {
-  const sorted = ids
-    .map((id, index) => ({
-      bag: bags[index].unwrapOr(null),
-      id,
-      key: id.toString()
-    }))
-    .sort((a, b) => b.id.cmp(a.id));
-  const max = sorted.length - 1;
-
-  return sorted.map((entry, index): Bag =>
-    objectSpread(entry, {
-      bagLower: index === max
-        ? BN_ZERO
-        : sorted[index + 1].id,
-      bagUpper: entry.id,
-      index
-    })
-  );
-}
-
-export function _getIds (instanceId: string, api: DeriveApi): (ids: (BN | number)[]) => Observable<Bag[]> {
-  const query = getQueryInterface(api);
-
-  return memo(instanceId, (_ids: (BN | number)[]): Observable<Bag[]> => {
-    const ids = _ids.map((id) => bnToBn(id));
-
-    return ids.length
-      ? query.listBags.multi<Option<PezpalletBagsListListBag>>(ids).pipe(
-        map((bags) => orderBags(ids, bags))
-      )
-      : of([]);
-  });
-}
-
-export function all (instanceId: string, api: DeriveApi): () => Observable<Bag[]> {
-  const query = getQueryInterface(api);
-
-  return memo(instanceId, (): Observable<Bag[]> =>
-    query.listBags.keys<[u64]>().pipe(
-      switchMap((keys) =>
-        api.derive.bagsList._getIds(keys.map(({ args: [id] }) => id))
-      ),
-      map((list) =>
-        list.filter(({ bag }) => bag)
-      )
-    )
-  );
-}
-
-/**
- * @name get
- * @param {(BN | number)} id The id of the bag to retrieve.
- * @description Retrieves a specific bag from the BagsList pallet by its id.
- */
-export function get (instanceId: string, api: DeriveApi): (id: BN | number) => Observable<Bag> {
-  return memo(instanceId, (id: BN | number): Observable<Bag> =>
-    api.derive.bagsList._getIds([bnToBn(id)]).pipe(
-      map((bags) => bags[0])
-    )
-  );
-}

package/build-deno/bagsList/getExpanded.ts

@@ -1,39 +0,0 @@
-
-import type { Observable } from 'https://esm.sh/rxjs@7.8.1';
-import type { BN } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-import type { DeriveApi } from '../types.ts';
-import type { Bag, BagExpanded } from './types.ts';
-
-import { map, switchMap } from 'https://esm.sh/rxjs@7.8.1';
-
-import { objectSpread } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { memo } from '../util/index.ts';
-
-/**
- * @name expand
- * @description Expands a given bag by retrieving all its nodes (accounts contained within the bag).
- * @param {Bag} bag The bag to be expanded.
- */
-export function expand (instanceId: string, api: DeriveApi): (bag: Bag) => Observable<BagExpanded> {
-  return memo(instanceId, (bag: Bag): Observable<BagExpanded> =>
-    api.derive.bagsList.listNodes(bag.bag).pipe(
-      map((nodes) => objectSpread({ nodes }, bag))
-    )
-  );
-}
-
-/**
- * @name getExpanded
- * @description Retrieves and expands a specific bag from the BagsList pallet.
- * @param {BN | number} id The id of the bag to expand.
- */
-export function getExpanded (instanceId: string, api: DeriveApi): (id: BN | number) => Observable<BagExpanded> {
-  return memo(instanceId, (id: BN | number): Observable<BagExpanded> =>
-    api.derive.bagsList.get(id).pipe(
-      switchMap((bag) =>
-        api.derive.bagsList.expand(bag)
-      )
-    )
-  );
-}

package/build-deno/bagsList/index.ts

@@ -1,4 +0,0 @@
-
-export * from './get.ts';
-export * from './getExpanded.ts';
-export * from './listNodes.ts';

package/build-deno/bagsList/listNodes.ts

@@ -1,48 +0,0 @@
-
-import type { Observable } from 'https://esm.sh/rxjs@7.8.1';
-import type { Option } from 'https://deno.land/x/pezkuwi/types/mod.ts';
-import type { AccountId32 } from 'https://deno.land/x/pezkuwi/types/interfaces/index.ts';
-import type { PezpalletBagsListListBag, PezpalletBagsListListNode } from 'https://deno.land/x/pezkuwi/types/lookup.ts';
-import type { DeriveApi } from '../types.ts';
-
-import { BehaviorSubject, map, of, switchMap, tap, toArray } from 'https://esm.sh/rxjs@7.8.1';
-
-import { nextTick } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { memo } from '../util/index.ts';
-import { getQueryInterface } from './util.ts';
-
-function traverseLinks (api: DeriveApi, head: AccountId32 | string): Observable<PezpalletBagsListListNode[]> {
-  const subject = new BehaviorSubject<AccountId32 | string>(head);
-  const query = getQueryInterface(api);
-
-  return subject.pipe(
-    switchMap((account) =>
-      query.listNodes<Option<PezpalletBagsListListNode>>(account)
-    ),
-    tap((node: Option<PezpalletBagsListListNode>): void => {
-      nextTick((): void => {
-        node.isSome && node.value.next.isSome
-          ? subject.next(node.unwrap().next.unwrap())
-          : subject.complete();
-      });
-    }),
-    toArray(), // toArray since we want to startSubject to be completed
-    map((all: Option<PezpalletBagsListListNode>[]) =>
-      all.map((o) => o.unwrap())
-    )
-  );
-}
-
-/**
- * @name listNodes
- * @param {(PezpalletBagsListListBag | null)} bag A reference to a specific bag in the BagsList pallet.
- * @description Retrieves the list of nodes (accounts) contained in a specific bag within the BagsList pallet.
- */
-export function listNodes (instanceId: string, api: DeriveApi): (bag: PezpalletBagsListListBag | null) => Observable<PezpalletBagsListListNode[]> {
-  return memo(instanceId, (bag: PezpalletBagsListListBag | null): Observable<PezpalletBagsListListNode[]> =>
-    bag && bag.head.isSome
-      ? traverseLinks(api, bag.head.unwrap())
-      : of([])
-  );
-}

package/build-deno/bagsList/types.ts

@@ -1,16 +0,0 @@
-
-import type { PezpalletBagsListListBag, PezpalletBagsListListNode } from 'https://deno.land/x/pezkuwi/types/lookup.ts';
-import type { BN } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-export interface Bag {
-  bag: PezpalletBagsListListBag | null;
-  bagUpper: BN;
-  bagLower: BN;
-  id: BN;
-  index: number;
-  key: string;
-}
-
-export interface BagExpanded extends Bag {
-  nodes: PezpalletBagsListListNode[];
-}

package/build-deno/bagsList/util.ts

@@ -1,12 +0,0 @@
-
-import type { DeriveApi } from '../types.ts';
-
-export function getQueryInterface (api: DeriveApi): DeriveApi['query']['voterList'] {
-  return (
-    // latest bizinikiwi & pezkuwi
-    api.query.voterList ||
-    // previous bizinikiwi
-    api.query['voterBagsList'] ||
-    api.query['bagsList']
-  );
-}

package/build-deno/balances/account.ts

@@ -1,207 +0,0 @@
-
-import type { Observable } from 'https://esm.sh/rxjs@7.8.1';
-import type { QueryableStorageEntry } from 'https://deno.land/x/pezkuwi/api-base/types/index.ts';
-import type { AccountData, AccountId, AccountIndex, AccountInfo, Address, Balance, Index } from 'https://deno.land/x/pezkuwi/types/interfaces/index.ts';
-import type { PezframeSystemAccountInfo, PezpalletBalancesAccountData } from 'https://deno.land/x/pezkuwi/types/lookup.ts';
-import type { ITuple } from 'https://deno.land/x/pezkuwi/types/types/index.ts';
-import type { DeriveApi, DeriveBalancesAccount, DeriveBalancesAccountData } from '../types.ts';
-
-import { combineLatest, map, of, switchMap } from 'https://esm.sh/rxjs@7.8.1';
-
-import { isFunction, objectSpread } from 'https://deno.land/x/pezkuwi/util/mod.ts';
-
-import { memo } from '../util/index.ts';
-
-type BalanceResult = [Balance, Balance, Balance, Balance];
-
-type Result = [Index, BalanceResult[], AccountType];
-
-interface AccountType { isFrameAccountData: boolean }
-
-type DeriveCustomAccount = DeriveApi['derive'] & Record<string, {
-  customAccount?: DeriveApi['query']['balances']['account']
-}>
-
-function zeroBalance (api: DeriveApi) {
-  return api.registry.createType('Balance');
-}
-
-function getBalance (api: DeriveApi, [freeBalance, reservedBalance, frozenFeeOrFrozen, frozenMiscOrFlags]: BalanceResult, accType: AccountType): DeriveBalancesAccountData {
-  const votingBalance = api.registry.createType('Balance', freeBalance.toBn());
-
-  if (accType.isFrameAccountData) {
-    return {
-      frameSystemAccountInfo: {
-        flags: frozenMiscOrFlags,
-        frozen: frozenFeeOrFrozen
-      },
-      freeBalance,
-      frozenFee: api.registry.createType('Balance', 0),
-      frozenMisc: api.registry.createType('Balance', 0),
-      reservedBalance,
-      votingBalance
-    };
-  }
-
-  return {
-    freeBalance,
-    frozenFee: frozenFeeOrFrozen,
-    frozenMisc: frozenMiscOrFlags,
-    reservedBalance,
-    votingBalance
-  };
-}
-
-function calcBalances (api: DeriveApi, [accountId, [accountNonce, [primary, ...additional], accType]]: [AccountId, Result]): DeriveBalancesAccount {
-  return objectSpread({
-    accountId,
-    accountNonce,
-    additional: additional.map((b) => getBalance(api, b, accType))
-  }, getBalance(api, primary, accType));
-}
-
-function queryBalancesFree (api: DeriveApi, accountId: AccountId): Observable<Result> {
-  return combineLatest([
-    api.query.balances['freeBalance']<Balance>(accountId),
-    api.query.balances['reservedBalance']<Balance>(accountId),
-    api.query.system['accountNonce']<Index>(accountId)
-  ]).pipe(
-    map(([freeBalance, reservedBalance, accountNonce]): Result => [
-      accountNonce,
-      [[freeBalance, reservedBalance, zeroBalance(api), zeroBalance(api)]],
-      { isFrameAccountData: false }
-    ])
-  );
-}
-
-function queryNonceOnly (api: DeriveApi, accountId: AccountId): Observable<Result> {
-  const fill = (nonce: Index): Result => [
-    nonce,
-    [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
-    { isFrameAccountData: false }
-  ];
-
-  return isFunction(api.query.system.account)
-    ? api.query.system.account(accountId).pipe(
-      map(({ nonce }) => fill(nonce))
-    )
-    : isFunction(api.query.system['accountNonce'])
-      ? api.query.system['accountNonce']<Index>(accountId).pipe(
-        map((nonce) => fill(nonce))
-      )
-      : of(fill(api.registry.createType('Index')));
-}
-
-function queryBalancesAccount (api: DeriveApi, accountId: AccountId, modules: string[] = ['balances']): Observable<Result> {
-  const balances = modules
-    .map((m): QueryableStorageEntry<'rxjs'> => (api.derive as DeriveCustomAccount)[m]?.customAccount || api.query[m as 'balances']?.account)
-    .filter((q) => isFunction(q));
-
-  const extract = (nonce: Index, data: AccountData[]): Result => [
-    nonce,
-    data.map(({ feeFrozen, free, miscFrozen, reserved }): BalanceResult => [free, reserved, feeFrozen, miscFrozen]),
-    { isFrameAccountData: false }
-  ];
-
-  // NOTE this is for the first case where we do have instances specified
-  return balances.length
-    ? isFunction(api.query.system.account)
-      ? combineLatest([
-        api.query.system.account(accountId),
-        ...balances.map((c) => c(accountId))
-      ]).pipe(
-        map(([{ nonce }, ...balances]) => extract(nonce, balances as unknown as AccountData[]))
-      )
-      : combineLatest([
-        api.query.system['accountNonce']<Index>(accountId),
-        ...balances.map((c) => c(accountId))
-      ]).pipe(
-        map(([nonce, ...balances]) => extract(nonce, balances as unknown as AccountData[]))
-      )
-    : queryNonceOnly(api, accountId);
-}
-
-function querySystemAccount (api: DeriveApi, accountId: AccountId): Observable<Result> {
-  // AccountInfo is current, support old, eg. Edgeware
-  return api.query.system.account<AccountInfo | PezframeSystemAccountInfo | ITuple<[Index, AccountData]>>(accountId).pipe(
-    map((infoOrTuple): Result => {
-      const data = (infoOrTuple as AccountInfo).nonce
-        ? (infoOrTuple as AccountInfo).data
-        : (infoOrTuple as [Index, AccountData])[1];
-
-      const nonce = (infoOrTuple as AccountInfo).nonce || (infoOrTuple as [Index, AccountData])[0];
-
-      if (!data || data.isEmpty) {
-        return [
-          nonce,
-          [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
-          { isFrameAccountData: false }
-        ];
-      }
-
-      const isFrameType = !!(infoOrTuple as PezframeSystemAccountInfo).data.frozen;
-
-      if (isFrameType) {
-        const { flags, free, frozen, reserved } = (data as unknown as PezpalletBalancesAccountData);
-
-        return [
-          nonce,
-          [[free, reserved, frozen, flags]],
-          { isFrameAccountData: true }
-        ];
-      } else {
-        const { feeFrozen, free, miscFrozen, reserved } = data;
-
-        return [
-          nonce,
-          [[free, reserved, feeFrozen, miscFrozen]],
-          { isFrameAccountData: false }
-        ];
-      }
-    })
-  );
-}
-
-/**
- * @name account
- * @description Retrieves the essential balance details for an account, such as free balance and account nonce.
- * @param {( AccountIndex | AccountId | Address | string )} address An accountsId in different formats.
- * @example
- * ```javascript
- * const ALICE = 'F7Hs';
- *
- * api.derive.balances.all(ALICE, ({ accountId, lockedBalance }) => {
- *   console.log(`The account ${accountId} has a locked balance ${lockedBalance} units.`);
- * });
- * ```
- */
-export function account (instanceId: string, api: DeriveApi): (address: AccountIndex | AccountId | Address | string) => Observable<DeriveBalancesAccount> {
-  const balanceInstances = api.registry.getModuleInstances(api.runtimeVersion.specName, 'balances');
-  const nonDefaultBalances = balanceInstances && balanceInstances[0] !== 'balances';
-
-  return memo(instanceId, (address: AccountIndex | AccountId | Address | string): Observable<DeriveBalancesAccount> =>
-    api.derive.accounts.accountId(address).pipe(
-      switchMap((accountId): Observable<[AccountId, Result]> =>
-        (accountId
-          ? combineLatest([
-            of(accountId),
-            nonDefaultBalances
-              ? queryBalancesAccount(api, accountId, balanceInstances)
-              : isFunction(api.query.system?.account)
-                ? querySystemAccount(api, accountId)
-                : isFunction(api.query.balances?.account)
-                  ? queryBalancesAccount(api, accountId)
-                  : isFunction(api.query.balances?.['freeBalance'])
-                    ? queryBalancesFree(api, accountId)
-                    : queryNonceOnly(api, accountId)
-          ])
-          : of([api.registry.createType('AccountId'), [
-            api.registry.createType('Index'),
-            [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
-            { isFrameAccountData: false }
-          ]])
-        )
-      ),
-      map((result): DeriveBalancesAccount => calcBalances(api, result))
-    ));
-}