Cleanups for bestNumber derives (#4318)

jacogr · web-flow · commit 63a55d2f8a1b · 2021-12-11T09:35:52.000+02:00
* Cleanups for bestNumber derives

* Unused imports

* Re-exports of types for *.d.ts outputs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,9 @@ Changes:
 
 - Add support for contracts V2 ABI metadata
 - `CheckNonZeroSender` signed extension support
-- Generated TS Enum interfaces now expose the `type` (with allowed values)
 - Remove old-style capabilities detection (unneeded with metadata v14+)
+- Generated TS Enum interfaces now expose the `type` (with allowed values)
+- Split local & package imports in generated TS interfaces
 - Add Kusama 9130 upgrade block
 - Internal maintainability cleanups
 
diff --git a/packages/api-derive/src/accounts/accountId.ts b/packages/api-derive/src/accounts/accountId.ts
@@ -12,28 +12,25 @@ import { decodeAddress } from '@polkadot/util-crypto';
 
 import { memo } from '../util';
 
-function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIndex | string | null | undefined): Observable<AccountId> {
-  const decoded = isU8a(address)
-    ? address
-    : decodeAddress((address || '').toString());
-
-  if (decoded.length > 8) {
-    return of(api.registry.createType('AccountId', decoded));
-  }
-
-  const accountIndex = api.registry.createType('AccountIndex', decoded);
-
-  return api.derive.accounts.indexToId(accountIndex.toString()).pipe(
-    map((accountId) => assertReturn(accountId, 'Unable to retrieve accountId'))
-  );
-}
-
 /**
  * @name accountId
  * @param {(Address | AccountId | AccountIndex | string | null)} address - An accounts address in various formats.
  * @description  An [[AccountId]]
  */
 export function accountId (instanceId: string, api: ApiInterfaceRx): (address?: Address | AccountId | AccountIndex | string | null) => Observable<AccountId> {
-  return memo(instanceId, (address?: Address | AccountId | AccountIndex | string | null): Observable<AccountId> =>
-    retrieve(api, address));
+  return memo(instanceId, (address?: Address | AccountId | AccountIndex | string | null): Observable<AccountId> => {
+    const decoded = isU8a(address)
+      ? address
+      : decodeAddress((address || '').toString());
+
+    if (decoded.length > 8) {
+      return of(api.registry.createType('AccountId', decoded));
+    }
+
+    const accountIndex = api.registry.createType('AccountIndex', decoded);
+
+    return api.derive.accounts.indexToId(accountIndex.toString()).pipe(
+      map((a) => assertReturn(a, 'Unable to retrieve accountId'))
+    );
+  });
 }
diff --git a/packages/api-derive/src/accounts/idAndIndex.ts b/packages/api-derive/src/accounts/idAndIndex.ts
@@ -13,31 +13,6 @@ import { decodeAddress } from '@polkadot/util-crypto';
 
 import { memo } from '../util';
 
-function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIndex | Uint8Array | string | null | undefined): Observable<AccountIdAndIndex> {
-  try {
-    // yes, this can fail, don't care too much, catch will catch it
-    const decoded = isU8a(address)
-      ? address
-      : decodeAddress((address || '').toString());
-
-    if (decoded.length > 8) {
-      const accountId = api.registry.createType('AccountId', decoded);
-
-      return api.derive.accounts.idToIndex(accountId).pipe(
-        map((accountIndex): AccountIdAndIndex => [accountId, accountIndex])
-      );
-    }
-
-    const accountIndex = api.registry.createType('AccountIndex', decoded);
-
-    return api.derive.accounts.indexToId(accountIndex.toString()).pipe(
-      map((accountId): AccountIdAndIndex => [accountId, accountIndex])
-    );
-  } catch (error) {
-    return of([undefined, undefined]);
-  }
-}
-
 /**
  * @name idAndIndex
  * @param {(Address | AccountId | AccountIndex | Uint8Array | string | null)} address - An accounts address in various formats.
@@ -52,6 +27,28 @@ function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIn
  * ```
  */
 export function idAndIndex (instanceId: string, api: ApiInterfaceRx): (address?: Address | AccountId | AccountIndex | Uint8Array | string | null) => Observable<AccountIdAndIndex> {
-  return memo(instanceId, (address?: Address | AccountId | AccountIndex | Uint8Array | string | null): Observable<AccountIdAndIndex> =>
-    retrieve(api, address));
+  return memo(instanceId, (address?: Address | AccountId | AccountIndex | Uint8Array | string | null): Observable<AccountIdAndIndex> => {
+    try {
+      // yes, this can fail, don't care too much, catch will catch it
+      const decoded = isU8a(address)
+        ? address
+        : decodeAddress((address || '').toString());
+
+      if (decoded.length > 8) {
+        const accountId = api.registry.createType('AccountId', decoded);
+
+        return api.derive.accounts.idToIndex(accountId).pipe(
+          map((accountIndex): AccountIdAndIndex => [accountId, accountIndex])
+        );
+      }
+
+      const accountIndex = api.registry.createType('AccountIndex', decoded);
+
+      return api.derive.accounts.indexToId(accountIndex.toString()).pipe(
+        map((accountId): AccountIdAndIndex => [accountId, accountIndex])
+      );
+    } catch (error) {
+      return of([undefined, undefined]);
+    }
+  });
 }
diff --git a/packages/api-derive/src/chain/bestNumber.ts b/packages/api-derive/src/chain/bestNumber.ts
@@ -1,11 +1,7 @@
 // Copyright 2017-2021 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { Observable } from 'rxjs';
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { BlockNumber } from '@polkadot/types/interfaces';
-
-import { unwrapNumber } from './util';
+import { unwrapBlockNumber } from './util';
 
 /**
  * @name bestNumber
@@ -19,6 +15,4 @@ import { unwrapNumber } from './util';
  * });
  * ```
  */
-export function bestNumber (instanceId: string, api: ApiInterfaceRx): () => Observable<BlockNumber> {
-  return unwrapNumber(instanceId, api.derive.chain.subscribeNewHeads);
-}
+export const bestNumber = unwrapBlockNumber((api) => api.derive.chain.subscribeNewHeads());
diff --git a/packages/api-derive/src/chain/bestNumberFinalized.ts b/packages/api-derive/src/chain/bestNumberFinalized.ts
@@ -1,11 +1,7 @@
 // Copyright 2017-2021 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { Observable } from 'rxjs';
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { BlockNumber } from '@polkadot/types/interfaces';
-
-import { unwrapNumber } from './util';
+import { unwrapBlockNumber } from './util';
 
 /**
  * @name bestNumberFinalized
@@ -20,6 +16,4 @@ import { unwrapNumber } from './util';
  * });
  * ```
  */
-export function bestNumberFinalized (instanceId: string, api: ApiInterfaceRx): () => Observable<BlockNumber> {
-  return unwrapNumber(instanceId, api.rpc.chain.subscribeFinalizedHeads);
-}
+export const bestNumberFinalized = unwrapBlockNumber((api) => api.rpc.chain.subscribeFinalizedHeads());
diff --git a/packages/api-derive/src/chain/util.ts b/packages/api-derive/src/chain/util.ts
@@ -2,13 +2,22 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { Observable } from 'rxjs';
-import type { Option } from '@polkadot/types';
+import type { ApiInterfaceRx } from '@polkadot/api/types';
+import type { Compact } from '@polkadot/types';
 import type { BlockNumber } from '@polkadot/types/interfaces';
 
 import { map } from 'rxjs';
 
 import { memo } from '../util';
 
-export function unwrapNumber <T extends { number: Option<BlockNumber> }> (instanceId: string, fn: () => Observable<T>): () => Observable<BlockNumber> {
-  return memo(instanceId, () => fn().pipe(map((r) => r.number.unwrap())));
+// re-export these - since these needs to be resolvable from api-derive, i.e. without this
+// we would emit code with ../<somewhere>/src embedded in the *.d.ts files
+export type { ApiInterfaceRx } from '@polkadot/api/types';
+export type { BlockNumber } from '@polkadot/types/interfaces';
+
+export function unwrapBlockNumber <T extends { number: Compact<BlockNumber> }> (fn: (api: ApiInterfaceRx) => Observable<T>): (instanceId: string, api: ApiInterfaceRx) => () => Observable<BlockNumber> {
+  return (instanceId: string, api: ApiInterfaceRx) =>
+    memo(instanceId, () => fn(api).pipe(
+      map((r) => r.number.unwrap())
+    ));
 }
diff --git a/packages/api-derive/src/collective/helpers.ts b/packages/api-derive/src/collective/helpers.ts
@@ -4,6 +4,9 @@
 import type { ApiInterfaceRx } from '@polkadot/api/types';
 import type { Collective } from './types';
 
+// We are re-exporting these from here to ensure that *.d.ts generation is correct
+export type { ApiInterfaceRx } from '@polkadot/api/types';
+
 export function getInstance (api: ApiInterfaceRx, section: string): string {
   const instances = api.registry.getModuleInstances(api.runtimeVersion.specName.toString(), section);
 
diff --git a/packages/api-derive/src/collective/members.ts b/packages/api-derive/src/collective/members.ts
@@ -13,6 +13,10 @@ import { isFunction } from '@polkadot/util';
 import { memo } from '../util';
 import { withSection } from './helpers';
 
+// We are re-exporting these from here to ensure that *.d.ts generation is correct
+export type { ApiInterfaceRx } from '@polkadot/api/types';
+export type { AccountId } from '@polkadot/types/interfaces';
+
 export function members (_section: Collective): (instanceId: string, api: ApiInterfaceRx) => () => Observable<AccountId[]> {
   return withSection(_section, (section, instanceId, api) =>
     memo(instanceId, (): Observable<AccountId[]> =>
diff --git a/packages/api-derive/src/collective/prime.ts b/packages/api-derive/src/collective/prime.ts
@@ -14,6 +14,10 @@ import { isFunction } from '@polkadot/util';
 import { memo } from '../util';
 import { withSection } from './helpers';
 
+// We are re-exporting these from here to ensure that *.d.ts generation is correct
+export type { ApiInterfaceRx } from '@polkadot/api/types';
+export type { AccountId } from '@polkadot/types/interfaces';
+
 export function prime (_section: Collective): (instanceId: string, api: ApiInterfaceRx) => () => Observable<AccountId | null> {
   return withSection(_section, (section, instanceId, api) =>
     memo(instanceId, (): Observable<AccountId | null> =>
diff --git a/packages/api-derive/src/collective/proposals.ts b/packages/api-derive/src/collective/proposals.ts
@@ -15,6 +15,11 @@ import { isFunction } from '@polkadot/util';
 import { memo } from '../util';
 import { withSection } from './helpers';
 
+// We are re-exporting these from here to ensure that *.d.ts generation is correct
+export type { ApiInterfaceRx } from '@polkadot/api/types';
+export type { Option, u32 } from '@polkadot/types';
+export type { Hash, Proposal, Votes } from '@polkadot/types/interfaces';
+
 type Result = [(Hash | Uint8Array | string)[], (Option<Proposal> | null)[], Option<Votes>[]];
 
 function parse (api: ApiInterfaceRx, [hashes, proposals, votes]: Result): DeriveCollectiveProposal[] {
diff --git a/packages/api-derive/src/council/index.ts b/packages/api-derive/src/council/index.ts
@@ -1,19 +1,6 @@
 // Copyright 2017-2021 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-// we need these type imports to be available
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { u32 } from '@polkadot/types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { AccountId, Hash } from '@polkadot/types/interfaces';
-
 import { hasProposals as collectiveHasProposals, members as collectiveMembers, prime as collectivePrime, proposal as collectiveProposal, proposalCount as collectiveProposalCount, proposalHashes as collectiveProposalHashes, proposals as collectiveProposals } from '../collective';
 
 export * from './votes';
diff --git a/packages/api-derive/src/democracy/proposals.ts b/packages/api-derive/src/democracy/proposals.ts
@@ -20,7 +20,6 @@ type Depositors = DepositorsNew | DepositorsOld;
 type Proposals = ITuple<[PropIndex, Hash, AccountId]>[];
 type Result = [Proposals, (DeriveProposalImage | undefined)[], Depositors[]];
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 function isNewDepositors (depositors: ITuple<[Vec<AccountId>, Balance]> | ITuple<[Balance, Vec<AccountId>]>): depositors is ITuple<[Vec<AccountId>, Balance]> {
   // Detect balance...
   // eslint-disable-next-line @typescript-eslint/unbound-method
diff --git a/packages/api-derive/src/membership/index.ts b/packages/api-derive/src/membership/index.ts
@@ -1,19 +1,6 @@
 // Copyright 2017-2021 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-// we need these type imports to be available
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { u32 } from '@polkadot/types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { AccountId, Hash } from '@polkadot/types/interfaces';
-
 import { hasProposals as collectiveHasProposals, members as collectiveMembers, prime as collectivePrime, proposal as collectiveProposal, proposalCount as collectiveProposalCount, proposalHashes as collectiveProposalHashes, proposals as collectiveProposals } from '../collective';
 
 export const members = collectiveMembers('membership');
diff --git a/packages/api-derive/src/technicalCommittee/index.ts b/packages/api-derive/src/technicalCommittee/index.ts
@@ -1,19 +1,6 @@
 // Copyright 2017-2021 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-// we need these type imports to be available
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { u32 } from '@polkadot/types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import type { AccountId, Hash } from '@polkadot/types/interfaces';
-
 import { hasProposals as collectiveHasProposals, members as collectiveMembers, prime as collectivePrime, proposal as collectiveProposal, proposalCount as collectiveProposalCount, proposalHashes as collectiveProposalHashes, proposals as collectiveProposals } from '../collective';
 
 export const members = collectiveMembers('technicalCommittee');
